@bigmi/core 0.3.0-beta.3 → 0.3.0-beta.4

package/src/factories/createTransport.ts

@@ -1,61 +1,7 @@
-import type { ErrorType } from '../errors/utils.js'
-import type { Chain } from '../types/chain.js'
-import type { ClientConfig } from '../types/client.js'
-import type { BtcRpcRequestFn } from '../types/request.js'
-import type { OneOf } from '../types/utils.js'
+import type { Transport, TransportConfig } from '../types/transport.js'
 import { buildRequest } from '../utils/buildRequest.js'
 import { uid as uid_ } from '../utils/uid.js'
 
-export type TransportConfig<
-  type extends string = string,
-  rpcRequestFn extends BtcRpcRequestFn = BtcRpcRequestFn,
-> = {
-  /** The name of the transport. */
-  name: string
-  /** The key of the transport. */
-  key: string
-  /** Methods to include or exclude from executing RPC requests. */
-  methods?:
-    | OneOf<
-        | {
-            include?: string[] | undefined
-          }
-        | {
-            exclude?: string[] | undefined
-          }
-      >
-    | undefined
-  /** The JSON-RPC request function that matches the EIP-1193 request spec. */
-  request: rpcRequestFn
-  /** The base delay (in ms) between retries. */
-  retryDelay?: number | undefined
-  /** The max number of times to retry. */
-  retryCount?: number | undefined
-  /** The timeout (in ms) for requests. */
-  timeout?: number | undefined
-  /** The type of the transport. */
-  type: type
-}
-
-export type Transport<
-  type extends string = string,
-  rpcAttributes = Record<string, any>,
-  rpcRequestFn extends BtcRpcRequestFn = BtcRpcRequestFn,
-> = <chain extends Chain | undefined = Chain>({
-  chain,
-}: {
-  chain?: chain | undefined
-  pollingInterval?: ClientConfig['pollingInterval'] | undefined
-  retryCount?: TransportConfig['retryCount'] | undefined
-  timeout?: TransportConfig['timeout'] | undefined
-}) => {
-  config: TransportConfig<type>
-  request: rpcRequestFn
-  value?: rpcAttributes | undefined
-}
-
-export type CreateTransportErrorType = ErrorType
-
 /**
  * @description Creates an transport intended to be used with a client.
  */

package/src/transports/ankr/ankr.ts

@@ -1,11 +1,17 @@
+import type { TransportConfig } from '../../types/transport.js'
 import type { HttpTransportConfig } from '../http.js'
+import type { UTXOAPISchema, UTXOMethod } from '../types.js'
 import { utxo } from '../utxo.js'
