@did-btcr2/method 0.13.1

package/dist/types/bitcoin/interface.d.ts

@@ -0,0 +1,86 @@
+import { AddMultiSigAddressParams, BatchOption, BlockResponse, BumpFeeOption, BumpFeeResult, ChainInfo, CreateMultiSigResult, CreateRawTxInputs, CreateRawTxOutputs, CreateWalletParams, CreateWalletResult, DecodedRawTransaction, FeeEstimateMode, FundRawTxOptions, GetBlockParams, MempoolInfo, MiningInfo, PeerInfo, RawTransactionResponse, ScriptDecoded, ValidateAddressResult } from '../types/bitcoin.js';
+/**
+ * Interface for the Bitcoin Core RPC client.
+ */
+export interface IBitcoinRpc {
+    /** Executes multiple commands in a batch request. */
+    command?<R extends ReturnType<any>>(methods: BatchOption[]): Promise<ReadonlyArray<R>>;
+    /** Marks a transaction and its in-wallet descendants as abandoned, allowing their inputs to be respent. */
+    abandonTransaction(txid: string): Promise<void>;
+    /** Stops the current wallet rescan triggered by an RPC call, such as by an importprivkey call. */
+    abortRescan(): Promise<void>;
+    /** Adds a multi-signature address with n required signatures and a set of keys. */
+    addMultiSigAddress({ nrequired, keys, account }: AddMultiSigAddressParams): Promise<string>;
+    /** Adds a witness address for SegWit compatibility. */
+    addWitnessAddress(address: string): Promise<void>;
+    /** Backs up the wallet file to a specified destination. */
+    backupWallet(destination: string): Promise<void>;
+    /** Increases the fee of an unconfirmed transaction to improve its confirmation time. */
+    bumpFee(txid: string, options?: BumpFeeOption): Promise<BumpFeeResult>;
+    /** Removes all banned nodes from the ban list. */
+    clearBanned(): Promise<void>;
+    /** Combines multiple raw transactions into a single transaction. */
+    combineRawTransaction(txs: string[]): Promise<string>;
+    /** Creates a multi-signature address with n required signatures and a set of keys. */
+    createMultiSig(nrequired: number, keys: string[]): Promise<CreateMultiSigResult>;
+    /** Creates a raw transaction spending specified inputs to specified outputs. */
+    createRawTransaction(inputs: CreateRawTxInputs[], outputs: CreateRawTxOutputs[], locktime?: number, replacable?: boolean): Promise<string>;
+    /** Creates a new wallet with various optional parameters. */
+    createWallet({ wallet_name, disable_private_keys, blank, passphrase, avoid_reuse, descriptors, load_on_startup, }: CreateWalletParams): Promise<CreateWalletResult>;
+    /** Decodes a raw transaction hex string. */
+    decodeRawTransaction(hexstring: string): Promise<DecodedRawTransaction>;
+    /** Decodes a hex-encoded script. */
+    decodeScript(hexstring: string): Promise<ScriptDecoded>;
+    /** Disconnects a node by address or node ID. */
+    disconnectNode(address?: string, nodeid?: number): Promise<void>;
+    /** Reveals the private key corresponding to an address. */
+    dumpPrivKey(address: string): Promise<string>;
+    /** Dumps all wallet keys and metadata to a file. */
+    dumpWallet(filename: string): Promise<{
+        filename: string;
+    }>;
+    /** Encrypts the wallet with a passphrase. */
+    encryptWallet(passphrase: string): Promise<void>;
+    /** Estimates the fee rate for a given confirmation target. */
+    estimateSmartFee(conf_target: number, estimate_mode?: FeeEstimateMode): Promise<{
+        feerate?: number;
+        errors?: string[];
+        blocks?: number;
+    }>;
+    /** Funds a raw transaction by adding necessary inputs and change. */
+    fundRawTransaction(hexstring: string, options: FundRawTxOptions): Promise<{
+        hex: string;
+        fee: number;
+        changepos: number;
+    }>;
+    /** Returns the number of blocks in the longest blockchain. */
+    getBlockCount(): Promise<number>;
+    /** Gets the hash of a block at a given height. */
+    getBlockHash(height: number): Promise<string>;
+    /** Gets detailed information about a specific block. */
+    getBlock({ blockhash, height, verbosity }: GetBlockParams): Promise<BlockResponse | undefined>;
+    /** Retrieves general blockchain state info. */
+    getBlockchainInfo(): Promise<ChainInfo>;
+    /** Gets the number of active connections to other nodes. */
+    getConnectionCount(): Promise<number>;
+    /** Gets the estimated network difficulty. */
+    getDifficulty(): Promise<number>;
+    /** Retrieves memory pool statistics. */
+    getMempoolInfo(): Promise<MempoolInfo>;
+    /** Retrieves mining statistics. */
+    getMiningInfo(): Promise<MiningInfo>;
+    /** Gets a new Bitcoin address for receiving payments. */
+    getNewAddress(account?: string): Promise<string>;
+    /** Gets detailed peer connection information. */
+    getPeerInfo(): Promise<PeerInfo[]>;
+    /** Sends raw transaction hex to the Bitcoin network. */
+    sendRawTransaction(hexstring: string, maxfeerate?: number | string, maxBurnAmount?: number | string): Promise<string>;
+    /** Sends bitcoins to a specified address. */
+    sendToAddress(address: string, amount: number, comment?: string, comment_to?: string, subtreactfeefromamount?: boolean, replaceable?: boolean, conf_target?: number, estimate_mode?: FeeEstimateMode): Promise<RawTransactionResponse>;
+    /** Validates a Bitcoin address. */
+    validateAddress(address: string): Promise<ValidateAddressResult>;
+    /** Verifies a signed message. */
+    verifyMessage(address: string, signature: string, message: string): Promise<boolean>;
+    /** Locks the wallet, requiring a passphrase to unlock. */
+    walletLock(passphrase: string, timeout: number): Promise<void>;
+}

