@bigmi/core 0.1.1 → 0.2.0-beta.0

package/dist/esm/factories/createClient.d.ts

@@ -0,0 +1,85 @@
+import type { Address } from '../types/address.js';
+import type { ErrorType } from '../errors/utils.js';
+import type { Transport } from '../factories/createTransport.js';
+import type { Account } from '../types/account.js';
+import type { Chain } from '../types/chain.js';
+import type { BtcRpcRequestFn, RpcSchema } from '../types/request.js';
+import type { BitcoinRpcMethods } from '../types/rpc.js';
+import type { Prettify } from '../types/utils.js';
+export type ClientConfig<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | Address | undefined = Account | Address | undefined, rpcSchema extends RpcSchema | undefined = undefined> = {
+    /** The Account to use for the Client. This will be used for Actions that require an account as an argument. */
+    account?: accountOrAddress | Account | Address | undefined;
+    /** Flags for batch settings. */
+    batch?: {
+        /** Toggle to enable `eth_call` multicall aggregation. */
+        multicall?: boolean | Prettify<MulticallBatchOptions> | undefined;
+    } | undefined;
+    /**
+     * Time (in ms) that cached data will remain in memory.
+     * @default 4_000
+     */
+    cacheTime?: number | undefined;
+    /** Chain for the client. */
+    chain?: Chain | undefined | chain;
+    /** A key for the client. */
+    key?: string | undefined;
+    /** A name for the client. */
+    name?: string | undefined;
+    /**
+     * Frequency (in ms) for polling enabled actions & events.
+     * @default 4_000
+     */
+    pollingInterval?: number | undefined;
+    /**
+     * Typed JSON-RPC schema for the client.
+     */
+    rpcSchema?: rpcSchema | undefined;
+    /** The RPC transport */
+    transport: transport;
+    /** The type of client. */
+    type?: string | undefined;
+};
+export type Client<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = undefined, extended extends Extended | undefined = Extended | undefined> = Client_Base<transport, chain, account, rpcSchema> & (extended extends Extended ? extended : unknown) & {
+    extend: <const client extends Extended>(fn: (client: Client<transport, chain, account, rpcSchema, extended>) => client) => Client<transport, chain, account, rpcSchema, Prettify<client> & (extended extends Extended ? extended : unknown)>;
+};
+type Client_Base<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = undefined> = {
+    /** The Account of the Client. */
+    account: account;
+    /** Time (in ms) that cached data will remain in memory. */
+    cacheTime: number;
+    /** Chain for the client. */
+    chain: chain;
+    /** A key for the client. */
+    key: string;
+    /** A name for the client. */
+    name: string;
+    /** Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. */
+    pollingInterval: number;
+    /** Request function wrapped with friendly error handling */
+    request: BtcRpcRequestFn<rpcSchema extends undefined ? BitcoinRpcMethods : rpcSchema>;
+    /** The RPC transport */
+    transport: ReturnType<transport>['config'] & ReturnType<transport>['value'];
+    /** The type of client. */
+    type: string;
+    /** A unique ID for the client. */
+    uid: string;
+};
+type Extended = Prettify<{
+    [_ in keyof Client_Base]?: undefined;
+} & {
+    [key: string]: unknown;
+}>;
+export type MulticallBatchOptions = {
+    /** The maximum size (in bytes) for each calldata chunk. @default 1_024 */
+    batchSize?: number | undefined;
+    /** The maximum number of milliseconds to wait before sending a batch. @default 0 */
+    wait?: number | undefined;
+};
+export type CreateClientErrorType = ErrorType;
+export declare function createClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = undefined>(parameters: ClientConfig<transport, chain, accountOrAddress, rpcSchema>): Prettify<Client<transport, chain, accountOrAddress extends Address ? Prettify<Account> : accountOrAddress, rpcSchema>>;
+/**
+ * Defines a typed JSON-RPC schema for the client.
+ * Note: This is a runtime noop function.
+ */
+export declare function rpcSchema<rpcSchema extends RpcSchema>(): rpcSchema;
+export {};

