@bigmi/core 0.7.1 → 0.8.0

package/dist/esm/actions/getXPubAddresses.d.ts

@@ -1,33 +1,37 @@
-import type { UTXOSchema } from '../transports/types.js';
-import type { Account } from '../types/account.js';
-import type { Chain } from '../types/chain.js';
-import type { Client } from '../types/client.js';
-import type { Transport } from '../types/transport.js';
-import type { xPubAccount } from '../types/xpub.js';
-export type GetXPubAddressesParameters = {
-    /** The public key you're trying to get addresses of. */
-    xPubKey: string;
+import { Chain } from "../types/chain.js";
+import { xPubAccount } from "../types/xpub.js";
+import { UTXOSchema } from "../transports/types.js";
+import { Account } from "../types/account.js";
+import { Transport } from "../types/transport.js";
+import { Client } from "../types/client.js";
+
+//#region src/actions/getXPubAddresses.d.ts
+type GetXPubAddressesParameters = {
+  /** The public key you're trying to get addresses of. */xPubKey: string;
 };
-export type GetXPubAddressesReturnType = xPubAccount;
+type GetXPubAddressesReturnType = xPubAccount;
 /**
- * Retrieves all addresses and their balances associated with an extended public key (xPub).
- *
- * An extended public key (xPub) is a Bitcoin public key that can be used to derive multiple
- * child addresses. This action fetches all derived addresses along with their individual balances
- * and the total balance across all addresses.
- *
- * @param client - Client instance configured with UTXO transport
- * @param params - {@link GetXPubAddressesParameters}
- * @returns The xPub account data including total balance and all derived addresses. {@link GetXPubAddressesReturnType}
- *
- * @example
- * ```typescript
- * const result = await getXPubAddresses(client, {
- *   xPubKey: 'xpub6CcGTthbwnbxsMRuEF3sb...'
- * })
- *
- * console.log(result.balance) // Total balance across all addresses
- * console.log(result.addresses) // Array of derived addresses with individual balances
- * ```
- */
-export declare function getXPubAddresses<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, params: GetXPubAddressesParameters): Promise<GetXPubAddressesReturnType>;
+* Retrieves all addresses and their balances associated with an extended public key (xPub).
+*
+* An extended public key (xPub) is a Bitcoin public key that can be used to derive multiple
+* child addresses. This action fetches all derived addresses along with their individual balances
+* and the total balance across all addresses.
+*
+* @param client - Client instance configured with UTXO transport
+* @param params - {@link GetXPubAddressesParameters}
+* @returns The xPub account data including total balance and all derived addresses. {@link GetXPubAddressesReturnType}
+*
+* @example
+* ```typescript
+* const result = await getXPubAddresses(client, {
+*   xPubKey: 'xpub6CcGTthbwnbxsMRuEF3sb...'
+* })
+*
+* console.log(result.balance) // Total balance across all addresses
+* console.log(result.addresses) // Array of derived addresses with individual balances
+* ```
+*/
+declare function getXPubAddresses<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, params: GetXPubAddressesParameters): Promise<GetXPubAddressesReturnType>;
+//#endregion
+export { GetXPubAddressesParameters, GetXPubAddressesReturnType, getXPubAddresses };
+//# sourceMappingURL=getXPubAddresses.d.ts.map

package/dist/esm/actions/getXPubAddresses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getXPubAddresses.d.ts","names":[],"sources":["../../../src/actions/getXPubAddresses.ts"],"mappings":";;;;;;;;KAOY,0BAAA;0DAEV,OAAA;AAAA;AAAA,KAGU,0BAAA,GAA6B,WAAA;;;AAAzC;;;;;AAuBA;;;;;;;;;;;;;;iBAAsB,gBAAA,WACV,KAAA,wBACA,OAAA,eAAsB,OAAA,aAAA,CAEhC,MAAA,EAAQ,MAAA,CAAO,SAAA,EAAW,CAAA,EAAG,CAAA,EAAG,UAAA,GAChC,MAAA,EAAQ,0BAAA,GACP,OAAA,CAAQ,0BAAA"}

