@dynamic-labs-sdk/bitcoin 1.18.0 → 1.19.0

package/dist/isBitcoinWalletAccount/isBitcoinWalletAccount.d.ts

@@ -3,9 +3,17 @@ import type { BitcoinWalletAccount } from '../BitcoinWalletAccount.types';
 /**
  * Type guard function to check if a wallet account is a Bitcoin wallet account.
  *
+ * @example
+ * ```ts
+ * const accounts = getWalletAccounts();
+ * const btcAccounts = accounts.filter(isBitcoinWalletAccount);
+ * ```
+ *
  * @param walletAccount - The wallet account to check.
  * @returns True if the wallet account is a Bitcoin wallet account, false otherwise.
-  * @notInstrumented
+ * @see isBitcoinNetworkProvider
+ * @see addBitcoinExtension
+ * @notInstrumented
  */
 export declare const isBitcoinWalletAccount: (walletAccount: WalletAccount) => walletAccount is BitcoinWalletAccount;
 //# sourceMappingURL=isBitcoinWalletAccount.d.ts.map

package/dist/isBitcoinWalletAccount/isBitcoinWalletAccount.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isBitcoinWalletAccount.d.ts","sourceRoot":"","sources":["../../src/isBitcoinWalletAccount/isBitcoinWalletAccount.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAE1E;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,kBAClB,aAAa,KAC3B,aAAa,IAAI,oBAAqD,CAAC"}
+{"version":3,"file":"isBitcoinWalletAccount.d.ts","sourceRoot":"","sources":["../../src/isBitcoinWalletAccount/isBitcoinWalletAccount.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAE1E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,sBAAsB,kBAClB,aAAa,KAC3B,aAAa,IAAI,oBAAqD,CAAC"}

package/dist/sendBitcoin/sendBitcoin.d.ts

@@ -5,14 +5,25 @@ type SendBitcoinParams = {
     walletAccount: BitcoinWalletAccount;
 };
 /**
- * Sends a Bitcoin transaction
- * @param params.transaction - The transaction to send
- * @param params.walletAccount - The wallet account to send the transaction from
+ * Sends a Bitcoin transaction.
+ *
+ * @example
+ * ```ts
+ * const { transactionId } = await sendBitcoin({
+ *   walletAccount: btcAccount,
+ *   transaction: { recipientAddress: 'bc1q...', amount: 50000n },
+ * });
+ * ```
+ *
+ * @param params.transaction - The transaction to send.
+ * @param params.walletAccount - The wallet account to send the transaction from.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns An object containing the transaction id
- * @throws {MethodNotImplementedError} If the wallet provider does not implement the sendBitcoin method
- * @throws {NotBitcoinProviderError} If the wallet account is not a valid BitcoinWalletAccount
-  * @notInstrumented
+ * @returns An object containing the transaction id.
+ * @throws {MethodNotImplementedError} If the wallet provider does not implement the sendBitcoin method.
+ * @throws {NotBitcoinProviderError} If the wallet account is not a valid BitcoinWalletAccount.
+ * @see sendRawTransaction
+ * @see signPsbt
+ * @notInstrumented
  */
 export declare const sendBitcoin: ({ walletAccount, transaction }: SendBitcoinParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => Promise<BitcoinSendTransactionResponse>;
 export {};

package/dist/sendBitcoin/sendBitcoin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendBitcoin.d.ts","sourceRoot":"","sources":["../../src/sendBitcoin/sendBitcoin.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EACV,8BAA8B,EAC9B,kBAAkB,EACnB,MAAM,gCAAgC,CAAC;AAIxC,KAAK,iBAAiB,GAAG;IACvB,WAAW,EAAE,kBAAkB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,mCACU,iBAAiB,gEAEhD,OAAO,CAAC,8BAA8B,CAiBxC,CAAC"}
+{"version":3,"file":"sendBitcoin.d.ts","sourceRoot":"","sources":["../../src/sendBitcoin/sendBitcoin.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EACV,8BAA8B,EAC9B,kBAAkB,EACnB,MAAM,gCAAgC,CAAC;AAIxC,KAAK,iBAAiB,GAAG;IACvB,WAAW,EAAE,kBAAkB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,WAAW,mCACU,iBAAiB,gEAEhD,OAAO,CAAC,8BAA8B,CAiBxC,CAAC"}

package/dist/sendRawTransaction/sendRawTransaction.d.ts

@@ -4,11 +4,24 @@ type SendRawTransactionParams = {
     walletAccount: BitcoinWalletAccount;
 };
 /**
- * Sends a raw transaction using the mempool.space API
- * @param params.rawTransaction - The raw transaction to send
- * @param params.walletAccount - The wallet account to send the transaction from
- * @returns An object containing the transaction id
-  * @notInstrumented
+ * Sends a raw transaction using the mempool.space API.
+ *
+ * @example
+ * ```ts
+ * const { transactionId } = await sendRawTransaction({
+ *   walletAccount: btcAccount,
+ *   rawTransaction: '0200000001...',
+ * });
+ * ```
+ *
+ * @param params.rawTransaction - The raw transaction hex to broadcast.
+ * @param params.walletAccount - The wallet account whose network determines the API endpoint.
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns An object containing the transaction id.
+ * @throws {SendBitcoinRawTransactionError} If the mempool API returns an error.
+ * @see sendBitcoin
+ * @see signPsbt
+ * @notInstrumented
  */
 export declare const sendRawTransaction: ({ rawTransaction, walletAccount }: SendRawTransactionParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => Promise<{
     transactionId: string;

package/dist/sendRawTransaction/sendRawTransaction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendRawTransaction.d.ts","sourceRoot":"","sources":["../../src/sendRawTransaction/sendRawTransaction.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAI1E,KAAK,wBAAwB,GAAG;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,sCACM,wBAAwB,gEAE1D,OAAO,CAAC;IACT,aAAa,EAAE,MAAM,CAAC;CACvB,CAuBA,CAAC"}
+{"version":3,"file":"sendRawTransaction.d.ts","sourceRoot":"","sources":["../../src/sendRawTransaction/sendRawTransaction.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAI1E,KAAK,wBAAwB,GAAG;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,kBAAkB,sCACM,wBAAwB,gEAE1D,OAAO,CAAC;IACT,aAAa,EAAE,MAAM,CAAC;CACvB,CAuBA,CAAC"}

package/dist/signMessageWithCustomOptions/signMessageWithCustomOptions.d.ts

@@ -7,19 +7,32 @@ type SignMessageWithCustomOptionsParams = {
     walletAccount: BitcoinWalletAccount;
 };
 /**
- * Signs a message with custom options, like a specific address type or protocol
+ * Signs a message with custom options, like a specific address type or protocol.
  *
- * If the wallet provider does not support specifying an address type or protocol, it will use the default values.
+ * If the wallet provider does not support specifying an address type or protocol,
+ * it will use the default values.
  *
- * @param params.addressType - The address type to use for signing ('ordinals' or 'payment')
- * @param params.message - The message to sign
- * @param params.protocol - The protocol to use for signing ('ecdsa' or 'bip322-simple')
- * @param params.walletAccount - The wallet account to sign the message with
+ * @example
+ * ```ts
+ * const { signature } = await signMessageWithCustomOptions({
+ *   walletAccount: btcAccount,
+ *   message: 'Hello Bitcoin',
+ *   protocol: 'bip322-simple',
+ *   addressType: 'payment',
+ * });
+ * ```
+ *
+ * @param params.addressType - The address type to use for signing ('ordinals' or 'payment').
+ * @param params.message - The message to sign.
+ * @param params.protocol - The protocol to use for signing ('ecdsa' or 'bip322-simple').
+ * @param params.walletAccount - The wallet account to sign the message with.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns An object containing the signature
- * @throws {MethodNotImplementedError} If the wallet provider does not implement the signMessage method
- * @throws {NotBitcoinProviderError} If the wallet account is not a valid BitcoinWalletAccount
-  * @notInstrumented
+ * @returns An object containing the signature.
+ * @throws {MethodNotImplementedError} If the wallet provider does not implement the signMessage method.
+ * @throws {NotBitcoinProviderError} If the wallet account is not a valid BitcoinWalletAccount.
+ * @see signPsbt
+ * @see sendBitcoin
+ * @notInstrumented
  */
 export declare const signMessageWithCustomOptions: ({ walletAccount, message, protocol, addressType, }: SignMessageWithCustomOptionsParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => Promise<{
     signature: string;

package/dist/signMessageWithCustomOptions/signMessageWithCustomOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signMessageWithCustomOptions.d.ts","sourceRoot":"","sources":["../../src/signMessageWithCustomOptions/signMessageWithCustomOptions.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,gCAAgC,CAAC;AAIxC,KAAK,kCAAkC,GAAG;IACxC,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,4BAA4B,uDAMpC,kCAAkC,gEAEpC,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAsB/B,CAAC"}
+{"version":3,"file":"signMessageWithCustomOptions.d.ts","sourceRoot":"","sources":["../../src/signMessageWithCustomOptions/signMessageWithCustomOptions.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,gCAAgC,CAAC;AAIxC,KAAK,kCAAkC,GAAG;IACxC,WAAW,CAAC,EAAE,kBAAkB,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAC/B,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,4BAA4B,uDAMpC,kCAAkC,gEAEpC,OAAO,CAAC;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,CAsB/B,CAAC"}

package/dist/signPsbt/signPsbt.d.ts

@@ -5,12 +5,24 @@ type SignPsbtParams = {
     walletAccount: BitcoinWalletAccount;
 };
 /**
- * Signs a PSBT
- * @param params.request - The request data to sign the PSBT
- * @param params.walletAccount - The wallet account to sign the PSBT with
+ * Signs a Partially Signed Bitcoin Transaction (PSBT).
+ *
+ * @example
+ * ```ts
+ * const { signedPsbt } = await signPsbt({
+ *   walletAccount: btcAccount,
+ *   request: { unsignedPsbtBase64: 'cHNidP8B...', allowedSighash: [1] },
+ * });
+ * ```
+ *
+ * @param params.request - The request data including the PSBT and inputs to sign.
+ * @param params.walletAccount - The wallet account to sign the PSBT with.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns An object containing the signed PSBT
-  * @notInstrumented
+ * @returns An object containing the signed PSBT.
+ * @throws {NotBitcoinProviderError} If the wallet account is not a valid BitcoinWalletAccount.
+ * @see signPsbts
+ * @see sendBitcoin
+ * @notInstrumented
  */
 export declare const signPsbt: ({ walletAccount, request }: SignPsbtParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => Promise<{
     signedPsbt: string;

package/dist/signPsbt/signPsbt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signPsbt.d.ts","sourceRoot":"","sources":["../../src/signPsbt/signPsbt.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAI7E,KAAK,cAAc,GAAG;IACpB,OAAO,EAAE,sBAAsB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,QAAQ,+BACS,cAAc,gEAEzC,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAahC,CAAC"}
+{"version":3,"file":"signPsbt.d.ts","sourceRoot":"","sources":["../../src/signPsbt/signPsbt.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAI7E,KAAK,cAAc,GAAG;IACpB,OAAO,EAAE,sBAAsB,CAAC;IAChC,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,QAAQ,+BACS,cAAc,gEAEzC,OAAO,CAAC;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,CAahC,CAAC"}

package/dist/signPsbts/signPsbts.d.ts

@@ -5,12 +5,27 @@ type SignPsbtsParams = {
     walletAccount: BitcoinWalletAccount;
 };
 /**
- * Signs multiple PSBTs
- * @param params.requests - The list of request data to sign the PSBTs
- * @param params.walletAccount - The wallet account to sign the PSBT with
+ * Signs multiple Partially Signed Bitcoin Transactions (PSBTs) in a single call.
+ *
+ * @example
+ * ```ts
+ * const { signedPsbts } = await signPsbts({
+ *   walletAccount: btcAccount,
+ *   requests: [
+ *     { unsignedPsbtBase64: 'cHNidP8B...', allowedSighash: [1] },
+ *     { unsignedPsbtBase64: 'cHNidP8C...', allowedSighash: [1] },
+ *   ],
+ * });
+ * ```
+ *
+ * @param params.requests - The list of request data to sign the PSBTs.
+ * @param params.walletAccount - The wallet account to sign the PSBTs with.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns An object containing the signed PSBT
-  * @notInstrumented
+ * @returns An object containing the array of signed PSBTs.
+ * @throws {NotBitcoinProviderError} If the wallet account is not a valid BitcoinWalletAccount.
+ * @see signPsbt
+ * @see sendBitcoin
+ * @notInstrumented
  */
 export declare const signPsbts: ({ walletAccount, requests }: SignPsbtsParams, client?: import("@dynamic-labs-sdk/client").DynamicClient) => Promise<{
     signedPsbts: string[];

package/dist/signPsbts/signPsbts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signPsbts.d.ts","sourceRoot":"","sources":["../../src/signPsbts/signPsbts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAI7E,KAAK,eAAe,GAAG;IACrB,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS,gCACS,eAAe,gEAE3C,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,EAAE,CAAA;CAAE,CAanC,CAAC"}
+{"version":3,"file":"signPsbts.d.ts","sourceRoot":"","sources":["../../src/signPsbts/signPsbts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAI7E,KAAK,eAAe,GAAG;IACrB,QAAQ,EAAE,sBAAsB,EAAE,CAAC;IACnC,aAAa,EAAE,oBAAoB,CAAC;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,SAAS,gCACS,eAAe,gEAE3C,OAAO,CAAC;IAAE,WAAW,EAAE,MAAM,EAAE,CAAA;CAAE,CAanC,CAAC"}