package/dist/esm/factories/createClient.js

@@ -0,0 +1,45 @@
+import { parseAccount } from '../utils/parseAccount.js';
+import { uid } from '../utils/uid.js';
+export function createClient(parameters) {
+    const { cacheTime = parameters.pollingInterval ?? 4000, key = 'base', name = 'Base Client', pollingInterval = 4000, type = 'base', } = parameters;
+    const chain = parameters.chain;
+    const account = parameters.account
+        ? parseAccount(parameters.account)
+        : undefined;
+    const { config, request, value } = parameters.transport({
+        chain,
+        pollingInterval,
+    });
+    const transport = { ...config, ...value };
+    const client = {
+        account,
+        cacheTime,
+        chain,
+        key,
+        name,
+        pollingInterval,
+        request,
+        transport,
+        type,
+        uid: uid(),
+    };
+    function extend(base) {
+        return (extendFn) => {
+            const extended = extendFn(base);
+            for (const key in client) {
+                delete extended[key];
+            }
+            const combined = { ...base, ...extended };
+            return Object.assign(combined, { extend: extend(combined) });
+        };
+    }
+    return Object.assign(client, { extend: extend(client) });
+}
+/**
+ * Defines a typed JSON-RPC schema for the client.
+ * Note: This is a runtime noop function.
+ */
+export function rpcSchema() {
+    return null;
+}
+//# sourceMappingURL=createClient.js.map

package/dist/esm/factories/createClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createClient.js","sourceRoot":"","sources":["../../../src/factories/createClient.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AAmIrC,MAAM,UAAU,YAAY,CAAC,UAAwB;IACnD,MAAM,EACJ,SAAS,GAAG,UAAU,CAAC,eAAe,IAAI,IAAK,EAE/C,GAAG,GAAG,MAAM,EACZ,IAAI,GAAG,aAAa,EACpB,eAAe,GAAG,IAAK,EACvB,IAAI,GAAG,MAAM,GACd,GAAG,UAAU,CAAA;IAEd,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAA;IAC9B,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO;QAChC,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC;QAClC,CAAC,CAAC,SAAS,CAAA;IACb,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC;QACtD,KAAK;QACL,eAAe;KAChB,CAAC,CAAA;IACF,MAAM,SAAS,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,CAAA;IAEzC,MAAM,MAAM,GAAG;QACb,OAAO;QACP,SAAS;QAET,KAAK;QACL,GAAG;QACH,IAAI;QACJ,eAAe;QACf,OAAO;QACP,SAAS;QACT,IAAI;QACJ,GAAG,EAAE,GAAG,EAAE;KACX,CAAA;IAED,SAAS,MAAM,CAAC,IAAmB;QAEjC,OAAO,CAAC,QAAkB,EAAE,EAAE;YAC5B,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAa,CAAA;YAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBACzB,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;YACtB,CAAC;YACD,MAAM,QAAQ,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,EAAE,CAAA;YACzC,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,QAAe,CAAC,EAAE,CAAC,CAAA;QACrE,CAAC,CAAA;IACH,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAQ,EAAE,CAAC,CAAA;AACjE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,IAAW,CAAA;AACpB,CAAC"}

package/dist/esm/factories/createTransport.d.ts

@@ -0,0 +1,42 @@
+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';
+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.
+ */
+export declare function createTransport<type extends string, rpcAttributes extends Record<string, any>>({ key, methods, name, request, retryCount, retryDelay, timeout, type, }: TransportConfig<type>, value?: rpcAttributes | undefined): ReturnType<Transport<type, rpcAttributes>>;

package/dist/esm/factories/createTransport.js

@@ -0,0 +1,23 @@
+import { buildRequest } from '../utils/buildRequest.js';
+import { uid as uid_ } from '../utils/uid.js';
+/**
+ * @description Creates an transport intended to be used with a client.
+ */
+export function createTransport({ key, methods, name, request, retryCount = 3, retryDelay = 150, timeout, type, }, value) {
+    const uid = uid_();
+    return {
+        config: {
+            key,
+            methods,
+            name,
+            request,
+            retryCount,
+            retryDelay,
+            timeout,
+            type,
+        },
+        request: buildRequest(request, { methods, retryCount, retryDelay, uid }),
+        value,
+    };
+}
+//# sourceMappingURL=createTransport.js.map

