@dynamic-labs-wallet/btc 0.0.322 → 0.0.324

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@dynamic-labs-wallet/btc",
-  "version": "0.0.322",
+  "version": "0.0.324",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,
   "dependencies": {
     "@dynamic-labs/sdk-api-core": "^0.0.900",
-    "@dynamic-labs-wallet/browser": "0.0.322",
-    "@dynamic-labs-wallet/btc-utils": "0.0.322",
+    "@dynamic-labs-wallet/browser": "0.0.324",
+    "@dynamic-labs-wallet/btc-utils": "0.0.324",
     "@bitcoinerlab/secp256k1": "^1.2.0",
     "bitcoinjs-lib": "^7.0.0"
   },

package/src/client/client.d.ts

@@ -0,0 +1,182 @@
+import { BitcoinAddressType, BitcoinNetwork, DynamicWalletClient, type BIP340KeygenResult, type BitcoinConfig, type DynamicWalletClientInternalOptions, type DynamicWalletClientProps, type EcdsaPublicKey, type ThresholdSignatureScheme, type RequestWithElevatedAccessToken } from '@dynamic-labs-wallet/browser';
+import type { SignMessageContext } from '@dynamic-labs/sdk-api-core';
+export declare class DynamicBtcWalletClient extends DynamicWalletClient {
+    readonly chainName = "BTC";
+    /**
+     * Creates a new instance of DynamicBtcWalletClient
+     * @param props - The client properties
+     */
+    constructor({ environmentId, authToken, baseApiUrl, baseMPCRelayApiUrl, storageKey, debug, featureFlags, authMode, sdkVersion, forwardMPCClient, logger, }: DynamicWalletClientProps, internalOptions?: DynamicWalletClientInternalOptions);
+    /**
+     * Creates a Bitcoin wallet account
+     * @param thresholdSignatureScheme - The threshold signature scheme to use for the wallet
+     * @param password - The password to use for the wallet
+     * @param onError - The function to call if an error occurs
+     * @param signedSessionId - The signed session ID to use for the wallet
+     * @param addressType - The type of address to use for the wallet
+     * @returns The account address, public key hex, and raw public key
+     */
+    createWalletAccount({ thresholdSignatureScheme, password, onError, signedSessionId, bitcoinConfig, }: {
+        thresholdSignatureScheme: ThresholdSignatureScheme;
+        password?: string;
+        onError?: (error: Error) => void;
+        signedSessionId: string;
+        bitcoinConfig: BitcoinConfig;
+    }): Promise<{
+        accountAddress: string;
+        publicKeyHex: string;
+        rawPublicKey: EcdsaPublicKey | BIP340KeygenResult | Uint8Array | string | undefined;
+    }>;
+    /**
+     * Derives the Bitcoin account address
+     * - BIP340 keys (32 bytes x-only): Only for Taproot addresses
+     * - ECDSA keys (33/65 bytes): For all other address types (Legacy, SegWit, Native SegWit)
+     * - Algorithm selection is automatic based on addressType
+     * @param rawPublicKey - The raw public key to derive the account address from
+     * @param addressType - The address type to derive the account address for
+     * @param network - The network to derive the account address for
+     * @returns The account address
+     */
+    deriveAccountAddress({ rawPublicKey, addressType, network, }: {
+        rawPublicKey: any;
+        addressType: BitcoinAddressType;
+        network: BitcoinNetwork;
+    }): {
+        accountAddress: string;
+    };
+    /**
+     * Signs a message (BIP-322)
+     * @param message - The message to sign
+     * @param accountAddress - The account address
+     * @param network - The network (mainnet/testnet)
+     * @param password - The wallet password (optional)
+     * @param signedSessionId - The signed session ID
+     * @param mfaToken - The MFA token (optional)
+     * @param context - Additional context
+     * @param onError - Error callback
+     * @returns The BIP-322 signature
+     */
+    signMessage({ message, accountAddress, network, password, signedSessionId, mfaToken, elevatedAccessToken, context, onError, }: {
+        message: string;
+        accountAddress: string;
+        network: BitcoinNetwork;
+        password?: string;
+        signedSessionId: string;
+        mfaToken?: string;
+        elevatedAccessToken?: string;
+        context?: SignMessageContext;
+        onError?: (error: Error) => void;
+    }): Promise<string>;
+    /**
+     * Verifies that the derived address matches the expected address
+     * @param rawPublicKey - The raw public key
+     * @param addressType - The address type
+     * @param network - The network
+     * @param expectedAddress - The expected address
+     */
+    private verifyWalletAddress;
+    /**
+     * Exports the private key for a given account
+     * @param accountAddress - The account address to export the private key for
+     * @param password - The password to use for the private key
+     * @param signedSessionId - The signed session ID to use for the private key
+     * @param mfaToken - The MFA token to use for the private key
+     * @param network - The network to use for the private key
+     * @returns The private key
+     */
+    exportPrivateKey({ accountAddress, password, signedSessionId, mfaToken, elevatedAccessToken, }: RequestWithElevatedAccessToken<{
+        accountAddress: string;
+        password?: string;
+        signedSessionId: string;
+        mfaToken?: string;
+    }>): Promise<string>;
+    /**
+     * Imports a private key and creates a Bitcoin wallet account
+     * @param privateKey - Private key in WIF format (Base58 encoded)
+     * @param chainName - Chain name ('BTC')
+     * @param thresholdSignatureScheme - The threshold signature scheme to use
+     * @param password - Optional password for encrypted backup
+     * @param onError - Optional error callback
+     * @param signedSessionId - The signed session ID
+     * @param publicAddressCheck - Optional address to validate against
+     * @param addressType - Bitcoin address type (NATIVE_SEGWIT or TAPROOT)
+     * @returns The account address, public key hex, and raw public key
+     */
+    importPrivateKey({ privateKey, chainName, thresholdSignatureScheme, password, onError, signedSessionId, publicAddressCheck, addressType, legacyWalletId, }: {
+        privateKey: string;
+        chainName: string;
+        thresholdSignatureScheme: ThresholdSignatureScheme;
+        password?: string;
+        onError?: (error: Error) => void;
+        signedSessionId: string;
+        publicAddressCheck?: string;
+        addressType?: string;
+        /** ID of the legacy embedded wallet being upgraded to v3 */
+        legacyWalletId?: string;
+    }): Promise<{
+        accountAddress: string;
+        publicKeyHex: string;
+        rawPublicKey: EcdsaPublicKey | BIP340KeygenResult | Uint8Array | string | undefined;
+    }>;
+    /**
+     * Converts MPC private key to Bitcoin WIF (Wallet Import Format)
+     * Uses the utility function from utils.ts for the core conversion logic
+     * @param privateKey - The private key to convert to a Bitcoin WIF format
+     * @param network - The network to convert the private key to a Bitcoin WIF format for
+     * @returns The Bitcoin WIF format
+     */
+    private convertPrivateKeyToBitcoinFormat;
+    /**
+     * Sign a Bitcoin Transaction (PSBT)
+     *
+     * @param transaction - The PSBT to sign in hex format
+     * @param senderAddress - The address of the sender
+     * @param password - The password to use for the transaction
+     * @param signedSessionId - The signed session ID to use for the transaction
+     * @param authToken - The auth token to use for the transaction
+     * @param mfaToken - The MFA token to use for the transaction
+     * @param context - The context to use for the transaction
+     * @param onError - The error handler
+     * @returns The signed PSBT
+     */
+    signTransaction({ transaction, senderAddress, network, password, signedSessionId, mfaToken, elevatedAccessToken, context, onError, }: {
+        transaction: string;
+        senderAddress: string;
+        network: BitcoinNetwork;
+        password?: string;
+        signedSessionId: string;
+        mfaToken?: string;
+        elevatedAccessToken?: string;
+        context?: SignMessageContext;
+        onError?: (error: Error) => void;
+    }): Promise<string>;
+    /**
+     * Creates a PSBT for a transaction
+     * @param receiverAddress - The address to send funds to
+     * @param amount - The amount to send in satoshis
+     * @param senderAddress - The address to send funds from
+     * @param network - The network to use (mainnet/testnet)
+     * @param feeRateLevel - The fee rate level to use (fast, medium, slow)
+     * @returns The PSBT in hex format
+     */
+    createTransaction({ receiverAddress, amount, senderAddress, network, feeRateLevel, }: {
+        receiverAddress: string;
+        amount: string;
+        senderAddress: string;
+        network: BitcoinNetwork;
+        feeRateLevel?: 'fast' | 'medium' | 'slow';
+    }): Promise<string>;
+    /**
+     * Fetches the raw transaction hex for a given transaction ID
+     * @param txid - The transaction ID
+     * @param network - The network
+     * @returns The transaction hex
+     */
+    private getTxHex;
+    /**
+     * Gets the Bitcoin wallets
+     * @returns The Bitcoin wallets
+     */
+    getBitcoinWallets(): Promise<any>;
+}
+//# sourceMappingURL=client.d.ts.map

