@bigmi/core 0.7.1 → 0.8.0

package/dist/cjs/transports/utxo.js

@@ -1,65 +1,63 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.utxo = utxo;
-const request_js_1 = require("../errors/request.js");
-const transport_js_1 = require("../errors/transport.js");
-const createTransport_js_1 = require("../factories/createTransport.js");
-const idCache_js_1 = require("../utils/idCache.js");
-const getHttpRpcClient_js_1 = require("./getHttpRpcClient.js");
-const getRpcProviderMethods_js_1 = require("./getRpcProviderMethods.js");
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_errors_request = require("../errors/request.js");
+const require_errors_transport = require("../errors/transport.js");
+const require_factories_createTransport = require("../factories/createTransport.js");
+const require_utils_idCache = require("../utils/idCache.js");
+const require_transports_getHttpRpcClient = require("./getHttpRpcClient.js");
+const require_transports_getRpcProviderMethods = require("./getRpcProviderMethods.js");
+//#region src/transports/utxo.ts
 function utxo(url, config = {}) {
-    const { fetchOptions, key = 'utxo', name = 'UTXO HTTP API', onFetchRequest, onFetchResponse, retryDelay, apiKey, methods, } = config;
-    return ({ chain, retryCount: retryCount_, timeout: timeout_ }) => {
-        const retryCount = config.retryCount ?? retryCount_;
-        const timeout = timeout_ ?? config.timeout ?? 10000;
-        let url_ = url;
-        if (config.includeChainToURL) {
-            const chainName = chain?.name.replace(' ', '-').toLowerCase();
-            url_ = `${url}${chainName ? `/${chainName}` : ''}`;
-        }
-        if (!url_) {
-            throw new transport_js_1.UrlRequiredError();
-        }
-        const client = (0, getHttpRpcClient_js_1.getHttpRpcClient)(url_, {
-            fetchOptions,
-            onRequest: onFetchRequest,
-            onResponse: onFetchResponse,
-            timeout,
-        });
-        const rpcMethods = (0, getRpcProviderMethods_js_1.getRpcProviderMethods)(key);
-        return (0, createTransport_js_1.createTransport)({
-            key,
-            name,
-            methods,
-            async request({ method, params }) {
-                const body = {
-                    jsonrpc: '2.0',
-                    id: idCache_js_1.idCache.take(),
-                    method,
-                    params,
-                };
-                const methodHandler = rpcMethods?.[method];
-                const { error, result } = await (methodHandler?.(client, { baseUrl: url_, apiKey }, params) ??
-                    client.request({
-                        body,
-                    }));
-                if (error) {
-                    throw new request_js_1.RpcRequestError({
-                        body,
-                        error,
-                        url: url_,
-                    });
-                }
-                return result;
-            },
-            retryCount,
-            retryDelay,
-            timeout,
-            type: 'http',
-        }, {
-            fetchOptions,
-            url: url_,
-        });
-    };
+	const { fetchOptions, key = "utxo", name = "UTXO HTTP API", onFetchRequest, onFetchResponse, retryDelay, apiKey, methods } = config;
+	return ({ chain, retryCount: retryCount_, timeout: timeout_ }) => {
+		const retryCount = config.retryCount ?? retryCount_;
+		const timeout = timeout_ ?? config.timeout ?? 1e4;
+		let url_ = url;
+		if (config.includeChainToURL) {
+			const chainName = chain?.name.replace(" ", "-").toLowerCase();
+			url_ = `${url}${chainName ? `/${chainName}` : ""}`;
+		}
+		if (!url_) throw new require_errors_transport.UrlRequiredError();
+		const client = require_transports_getHttpRpcClient.getHttpRpcClient(url_, {
+			fetchOptions,
+			onRequest: onFetchRequest,
+			onResponse: onFetchResponse,
+			timeout
+		});
+		const rpcMethods = require_transports_getRpcProviderMethods.getRpcProviderMethods(key);
+		return require_factories_createTransport.createTransport({
+			key,
+			name,
+			methods,
+			async request({ method, params }) {
+				const body = {
+					jsonrpc: "2.0",
+					id: require_utils_idCache.idCache.take(),
+					method,
+					params
+				};
+				const methodHandler = rpcMethods?.[method];
+				const { error, result } = await (methodHandler?.(client, {
+					baseUrl: url_,
+					apiKey
+				}, params) ?? client.request({ body }));
+				if (error) throw new require_errors_request.RpcRequestError({
+					body,
+					error,
+					url: url_
+				});
+				return result;
+			},
+			retryCount,
+			retryDelay,
+			timeout,
+			type: "http"
+		}, {
+			fetchOptions,
+			url: url_
+		});
+	};
 }