package/dist/esm/factories/createTransport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTransport.js","sourceRoot":"","sources":["../../../src/factories/createTransport.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,GAAG,IAAI,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAoD7C;;GAEG;AACH,MAAM,UAAU,eAAe,CAI7B,EACE,GAAG,EACH,OAAO,EACP,IAAI,EACJ,OAAO,EACP,UAAU,GAAG,CAAC,EACd,UAAU,GAAG,GAAG,EAChB,OAAO,EACP,IAAI,GACkB,EACxB,KAAiC;IAEjC,MAAM,GAAG,GAAG,IAAI,EAAE,CAAA;IAClB,OAAO;QACL,MAAM,EAAE;YACN,GAAG;YACH,OAAO;YACP,IAAI;YACJ,OAAO;YACP,UAAU;YACV,UAAU;YACV,OAAO;YACP,IAAI;SACL;QACD,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC;QACxE,KAAK;KACN,CAAA;AACH,CAAC"}

package/dist/esm/index.d.ts

@@ -14,9 +14,8 @@ export { waitForTransaction } from './actions/waitForTransaction.js';
 export type { ReplacementReason, ReplacementReturnType, WaitForTransactionReceiptParameters, WaitForTransactionReceiptReturnType, WithRetryParameters, } from './actions/waitForTransaction.js';
 export { watchBlockNumber } from './actions/watchBlockNumber.js';
 export type { OnBlockNumberFn, OnBlockNumberParameter, WatchBlockNumberParameters, WatchBlockNumberReturnType, } from './actions/watchBlockNumber.js';
-export type { BtcAccount, SignPsbtParameters, SignPsbtReturnType, UTXOWalletProvider, UTXOWalletSchema, } from './clients/types.js';
-export { UTXOActions } from './decorators/UTXOActions.js';
-export { UTXOAPIActions } from './decorators/UTXOAPIActions.js';
+export { type PublicActions, publicActions, } from './clients/decorators/public.js';
+export { type WalletActions, walletActions, } from './clients/decorators/wallet.js';
 export { ankrMethods } from './transports/ankr.js';
 export { blockchairMethods } from './transports/blockchair.js';
 export { blockcypherMethods } from './transports/blockcypher.js';
@@ -24,10 +23,21 @@ export { getHttpRpcClient } from './transports/getHttpRpcClient.js';
 export type { HttpRequestParameters, HttpRpcClient, RpcRequest, } from './transports/getHttpRpcClient.js';
 export { getRpcProviderMethods } from './transports/getRpcProviderMethods.js';
 export { mempoolMethods } from './transports/mempool.js';
-export type { ErrorResult, RpcMethodHandler, RpcMethods, RpcResponse, SuccessResult, UTXOAPIMethod, UTXOAPISchema, UTXOSchema, } from './transports/types.js';
+export type { ErrorResult, RpcMethodHandler, RpcMethods, RpcResponse, SuccessResult, UTXOSchema, UTXOWalletSchema, SignPsbtParameters, SignPsbtReturnType, } from './transports/types.js';
 export { utxo } from './transports/utxo.js';
+export { custom } from './transports/custom.js';
+export type { Account } from './types/account.js';
+export type { Address } from './types/address.js';
+export type { BlockTag } from './types/block.js';
 export type { BlockStats, BlockStatsKeys } from './types/blockStats.js';
+export type { Chain, ChainConfig, ChainFormatter, ChainFormatters, } from './types/chain.js';
+export type { Client, ClientConfig, CreateClientErrorType, } from './types/client.js';
+export type { Hash } from './types/hash.js';
+export type { BtcRpcRequestFn, BtcRpcRequestOptions, RpcParameters, RpcSchema, RpcSchemaOverride, } from './types/request.js';
+export type { BitcoinRpcMethods, WalletRpcSchema, } from './types/rpc.js';
 export type { UTXOTransaction } from './types/transaction.js';
