Use Uint8Array<ArrayBuffer> whenever possible and add fixUint8Array

webmaster128 · webmaster128 · commit 5412f75b21e4 · 2025-10-29T14:56:40.000+01:00
diff --git a/packages/amino/src/wallet.ts b/packages/amino/src/wallet.ts
@@ -13,7 +13,7 @@ import { sleep } from "@cosmjs/utils";
  * This reduces the scope of a potential rainbow attack to all CosmJS users.
  * Must be 16 bytes due to implementation limitations.
  */
-export const cosmjsSalt: Uint8Array = toAscii("The CosmJS salt.");
+export const cosmjsSalt: Uint8Array<ArrayBuffer> = toAscii("The CosmJS salt.");
 
 export interface KdfConfiguration {
   /**
diff --git a/packages/cosmwasm-stargate/src/cosmwasmclient.ts b/packages/cosmwasm-stargate/src/cosmwasmclient.ts
@@ -1,4 +1,4 @@
-import { fromUtf8, toHex } from "@cosmjs/encoding";
+import { fixUint8Array, fromUtf8, toHex } from "@cosmjs/encoding";
 import { Uint53 } from "@cosmjs/math";
 import {
   Account,
@@ -496,7 +496,10 @@ export class CosmWasmClient {
         events: tx.result.events.map(fromTendermintEvent),
         rawLog: tx.result.log || "",
         tx: tx.tx,
-        msgResponses: txMsgData.msgResponses,
+        msgResponses: txMsgData.msgResponses.map((mr) => ({
+          typeUrl: mr.typeUrl,
+          value: fixUint8Array(mr.value),
+        })),
         gasUsed: tx.result.gasUsed,
         gasWanted: tx.result.gasWanted,
       };
diff --git a/packages/crypto/src/bip39.ts b/packages/crypto/src/bip39.ts
@@ -1,3 +1,4 @@
+import { fixUint8Array } from "@cosmjs/encoding";
 import { entropyToMnemonic, mnemonicToEntropy, mnemonicToSeed } from "@scure/bip39";
 import { wordlist } from "@scure/bip39/wordlists/english";
 
@@ -39,7 +40,7 @@ export class Bip39 {
   }
 
   public static decode(mnemonic: EnglishMnemonic): Uint8Array<ArrayBuffer> {
-    return mnemonicToEntropy(mnemonic.toString(), wordlist);
+    return fixUint8Array(mnemonicToEntropy(mnemonic.toString(), wordlist));
   }
 
   public static async mnemonicToSeed(mnemonic: EnglishMnemonic, password?: string): Promise<Uint8Array> {
diff --git a/packages/crypto/src/hmac.ts b/packages/crypto/src/hmac.ts
@@ -1,3 +1,5 @@
+import { fixUint8Array } from "@cosmjs/encoding";
+
 import { HashFunction } from "./hash";
 
 export class Hmac<H extends HashFunction> implements HashFunction {
@@ -6,7 +8,7 @@ export class Hmac<H extends HashFunction> implements HashFunction {
   private readonly messageHasher: H;
   private readonly oKeyPad: Uint8Array;
   private readonly iKeyPad: Uint8Array;
-  private readonly hash: (data: Uint8Array) => Uint8Array;
+  private readonly hash: (data: Uint8Array) => Uint8Array<ArrayBuffer>;
 
   public constructor(hashFunctionConstructor: new () => H, originalKey: Uint8Array) {
     // This implementation is based on https://en.wikipedia.org/wiki/HMAC#Implementation
@@ -15,7 +17,7 @@ export class Hmac<H extends HashFunction> implements HashFunction {
 
     const blockSize = new hashFunctionConstructor().blockSize;
 
-    this.hash = (data) => new hashFunctionConstructor().update(data).digest();
+    this.hash = (data) => fixUint8Array(new hashFunctionConstructor().update(data).digest());
 
     let key = originalKey;
     if (key.length > blockSize) {
diff --git a/packages/crypto/src/keccak.ts b/packages/crypto/src/keccak.ts
@@ -1,3 +1,4 @@
+import { fixUint8Array } from "@cosmjs/encoding";
 import { keccak_256 } from "@noble/hashes/sha3.js";
 
 import { HashFunction } from "./hash";
@@ -20,7 +21,7 @@ export class Keccak256 implements HashFunction {
   }
 
   public digest(): Uint8Array<ArrayBuffer> {
-    return this.impl.digest();
+    return fixUint8Array(this.impl.digest());
   }
 }
 
diff --git a/packages/crypto/src/ripemd.ts b/packages/crypto/src/ripemd.ts
@@ -1,3 +1,4 @@
+import { fixUint8Array } from "@cosmjs/encoding";
 import { ripemd160 as nobleRipemd160 } from "@noble/hashes/legacy.js";
 
 import { HashFunction } from "./hash";
@@ -20,7 +21,7 @@ export class Ripemd160 implements HashFunction {
   }
 
   public digest(): Uint8Array<ArrayBuffer> {
-    return this.impl.digest();
+    return fixUint8Array(this.impl.digest());
   }
 }
 
diff --git a/packages/crypto/src/secp256k1.ts b/packages/crypto/src/secp256k1.ts
@@ -1,4 +1,4 @@
-import { fromHex, toHex } from "@cosmjs/encoding";
+import { fixUint8Array, fromHex, toHex } from "@cosmjs/encoding";
 import { assert } from "@cosmjs/utils";
 import { secp256k1 } from "@noble/curves/secp256k1";
 
@@ -106,7 +106,7 @@ export class Secp256k1 {
       bytesToUnsignedBigInt(signature.s()),
       signature.recovery,
     ).recoverPublicKey(messageHash);
-    return pk.toBytes(false);
+    return fixUint8Array(pk.toBytes(false));
   }
 
   /**
@@ -117,9 +117,9 @@ export class Secp256k1 {
   public static compressPubkey(pubkey: Uint8Array): Uint8Array<ArrayBuffer> {
     switch (pubkey.length) {
       case 33:
-        return pubkey;
+        return fixUint8Array(pubkey);
       case 65:
-        return secp256k1.Point.fromBytes(pubkey).toBytes(true);
+        return fixUint8Array(secp256k1.Point.fromBytes(pubkey).toBytes(true));
       default:
         throw new Error("Invalid pubkey length");
     }
@@ -133,9 +133,9 @@ export class Secp256k1 {
   public static uncompressPubkey(pubkey: Uint8Array): Uint8Array<ArrayBuffer> {
     switch (pubkey.length) {
       case 33:
-        return secp256k1.Point.fromBytes(pubkey).toBytes(false);
+        return fixUint8Array(secp256k1.Point.fromBytes(pubkey).toBytes(false));
       case 65:
-        return pubkey;
+        return fixUint8Array(pubkey);
       default:
         throw new Error("Invalid pubkey length");
     }
@@ -144,7 +144,7 @@ export class Secp256k1 {
   public static trimRecoveryByte(signature: Uint8Array): Uint8Array<ArrayBuffer> {
     switch (signature.length) {
       case 64:
-        return signature;
+        return fixUint8Array(signature);
       case 65:
         return signature.slice(0, 64);
       default:
diff --git a/packages/crypto/src/secp256k1signature.ts b/packages/crypto/src/secp256k1signature.ts
@@ -1,3 +1,5 @@
+import { fixUint8Array } from "@cosmjs/encoding";
+
 function trimLeadingNullBytes(inData: Uint8Array): Uint8Array<ArrayBuffer> {
   let numberOfLeadingNullBytes = 0;
   for (const byte of inData) {
@@ -74,8 +76,8 @@ export class Secp256k1Signature {
   }
 
   private readonly data: {
-    readonly r: Uint8Array;
-    readonly s: Uint8Array;
+    readonly r: Uint8Array<ArrayBuffer>;
+    readonly s: Uint8Array<ArrayBuffer>;
   };
 
   public constructor(r: Uint8Array, s: Uint8Array) {
@@ -88,8 +90,8 @@ export class Secp256k1Signature {
     }
 
     this.data = {
-      r: r,
-      s: s,
+      r: fixUint8Array(r),
+      s: fixUint8Array(s),
     };
   }
 
diff --git a/packages/crypto/src/sha.ts b/packages/crypto/src/sha.ts
@@ -1,3 +1,4 @@
+import { fixUint8Array } from "@cosmjs/encoding";
 import { sha256 as nobleSha256, sha512 as nobleSha512 } from "@noble/hashes/sha2.js";
 
 import { HashFunction } from "./hash";
@@ -20,7 +21,7 @@ export class Sha256 implements HashFunction {
   }
 
   public digest(): Uint8Array<ArrayBuffer> {
-    return this.impl.digest();
+    return fixUint8Array(this.impl.digest());
   }
 }
 
@@ -46,7 +47,7 @@ export class Sha512 implements HashFunction {
   }
 
   public digest(): Uint8Array<ArrayBuffer> {
-    return this.impl.digest();
+    return fixUint8Array(this.impl.digest());
   }
 }
 
diff --git a/packages/crypto/src/slip10.ts b/packages/crypto/src/slip10.ts
@@ -1,4 +1,4 @@
-import { fromHex, toAscii, toHex } from "@cosmjs/encoding";
+import { fixUint8Array, fromHex, toAscii, toHex } from "@cosmjs/encoding";
 import { Uint32, Uint53 } from "@cosmjs/math";
 import { assert } from "@cosmjs/utils";
 import { secp256k1 } from "@noble/curves/secp256k1";
@@ -153,7 +153,7 @@ export class Slip10 {
   private static serializedPoint(curve: Slip10Curve, p: bigint): Uint8Array<ArrayBuffer> {
     switch (curve) {
       case Slip10Curve.Secp256k1:
-        return secp256k1.Point.BASE.multiply(p).toBytes(true);
+        return fixUint8Array(secp256k1.Point.BASE.multiply(p).toBytes(true));
       default:
         throw new Error("curve not supported");
     }
diff --git a/packages/crypto/src/utils.ts b/packages/crypto/src/utils.ts
@@ -1,5 +1,5 @@
 // See https://github.com/paulmillr/noble-hashes/issues/25 for why this is needed
-export function toRealUint8Array(data: ArrayLike<number>): Uint8Array<ArrayBuffer> {
+export function toRealUint8Array(data: ArrayLike<number>): Uint8Array {
   if (data instanceof Uint8Array) return data;
   else return Uint8Array.from(data);
 }
diff --git a/packages/encoding/src/base64.ts b/packages/encoding/src/base64.ts
@@ -1,5 +1,7 @@
 import * as base64js from "base64-js";
 
+import { fixUint8Array } from "./uint8array";
+
 export function toBase64(data: Uint8Array): string {
   return base64js.fromByteArray(data);
 }
@@ -8,5 +10,5 @@ export function fromBase64(base64String: string): Uint8Array<ArrayBuffer> {
   if (!base64String.match(/^[a-zA-Z0-9+/]*={0,2}$/)) {
     throw new Error("Invalid base64 string format");
   }
-  return base64js.toByteArray(base64String);
+  return fixUint8Array(base64js.toByteArray(base64String));
 }
diff --git a/packages/encoding/src/bech32.ts b/packages/encoding/src/bech32.ts
@@ -1,5 +1,7 @@
 import { bech32 } from "@scure/base";
 
+import { fixUint8Array } from "./uint8array";
+
 export function toBech32(prefix: string, data: Uint8Array, limit?: number): string {
   const address = bech32.encode(prefix, bech32.toWords(data), limit);
   return address;
@@ -12,15 +14,15 @@ function hasBech32Separator(input: string): input is `${string}1${string}` {
 export function fromBech32(
   address: string,
   limit = Infinity,
-): { readonly prefix: string; readonly data: Uint8Array } {
+): { readonly prefix: string; readonly data: Uint8Array<ArrayBuffer> } {
   // This extra check can be removed once
   // https://github.com/paulmillr/scure-base/pull/45 is merged and published.
   if (!hasBech32Separator(address)) throw new Error(`No bech32 separator found`);
 
   const decodedAddress = bech32.decode(address, limit);
   return {
     prefix: decodedAddress.prefix,
-    data: new Uint8Array(bech32.fromWords(decodedAddress.words)),
+    data: fixUint8Array(bech32.fromWords(decodedAddress.words)),
   };
 }
 
diff --git a/packages/encoding/src/index.ts b/packages/encoding/src/index.ts
@@ -3,4 +3,5 @@ export { fromBase64, toBase64 } from "./base64";
 export { fromBech32, normalizeBech32, toBech32 } from "./bech32";
 export { fromHex, toHex } from "./hex";
 export { fromRfc3339, toRfc3339 } from "./rfc3339";
+export { fixUint8Array } from "./uint8array";
 export { fromUtf8, toUtf8 } from "./utf8";
diff --git a/packages/encoding/src/uint8array.ts b/packages/encoding/src/uint8array.ts
@@ -0,0 +1,16 @@
+/**
+ * Safely converts a Uint8Array<T> or Uint8Array into a
+ * Uint8Array<ArrayBuffer>, often without a copy at runtime.
+ *
+ * @see https://github.com/paulmillr/scure-base/issues/53
+ */
+export function fixUint8Array<T extends ArrayBufferLike>(source: Uint8Array<T>): Uint8Array<ArrayBuffer> {
+  const buffer = source.buffer;
+  if (buffer instanceof ArrayBuffer) {
+    return new Uint8Array(buffer); // new instance just to make TS happy without unsafe cast
+  }
+
+  const copy = new ArrayBuffer(buffer.byteLength);
+  new Uint8Array(copy).set(new Uint8Array(buffer));
+  return new Uint8Array(copy);
+}
diff --git a/packages/encoding/src/utf8.ts b/packages/encoding/src/utf8.ts
@@ -1,5 +1,7 @@
+import { fixUint8Array } from "./uint8array";
+
 export function toUtf8(str: string): Uint8Array<ArrayBuffer> {
-  return new TextEncoder().encode(str);
+  return fixUint8Array(new TextEncoder().encode(str));
 }
 
 /**
diff --git a/packages/proto-signing/src/registry.ts b/packages/proto-signing/src/registry.ts
@@ -1,3 +1,4 @@
+import { fixUint8Array } from "@cosmjs/encoding";
 import { BinaryWriter } from "cosmjs-types/binary";
 import { MsgSend } from "cosmjs-types/cosmos/bank/v1beta1/tx";
 import { Coin } from "cosmjs-types/cosmos/base/v1beta1/coin";
@@ -170,7 +171,7 @@ export class Registry {
       isTelescopeGeneratedType(type) || isTsProtoGeneratedType(type)
         ? type.fromPartial(value)
         : type.create(value);
-    return type.encode(instance).finish();
+    return fixUint8Array(type.encode(instance).finish());
   }
 
   /**
@@ -192,7 +193,7 @@ export class Registry {
       timeoutHeight: BigInt(txBodyFields.timeoutHeight?.toString() ?? "0"),
       messages: wrappedMessages,
     });
-    return TxBody.encode(txBody).finish();
+    return fixUint8Array(TxBody.encode(txBody).finish());
   }
 
   public decode({ typeUrl, value }: DecodeObject): any {
diff --git a/packages/proto-signing/src/signing.ts b/packages/proto-signing/src/signing.ts
@@ -1,3 +1,4 @@
+import { fixUint8Array } from "@cosmjs/encoding";
 import { assert } from "@cosmjs/utils";
 import { Coin } from "cosmjs-types/cosmos/base/v1beta1/coin";
 import { SignMode } from "cosmjs-types/cosmos/tx/signing/v1beta1/signing";
@@ -53,7 +54,7 @@ export function makeAuthInfoBytes(
       payer: feePayer,
     },
   });
-  return AuthInfo.encode(authInfo).finish();
+  return fixUint8Array(AuthInfo.encode(authInfo).finish());
 }
 
 export function makeSignDoc(
@@ -82,5 +83,5 @@ export function makeSignBytes({
     bodyBytes: bodyBytes,
     chainId: chainId,
   });
-  return SignDoc.encode(signDoc).finish();
+  return fixUint8Array(SignDoc.encode(signDoc).finish());
 }
diff --git a/packages/proto-signing/src/wallet.ts b/packages/proto-signing/src/wallet.ts
@@ -13,7 +13,7 @@ import { sleep } from "@cosmjs/utils";
  * This reduces the scope of a potential rainbow attack to all CosmJS users.
  * Must be 16 bytes due to implementation limitations.
  */
-export const cosmjsSalt: Uint8Array = toAscii("The CosmJS salt.");
+export const cosmjsSalt: Uint8Array<ArrayBuffer> = toAscii("The CosmJS salt.");
 
 export interface KdfConfiguration {
   /**
diff --git a/packages/stargate/src/stargateclient.ts b/packages/stargate/src/stargateclient.ts
@@ -1,5 +1,5 @@
 import { addCoins } from "@cosmjs/amino";
-import { toHex } from "@cosmjs/encoding";
+import { fixUint8Array, toHex } from "@cosmjs/encoding";
 import { Uint53 } from "@cosmjs/math";
 import { CometClient, connectComet, HttpEndpoint, toRfc3339WithNanoseconds } from "@cosmjs/tendermint-rpc";
 import { assert, sleep } from "@cosmjs/utils";
@@ -87,13 +87,16 @@ export interface IndexedTx {
    *
    * Use `decodeTxRaw` from @cosmjs/proto-signing to decode this.
    */
-  readonly tx: Uint8Array;
+  readonly tx: Uint8Array<ArrayBuffer>;
   /**
    * The message responses of the [TxMsgData](https://github.com/cosmos/cosmos-sdk/blob/v0.46.3/proto/cosmos/base/abci/v1beta1/abci.proto#L128-L140)
    * as `Any`s.
    * This field is an empty list for chains running Cosmos SDK < 0.46.
    */
-  readonly msgResponses: Array<{ readonly typeUrl: string; readonly value: Uint8Array }>;
+  readonly msgResponses: Array<{
+    readonly typeUrl: string;
+    readonly value: Uint8Array<ArrayBuffer>;
+  }>;
   readonly gasUsed: bigint;
   readonly gasWanted: bigint;
 }
@@ -133,7 +136,10 @@ export interface DeliverTxResponse {
    * as `Any`s.
    * This field is an empty list for chains running Cosmos SDK < 0.46.
    */
-  readonly msgResponses: Array<{ readonly typeUrl: string; readonly value: Uint8Array }>;
+  readonly msgResponses: Array<{
+    readonly typeUrl: string;
+    readonly value: Uint8Array<ArrayBuffer>;
+  }>;
   readonly gasUsed: bigint;
   readonly gasWanted: bigint;
 }
@@ -510,7 +516,10 @@ export class StargateClient {
         events: tx.result.events.map(fromTendermintEvent),
         rawLog: tx.result.log || "",
         tx: tx.tx,
-        msgResponses: txMsgData.msgResponses,
+        msgResponses: txMsgData.msgResponses.map((mr) => ({
+          typeUrl: mr.typeUrl,
+          value: fixUint8Array(mr.value),
+        })),
         gasUsed: tx.result.gasUsed,
         gasWanted: tx.result.gasWanted,
       };
diff --git a/packages/tendermint-rpc/src/comet1/comet1client.spec.ts b/packages/tendermint-rpc/src/comet1/comet1client.spec.ts
diff --git a/packages/tendermint-rpc/src/comet1/responses.ts b/packages/tendermint-rpc/src/comet1/responses.ts
diff --git a/packages/tendermint-rpc/src/comet38/comet38client.spec.ts b/packages/tendermint-rpc/src/comet38/comet38client.spec.ts
diff --git a/packages/tendermint-rpc/src/comet38/responses.ts b/packages/tendermint-rpc/src/comet38/responses.ts
diff --git a/packages/tendermint-rpc/src/tendermint34/responses.ts b/packages/tendermint-rpc/src/tendermint34/responses.ts
diff --git a/packages/tendermint-rpc/src/tendermint34/tendermint34client.spec.ts b/packages/tendermint-rpc/src/tendermint34/tendermint34client.spec.ts
diff --git a/packages/tendermint-rpc/src/tendermint37/responses.ts b/packages/tendermint-rpc/src/tendermint37/responses.ts
diff --git a/packages/tendermint-rpc/src/tendermint37/tendermint37client.spec.ts b/packages/tendermint-rpc/src/tendermint37/tendermint37client.spec.ts
diff --git a/packages/tendermint-rpc/src/types.ts b/packages/tendermint-rpc/src/types.ts

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { fixUint8Array } from "@cosmjs/encoding";`
`1`	`2`	`import { entropyToMnemonic, mnemonicToEntropy, mnemonicToSeed } from "@scure/bip39";`
`2`	`3`	`import { wordlist } from "@scure/bip39/wordlists/english";`
`3`	`4`
`@@ -39,7 +40,7 @@ export class Bip39 {`
`39`	`40`	`}`
`40`	`41`
`41`	`42`	`public static decode(mnemonic: EnglishMnemonic): Uint8Array<ArrayBuffer> {`
`42`		`- return mnemonicToEntropy(mnemonic.toString(), wordlist);`
	`43`	`+ return fixUint8Array(mnemonicToEntropy(mnemonic.toString(), wordlist));`
`43`	`44`	`}`
`44`	`45`
`45`	`46`	`public static async mnemonicToSeed(mnemonic: EnglishMnemonic, password?: string): Promise<Uint8Array> {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { fixUint8Array } from "@cosmjs/encoding";`
`1`	`2`	`import { keccak_256 } from "@noble/hashes/sha3.js";`
`2`	`3`
`3`	`4`	`import { HashFunction } from "./hash";`
`@@ -20,7 +21,7 @@ export class Keccak256 implements HashFunction {`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public digest(): Uint8Array<ArrayBuffer> {`
`23`		`- return this.impl.digest();`
	`24`	`+ return fixUint8Array(this.impl.digest());`
`24`	`25`	`}`
`25`	`26`	`}`
`26`	`27`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { fixUint8Array } from "@cosmjs/encoding";`
`1`	`2`	`import { ripemd160 as nobleRipemd160 } from "@noble/hashes/legacy.js";`
`2`	`3`
`3`	`4`	`import { HashFunction } from "./hash";`
`@@ -20,7 +21,7 @@ export class Ripemd160 implements HashFunction {`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public digest(): Uint8Array<ArrayBuffer> {`
`23`		`- return this.impl.digest();`
	`24`	`+ return fixUint8Array(this.impl.digest());`
`24`	`25`	`}`
`25`	`26`	`}`
`26`	`27`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { fixUint8Array } from "@cosmjs/encoding";`
`1`	`2`	`import { sha256 as nobleSha256, sha512 as nobleSha512 } from "@noble/hashes/sha2.js";`
`2`	`3`
`3`	`4`	`import { HashFunction } from "./hash";`
`@@ -20,7 +21,7 @@ export class Sha256 implements HashFunction {`
`20`	`21`	`}`
`21`	`22`
`22`	`23`	`public digest(): Uint8Array<ArrayBuffer> {`
`23`		`- return this.impl.digest();`
	`24`	`+ return fixUint8Array(this.impl.digest());`
`24`	`25`	`}`
`25`	`26`	`}`
`26`	`27`
`@@ -46,7 +47,7 @@ export class Sha512 implements HashFunction {`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`public digest(): Uint8Array<ArrayBuffer> {`
`49`		`- return this.impl.digest();`
	`50`	`+ return fixUint8Array(this.impl.digest());`
`50`	`51`	`}`
`51`	`52`	`}`
`52`	`53`