@dynamic-labs-wallet/node-btc 0.0.0 → 0.0.255

package/src/client/client.d.ts

@@ -0,0 +1,165 @@
+import { DynamicWalletClient, type DynamicWalletClientProps, type ServerKeyShare, type ThresholdSignatureScheme, type EcdsaPublicKey, type BIP340KeygenResult, type EcdsaKeygenResult, type WalletProperties } from '@dynamic-labs-wallet/node';
+import type { SignMessageContext } from '@dynamic-labs/sdk-api-core';
+import { BitcoinAddressType, BitcoinNetwork, type BitcoinConfig } from '@dynamic-labs-wallet/core';
+export declare class DynamicBtcWalletClient extends DynamicWalletClient {
+    readonly chainName = "BTC";
+    constructor({ environmentId, baseApiUrl, baseMPCRelayApiUrl, enableMPCAccelerator, }: DynamicWalletClientProps);
+    /**
+     * 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;
+    };
+    /**
+     * Gets wallet properties and derivation info for a given account address
+     * @param accountAddress - The account address
+     * @returns The wallet properties, derivation path, and address type
+     */
+    private getWalletDerivationInfo;
+    /**
+     * 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;
+    /**
+     * Creates a new wallet account and stores the key shares in the wallet map.
+     * @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 backUpToClientShareService - Whether to back up the external server key shares to the client share service. By default, it is false.
+     * @param bitcoinConfig - Bitcoin configuration (addressType, network)
+     * @returns The account address, public key, raw public key, external server key shares, and wallet id.
+     */
+    createWalletAccount({ thresholdSignatureScheme, password, onError, backUpToClientShareService, bitcoinConfig, }: {
+        thresholdSignatureScheme: ThresholdSignatureScheme;
+        password?: string;
+        onError?: (error: Error) => void;
+        backUpToClientShareService?: boolean;
+        bitcoinConfig: BitcoinConfig;
+    }): Promise<{
+        accountAddress: string;
+        publicKeyHex: string;
+        rawPublicKey: EcdsaPublicKey | Uint8Array | string | undefined;
+        externalServerKeyShares: ServerKeyShare[];
+    }>;
+    /**
+     * Signs a message for BTC using BIP-322 format
+     *
+     * The address type is automatically derived from the wallet's derivation path.
+     * Supports both TAPROOT (BIP-86) and NATIVE_SEGWIT (BIP-84) address types.
+     *
+     * @param message - The message to sign
+     * @param accountAddress - The account address
+     * @param network - The Bitcoin network (MAINNET or TESTNET)
+     * @param password - Optional password for encrypted backup shares
+     * @param externalServerKeyShares - Optional external server key shares
+     * @param context - Optional. Sign message context for API tracking
+     * @param onError - Optional. Error callback function
+     * @returns Promise resolving to the BIP-322 signature as a base64 string
+     * @throws Error if required parameters are missing, derivation path is invalid, or signing fails
+     */
+    signMessage({ message, accountAddress, network, password, externalServerKeyShares, context, onError, }: {
+        message: string;
+        accountAddress: string;
+        network: BitcoinNetwork;
+        password?: string;
+        externalServerKeyShares?: ServerKeyShare[];
+        context?: SignMessageContext;
+        onError?: (error: Error) => void;
+    }): Promise<string>;
+    /**
+     * Signs a Bitcoin transaction (PSBT)
+     *
+     * The address type is automatically derived from the wallet's derivation path.
+     * Only inputs belonging to the sender address are signed. Supports both TAPROOT
+     * (BIP-341) and Native SegWit (BIP-143) signing methods.
+     *
+     * @param transaction - The PSBT to sign as a base64 string
+     * @param senderAddress - The sender address (must match inputs to be signed)
+     * @param network - The Bitcoin network (MAINNET or TESTNET)
+     * @param password - Optional password for encrypted backup shares
+     * @param externalServerKeyShares - Optional external server key shares
+     * @param context - Optional. Sign message context for API tracking
+     * @param onError - Optional. Error callback function
+     * @returns Promise resolving to the signed PSBT as a base64 string
+     * @throws Error if required parameters are missing, no inputs belong to sender address, or signing fails
+     */
+    signTransaction({ transaction, senderAddress, network, password, externalServerKeyShares, context, onError, }: {
+        transaction: string;
+        senderAddress: string;
+        network: BitcoinNetwork;
+        password?: string;
+        externalServerKeyShares?: ServerKeyShare[];
+        context?: SignMessageContext;
+        onError?: (error: Error) => void;
+    }): Promise<string>;
+    /**
+     * Exports the private key for a wallet
+     * @param accountAddress - The account address to export the private key for
+     * @param password - The password for encrypted backup shares
+     * @param externalServerKeyShares - Optional external server key shares
+     * @returns The private key in WIF format
+     */
+    exportPrivateKey({ accountAddress, password, externalServerKeyShares, }: {
+        accountAddress: string;
+        password?: string;
+        externalServerKeyShares?: ServerKeyShare[];
+    }): Promise<string>;
+    /**
+     * Exports the private key for a given account address offline using key shares
+     * @param keyShares - The key shares to export the private key for
+     * @param derivationPath - Optional derivation path
+     * @param bitcoinConfig - Bitcoin configuration (address type, network)
+     * @returns The private key in WIF format
+     */
+    offlineExportPrivateKey({ keyShares, derivationPath, bitcoinConfig, }: {
+        keyShares: (EcdsaKeygenResult | BIP340KeygenResult)[];
+        derivationPath?: string;
+        bitcoinConfig?: BitcoinConfig;
+    }): Promise<string>;
+    /**
+     * Imports a private key and stores the key shares in the wallet map.
+     * @param privateKey - The private key to import (WIF format)
+     * @param chainName - The chain name to use for the wallet
+     * @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 backUpToClientShareService - Whether to back up the external server key shares to the client share service. By default, it is false.
+     * @param bitcoinConfig - Bitcoin configuration (addressType, network)
+     * @returns The account address, public key, raw public key, external server key shares
+     */
+    importPrivateKey({ privateKey, chainName, thresholdSignatureScheme, password, backUpToClientShareService, onError, bitcoinConfig, }: {
+        privateKey: string;
+        chainName: string;
+        thresholdSignatureScheme: ThresholdSignatureScheme;
+        password?: string;
+        backUpToClientShareService?: boolean;
+        onError?: (error: Error) => void;
+        bitcoinConfig: BitcoinConfig;
+    }): Promise<{
+        accountAddress: string;
+        publicKeyHex: string;
+        rawPublicKey: EcdsaPublicKey | Uint8Array | string | undefined;
+        externalServerKeyShares: ServerKeyShare[];
+    }>;
+    /**
+     * Gets the Bitcoin wallets
+     * @returns The Bitcoin wallets
+     */
+    getBitcoinWallets(): Promise<WalletProperties[]>;
+}
+//# 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,EACL,mBAAmB,EACnB,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACnB,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EAEnB,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EAItB,MAAM,2BAA2B,CAAC;AACnC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,OAAO,EACL,kBAAkB,EAClB,cAAc,EACd,KAAK,aAAa,EACnB,MAAM,2BAA2B,CAAC;AAkCnC,qBAAa,sBAAuB,SAAQ,mBAAmB;IAC7D,QAAQ,CAAC,SAAS,SAAS;gBAEf,EACV,aAAa,EACb,UAAU,EACV,kBAAkB,EAClB,oBAAoB,GACrB,EAAE,wBAAwB;IAS3B;;;;;;;;;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;IAY9B;;;;OAIG;IACH,OAAO,CAAC,uBAAuB;IAsB/B;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAoB3B;;;;;;;;OAQG;IACG,mBAAmB,CAAC,EACxB,wBAAwB,EACxB,QAAoB,EACpB,OAAO,EACP,0BAAkC,EAClC,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,0BAA0B,CAAC,EAAE,OAAO,CAAC;QACrC,aAAa,EAAE,aAAa,CAAC;KAC9B,GAAG,OAAO,CAAC;QACV,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;QAC/D,uBAAuB,EAAE,cAAc,EAAE,CAAC;KAC3C,CAAC;IA2FF;;;;;;;;;;;;;;;OAeG;IACG,WAAW,CAAC,EAChB,OAAO,EACP,cAAc,EACd,OAAO,EACP,QAAoB,EACpB,uBAAuB,EACvB,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,uBAAuB,CAAC,EAAE,cAAc,EAAE,CAAC;QAC3C,OAAO,CAAC,EAAE,kBAAkB,CAAC;QAC7B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;KAClC,GAAG,OAAO,CAAC,MAAM,CAAC;IAuHnB;;;;;;;;;;;;;;;;OAgBG;IACG,eAAe,CAAC,EACpB,WAAW,EACX,aAAa,EACb,OAAO,EACP,QAAoB,EACpB,uBAAuB,EACvB,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,uBAAuB,CAAC,EAAE,cAAc,EAAE,CAAC;QAC3C,OAAO,CAAC,EAAE,kBAAkB,CAAC;QAC7B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;KAClC,GAAG,OAAO,CAAC,MAAM,CAAC;IAuMnB;;;;;;OAMG;IACG,gBAAgB,CAAC,EACrB,cAAc,EACd,QAAoB,EACpB,uBAAuB,GACxB,EAAE;QACD,cAAc,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,uBAAuB,CAAC,EAAE,cAAc,EAAE,CAAC;KAC5C,GAAG,OAAO,CAAC,MAAM,CAAC;IA4DnB;;;;;;OAMG;IACG,uBAAuB,CAAC,EAC5B,SAAS,EACT,cAAc,EACd,aAAa,GACd,EAAE;QACD,SAAS,EAAE,CAAC,iBAAiB,GAAG,kBAAkB,CAAC,EAAE,CAAC;QACtD,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,aAAa,CAAC,EAAE,aAAa,CAAC;KAC/B,GAAG,OAAO,CAAC,MAAM,CAAC;IAmBnB;;;;;;;;;;OAUG;IACG,gBAAgB,CAAC,EACrB,UAAU,EACV,SAAS,EACT,wBAAwB,EACxB,QAAoB,EACpB,0BAAkC,EAClC,OAAO,EACP,aAAa,GACd,EAAE;QACD,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,wBAAwB,EAAE,wBAAwB,CAAC;QACnD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,0BAA0B,CAAC,EAAE,OAAO,CAAC;QACrC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;QACjC,aAAa,EAAE,aAAa,CAAC;KAC9B,GAAG,OAAO,CAAC;QACV,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;QAC/D,uBAAuB,EAAE,cAAc,EAAE,CAAC;KAC3C,CAAC;IAkIF;;;OAGG;IACG,iBAAiB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;CAQvD"}

