@xchainjs/xchain-utxo-providers 0.1.2 → 0.2.0

package/lib/providers/blockcypher/blockcypher-api-types.d.ts

@@ -1,96 +1,96 @@
-import { TxHash } from '@xchainjs/xchain-client';
-export declare enum BlockcypherNetwork {
-    BTC = "btc/main",
-    BTCTEST = "btc/test3",
-    LTC = "ltc/main",
-    DOGE = "doge/main"
-}
-export declare type AddressParams = {
-    apiKey?: string;
-    baseUrl: string;
-    network: BlockcypherNetwork;
-    address: string;
-    page: number;
-};
-export declare type BalanceParams = {
-    apiKey?: string;
-    baseUrl: string;
-    network: BlockcypherNetwork;
-    address: string;
-    confirmedOnly: boolean;
-    assetDecimals: number;
-};
-export declare type TxHashParams = {
-    apiKey?: string;
-    baseUrl: string;
-    network: BlockcypherNetwork;
-    hash: TxHash;
-};
-export declare type TxBroadcastParams = {
-    apiKey?: string;
-    baseUrl: string;
-    network: BlockcypherNetwork;
-    txHex: string;
-};
-export interface TxInput {
-    output_value: string;
-    addresses: string[];
-    script_type?: string;
-}
-export interface TxOutput {
-    value: string;
-    addresses: string[];
-    script_type?: string;
-    script: string;
-}
-export interface Transaction {
-    hash: string;
-    block_hash: string;
-    confirmed: string;
-    hex: string;
-    inputs: TxInput[];
-    outputs: TxOutput[];
-}
-export declare type AddressUTXO = {
-    hash: string;
-    index: number;
-    script: string;
-    address: string;
-    tx_hex: string;
-    value: string;
-    block: number;
-};
-export declare type AddressTxDTO = {
-    tx_hash: string;
-    block_height: number;
-    confirmed: string;
-};
-export declare type GetBalanceDTO = {
-    balance: string;
-    unconfirmed_balance: string;
-    final_balance: string;
-    n_tx: number;
-    unconfirmed_n_tx: number;
-    final_n_tx: number;
-};
-export declare type GetTxsDTO = {
-    txrefs: AddressTxDTO[];
-};
-export declare type BroadcastDTO = {
-    tx: {
-        hash: string;
-    };
-};
-export declare type UnspentTxsDTO = {
-    outputs: AddressUTXO[];
-};
-export declare type BroadcastTransfer = {
-    network: string;
-    txid: string;
-};
-export declare type TxConfirmedStatus = {
-    network: string;
-    txid: string;
-    confirmations: number;
-    is_confirmed: boolean;
-};
+import { TxHash } from '@xchainjs/xchain-client';
+export declare enum BlockcypherNetwork {
+    BTC = "btc/main",
+    BTCTEST = "btc/test3",
+    LTC = "ltc/main",
+    DOGE = "doge/main"
+}
+export type AddressParams = {
+    apiKey?: string;
+    baseUrl: string;
+    network: BlockcypherNetwork;
+    address: string;
+    page: number;
+};
+export type BalanceParams = {
+    apiKey?: string;
+    baseUrl: string;
+    network: BlockcypherNetwork;
+    address: string;
+    confirmedOnly: boolean;
+    assetDecimals: number;
+};
+export type TxHashParams = {
+    apiKey?: string;
+    baseUrl: string;
+    network: BlockcypherNetwork;
+    hash: TxHash;
+};
+export type TxBroadcastParams = {
+    apiKey?: string;
+    baseUrl: string;
+    network: BlockcypherNetwork;
+    txHex: string;
+};
+export interface TxInput {
+    output_value: string;
+    addresses: string[];
+    script_type?: string;
+}
+export interface TxOutput {
+    value: string;
+    addresses: string[];
+    script_type?: string;
+    script: string;
+}
+export interface Transaction {
+    hash: string;
+    block_hash: string;
+    confirmed: string;
+    hex: string;
+    inputs: TxInput[];
+    outputs: TxOutput[];
+}
+export type AddressUTXO = {
+    hash: string;
+    index: number;
+    script: string;
+    address: string;
+    tx_hex: string;
+    value: string;
+    block: number;
+};
+export type AddressTxDTO = {
+    tx_hash: string;
+    block_height: number;
+    confirmed: string;
+};
+export type GetBalanceDTO = {
+    balance: string;
+    unconfirmed_balance: string;
+    final_balance: string;
+    n_tx: number;
+    unconfirmed_n_tx: number;
+    final_n_tx: number;
+};
+export type GetTxsDTO = {
+    txrefs: AddressTxDTO[];
+};
+export type BroadcastDTO = {
+    tx: {
+        hash: string;
+    };
+};
+export type UnspentTxsDTO = {
+    outputs: AddressUTXO[];
+};
+export type BroadcastTransfer = {
+    network: string;
+    txid: string;
+};
+export type TxConfirmedStatus = {
+    network: string;
+    txid: string;
+    confirmations: number;
+    is_confirmed: boolean;
+};