+export type { Assign, Compute, ExactPartial, IsNarrowable, IsNever, IsUnknown, LooseOmit, UnionStrictOmit, } from './types/utils.js';
+export type { BtcAccount } from './types/account.js';
 export { cancelTransaction } from './utils/cancelTransaction.js';
 export { UTXOAddressType, UTXONetwork, getUTXOAddress, } from './utils/getUTXOAddress.js';
 export type { UTXOAddress } from './utils/getUTXOAddress.js';
@@ -35,4 +45,27 @@ export { isUTXOAddress } from './utils/isUTXOAddress.js';
 export { modifyFee } from './utils/modifyFee.js';
 export { cleanupCache, listenersCache, observe } from './utils/observe.js';
 export { poll } from './utils/poll.js';
+export { base64ToHex, hexToBase64 } from './utils/converter.js';
+export { withRetry } from './utils/withRetry.js';
+export { parseAccount } from './utils/parseAccount.js';
+export { deepEqual } from './utils/deepEqual.js';
+export { withTimeout } from './utils/withTimeout.js';
+export { createClient, rpcSchema } from './factories/createClient.js';
 export { bitcoin } from './chains/bitcoin.js';
+export { defineChain } from './chains/defineChain.js';
+export { InvalidAddressError, type InvalidAddressErrorType, } from './errors/address.js';
+export { BaseError, type BaseErrorType } from './errors/base.js';
+export { BlockNotFoundError } from './errors/block.js';
+export { ChainNotConfiguredError, ConnectorAccountNotFoundError, ConnectorAlreadyConnectedError, ConnectorChainMismatchError, ConnectorNotConnectedError, ConnectorNotFoundError, } from './errors/config.js';
+export { ProviderNotFoundError } from './errors/provider.js';
+export { HttpRequestError, RpcRequestError, SocketClosedError, TimeoutError, } from './errors/request.js';
+export { MethodNotSupportedRpcError, ParseError, RpcErrorCode, UserRejectedRequestError, } from './errors/rpc.js';
+export { TransactionNotFoundError, TransactionReceiptNotFoundError, WaitForTransactionReceiptTimeoutError, } from './errors/transaction.js';
+export { UrlRequiredError } from './errors/transport.js';
+export type { ErrorType } from './errors/utils.js';
+export { http, type HttpTransport, type HttpTransportConfig, type HttpTransportErrorType, } from './transports/http.js';
+export { fallback, type FallbackTransport, type FallbackTransportConfig, type FallbackTransportErrorType, } from './transports/fallback.js';
+export type { Transport } from './types/transport.js';
+export type { OneOf, RemoveUndefined } from './types/utils.js';
+export { uid } from './utils/uid.js';
+export { version } from './version.js';

package/dist/esm/index.js

@@ -8,9 +8,9 @@ export { sendUTXOTransaction } from './actions/sendUTXOTransaction.js';
 export { signPsbt } from './actions/signPsbt.js';
 export { waitForTransaction } from './actions/waitForTransaction.js';
 export { watchBlockNumber } from './actions/watchBlockNumber.js';
-// Exporting decorators
-export { UTXOActions } from './decorators/UTXOActions.js';
-export { UTXOAPIActions } from './decorators/UTXOAPIActions.js';
+// Exporting clients
+export { publicActions, } from './clients/decorators/public.js';
+export { walletActions, } from './clients/decorators/wallet.js';
 // Exporting transports
 export { ankrMethods } from './transports/ankr.js';
 export { blockchairMethods } from './transports/blockchair.js';
@@ -19,6 +19,7 @@ export { getHttpRpcClient } from './transports/getHttpRpcClient.js';
 export { getRpcProviderMethods } from './transports/getRpcProviderMethods.js';
 export { mempoolMethods } from './transports/mempool.js';
 export { utxo } from './transports/utxo.js';
