feat: Uint8Array<SharedArrayBuffer> is accepted in toBase58check

Author: ChALkeR

base58check.d.ts

@@ -36,7 +36,7 @@ export interface Base58CheckAsync {
    * @param arr - The input bytes to encode
    * @returns A Promise that resolves to the base58check encoded string
    */
-  encode(arr: Uint8ArrayBuffer): Promise<string>;
+  encode(arr: Uint8Array): Promise<string>;
 
   /**
    * Decode a base58check string to bytes asynchronously
@@ -60,7 +60,7 @@ export interface Base58CheckSync extends Base58CheckAsync {
    * @param arr - The input bytes to encode
    * @returns The base58check encoded string
    */
-  encodeSync(arr: Uint8ArrayBuffer): string;
+  encodeSync(arr: Uint8Array): string;
 
   /**
    * Decode a base58check string to bytes synchronously
@@ -92,7 +92,7 @@ export function makeBase58check(hashAlgo: HashFunction): Base58CheckAsync;
  * @param arr - The input bytes to encode
  * @returns A Promise that resolves to the base58check encoded string
  */
-export function toBase58check(arr: Uint8ArrayBuffer): Promise<string>;
+export function toBase58check(arr: Uint8Array): Promise<string>;
 
 /**
  * Decode a base58check string to bytes asynchronously
@@ -115,7 +115,7 @@ export function fromBase58check(string: string, format?: OutputFormat): Promise<
  * @param arr - The input bytes to encode
  * @returns The base58check encoded string
  */
-export function toBase58checkSync(arr: Uint8ArrayBuffer): string;
+export function toBase58checkSync(arr: Uint8Array): string;
 
 /**
  * Decode a base58check string to bytes synchronously

base58check.js

@@ -4,7 +4,8 @@ import { makeBase58check } from './fallback/base58check.js'
 // Note: while API is async, we use hashSync for now until we improve webcrypto perf for hash256
 // Inputs to base58 are typically very small, and that makes a difference
 
-// eslint-disable-next-line @exodus/import/no-deprecated
+// Note: using native WebCrypto will have to have account for SharedArrayBuffer
+
 const hash256sync = (x) => sha256(sha256(x))
 const hash256 = hash256sync // See note at the top
 const {

tests/vendor/bs58check/base.test.js

@@ -5,6 +5,13 @@ import { makeBase58check } from '@exodus/bytes/base58check.js'
 import { hash, hashSync } from '@exodus/crypto/hash' // eslint-disable-line @exodus/import/no-deprecated
 import { test } from 'node:test'
 
+const SharedArrayBuffer = globalThis.SharedArrayBuffer ?? ArrayBuffer
+const toShared = (u8) => {
+  const res = new Uint8Array(new SharedArrayBuffer(u8.length))
+  res.set(u8)
+  return res
+}
+
 // eslint-disable-next-line @exodus/import/no-deprecated
 const blake256x2sync = (x) => hashSync('blake256', hashSync('blake256', x, 'uint8'), 'uint8')
 const blake256x2 = async (x) => hash('blake256', await hash('blake256', x, 'uint8'), 'uint8')
@@ -15,7 +22,9 @@ test('custom checksum function (blake256x2)', async (t) => {
   const payload = hexToBytes('073f0415e993935a68154fda7018b887c4e3fe8b4e10')
 
   t.assert.strictEqual(await bs58check.encode(payload), address)
+  t.assert.strictEqual(await bs58check.encode(toShared(payload)), address)
   t.assert.deepStrictEqual(await bs58check.decode(address), payload)
   t.assert.strictEqual(bs58check.encodeSync(payload), address)
+  t.assert.strictEqual(bs58check.encodeSync(toShared(payload)), address)
   t.assert.deepStrictEqual(bs58check.decodeSync(address), payload)
 })

tests/vendor/bs58check/bs58check.test.js

@@ -6,6 +6,13 @@ import { toHex as bytesToHex, fromHex as hexToBytes } from '@exodus/bytes/hex.js
 import { test } from 'node:test'
 import fixtures from './fixtures.cjs'
 
+const SharedArrayBuffer = globalThis.SharedArrayBuffer ?? ArrayBuffer
+const toShared = (u8) => {
+  const res = new Uint8Array(new SharedArrayBuffer(u8.length))
+  res.set(u8)
+  return res
+}
+
 const libs = [auto]
 if (js.toBase58check !== auto.toBase58check) libs.push(js)
 
@@ -36,8 +43,10 @@ for (const f of fixtures.valid) {
     for (const lib of libs) {
       t.assert.strictEqual(await lib.toBase58check(u8), f.string)
       t.assert.strictEqual(await lib.toBase58check(buffer), f.string)
+      t.assert.strictEqual(await lib.toBase58check(toShared(u8)), f.string)
       t.assert.strictEqual(lib.toBase58checkSync(u8), f.string)
       t.assert.strictEqual(lib.toBase58checkSync(buffer), f.string)
+      t.assert.strictEqual(lib.toBase58checkSync(toShared(u8)), f.string)
     }
   })
 }