@bigmi/core 0.2.0 → 0.3.0-beta.0

package/dist/types/version.d.ts

@@ -1,2 +1,3 @@
-export declare const version = "0.1.1";
+export declare const name = "@bigmi/core";
+export declare const version = "0.3.0-beta.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/types/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,gBAAgB,CAAA;AACjC,eAAO,MAAM,OAAO,iBAAiB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigmi/core",
-  "version": "0.2.0",
+  "version": "0.3.0-beta.0",
   "description": "TypeScript library for Bitcoin apps.",
   "type": "module",
   "main": "./dist/esm/index.js",
@@ -32,7 +32,7 @@
     "bitcoinjs-lib": "^7.0.0-rc.0",
     "bs58": "^6.0.0",
     "eventemitter3": "^5.0.1",
-    "zustand": "^5.0.4"
+    "zustand": "^5.0.5"
   },
   "peerDependencies": {
     "bs58": "^6.0.0"

package/package.json.tmp

@@ -1,6 +1,6 @@
 {
   "name": "@bigmi/core",
-  "version": "0.2.0",
+  "version": "0.3.0-beta.0",
   "description": "TypeScript library for Bitcoin apps.",
   "type": "module",
   "main": "./src/index.ts",
@@ -8,18 +8,21 @@
   "sideEffects": false,
   "scripts": {
     "watch": "tsc -w -p ./tsconfig.json",
-    "build": "pnpm clean && pnpm build:esm && pnpm build:cjs && pnpm build:types && pnpm build:clean",
+    "build": "pnpm clean && pnpm build:version && pnpm build:esm && pnpm build:cjs && pnpm build:types && pnpm build:clean",
     "build:cjs": "tsc --project ./tsconfig.json --module commonjs --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && printf '{\"type\":\"commonjs\"}' > ./dist/cjs/package.json",
     "build:esm": "tsc --project ./tsconfig.json --module es2015 --outDir ./dist/esm && printf '{\"type\": \"module\",\"sideEffects\":false}' > ./dist/esm/package.json",
     "build:types": "tsc --project ./tsconfig.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
     "build:prerelease": "node ../../scripts/prerelease.js && cpy '../../*.md' .",
     "build:postrelease": "node ../../scripts/postrelease.js && rm -rf *.md",
     "build:clean": "rm -rf tsconfig.tsbuildinfo ./dist/tsconfig.tsbuildinfo",
+    "build:version": "node ../../scripts/version.js",
     "release:build": "pnpm build",
     "clean": "pnpm build:clean && rm -rf dist",
     "check:types": "tsc --noEmit",
     "check:circular-deps": "madge --circular $(find ./src -name '*.ts' -o -name '*.tsx')",
-    "check:circular-deps-graph": "madge --circular $(find ./src -name '*.ts' -o -name '*.tsx') --image graph.svg"
+    "check:circular-deps-graph": "madge --circular $(find ./src -name '*.ts' -o -name '*.tsx') --image graph.svg",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
   },
   "author": "Eugene Chybisov <eugene@li.finance>",
   "homepage": "https://github.com/lifinance/bigmi",
@@ -47,12 +50,14 @@
     "bitcoinjs-lib": "^7.0.0-rc.0",
     "bs58": "^6.0.0",
     "eventemitter3": "^5.0.1",
-    "zustand": "^5.0.4"
+    "zustand": "^5.0.5"
   },
   "devDependencies": {
+    "@vitest/coverage-v8": "^3.1.4",
     "cpy-cli": "^5.0.0",
     "madge": "^8.0.0",
-    "typescript": "^5.7.3"
+    "typescript": "^5.7.3",
+    "vitest": "^3.1.4"
   },
   "peerDependencies": {
     "bs58": "^6.0.0"

package/src/actions/getBalance.ts

@@ -25,5 +25,6 @@ export async function getBalance<
     },
     { dedupe: true }
   )
+
   return data
 }

package/src/actions/getTransactions.ts

@@ -0,0 +1,40 @@
+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 { UTXOTransaction } from '../types/transaction.js'
+import type { Transport } from '../types/transport.js'
+
+export type GetTransactionsParameters = {
+  address: string
+  offset?: number
+  limit?: number
+  lastBlock?: string
+  afterTxId?: string
+}
+
+export type GetTransactionsReturnType = {
+  transactions: Array<Partial<UTXOTransaction>>
+  total: number
+  hasMore?: boolean
+}
+
+export async function getTransactions<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>,
+  { address, offset, limit, lastBlock }: GetTransactionsParameters
+): Promise<GetTransactionsReturnType> {
+  const data = await client.request({
+    method: 'getTransactions',
+    params: {
+      address,
+      offset,
+      limit,
+      lastBlock,
+    },
+  })
+
+  return data
+}

package/src/actions/getUTXOs.ts

@@ -0,0 +1,30 @@
+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 { UTXO } from '../types/transaction.js'
+import type { Transport } from '../types/transport.js'
+
+export type GetUTXOsParameters = {
+  address: string
+  minValue?: number // get utxos add up to this value
+}
+
+export type GetUTXOsReturnType = Array<UTXO>
+
+export async function getUTXOs<
+  C extends Chain | undefined,
+  A extends Account | undefined = Account | undefined,
+>(
+  client: Client<Transport, C, A, UTXOSchema>,
+  { address, minValue }: GetUTXOsParameters
+): Promise<GetUTXOsReturnType> {
+  const data = await client.request({
+    method: 'getUTXOs',
+    params: {
+      address,
+      minValue,
+    },
+  })
+  return data
+}