+export { custom } from './transports/custom.js';
 // Exporting utils
 export { cancelTransaction } from './utils/cancelTransaction.js';
 export { UTXOAddressType, UTXONetwork, getUTXOAddress, } from './utils/getUTXOAddress.js';
@@ -26,6 +27,28 @@ export { isUTXOAddress } from './utils/isUTXOAddress.js';
 export { modifyFee } from './utils/modifyFee.js';
 export { cleanupCache, listenersCache, observe } from './utils/observe.js';
 export { poll } from './utils/poll.js';
+export { base64ToHex, hexToBase64 } from './utils/converter.js';
+export { withRetry } from './utils/withRetry.js';
+export { parseAccount } from './utils/parseAccount.js';
+export { deepEqual } from './utils/deepEqual.js';
+export { withTimeout } from './utils/withTimeout.js';
+// Exporting factories
+export { createClient, rpcSchema } from './factories/createClient.js';
 // Exporting chains
 export { bitcoin } from './chains/bitcoin.js';
+export { defineChain } from './chains/defineChain.js';
+// Exporting errors
+export { InvalidAddressError, } from './errors/address.js';
+export { BaseError } from './errors/base.js';
+export { BlockNotFoundError } from './errors/block.js';
+export { ChainNotConfiguredError, ConnectorAccountNotFoundError, ConnectorAlreadyConnectedError, ConnectorChainMismatchError, ConnectorNotConnectedError, ConnectorNotFoundError, } from './errors/config.js';
+export { ProviderNotFoundError } from './errors/provider.js';
+export { HttpRequestError, RpcRequestError, SocketClosedError, TimeoutError, } from './errors/request.js';
+export { MethodNotSupportedRpcError, ParseError, RpcErrorCode, UserRejectedRequestError, } from './errors/rpc.js';
+export { TransactionNotFoundError, TransactionReceiptNotFoundError, WaitForTransactionReceiptTimeoutError, } from './errors/transaction.js';
+export { UrlRequiredError } from './errors/transport.js';
+export { http, } from './transports/http.js';
+export { fallback, } from './transports/fallback.js';
+export { uid } from './utils/uid.js';
+export { version } from './version.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAKhD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAK1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAKpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAKtE,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAQpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAiBhE,uBAAuB;AACvB,OAAO,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAA;AAE/D,uBAAuB;AACvB,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AAMnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAA;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAWxD,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAM3C,kBAAkB;AAClB,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EACL,eAAe,EACf,WAAW,EACX,cAAc,GACf,MAAM,2BAA2B,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC1E,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAEtC,mBAAmB;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAKhD,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE1D,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAK1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAKpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAA;AAKtE,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAQpE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAQhE,oBAAoB;AACpB,OAAO,EAEL,aAAa,GACd,MAAM,gCAAgC,CAAA;AACvC,OAAO,EAEL,aAAa,GACd,MAAM,gCAAgC,CAAA;AAEvC,uBAAuB;AACvB,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAA;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAA;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAA;AAMnE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uCAAuC,CAAA;AAC7E,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAYxD,OAAO,EAAE,IAAI,EAAE,MAAM,sBAAsB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AA2C/C,kBAAkB;AAClB,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,EACL,eAAe,EACf,WAAW,EACX,cAAc,GACf,MAAM,2BAA2B,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAC1E,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AACtC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AAEpD,sBAAsB;AACtB,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAErE,mBAAmB;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAErD,mBAAmB;AACnB,OAAO,EACL,mBAAmB,GAEpB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAsB,MAAM,kBAAkB,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EACL,uBAAuB,EACvB,6BAA6B,EAC7B,8BAA8B,EAC9B,2BAA2B,EAC3B,0BAA0B,EAC1B,sBAAsB,GACvB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,YAAY,GACb,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,0BAA0B,EAC1B,UAAU,EACV,YAAY,EACZ,wBAAwB,GACzB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACL,wBAAwB,EACxB,+BAA+B,EAC/B,qCAAqC,GACtC,MAAM,yBAAyB,CAAA;AAChC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,EACL,IAAI,GAIL,MAAM,sBAAsB,CAAA;AAE7B,OAAO,EACL,QAAQ,GAIT,MAAM,0BAA0B,CAAA;AAKjC,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/dist/esm/transports/custom.d.ts