+import { ankrMethods } from './methods.js'
 
 type AnkrConfig = { baseUrl?: string; apiKey?: string } & HttpTransportConfig
 
 export const ankr = (config?: AnkrConfig) => {
+  const methods: TransportConfig['methods'] = {
+    include: Object.keys(ankrMethods) as UTXOMethod[],
+  }
   if (config?.baseUrl) {
-    return utxo(config.baseUrl, { key: 'ankr', ...config })
+    return utxo(config.baseUrl, { key: 'ankr', ...config, methods })
   }
 
   if (!config?.apiKey) {
@@ -15,6 +21,7 @@ export const ankr = (config?: AnkrConfig) => {
     `https://rpc.ankr.com/premium-http/btc_blockbook/${config.apiKey}/api/v2`,
     {
       key: 'ankr',
+      methods,
       ...config,
     }
   )

package/src/transports/blockchair/blockchair.ts

@@ -1,5 +1,8 @@
+import type { TransportConfig } from '../../types/transport.js'
 import type { HttpTransportConfig } from '../http.js'
+import type { UTXOMethod } from '../types.js'
 import { utxo } from '../utxo.js'
+import { blockchairMethods } from './methods.js'
 
 type BlockchairConfig = {
   baseUrl?: string
@@ -10,5 +13,8 @@ export const blockchair = (config?: BlockchairConfig) =>
   utxo(config?.baseUrl || 'https://api.blockchair.com', {
     key: 'blockchair',
     includeChainToURL: true,
+    methods: {
+      include: Object.keys(blockchairMethods) as UTXOMethod[],
+    },
     ...config,
   })

package/src/transports/blockcypher/blockcypher.ts

@@ -1,5 +1,7 @@
 import type { HttpTransportConfig } from '../http.js'
+import type { UTXOMethod } from '../types.js'
 import { utxo } from '../utxo.js'
+import { blockcypherMethods } from './methods.js'
 
 type BlockcypherConfig = {
   baseUrl?: string
@@ -9,5 +11,8 @@ type BlockcypherConfig = {
 export const blockcypher = (config?: BlockcypherConfig) =>
   utxo(config?.baseUrl || 'https://api.blockcypher.com/v1/btc/main', {
     key: 'blockcypher',
+    methods: {
+      include: Object.keys(blockcypherMethods) as UTXOMethod[],
+    },
     ...config,
   })

package/src/transports/custom.ts

@@ -1,10 +1,10 @@
 import type { ErrorType } from '../errors/utils.js'
-import {
-  type CreateTransportErrorType,
-  type Transport,
-  type TransportConfig,
-  createTransport,
-} from '../factories/createTransport.js'
+import { createTransport } from '../factories/createTransport.js'
+import type {
+  CreateTransportErrorType,
+  Transport,
+  TransportConfig,
+} from '../types/transport.js'
 
 type BitcoinProvider = { request(...args: any): Promise<any> }
 

package/src/transports/fallback.ts

@@ -125,7 +125,7 @@ export function fallback<const transports extends readonly Transport[]>(
           // Filter transports to only those that support the requested method
           const supportedTransports = transports.reduce<
             ReturnType<Transport>[]
-          >((acc, transport) => {
+          >((supportedTransports, transport) => {
             const instance = transport({
               ...rest,
               chain,
@@ -135,18 +135,18 @@ export function fallback<const transports extends readonly Transport[]>(
             const { include, exclude } = instance.config.methods || {}
             if (include) {
               if (include.includes(method)) {
-                acc.push(instance)
+                supportedTransports.push(instance)
               }
-              return acc
+              return supportedTransports
             }
             if (exclude) {
               if (!exclude.includes(method)) {
-                acc.push(instance)
+                supportedTransports.push(instance)
               }
-              return acc
+              return supportedTransports
             }
-            acc.push(instance)
-            return acc
+            supportedTransports.push(instance)
+            return supportedTransports
           }, [])
 
           if (!supportedTransports.length) {

package/src/transports/http.ts

@@ -4,13 +4,13 @@ import {
   type UrlRequiredErrorType,
 } from '../errors/transport.js'
 import type { ErrorType } from '../errors/utils.js'
-import {
-  type CreateTransportErrorType,
-  type Transport,
-  type TransportConfig,
-  createTransport,
-} from '../factories/createTransport.js'
+import { createTransport } from '../factories/createTransport.js'
 import type { BtcRpcRequestFn, RpcSchema } from '../types/request.js'
+import type {
+  CreateTransportErrorType,
+  Transport,
+  TransportConfig,
+} from '../types/transport.js'
 import { createBatchScheduler } from '../utils/createBatchScheduler.js'
 import {
   type HttpRpcClientOptions,

package/src/transports/mempool/mempool.ts

@@ -1,5 +1,7 @@
 import type { HttpTransportConfig } from '../http.js'
+import type { UTXOMethod } from '../types.js'
 import { utxo } from '../utxo.js'
+import { mempoolMethods } from './methods.js'
 
 type MempoolConfig = {
   baseUrl?: string
@@ -8,5 +10,8 @@ type MempoolConfig = {
 export const mempool = (config?: MempoolConfig) =>
   utxo(config?.baseUrl || 'https://mempool.space/api', {
     key: 'mempool',
+    methods: {
+      include: Object.keys(mempoolMethods) as UTXOMethod[],
+    },
     ...config,
   })

package/src/transports/types.ts

@@ -2,7 +2,7 @@ import type { BlockStats, BlockStatsKeys } from '../types/blockStats.js'
 import type { UTXO, UTXOTransaction } from '../types/transaction.js'
 import type { HttpRpcClient } from './getHttpRpcClient.js'
 
-export const UTXOAPISchemaMethods = [
+export const UTXOAPISchemaMethods: UTXOMethod[] = [
   'getBalance',
   'getTransactions',
   'getUTXOs',

package/src/transports/utxo.ts

@@ -4,7 +4,7 @@ import { createTransport } from '../factories/createTransport.js'
 import { getHttpRpcClient } from './getHttpRpcClient.js'
 import { getRpcProviderMethods } from './getRpcProviderMethods.js'
 import type { HttpTransport, HttpTransportConfig } from './http.js'
-import { UTXOAPISchemaMethods, type UTXOMethod } from './types.js'
+import type { UTXOMethod } from './types.js'
 
 type UTXOHttpTransportConfig = HttpTransportConfig & {
   includeChainToURL?: boolean
@@ -23,6 +23,7 @@ export function utxo(
     onFetchResponse,
     retryDelay,
     apiKey,
+    methods,
   } = config
 
   return ({ chain, retryCount: retryCount_, timeout: timeout_ }) => {
@@ -50,9 +51,7 @@ export function utxo(
       {
         key,
         name,
-        methods: {
-          include: UTXOAPISchemaMethods,
-        },
+        methods,
         async request({ method, params }) {
           const body = { method, params }
           const methodHandler = rpcMethods?.[method as UTXOMethod]

package/src/types/request.ts

@@ -1,4 +1,5 @@
 import type { ErrorType } from '../errors/utils.js'
+import type { UTXOMethod } from '../transports/types.js'
 import type { OneOf } from './utils.js'
 
 export type RpcSchema = readonly {
@@ -34,10 +35,10 @@ export type BtcRpcRequestOptions = {
   methods?:
     | OneOf<
         | {
-            include?: string[] | undefined
+            include?: UTXOMethod[] | undefined
           }
         | {
-            exclude?: string[] | undefined
+            exclude?: UTXOMethod[] | undefined
           }
       >
     | undefined

package/src/types/transport.ts

@@ -1,4 +1,5 @@
 import type { ErrorType } from '../errors/utils.js'
+import type { UTXOMethod } from '../transports/types.js'
 import type { Chain } from './chain.js'
 import type { BtcRpcRequestFn, RpcSchema } from './request.js'
 import type { OneOf } from './utils.js'
@@ -15,10 +16,10 @@ export type TransportConfig<
   methods?:
     | OneOf<
         | {
-            include?: string[] | undefined
+            include?: UTXOMethod[] | undefined
           }
         | {
-            exclude?: string[] | undefined
+            exclude?: UTXOMethod[] | undefined
           }
       >
     | undefined

package/src/utils/getAction.ts

@@ -1,8 +1,8 @@
 import type { PublicActions } from '../clients/decorators/public.js'
 import type { WalletActions } from '../clients/decorators/wallet.js'
-import type { Transport } from '../factories/createTransport.js'
 import type { UTXOSchema } from '../transports/types.js'
 import type { Client } from '../types/client.js'
+import type { Transport } from '../types/transport.js'
 
 import type { Account } from '../types/account.js'
 import type { Chain } from '../types/chain.js'

package/src/version.ts

@@ -1,2 +1,2 @@
 export const name = '@bigmi/core'
-export const version = '0.3.0-beta.3'
+export const version = '0.3.0-beta.4'