@bigmi/core 0.0.1

package/dist/types/utils/poll.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"poll.d.ts","sourceRoot":"","sources":["../../../src/utils/poll.ts"],"names":[],"mappings":"AAEA,KAAK,WAAW,CAAC,CAAC,IAAI;IAEpB,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IAEjC,eAAe,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,SAAS,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;IAExE,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EACpB,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE;IAAE,MAAM,EAAE,MAAM,IAAI,CAAA;CAAE,KAAK,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,EAClE,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,cA+B3D"}

package/dist/types/utils/sleep.d.ts

@@ -0,0 +1,2 @@
+export declare function sleep(ms: number): Promise<null>;
+//# sourceMappingURL=sleep.d.ts.map

package/dist/types/utils/sleep.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.d.ts","sourceRoot":"","sources":["../../../src/utils/sleep.ts"],"names":[],"mappings":"AAAA,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAI/C"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@bigmi/core",
+  "version": "0.0.1",
+  "description": "TypeScript library for Bitcoin apps.",
+  "type": "module",
+  "main": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "sideEffects": false,
+  "author": "Eugene Chybisov <eugene@li.finance>",
+  "homepage": "https://github.com/lifinance/bigmi",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lifinance/bigmi.git",
+    "directory": "packages/core"
+  },
+  "bugs": {
+    "url": "https://github.com/lifinance/bigmi/issues"
+  },
+  "license": "MIT",
+  "keywords": [
+    "bitcoin",
+    "bitcoinjs",
+    "btc",
+    "utxo",
+    "web3",
+    "dapp",
+    "typescript"
+  ],
+  "dependencies": {
+    "@noble/curves": "^1.6.0",
+    "@noble/hashes": "^1.5.0",
+    "bech32": "^2.0.0",
+    "bitcoinjs-lib": "^7.0.0-rc.0",
+    "bs58": "^6.0.0",
+    "viem": "^2.21.25"
+  },
+  "peerDependencies": {
+    "bitcoinjs-lib": "^7.0.0-rc.0",
+    "bs58": "^6.0.0",
+    "viem": "^2.21.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/cjs/index.js"
+    },
+    "./package.json": "./package.json"
+  }
+}

package/src/actions/getBalance.ts

@@ -0,0 +1,26 @@
+import type { Account, Chain, Client, Transport } from 'viem'
+import type { UTXOAPISchema } from '../transports/types.js'
+
+export type GetBalanceParameters = {
+  /** The address of the account. */
+  address: string
+}
+
+export type GetBalanceReturnType = bigint
+
+export async function getBalance<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOAPISchema>,
+  params: GetBalanceParameters
+): Promise<GetBalanceReturnType> {
+  const data = await client.request(
+    {
+      method: 'getBalance',
+      params,
+    },
+    { dedupe: true }
+  )
+  return data
+}

package/src/actions/getBlock.ts

@@ -0,0 +1,58 @@
+import { Block } from 'bitcoinjs-lib'
+import {
+  type Account,
+  BlockNotFoundError,
+  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 async function getBlock<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>,
+  { blockHash, blockNumber }: GetBlockParameters
+): Promise<GetBlockReturnType> {
+  let blockHex: string | undefined
+  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 BlockNotFoundError({ blockHash, blockNumber } as never)
+  }
+  if (!blockHex) {
+    throw new BlockNotFoundError({ blockHash, blockNumber } as never)
+  }
+  return Block.fromHex(blockHex)
+}

package/src/actions/getBlockCount.ts

@@ -0,0 +1,20 @@
+import type { Account, Chain, Client, Transport } from 'viem'
+import type { UTXOSchema } from '../transports/types.js'
+
+export type GetBlockCountReturnType = number
+
+export async function getBlockCount<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>
+): Promise<GetBlockCountReturnType> {
+  const data = await client.request(
+    {
+      method: 'getblockcount',
+      params: [],
+    },
+    { dedupe: true }
+  )
+  return data
+}

package/src/actions/getBlockStats.ts

@@ -0,0 +1,55 @@
+import {
+  type Account,
+  BlockNotFoundError,
+  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 async function getBlockStats<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>,
+  { blockHash, blockNumber, stats }: GetBlockStatsParameters
+): Promise<GetBlockStatsReturnType> {
+  const blockHashOrNumber = blockHash || blockNumber
+  if (!blockHashOrNumber) {
+    throw new BlockNotFoundError({ blockHash, blockNumber } as never)
+  }
+  try {
+    const params: [string | number, Array<BlockStatsKeys>?] = [
+      blockHashOrNumber,
+    ]
+    if (stats) {
+      params.push(stats)
+    }
+    const data = await client.request(
+      {
+        method: 'getblockstats',
+        params: params,
+      },
+      { dedupe: true }
+    )
+    return data
+  } catch (_error) {
+    throw new BlockNotFoundError({ blockHash, blockNumber } as never)
+  }
+}

package/src/actions/getUTXOTransaction.ts

@@ -0,0 +1,43 @@
+import {
+  type Account,
+  type Chain,
+  type Client,
+  TransactionNotFoundError,
+  type Transport,
+} from 'viem'
+import type { UTXOSchema } from '../transports/types.js'
+import type { UTXOTransaction } from '../types/transaction.js'
+
+export type GetUTXOTransactionParameters = {
+  /** The Id of the transaction */
+  txId: string
+  /** The block in which to look for the transaction */
+  blockHash?: string
+}
+
+export type GetUTXOTransactionReturnType = UTXOTransaction
+
+export async function getUTXOTransaction<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>,
+  { txId, blockHash }: GetUTXOTransactionParameters
+): Promise<GetUTXOTransactionReturnType> {
+  try {
+    const params: [string, boolean, string?] = [txId, true]
+    if (blockHash) {
+      params.push(blockHash)
+    }
+    const data = await client.request({
+      method: 'getrawtransaction',
+      params: params,
+    })
+    return data
+  } catch (_error) {
+    throw new TransactionNotFoundError({
+      blockHash: blockHash as never,
+      hash: txId as never,
+    })
+  }
+}

package/src/actions/sendUTXOTransaction.ts

@@ -0,0 +1,29 @@
+import type { Account, Chain, Client, Transport } from 'viem'
+import type { UTXOSchema } from '../transports/types.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
+}
+
+export type SendUTXOTransactionReturnType = string
+
+export async function sendUTXOTransaction<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>,
+  { hex, maxFeeRate }: SendUTXOTransactionParameters
+): Promise<SendUTXOTransactionReturnType> {
+  const params: [string, number?] = [hex]
+  if (maxFeeRate) {
+    params.push(maxFeeRate)
+  }
+  const data = await client.request({
+    method: 'sendrawtransaction',
+    params: params,
+  })
+  return data
+}

package/src/actions/signPsbt.ts

@@ -0,0 +1,23 @@
+import type { Account, Chain, Client, Transport } from 'viem'
+import type {
+  SignPsbtParameters,
+  SignPsbtReturnType,
+  UTXOWalletSchema,
+} from '../clients/types.js'
+
+export async function signPsbt<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOWalletSchema>,
+  params: SignPsbtParameters
+): Promise<SignPsbtReturnType> {
+  const data = await client.request(
+    {
+      method: 'signPsbt',
+      params: params,
+    },
+    { dedupe: true }
+  )
+  return data
+}