@@ -0,0 +1,24 @@
+import type { ErrorType } from '../errors/utils.js';
+import { type CreateTransportErrorType, type Transport, type TransportConfig } from '../factories/createTransport.js';
+type BitcoinProvider = {
+    request(...args: any): Promise<any>;
+};
+export type CustomTransportConfig = {
+    /** The key of the transport. */
+    key?: TransportConfig['key'] | undefined;
+    /** Methods to include or exclude from executing RPC requests. */
+    methods?: TransportConfig['methods'] | undefined;
+    /** The name of the transport. */
+    name?: TransportConfig['name'] | undefined;
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'] | undefined;
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'] | undefined;
+};
+export type CustomTransport = Transport<'custom', {}, BitcoinProvider['request']>;
+export type CustomTransportErrorType = CreateTransportErrorType | ErrorType;
+/**
+ * @description Creates a custom transport given an EIP-1193 compliant `request` attribute.
+ */
+export declare function custom<provider extends BitcoinProvider>(provider: provider, config?: CustomTransportConfig): CustomTransport;
+export {};

package/dist/esm/transports/custom.js

@@ -0,0 +1,17 @@
+import { createTransport, } from '../factories/createTransport.js';
+/**
+ * @description Creates a custom transport given an EIP-1193 compliant `request` attribute.
+ */
+export function custom(provider, config = {}) {
+    const { key = 'custom', methods, name = 'Custom Provider', retryDelay, } = config;
+    return ({ retryCount: defaultRetryCount }) => createTransport({
+        key,
+        methods,
+        name,
+        request: provider.request.bind(provider),
+        retryCount: config.retryCount ?? defaultRetryCount,
+        retryDelay,
+        type: 'custom',
+    });
+}
+//# sourceMappingURL=custom.js.map

package/dist/esm/transports/custom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../../src/transports/custom.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,eAAe,GAChB,MAAM,iCAAiC,CAAA;AA0BxC;;GAEG;AACH,MAAM,UAAU,MAAM,CACpB,QAAkB,EAClB,SAAgC,EAAE;IAElC,MAAM,EACJ,GAAG,GAAG,QAAQ,EACd,OAAO,EACP,IAAI,GAAG,iBAAiB,EACxB,UAAU,GACX,GAAG,MAAM,CAAA;IACV,OAAO,CAAC,EAAE,UAAU,EAAE,iBAAiB,EAAE,EAAE,EAAE,CAC3C,eAAe,CAAC;QACd,GAAG;QACH,OAAO;QACP,IAAI;QACJ,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC;QACxC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,iBAAiB;QAClD,UAAU;QACV,IAAI,EAAE,QAAQ;KACf,CAAC,CAAA;AACN,CAAC"}

package/dist/esm/transports/fallback.d.ts