package/dist/types/bitcoin/interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.d.ts","sourceRoot":"","sources":["../../../src/bitcoin/interface.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,wBAAwB,EACxB,WAAW,EACX,aAAa,EACb,aAAa,EACb,aAAa,EACb,SAAS,EACT,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,UAAU,EACV,QAAQ,EACR,sBAAsB,EACtB,aAAa,EACb,qBAAqB,EACtB,MAAM,qBAAqB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,qDAAqD;IACrD,OAAO,CAAC,CAAC,CAAC,SAAS,UAAU,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAEvF,2GAA2G;IAC3G,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD,kGAAkG;IAClG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B,mFAAmF;IACnF,kBAAkB,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,wBAAwB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5F,uDAAuD;IACvD,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,2DAA2D;IAC3D,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,wFAAwF;IACxF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEvE,kDAAkD;IAClD,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B,oEAAoE;IACpE,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtD,sFAAsF;IACtF,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAEjF,gFAAgF;IAChF,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,EAAE,EAAE,OAAO,EAAE,kBAAkB,EAAE,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3I,6DAA6D;IAC7D,YAAY,CAAC,EACX,WAAW,EACX,oBAAoB,EACpB,KAAK,EACL,UAAU,EACV,WAAW,EACX,WAAW,EACX,eAAe,GAChB,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEpD,4CAA4C;IAC5C,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAExE,oCAAoC;IACpC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAExD,gDAAgD;IAChD,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE,2DAA2D;IAC3D,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9C,oDAAoD;IACpD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D,6CAA6C;IAC7C,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjD,8DAA8D;IAC9D,gBAAgB,CACZ,WAAW,EAAE,MAAM,EACnB,aAAa,CAAC,EAAE,eAAe,GAChC,OAAO,CAAC;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAErE,qEAAqE;IACrE,kBAAkB,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,gBAAgB,GAC1B,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAE5D,8DAA8D;IAC9D,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjC,kDAAkD;IAClD,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE9C,wDAAwD;IACxD,QAAQ,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,CAAA;IAE9F,+CAA+C;IAC/C,iBAAiB,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC;IAExC,4DAA4D;IAC5D,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtC,6CAA6C;IAC7C,aAAa,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjC,wCAAwC;IACxC,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAEvC,mCAAmC;IACnC,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IAErC,yDAAyD;IACzD,aAAa,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjD,iDAAiD;IACjD,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IAEnC,wDAAwD;IACxD,kBAAkB,CAChB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAC9B,OAAO,CAAC,MAAM,CAAC,CAAC;IAEnB,6CAA6C;IAC7C,aAAa,CACT,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,EACnB,sBAAsB,CAAC,EAAE,OAAO,EAChC,WAAW,CAAC,EAAE,OAAO,EACrB,WAAW,CAAC,EAAE,MAAM,EACpB,aAAa,CAAC,EAAE,eAAe,GAChC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAEnC,mCAAmC;IACnC,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEjE,iCAAiC;IACjC,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAErF,0DAA0D;IAC1D,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE"}