package/lib/providers/blockcypher/blockcypher-api.d.ts

@@ -1,69 +1,69 @@
-import { TxHash } from '@xchainjs/xchain-client';
-import { BaseAmount } from '@xchainjs/xchain-util';
-import { BalanceParams, BlockcypherNetwork, GetTxsDTO, Transaction, TxConfirmedStatus, TxHashParams } from './blockcypher-api-types';
-/**
- * Get transaction by hash.
- *
- *
- * @param {string} baseUrl The sochain node url.
- * @param {string} network network id
- * @param {string} hash The transaction hash.
- * @returns {Transactions}
- */
-export declare const getTx: ({ apiKey, baseUrl, network, hash }: TxHashParams) => Promise<Transaction>;
-/**
- * Get transactions
- *
- *
- * @param {string} baseUrl The sochain node url.
- * @param {string} network network id
- * @param {string} hash The transaction hash.
- * @returns {Transactions}
- */
-export declare const getTxs: ({ apiKey, address, baseUrl, network, beforeBlock, limit, unspentOnly, }: {
-    apiKey?: string | undefined;
-    address: string;
-    baseUrl: string;
-    network: BlockcypherNetwork;
-    limit: number;
-    beforeBlock?: number | undefined;
-    unspentOnly: boolean;
-}) => Promise<GetTxsDTO>;
-/**
- * Get address balance.
- *
- *
- * @param {string} baseUrl The sochain node url.
- * @param {string} network Network
- * @param {string} address Address
- * @param {boolean} confirmedOnly Flag whether to get balances of confirmed txs only or for all
- * @returns {number}
- */
-export declare const getBalance: ({ apiKey, baseUrl, network, address, confirmedOnly, assetDecimals, }: BalanceParams) => Promise<BaseAmount>;
-/**
- * Get Tx Confirmation status
- *
- *
- * @param {string} baseUrl The sochain node url.
- * @param {Network} network
- * @param {string} hash tx id
- * @returns {TxConfirmedStatus}
- */
-export declare const getIsTxConfirmed: ({ apiKey, baseUrl, network, hash, }: TxHashParams) => Promise<TxConfirmedStatus>;
-/**
- * Helper to get `confirmed` status of a tx.
- *
- * It will get it from cache or try to get it from Sochain (if not cached before)
- */
-export declare const getConfirmedTxStatus: ({ apiKey, txHash, baseUrl, network, }: {
-    apiKey?: string | undefined;
-    baseUrl: string;
-    txHash: TxHash;
-    network: BlockcypherNetwork;
-}) => Promise<boolean>;
-export declare const broadcastTx: ({ apiKey, baseUrl, network, txHex, }: {
-    apiKey?: string | undefined;
-    baseUrl: string;
-    txHex: string;
-    network: BlockcypherNetwork;
-}) => Promise<TxHash>;
+import { TxHash } from '@xchainjs/xchain-client';
+import { BaseAmount } from '@xchainjs/xchain-util';
+import { BalanceParams, BlockcypherNetwork, GetTxsDTO, Transaction, TxConfirmedStatus, TxHashParams } from './blockcypher-api-types';
+/**
+ * Get transaction by hash.
+ *
+ *
+ * @param {string} baseUrl The sochain node url.
+ * @param {string} network network id
+ * @param {string} hash The transaction hash.
+ * @returns {Transactions}
+ */
+export declare const getTx: ({ apiKey, baseUrl, network, hash }: TxHashParams) => Promise<Transaction>;
+/**
+ * Get transactions
+ *
+ *
+ * @param {string} baseUrl The sochain node url.
+ * @param {string} network network id
+ * @param {string} hash The transaction hash.
+ * @returns {Transactions}
+ */
+export declare const getTxs: ({ apiKey, address, baseUrl, network, beforeBlock, limit, unspentOnly, }: {
+    apiKey?: string | undefined;
+    address: string;
+    baseUrl: string;
+    network: BlockcypherNetwork;
+    limit: number;
+    beforeBlock?: number | undefined;
+    unspentOnly: boolean;
+}) => Promise<GetTxsDTO>;
+/**
+ * Get address balance.
+ *
+ *
+ * @param {string} baseUrl The sochain node url.
+ * @param {string} network Network
+ * @param {string} address Address
+ * @param {boolean} confirmedOnly Flag whether to get balances of confirmed txs only or for all
+ * @returns {number}
+ */
+export declare const getBalance: ({ apiKey, baseUrl, network, address, confirmedOnly, assetDecimals, }: BalanceParams) => Promise<BaseAmount>;
+/**
+ * Get Tx Confirmation status
+ *
+ *
+ * @param {string} baseUrl The sochain node url.
+ * @param {Network} network
+ * @param {string} hash tx id
+ * @returns {TxConfirmedStatus}
+ */
+export declare const getIsTxConfirmed: ({ apiKey, baseUrl, network, hash, }: TxHashParams) => Promise<TxConfirmedStatus>;
+/**
+ * Helper to get `confirmed` status of a tx.
+ *
+ * It will get it from cache or try to get it from Sochain (if not cached before)
+ */
+export declare const getConfirmedTxStatus: ({ apiKey, txHash, baseUrl, network, }: {
+    apiKey?: string | undefined;
+    baseUrl: string;
+    txHash: TxHash;
+    network: BlockcypherNetwork;
+}) => Promise<boolean>;
+export declare const broadcastTx: ({ apiKey, baseUrl, network, txHex, }: {
+    apiKey?: string | undefined;
+    baseUrl: string;
+    txHex: string;
+    network: BlockcypherNetwork;
+}) => Promise<TxHash>;