@@ -0,0 +1,89 @@
+import type { ErrorType } from '../errors/utils.js';
+import type { Chain } from '../types/chain.js';
+import type { CreateTransportErrorType, Transport, TransportConfig } from '../types/transport.js';
+export type OnResponseFn = (args: {
+    method: string;
+    params: unknown[];
+    transport: ReturnType<Transport>;
+} & ({
+    error?: undefined;
+    response: unknown;
+    status: 'success';
+} | {
+    error: Error;
+    response?: undefined;
+    status: 'error';
+})) => void;
+type RankOptions = {
+    /**
+     * The polling interval (in ms) at which the ranker should ping the RPC URL.
+     * @default client.pollingInterval
+     */
+    interval?: number | undefined;
+    /**
+     * Ping method to determine latency.
+     */
+    ping?: (parameters: {
+        transport: ReturnType<Transport>;
+    }) => Promise<unknown> | undefined;
+    /**
+     * The number of previous samples to perform ranking on.
+     * @default 10
+     */
+    sampleCount?: number | undefined;
+    /**
+     * Timeout when sampling transports.
+     * @default 1_000
+     */
+    timeout?: number | undefined;
+    /**
+     * Weights to apply to the scores. Weight values are proportional.
+     */
+    weights?: {
+        /**
+         * The weight to apply to the latency score.
+         * @default 0.3
+         */
+        latency?: number | undefined;
+        /**
+         * The weight to apply to the stability score.
+         * @default 0.7
+         */
+        stability?: number | undefined;
+    } | undefined;
+};
+export type FallbackTransportConfig = {
+    /** The key of the Fallback transport. */
+    key?: TransportConfig['key'] | undefined;
+    /** The name of the Fallback transport. */
+    name?: TransportConfig['name'] | undefined;
+    /** Toggle to enable ranking, or rank options. */
+    rank?: boolean | RankOptions | undefined;
+    /** The max number of times to retry. */
+    retryCount?: TransportConfig['retryCount'] | undefined;
+    /** The base delay (in ms) between retries. */
+    retryDelay?: TransportConfig['retryDelay'] | undefined;
+    /** Callback on whether an error should throw or try the next transport in the fallback. */
+    shouldThrow?: (error: Error) => boolean | undefined;
+};
+export type FallbackTransport<transports extends readonly Transport[] = readonly Transport[]> = Transport<'fallback', {
+    onResponse: (fn: OnResponseFn) => void;
+    transports: {
+        [key in keyof transports]: ReturnType<transports[key]>;
+    };
+}>;
+export type FallbackTransportErrorType = CreateTransportErrorType | ErrorType;
+export declare function fallback<const transports extends readonly Transport[]>(transports_: transports, config?: FallbackTransportConfig): FallbackTransport<transports>;
+export declare function shouldThrow(error: Error): boolean;
+/** @internal */
+export declare function rankTransports({ chain, interval, onTransports, ping, sampleCount, timeout, transports, weights, }: {
+    chain?: Chain | undefined;
+    interval: RankOptions['interval'];
+    onTransports: (transports: readonly Transport[]) => void;
+    ping?: RankOptions['ping'] | undefined;
+    sampleCount?: RankOptions['sampleCount'] | undefined;
+    timeout?: RankOptions['timeout'] | undefined;
+    transports: readonly Transport[];
+    weights?: RankOptions['weights'] | undefined;
+}): void;
+export {};

package/dist/esm/transports/fallback.js