package/src/errors/transport.ts

@@ -13,3 +13,15 @@ export class UrlRequiredError extends BaseError {
     )
   }
 }
+
+export type TransportMethodNotSupportedErrorType =
+  TransportMethodNotSupportedError & {
+    name: 'TransportMethodNotSupportedError'
+  }
+export class TransportMethodNotSupportedError extends BaseError {
+  constructor({ method }: { method: string }) {
+    super(`No transport found that supports the method: ${method}`, {
+      name: 'TransportMethodNotSupportedError',
+    })
+  }
+}

package/src/errors/utxo.ts

@@ -0,0 +1,20 @@
+import { BaseError } from './base.js'
+
+export type InsufficientUTXOBalanceErrorType = InsufficientUTXOBalanceError & {
+  name: 'InsufficientUTXOBalanceError'
+}
+
+export class InsufficientUTXOBalanceError extends BaseError {
+  constructor({
+    minValue,
+    address,
+    balance,
+  }: { minValue: number; address?: string; balance?: number }) {
+    super(`Not enough UTXOs required for ${minValue}`, {
+      metaMessages: [
+        `${address && balance && `Address ${address} has a balance of ${balance}.`}`,
+      ],
+      name: 'InsufficientUTXOBalanceError',
+    })
+  }
+}

package/src/index.ts

@@ -38,6 +38,16 @@ export type {
   WatchBlockNumberParameters,
   WatchBlockNumberReturnType,
 } from './actions/watchBlockNumber.js'
+export { getUTXOs } from './actions/getUTXOs.js'
+export type {
+  GetUTXOsParameters,
+  GetUTXOsReturnType,
+} from './actions/getUTXOs.js'
+export { getTransactions } from './actions/getTransactions.js'
+export type {
+  GetTransactionsParameters,
+  GetTransactionsReturnType,
+} from './actions/getTransactions.js'
 
 // Exporting clients
 export {
@@ -50,9 +60,9 @@ export {
 } from './clients/decorators/wallet.js'
 
 // Exporting transports
-export { ankrMethods } from './transports/ankr.js'
-export { blockchairMethods } from './transports/blockchair.js'
-export { blockcypherMethods } from './transports/blockcypher.js'
+export { ankrMethods } from './transports/ankr/methods.js'
+export { blockchairMethods } from './transports/blockchair/methods.js'
+export { blockcypherMethods } from './transports/blockcypher/methods.js'
 export { getHttpRpcClient } from './transports/getHttpRpcClient.js'
 export type {
   HttpRequestParameters,
@@ -60,7 +70,7 @@ export type {
   RpcRequest,
 } from './transports/getHttpRpcClient.js'
 export { getRpcProviderMethods } from './transports/getRpcProviderMethods.js'
-export { mempoolMethods } from './transports/mempool.js'
+export { mempoolMethods } from './transports/mempool/methods.js'
 export type {
   ErrorResult,
   RpcMethodHandler,
@@ -74,6 +84,10 @@ export type {
 } from './transports/types.js'
 export { utxo } from './transports/utxo.js'
 export { custom } from './transports/custom.js'
+export { ankr } from './transports/ankr/ankr.js'
+export { blockchair } from './transports/blockchair/blockchair.js'
+export { blockcypher } from './transports/blockcypher/blockcypher.js'
+export { mempool } from './transports/mempool/mempool.js'
 
 // Exporting types
 export type { Account } from './types/account.js'
@@ -114,7 +128,6 @@ export type {
   LooseOmit,
   UnionStrictOmit,
 } from './types/utils.js'
-export type { BtcAccount } from './types/account.js'
 
 // Exporting utils
 export { cancelTransaction } from './utils/cancelTransaction.js'
@@ -174,6 +187,10 @@ export {
   TransactionReceiptNotFoundError,
   WaitForTransactionReceiptTimeoutError,
 } from './errors/transaction.js'
+export {
+  InsufficientUTXOBalanceError,
+  type InsufficientUTXOBalanceErrorType,
+} from './errors/utxo.js'
 export { UrlRequiredError } from './errors/transport.js'
 export type { ErrorType } from './errors/utils.js'
 

package/src/test/utils.ts

@@ -0,0 +1,8 @@
+export const createMockResponse = <T>(data: T): Response =>
+  ({
+    ok: true,
+    json: () => Promise.resolve(data),
+    headers: new Headers({
+      'Content-type': 'application/json',
+    }),
+  }) as Response

package/src/transports/ankr/__mocks__/getBalance/valid.json

@@ -0,0 +1,9 @@
+{
+  "address": "bc1qpvk0kjdg0kantu9z78qz7gqk53q643auz33yaw",
+  "balance": "33206",
+  "totalReceived": "424052",
+  "totalSent": "390846",
+  "unconfirmedBalance": "0",
+  "unconfirmedTxs": 0,
+  "txs": 19
+}