package/src/client/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EAOnB,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAClB,KAAK,kCAAkC,EACvC,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EAEnB,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,EACpC,MAAM,8BAA8B,CAAC;AACtC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AA2BrE,qBAAa,sBAAuB,SAAQ,mBAAmB;IAC7D,QAAQ,CAAC,SAAS,SAAS;IAE3B;;;OAGG;gBAED,EACE,aAAa,EACb,SAAS,EACT,UAAU,EACV,kBAAkB,EAClB,UAAU,EACV,KAAK,EACL,YAAY,EACZ,QAA0B,EAC1B,UAAU,EACV,gBAAgB,EAChB,MAAM,GACP,EAAE,wBAAwB,EAC3B,eAAe,CAAC,EAAE,kCAAkC;IAuBtD;;;;;;;;OAQG;IACG,mBAAmB,CAAC,EACxB,wBAAwB,EACxB,QAAoB,EACpB,OAAO,EACP,eAAe,EACf,aAAa,GACd,EAAE;QACD,wBAAwB,EAAE,wBAAwB,CAAC;QACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;QACjC,eAAe,EAAE,MAAM,CAAC;QACxB,aAAa,EAAE,aAAa,CAAC;KAC9B,GAAG,OAAO,CAAC;QACV,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,cAAc,GAAG,kBAAkB,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;KACrF,CAAC;IA2GF;;;;;;;;;OASG;IACH,oBAAoB,CAAC,EACnB,YAAY,EACZ,WAAW,EACX,OAAO,GACR,EAAE;QACD,YAAY,EAAE,GAAG,CAAC;QAClB,WAAW,EAAE,kBAAkB,CAAC;QAChC,OAAO,EAAE,cAAc,CAAC;KACzB,GAAG;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE;IAQ9B;;;;;;;;;;;OAWG;IACG,WAAW,CAAC,EAChB,OAAO,EACP,cAAc,EACd,OAAO,EACP,QAAoB,EACpB,eAAe,EACf,QAAQ,EACR,mBAAmB,EACnB,OAAO,EACP,OAAO,GACR,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,cAAc,EAAE,MAAM,CAAC;QACvB,OAAO,EAAE,cAAc,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,OAAO,CAAC,EAAE,kBAAkB,CAAC;QAC7B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;KAClC;IAkHD;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAc3B;;;;;;;;OAQG;IACG,gBAAgB,CAAC,EACrB,cAAc,EACd,QAAoB,EACpB,eAAe,EACf,QAAQ,EACR,mBAAmB,GACpB,EAAE,8BAA8B,CAAC;QAChC,cAAc,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAkDpB;;;;;;;;;;;OAWG;IACG,gBAAgB,CAAC,EACrB,UAAU,EACV,SAAS,EACT,wBAAwB,EACxB,QAAoB,EACpB,OAAO,EACP,eAAe,EACf,kBAAkB,EAClB,WAAW,EACX,cAAc,GACf,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,wBAAwB,EAAE,wBAAwB,CAAC;QACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;QACjC,eAAe,EAAE,MAAM,CAAC;QACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,4DAA4D;QAC5D,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,GAAG,OAAO,CAAC;QACV,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,cAAc,GAAG,kBAAkB,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;KACrF,CAAC;IA4HF;;;;;;OAMG;IACH,OAAO,CAAC,gCAAgC;IA4BxC;;;;;;;;;;;;OAYG;IACG,eAAe,CAAC,EACpB,WAAW,EACX,aAAa,EACb,OAAO,EACP,QAAQ,EACR,eAAe,EACf,QAAQ,EACR,mBAAmB,EACnB,OAAO,EACP,OAAO,GACR,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;QACpB,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,cAAc,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,eAAe,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,OAAO,CAAC,EAAE,kBAAkB,CAAC;QAC7B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;KAClC,GAAG,OAAO,CAAC,MAAM,CAAC;IA2MnB;;;;;;;;OAQG;IACG,iBAAiB,CAAC,EACtB,eAAe,EACf,MAAM,EACN,aAAa,EACb,OAAO,EACP,YAAuB,GACxB,EAAE;QACD,eAAe,EAAE,MAAM,CAAC;QACxB,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,cAAc,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;KAC3C,GAAG,OAAO,CAAC,MAAM,CAAC;IAwGnB;;;;;OAKG;YACW,QAAQ;IAWtB;;;OAGG;IACG,iBAAiB;CAKxB"}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client/client.js';
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../packages/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/src/types/index.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Supported Bitcoin networks.
+ */
+export type BitcoinNetwork = 'mainnet' | 'testnet';
+/**
+ * Represents an Unspent Transaction Output (UTXO).
+ */
+export type UTXO = {
+    /**
+     * The transaction ID where this output was created.
+     */
+    txid: string;
+    /**
+     * The index of the output in the transaction.
+     */
+    vout: number;
+    /**
+     * The value of the output in satoshis.
+     */
+    value: bigint;
+    /**
+     * The script public key of the output.
+     */
+    scriptPubKey?: Uint8Array;
+    /**
+     * The witness UTXO data, used for SegWit inputs.
+     */
+    witnessUtxo?: {
+        /**
+         * The script of the witness UTXO.
+         */
+        script: Uint8Array;
+        /**
+         * The amount of the witness UTXO in satoshis.
+         */
+        amount: bigint;
+    };
+};
+//# sourceMappingURL=index.d.ts.map