package/lib/providers/blockcypher/blockcypher-data-provider.d.ts

@@ -1,52 +1,52 @@
-import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
-import { Address, Asset, Chain } from '@xchainjs/xchain-util';
-import { BlockcypherNetwork } from './blockcypher-api-types';
-export declare class BlockcypherProvider implements UtxoOnlineDataProvider {
-    private baseUrl;
-    private _apiKey?;
-    private chain;
-    private asset;
-    private assetDecimals;
-    private blockcypherNetwork;
-    constructor(baseUrl: string | undefined, chain: Chain, asset: Asset, assetDecimals: number, blockcypherNetwork: BlockcypherNetwork, apiKey?: string);
-    get apiKey(): string | undefined;
-    set apiKey(value: string | undefined);
-    broadcastTx(txHex: string): Promise<TxHash>;
-    getConfirmedUnspentTxs(address: string): Promise<UTXO[]>;
-    getUnspentTxs(address: string): Promise<UTXO[]>;
-    getBalance(address: Address, assets?: Asset[], confirmedOnly?: boolean): Promise<Balance[]>;
-    /**
-     * Get transaction history of a given address with pagination options.
-     * By default it will return the transaction history of the current wallet.
-     *
-     * @param {TxHistoryParams} params The options to get transaction history. (optional)
-     * @returns {TxsPage} The transaction history.
-     */
-    getTransactions(params?: TxHistoryParams, unspentOnly?: boolean): Promise<TxsPage>;
-    /**
-     * Get the transaction details of a given transaction id.
-     *
-     * @param {string} txId The transaction id.
-     * @returns {Tx} The transaction details of the given transaction id.
-     */
-    getTransactionData(txId: string): Promise<Tx>;
-    private mapTransactionToTx;
-    private mapUTXOs;
-    /**
-     * helper function tto limit adding to an array
-     *
-     * @param arr array to be added to
-     * @param toAdd elements to add
-     * @param limit do not add more than this limit
-     */
-    private addArrayUpToLimit;
-    private delay;
-    /**
-     * Get transaction history of a given address with pagination options.
-     * By default it will return the transaction history of the current wallet.
-     *
-     * @param {TxHistoryParams} params The options to get transaction history. (optional)
-     * @returns {TxsPage} The transaction history.
-     */
-    private getRawTransactions;
-}
+import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Address, Asset, Chain } from '@xchainjs/xchain-util';
+import { BlockcypherNetwork } from './blockcypher-api-types';
+export declare class BlockcypherProvider implements UtxoOnlineDataProvider {
+    private baseUrl;
+    private _apiKey?;
+    private chain;
+    private asset;
+    private assetDecimals;
+    private blockcypherNetwork;
+    constructor(baseUrl: string | undefined, chain: Chain, asset: Asset, assetDecimals: number, blockcypherNetwork: BlockcypherNetwork, apiKey?: string);
+    get apiKey(): string | undefined;
+    set apiKey(value: string | undefined);
+    broadcastTx(txHex: string): Promise<TxHash>;
+    getConfirmedUnspentTxs(address: string): Promise<UTXO[]>;
+    getUnspentTxs(address: string): Promise<UTXO[]>;
+    getBalance(address: Address, assets?: Asset[], confirmedOnly?: boolean): Promise<Balance[]>;
+    /**
+     * Get transaction history of a given address with pagination options.
+     * By default it will return the transaction history of the current wallet.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history. (optional)
+     * @returns {TxsPage} The transaction history.
+     */
+    getTransactions(params?: TxHistoryParams, unspentOnly?: boolean): Promise<TxsPage>;
+    /**
+     * Get the transaction details of a given transaction id.
+     *
+     * @param {string} txId The transaction id.
+     * @returns {Tx} The transaction details of the given transaction id.
+     */
+    getTransactionData(txId: string): Promise<Tx>;
+    private mapTransactionToTx;
+    private mapUTXOs;
+    /**
+     * helper function tto limit adding to an array
+     *
+     * @param arr array to be added to
+     * @param toAdd elements to add
+     * @param limit do not add more than this limit
+     */
+    private addArrayUpToLimit;
+    private delay;
+    /**
+     * Get transaction history of a given address with pagination options.
+     * By default it will return the transaction history of the current wallet.
+     *
+     * @param {TxHistoryParams} params The options to get transaction history. (optional)
+     * @returns {TxsPage} The transaction history.
+     */
+    private getRawTransactions;
+}