package/src/client/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const ERROR_CREATE_WALLET_ACCOUNT = "Error creating wallet account";
+export declare const ERROR_ACCOUNT_ADDRESS_REQUIRED = "Account address is required";
+export declare const ERROR_SIGN_MESSAGE = "Error signing message";
+export declare const ERROR_SIGN_TRANSACTION = "Error signing transaction";
+export declare const ERROR_IMPORT_PRIVATE_KEY = "Error importing private key";
+export declare const ERROR_KEYGEN_FAILED = "Error with keygen";
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/client/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,2BAA2B,kCAAkC,CAAC;AAC3E,eAAO,MAAM,8BAA8B,gCAAgC,CAAC;AAC5E,eAAO,MAAM,kBAAkB,0BAA0B,CAAC;AAC1D,eAAO,MAAM,sBAAsB,8BAA8B,CAAC;AAClE,eAAO,MAAM,wBAAwB,gCAAgC,CAAC;AACtE,eAAO,MAAM,mBAAmB,sBAAsB,CAAC"}

package/src/client/index.d.ts

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

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

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

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client/index.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,mBAAmB,CAAC"}

package/src/services/logger.d.ts

@@ -0,0 +1,10 @@
+import { Logger } from '@dynamic-labs/logger';
+export declare const logger: Logger;
+declare const logError: ({ message, error, context, }: {
+    message: string;
+    error: Error;
+    context: Record<string, unknown>;
+}) => void;
+export { Logger } from '@dynamic-labs/logger';
+export { logError };
+//# sourceMappingURL=logger.d.ts.map

package/src/services/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/services/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAI9C,eAAO,MAAM,MAAM,QAAwC,CAAC;AAE5D,QAAA,MAAM,QAAQ,iCAIX;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAClC,KAAG,IAQH,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,CAAC"}