package/dist/types/bitcoin/network.d.ts

@@ -0,0 +1,2 @@
+import { networks } from 'bitcoinjs-lib';
+export declare function getNetwork(network: string): networks.Network;

package/dist/types/bitcoin/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../../src/bitcoin/network.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAC,OAAO,CAc5D"}

package/dist/types/bitcoin/rest-client.d.ts

@@ -0,0 +1,268 @@
+import { Bytes, UnixTimestamp } from '@did-btcr2/common';
+import { BlockResponse, GetBlockParams, TxInPrevout } from '../types/bitcoin.js';
+export type TransactionStatus = {
+    confirmed: boolean;
+    block_height: number;
+    block_hash: string;
+    block_time: UnixTimestamp;
+};
+export interface Vin {
+    txid: string;
+    vout: number;
+    prevout?: TxInPrevout;
+    scriptsig: string;
+    scriptsig_asm: string;
+    witness: string[];
+    is_coinbase: boolean;
+    sequence: number;
+}
+export interface Vout {
+    scriptpubkey: string;
+    scriptpubkey_asm: string;
+    scriptpubkey_type: string;
+    scriptpubkey_address?: string;
+    value: number;
+}
+export interface ChainStats {
+    funded_txo_count: number;
+    funded_txo_sum: number;
+    spent_txo_count: number;
+    spent_txo_sum: number;
+    tx_count: number;
+}
+export interface MempoolStats {
+    funded_txo_count: number;
+    funded_txo_sum: number;
+    spent_txo_count: number;
+    spent_txo_sum: number;
+    tx_count: number;
+}
+export interface AddressInfo {
+    address: string;
+    chain_stats: ChainStats;
+    mempool_stats: MempoolStats;
+}
+export interface RawTransactionRest {
+    txid: string;
+    version: number;
+    locktime: number;
+    vin: Array<Vin>;
+    vout: Array<Vout>;
+    size: number;
+    weight: number;
+    fee: number;
+    status: TransactionStatus;
+}
+export interface AddressUtxo {
+    txid: string;
+    vout: number;
+    status: TransactionStatus;
+    value: number;
+}
+export interface RestClientConfigParams {
+    host: string;
+    headers?: {
+        [key: string]: string;
+    };
+}
+export declare class RestClientConfig {
+    host: string;
+    headers?: {
+        [key: string]: string;
+    };
+    constructor({ host, headers }: RestClientConfigParams);
+}
+export interface RestApiCallParams {
+    path: string;
+    url?: string;
+    method?: string;
+    body?: any;
+    headers?: any;
+}
+export interface RestResponse extends Response {
+    [key: string]: any;
+}
+/**
+ * Implements a strongly-typed BitcoinRest to connect to remote bitcoin node via REST API.
+ * @class BitcoinRest
+ * @type {BitcoinRest}
+ */
+export default class BitcoinRest {
+    /**
+     * The encapsulated {@link RestClientConfig} object.
+     * @private
+     * @type {RestClientConfig}
+     */
+    private _config;
+    /**
+     * The api calls related to bitcoin transactions.
+     * @type {BitcoinTransaction}
+     */
+    transaction: BitcoinTransaction;
+    /**
+     * The api calls related to bitcoin blocks.
+     * @type {BitcoinBlock}
+     */
+    block: BitcoinBlock;
+    /**
+     * The api calls related to bitcoin addresses.
+     * @type {BitcoinAddress}
+     */
+    address: BitcoinAddress;
+    /**
+     * The API call method that can be used to make requests to the REST API.
+     * @returns {Promise<any>} A promise resolving to the response data.
+     */
+    api: (params: RestApiCallParams) => Promise<any>;
+    constructor(config: RestClientConfig);
+    /**
+     * Get the configuration object.
+     * @private
+     */
+    get config(): RestClientConfig;
+    /**
+     * Static method connects to a bitcoin node running a esplora REST API.
+     *
+     * @param {RestClientConfig} config The configuration object for the client (optional).
+     * @returns A new {@link BitcoinRest} instance.
+     * @example
+     * ```
+     * const rest = BitcoinRest.connect();
+     * ```
+     */
+    static connect(config?: RestClientConfig): BitcoinRest;
+    /**
+     * Make a REST API call to the configured Bitcoin node.
+     * @private
+     * @param {RestApiCallParams} params The parameters for the API call. See {@link RestApiCallParams} for details.
+     * @param {string} [params.path] The path to the API endpoint (required).
+     * @param {string} [params.url] The full URL to the API endpoint (optional).
+     * @param {string} [params.method] The HTTP method to use (default is 'GET').
+     * @param {any} [params.body] The body of the request (optional).
+     * @param {any} [params.headers] Additional headers to include in the request (optional).
+     * @returns {Promise<any>} A promise resolving to the response data.
+     */
+    private call;
+}
+export declare class BitcoinTransaction {
+    private api;
+    constructor(api: (params: RestApiCallParams) => Promise<any>);
+    /**
+     * Returns the transaction in JSON format.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxid | Esplora GET /tx/:txid } for details.
+     * @param {string} txid The transaction id (required).
+     * @returns {GetRawTransaction} A promise resolving to data about a transaction in the form specified by verbosity.
+     */
+    get(txid: string): Promise<RawTransactionRest>;
+    /**
+     * Returns the transaction in JSON format.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxid | Esplora GET /tx/:txid } for details.
+     * @param {string} txid The transaction id (required).
+     * @returns {GetRawTransaction} A promise resolving to data about a transaction in the form specified by verbosity.
+     */
+    isConfirmed(txid: string): Promise<boolean>;
+    /**
+     * Returns the raw transaction in hex or as binary data.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidhex | Esplora GET /tx/:txid/hex } and
+     * {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidraw | Esplora GET /tx/:txid/raw } for details.
+     * @param {string} txid The transaction id (required).
+     * @returns {Promise<RawTransactionRest | string>} A promise resolving to the raw transaction in the specified format.
+     */
+    getHex(txid: string): Promise<string>;
+    /**
+     * Returns the raw transaction in hex or as binary data.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidhex | Esplora GET /tx/:txid/hex } and
+     * {@link https://github.com/blockstream/esplora/blob/master/API.md#get-txtxidraw | Esplora GET /tx/:txid/raw } for details.
+     * @param {string} txid The transaction id (required).
+     * @returns {Promise<RawTransactionRest | string>} A promise resolving to the raw transaction in the specified format.
+     */
+    getRaw(txid: string): Promise<Bytes>;
+    /**
+     * Broadcast a raw transaction to the network. The transaction should be provided as hex in the request body. The txid
+     * will be returned on success.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#post-tx | Esplora POST /tx } for details.
+     * @param {string} tx The raw transaction in hex format (required).
+     * @returns {Promise<string>} The transaction id of the broadcasted transaction.
+     */
+    send(tx: string): Promise<string>;
+}
+/**
+ * Implements a strongly-typed BitcoinRest to connect to remote bitcoin node via REST API for block-related operations.
+ * @class BitcoinBlock
+ * @type {BitcoinBlock}
+ */
+export declare class BitcoinBlock {
+    private api;
+    constructor(api: (params: RestApiCallParams) => Promise<any>);
+    /**
+     * Returns the blockheight of the most-work fully-validated chain. The genesis block has height 0.
+     * @returns {Blockheight} The number of the blockheight with the most-work of the fully-validated chain.
+     */
+    count(): Promise<number>;
+    /**
+     * Returns the block data associated with a `blockhash` of a valid block.
+     * @param {GetBlockParams} params See {@link GetBlockParams} for details.
+     * @param {?string} params.blockhash The blockhash of the block to query.
+     * @param {?number} params.height The block height of the block to query.
+     * @returns {BlockResponse} A promise resolving to a {@link BlockResponse} formatted depending on `verbosity` level.
+     * @throws {BitcoinRpcError} If neither `blockhash` nor `height` is provided.
+     */
+    get({ blockhash, height }: GetBlockParams): Promise<BlockResponse | undefined>;
+    /**
+     * Get the block hash for a given block height.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-block-heightheight | Esplora GET /block-height/:height } for details.
+     * @param {number} height The block height (required).
+     * @returns {Promise<string>} The hash of the block currently at height..
+     */
+    getHash(height: number): Promise<string>;
+}
+export declare class BitcoinAddress {
+    private api;
+    constructor(api: (params: RestApiCallParams) => Promise<any>);
+    /**
+     * Get transaction history for the specified address/scripthash, sorted with newest first.
+     * Returns up to 50 mempool transactions plus the first 25 confirmed transactions.
+     * See {@link https://github.com/blockstream/esplora/blob/master/API.md#get-addressaddresstxs | Esplora GET /address/:address/txs } for details.
+     * @param {string} addressOrScripthash The address or scripthash to check.
+     * @returns {Promise<Array<RawTransactionRest>>} A promise resolving to an array of {@link RawTransactionRest} objects.
+     */
+    getTxs(addressOrScripthash: string): Promise<Array<RawTransactionRest>>;
+    /**
+     * Calls getAddressTxs and checks if any funds come back.
+     * Toggle if those funds are confirmed.
+     * @param {string} addressOrScripthash The address or scripthash to check.
+     * @returns {Promise<boolean>} True if the address has any funds, false otherwise.
+     */
+    isFundedAddress(addressOrScripthash: string): Promise<boolean>;
+    /**
+     * Get unconfirmed transaction history for the specified address/scripthash.
+     * Returns up to 50 transactions (no paging).
+     * @param {string} addressOrScripthash The address or scripthash to check.
+     * @returns {Promise<Array<RawTransactionRest>>} A promise resolving to an array of {@link RawTransactionRest} objects.
+     */
+    getTxsMempool(addressOrScripthash: string): Promise<Array<RawTransactionRest>>;
+    /**
+     * Get information about an address/scripthash.
+     * Available fields: address/scripthash, chain_stats and mempool_stats.
+     * {chain,mempool}_stats each contain an object with tx_count, funded_txo_count, funded_txo_sum, spent_txo_count and spent_txo_sum.
+     * Elements-based chains don't have the {funded,spent}_txo_sum fields.
+     * @param {string} addressOrScripthash The address or scripthash to check.
+     * @returns {Promise<AddressInfo>} A promise resolving to an {@link AddressInfo} object.
+     */
+    getInfo(addressOrScripthash: string): Promise<AddressInfo>;
+    /**
+     * Get confirmed transaction history for the specified address/scripthash, sorted with newest first.
+     * Returns 25 transactions per page. More can be requested by specifying the last txid seen by the previous query.
+     * @param {string} addressOrScripthash The address or scripthash to check.
+     * @param lastSeenTxId The last transaction id seen by the previous query (optional).
+     * @returns {Promise<Array<RawTransactionRest>>} A promise resolving to an array of {@link RawTransactionRest} objects.
+     */
+    getConfirmedTxs(addressOrScripthash: string, lastSeenTxId?: string): Promise<Array<RawTransactionRest>>;
+    /**
+     * Get the list of unspent transaction outputs associated with the address/scripthash.
+     * See {@link https://github.com/Blockstream/esplora/blob/master/API.md#get-addressaddressutxo | Esplora GET /address/:address/utxo } for details.
+     * @param {string} addressOrScripthash The address or scripthash to check.
+     * @returns {Promise<Array<RawTransactionRest>>} A promise resolving to an array of {@link RawTransactionRest} objects.
+     */
+    getUtxos(addressOrScripthash: string): Promise<Array<AddressUtxo>>;
+}