+//#endregion
+exports.utxo = utxo;
+
 //# sourceMappingURL=utxo.js.map

package/dist/cjs/transports/utxo.js.map

@@ -1 +1 @@
-{"version":3,"file":"utxo.js","sourceRoot":"","sources":["../../../src/transports/utxo.ts"],"names":[],"mappings":";;AAcA,oBA6EC;AA3FD,qDAAsD;AACtD,yDAAyD;AACzD,wEAAiE;AACjE,oDAA6C;AAC7C,+DAAwD;AACxD,yEAAkE;AASlE,SAAgB,IAAI,CAClB,GAAY,EACZ,SAAkC,EAAE;IAEpC,MAAM,EACJ,YAAY,EACZ,GAAG,GAAG,MAAM,EACZ,IAAI,GAAG,eAAe,EACtB,cAAc,EACd,eAAe,EACf,UAAU,EACV,MAAM,EACN,OAAO,GACR,GAAG,MAAM,CAAA;IAEV,OAAO,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,IAAI,WAAW,CAAA;QACnD,MAAM,OAAO,GAAG,QAAQ,IAAI,MAAM,CAAC,OAAO,IAAI,KAAM,CAAA;QACpD,IAAI,IAAI,GAAG,GAAG,CAAA;QACd,IAAI,MAAM,CAAC,iBAAiB,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,CAAA;YAC7D,IAAI,GAAG,GAAG,GAAG,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;QACpD,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,+BAAgB,EAAE,CAAA;QAC9B,CAAC;QAED,MAAM,MAAM,GAAG,IAAA,sCAAgB,EAAC,IAAI,EAAE;YACpC,YAAY;YACZ,SAAS,EAAE,cAAc;YACzB,UAAU,EAAE,eAAe;YAC3B,OAAO;SACR,CAAC,CAAA;QAEF,MAAM,UAAU,GAAG,IAAA,gDAAqB,EAAC,GAAG,CAAC,CAAA;QAE7C,OAAO,IAAA,oCAAe,EACpB;YACE,GAAG;YACH,IAAI;YACJ,OAAO;YACP,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE;gBAC9B,MAAM,IAAI,GAAG;oBACX,OAAO,EAAE,KAAc;oBACvB,EAAE,EAAE,oBAAO,CAAC,IAAI,EAAE;oBAClB,MAAM;oBACN,MAAM;iBACP,CAAA;gBACD,MAAM,aAAa,GAAG,UAAU,EAAE,CAAC,MAAoB,CAAC,CAAA;gBACxD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,aAAa,EAAE,CAC9C,MAAM,EACN,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,EACzB,MAAM,CACP;oBACC,MAAM,CAAC,OAAO,CAAC;wBACb,IAAI;qBACL,CAAC,CAAC,CAAA;gBACL,IAAI,KAAK,EAAE,CAAC;oBACV,MAAM,IAAI,4BAAe,CAAC;wBACxB,IAAI;wBACJ,KAAK;wBACL,GAAG,EAAE,IAAI;qBACV,CAAC,CAAA;gBACJ,CAAC;gBACD,OAAO,MAAM,CAAA;YACf,CAAC;YACD,UAAU;YACV,UAAU;YACV,OAAO;YACP,IAAI,EAAE,MAAM;SACb,EACD;YACE,YAAY;YACZ,GAAG,EAAE,IAAI;SACV,CACF,CAAA;IACH,CAAC,CAAA;AACH,CAAC"}
+{"version":3,"file":"utxo.js","names":["UrlRequiredError","getHttpRpcClient","getRpcProviderMethods","createTransport","idCache","RpcRequestError"],"sources":["../../../src/transports/utxo.ts"],"sourcesContent":["import { RpcRequestError } from '../errors/request.js'\nimport { UrlRequiredError } from '../errors/transport.js'\nimport { createTransport } from '../factories/createTransport.js'\nimport { idCache } from '../utils/idCache.js'\nimport { getHttpRpcClient } from './getHttpRpcClient.js'\nimport { getRpcProviderMethods } from './getRpcProviderMethods.js'\nimport type { HttpTransport, HttpTransportConfig } from './http.js'\nimport type { UTXOMethod } from './types.js'\n\ntype UTXOHttpTransportConfig = HttpTransportConfig & {\n  includeChainToURL?: boolean\n  apiKey?: string\n}\n\nexport function utxo(\n  url?: string,\n  config: UTXOHttpTransportConfig = {}\n): HttpTransport {\n  const {\n    fetchOptions,\n    key = 'utxo',\n    name = 'UTXO HTTP API',\n    onFetchRequest,\n    onFetchResponse,\n    retryDelay,\n    apiKey,\n    methods,\n  } = config\n\n  return ({ chain, retryCount: retryCount_, timeout: timeout_ }) => {\n    const retryCount = config.retryCount ?? retryCount_\n    const timeout = timeout_ ?? config.timeout ?? 10_000\n    let url_ = url\n    if (config.includeChainToURL) {\n      const chainName = chain?.name.replace(' ', '-').toLowerCase()\n      url_ = `${url}${chainName ? `/${chainName}` : ''}`\n    }\n    if (!url_) {\n      throw new UrlRequiredError()\n    }\n\n    const client = getHttpRpcClient(url_, {\n      fetchOptions,\n      onRequest: onFetchRequest,\n      onResponse: onFetchResponse,\n      timeout,\n    })\n\n    const rpcMethods = getRpcProviderMethods(key)\n\n    return createTransport(\n      {\n        key,\n        name,\n        methods,\n        async request({ method, params }) {\n          const body = {\n            jsonrpc: '2.0' as const,\n            id: idCache.take(),\n            method,\n            params,\n          }\n          const methodHandler = rpcMethods?.[method as UTXOMethod]\n          const { error, result } = await (methodHandler?.(\n            client,\n            { baseUrl: url_, apiKey },\n            params\n          ) ??\n            client.request({\n              body,\n            }))\n          if (error) {\n            throw new RpcRequestError({\n              body,\n              error,\n              url: url_,\n            })\n          }\n          return result\n        },\n        retryCount,\n        retryDelay,\n        timeout,\n        type: 'http',\n      },\n      {\n        fetchOptions,\n        url: url_,\n      }\n    )\n  }\n}\n"],"mappings":";;;;;;;;AAcA,SAAgB,KACd,KACA,SAAkC,EAAE,EACrB;CACf,MAAM,EACJ,cACA,MAAM,QACN,OAAO,iBACP,gBACA,iBACA,YACA,QACA,YACE;AAEJ,SAAQ,EAAE,OAAO,YAAY,aAAa,SAAS,eAAe;EAChE,MAAM,aAAa,OAAO,cAAc;EACxC,MAAM,UAAU,YAAY,OAAO,WAAW;EAC9C,IAAI,OAAO;AACX,MAAI,OAAO,mBAAmB;GAC5B,MAAM,YAAY,OAAO,KAAK,QAAQ,KAAK,IAAI,CAAC,aAAa;AAC7D,UAAO,GAAG,MAAM,YAAY,IAAI,cAAc;;AAEhD,MAAI,CAAC,KACH,OAAM,IAAIA,yBAAAA,kBAAkB;EAG9B,MAAM,SAASC,oCAAAA,iBAAiB,MAAM;GACpC;GACA,WAAW;GACX,YAAY;GACZ;GACD,CAAC;EAEF,MAAM,aAAaC,yCAAAA,sBAAsB,IAAI;AAE7C,SAAOC,kCAAAA,gBACL;GACE;GACA;GACA;GACA,MAAM,QAAQ,EAAE,QAAQ,UAAU;IAChC,MAAM,OAAO;KACX,SAAS;KACT,IAAIC,sBAAAA,QAAQ,MAAM;KAClB;KACA;KACD;IACD,MAAM,gBAAgB,aAAa;IACnC,MAAM,EAAE,OAAO,WAAW,OAAO,gBAC/B,QACA;KAAE,SAAS;KAAM;KAAQ,EACzB,OACD,IACC,OAAO,QAAQ,EACb,MACD,CAAC;AACJ,QAAI,MACF,OAAM,IAAIC,uBAAAA,gBAAgB;KACxB;KACA;KACA,KAAK;KACN,CAAC;AAEJ,WAAO;;GAET;GACA;GACA;GACA,MAAM;GACP,EACD;GACE;GACA,KAAK;GACN,CACF"}

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

