@talismn/crypto 0.3.0 → 0.3.1

package/dist/index.d.mts

@@ -0,0 +1,124 @@
+import * as _noble_hashes_utils from '@noble/hashes/utils';
+export { ed25519 } from '@noble/curves/ed25519';
+export { base58, base64, hex, utf8 } from '@scure/base';
+
+type KeypairCurve = "ecdsa" | "ed25519" | "sr25519" | "ethereum" | "bitcoin-ed25519" | "bitcoin-ecdsa" | "solana";
+type AddressEncoding = "ss58" | "ethereum" | "bech32m" | "bech32" | "base58check" | "base58solana";
+type Keypair = {
+    type: KeypairCurve;
+    secretKey: Uint8Array;
+    publicKey: Uint8Array;
+    address: string;
+};
+type AccountPlatform = "ethereum" | "polkadot" | "bitcoin" | "solana";
+
+type EncodeAddressOptions$1 = {
+    ss58Prefix?: number;
+};
+declare const addressFromPublicKey: (publicKey: Uint8Array, encoding: AddressEncoding, options?: EncodeAddressOptions$1) => string;
+
+type EncodeAddressOptions = {
+    ss58Format?: number | undefined;
+};
+declare const encodeAnyAddress: (address: string, options?: EncodeAddressOptions) => string;
+
+/** NOTE: Try not to use this too much, it will need to change */
+declare const addressEncodingFromCurve: (curve: KeypairCurve) => AddressEncoding;
+
+declare const isBitcoinAddress: (address: string) => boolean;
+declare function isBech32mAddress(address: string): boolean;
+declare function isBech32Address(address: string): boolean;
+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.
+ */
+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.
+ */
+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.
+ */
+declare function fromBase58Check(address: string): {
+    version: number;
+    hash: Uint8Array<ArrayBuffer>;
+};
+
+declare const detectAddressEncoding: (address: string) => AddressEncoding;
+
+/**
+ * Encodes a public key using H160 encoding with Ethereum checksum.
+ */
+declare const encodeAddressEthereum: (publicKey: Uint8Array) => `0x${string}`;
+declare const checksumEthereumAddress: (address: string) => `0x${string}`;
+declare function isEthereumAddress(address: string): address is `0x${string}`;
+
+declare const encodeAddressSolana: (publicKey: Uint8Array) => string;
+declare function isSolanaAddress(address: string): boolean;
+
+declare const decodeSs58Address: (addressStr: string) => [publicKey: Uint8Array, prefix: number];
+declare const encodeAddressSs58: (publicKey: Uint8Array | string, prefix?: number) => string;
+declare function isSs58Address(address: string): boolean;
+
+declare const isAddressEqual: (address1: string, address2: string) => boolean;
+
+declare const isAddressValid: (address: string) => boolean;
+
+declare const normalizeAddress: (address: string) => string;
+
+declare const getPublicKeySolana: (secretKey: Uint8Array) => Uint8Array<ArrayBufferLike>;
+
+declare const deriveKeypair: (seed: Uint8Array, derivationPath: string, curve: KeypairCurve) => Keypair;
+declare const getPublicKeyFromSecret: (secretKey: Uint8Array, curve: KeypairCurve) => Uint8Array;
+declare const addressFromMnemonic: (mnemonic: string, derivationPath: string, curve: KeypairCurve) => Promise<string>;
+declare const removeHexPrefix: (secretKey: string) => string;
+declare const parseSecretKey: (secretKey: string, platform: AccountPlatform) => Uint8Array<ArrayBufferLike>;
+declare const isValidDerivationPath: (derivationPath: string, curve: KeypairCurve) => Promise<boolean>;
+
+declare const encryptKemAead: (publicKey: Uint8Array, plaintext: Uint8Array) => Promise<Uint8Array<ArrayBufferLike>>;
+
+declare const blake3: {
+    (msg: _noble_hashes_utils.Input, opts?: Object | undefined): Uint8Array;
+    outputLen: number;
+    blockLen: number;
+    create(opts?: Object | undefined): _noble_hashes_utils.HashXOF<_noble_hashes_utils.HashXOF<_noble_hashes_utils.HashXOF<any>>>;
+};
+declare const blake2b256: (msg: Uint8Array) => Uint8Array<ArrayBufferLike>;
+declare const blake2b512: (msg: Uint8Array) => Uint8Array<ArrayBufferLike>;
+declare const getSafeHash: (bytes: Uint8Array) => string;
+
+declare const mnemonicToEntropy: (mnemonic: string) => Uint8Array<ArrayBufferLike>;
+declare const entropyToMnemonic: (entropy: Uint8Array) => string;
+declare const entropyToSeed: (entropy: Uint8Array, curve: KeypairCurve, password?: string) => Promise<Uint8Array<ArrayBuffer>>;
+declare const isValidMnemonic: (mnemonic: string) => boolean;
+declare const generateMnemonic: (words: 12 | 24) => string;
+declare const DEV_MNEMONIC_POLKADOT = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
+declare const DEV_MNEMONIC_ETHEREUM = "test test test test test test test test test test test junk";
+declare const getDevSeed: (curve: KeypairCurve) => Promise<Uint8Array<ArrayBufferLike>>;
+
+declare const getAccountPlatformFromCurve: (curve: KeypairCurve) => AccountPlatform;
+declare const getAccountPlatformFromEncoding: (encoding: AddressEncoding) => AccountPlatform;
+declare const getAccountPlatformFromAddress: (address: string) => AccountPlatform;
+
+declare const pbkdf2: (hash: "SHA-256" | "SHA-512", entropy: Uint8Array, salt: Uint8Array, iterations: number, outputLenBytes: number) => Promise<Uint8Array<ArrayBuffer>>;
+
+export { type AccountPlatform, type AddressEncoding, DEV_MNEMONIC_ETHEREUM, DEV_MNEMONIC_POLKADOT, type EncodeAddressOptions$1 as EncodeAddressOptions, type Keypair, type KeypairCurve, addressEncodingFromCurve, addressFromMnemonic, addressFromPublicKey, blake2b256, blake2b512, blake3, checksumEthereumAddress, decodeSs58Address, deriveKeypair, detectAddressEncoding, encodeAddressEthereum, encodeAddressSolana, encodeAddressSs58, encodeAnyAddress, encryptKemAead, entropyToMnemonic, entropyToSeed, fromBase58Check, fromBech32, fromBech32m, generateMnemonic, getAccountPlatformFromAddress, getAccountPlatformFromCurve, getAccountPlatformFromEncoding, getDevSeed, getPublicKeyFromSecret, getPublicKeySolana, getSafeHash, isAddressEqual, isAddressValid, isBase58CheckAddress, isBech32Address, isBech32mAddress, isBitcoinAddress, isEthereumAddress, isSolanaAddress, isSs58Address, isValidDerivationPath, isValidMnemonic, mnemonicToEntropy, normalizeAddress, parseSecretKey, pbkdf2, removeHexPrefix };

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+import * as _noble_hashes_utils from '@noble/hashes/utils';
+export { ed25519 } from '@noble/curves/ed25519';
+export { base58, base64, hex, utf8 } from '@scure/base';
+
+type KeypairCurve = "ecdsa" | "ed25519" | "sr25519" | "ethereum" | "bitcoin-ed25519" | "bitcoin-ecdsa" | "solana";
+type AddressEncoding = "ss58" | "ethereum" | "bech32m" | "bech32" | "base58check" | "base58solana";
+type Keypair = {
+    type: KeypairCurve;
+    secretKey: Uint8Array;
+    publicKey: Uint8Array;
+    address: string;
+};
+type AccountPlatform = "ethereum" | "polkadot" | "bitcoin" | "solana";
+
+type EncodeAddressOptions$1 = {
+    ss58Prefix?: number;
+};
+declare const addressFromPublicKey: (publicKey: Uint8Array, encoding: AddressEncoding, options?: EncodeAddressOptions$1) => string;
+
+type EncodeAddressOptions = {
+    ss58Format?: number | undefined;
+};
+declare const encodeAnyAddress: (address: string, options?: EncodeAddressOptions) => string;
+
+/** NOTE: Try not to use this too much, it will need to change */
+declare const addressEncodingFromCurve: (curve: KeypairCurve) => AddressEncoding;
+
+declare const isBitcoinAddress: (address: string) => boolean;
+declare function isBech32mAddress(address: string): boolean;
+declare function isBech32Address(address: string): boolean;
+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.
+ */
+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.
+ */
+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.
+ */
+declare function fromBase58Check(address: string): {
+    version: number;
+    hash: Uint8Array<ArrayBuffer>;
+};
+
+declare const detectAddressEncoding: (address: string) => AddressEncoding;
+
+/**
+ * Encodes a public key using H160 encoding with Ethereum checksum.
+ */
+declare const encodeAddressEthereum: (publicKey: Uint8Array) => `0x${string}`;
+declare const checksumEthereumAddress: (address: string) => `0x${string}`;
+declare function isEthereumAddress(address: string): address is `0x${string}`;
+
+declare const encodeAddressSolana: (publicKey: Uint8Array) => string;
+declare function isSolanaAddress(address: string): boolean;
+
+declare const decodeSs58Address: (addressStr: string) => [publicKey: Uint8Array, prefix: number];
+declare const encodeAddressSs58: (publicKey: Uint8Array | string, prefix?: number) => string;
+declare function isSs58Address(address: string): boolean;
+
+declare const isAddressEqual: (address1: string, address2: string) => boolean;
+
+declare const isAddressValid: (address: string) => boolean;
+
+declare const normalizeAddress: (address: string) => string;
+
+declare const getPublicKeySolana: (secretKey: Uint8Array) => Uint8Array<ArrayBufferLike>;
+
+declare const deriveKeypair: (seed: Uint8Array, derivationPath: string, curve: KeypairCurve) => Keypair;
+declare const getPublicKeyFromSecret: (secretKey: Uint8Array, curve: KeypairCurve) => Uint8Array;
+declare const addressFromMnemonic: (mnemonic: string, derivationPath: string, curve: KeypairCurve) => Promise<string>;
+declare const removeHexPrefix: (secretKey: string) => string;
+declare const parseSecretKey: (secretKey: string, platform: AccountPlatform) => Uint8Array<ArrayBufferLike>;
+declare const isValidDerivationPath: (derivationPath: string, curve: KeypairCurve) => Promise<boolean>;
+
+declare const encryptKemAead: (publicKey: Uint8Array, plaintext: Uint8Array) => Promise<Uint8Array<ArrayBufferLike>>;
+
+declare const blake3: {
+    (msg: _noble_hashes_utils.Input, opts?: Object | undefined): Uint8Array;
+    outputLen: number;
+    blockLen: number;
+    create(opts?: Object | undefined): _noble_hashes_utils.HashXOF<_noble_hashes_utils.HashXOF<_noble_hashes_utils.HashXOF<any>>>;
+};
+declare const blake2b256: (msg: Uint8Array) => Uint8Array<ArrayBufferLike>;
+declare const blake2b512: (msg: Uint8Array) => Uint8Array<ArrayBufferLike>;
+declare const getSafeHash: (bytes: Uint8Array) => string;
+
+declare const mnemonicToEntropy: (mnemonic: string) => Uint8Array<ArrayBufferLike>;
+declare const entropyToMnemonic: (entropy: Uint8Array) => string;
+declare const entropyToSeed: (entropy: Uint8Array, curve: KeypairCurve, password?: string) => Promise<Uint8Array<ArrayBuffer>>;
+declare const isValidMnemonic: (mnemonic: string) => boolean;
+declare const generateMnemonic: (words: 12 | 24) => string;
+declare const DEV_MNEMONIC_POLKADOT = "bottom drive obey lake curtain smoke basket hold race lonely fit walk";
+declare const DEV_MNEMONIC_ETHEREUM = "test test test test test test test test test test test junk";
+declare const getDevSeed: (curve: KeypairCurve) => Promise<Uint8Array<ArrayBufferLike>>;
+
+declare const getAccountPlatformFromCurve: (curve: KeypairCurve) => AccountPlatform;
+declare const getAccountPlatformFromEncoding: (encoding: AddressEncoding) => AccountPlatform;
+declare const getAccountPlatformFromAddress: (address: string) => AccountPlatform;
+
+declare const pbkdf2: (hash: "SHA-256" | "SHA-512", entropy: Uint8Array, salt: Uint8Array, iterations: number, outputLenBytes: number) => Promise<Uint8Array<ArrayBuffer>>;
+
+export { type AccountPlatform, type AddressEncoding, DEV_MNEMONIC_ETHEREUM, DEV_MNEMONIC_POLKADOT, type EncodeAddressOptions$1 as EncodeAddressOptions, type Keypair, type KeypairCurve, addressEncodingFromCurve, addressFromMnemonic, addressFromPublicKey, blake2b256, blake2b512, blake3, checksumEthereumAddress, decodeSs58Address, deriveKeypair, detectAddressEncoding, encodeAddressEthereum, encodeAddressSolana, encodeAddressSs58, encodeAnyAddress, encryptKemAead, entropyToMnemonic, entropyToSeed, fromBase58Check, fromBech32, fromBech32m, generateMnemonic, getAccountPlatformFromAddress, getAccountPlatformFromCurve, getAccountPlatformFromEncoding, getDevSeed, getPublicKeyFromSecret, getPublicKeySolana, getSafeHash, isAddressEqual, isAddressValid, isBase58CheckAddress, isBech32Address, isBech32mAddress, isBitcoinAddress, isEthereumAddress, isSolanaAddress, isSs58Address, isValidDerivationPath, isValidMnemonic, mnemonicToEntropy, normalizeAddress, parseSecretKey, pbkdf2, removeHexPrefix };