@talismn/crypto 0.1.2 → 0.1.4

package/dist/declarations/src/address/encoding/addressEncodingFromCurve.d.ts

@@ -1,2 +1,3 @@
 import type { AddressEncoding, KeypairCurve } from "../../types";
+/** NOTE: Try not to use this too much, it will need to change */
 export declare const addressEncodingFromCurve: (curve: KeypairCurve) => AddressEncoding;

package/dist/declarations/src/address/encoding/bitcoin.d.ts

@@ -0,0 +1,37 @@
+export declare const isBitcoinAddress: (address: string) => boolean;
+export declare function isBech32mAddress(address: string): boolean;
+export declare function isBech32Address(address: string): boolean;
+export declare function isBase58CheckAddress(address: string): boolean;
+/**
+ * Converts a Bech32m encoded address to its corresponding data representation.
+ * @param address - The Bech32m encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+export declare function fromBech32m(address: string): {
+    version: number;
+    prefix: string;
+    data: Uint8Array<ArrayBuffer>;
+};
+/**
+ * Converts a Bech32 encoded address to its corresponding data representation.
+ * @param address - The Bech32 encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+export declare function fromBech32(address: string): {
+    version: number;
+    prefix: string;
+    data: Uint8Array<ArrayBuffer>;
+};
+/**
+ * Decodes a base58check encoded Bitcoin address and returns the version and hash.
+ *
+ * @param address - The base58check encoded Bitcoin address to decode.
+ * @returns An object containing the version and hash of the decoded address.
+ * @throws {TypeError} If the address is too short or too long.
+ */
+export declare function fromBase58Check(address: string): {
+    version: number;
+    hash: Uint8Array<ArrayBuffer>;
+};

package/dist/declarations/src/address/encoding/index.d.ts

@@ -1,5 +1,6 @@
+export * from "./addressEncodingFromCurve";
 export * from "./base58";
+export * from "./bitcoin";
+export * from "./detectAddressEncoding";
 export * from "./ethereum";
 export * from "./ss58";
-export * from "./addressEncodingFromCurve";
-export * from "./detectAddressEncoding";

package/dist/declarations/src/types/index.d.ts

@@ -1,9 +1,9 @@
-export type KeypairCurve = "ecdsa" | "ed25519" | "sr25519" | "ethereum" | "solana";
-export type AddressEncoding = "ss58" | "ethereum" | "base58";
+export type KeypairCurve = "ecdsa" | "ed25519" | "sr25519" | "ethereum" | "bitcoin-ed25519" | "bitcoin-ecdsa" | "solana";
+export type AddressEncoding = "ss58" | "ethereum" | "bech32m" | "bech32" | "base58check" | "base58";
 export type Keypair = {
     type: KeypairCurve;
     secretKey: Uint8Array;
     publicKey: Uint8Array;
     address: string;
 };
-export type Platform = "ethereum" | "polkadot" | "solana";
+export type Platform = "ethereum" | "polkadot" | "bitcoin" | "solana";

package/dist/talismn-crypto.cjs.dev.js

@@ -3,6 +3,8 @@
 var bip39 = require('@scure/bip39');
 var english = require('@scure/bip39/wordlists/english');
 var base = require('@scure/base');
+var bech32 = require('bech32');
+var bs58check = require('bs58check');
 var sha3 = require('@noble/hashes/sha3');
 var utils = require('@noble/hashes/utils');
 var blake2b = require('@noble/hashes/blake2b');
@@ -15,6 +17,10 @@ var hmac = require('@noble/hashes/hmac');
 var sha512 = require('@noble/hashes/sha512');
 var microSr25519 = require('micro-sr25519');
 
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var bs58check__default = /*#__PURE__*/_interopDefault(bs58check);
+
 const pbkdf2 = async (hash, entropy, salt, iterations, outputLenBytes) => {
   // NOTE: react-native-quick-crypto (our `global.crypto` polyfill on Talisman Mobile) doesn't support `crypto.subtle.deriveKey`.
   // But, we can work around this by using `crypto.subtle.deriveBits` and `crypto.subtle.importKey`, which when used together
@@ -56,6 +62,9 @@ const getSeedDerivationType = curve => {
     case "ethereum":
     case "solana":
       return "classic";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("seed derivation is not implemented for Bitcoin");
   }
 };
 