@@ -1,7 +1,12 @@
-import type { Address, AddressPurpose, AddressType } from './address.js';
-export interface Account {
-    address: Address;
-    addressType: AddressType;
-    publicKey: string;
-    purpose: AddressPurpose;
+import { Address, AddressPurpose, AddressType } from "./address.js";
+
+//#region src/types/account.d.ts
+interface Account {
+  address: Address;
+  addressType: AddressType;
+  publicKey: string;
+  purpose: AddressPurpose;
 }
+//#endregion
+export { Account };
+//# sourceMappingURL=account.d.ts.map

package/dist/cjs/types/account.js

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

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

@@ -1,17 +1,22 @@
-import type { Network } from './chain.js';
-export type Address = string;
-export type AddressPurpose = 'payment' | 'ordinals' | 'stacks';
-export declare enum AddressType {
-    p2pkh = "p2pkh",
-    p2sh = "p2sh",
-    p2wpkh = "p2wpkh",
-    p2wsh = "p2wsh",
-    p2tr = "p2tr"
+import { Network } from "./chain.js";
+
+//#region src/types/address.d.ts
+type Address = string;
+type AddressPurpose = "payment" | "ordinals" | "stacks";
+declare enum AddressType {
+  p2pkh = "p2pkh",
+  p2sh = "p2sh",
+  p2wpkh = "p2wpkh",
+  p2wsh = "p2wsh",
+  p2tr = "p2tr"
 }
-export type AddressInfo = {
-    bech32: boolean;
-    network: Network;
-    address: Address;
-    type: AddressType;
-    purpose: AddressPurpose;
+type AddressInfo = {
+  bech32: boolean;
+  network: Network;
+  address: Address;
+  type: AddressType;
+  purpose: AddressPurpose;
 };
+//#endregion
+export { Address, AddressInfo, AddressPurpose, AddressType };
+//# sourceMappingURL=address.d.ts.map

package/dist/cjs/types/address.js

@@ -1,12 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AddressType = void 0;
-var AddressType;
-(function (AddressType) {
-    AddressType["p2pkh"] = "p2pkh";
-    AddressType["p2sh"] = "p2sh";
-    AddressType["p2wpkh"] = "p2wpkh";
-    AddressType["p2wsh"] = "p2wsh";
-    AddressType["p2tr"] = "p2tr";
-})(AddressType || (exports.AddressType = AddressType = {}));
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/types/address.ts
+let AddressType = /* @__PURE__ */ function(AddressType) {
+	AddressType["p2pkh"] = "p2pkh";
+	AddressType["p2sh"] = "p2sh";
+	AddressType["p2wpkh"] = "p2wpkh";
+	AddressType["p2wsh"] = "p2wsh";
+	AddressType["p2tr"] = "p2tr";
+	return AddressType;
+}({});
+//#endregion
+exports.AddressType = AddressType;
+
 //# sourceMappingURL=address.js.map

package/dist/cjs/types/address.js.map

@@ -1 +1 @@
-{"version":3,"file":"address.js","sourceRoot":"","sources":["../../../src/types/address.ts"],"names":[],"mappings":";;;AAMA,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,8BAAe,CAAA;IACf,4BAAa,CAAA;IACb,gCAAiB,CAAA;IACjB,8BAAe,CAAA;IACf,4BAAa,CAAA;AACf,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB"}
+{"version":3,"file":"address.js","names":[],"sources":["../../../src/types/address.ts"],"sourcesContent":["import type { Network } from './chain.js'\n\nexport type Address = string\n\nexport type AddressPurpose = 'payment' | 'ordinals' | 'stacks'\n\nexport enum AddressType {\n  p2pkh = 'p2pkh',\n  p2sh = 'p2sh',\n  p2wpkh = 'p2wpkh',\n  p2wsh = 'p2wsh',\n  p2tr = 'p2tr',\n}\n\nexport type AddressInfo = {\n  bech32: boolean\n  network: Network\n  address: Address\n  type: AddressType\n  purpose: AddressPurpose\n}\n"],"mappings":";;AAMA,IAAY,cAAL,yBAAA,aAAA;AACL,aAAA,WAAA;AACA,aAAA,UAAA;AACA,aAAA,YAAA;AACA,aAAA,WAAA;AACA,aAAA,UAAA;;KACD"}

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

@@ -1 +1,23 @@
-export type BlockTag = 'latest' | 'earliest' | 'pending' | 'safe' | 'finalized';
+//#region src/types/block.d.ts
+/**
+* Specifies a particular block in the blockchain.
+*
+* - `"latest"`: the latest proposed block
+* - `"earliest"`: the earliest/genesis block – lowest numbered block the client has available
+* - `"pending"`: pending state/transactions – next block built by the client on top
+*   of unsafe and containing the set of transactions usually taken from local mempool
+* - `"safe"`: the latest safe head block – the most recent block that is safe from
+*   re-orgs under honest majority and certain synchronicity assumptions
+* - `"finalized"`: the latest finalized block – the most recent crypto-economically secure block;
+*   cannot be re-orged outside of manual intervention driven by community coordination
+*
+* Using `pending`, while allowed, is not advised, as it may lead
+* to internally inconsistent results. Use of `latest` is safe and will not
+* lead to inconsistent results. Depending on the backing RPC networks caching system,
+* the usage of `pending` may lead to inconsistencies as a result of an
+* overly aggressive cache system. This may cause downstream errors/invalid states.
+*/
+type BlockTag = "latest" | "earliest" | "pending" | "safe" | "finalized";
+//#endregion
+export { BlockTag };
+//# sourceMappingURL=block.d.ts.map

package/dist/cjs/types/block.js

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

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

@@ -1,34 +1,38 @@
-export type BlockStats = Partial<{
-    avgfee: number;
-    avgfeerate: number;
-    avgtxsize: number;
-    blockhash: string;
-    feerate_percentiles: number[];
-    height: number;
-    ins: number;
-    maxfee: number;
-    maxfeerate: number;
-    maxtxsize: number;
-    medianfee: number;
-    mediantime: number;
-    mediantxsize: number;
-    minfee: number;
-    minfeerate: number;
-    mintxsize: number;
-    outs: number;
-    subsidy: number;
-    swtotal_size: number;
-    swtotal_weight: number;
-    swtxs: number;
-    time: number;
-    total_out: number;
-    total_size: number;
-    total_weight: number;
-    totalfee: number;
-    txs: number;
-    utxo_increase: number;
-    utxo_size_inc: number;
-    utxo_increase_actual: number;
-    utxo_size_inc_actual: number;
+//#region src/types/blockStats.d.ts
+type BlockStats = Partial<{
+  avgfee: number;
+  avgfeerate: number;
+  avgtxsize: number;
+  blockhash: string;
+  feerate_percentiles: number[];
+  height: number;
+  ins: number;
+  maxfee: number;
+  maxfeerate: number;
+  maxtxsize: number;
+  medianfee: number;
+  mediantime: number;
+  mediantxsize: number;
+  minfee: number;
+  minfeerate: number;
+  mintxsize: number;
+  outs: number;
+  subsidy: number;
+  swtotal_size: number;
+  swtotal_weight: number;
+  swtxs: number;
+  time: number;
+  total_out: number;
+  total_size: number;
+  total_weight: number;
+  totalfee: number;
+  txs: number;
+  utxo_increase: number;
+  utxo_size_inc: number;
+  utxo_increase_actual: number;
+  utxo_size_inc_actual: number;
 }>;
-export type BlockStatsKeys = keyof BlockStats;
+type BlockStatsKeys = keyof BlockStats;
+//#endregion
+export { BlockStats, BlockStatsKeys };
+//# sourceMappingURL=blockStats.d.ts.map

package/dist/cjs/types/blockStats.js

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

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

@@ -1,52 +1,55 @@
-export declare enum ChainId {
-    BITCOIN_MAINNET = "bitcoin:mainnet",
-    BITCOIN_TESTNET = "bitcoin:testnet",
-    BITCOIN_TESTNET4 = "bitcoin:testnet4",
-    BITCOIN_SIGNET = "bitcoin:signet",
-    FRACTAL_BITCOIN_MAINNET = "fractal:mainnet",
-    FRACTAL_BITCOIN_TESTNET = "fractal:testnet",
-    STACKS_MAINNET = "stacks:mainnet",
-    STACKS_TESTNET = "stacks:testnet"
+//#region src/types/chain.d.ts
+declare enum ChainId {
+  BITCOIN_MAINNET = "bitcoin:mainnet",
+  BITCOIN_TESTNET = "bitcoin:testnet",
+  BITCOIN_TESTNET4 = "bitcoin:testnet4",
+  BITCOIN_SIGNET = "bitcoin:signet",
+  FRACTAL_BITCOIN_MAINNET = "fractal:mainnet",
+  FRACTAL_BITCOIN_TESTNET = "fractal:testnet",
+  STACKS_MAINNET = "stacks:mainnet",
+  STACKS_TESTNET = "stacks:testnet"
 }
-export declare enum Network {
-    Mainnet = "mainnet",
-    Testnet = "testnet",
-    Regtest = "regtest"
+declare enum Network {
+  Mainnet = "mainnet",
+  Testnet = "testnet",
+  Regtest = "regtest"
 }
-export type Chain<formatters extends ChainFormatters | undefined = ChainFormatters | undefined, custom extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> = {
-    blockExplorers?: {
-        [key: string]: ChainBlockExplorer;
-        default: ChainBlockExplorer;
-    } | undefined;
-    id: ChainId;
-    name: string;
-    rpcUrls: {
-        [key: string]: ChainRpcUrls;
-        default: ChainRpcUrls;
-    };
-    testnet?: boolean | undefined;
+type Chain<formatters extends ChainFormatters | undefined = ChainFormatters | undefined, custom extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> = {
+  /** Collection of block explorers */blockExplorers?: {
+    [key: string]: ChainBlockExplorer;
+    default: ChainBlockExplorer;
+  } | undefined; /** ID in number form */
+  id: ChainId; /** Human-readable name */
+  name: string; /** Collection of RPC endpoints */
+  rpcUrls: {
+    [key: string]: ChainRpcUrls;
+    default: ChainRpcUrls;
+  }; /** Flag for test networks */
+  testnet?: boolean | undefined;
 } & ChainConfig<formatters, custom>;
-export type ChainConfig<formatters extends ChainFormatters | undefined = ChainFormatters | undefined, custom extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> = {
-    custom?: custom | undefined;
-    formatters?: formatters | undefined;
+type ChainConfig<formatters extends ChainFormatters | undefined = ChainFormatters | undefined, custom extends Record<string, unknown> | undefined = Record<string, unknown> | undefined> = {
+  /** Custom chain data. */custom?: custom | undefined; /** Modifies how data is formatted and typed (e.g. blocks and transactions) */
+  formatters?: formatters | undefined;
 };
-export type ChainFormatters = {
-    block?: ChainFormatter<'block'> | undefined;
-    transaction?: ChainFormatter<'transaction'> | undefined;
-    transactionReceipt?: ChainFormatter<'transactionReceipt'> | undefined;
-    transactionRequest?: ChainFormatter<'transactionRequest'> | undefined;
+type ChainFormatters = {
+  /** Modifies how the Block structure is formatted & typed. */block?: ChainFormatter<"block"> | undefined; /** Modifies how the Transaction structure is formatted & typed. */
+  transaction?: ChainFormatter<"transaction"> | undefined; /** Modifies how the TransactionReceipt structure is formatted & typed. */
+  transactionReceipt?: ChainFormatter<"transactionReceipt"> | undefined; /** Modifies how the TransactionRequest structure is formatted & typed. */
+  transactionRequest?: ChainFormatter<"transactionRequest"> | undefined;
 };
-export type ChainFormatter<type extends string = string> = {
-    format: (args: any) => any;
-    type: type;
+type ChainFormatter<type extends string = string> = {
+  format: (args: any) => any;
+  type: type;
 };
 type ChainBlockExplorer = {
-    name: string;
-    url: string;
-    apiUrl?: string | undefined;
+  name: string;
+  url: string;
+  apiUrl?: string | undefined;
 };
 type ChainRpcUrls = {
-    http: readonly string[];
-    webSocket?: readonly string[] | undefined;
+  http: readonly string[];
+  webSocket?: readonly string[] | undefined;
 };
-export {};
+//#endregion
+export { Chain, ChainConfig, ChainFormatter, ChainFormatters, ChainId, Network };
+//# sourceMappingURL=chain.d.ts.map

package/dist/cjs/types/chain.js

@@ -1,21 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Network = exports.ChainId = void 0;
-var ChainId;
-(function (ChainId) {
-    ChainId["BITCOIN_MAINNET"] = "bitcoin:mainnet";
-    ChainId["BITCOIN_TESTNET"] = "bitcoin:testnet";
-    ChainId["BITCOIN_TESTNET4"] = "bitcoin:testnet4";
-    ChainId["BITCOIN_SIGNET"] = "bitcoin:signet";
-    ChainId["FRACTAL_BITCOIN_MAINNET"] = "fractal:mainnet";
-    ChainId["FRACTAL_BITCOIN_TESTNET"] = "fractal:testnet";
-    ChainId["STACKS_MAINNET"] = "stacks:mainnet";
-    ChainId["STACKS_TESTNET"] = "stacks:testnet";
-})(ChainId || (exports.ChainId = ChainId = {}));
-var Network;
-(function (Network) {
-    Network["Mainnet"] = "mainnet";
-    Network["Testnet"] = "testnet";
-    Network["Regtest"] = "regtest";
-})(Network || (exports.Network = Network = {}));
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/types/chain.ts
+let ChainId = /* @__PURE__ */ function(ChainId) {
+	ChainId["BITCOIN_MAINNET"] = "bitcoin:mainnet";
+	ChainId["BITCOIN_TESTNET"] = "bitcoin:testnet";
+	ChainId["BITCOIN_TESTNET4"] = "bitcoin:testnet4";
+	ChainId["BITCOIN_SIGNET"] = "bitcoin:signet";
+	ChainId["FRACTAL_BITCOIN_MAINNET"] = "fractal:mainnet";
+	ChainId["FRACTAL_BITCOIN_TESTNET"] = "fractal:testnet";
+	ChainId["STACKS_MAINNET"] = "stacks:mainnet";
+	ChainId["STACKS_TESTNET"] = "stacks:testnet";
+	return ChainId;
+}({});
+let Network = /* @__PURE__ */ function(Network) {
+	Network["Mainnet"] = "mainnet";
+	Network["Testnet"] = "testnet";
+	Network["Regtest"] = "regtest";
+	return Network;
+}({});
+//#endregion
+exports.ChainId = ChainId;
+exports.Network = Network;
+
 //# sourceMappingURL=chain.js.map

package/dist/cjs/types/chain.js.map

@@ -1 +1 @@
-{"version":3,"file":"chain.js","sourceRoot":"","sources":["../../../src/types/chain.ts"],"names":[],"mappings":";;;AAAA,IAAY,OASX;AATD,WAAY,OAAO;IACjB,8CAAmC,CAAA;IACnC,8CAAmC,CAAA;IACnC,gDAAqC,CAAA;IACrC,4CAAiC,CAAA;IACjC,sDAA2C,CAAA;IAC3C,sDAA2C,CAAA;IAC3C,4CAAiC,CAAA;IACjC,4CAAiC,CAAA;AACnC,CAAC,EATW,OAAO,uBAAP,OAAO,QASlB;AAED,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;IACnB,8BAAmB,CAAA;AACrB,CAAC,EAJW,OAAO,uBAAP,OAAO,QAIlB"}
+{"version":3,"file":"chain.js","names":[],"sources":["../../../src/types/chain.ts"],"sourcesContent":["export enum ChainId {\n  BITCOIN_MAINNET = 'bitcoin:mainnet',\n  BITCOIN_TESTNET = 'bitcoin:testnet',\n  BITCOIN_TESTNET4 = 'bitcoin:testnet4',\n  BITCOIN_SIGNET = 'bitcoin:signet',\n  FRACTAL_BITCOIN_MAINNET = 'fractal:mainnet',\n  FRACTAL_BITCOIN_TESTNET = 'fractal:testnet',\n  STACKS_MAINNET = 'stacks:mainnet',\n  STACKS_TESTNET = 'stacks:testnet',\n}\n\nexport enum Network {\n  Mainnet = 'mainnet',\n  Testnet = 'testnet',\n  Regtest = 'regtest',\n}\n\nexport type Chain<\n  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,\n  custom extends Record<string, unknown> | undefined =\n    | Record<string, unknown>\n    | undefined,\n> = {\n  /** Collection of block explorers */\n  blockExplorers?:\n    | {\n        [key: string]: ChainBlockExplorer\n        default: ChainBlockExplorer\n      }\n    | undefined\n  /** ID in number form */\n  id: ChainId\n  /** Human-readable name */\n  name: string\n  /** Collection of RPC endpoints */\n  rpcUrls: {\n    [key: string]: ChainRpcUrls\n    default: ChainRpcUrls\n  }\n  /** Flag for test networks */\n  testnet?: boolean | undefined\n} & ChainConfig<formatters, custom>\n\nexport type ChainConfig<\n  formatters extends ChainFormatters | undefined = ChainFormatters | undefined,\n  custom extends Record<string, unknown> | undefined =\n    | Record<string, unknown>\n    | undefined,\n> = {\n  /** Custom chain data. */\n  custom?: custom | undefined\n  /** Modifies how data is formatted and typed (e.g. blocks and transactions) */\n  formatters?: formatters | undefined\n}\n\n/////////////////////////////////////////////////////////////////////\n// Formatters\n/////////////////////////////////////////////////////////////////////\n\nexport type ChainFormatters = {\n  /** Modifies how the Block structure is formatted & typed. */\n  block?: ChainFormatter<'block'> | undefined\n  /** Modifies how the Transaction structure is formatted & typed. */\n  transaction?: ChainFormatter<'transaction'> | undefined\n  /** Modifies how the TransactionReceipt structure is formatted & typed. */\n  transactionReceipt?: ChainFormatter<'transactionReceipt'> | undefined\n  /** Modifies how the TransactionRequest structure is formatted & typed. */\n  transactionRequest?: ChainFormatter<'transactionRequest'> | undefined\n}\n\nexport type ChainFormatter<type extends string = string> = {\n  format: (args: any) => any\n  type: type\n}\n\n/////////////////////////////////////////////////////////////////////\n// Constants\n/////////////////////////////////////////////////////////////////////\n\ntype ChainBlockExplorer = {\n  name: string\n  url: string\n  apiUrl?: string | undefined\n}\n\ntype ChainRpcUrls = {\n  http: readonly string[]\n  webSocket?: readonly string[] | undefined\n}\n"],"mappings":";;AAAA,IAAY,UAAL,yBAAA,SAAA;AACL,SAAA,qBAAA;AACA,SAAA,qBAAA;AACA,SAAA,sBAAA;AACA,SAAA,oBAAA;AACA,SAAA,6BAAA;AACA,SAAA,6BAAA;AACA,SAAA,oBAAA;AACA,SAAA,oBAAA;;KACD;AAED,IAAY,UAAL,yBAAA,SAAA;AACL,SAAA,aAAA;AACA,SAAA,aAAA;AACA,SAAA,aAAA;;KACD"}

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

@@ -1,41 +1,54 @@
-import type { ErrorType } from '../errors/utils.js';
-import type { Account } from './account.js';
-import type { Address } from './address.js';
-import type { Chain } from './chain.js';
-import type { BtcRpcRequestFn, RpcSchema } from './request.js';
-import type { BitcoinRpcMethods } from './rpc.js';
-import type { Transport } from './transport.js';
-import type { Prettify } from './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> = {
-    account?: accountOrAddress | Account | Address | undefined;
-    cacheTime?: number | undefined;
-    chain?: Chain | undefined | chain;
-    key?: string | undefined;
-    name?: string | undefined;
-    pollingInterval?: number | undefined;
-    rpcSchema?: rpcSchema | undefined;
-    transport: transport;
-    type?: string | undefined;
+import { Chain } from "./chain.js";
+import { Address } from "./address.js";
+import { BitcoinRpcMethods } from "./rpc.js";
+import { Prettify } from "./utils.js";
+import { Account } from "./account.js";
+import { ErrorType } from "../errors/utils.js";
+import { BtcRpcRequestFn, RpcSchema } from "./request.js";
+import { Transport } from "./transport.js";
+
+//#region src/types/client.d.ts
+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;
+  /**
+  * 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<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> = {
-    account: account;
-    cacheTime: number;
-    chain: chain;
-    key: string;
-    name: string;
-    pollingInterval: number;
-    request: BtcRpcRequestFn<rpcSchema extends undefined ? BitcoinRpcMethods : rpcSchema>;
-    transport: ReturnType<transport>['config'] & ReturnType<transport>['value'];
-    type: string;
-    uid: string;
+  /** 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;
+type Extended = Prettify<{ [_ in keyof Client_Base]?: undefined } & {
+  [key: string]: unknown;
 }>;
-export type CreateClientErrorType = ErrorType;
-export {};
+type CreateClientErrorType = ErrorType;
+//#endregion
+export { Client, ClientConfig, CreateClientErrorType };
+//# sourceMappingURL=client.d.ts.map

package/dist/cjs/types/client.js

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

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

@@ -1 +1,5 @@
-export type Hash = `0x${string}`;
+//#region src/types/hash.d.ts
+type Hash = `0x${string}`;
+//#endregion
+export { Hash };
+//# sourceMappingURL=hash.d.ts.map