package/dist/esm/actions/getXPubAddresses.js

@@ -1,29 +1,32 @@
+//#region src/actions/getXPubAddresses.ts
 /**
- * Retrieves all addresses and their balances associated with an extended public key (xPub).
- *
- * An extended public key (xPub) is a Bitcoin public key that can be used to derive multiple
- * child addresses. This action fetches all derived addresses along with their individual balances
- * and the total balance across all addresses.
- *
- * @param client - Client instance configured with UTXO transport
- * @param params - {@link GetXPubAddressesParameters}
- * @returns The xPub account data including total balance and all derived addresses. {@link GetXPubAddressesReturnType}
- *
- * @example
- * ```typescript
- * const result = await getXPubAddresses(client, {
- *   xPubKey: 'xpub6CcGTthbwnbxsMRuEF3sb...'
- * })
- *
- * console.log(result.balance) // Total balance across all addresses
- * console.log(result.addresses) // Array of derived addresses with individual balances
- * ```
- */
-export async function getXPubAddresses(client, params) {
-    const data = await client.request({
-        method: 'getXPubAddresses',
-        params,
-    }, { dedupe: true });
-    return data;
+* Retrieves all addresses and their balances associated with an extended public key (xPub).
+*
+* An extended public key (xPub) is a Bitcoin public key that can be used to derive multiple
+* child addresses. This action fetches all derived addresses along with their individual balances
+* and the total balance across all addresses.
+*
+* @param client - Client instance configured with UTXO transport
+* @param params - {@link GetXPubAddressesParameters}
+* @returns The xPub account data including total balance and all derived addresses. {@link GetXPubAddressesReturnType}
+*
+* @example
+* ```typescript
+* const result = await getXPubAddresses(client, {
+*   xPubKey: 'xpub6CcGTthbwnbxsMRuEF3sb...'
+* })
+*
+* console.log(result.balance) // Total balance across all addresses
+* console.log(result.addresses) // Array of derived addresses with individual balances
+* ```
+*/
+async function getXPubAddresses(client, params) {
+	return await client.request({
+		method: "getXPubAddresses",
+		params
+	}, { dedupe: true });
 }
+//#endregion
+export { getXPubAddresses };
+
 //# sourceMappingURL=getXPubAddresses.js.map

package/dist/esm/actions/getXPubAddresses.js.map

@@ -1 +1 @@
-{"version":3,"file":"getXPubAddresses.js","sourceRoot":"","sources":["../../../src/actions/getXPubAddresses.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAIpC,MAA2C,EAC3C,MAAkC;IAElC,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAC/B;QACE,MAAM,EAAE,kBAAkB;QAC1B,MAAM;KACP,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IAED,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"getXPubAddresses.js","names":[],"sources":["../../../src/actions/getXPubAddresses.ts"],"sourcesContent":["import type { UTXOSchema } from '../transports/types.js'\nimport type { Account } from '../types/account.js'\nimport type { Chain } from '../types/chain.js'\nimport type { Client } from '../types/client.js'\nimport type { Transport } from '../types/transport.js'\nimport type { xPubAccount } from '../types/xpub.js'\n\nexport type GetXPubAddressesParameters = {\n  /** The public key you're trying to get addresses of. */\n  xPubKey: string\n}\n\nexport type GetXPubAddressesReturnType = xPubAccount\n\n/**\n * Retrieves all addresses and their balances associated with an extended public key (xPub).\n *\n * An extended public key (xPub) is a Bitcoin public key that can be used to derive multiple\n * child addresses. This action fetches all derived addresses along with their individual balances\n * and the total balance across all addresses.\n *\n * @param client - Client instance configured with UTXO transport\n * @param params - {@link GetXPubAddressesParameters}\n * @returns The xPub account data including total balance and all derived addresses. {@link GetXPubAddressesReturnType}\n *\n * @example\n * ```typescript\n * const result = await getXPubAddresses(client, {\n *   xPubKey: 'xpub6CcGTthbwnbxsMRuEF3sb...'\n * })\n *\n * console.log(result.balance) // Total balance across all addresses\n * console.log(result.addresses) // Array of derived addresses with individual balances\n * ```\n */\nexport async function getXPubAddresses<\n  C extends Chain | undefined,\n  A extends Account | undefined = Account | undefined,\n>(\n  client: Client<Transport, C, A, UTXOSchema>,\n  params: GetXPubAddressesParameters\n): Promise<GetXPubAddressesReturnType> {\n  const data = await client.request(\n    {\n      method: 'getXPubAddresses',\n      params,\n    },\n    { dedupe: true }\n  )\n\n  return data\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAmCA,eAAsB,iBAIpB,QACA,QACqC;AASrC,QARa,MAAM,OAAO,QACxB;EACE,QAAQ;EACR;EACD,EACD,EAAE,QAAQ,MAAM,CACjB"}

package/dist/esm/actions/sendUTXOTransaction.d.ts

@@ -1,13 +1,19 @@
-import type { UTXOSchema } from '../transports/types.js';
-import type { Account } from '../types/account.js';
-import type { Chain } from '../types/chain.js';
-import type { Client } from '../types/client.js';
-import type { Transport } from '../types/transport.js';
-export type SendUTXOTransactionParameters = {
-    /** The hex string of the raw transaction. */
-    hex: string;
-    /** Rejects transactions whose fee rate is higher than the specified value, expressed in BTC/kB. Set to 0 to accept any fee rate. Default = 0.10 */
-    maxFeeRate?: number;
+import { Chain } from "../types/chain.js";
+import { UTXOSchema } from "../transports/types.js";
+import { Account } from "../types/account.js";
+import { Transport } from "../types/transport.js";
+import { Client } from "../types/client.js";
+
+//#region src/actions/sendUTXOTransaction.d.ts
+type SendUTXOTransactionParameters = {
+  /** The hex string of the raw transaction. */hex: string; /** Rejects transactions whose fee rate is higher than the specified value, expressed in BTC/kB. Set to 0 to accept any fee rate. Default = 0.10 */
+  maxFeeRate?: number;
 };
-export type SendUTXOTransactionReturnType = string;
-export declare function sendUTXOTransaction<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, { hex, maxFeeRate }: SendUTXOTransactionParameters): Promise<SendUTXOTransactionReturnType>;
+type SendUTXOTransactionReturnType = string;
+declare function sendUTXOTransaction<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, {
+  hex,
+  maxFeeRate
+}: SendUTXOTransactionParameters): Promise<SendUTXOTransactionReturnType>;
+//#endregion
+export { SendUTXOTransactionParameters, SendUTXOTransactionReturnType, sendUTXOTransaction };
+//# sourceMappingURL=sendUTXOTransaction.d.ts.map

package/dist/esm/actions/sendUTXOTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sendUTXOTransaction.d.ts","names":[],"sources":["../../../src/actions/sendUTXOTransaction.ts"],"mappings":";;;;;;;KAMY,6BAAA;+CAEV,GAAA,UAFU;EAIV,UAAA;AAAA;AAAA,KAGU,6BAAA;AAAA,iBAEU,mBAAA,WACV,KAAA,wBACA,OAAA,eAAsB,OAAA,aAAA,CAEhC,MAAA,EAAQ,MAAA,CAAO,SAAA,EAAW,CAAA,EAAG,CAAA,EAAG,UAAA;EAC9B,GAAA;EAAK;AAAA,GAAc,6BAAA,GACpB,OAAA,CAAQ,6BAAA"}

package/dist/esm/actions/sendUTXOTransaction.js

@@ -1,12 +1,13 @@
-export async function sendUTXOTransaction(client, { hex, maxFeeRate }) {
-    const params = [hex];
-    if (maxFeeRate) {
-        params.push(maxFeeRate);
-    }
-    const data = await client.request({
-        method: 'sendrawtransaction',
-        params: params,
-    });
-    return data;
+//#region src/actions/sendUTXOTransaction.ts
+async function sendUTXOTransaction(client, { hex, maxFeeRate }) {
+	const params = [hex];
+	if (maxFeeRate) params.push(maxFeeRate);
+	return await client.request({
+		method: "sendrawtransaction",
+		params
+	});
 }
+//#endregion
+export { sendUTXOTransaction };
+
 //# sourceMappingURL=sendUTXOTransaction.js.map

package/dist/esm/actions/sendUTXOTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"sendUTXOTransaction.js","sourceRoot":"","sources":["../../../src/actions/sendUTXOTransaction.ts"],"names":[],"mappings":"AAeA,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAIvC,MAA2C,EAC3C,EAAE,GAAG,EAAE,UAAU,EAAiC;IAElD,MAAM,MAAM,GAAsB,CAAC,GAAG,CAAC,CAAA;IACvC,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IACzB,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;QAChC,MAAM,EAAE,oBAAoB;QAC5B,MAAM,EAAE,MAAM;KACf,CAAC,CAAA;IACF,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"sendUTXOTransaction.js","names":[],"sources":["../../../src/actions/sendUTXOTransaction.ts"],"sourcesContent":["import type { UTXOSchema } from '../transports/types.js'\nimport type { Account } from '../types/account.js'\nimport type { Chain } from '../types/chain.js'\nimport type { Client } from '../types/client.js'\nimport type { Transport } from '../types/transport.js'\n\nexport type SendUTXOTransactionParameters = {\n  /** The hex string of the raw transaction. */\n  hex: string\n  /** Rejects transactions whose fee rate is higher than the specified value, expressed in BTC/kB. Set to 0 to accept any fee rate. Default = 0.10 */\n  maxFeeRate?: number\n}\n\nexport type SendUTXOTransactionReturnType = string\n\nexport async function sendUTXOTransaction<\n  C extends Chain | undefined,\n  A extends Account | undefined = Account | undefined,\n>(\n  client: Client<Transport, C, A, UTXOSchema>,\n  { hex, maxFeeRate }: SendUTXOTransactionParameters\n): Promise<SendUTXOTransactionReturnType> {\n  const params: [string, number?] = [hex]\n  if (maxFeeRate) {\n    params.push(maxFeeRate)\n  }\n  const data = await client.request({\n    method: 'sendrawtransaction',\n    params: params,\n  })\n  return data\n}\n"],"mappings":";AAeA,eAAsB,oBAIpB,QACA,EAAE,KAAK,cACiC;CACxC,MAAM,SAA4B,CAAC,IAAI;AACvC,KAAI,WACF,QAAO,KAAK,WAAW;AAMzB,QAJa,MAAM,OAAO,QAAQ;EAChC,QAAQ;EACA;EACT,CAAC"}

package/dist/esm/actions/signPsbt.d.ts

@@ -1,6 +1,11 @@
-import type { SignPsbtParameters, SignPsbtReturnType, UTXOWalletSchema } from '../transports/types.js';
-import type { Account } from '../types/account.js';
-import type { Chain } from '../types/chain.js';
-import type { Client } from '../types/client.js';
-import type { Transport } from '../types/transport.js';
-export declare function signPsbt<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOWalletSchema>, params: SignPsbtParameters): Promise<SignPsbtReturnType>;
+import { Chain } from "../types/chain.js";
+import { SignPsbtParameters, SignPsbtReturnType, UTXOWalletSchema } from "../transports/types.js";
+import { Account } from "../types/account.js";
+import { Transport } from "../types/transport.js";
+import { Client } from "../types/client.js";
+
+//#region src/actions/signPsbt.d.ts
+declare function signPsbt<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOWalletSchema>, params: SignPsbtParameters): Promise<SignPsbtReturnType>;
+//#endregion
+export { signPsbt };
+//# sourceMappingURL=signPsbt.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"signPsbt.d.ts","names":[],"sources":["../../../src/actions/signPsbt.ts"],"mappings":";;;;;;;iBAUsB,QAAA,WACV,KAAA,wBACA,OAAA,eAAsB,OAAA,aAAA,CAEhC,MAAA,EAAQ,MAAA,CAAO,SAAA,EAAW,CAAA,EAAG,CAAA,EAAG,gBAAA,GAChC,MAAA,EAAQ,kBAAA,GACP,OAAA,CAAQ,kBAAA"}

package/dist/esm/actions/signPsbt.js

@@ -1,8 +1,11 @@
-export async function signPsbt(client, params) {
-    const data = await client.request({
-        method: 'signPsbt',
-        params: params,
-    }, { dedupe: true });
-    return data;
+//#region src/actions/signPsbt.ts
+async function signPsbt(client, params) {
+	return await client.request({
+		method: "signPsbt",
+		params
+	}, { dedupe: true });
 }
+//#endregion
+export { signPsbt };
+
 //# sourceMappingURL=signPsbt.js.map

package/dist/esm/actions/signPsbt.js.map

@@ -1 +1 @@
-{"version":3,"file":"signPsbt.js","sourceRoot":"","sources":["../../../src/actions/signPsbt.ts"],"names":[],"mappings":"AAUA,MAAM,CAAC,KAAK,UAAU,QAAQ,CAI5B,MAAiD,EACjD,MAA0B;IAE1B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAC/B;QACE,MAAM,EAAE,UAAU;QAClB,MAAM,EAAE,MAAM;KACf,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}
+{"version":3,"file":"signPsbt.js","names":[],"sources":["../../../src/actions/signPsbt.ts"],"sourcesContent":["import type {\n  SignPsbtParameters,\n  SignPsbtReturnType,\n  UTXOWalletSchema,\n} from '../transports/types.js'\nimport type { Account } from '../types/account.js'\nimport type { Chain } from '../types/chain.js'\nimport type { Client } from '../types/client.js'\nimport type { Transport } from '../types/transport.js'\n\nexport async function signPsbt<\n  C extends Chain | undefined,\n  A extends Account | undefined = Account | undefined,\n>(\n  client: Client<Transport, C, A, UTXOWalletSchema>,\n  params: SignPsbtParameters\n): Promise<SignPsbtReturnType> {\n  const data = await client.request(\n    {\n      method: 'signPsbt',\n      params: params,\n    },\n    { dedupe: true }\n  )\n  return data\n}\n"],"mappings":";AAUA,eAAsB,SAIpB,QACA,QAC6B;AAQ7B,QAPa,MAAM,OAAO,QACxB;EACE,QAAQ;EACA;EACT,EACD,EAAE,QAAQ,MAAM,CACjB"}

package/dist/esm/actions/waitForTransaction.d.ts

@@ -1,77 +1,87 @@
-import { Transaction } from 'bitcoinjs-lib';
-import type { Chain } from '../types/chain.js';
-import type { Client } from '../types/client.js';
-import type { UTXOTransaction } from '../types/transaction.js';
-import type { Transport } from '../types/transport.js';
-export type ReplacementReason = 'cancelled' | 'replaced' | 'repriced';
-export type ReplacementReturnType = {
-    reason: ReplacementReason;
-    replacedTransaction: Transaction;
-    transaction: UTXOTransaction;
+import { UTXOTransaction } from "../types/transaction.js";
+import { Chain } from "../types/chain.js";
+import { Transport } from "../types/transport.js";
+import { Client } from "../types/client.js";
+import { Transaction } from "bitcoinjs-lib";
+
+//#region src/actions/waitForTransaction.d.ts
+type ReplacementReason = "cancelled" | "replaced" | "repriced";
+type ReplacementReturnType = {
+  reason: ReplacementReason;
+  replacedTransaction: Transaction;
+  transaction: UTXOTransaction;
 };
-export type WaitForTransactionReceiptReturnType = UTXOTransaction;
-export type WithRetryParameters = {
-    delay?: ((config: {
-        count: number;
-        error: Error;
-    }) => number) | number | undefined;
-    retryCount?: number | undefined;
+type WaitForTransactionReceiptReturnType = UTXOTransaction;
+type WithRetryParameters = {
+  delay?: ((config: {
+    count: number;
+    error: Error;
+  }) => number) | number | undefined;
+  retryCount?: number | undefined;
 };
-export type WaitForTransactionReceiptParameters = {
-    /** The Id of the transaction. */
-    txId: string;
-    /** The hex string of the raw transaction. */
-    txHex: string;
-    /** The sender address of the transaction. */
-    senderAddress?: string;
-    /**
-     * The number of confirmations (blocks that have passed) to wait before resolving.
-     * @default 1
-     */
-    confirmations?: number | undefined;
-    /** Optional callback to emit if the transaction has been replaced. */
-    onReplaced?: ((response: ReplacementReturnType) => void) | undefined;
-    /**
-     * Polling frequency (in ms). Defaults to the client's pollingInterval config.
-     * @default client.pollingInterval
-     */
-    pollingInterval?: number | undefined;
-    /**
-     * Number of times to retry if the transaction or block is not found.
-     * @default 6 (exponential backoff)
-     */
-    retryCount?: number;
-    /**
-     * Time to wait (in ms) between retries.
-     */
-    retryDelay?: ((config: {
-        count: number;
-        error: Error;
-    }) => number) | number;
-    /** Optional timeout (in milliseconds) to wait before stopping polling. */
-    timeout?: number | undefined;
+type WaitForTransactionReceiptParameters = {
+  /** The Id of the transaction. */txId: string; /** The hex string of the raw transaction. */
+  txHex: string; /** The sender address of the transaction. */
+  senderAddress?: string;
+  /**
+  * The number of confirmations (blocks that have passed) to wait before resolving.
+  * @default 1
+  */
+  confirmations?: number | undefined; /** Optional callback to emit if the transaction has been replaced. */
+  onReplaced?: ((response: ReplacementReturnType) => void) | undefined;
+  /**
+  * Polling frequency (in ms). Defaults to the client's pollingInterval config.
+  * @default client.pollingInterval
+  */
+  pollingInterval?: number | undefined;
+  /**
+  * Number of times to retry if the transaction or block is not found.
+  * @default 6 (exponential backoff)
+  */
+  retryCount?: number;
+  /**
+  * Time to wait (in ms) between retries.
+  */
+  retryDelay?: ((config: {
+    count: number;
+    error: Error;
+  }) => number) | number; /** Optional timeout (in milliseconds) to wait before stopping polling. */
+  timeout?: number | undefined;
 };
 /**
- * Waits for the transaction to be included on a block (one confirmation), and then returns the transaction.
- * - JSON-RPC Methods:
- * - Polls getrawtransaction on each block until it has been processed.
- * - If a transaction has been replaced:
- * - Calls getblock and extracts the transactions
- * - Checks if one of the transactions is a replacement
- * - If so, calls getrawtransaction.
- *
- * The `waitForTransaction` action additionally supports replacement detection (e.g. RBF - transactions replaced-by-fee ).
- *
- * Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel).
- * https://bitcoinops.org/en/topics/replace-by-fee/
- *
- * There are 3 types of Transaction Replacement reasons:
- *
- * - `repriced`: The fee has been modified (e.g. same outputs, different amounts)
- * - `cancelled`: The Transaction has been cancelled (e.g. output is sender address)
- * - `replaced`: The Transaction has been replaced (e.g. different outputs)
- * @param client - Client to use
- * @param parameters - {@link WaitForTransactionReceiptParameters}
- * @returns The UTXO transaction. {@link WaitForTransactionReceiptReturnType}
- */
-export declare function waitForTransaction<chain extends Chain | undefined>(client: Client<Transport, chain>, { confirmations, txId, txHex, senderAddress, onReplaced, pollingInterval, retryCount, retryDelay, timeout, }: WaitForTransactionReceiptParameters): Promise<WaitForTransactionReceiptReturnType>;
+* Waits for the transaction to be included on a block (one confirmation), and then returns the transaction.
+* - JSON-RPC Methods:
+* - Polls getrawtransaction on each block until it has been processed.
+* - If a transaction has been replaced:
+* - Calls getblock and extracts the transactions
+* - Checks if one of the transactions is a replacement
+* - If so, calls getrawtransaction.
+*
+* The `waitForTransaction` action additionally supports replacement detection (e.g. RBF - transactions replaced-by-fee ).
+*
+* Transactions can be replaced when a user modifies their transaction in their wallet (to speed up or cancel).
+* https://bitcoinops.org/en/topics/replace-by-fee/
+*
+* There are 3 types of Transaction Replacement reasons:
+*
+* - `repriced`: The fee has been modified (e.g. same outputs, different amounts)
+* - `cancelled`: The Transaction has been cancelled (e.g. output is sender address)
+* - `replaced`: The Transaction has been replaced (e.g. different outputs)
+* @param client - Client to use
+* @param parameters - {@link WaitForTransactionReceiptParameters}
+* @returns The UTXO transaction. {@link WaitForTransactionReceiptReturnType}
+*/
+declare function waitForTransaction<chain extends Chain | undefined>(client: Client<Transport, chain>, {
+  confirmations,
+  txId,
+  txHex,
+  senderAddress,
+  onReplaced,
+  pollingInterval,
+  retryCount,
+  retryDelay,
+  timeout
+}: WaitForTransactionReceiptParameters): Promise<WaitForTransactionReceiptReturnType>;
+//#endregion
+export { ReplacementReason, ReplacementReturnType, WaitForTransactionReceiptParameters, WaitForTransactionReceiptReturnType, WithRetryParameters, waitForTransaction };
+//# sourceMappingURL=waitForTransaction.d.ts.map

package/dist/esm/actions/waitForTransaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitForTransaction.d.ts","names":[],"sources":["../../../src/actions/waitForTransaction.ts"],"mappings":";;;;;;;KAmBY,iBAAA;AAAA,KACA,qBAAA;EACV,MAAA,EAAQ,iBAAA;EACR,mBAAA,EAAqB,WAAA;EACrB,WAAA,EAAa,eAAA;AAAA;AAAA,KAGH,mCAAA,GAAsC,eAAA;AAAA,KAEtC,mBAAA;EAEV,KAAA,KACM,MAAA;IAAU,KAAA;IAAe,KAAA,EAAO,KAAA;EAAA;EAItC,UAAA;AAAA;AAAA,KAGU,mCAAA;mCAEV,IAAA;EAEA,KAAA;EAEA,aAAA;;;AAlBF;;EAuBE,aAAA,uBAvBgD;EAyBhD,UAAA,KAAe,QAAA,EAAU,qBAAA;EAvB3B;;;;EA4BE,eAAA;;;;;EAKA,UAAA;;;AAvBF;EA2BE,UAAA,KAAe,MAAA;IAAU,KAAA;IAAe,KAAA,EAAO,KAAA;EAAA;EAE/C,OAAA;AAAA;;;;;;;;;;;;;;AA0BF;;;;;;;;;;iBAAsB,kBAAA,eAAiC,KAAA,aAAA,CACrD,MAAA,EAAQ,MAAA,CAAO,SAAA,EAAW,KAAA;EAExB,aAAA;EACA,IAAA;EACA,KAAA;EACA,aAAA;EACA,UAAA;EACA,eAAA;EACA,UAAA;EACA,UAAA;EACA;AAAA,GACC,mCAAA,GACF,OAAA,CAAQ,mCAAA"}