package/lib/providers/haskoin/haskoin-api-types.d.ts

@@ -1,113 +1,113 @@
-/**
- * Haskoin API types
- */
-import { TxHash } from '@xchainjs/xchain-client';
-import { Address } from '@xchainjs/xchain-util';
-export declare enum HaskoinNetwork {
-    BTC = "btc",
-    BTCTEST = "btctest",
-    BCH = "bch",
-    BCHTEST = "bchtest"
-}
-export declare type AddressParams = {
-    haskoinUrl: string;
-    network: HaskoinNetwork;
-    address: string;
-};
-export declare type ErrorResponse = {
-    error: unknown;
-};
-export declare type AddressBalance = {
-    received: number;
-    utxo: number;
-    address: string;
-    txs: number;
-    unconfirmed: number;
-    confirmed: number;
-};
-export declare type BalanceData = {
-    address: Address;
-    confirmed: number;
-    unconfirmed: number;
-    utxo: number;
-    txs: number;
-    received: number;
-};
-export declare type RawTransaction = {
-    result: string;
-};
-export declare type AddressDTO = {
-    network: string;
-    address: string;
-    balance: string;
-    received_value: string;
-    pending_value: string;
-    total_txs: number;
-};
-export declare type TxHashParams = {
-    haskoinUrl: string;
-    network: HaskoinNetwork;
-    txId: TxHash;
-};
-export interface TxIO {
-    txid: number;
-    output: number;
-    script: string;
-    address: string;
-    value: number;
-    type?: string;
-}
-export declare type Transaction = {
-    txid: string;
-    block: Block;
-    confirmations: number;
-    time: number;
-    tx_hex: string;
-    inputs: TxIO[];
-    outputs: TxIO[];
-};
-export interface HaskoinResponse<T> {
-    data: T;
-    status: string;
-}
-export declare type Block = {
-    height: number;
-    position: number;
-};
-export declare type GetTxsDTO = {
-    transactions: AddressTxDTO[];
-};
-export declare type AddressTxDTO = {
-    txid: string;
-    block: Block;
-    time: number;
-};
-export declare type TxConfirmedStatus = {
-    network: string;
-    txid: string;
-    confirmations: number;
-    is_confirmed: boolean;
-};
-export declare type AddressUTXO = {
-    address: string;
-    block: Block;
-    txid: string;
-    index: number;
-    pkscript: string;
-    value: string;
-    tx_hex: string;
-};
-export declare type UnspentTxsDTO = {
-    outputs: AddressUTXO[];
-};
-export declare type TxUnspent = {
-    pkscript: string;
-    value: number;
-    address: string;
-    block: {
-        height: number;
-        position: number;
-    };
-    index: number;
-    txid: string;
-};
+/**
+ * Haskoin API types
+ */
+import { TxHash } from '@xchainjs/xchain-client';
+import { Address } from '@xchainjs/xchain-util';
+export declare enum HaskoinNetwork {
+    BTC = "btc",
+    BTCTEST = "btctest",
+    BCH = "bch",
+    BCHTEST = "bchtest"
+}
+export type AddressParams = {
+    haskoinUrl: string;
+    network: HaskoinNetwork;
+    address: string;
+};
+export type ErrorResponse = {
+    error: unknown;
+};
+export type AddressBalance = {
+    received: number;
+    utxo: number;
+    address: string;
+    txs: number;
+    unconfirmed: number;
+    confirmed: number;
+};
+export type BalanceData = {
+    address: Address;
+    confirmed: number;
+    unconfirmed: number;
+    utxo: number;
+    txs: number;
+    received: number;
+};
+export type RawTransaction = {
+    result: string;
+};
+export type AddressDTO = {
+    network: string;
+    address: string;
+    balance: string;
+    received_value: string;
+    pending_value: string;
+    total_txs: number;
+};
+export type TxHashParams = {
+    haskoinUrl: string;
+    network: HaskoinNetwork;
+    txId: TxHash;
+};
+export interface TxIO {
+    txid: number;
+    output: number;
+    script: string;
+    address: string;
+    value: number;
+    type?: string;
+}
+export type Transaction = {
+    txid: string;
+    block: Block;
+    confirmations: number;
+    time: number;
+    tx_hex: string;
+    inputs: TxIO[];
+    outputs: TxIO[];
+};
+export interface HaskoinResponse<T> {
+    data: T;
+    status: string;
+}
+export type Block = {
+    height: number;
+    position: number;
+};
+export type GetTxsDTO = {
+    transactions: AddressTxDTO[];
+};
+export type AddressTxDTO = {
+    txid: string;
+    block: Block;
+    time: number;
+};
+export type TxConfirmedStatus = {
+    network: string;
+    txid: string;
+    confirmations: number;
+    is_confirmed: boolean;
+};
+export type AddressUTXO = {
+    address: string;
+    block: Block;
+    txid: string;
+    index: number;
+    pkscript: string;
+    value: string;
+    tx_hex: string;
+};
+export type UnspentTxsDTO = {
+    outputs: AddressUTXO[];
+};
+export type TxUnspent = {
+    pkscript: string;
+    value: number;
+    address: string;
+    block: {
+        height: number;
+        position: number;
+    };
+    index: number;
+    txid: string;
+};