Revamp browser compatibility by removing Buffer-specific invokation (#…

…730)

.github/workflows/cd.yml

@@ -11,10 +11,10 @@ jobs:
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2
         with:
-          version: "8.6.12"
+          version: "latest"
       - uses: actions/setup-node@v3
         with:
-          node-version: 18
+          node-version: 20
           registry-url: "https://registry.npmjs.org"
       - run: pnpm install
       - run: npm test -- --bail --ci

.github/workflows/ci.yml

@@ -18,13 +18,14 @@ jobs:
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2
         with:
-          version: "8.6.12"
+          version: "latest"
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
           cache: pnpm
           cache-dependency-path: pnpm-lock.yaml
 
-      - run: pnpm install && npm test -- --bail --ci
+      - run: pnpm install
+      - run: npm test -- --bail --ci
       - uses: codecov/codecov-action@v3
       - run: npm run build && npm publish --dry-run

README.md

@@ -24,15 +24,15 @@ Run the code below with `npx ts-node`.
 
 ```typescript
 > import { encrypt, decrypt, PrivateKey } from 'eciesjs'
-> const k1 = new PrivateKey()
-> const data = Buffer.from('this is a test')
-> decrypt(k1.toHex(), encrypt(k1.publicKey.toHex(), data)).toString()
-'this is a test'
+> const sk = new PrivateKey()
+> const data = Buffer.from('hello world🌍')
+> decrypt(sk.toHex(), encrypt(sk.publicKey.toHex(), data)).toString()
+'hello world🌍'
 ```
 
 ## API
 
-### `encrypt(receiverRawPK: string | Buffer, msg: Buffer): Buffer`
+### `encrypt(receiverRawPK: string | Uint8Array, msg: Uint8Array): Buffer`
 
 Parameters:
 
@@ -41,7 +41,7 @@ Parameters:
 
 Returns: **Buffer**
 
-### `decrypt(receiverRawSK: string | Buffer, msg: Buffer): Buffer`
+### `decrypt(receiverRawSK: string | Uint8Array, msg: Uint8Array): Buffer`
 
 Parameters:
 
@@ -59,7 +59,7 @@ static fromHex(hex: string): PrivateKey;
 constructor(secret?: Uint8Array);
 toHex(): string;
 encapsulate(pk: PublicKey): Uint8Array;
-multiply(pub: PublicKey, compressed?: boolean): Uint8Array;
+multiply(pk: PublicKey, compressed?: boolean): Uint8Array;
 equals(other: PrivateKey): boolean;
 ```
 

package.json

@@ -35,18 +35,18 @@
   },
   "dependencies": {
     "@noble/ciphers": "^0.2.0",
-    "@noble/curves": "^1.1.0",
-    "@noble/hashes": "^1.3.1"
+    "@noble/curves": "^1.2.0",
+    "@noble/hashes": "^1.3.2"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.3",
-    "@types/node": "^20.4.9",
+    "@types/jest": "^29.5.4",
+    "@types/node": "^20.5.6",
     "@types/node-fetch": "^2.6.4",
     "https-proxy-agent": "^7.0.1",
-    "jest": "^29.6.2",
-    "node-fetch": "^2.6.12",
+    "jest": "^29.6.4",
+    "node-fetch": "^2.7.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "typescript": "^5.2.2"
   }
 }