@bigmi/core
Version:
TypeScript library for Bitcoin apps.
25 lines (24 loc) • 1.18 kB
TypeScript
import type { ErrorType } from '../errors/utils.js';
import type { CreateTransportErrorType, Transport, TransportConfig } from '../types/transport.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 {};