package/src/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,SAAS,GAAG,SAAS,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,YAAY,CAAC,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;WAEG;QACH,MAAM,EAAE,UAAU,CAAC;QACnB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH,CAAC"}

package/src/utils/index.d.ts

@@ -0,0 +1,2 @@
+export { parseDerivationPath } from './parseDerivationPath/index.js';
+//# sourceMappingURL=index.d.ts.map

package/src/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC"}

package/src/utils/parseDerivationPath/index.d.ts

@@ -0,0 +1,2 @@
+export { parseDerivationPath } from './parseDerivationPath.js';
+//# sourceMappingURL=index.d.ts.map

package/src/utils/parseDerivationPath/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/parseDerivationPath/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}

package/src/utils/parseDerivationPath/parseDerivationPath.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Parses the derivation path string into a Uint32Array
+ * Handles empty strings and empty array strings by returning an empty Uint32Array
+ *
+ * @param derivationPath - The derivation path as a JSON string (e.g., '{"0":44,"1":0,"2":0}' or '[]' or '')
+ * @returns The derivation path as a Uint32Array
+ * @throws Error if the derivation path is invalid JSON
+ */
+export declare const parseDerivationPath: (derivationPath: string) => Uint32Array;
+//# sourceMappingURL=parseDerivationPath.d.ts.map

package/src/utils/parseDerivationPath/parseDerivationPath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseDerivationPath.d.ts","sourceRoot":"","sources":["../../../src/utils/parseDerivationPath/parseDerivationPath.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,mBAAoB,MAAM,KAAG,WAK5D,CAAC"}