@bigmi/core 0.7.1 → 0.8.0

package/dist/cjs/types/hash.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=hash.js.map

package/dist/cjs/types/request.d.ts

@@ -1,44 +1,46 @@
-import type { ErrorType } from '../errors/utils.js';
-import type { UTXOMethod } from '../transports/types.js';
-import type { OneOf } from './utils.js';
-export type RpcSchema = readonly {
-    Method: string;
-    Parameters?: unknown | undefined;
-    ReturnType: unknown;
+import { OneOf } from "./utils.js";
+import { UTXOMethod } from "../transports/types.js";
+import { ErrorType } from "../errors/utils.js";
+
+//#region src/types/request.d.ts
+type RpcSchema = readonly {
+  Method: string;
+  Parameters?: unknown | undefined;
+  ReturnType: unknown;
 }[];
-export type RpcSchemaOverride = Omit<RpcSchema[number], 'Method'>;
+type RpcSchemaOverride = Omit<RpcSchema[number], "Method">;
 type DerivedRpcSchema<rpcSchema extends RpcSchema | undefined> = rpcSchema extends RpcSchema ? rpcSchema : never;
-export type RpcParameters<rpcSchema extends RpcSchema | undefined = undefined> = rpcSchema extends RpcSchema ? {
-    [K in keyof rpcSchema]: rpcSchema[K] extends RpcSchema[number] ? {
-        method: rpcSchema[K]['Method'];
-        params: rpcSchema[K]['Parameters'];
-    } : never;
-}[number] : {
-    method: string;
-    params?: unknown | undefined;
+type RpcParameters<rpcSchema extends RpcSchema | undefined = undefined> = rpcSchema extends RpcSchema ? { [K in keyof rpcSchema]: rpcSchema[K] extends RpcSchema[number] ? {
+  method: rpcSchema[K]["Method"];
+  params: rpcSchema[K]["Parameters"];
+} : never }[number] : {
+  method: string;
+  params?: unknown | undefined;
 };
-export type BtcRpcRequestOptions = {
-    dedupe?: boolean | undefined;
-    methods?: OneOf<{
-        include?: UTXOMethod[] | undefined;
-    } | {
-        exclude?: UTXOMethod[] | undefined;
-    }> | undefined;
-    retryDelay?: number | undefined;
-    retryCount?: number | undefined;
-    uid?: string | undefined;
+type BtcRpcRequestOptions = {
+  /** Deduplicate in-flight requests. */dedupe?: boolean | undefined; /** Methods to include or exclude from executing RPC requests. */
+  methods?: OneOf<{
+    include?: UTXOMethod[] | undefined;
+  } | {
+    exclude?: UTXOMethod[] | undefined;
+  }> | undefined; /** The base delay (in ms) between retries. */
+  retryDelay?: number | undefined; /** The max number of times to retry. */
+  retryCount?: number | undefined; /** Unique identifier for the request. */
+  uid?: string | undefined;
 };
-export type BtcRpcRequestFn<rpcSchema extends RpcSchema | undefined = undefined, raw extends boolean = false> = <_parameters extends RpcParameters<DerivedRpcSchema<rpcSchema>> = RpcParameters<DerivedRpcSchema<rpcSchema>>, _returnType = DerivedRpcSchema<rpcSchema> extends RpcSchema ? raw extends true ? OneOf<{
-    result: Extract<DerivedRpcSchema<rpcSchema>[number], {
-        Method: _parameters['method'];
-    }>['ReturnType'];
+type BtcRpcRequestFn<rpcSchema extends RpcSchema | undefined = undefined, raw extends boolean = false> = <_parameters extends RpcParameters<DerivedRpcSchema<rpcSchema>> = RpcParameters<DerivedRpcSchema<rpcSchema>>, _returnType = (DerivedRpcSchema<rpcSchema> extends RpcSchema ? raw extends true ? OneOf<{
+  result: Extract<DerivedRpcSchema<rpcSchema>[number], {
+    Method: _parameters["method"];
+  }>["ReturnType"];
 } | {
-    error: ErrorType;
+  error: ErrorType;
 }> : Extract<DerivedRpcSchema<rpcSchema>[number], {
-    Method: _parameters['method'];
-}>['ReturnType'] : raw extends true ? OneOf<{
-    result: unknown;
+  Method: _parameters["method"];
+}>["ReturnType"] : raw extends true ? OneOf<{
+  result: unknown;
 } | {
-    error: ErrorType;
-}> : unknown>(args: _parameters, options?: BtcRpcRequestOptions | undefined) => Promise<_returnType>;
-export {};
+  error: ErrorType;
+}> : unknown)>(args: _parameters, options?: BtcRpcRequestOptions | undefined) => Promise<_returnType>;
+//#endregion
+export { BtcRpcRequestFn, BtcRpcRequestOptions, RpcParameters, RpcSchema, RpcSchemaOverride };
+//# sourceMappingURL=request.d.ts.map

package/dist/cjs/types/request.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=request.js.map

package/dist/cjs/types/rpc.d.ts

@@ -1,34 +1,34 @@
-export type RpcRequest = {
-    jsonrpc?: '2.0' | undefined;
-    method: string;
-    params?: any | undefined;
-    id?: number | undefined;
+//#region src/types/rpc.d.ts
+type RpcRequest = {
+  jsonrpc?: "2.0" | undefined;
+  method: string;
+  params?: any | undefined;
+  id?: number | undefined;
 };
-export type RpcResponse<result = any, error = any> = {
-    jsonrpc: `${number}`;
-    id: number;
+type RpcResponse<result = any, error = any> = {
+  jsonrpc: `${number}`;
+  id: number;
 } & (SuccessResult<result> | ErrorResult<error>);
 type SuccessResult<result> = {
-    method?: undefined;
-    result: result;
-    error?: undefined;
+  method?: undefined;
+  result: result;
+  error?: undefined;
 };
 type ErrorResult<error> = {
-    method?: undefined;
-    result?: undefined;
-    error: error;
+  method?: undefined;
+  result?: undefined;
+  error: error;
 };
-export type BitcoinRpcMethods = [...WalletRpcSchema];
-export type WalletRpcSchema = [
-    {
-        Method: 'getAddressInfo';
-        Parameters?: undefined;
-        ReturnType: string;
-    },
-    {
-        Method: 'getBalance';
-        Parameters?: undefined;
-        ReturnType: bigint;
-    }
-];
-export {};
+type BitcoinRpcMethods = [...WalletRpcSchema];
+type WalletRpcSchema = [{
+  Method: "getAddressInfo";
+  Parameters?: undefined;
+  ReturnType: string;
+}, {
+  Method: "getBalance";
+  Parameters?: undefined;
+  ReturnType: bigint;
+}];
+//#endregion
+export { BitcoinRpcMethods, RpcRequest, RpcResponse, WalletRpcSchema };
+//# sourceMappingURL=rpc.d.ts.map

package/dist/cjs/types/rpc.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=rpc.js.map

package/dist/cjs/types/transaction.d.ts

@@ -1,49 +1,53 @@
-export type UTXOTransaction = {
-    blockhash?: string;
-    blocktime?: number;
-    confirmations?: number;
-    hash: string;
-    hex: string;
-    in_active_chain?: boolean;
-    locktime: number;
-    size: number;
-    time?: number;
+//#region src/types/transaction.d.ts
+type UTXOTransaction = {
+  blockhash?: string;
+  blocktime?: number;
+  confirmations?: number;
+  hash: string;
+  hex: string;
+  in_active_chain?: boolean;
+  locktime: number;
+  size: number;
+  time?: number;
+  txid: string;
+  version: number;
+  vsize: number;
+  weight: number;
+  vin: ({
+    coinbase: string;
+    sequence: number;
+    txinwitness?: string[];
+  } | {
     txid: string;
-    version: number;
-    vsize: number;
-    weight: number;
-    vin: ({
-        coinbase: string;
-        sequence: number;
-        txinwitness?: string[];
-    } | {
-        txid: string;
-        vout: number;
-        scriptSig?: {
-            asm: string;
-            hex: string;
-        };
-        sequence: number;
-        txinwitness?: string[];
-    })[];
-    vout: {
-        n: number;
-        value: number;
-        scriptPubKey: {
-            address?: string;
-            asm: string;
-            desc: string;
-            hex: string;
-            type: string;
-        };
-    }[];
-};
-export type UTXO = {
-    txId: string;
     vout: number;
+    scriptSig?: {
+      asm: string;
+      hex: string;
+    };
+    sequence: number;
+    txinwitness?: string[];
+  })[];
+  vout: {
+    n: number;
     value: number;
-    isConfirmed?: boolean;
-    confirmations?: number;
-    blockHeight: number;
-    scriptHex: string;
+    scriptPubKey: {
+      address?: string;
+      asm: string;
+      desc: string;
+      hex: string;
+      type: string;
+    };
+  }[];
+};
+type UTXO = {
+  txId: string;
+  vout: number;
+  value: number;
+  isConfirmed?: boolean;
+  confirmations?: number;
+  blockHeight: number;
+  scriptHex: string;
 };
+//#endregion
+export { UTXO, UTXOTransaction };
+//# sourceMappingURL=transaction.d.ts.map

package/dist/cjs/types/transaction.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=transaction.js.map

package/dist/cjs/types/transport.d.ts

@@ -1,30 +1,37 @@
-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';
-export type TransportConfig<type extends string = string, rpcRequestFn extends BtcRpcRequestFn = BtcRpcRequestFn> = {
-    name: string;
-    key: string;
-    methods?: OneOf<{
-        include?: UTXOMethod[] | undefined;
-    } | {
-        exclude?: UTXOMethod[] | undefined;
-    }> | undefined;
-    request: rpcRequestFn;
-    retryDelay?: number | undefined;
-    retryCount?: number | undefined;
-    timeout?: number | undefined;
-    type: type;
+import { Chain } from "./chain.js";
+import { OneOf } from "./utils.js";
+import { UTXOMethod } from "../transports/types.js";
+import { ErrorType } from "../errors/utils.js";
+import { BtcRpcRequestFn, RpcSchema } from "./request.js";
+
+//#region src/types/transport.d.ts
+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?: UTXOMethod[] | undefined;
+  } | {
+    exclude?: UTXOMethod[] | 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<RpcSchema>> = <chain extends Chain | undefined = Chain>({ chain, }: {
-    chain?: chain | undefined;
-    pollingInterval?: number | undefined;
-    retryCount?: TransportConfig['retryCount'] | undefined;
-    timeout?: TransportConfig['timeout'] | undefined;
+type Transport<type extends string = string, rpcAttributes = Record<string, any>, rpcRequestFn extends BtcRpcRequestFn = BtcRpcRequestFn<RpcSchema>> = <chain extends Chain | undefined = Chain>({
+  chain
+}: {
+  chain?: chain | undefined;
+  pollingInterval?: number | undefined;
+  retryCount?: TransportConfig["retryCount"] | undefined;
+  timeout?: TransportConfig["timeout"] | undefined;
 }) => {
-    config: TransportConfig<type>;
-    request: rpcRequestFn;
-    value?: rpcAttributes | undefined;
+  config: TransportConfig<type>;
+  request: rpcRequestFn;
+  value?: rpcAttributes | undefined;
 };
-export type CreateTransportErrorType = ErrorType;
+type CreateTransportErrorType = ErrorType;
+//#endregion
+export { CreateTransportErrorType, Transport, TransportConfig };
+//# sourceMappingURL=transport.d.ts.map

package/dist/cjs/types/transport.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=transport.js.map

package/dist/cjs/types/utils.d.ts

@@ -1,36 +1,61 @@
-export type Compute<type> = {
-    [key in keyof type]: type[key];
-} & unknown;
-export type ExactPartial<type> = {
-    [key in keyof type]?: type[key] | undefined;
-};
-export type IsNarrowable<type, type2> = IsUnknown<type> extends true ? false : undefined extends type ? false : IsNever<(type extends type2 ? true : false) & (type2 extends type ? false : true)> extends true ? false : true;
-export type IsNever<type> = [type] extends [never] ? true : false;
-export type IsUnknown<type> = unknown extends type ? true : false;
-export type Merge<obj1, obj2> = Compute<LooseOmit<obj1, keyof obj2 extends infer key extends string ? key : never> & obj2>;
-export type Mutable<type extends object> = {
-    -readonly [key in keyof type]: type[key];
-};
-export type StrictOmit<type, keys extends keyof type> = Pick<type, Exclude<keyof type, keys>>;
-export type OneOf<union extends object, keys extends KeyofUnion<union> = KeyofUnion<union>> = union extends infer Item ? Compute<Item & {
-    [K in Exclude<keys, keyof Item>]?: undefined;
-}> : never;
+//#region src/types/utils.d.ts
+/** Combines members of an intersection into a readable type. */
+type Compute<type> = { [key in keyof type]: type[key] } & unknown;
+/**
+* Makes all properties of an object optional.
+*
+* Compatible with [`exactOptionalPropertyTypes`](https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes).
+*/
+type ExactPartial<type> = { [key in keyof type]?: type[key] | undefined };
+/** Checks if {@link type} can be narrowed further than {@link type2} */
+type IsNarrowable<type, type2> = IsUnknown<type> extends true ? false : undefined extends type ? false : IsNever<(type extends type2 ? true : false) & (type2 extends type ? false : true)> extends true ? false : true;
+/**
+* @internal
+* Checks if {@link type} is `never`
+*/
+type IsNever<type> = [type] extends [never] ? true : false;
+/**
+* @internal
+* Checks if {@link type} is `unknown`
+*/
+type IsUnknown<type> = unknown extends type ? true : false;
+/** Merges two object types into new type  */
+type Merge<obj1, obj2> = Compute<LooseOmit<obj1, keyof obj2 extends infer key extends string ? key : never> & obj2>;
+/** Removes `readonly` from all properties of an object. */
+type Mutable<type extends object> = { -readonly [key in keyof type]: type[key] };
+/** Strict version of built-in Omit type */
+type StrictOmit<type, keys extends keyof type> = Pick<type, Exclude<keyof type, keys>>;
+/** Makes objects destructurable. */
+type OneOf<union extends object, keys extends KeyofUnion<union> = KeyofUnion<union>> = union extends infer Item ? Compute<Item & { [K in Exclude<keys, keyof Item>]?: undefined }> : never;
 type KeyofUnion<type> = type extends type ? keyof type : never;
-export type PartialBy<type, key extends keyof type> = ExactPartial<Pick<type, key>> & StrictOmit<type, key>;
-export type RemoveUndefined<type> = {
-    [key in keyof type]: NonNullable<type[key]>;
-};
-export type LooseOmit<type, keys extends string> = Pick<type, Exclude<keyof type, keys>>;
-export type UnionCompute<type> = type extends object ? Compute<type> : type;
-export type UnionLooseOmit<type, keys extends string> = type extends any ? LooseOmit<type, keys> : never;
-export type UnionStrictOmit<type, keys extends keyof type> = type extends any ? StrictOmit<type, keys> : never;
-export type UnionExactPartial<type> = type extends object ? ExactPartial<type> : type;
-export type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-export type Assign<T, U> = Assign_<T, U> & U;
-type Assign_<T, U> = {
-    [K in keyof T as K extends keyof U ? U[K] extends void ? never : K : K]: K extends keyof U ? U[K] : T[K];
-};
-export type MaybePromise<T> = T | Promise<T>;
-export {};
+/** Makes {@link key} optional in {@link type} while preserving type inference. */
+type PartialBy<type, key extends keyof type> = ExactPartial<Pick<type, key>> & StrictOmit<type, key>;
+type RemoveUndefined<type> = { [key in keyof type]: NonNullable<type[key]> };
+/** Loose version of {@link StrictOmit} */
+type LooseOmit<type, keys extends string> = Pick<type, Exclude<keyof type, keys>>;
+type UnionCompute<type> = type extends object ? Compute<type> : type;
+type UnionLooseOmit<type, keys extends string> = type extends any ? LooseOmit<type, keys> : never;
+type UnionStrictOmit<type, keys extends keyof type> = type extends any ? StrictOmit<type, keys> : never;
+type UnionExactPartial<type> = type extends object ? ExactPartial<type> : type;
+/**
+* @description Combines members of an intersection into a readable type.
+*
+* @see {@link https://twitter.com/mattpocockuk/status/1622730173446557697?s=20&t=NdpAcmEFXY01xkqU3KO0Mg}
+* @example
+* Prettify<{ a: string } & { b: string } & { c: number, d: bigint }>
+* => { a: string, b: string, c: number, d: bigint }
+*/
+type Prettify<T> = { [K in keyof T]: T[K] } & {};
+/**
+* @description Assigns the properties of U onto T.
+*
+* @example
+* Assign<{ a: string, b: number }, { a: undefined, c: boolean }>
+* => { a: undefined, b: number, c: boolean }
+*/
+type Assign<T, U> = Assign_<T, U> & U;
+type Assign_<T, U> = { [K in keyof T as K extends keyof U ? U[K] extends void ? never : K : K]: K extends keyof U ? U[K] : T[K] };
+type MaybePromise<T> = T | Promise<T>;
+//#endregion
+export { Assign, Compute, ExactPartial, IsNarrowable, IsNever, IsUnknown, LooseOmit, MaybePromise, Merge, Mutable, OneOf, PartialBy, Prettify, RemoveUndefined, StrictOmit, UnionCompute, UnionExactPartial, UnionLooseOmit, UnionStrictOmit };
+//# sourceMappingURL=utils.d.ts.map

package/dist/cjs/types/utils.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=utils.js.map

package/dist/cjs/types/xpub.d.ts

@@ -1,10 +1,15 @@
-import type { Address } from './address.js';
-export type xPubAccount = {
+import { Address } from "./address.js";
+
+//#region src/types/xpub.d.ts
+type xPubAccount = {
+  balance: bigint;
+  addresses: Array<{
+    address: Address;
     balance: bigint;
-    addresses: Array<{
-        address: Address;
-        balance: bigint;
-        path: string;
-        scriptHex: string;
-    }>;
+    path: string;
+    scriptHex: string;
+  }>;
 };
+//#endregion
+export { xPubAccount };
+//# sourceMappingURL=xpub.d.ts.map

package/dist/cjs/types/xpub.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=xpub.js.map

package/dist/cjs/utils/buildRequest.d.ts

@@ -1,5 +1,11 @@
-import type { ErrorType } from '../errors/utils.js';
-import type { BtcRpcRequestFn, BtcRpcRequestOptions, RpcSchema } from '../types/request.js';
-export type RequestErrorType = ErrorType;
-export declare function buildRequest<request extends BtcRpcRequestFn<RpcSchema>>(request: request, options?: BtcRpcRequestOptions): BtcRpcRequestFn;
-export declare function shouldRetry(error: Error): boolean;
+import { ErrorType } from "../errors/utils.js";
+import { BtcRpcRequestFn, BtcRpcRequestOptions, RpcSchema } from "../types/request.js";
+
+//#region src/utils/buildRequest.d.ts
+type RequestErrorType = ErrorType;
+declare function buildRequest<request extends BtcRpcRequestFn<RpcSchema>>(request: request, options?: BtcRpcRequestOptions): BtcRpcRequestFn;
+/** @internal */
+declare function shouldRetry(error: Error): boolean;
+//#endregion
+export { RequestErrorType, buildRequest, shouldRetry };
+//# sourceMappingURL=buildRequest.d.ts.map