@bigmi/core 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### 0.0.1 (2024-10-15)
+
+
+### Bug Fixes
+
+* biome checks ([bc348fa](https://github.com/lifinance/bigmi/commit/bc348faad5cec9ddada1a0c82f4d34e68b85c1c4))
+* tsconfig ([bf6ccea](https://github.com/lifinance/bigmi/commit/bf6cceae3a1602b99b4825ee3695b367d5935226))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Bigmi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,137 @@
+<div align="center">
+
+<h1 align="center">Bigmi</h1>
+<p align="center"><strong>TypeScript library and reactive primitives for Bitcoin apps.</strong></p>
+
+[![license](https://img.shields.io/npm/l/@bigmi/core)](/LICENSE.md)
+[![npm latest package](https://img.shields.io/npm/v/@bigmi/core/latest.svg)](https://www.npmjs.com/package/@bigmi/core)
+[![npm downloads](https://img.shields.io/npm/dm/@bigmi/core.svg)](https://www.npmjs.com/package/@bigmi/core)
+
+</div>
+
+**Bigmi** (short for *Bitcoin Is Gonna Make It*) is a TypeScript library that provides reactive primitives for building Bitcoin applications. Bigmi simplifies Bitcoin app development by offering:
+
+- Abstractions over the [Bitcoin JSON-RPC API](https://developer.bitcoin.org/reference/rpc/)
+- First-class APIs for interacting with the [Bitcoin](https://bitcoin.design/) network, including sending transactions and tracking with [Replace-By-Fee (RBF)](https://github.com/bitcoin/bips/blob/master/bip-0125.mediawiki) support
+- Connectors for popular Bitcoin wallet extensions
+- TypeScript support
+  
+Whether you're building a Node.js application or a client-side app, Bigmi provides the tools you need to interact with the Bitcoin.
+
+### Packages
+
+Bigmi is modularized into several packages, each suited to different use cases:
+
+- [@bigmi/core](https://www.npmjs.com/package/@bigmi/core) - Actions, transports, utilities, and other core primitives for Node.js or client-side applications.
+- [@bigmi/react](https://www.npmjs.com/package/@bigmi/react) - Hooks, providers, and other useful primitives for React applications.
+- [@bigmi/client](https://www.npmjs.com/package/@bigmi/client) - Wallet connectors and other tools to connect wallet extensions with Bitcoin applications.
+
+## Installation
+
+```sh
+pnpm add @bigmi/react
+```
+```sh
+pnpm add @bigmi/core
+```
+```sh
+pnpm add @bigmi/client
+```
+
+## Getting Started
+
+Here is an example of a basic usage:
+
+```tsx
+import {
+  type UTXOAPISchema,
+  bitcoin,
+  getBalance,
+  getBlockCount,
+  sendUTXOTransaction,
+  utxo,
+  waitForTransaction,
+} from '@bigmi/core'
+import { createClient, fallback, rpcSchema } from 'viem'
+
+// Create a public client for interactions with the Bitcoin
+const publicClient = createClient({
+  chain: bitcoin,
+  rpcSchema: rpcSchema<UTXOAPISchema>(),
+  transport: fallback([
+    utxo('https://api.blockchair.com', {
+      key: 'blockchair',
+      includeChainToURL: true,
+    }),
+    utxo('https://rpc.ankr.com/http/btc_blockbook/api/v2', {
+      key: 'ankr',
+    }),
+    utxo('https://api.blockcypher.com/v1/btc/main', {
+      key: 'blockcypher',
+    }),
+    utxo('https://mempool.space/api', {
+      key: 'mempool',
+    }),
+  ]),
+})
+
+// Define the Bitcoin address you're working with
+const address = 'BITCOIN_ADDRESS';
+
+// Fetch the balance of the address
+const balance = await getBalance(publicClient, { address });
+console.log(`Balance for ${address}:`, balance);
+
+// Fetch the current block count (height)
+const blockCount = await getBlockCount(publicClient);
+console.log('Current block count:', blockCount);
+
+// Prepare the transaction hex (as a string)
+const txHex = 'TRANSACTION_HEX';
+
+// Send the transaction to the network
+const txId = await sendUTXOTransaction(publicClient, { hex: txHex });
+console.log('Transaction sent with ID:', txId);
+
+// Wait for the transaction to be confirmed
+const transaction = await waitForTransaction(publicClient, {
+  txId,
+  txHex,
+  senderAddress: address,
+  onReplaced: (response) => {
+    console.log('Transaction replaced due to:', response.reason);
+  },
+});
+
+console.log('Transaction confirmed:', transaction);
+```
+
+## Examples
+
+We are working on examples to showcase Bigmi's capabilities. Stay tuned!
+
+In the meantime, explore the [LI.FI Widget](https://github.com/lifinance/widget) and [LI.FI SDK](https://github.com/lifinance/sdk) for inspiration.
+
+## Documentation
+
+Detailed documentation is coming soon. For now, refer to the source code and type definitions for guidance.
+
+## Support
+
+If you encounter any issues or have questions, please open an issue.
+
+## Contributing
+
+We welcome contributions from the community!
+
+## Changelog
+
+The [changelog](/CHANGELOG.md) is regularly updated to reflect what's changed in each new release.
+
+## License
+
+This project is licensed under the terms of the [MIT License](/LICENSE.md).
+
+## Acknowledgments
+
+Bigmi is inspired by the [wevm](https://github.com/wevm) stack. We appreciate the open-source community's contributions to advancing blockchain development.

package/dist/cjs/actions/getBalance.d.ts

@@ -0,0 +1,7 @@
+import type { Account, Chain, Client, Transport } from 'viem';
+import type { UTXOAPISchema } from '../transports/types.js';
+export type GetBalanceParameters = {
+    address: string;
+};
+export type GetBalanceReturnType = bigint;
+export declare function getBalance<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOAPISchema>, params: GetBalanceParameters): Promise<GetBalanceReturnType>;

package/dist/cjs/actions/getBalance.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBalance = getBalance;
+async function getBalance(client, params) {
+    const data = await client.request({
+        method: 'getBalance',
+        params,
+    }, { dedupe: true });
+    return data;
+}
+//# sourceMappingURL=getBalance.js.map

package/dist/cjs/actions/getBalance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBalance.js","sourceRoot":"","sources":["../../../src/actions/getBalance.ts"],"names":[],"mappings":";;AAUA,gCAeC;AAfM,KAAK,UAAU,UAAU,CAI9B,MAA8C,EAC9C,MAA4B;IAE5B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAC/B;QACE,MAAM,EAAE,YAAY;QACpB,MAAM;KACP,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/cjs/actions/getBlock.d.ts

@@ -0,0 +1,12 @@
+import { Block } from 'bitcoinjs-lib';
+import { type Account, type Chain, type Client, type Transport } from 'viem';
+import type { UTXOSchema } from '../transports/types.js';
+export type GetBlockParameters = {
+    blockHash: string;
+    blockNumber?: never;
+} | {
+    blockHash?: never;
+    blockNumber: number;
+};
+export type GetBlockReturnType = Block;
+export declare function getBlock<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, { blockHash, blockNumber }: GetBlockParameters): Promise<GetBlockReturnType>;

package/dist/cjs/actions/getBlock.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlock = getBlock;
+const bitcoinjs_lib_1 = require("bitcoinjs-lib");
+const viem_1 = require("viem");
+async function getBlock(client, { blockHash, blockNumber }) {
+    let blockHex;
+    try {
+        let _blockHash = blockHash;
+        if (!_blockHash && blockNumber) {
+            _blockHash = await client.request({
+                method: 'getblockhash',
+                params: [blockNumber],
+            }, { dedupe: true });
+        }
+        if (_blockHash) {
+            blockHex = await client.request({
+                method: 'getblock',
+                params: [_blockHash, 0],
+            }, { dedupe: true });
+        }
+    }
+    catch (_error) {
+        throw new viem_1.BlockNotFoundError({ blockHash, blockNumber });
+    }
+    if (!blockHex) {
+        throw new viem_1.BlockNotFoundError({ blockHash, blockNumber });
+    }
+    return bitcoinjs_lib_1.Block.fromHex(blockHex);
+}
+//# sourceMappingURL=getBlock.js.map

package/dist/cjs/actions/getBlock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlock.js","sourceRoot":"","sources":["../../../src/actions/getBlock.ts"],"names":[],"mappings":";;AAsBA,4BAmCC;AAzDD,iDAAqC;AACrC,+BAMa;AAeN,KAAK,UAAU,QAAQ,CAI5B,MAA2C,EAC3C,EAAE,SAAS,EAAE,WAAW,EAAsB;IAE9C,IAAI,QAA4B,CAAA;IAChC,IAAI,CAAC;QACH,IAAI,UAAU,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,UAAU,IAAI,WAAW,EAAE,CAAC;YAC/B,UAAU,GAAG,MAAM,MAAM,CAAC,OAAO,CAC/B;gBACE,MAAM,EAAE,cAAc;gBACtB,MAAM,EAAE,CAAC,WAAW,CAAC;aACtB,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;QACH,CAAC;QACD,IAAI,UAAU,EAAE,CAAC;YACf,QAAQ,GAAG,MAAM,MAAM,CAAC,OAAO,CAC7B;gBACE,MAAM,EAAE,UAAU;gBAClB,MAAM,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;aACxB,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;QACH,CAAC;IACH,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,IAAI,yBAAkB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAW,CAAC,CAAA;IACnE,CAAC;IACD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,yBAAkB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAW,CAAC,CAAA;IACnE,CAAC;IACD,OAAO,qBAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;AAChC,CAAC"}

package/dist/cjs/actions/getBlockCount.d.ts

@@ -0,0 +1,4 @@
+import type { Account, Chain, Client, Transport } from 'viem';
+import type { UTXOSchema } from '../transports/types.js';
+export type GetBlockCountReturnType = number;
+export declare function getBlockCount<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>): Promise<GetBlockCountReturnType>;

package/dist/cjs/actions/getBlockCount.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlockCount = getBlockCount;
+async function getBlockCount(client) {
+    const data = await client.request({
+        method: 'getblockcount',
+        params: [],
+    }, { dedupe: true });
+    return data;
+}
+//# sourceMappingURL=getBlockCount.js.map

package/dist/cjs/actions/getBlockCount.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlockCount.js","sourceRoot":"","sources":["../../../src/actions/getBlockCount.ts"],"names":[],"mappings":";;AAKA,sCAcC;AAdM,KAAK,UAAU,aAAa,CAIjC,MAA2C;IAE3C,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAC/B;QACE,MAAM,EAAE,eAAe;QACvB,MAAM,EAAE,EAAE;KACX,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;IACD,OAAO,IAAI,CAAA;AACb,CAAC"}

package/dist/cjs/actions/getBlockStats.d.ts

@@ -0,0 +1,14 @@
+import { type Account, type Chain, type Client, type Transport } from 'viem';
+import type { UTXOSchema } from '../transports/types.js';
+import type { BlockStats, BlockStatsKeys } from '../types/blockStats.js';
+export type GetBlockStatsParameters = ({
+    blockHash: string;
+    blockNumber?: never;
+} | {
+    blockHash?: never;
+    blockNumber: number;
+}) & {
+    stats?: Array<BlockStatsKeys>;
+};
+export type GetBlockStatsReturnType = BlockStats;
+export declare function getBlockStats<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, { blockHash, blockNumber, stats }: GetBlockStatsParameters): Promise<GetBlockStatsReturnType>;

package/dist/cjs/actions/getBlockStats.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBlockStats = getBlockStats;
+const viem_1 = require("viem");
+async function getBlockStats(client, { blockHash, blockNumber, stats }) {
+    const blockHashOrNumber = blockHash || blockNumber;
+    if (!blockHashOrNumber) {
+        throw new viem_1.BlockNotFoundError({ blockHash, blockNumber });
+    }
+    try {
+        const params = [
+            blockHashOrNumber,
+        ];
+        if (stats) {
+            params.push(stats);
+        }
+        const data = await client.request({
+            method: 'getblockstats',
+            params: params,
+        }, { dedupe: true });
+        return data;
+    }
+    catch (_error) {
+        throw new viem_1.BlockNotFoundError({ blockHash, blockNumber });
+    }
+}
+//# sourceMappingURL=getBlockStats.js.map

package/dist/cjs/actions/getBlockStats.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getBlockStats.js","sourceRoot":"","sources":["../../../src/actions/getBlockStats.ts"],"names":[],"mappings":";;AAyBA,sCA6BC;AAtDD,+BAMa;AAmBN,KAAK,UAAU,aAAa,CAIjC,MAA2C,EAC3C,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,EAA2B;IAE1D,MAAM,iBAAiB,GAAG,SAAS,IAAI,WAAW,CAAA;IAClD,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACvB,MAAM,IAAI,yBAAkB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAW,CAAC,CAAA;IACnE,CAAC;IACD,IAAI,CAAC;QACH,MAAM,MAAM,GAA8C;YACxD,iBAAiB;SAClB,CAAA;QACD,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACpB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAC/B;YACE,MAAM,EAAE,eAAe;YACvB,MAAM,EAAE,MAAM;SACf,EACD,EAAE,MAAM,EAAE,IAAI,EAAE,CACjB,CAAA;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,IAAI,yBAAkB,CAAC,EAAE,SAAS,EAAE,WAAW,EAAW,CAAC,CAAA;IACnE,CAAC;AACH,CAAC"}

package/dist/cjs/actions/getUTXOTransaction.d.ts

@@ -0,0 +1,9 @@
+import { type Account, type Chain, type Client, type Transport } from 'viem';
+import type { UTXOSchema } from '../transports/types.js';
+import type { UTXOTransaction } from '../types/transaction.js';
+export type GetUTXOTransactionParameters = {
+    txId: string;
+    blockHash?: string;
+};
+export type GetUTXOTransactionReturnType = UTXOTransaction;
+export declare function getUTXOTransaction<C extends Chain | undefined, A extends Account | undefined = Account | undefined>(client: Client<Transport, C, A, UTXOSchema>, { txId, blockHash }: GetUTXOTransactionParameters): Promise<GetUTXOTransactionReturnType>;

package/dist/cjs/actions/getUTXOTransaction.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUTXOTransaction = getUTXOTransaction;
+const viem_1 = require("viem");
+async function getUTXOTransaction(client, { txId, blockHash }) {
+    try {
+        const params = [txId, true];
+        if (blockHash) {
+            params.push(blockHash);
+        }
+        const data = await client.request({
+            method: 'getrawtransaction',
+            params: params,
+        });
+        return data;
+    }
+    catch (_error) {
+        throw new viem_1.TransactionNotFoundError({
+            blockHash: blockHash,
+            hash: txId,
+        });
+    }
+}
+//# sourceMappingURL=getUTXOTransaction.js.map

package/dist/cjs/actions/getUTXOTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUTXOTransaction.js","sourceRoot":"","sources":["../../../src/actions/getUTXOTransaction.ts"],"names":[],"mappings":";;AAmBA,gDAuBC;AA1CD,+BAMa;AAaN,KAAK,UAAU,kBAAkB,CAItC,MAA2C,EAC3C,EAAE,IAAI,EAAE,SAAS,EAAgC;IAEjD,IAAI,CAAC;QACH,MAAM,MAAM,GAA+B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACvD,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACxB,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,mBAAmB;YAC3B,MAAM,EAAE,MAAM;SACf,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,MAAM,IAAI,+BAAwB,CAAC;YACjC,SAAS,EAAE,SAAkB;YAC7B,IAAI,EAAE,IAAa;SACpB,CAAC,CAAA;IACJ,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,8 @@
+import type { Account, Chain, Client, Transport } from 'viem';
+import type { UTXOSchema } from '../transports/types.js';
+export type SendUTXOTransactionParameters = {
+    hex: string;
+    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>;

package/dist/cjs/actions/sendUTXOTransaction.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sendUTXOTransaction = sendUTXOTransaction;
+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;
+}
+//# sourceMappingURL=sendUTXOTransaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sendUTXOTransaction.js","sourceRoot":"","sources":["../../../src/actions/sendUTXOTransaction.ts"],"names":[],"mappings":";;AAYA,kDAgBC;AAhBM,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"}

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

@@ -0,0 +1,3 @@
+import type { Account, Chain, Client, Transport } from 'viem';
+import type { SignPsbtParameters, SignPsbtReturnType, UTXOWalletSchema } from '../clients/types.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>;

package/dist/cjs/actions/signPsbt.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signPsbt = signPsbt;
+async function signPsbt(client, params) {
+    const data = await client.request({
+        method: 'signPsbt',
+        params: params,
+    }, { dedupe: true });
+    return data;
+}
+//# sourceMappingURL=signPsbt.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"signPsbt.js","sourceRoot":"","sources":["../../../src/actions/signPsbt.ts"],"names":[],"mappings":";;AAOA,4BAeC;AAfM,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"}

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

@@ -0,0 +1,32 @@
+import { Transaction } from 'bitcoinjs-lib';
+import { type Chain, type Client, type Transport } from 'viem';
+import type { UTXOTransaction } from '../types/transaction.js';
+export type ReplacementReason = 'cancelled' | 'replaced' | 'repriced';
+export 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;
+};
+export type WaitForTransactionReceiptParameters = {
+    txId: string;
+    txHex: string;
+    senderAddress?: string;
+    confirmations?: number | undefined;
+    onReplaced?: ((response: ReplacementReturnType) => void) | undefined;
+    pollingInterval?: number | undefined;
+    retryCount?: number;
+    retryDelay?: ((config: {
+        count: number;
+        error: Error;
+    }) => number) | number;
+    timeout?: number | undefined;
+};
+export declare function waitForTransaction<chain extends Chain | undefined>(client: Client<Transport, chain>, { confirmations, txId, txHex, senderAddress, onReplaced, pollingInterval, retryCount, retryDelay, timeout, }: WaitForTransactionReceiptParameters): Promise<WaitForTransactionReceiptReturnType>;

package/dist/cjs/actions/waitForTransaction.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForTransaction = waitForTransaction;
+const bitcoinjs_lib_1 = require("bitcoinjs-lib");
+const viem_1 = require("viem");
+const utils_1 = require("viem/utils");
+const observe_js_1 = require("../utils/observe.js");
+const getBlock_js_1 = require("./getBlock.js");
+const getBlockStats_js_1 = require("./getBlockStats.js");
+const getUTXOTransaction_js_1 = require("./getUTXOTransaction.js");
+const watchBlockNumber_js_1 = require("./watchBlockNumber.js");
+async function waitForTransaction(client, { confirmations = 1, txId, txHex, senderAddress, onReplaced, pollingInterval = client.pollingInterval, retryCount = 10, retryDelay = 3000, timeout, }) {
+    const observerId = (0, viem_1.stringify)(['waitForTransaction', client.uid, txId]);
+    let count = 0;
+    let transaction;
+    let replacedTransaction;
+    let retrying = false;
+    return new Promise((resolve, reject) => {
+        if (timeout) {
+            setTimeout(() => reject(new viem_1.WaitForTransactionReceiptTimeoutError({ hash: txId })), timeout);
+        }
+        const _unobserve = (0, observe_js_1.observe)(observerId, { onReplaced, resolve, reject }, (emit) => {
+            const _unwatch = (0, utils_1.getAction)(client, watchBlockNumber_js_1.watchBlockNumber, 'watchBlockNumber')({
+                emitMissed: true,
+                emitOnBegin: true,
+                pollingInterval,
+                async onBlockNumber(blockNumber_) {
+                    const done = (fn) => {
+                        _unwatch();
+                        fn();
+                        _unobserve();
+                    };
+                    let blockNumber = blockNumber_;
+                    if (retrying) {
+                        return;
+                    }
+                    if (count > retryCount) {
+                        done(() => emit.reject(new viem_1.WaitForTransactionReceiptTimeoutError({
+                            hash: txId,
+                        })));
+                    }
+                    try {
+                        if (transaction?.blockhash) {
+                            const blockStats = await (0, utils_1.getAction)(client, getBlockStats_js_1.getBlockStats, 'getBlockStats')({
+                                blockHash: transaction.blockhash,
+                                stats: ['height'],
+                            });
+                            if (confirmations > 1 &&
+                                (!blockStats.height ||
+                                    blockNumber - blockStats.height + 1 < confirmations)) {
+                                return;
+                            }
+                            done(() => emit.resolve(transaction));
+                            return;
+                        }
+                        retrying = true;
+                        transaction = await (0, viem_1.withRetry)(() => (0, utils_1.getAction)(client, getUTXOTransaction_js_1.getUTXOTransaction, 'getUTXOTransaction')({ txId: transaction?.txid || txId }), {
+                            delay: retryDelay,
+                            retryCount,
+                        });
+                        if (transaction.blockhash) {
+                            const blockStats = await (0, utils_1.getAction)(client, getBlockStats_js_1.getBlockStats, 'getBlockStats')({
+                                blockHash: transaction.blockhash,
+                                stats: ['height'],
+                            });
+                            if (blockStats.height) {
+                                blockNumber = blockStats.height;
+                            }
+                        }
+                        retrying = false;
+                        if (!transaction?.confirmations) {
+                            throw new viem_1.TransactionReceiptNotFoundError({
+                                hash: txId,
+                            });
+                        }
+                        if (transaction.confirmations < confirmations) {
+                            return;
+                        }
+                        done(() => emit.resolve(transaction));
+                    }
+                    catch (err) {
+                        if (err instanceof viem_1.TransactionNotFoundError ||
+                            err instanceof viem_1.TransactionReceiptNotFoundError) {
+                            try {
+                                replacedTransaction = bitcoinjs_lib_1.Transaction.fromHex(transaction?.hex || txHex);
+                                retrying = true;
+                                const block = await (0, viem_1.withRetry)(() => (0, utils_1.getAction)(client, getBlock_js_1.getBlock, 'getBlock')({
+                                    blockNumber,
+                                }), {
+                                    delay: retryDelay,
+                                    retryCount,
+                                });
+                                retrying = false;
+                                const replacedTransactionInputs = new Set();
+                                for (const input of replacedTransaction.ins) {
+                                    const txid = Array.from(input.hash)
+                                        .reverse()
+                                        .map((byte) => `00${byte.toString(16)}`.slice(-2))
+                                        .join('');
+                                    const vout = input.index;
+                                    const inputId = `${txid}:${vout}`;
+                                    replacedTransactionInputs.add(inputId);
+                                }
+                                let replacementTransaction;
+                                for (const tx of block.transactions) {
+                                    if (tx.isCoinbase()) {
+                                        continue;
+                                    }
+                                    for (const input of tx.ins) {
+                                        const txid = Array.from(input.hash)
+                                            .reverse()
+                                            .map((byte) => `00${byte.toString(16)}`.slice(-2))
+                                            .join('');
+                                        const vout = input.index;
+                                        const inputId = `${txid}:${vout}`;
+                                        if (replacedTransactionInputs.has(inputId)) {
+                                            replacementTransaction = tx;
+                                            break;
+                                        }
+                                    }
+                                    if (replacementTransaction) {
+                                        break;
+                                    }
+                                }
+                                if (!replacementTransaction) {
+                                    return;
+                                }
+                                transaction = await (0, utils_1.getAction)(client, getUTXOTransaction_js_1.getUTXOTransaction, 'getUTXOTransaction')({
+                                    txId: replacementTransaction.getId(),
+                                });
+                                if (transaction.confirmations &&
+                                    transaction.confirmations < confirmations) {
+                                    return;
+                                }
+                                let reason = 'replaced';
+                                function getOutputAddresses(tx) {
+                                    const addresses = [];
+                                    for (const output of tx.outs) {
+                                        try {
+                                            const outputAddress = bitcoinjs_lib_1.address.fromOutputScript(output.script);
+                                            addresses.push(outputAddress);
+                                        }
+                                        catch (_e) {
+                                        }
+                                    }
+                                    return addresses;
+                                }
+                                const originalOutputAddresses = getOutputAddresses(replacedTransaction);
+                                const replacementOutputAddresses = getOutputAddresses(replacementTransaction);
+                                if (originalOutputAddresses.length ===
+                                    replacementOutputAddresses.length &&
+                                    originalOutputAddresses.every((address) => replacementOutputAddresses.includes(address))) {
+                                    reason = 'repriced';
+                                }
+                                else if (senderAddress &&
+                                    replacementOutputAddresses.length === 1 &&
+                                    replacementOutputAddresses.includes(senderAddress)) {
+                                    reason = 'cancelled';
+                                }
+                                done(() => {
+                                    emit.onReplaced?.({
+                                        reason,
+                                        replacedTransaction: replacedTransaction,
+                                        transaction: transaction,
+                                    });
+                                    emit.resolve(transaction);
+                                });
+                            }
+                            catch (err_) {
+                                done(() => emit.reject(err_));
+                            }
+                        }
+                        else {
+                            done(() => emit.reject(err));
+                        }
+                    }
+                    finally {
+                        count++;
+                    }
+                },
+            });
+        });
+    });
+}
+//# sourceMappingURL=waitForTransaction.js.map

package/dist/cjs/actions/waitForTransaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waitForTransaction.js","sourceRoot":"","sources":["../../../src/actions/waitForTransaction.ts"],"names":[],"mappings":";;AA6FA,gDAqSC;AAlYD,iDAAoD;AACpD,+BASa;AACb,sCAAsC;AAEtC,oDAA6C;AAC7C,+CAAwC;AACxC,yDAAkD;AAClD,mEAA4D;AAC5D,+DAAwD;AA4EjD,KAAK,UAAU,kBAAkB,CACtC,MAAgC,EAChC,EACE,aAAa,GAAG,CAAC,EACjB,IAAI,EACJ,KAAK,EACL,aAAa,EACb,UAAU,EACV,eAAe,GAAG,MAAM,CAAC,eAAe,EACxC,UAAU,GAAG,EAAE,EACf,UAAU,GAAG,IAAK,EAClB,OAAO,GAC6B;IAEtC,MAAM,UAAU,GAAG,IAAA,gBAAS,EAAC,CAAC,oBAAoB,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;IAEtE,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,WAAwC,CAAA;IAC5C,IAAI,mBAA4C,CAAA;IAChD,IAAI,QAAQ,GAAG,KAAK,CAAA;IAEpB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,OAAO,EAAE,CAAC;YACZ,UAAU,CACR,GAAG,EAAE,CACH,MAAM,CACJ,IAAI,4CAAqC,CAAC,EAAE,IAAI,EAAE,IAAa,EAAE,CAAC,CACnE,EACH,OAAO,CACR,CAAA;QACH,CAAC;QAED,MAAM,UAAU,GAAG,IAAA,oBAAO,EACxB,UAAU,EACV,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,EAC/B,CAAC,IAAI,EAAE,EAAE;YACP,MAAM,QAAQ,GAAG,IAAA,iBAAS,EACxB,MAAM,EACN,sCAAgB,EAChB,kBAAkB,CACnB,CAAC;gBACA,UAAU,EAAE,IAAI;gBAChB,WAAW,EAAE,IAAI;gBACjB,eAAe;gBACf,KAAK,CAAC,aAAa,CAAC,YAAY;oBAC9B,MAAM,IAAI,GAAG,CAAC,EAAc,EAAE,EAAE;wBAC9B,QAAQ,EAAE,CAAA;wBACV,EAAE,EAAE,CAAA;wBACJ,UAAU,EAAE,CAAA;oBACd,CAAC,CAAA;oBAED,IAAI,WAAW,GAAG,YAAY,CAAA;oBAE9B,IAAI,QAAQ,EAAE,CAAC;wBACb,OAAM;oBACR,CAAC;oBACD,IAAI,KAAK,GAAG,UAAU,EAAE,CAAC;wBACvB,IAAI,CAAC,GAAG,EAAE,CACR,IAAI,CAAC,MAAM,CACT,IAAI,4CAAqC,CAAC;4BACxC,IAAI,EAAE,IAAa;yBACpB,CAAC,CACH,CACF,CAAA;oBACH,CAAC;oBAED,IAAI,CAAC;wBAGH,IAAI,WAAW,EAAE,SAAS,EAAE,CAAC;4BAC3B,MAAM,UAAU,GAAG,MAAM,IAAA,iBAAS,EAChC,MAAM,EACN,gCAAa,EACb,eAAe,CAChB,CAAC;gCACA,SAAS,EAAE,WAAW,CAAC,SAAS;gCAChC,KAAK,EAAE,CAAC,QAAQ,CAAC;6BAClB,CAAC,CAAA;4BACF,IACE,aAAa,GAAG,CAAC;gCACjB,CAAC,CAAC,UAAU,CAAC,MAAM;oCACjB,WAAW,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,CAAC,EACtD,CAAC;gCACD,OAAM;4BACR,CAAC;4BACD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC,CAAA;4BACtC,OAAM;wBACR,CAAC;wBAKD,QAAQ,GAAG,IAAI,CAAA;wBACf,WAAW,GAAG,MAAM,IAAA,gBAAS,EAC3B,GAAG,EAAE,CACH,IAAA,iBAAS,EACP,MAAM,EACN,0CAAkB,EAClB,oBAAoB,CAErB,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC,EACxC;4BACE,KAAK,EAAE,UAAU;4BACjB,UAAU;yBACX,CACF,CAAA;wBACD,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;4BAC1B,MAAM,UAAU,GAAG,MAAM,IAAA,iBAAS,EAChC,MAAM,EACN,gCAAa,EACb,eAAe,CAChB,CAAC;gCACA,SAAS,EAAE,WAAW,CAAC,SAAS;gCAChC,KAAK,EAAE,CAAC,QAAQ,CAAC;6BAClB,CAAC,CAAA;4BACF,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;gCACtB,WAAW,GAAG,UAAU,CAAC,MAAM,CAAA;4BACjC,CAAC;wBACH,CAAC;wBACD,QAAQ,GAAG,KAAK,CAAA;wBAGhB,IAAI,CAAC,WAAW,EAAE,aAAa,EAAE,CAAC;4BAChC,MAAM,IAAI,sCAA+B,CAAC;gCACxC,IAAI,EAAE,IAAa;6BACpB,CAAC,CAAA;wBACJ,CAAC;wBAGD,IAAI,WAAW,CAAC,aAAa,GAAG,aAAa,EAAE,CAAC;4BAC9C,OAAM;wBACR,CAAC;wBAED,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC,CAAA;oBACxC,CAAC;oBAAC,OAAO,GAAG,EAAE,CAAC;wBAGb,IACE,GAAG,YAAY,+BAAwB;4BACvC,GAAG,YAAY,sCAA+B,EAC9C,CAAC;4BACD,IAAI,CAAC;gCACH,mBAAmB,GAAG,2BAAW,CAAC,OAAO,CACvC,WAAW,EAAE,GAAG,IAAI,KAAK,CAC1B,CAAA;gCAKD,QAAQ,GAAG,IAAI,CAAA;gCACf,MAAM,KAAK,GAAG,MAAM,IAAA,gBAAS,EAC3B,GAAG,EAAE,CACH,IAAA,iBAAS,EACP,MAAM,EACN,sBAAQ,EACR,UAAU,CACX,CAAC;oCACA,WAAW;iCACZ,CAAC,EACJ;oCACE,KAAK,EAAE,UAAU;oCACjB,UAAU;iCAGX,CACF,CAAA;gCACD,QAAQ,GAAG,KAAK,CAAA;gCAGhB,MAAM,yBAAyB,GAAG,IAAI,GAAG,EAAU,CAAA;gCAEnD,KAAK,MAAM,KAAK,IAAI,mBAAmB,CAAC,GAAG,EAAE,CAAC;oCAC5C,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;yCAChC,OAAO,EAAE;yCACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;yCACjD,IAAI,CAAC,EAAE,CAAC,CAAA;oCACX,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAA;oCACxB,MAAM,OAAO,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;oCACjC,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;gCACxC,CAAC;gCAED,IAAI,sBAA+C,CAAA;gCAEnD,KAAK,MAAM,EAAE,IAAI,KAAK,CAAC,YAAa,EAAE,CAAC;oCACrC,IAAI,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC;wCACpB,SAAQ;oCACV,CAAC;oCAGD,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;wCAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;6CAChC,OAAO,EAAE;6CACT,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;6CACjD,IAAI,CAAC,EAAE,CAAC,CAAA;wCACX,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAA;wCACxB,MAAM,OAAO,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAA;wCACjC,IAAI,yBAAyB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;4CAC3C,sBAAsB,GAAG,EAAE,CAAA;4CAC3B,MAAK;wCACP,CAAC;oCACH,CAAC;oCACD,IAAI,sBAAsB,EAAE,CAAC;wCAC3B,MAAK;oCACP,CAAC;gCACH,CAAC;gCAGD,IAAI,CAAC,sBAAsB,EAAE,CAAC;oCAC5B,OAAM;gCACR,CAAC;gCAGD,WAAW,GAAG,MAAM,IAAA,iBAAS,EAC3B,MAAM,EACN,0CAAkB,EAClB,oBAAoB,CACrB,CAAC;oCACA,IAAI,EAAE,sBAAsB,CAAC,KAAK,EAAE;iCACrC,CAAC,CAAA;gCAGF,IACE,WAAW,CAAC,aAAa;oCACzB,WAAW,CAAC,aAAa,GAAG,aAAa,EACzC,CAAC;oCACD,OAAM;gCACR,CAAC;gCAED,IAAI,MAAM,GAAsB,UAAU,CAAA;gCAG1C,SAAS,kBAAkB,CAAC,EAAe;oCACzC,MAAM,SAAS,GAAa,EAAE,CAAA;oCAC9B,KAAK,MAAM,MAAM,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;wCAC7B,IAAI,CAAC;4CACH,MAAM,aAAa,GAAG,uBAAO,CAAC,gBAAgB,CAC5C,MAAM,CAAC,MAAM,CACd,CAAA;4CACD,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;wCAC/B,CAAC;wCAAC,OAAO,EAAE,EAAE,CAAC;wCAEd,CAAC;oCACH,CAAC;oCACD,OAAO,SAAS,CAAA;gCAClB,CAAC;gCAGD,MAAM,uBAAuB,GAC3B,kBAAkB,CAAC,mBAAmB,CAAC,CAAA;gCAGzC,MAAM,0BAA0B,GAAG,kBAAkB,CACnD,sBAAsB,CACvB,CAAA;gCAED,IACE,uBAAuB,CAAC,MAAM;oCAC5B,0BAA0B,CAAC,MAAM;oCACnC,uBAAuB,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CACxC,0BAA0B,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7C,EACD,CAAC;oCACD,MAAM,GAAG,UAAU,CAAA;gCACrB,CAAC;qCAAM,IACL,aAAa;oCACb,0BAA0B,CAAC,MAAM,KAAK,CAAC;oCACvC,0BAA0B,CAAC,QAAQ,CAAC,aAAa,CAAC,EAClD,CAAC;oCACD,MAAM,GAAG,WAAW,CAAA;gCACtB,CAAC;gCAED,IAAI,CAAC,GAAG,EAAE;oCACR,IAAI,CAAC,UAAU,EAAE,CAAC;wCAChB,MAAM;wCACN,mBAAmB,EAAE,mBAAoB;wCACzC,WAAW,EAAE,WAAY;qCAC1B,CAAC,CAAA;oCACF,IAAI,CAAC,OAAO,CAAC,WAAY,CAAC,CAAA;gCAC5B,CAAC,CAAC,CAAA;4BACJ,CAAC;4BAAC,OAAO,IAAI,EAAE,CAAC;gCACd,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;4BAC/B,CAAC;wBACH,CAAC;6BAAM,CAAC;4BACN,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAA;wBAC9B,CAAC;oBACH,CAAC;4BAAS,CAAC;wBACT,KAAK,EAAE,CAAA;oBACT,CAAC;gBACH,CAAC;aACF,CAAC,CAAA;QACJ,CAAC,CACF,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC"}