@@ -0,0 +1,172 @@
+import { RpcErrorCode } from '../errors/rpc.js';
+import { createTransport } from '../factories/createTransport.js';
+import { wait } from '../utils/wait.js';
+export function fallback(transports_, config = {}) {
+    const { key = 'fallback', name = 'Fallback', rank = false, shouldThrow: shouldThrow_ = shouldThrow, retryCount, retryDelay, } = config;
+    return (({ chain, pollingInterval = 4000, timeout, ...rest }) => {
+        let transports = transports_;
+        let onResponse = () => { };
+        const transport = createTransport({
+            key,
+            name,
+            async request({ method, params }) {
+                let includes;
+                const fetch = async (i = 0) => {
+                    const transport = transports[i]({
+                        ...rest,
+                        chain,
+                        retryCount: 0,
+                        timeout,
+                    });
+                    try {
+                        const response = await transport.request({
+                            method,
+                            params,
+                        });
+                        onResponse({
+                            method,
+                            params: params,
+                            response,
+                            transport,
+                            status: 'success',
+                        });
+                        return response;
+                    }
+                    catch (err) {
+                        onResponse({
+                            error: err,
+                            method,
+                            params: params,
+                            transport,
+                            status: 'error',
+                        });
+                        if (shouldThrow_(err)) {
+                            throw err;
+                        }
+                        // If we've reached the end of the fallbacks, throw the error.
+                        if (i === transports.length - 1) {
+                            throw err;
+                        }
+                        // Check if at least one other transport includes the method
+                        includes ?? (includes = transports.slice(i + 1).some((transport) => {
+                            const { include, exclude } = transport({ chain }).config.methods || {};
+                            if (include) {
+                                return include.includes(method);
+                            }
+                            if (exclude) {
+                                return !exclude.includes(method);
+                            }
+                            return true;
+                        }));
+                        if (!includes) {
+                            throw err;
+                        }
+                        // Otherwise, try the next fallback.
+                        return fetch(i + 1);
+                    }
+                };
+                return fetch();
+            },
+            retryCount,
+            retryDelay,
+            type: 'fallback',
+        }, {
+            onResponse: (fn) => {
+                onResponse = fn;
+            },
+            transports: transports.map((fn) => fn({ chain, retryCount: 0 })),
+        });
+        if (rank) {
+            const rankOptions = (typeof rank === 'object' ? rank : {});
+            rankTransports({
+                chain,
+                interval: rankOptions.interval ?? pollingInterval,
+                onTransports: (transports_) => {
+                    transports = transports_;
+                },
+                ping: rankOptions.ping,
+                sampleCount: rankOptions.sampleCount,
+                timeout: rankOptions.timeout,
+                transports,
+                weights: rankOptions.weights,
+            });
+        }
+        return transport;
+    });
+}
+export function shouldThrow(error) {
+    if ('code' in error && typeof error.code === 'number') {
+        if (error.code === RpcErrorCode.INTERNAL_ERROR ||
+            error.code === RpcErrorCode.USER_REJECTION ||
+            error.code === 5000 // CAIP UserRejectedRequestError
+        ) {
+            return true;
+        }
+    }
+    return false;
+}
+/** @internal */
+export function rankTransports({ chain, interval = 4000, onTransports, ping, sampleCount = 10, timeout = 1000, transports, weights = {}, }) {
+    const { stability: stabilityWeight = 0.7, latency: latencyWeight = 0.3 } = weights;
+    const samples = [];
+    const rankTransports_ = async () => {
+        // 1. Take a sample from each Transport.
+        const sample = await Promise.all(transports.map(async (transport) => {
+            const transport_ = transport({ chain, retryCount: 0, timeout });
+            const start = Date.now();
+            let end;
+            let success;
+            try {
+                await (ping
+                    ? ping({ transport: transport_ })
+                    : transport_.request({
+                        method: 'net_listening',
+                        params: undefined,
+                    }));
+                success = 1;
+            }
+            catch {
+                success = 0;
+            }
+            finally {
+                end = Date.now();
+            }
+            const latency = end - start;
+            return { latency, success };
+        }));
+        // 2. Store the sample. If we have more than `sampleCount` samples, remove
+        // the oldest sample.
+        samples.push(sample);
+        if (samples.length > sampleCount) {
+            samples.shift();
+        }
+        // 3. Calculate the max latency from samples.
+        const maxLatency = Math.max(...samples.map((sample) => Math.max(...sample.map(({ latency }) => latency))));
+        // 4. Calculate the score for each Transport.
+        const scores = transports
+            .map((_, i) => {
+            const latencies = samples.map((sample) => sample[i].latency);
+            const meanLatency = latencies.reduce((acc, latency) => acc + latency, 0) /
+                latencies.length;
+            const latencyScore = 1 - meanLatency / maxLatency;
+            const successes = samples.map((sample) => sample[i].success);
+            const stabilityScore = successes.reduce((acc, success) => acc + success, 0) /
+                successes.length;
+            if (stabilityScore === 0) {
+                return [0, i];
+            }
+            return [
+                latencyWeight * latencyScore + stabilityWeight * stabilityScore,
+                i,
+            ];
+        })
+            .sort((a, b) => b[0] - a[0]);
+        // 5. Sort the Transports by score.
+        onTransports(scores.map(([, i]) => transports[i]));
+        // 6. Wait, and then rank again.
+        await wait(interval);
+        rankTransports_();
+    };
+    rankTransports_();
+}
+//# sourceMappingURL=fallback.js.map