@bigmi/core 0.2.1 → 0.3.0-beta.0

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/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
+}