migrate to @scure/base for base64 & bech32 encoding

Return types are narrowed in a way that's still backwards-compatible.

Author: dynst

.pnp.cjs

@@ -37,6 +37,6 @@ export function pubkeyToRawAddress(pubkey: Pubkey): Uint8Array {
   }
 }
 
-export function pubkeyToAddress(pubkey: Pubkey, prefix: string): string {
+export function pubkeyToAddress(pubkey: Pubkey, prefix: string): `${string}1${string}` {
   return toBech32(prefix, pubkeyToRawAddress(pubkey));
 }

.yarn/cache/bech32-npm-1.1.4-87b69922f7-5f62ca47b8.zip

@@ -33,7 +33,7 @@ export class Secp256k1Wallet implements OfflineAminoSigner {
     this.prefix = prefix;
   }
 
-  private get address(): string {
+  private get address(): `${string}1${string}` {
     return toBech32(this.prefix, rawSecp256k1PubkeyToRawAddress(this.pubkey));
   }
 

packages/amino/src/addresses.ts

@@ -29,7 +29,7 @@ export function _instantiate2AddressIntermediate(
   salt: Uint8Array,
   msg: string | null,
   prefix: string,
-): { key: Uint8Array; addressData: Uint8Array; address: string } {
+): { key: Uint8Array; addressData: Uint8Array; address: `${string}1${string}` } {
   assert(checksum.length === 32);
   const creatorData = fromBech32(creator).data;
 
@@ -68,7 +68,7 @@ export function instantiate2Address(
   creator: string,
   salt: Uint8Array,
   bech32Prefix: string,
-): string {
+): `${string}1${string}` {
   // Non-empty msg values are discouraged.
   // See https://medium.com/cosmwasm/dev-note-3-limitations-of-instantiate2-and-how-to-deal-with-them-a3f946874230.
   const msg = null;

packages/amino/src/secp256k1wallet.ts

@@ -65,7 +65,7 @@ export function getHackatom(): ContractUploadInstructions {
   };
 }
 
-export function makeRandomAddress(): string {
+export function makeRandomAddress(): `${string}1${string}` {
   return toBech32("wasm", Random.getBytes(20));
 }
 

packages/cosmwasm-stargate/src/instantiate2.ts

@@ -36,8 +36,7 @@
     "pack-web": "yarn build-or-skip && webpack --mode development --config webpack.web.config.cjs"
   },
   "dependencies": {
-    "base64-js": "^1.3.0",
-    "bech32": "^1.1.4",
+    "@scure/base": "^1.2.6",
     "readonly-date": "^1.0.0"
   },
   "devDependencies": {

packages/cosmwasm-stargate/src/testutils.spec.ts

@@ -1,12 +1,12 @@
-import * as base64js from "base64-js";
+import { base64 } from "@scure/base";
 
 export function toBase64(data: Uint8Array): string {
-  return base64js.fromByteArray(data);
+  return base64.encode(data);
 }
 
 export function fromBase64(base64String: string): Uint8Array {
   if (!base64String.match(/^[a-zA-Z0-9+/]*={0,2}$/)) {
     throw new Error("Invalid base64 string format");
   }
-  return base64js.toByteArray(base64String);
+  return base64.decode(base64String);
 }

packages/encoding/package.json

@@ -1,15 +1,15 @@
-import * as bech32 from "bech32";
+import { bech32 } from "@scure/base";
 
-export function toBech32(prefix: string, data: Uint8Array, limit?: number): string {
-  const address = bech32.encode(prefix, bech32.toWords(data), limit);
+export function toBech32(prefix: string, data: Uint8Array, limit?: number): `${string}1${string}` {
+  const address: `${typeof prefix}1${string}` = bech32.encode(prefix, bech32.toWords(data), limit);
   return address;
 }
 
 export function fromBech32(
   address: string,
   limit = Infinity,
 ): { readonly prefix: string; readonly data: Uint8Array } {
-  const decodedAddress = bech32.decode(address, limit);
+  const decodedAddress = bech32.decode(address as `${string}1${string}`, limit);
   return {
     prefix: decodedAddress.prefix,
     data: new Uint8Array(bech32.fromWords(decodedAddress.words)),
@@ -22,7 +22,7 @@ export function fromBech32(
  * The input is validated along the way, which makes this significantly safer than
  * using `address.toLowerCase()`.
  */
-export function normalizeBech32(address: string): string {
-  const { prefix, data } = fromBech32(address);
+export function normalizeBech32(address: string): `${string}1${string}` {
+  const { prefix, data } = fromBech32(address.toLowerCase() as `${string}1${string}`);
   return toBech32(prefix, data);
 }

packages/encoding/src/base64.ts

@@ -1,4 +1,4 @@
-import { ReadonlyDate } from "readonly-date";
+import type { ReadonlyDate } from "readonly-date";
 
 const rfc3339Matcher =
   /^(\d{4})-(\d{2})-(\d{2})[T ](\d{2}):(\d{2}):(\d{2})(\.\d{1,9})?((?:[+-]\d{2}:\d{2})|Z)$/;