@@ -115,6 +124,26 @@ const getDevSeed = async curve => {
   return DEV_SEED_CACHE.get(type);
 };
 
+/** NOTE: Try not to use this too much, it will need to change */
+const addressEncodingFromCurve = curve => {
+  switch (curve) {
+    case "sr25519":
+    case "ed25519":
+    case "ecdsa":
+      return "ss58";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      // NOTE: Bitcoin has multiple address formats, so this isn't necessarily correct
+      // The format MAY be bech32m, but it might also be bech32 or base58check.
+      // bech32m is the most recent format.
+      return "bech32m";
+    case "ethereum":
+      return "ethereum";
+    case "solana":
+      return "base58";
+  }
+};
+
 const encodeAddressBase58 = publicKey => {
   return base.base58.encode(publicKey);
 };
@@ -128,6 +157,94 @@ function isBase58Address(address) {
   }
 }
 
+const isBitcoinAddress = address => isBech32mAddress(address) || isBech32Address(address) || isBase58CheckAddress(address);
+function isBech32mAddress(address) {
+  try {
+    fromBech32m(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+function isBech32Address(address) {
+  try {
+    fromBech32(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+function isBase58CheckAddress(address) {
+  try {
+    fromBase58Check(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+
+/**
+ * Converts a Bech32m encoded address to its corresponding data representation.
+ * @param address - The Bech32m encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+function fromBech32m(address) {
+  const result = bech32.bech32m.decode(address);
+  const version = result.words[0];
+  if (version === 0) throw new TypeError(address + " uses wrong encoding");
+  const data = bech32.bech32m.fromWords(result.words.slice(1));
+  return {
+    version,
+    prefix: result.prefix,
+    data: Uint8Array.from(data)
+  };
+}
+
+/**
+ * Converts a Bech32 encoded address to its corresponding data representation.
+ * @param address - The Bech32 encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+function fromBech32(address) {
+  const result = bech32.bech32.decode(address);
+  const version = result.words[0];
+  if (version !== 0) throw new TypeError(address + " uses wrong encoding");
+  const data = bech32.bech32.fromWords(result.words.slice(1));
+  return {
+    version,
+    prefix: result.prefix,
+    data: Uint8Array.from(data)
+  };
+}
+
+/**
+ * Decodes a base58check encoded Bitcoin address and returns the version and hash.
+ *
+ * @param address - The base58check encoded Bitcoin address to decode.
+ * @returns An object containing the version and hash of the decoded address.
+ * @throws {TypeError} If the address is too short or too long.
+ */
+function fromBase58Check(address) {
+  const payload = bs58check__default.default.decode(address);
+  if (payload.length < 21) throw new TypeError(address + " is too short");
+  if (payload.length > 21) throw new TypeError(address + " is too long");
+  function readUInt8(buffer, offset) {
+    if (offset + 1 > buffer.length) {
+      throw new Error("Offset is outside the bounds of Uint8Array");
+    }
+    const buf = Buffer.from(buffer);
+    return buf.readUInt8(offset);
+  }
+  const version = readUInt8(payload, 0);
+  const hash = payload.slice(1);
+  return {
+    version,
+    hash
+  };
+}
+
 /**
  * Encodes a public key using H160 encoding with Ethereum checksum.
  */
@@ -215,23 +332,13 @@ function isSs58Address(address) {
   }
 }
 
-const addressEncodingFromCurve = curve => {
-  switch (curve) {
-    case "sr25519":
-    case "ed25519":
-    case "ecdsa":
-      return "ss58";
-    case "ethereum":
-      return "ethereum";
-    case "solana":
-      return "base58";
-  }
-};
-
 const CACHE$1 = new Map();
 const detectAddressEncodingInner = address => {
   if (isEthereumAddress(address)) return "ethereum";
   if (isSs58Address(address)) return "ss58";
+  if (isBech32mAddress(address)) return "bech32m";
+  if (isBech32Address(address)) return "bech32";
+  if (isBase58CheckAddress(address)) return "base58check";
   if (isBase58Address(address)) return "base58";
   throw new Error(`Unknown address encoding`);
 };
@@ -246,6 +353,10 @@ const addressFromPublicKey = (publicKey, encoding, options) => {
       return encodeAddressSs58(publicKey, options?.ss58Prefix);
     case "ethereum":
       return encodeAddressEthereum(publicKey);
+    case "bech32m":
+    case "bech32":
+    case "base58check":
+      throw new Error("addressFromPublicKey is not implemented for Bitcoin");
     case "base58":
       return encodeAddressBase58(publicKey);
   }
@@ -268,6 +379,9 @@ const normalizeAnyAddress = address => {
   switch (detectAddressEncoding(address)) {
     case "ethereum":
       return checksumEthereumAddress(address);
+    case "bech32m":
+    case "bech32":
+    case "base58check":
     case "base58":
       return address;
     case "ss58":
@@ -279,7 +393,12 @@ const normalizeAnyAddress = address => {
 };
 
 const isAddressEqual = (address1, address2) => {
-  return normalizeAddress(address1) === normalizeAddress(address2);
+  try {
+    return normalizeAddress(address1) === normalizeAddress(address2);
+  } catch (err) {
+    // if normalization fails, assume the addresses are not equal
+    return false;
+  }
 };
 
 // Inspired from MIT licensed @polkadot-labs/hdkd helpers
@@ -448,6 +567,9 @@ const deriveKeypair = (seed, derivationPath, curve) => {
       return deriveEd25519(seed, derivationPath);
     case "ecdsa":
       return deriveEcdsa(seed, derivationPath);
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("deriveKeypair is not implemented for Bitcoin");
     case "ethereum":
       return deriveEthereum(seed, derivationPath);
     case "solana":
@@ -464,6 +586,9 @@ const getPublicKeyFromSecret = (secretKey, curve) => {
       return getPublicKeySr25519(secretKey);
     case "ed25519":
       return getPublicKeyEd25519(secretKey);
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("getPublicKeyFromSecret is not implemented for Bitcoin");
     case "solana":
       return getPublicKeySolana(secretKey);
   }
@@ -519,6 +644,8 @@ const parseSecretKey = (secretKey, curve) => {
     case "ed25519":
     case "sr25519":
     case "ecdsa":
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
     case "solana":
       throw new Error("Not implemented");
   }
@@ -542,6 +669,9 @@ const platformFromCurve = curve => {
       return "polkadot";
     case "ethereum":
       return "ethereum";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      return "bitcoin";
     case "solana":
       return "solana";
   }
@@ -552,6 +682,10 @@ const platformFromEncoding = encoding => {
       return "polkadot";
     case "ethereum":
       return "ethereum";
+    case "bech32m":
+    case "bech32":
+    case "base58check":
+      return "bitcoin";
     case "base58":
       return "solana";
   }
@@ -586,12 +720,19 @@ exports.encodeAddressEthereum = encodeAddressEthereum;
 exports.encodeAddressSs58 = encodeAddressSs58;
 exports.entropyToMnemonic = entropyToMnemonic;
 exports.entropyToSeed = entropyToSeed;
+exports.fromBase58Check = fromBase58Check;
+exports.fromBech32 = fromBech32;
+exports.fromBech32m = fromBech32m;
 exports.generateMnemonic = generateMnemonic;
 exports.getDevSeed = getDevSeed;
 exports.getPublicKeyFromSecret = getPublicKeyFromSecret;
 exports.getSafeHash = getSafeHash;
 exports.isAddressEqual = isAddressEqual;
 exports.isBase58Address = isBase58Address;
+exports.isBase58CheckAddress = isBase58CheckAddress;
+exports.isBech32Address = isBech32Address;
+exports.isBech32mAddress = isBech32mAddress;
+exports.isBitcoinAddress = isBitcoinAddress;
 exports.isEthereumAddress = isEthereumAddress;
 exports.isSs58Address = isSs58Address;
 exports.isValidDerivationPath = isValidDerivationPath;

package/dist/talismn-crypto.cjs.prod.js

@@ -3,6 +3,8 @@
 var bip39 = require('@scure/bip39');
 var english = require('@scure/bip39/wordlists/english');
 var base = require('@scure/base');
+var bech32 = require('bech32');
+var bs58check = require('bs58check');
 var sha3 = require('@noble/hashes/sha3');
 var utils = require('@noble/hashes/utils');
 var blake2b = require('@noble/hashes/blake2b');
@@ -15,6 +17,10 @@ var hmac = require('@noble/hashes/hmac');
 var sha512 = require('@noble/hashes/sha512');
 var microSr25519 = require('micro-sr25519');
 
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var bs58check__default = /*#__PURE__*/_interopDefault(bs58check);
+
 const pbkdf2 = async (hash, entropy, salt, iterations, outputLenBytes) => {
   // NOTE: react-native-quick-crypto (our `global.crypto` polyfill on Talisman Mobile) doesn't support `crypto.subtle.deriveKey`.
   // But, we can work around this by using `crypto.subtle.deriveBits` and `crypto.subtle.importKey`, which when used together
@@ -56,6 +62,9 @@ const getSeedDerivationType = curve => {
     case "ethereum":
     case "solana":
       return "classic";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("seed derivation is not implemented for Bitcoin");
   }
 };
 
@@ -115,6 +124,26 @@ const getDevSeed = async curve => {
   return DEV_SEED_CACHE.get(type);
 };
 
+/** NOTE: Try not to use this too much, it will need to change */
+const addressEncodingFromCurve = curve => {
+  switch (curve) {
+    case "sr25519":
+    case "ed25519":
+    case "ecdsa":
+      return "ss58";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      // NOTE: Bitcoin has multiple address formats, so this isn't necessarily correct
+      // The format MAY be bech32m, but it might also be bech32 or base58check.
+      // bech32m is the most recent format.
+      return "bech32m";
+    case "ethereum":
+      return "ethereum";
+    case "solana":
+      return "base58";
+  }
+};
+
 const encodeAddressBase58 = publicKey => {
   return base.base58.encode(publicKey);
 };
@@ -128,6 +157,94 @@ function isBase58Address(address) {
   }
 }
 
+const isBitcoinAddress = address => isBech32mAddress(address) || isBech32Address(address) || isBase58CheckAddress(address);
+function isBech32mAddress(address) {
+  try {
+    fromBech32m(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+function isBech32Address(address) {
+  try {
+    fromBech32(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+function isBase58CheckAddress(address) {
+  try {
+    fromBase58Check(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+
+/**
+ * Converts a Bech32m encoded address to its corresponding data representation.
+ * @param address - The Bech32m encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+function fromBech32m(address) {
+  const result = bech32.bech32m.decode(address);
+  const version = result.words[0];
+  if (version === 0) throw new TypeError(address + " uses wrong encoding");
+  const data = bech32.bech32m.fromWords(result.words.slice(1));
+  return {
+    version,
+    prefix: result.prefix,
+    data: Uint8Array.from(data)
+  };
+}
+
+/**
+ * Converts a Bech32 encoded address to its corresponding data representation.
+ * @param address - The Bech32 encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+function fromBech32(address) {
+  const result = bech32.bech32.decode(address);
+  const version = result.words[0];
+  if (version !== 0) throw new TypeError(address + " uses wrong encoding");
+  const data = bech32.bech32.fromWords(result.words.slice(1));
+  return {
+    version,
+    prefix: result.prefix,
+    data: Uint8Array.from(data)
+  };
+}
+
+/**
+ * Decodes a base58check encoded Bitcoin address and returns the version and hash.
+ *
+ * @param address - The base58check encoded Bitcoin address to decode.
+ * @returns An object containing the version and hash of the decoded address.
+ * @throws {TypeError} If the address is too short or too long.
+ */
+function fromBase58Check(address) {
+  const payload = bs58check__default.default.decode(address);
+  if (payload.length < 21) throw new TypeError(address + " is too short");
+  if (payload.length > 21) throw new TypeError(address + " is too long");
+  function readUInt8(buffer, offset) {
+    if (offset + 1 > buffer.length) {
+      throw new Error("Offset is outside the bounds of Uint8Array");
+    }
+    const buf = Buffer.from(buffer);
+    return buf.readUInt8(offset);
+  }
+  const version = readUInt8(payload, 0);
+  const hash = payload.slice(1);
+  return {
+    version,
+    hash
+  };
+}
+
 /**
  * Encodes a public key using H160 encoding with Ethereum checksum.
  */
@@ -215,23 +332,13 @@ function isSs58Address(address) {
   }
 }
 
-const addressEncodingFromCurve = curve => {
-  switch (curve) {
-    case "sr25519":
-    case "ed25519":
-    case "ecdsa":
-      return "ss58";
-    case "ethereum":
-      return "ethereum";
-    case "solana":
-      return "base58";
-  }
-};
-
 const CACHE$1 = new Map();
 const detectAddressEncodingInner = address => {
   if (isEthereumAddress(address)) return "ethereum";
   if (isSs58Address(address)) return "ss58";
+  if (isBech32mAddress(address)) return "bech32m";
+  if (isBech32Address(address)) return "bech32";
+  if (isBase58CheckAddress(address)) return "base58check";
   if (isBase58Address(address)) return "base58";
   throw new Error(`Unknown address encoding`);
 };
@@ -246,6 +353,10 @@ const addressFromPublicKey = (publicKey, encoding, options) => {
       return encodeAddressSs58(publicKey, options?.ss58Prefix);
     case "ethereum":
       return encodeAddressEthereum(publicKey);
+    case "bech32m":
+    case "bech32":
+    case "base58check":
+      throw new Error("addressFromPublicKey is not implemented for Bitcoin");
     case "base58":
       return encodeAddressBase58(publicKey);
   }
@@ -268,6 +379,9 @@ const normalizeAnyAddress = address => {
   switch (detectAddressEncoding(address)) {
     case "ethereum":
       return checksumEthereumAddress(address);
+    case "bech32m":
+    case "bech32":
+    case "base58check":
     case "base58":
       return address;
     case "ss58":
@@ -279,7 +393,12 @@ const normalizeAnyAddress = address => {
 };
 
 const isAddressEqual = (address1, address2) => {
-  return normalizeAddress(address1) === normalizeAddress(address2);
+  try {
+    return normalizeAddress(address1) === normalizeAddress(address2);
+  } catch (err) {
+    // if normalization fails, assume the addresses are not equal
+    return false;
+  }
 };
 
 // Inspired from MIT licensed @polkadot-labs/hdkd helpers
@@ -448,6 +567,9 @@ const deriveKeypair = (seed, derivationPath, curve) => {
       return deriveEd25519(seed, derivationPath);
     case "ecdsa":
       return deriveEcdsa(seed, derivationPath);
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("deriveKeypair is not implemented for Bitcoin");
     case "ethereum":
       return deriveEthereum(seed, derivationPath);
     case "solana":
@@ -464,6 +586,9 @@ const getPublicKeyFromSecret = (secretKey, curve) => {
       return getPublicKeySr25519(secretKey);
     case "ed25519":
       return getPublicKeyEd25519(secretKey);
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("getPublicKeyFromSecret is not implemented for Bitcoin");
     case "solana":
       return getPublicKeySolana(secretKey);
   }
@@ -519,6 +644,8 @@ const parseSecretKey = (secretKey, curve) => {
     case "ed25519":
     case "sr25519":
     case "ecdsa":
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
     case "solana":
       throw new Error("Not implemented");
   }
@@ -542,6 +669,9 @@ const platformFromCurve = curve => {
       return "polkadot";
     case "ethereum":
       return "ethereum";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      return "bitcoin";
     case "solana":
       return "solana";
   }
@@ -552,6 +682,10 @@ const platformFromEncoding = encoding => {
       return "polkadot";
     case "ethereum":
       return "ethereum";
+    case "bech32m":
+    case "bech32":
+    case "base58check":
+      return "bitcoin";
     case "base58":
       return "solana";
   }
@@ -586,12 +720,19 @@ exports.encodeAddressEthereum = encodeAddressEthereum;
 exports.encodeAddressSs58 = encodeAddressSs58;
 exports.entropyToMnemonic = entropyToMnemonic;
 exports.entropyToSeed = entropyToSeed;
+exports.fromBase58Check = fromBase58Check;
+exports.fromBech32 = fromBech32;
+exports.fromBech32m = fromBech32m;
 exports.generateMnemonic = generateMnemonic;
 exports.getDevSeed = getDevSeed;
 exports.getPublicKeyFromSecret = getPublicKeyFromSecret;
 exports.getSafeHash = getSafeHash;
 exports.isAddressEqual = isAddressEqual;
 exports.isBase58Address = isBase58Address;
+exports.isBase58CheckAddress = isBase58CheckAddress;
+exports.isBech32Address = isBech32Address;
+exports.isBech32mAddress = isBech32mAddress;
+exports.isBitcoinAddress = isBitcoinAddress;
 exports.isEthereumAddress = isEthereumAddress;
 exports.isSs58Address = isSs58Address;
 exports.isValidDerivationPath = isValidDerivationPath;

package/dist/talismn-crypto.esm.js

@@ -2,6 +2,8 @@ import { mnemonicToEntropy as mnemonicToEntropy$1, entropyToMnemonic as entropyT
 import { wordlist } from '@scure/bip39/wordlists/english';
 import { base58, bytesToString, stringToBytes } from '@scure/base';
 export { bytesToString, stringToBytes } from '@scure/base';
+import { bech32m, bech32 } from 'bech32';
+import bs58check from 'bs58check';
 import { keccak_256 } from '@noble/hashes/sha3';
 import { bytesToHex, randomBytes } from '@noble/hashes/utils';
 import { blake2b } from '@noble/hashes/blake2b';
@@ -55,6 +57,9 @@ const getSeedDerivationType = curve => {
     case "ethereum":
     case "solana":
       return "classic";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("seed derivation is not implemented for Bitcoin");
   }
 };
 
@@ -114,6 +119,26 @@ const getDevSeed = async curve => {
   return DEV_SEED_CACHE.get(type);
 };
 
+/** NOTE: Try not to use this too much, it will need to change */
+const addressEncodingFromCurve = curve => {
+  switch (curve) {
+    case "sr25519":
+    case "ed25519":
+    case "ecdsa":
+      return "ss58";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      // NOTE: Bitcoin has multiple address formats, so this isn't necessarily correct
+      // The format MAY be bech32m, but it might also be bech32 or base58check.
+      // bech32m is the most recent format.
+      return "bech32m";
+    case "ethereum":
+      return "ethereum";
+    case "solana":
+      return "base58";
+  }
+};
+
 const encodeAddressBase58 = publicKey => {
   return base58.encode(publicKey);
 };
@@ -127,6 +152,94 @@ function isBase58Address(address) {
   }
 }
 
+const isBitcoinAddress = address => isBech32mAddress(address) || isBech32Address(address) || isBase58CheckAddress(address);
+function isBech32mAddress(address) {
+  try {
+    fromBech32m(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+function isBech32Address(address) {
+  try {
+    fromBech32(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+function isBase58CheckAddress(address) {
+  try {
+    fromBase58Check(address);
+  } catch {
+    return false;
+  }
+  return true;
+}
+
+/**
+ * Converts a Bech32m encoded address to its corresponding data representation.
+ * @param address - The Bech32m encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+function fromBech32m(address) {
+  const result = bech32m.decode(address);
+  const version = result.words[0];
+  if (version === 0) throw new TypeError(address + " uses wrong encoding");
+  const data = bech32m.fromWords(result.words.slice(1));
+  return {
+    version,
+    prefix: result.prefix,
+    data: Uint8Array.from(data)
+  };
+}
+
+/**
+ * Converts a Bech32 encoded address to its corresponding data representation.
+ * @param address - The Bech32 encoded address.
+ * @returns An object containing the version, prefix, and data of the address.
+ * @throws {TypeError} If the address uses the wrong encoding.
+ */
+function fromBech32(address) {
+  const result = bech32.decode(address);
+  const version = result.words[0];
+  if (version !== 0) throw new TypeError(address + " uses wrong encoding");
+  const data = bech32.fromWords(result.words.slice(1));
+  return {
+    version,
+    prefix: result.prefix,
+    data: Uint8Array.from(data)
+  };
+}
+
+/**
+ * Decodes a base58check encoded Bitcoin address and returns the version and hash.
+ *
+ * @param address - The base58check encoded Bitcoin address to decode.
+ * @returns An object containing the version and hash of the decoded address.
+ * @throws {TypeError} If the address is too short or too long.
+ */
+function fromBase58Check(address) {
+  const payload = bs58check.decode(address);
+  if (payload.length < 21) throw new TypeError(address + " is too short");
+  if (payload.length > 21) throw new TypeError(address + " is too long");
+  function readUInt8(buffer, offset) {
+    if (offset + 1 > buffer.length) {
+      throw new Error("Offset is outside the bounds of Uint8Array");
+    }
+    const buf = Buffer.from(buffer);
+    return buf.readUInt8(offset);
+  }
+  const version = readUInt8(payload, 0);
+  const hash = payload.slice(1);
+  return {
+    version,
+    hash
+  };
+}
+
 /**
  * Encodes a public key using H160 encoding with Ethereum checksum.
  */
@@ -214,23 +327,13 @@ function isSs58Address(address) {
   }
 }
 
-const addressEncodingFromCurve = curve => {
-  switch (curve) {
-    case "sr25519":
-    case "ed25519":
-    case "ecdsa":
-      return "ss58";
-    case "ethereum":
-      return "ethereum";
-    case "solana":
-      return "base58";
-  }
-};
-
 const CACHE$1 = new Map();
 const detectAddressEncodingInner = address => {
   if (isEthereumAddress(address)) return "ethereum";
   if (isSs58Address(address)) return "ss58";
+  if (isBech32mAddress(address)) return "bech32m";
+  if (isBech32Address(address)) return "bech32";
+  if (isBase58CheckAddress(address)) return "base58check";
   if (isBase58Address(address)) return "base58";
   throw new Error(`Unknown address encoding`);
 };
@@ -245,6 +348,10 @@ const addressFromPublicKey = (publicKey, encoding, options) => {
       return encodeAddressSs58(publicKey, options?.ss58Prefix);
     case "ethereum":
       return encodeAddressEthereum(publicKey);
+    case "bech32m":
+    case "bech32":
+    case "base58check":
+      throw new Error("addressFromPublicKey is not implemented for Bitcoin");
     case "base58":
       return encodeAddressBase58(publicKey);
   }
@@ -267,6 +374,9 @@ const normalizeAnyAddress = address => {
   switch (detectAddressEncoding(address)) {
     case "ethereum":
       return checksumEthereumAddress(address);
+    case "bech32m":
+    case "bech32":
+    case "base58check":
     case "base58":
       return address;
     case "ss58":
@@ -278,7 +388,12 @@ const normalizeAnyAddress = address => {
 };
 
 const isAddressEqual = (address1, address2) => {
-  return normalizeAddress(address1) === normalizeAddress(address2);
+  try {
+    return normalizeAddress(address1) === normalizeAddress(address2);
+  } catch (err) {
+    // if normalization fails, assume the addresses are not equal
+    return false;
+  }
 };
 
 // Inspired from MIT licensed @polkadot-labs/hdkd helpers
@@ -447,6 +562,9 @@ const deriveKeypair = (seed, derivationPath, curve) => {
       return deriveEd25519(seed, derivationPath);
     case "ecdsa":
       return deriveEcdsa(seed, derivationPath);
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("deriveKeypair is not implemented for Bitcoin");
     case "ethereum":
       return deriveEthereum(seed, derivationPath);
     case "solana":
@@ -463,6 +581,9 @@ const getPublicKeyFromSecret = (secretKey, curve) => {
       return getPublicKeySr25519(secretKey);
     case "ed25519":
       return getPublicKeyEd25519(secretKey);
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      throw new Error("getPublicKeyFromSecret is not implemented for Bitcoin");
     case "solana":
       return getPublicKeySolana(secretKey);
   }
@@ -518,6 +639,8 @@ const parseSecretKey = (secretKey, curve) => {
     case "ed25519":
     case "sr25519":
     case "ecdsa":
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
     case "solana":
       throw new Error("Not implemented");
   }
@@ -541,6 +664,9 @@ const platformFromCurve = curve => {
       return "polkadot";
     case "ethereum":
       return "ethereum";
+    case "bitcoin-ecdsa":
+    case "bitcoin-ed25519":
+      return "bitcoin";
     case "solana":
       return "solana";
   }
@@ -551,6 +677,10 @@ const platformFromEncoding = encoding => {
       return "polkadot";
     case "ethereum":
       return "ethereum";
+    case "bech32m":
+    case "bech32":
+    case "base58check":
+      return "bitcoin";
     case "base58":
       return "solana";
   }
@@ -560,4 +690,4 @@ const platformFromAddress = address => {
   return platformFromEncoding(encoding);
 };
 
-export { DEV_MNEMONIC_ETHEREUM, DEV_MNEMONIC_POLKADOT, addressEncodingFromCurve, addressFromPublicKey, addressFromSuri, blake2b256, blake2b512, blake3, checksumEthereumAddress, decodeSs58Address, deriveKeypair, detectAddressEncoding, encodeAddressBase58, encodeAddressEthereum, encodeAddressSs58, entropyToMnemonic, entropyToSeed, generateMnemonic, getDevSeed, getPublicKeyFromSecret, getSafeHash, isAddressEqual, isBase58Address, isEthereumAddress, isSs58Address, isValidDerivationPath, isValidMnemonic, mnemonicToEntropy, normalizeAddress, parseSecretKey, parseSuri, pbkdf2, platformFromAddress, platformFromCurve, platformFromEncoding, removeHexPrefix };
+export { DEV_MNEMONIC_ETHEREUM, DEV_MNEMONIC_POLKADOT, addressEncodingFromCurve, addressFromPublicKey, addressFromSuri, blake2b256, blake2b512, blake3, checksumEthereumAddress, decodeSs58Address, deriveKeypair, detectAddressEncoding, encodeAddressBase58, encodeAddressEthereum, encodeAddressSs58, entropyToMnemonic, entropyToSeed, fromBase58Check, fromBech32, fromBech32m, generateMnemonic, getDevSeed, getPublicKeyFromSecret, getSafeHash, isAddressEqual, isBase58Address, isBase58CheckAddress, isBech32Address, isBech32mAddress, isBitcoinAddress, isEthereumAddress, isSs58Address, isValidDerivationPath, isValidMnemonic, mnemonicToEntropy, normalizeAddress, parseSecretKey, parseSuri, pbkdf2, platformFromAddress, platformFromCurve, platformFromEncoding, removeHexPrefix };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/crypto",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -27,6 +27,8 @@
     "@scure/base": "1.2.4",
     "@scure/bip32": "1.6.2",
     "@scure/bip39": "1.5.4",
+    "bech32": "2.0.0",
+    "bs58check": "4.0.0",
     "micro-sr25519": "0.1.3",
     "scale-ts": "1.6.1"
   },