package/dist/types/bitcoin/rest-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rest-client.d.ts","sourceRoot":"","sources":["../../../src/bitcoin/rest-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,aAAa,EAEb,cAAc,EACd,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAI7B,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,EAAE,OAAO,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,aAAa,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,IAAI;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,KAAK,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,UAAU;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,UAAU,CAAC;IACxB,aAAa,EAAE,YAAY,CAAC;CAC7B;AACD,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IAChB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,iBAAiB,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AACD,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CACrC;AAED,qBAAa,gBAAgB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;gBACxB,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,sBAAsB;CAItD;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,GAAG,CAAC;CACf;AAED,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC9B;;;;OAIG;IACH,OAAO,CAAC,OAAO,CAAmB;IAElC;;;OAGG;IACI,WAAW,EAAE,kBAAkB,CAAC;IAEvC;;;OAGG;IACI,KAAK,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACI,OAAO,EAAE,cAAc,CAAC;IAE/B;;;OAGG;IACI,GAAG,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,OAAO,CAAC,GAAG,CAAC,CAAa;gBAExD,MAAM,EAAE,gBAAgB;IAQpC;;;OAGG;IACH,IAAI,MAAM,IAAI,gBAAgB,CAG7B;IAED;;;;;;;;;OASG;WACW,OAAO,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,WAAW;IAI7D;;;;;;;;;;OAUG;YACW,IAAI;CAyCnB;AAED,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,GAAG,CAA8C;gBAE7C,GAAG,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,OAAO,CAAC,GAAG,CAAC;IAI5D;;;;;OAKG;IACU,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI3D;;;;;OAKG;IACU,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKxD;;;;;;OAMG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIlD;;;;;;OAMG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIjD;;;;;;OAMG;IACU,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAG/C;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,GAAG,CAA8C;gBAE7C,GAAG,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,OAAO,CAAC,GAAG,CAAC;IAI5D;;;OAGG;IACU,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAIrC;;;;;;;OAOG;IACU,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAgB3F;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAGtD;AAED,qBAAa,cAAc;IACzB,OAAO,CAAC,GAAG,CAA8C;gBAE7C,GAAG,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,OAAO,CAAC,GAAG,CAAC;IAI5D;;;;;;OAMG;IACU,MAAM,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAIpF;;;;;OAKG;IACU,eAAe,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAM3E;;;;;OAKG;IACU,aAAa,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAI3F;;;;;;;OAOG;IACU,OAAO,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAIvE;;;;;;OAMG;IACU,eAAe,CAAC,mBAAmB,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAQpH;;;;;OAKG;IACU,QAAQ,CAAC,mBAAmB,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;CAGhF"}