@xchainjs/xchain-utxo-providers 0.1.2 → 0.2.0

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

@@ -1,150 +1,150 @@
-/**
- * Module to interact with Haskoin API
- *
- * Doc (SwaggerHub) https://app.swaggerhub.com/apis/eligecode/blockchain-api/0.0.1-oas3
- *
- */
-import { TxHash } from '@xchainjs/xchain-client';
-import { BaseAmount } from '@xchainjs/xchain-util';
-import { AddressBalance, AddressDTO, AddressParams, HaskoinNetwork, Transaction, TxConfirmedStatus, TxHashParams, TxUnspent } from './haskoin-api-types';
-/**
- * Get account from address.
- *
- * @param {string} haskoinUrl The haskoin API url.
- * @param {string} address The BCH address.
- * @returns {AddressBalance}
- *
- * @throws {"failed to query account by a given address"} thrown if failed to query account by a given address
- */
-export declare const getAccount: ({ haskoinUrl, network, address }: AddressParams) => Promise<AddressBalance>;
-/**
- * Get address information.
- *
- * @param {string} haskoinUrl The haskoin node url.
- * @param {string} network
- * @param {string} address
- * @returns {AddressDTO}
- */
-export declare const getAddress: ({ haskoinUrl, network, address }: AddressParams) => Promise<AddressDTO>;
-/**
- * Get transaction by hash.
- *
- * @param {string} haskoinUrl The haskoin API url.
- * @param {string} txId The transaction id.
- * @returns {Transaction}
- *
- * @throws {"failed to query transaction by a given hash"} thrown if failed to query transaction by a given hash
- */
-export declare const getTx: ({ haskoinUrl, txId, network }: TxHashParams) => Promise<Transaction>;
-/**
- * Get raw transaction by hash.
- *
- * @param {string} haskoinUrl The haskoin API url.
- * @param {string} txId The transaction id.
- * @returns {Transaction}
- *
- * @throws {"failed to query transaction by a given hash"} thrown if failed to query raw transaction by a given hash
- */
-export declare const getRawTransaction: ({ haskoinUrl, network, txId }: TxHashParams) => Promise<string>;
-/**
- * Get transactions
- *
- * @see https://haskoin.com/api#get-tx
- *
- * @param {string} haskoinUrl The haskoin node url.
- * @param {string} network network id
- * @param {string} hash The transaction hash.
- * @returns {Transactions}
- */
-export declare const getTxs: ({ address, haskoinUrl, network, limit, offset, }: {
-    address: string;
-    haskoinUrl: string;
-    network: HaskoinNetwork;
-    limit: number;
-    offset?: number | undefined;
-}) => Promise<Transaction[]>;
-/**
- *
- * @param param
- * @returns Returns BaseAmount
- */
-export declare const getBalance: ({ haskoinUrl, haskoinNetwork, address, confirmedOnly, assetDecimals, }: {
-    haskoinUrl: string;
-    haskoinNetwork: string;
-    address: string;
-    confirmedOnly: boolean;
-    assetDecimals: number;
-}) => Promise<BaseAmount>;
-/**
- * Get unspent transactions.
- *
- * @param {string} haskoinUrl The haskoin API url.
- * @param {string} address The BCH address.
- * @returns {TxUnspent[]}
- *
- * @throws {"failed to query unspent transactions"} thrown if failed to query unspent transactions
- */
-export declare const getUnspentTxs: ({ haskoinUrl, network, address }: AddressParams) => Promise<TxUnspent[]>;
-/**
- * Get Tx Confirmation status
- *
- * @param {string} haskoinUrl The haskoin node url.
- * @param {Network} network
- * @param {string} hash tx id
- * @returns {TxConfirmedStatus}
- */
-export declare const getIsTxConfirmed: ({ haskoinUrl, network, txId }: TxHashParams) => Promise<TxConfirmedStatus>;
-/**
- * Helper to get `confirmed` status of a tx.
- *
- * It will get it from cache or try to get it from haskoin (if not cached before)
- */
-export declare const getConfirmedTxStatus: ({ txHash, haskoinUrl, network, }: {
-    haskoinUrl: string;
-    txHash: TxHash;
-    network: HaskoinNetwork;
-}) => Promise<boolean>;
-/**
- * Get unspent txs and filter out pending UTXOs
- *
- * @see https://haskoin.com/api#get-unspent-tx
- *
- * @param {string} haskoinUrl The haskoin node url.
- * @param {Network} network
- * @param {string} address
- * @returns {AddressUTXO[]}
- */
-export declare const getConfirmedUnspentTxs: ({ haskoinUrl, network, address }: AddressParams) => Promise<TxUnspent[]>;
-/**
- * Helper to get `hex` of `Tx`
- *
- * It will try to get it from cache before requesting it from Sochain
- */
-export declare const getTxHex: ({ haskoinUrl, network, txId }: TxHashParams) => Promise<string>;
-/**
- * Get unspent transactions.
- *
- * @param {string} haskoinUrl The haskoin API url.
- * @param {string} address The BCH address.
- * @returns {TxUnspent[]}
- *
- * @throws {"failed to query unspent transactions"} thrown if failed to query unspent transactions
- */
-export declare const getUnspentTransactions: ({ haskoinUrl, network, address }: AddressParams) => Promise<TxUnspent[]>;
-/**
- * Broadcast transaction.
- *
- * @see https://app.swaggerhub.com/apis/eligecode/blockchain-api/0.0.1-oas3#/blockchain/sendTransaction
- *
- * Note: Because of an Haskoin issue (@see https://github.com/haskoin/haskoin-store/issues/25),
- * we need to broadcast same tx several times in case of `500` errors
- * @see https://github.com/xchainjs/xchainjs-lib/issues/492
- *
- * @param {BroadcastTxParams} params
- * @returns {TxHash} Transaction hash.
- */
-export declare const broadcastTx: ({ txHex, haskoinUrl, haskoinNetwork, }: {
-    txHex: string;
-    haskoinUrl: string;
-    haskoinNetwork: string;
-}) => Promise<TxHash>;
+/**
+ * Module to interact with Haskoin API
+ *
+ * Doc (SwaggerHub) https://app.swaggerhub.com/apis/eligecode/blockchain-api/0.0.1-oas3
+ *
+ */
+import { TxHash } from '@xchainjs/xchain-client';
+import { BaseAmount } from '@xchainjs/xchain-util';
+import { AddressBalance, AddressDTO, AddressParams, HaskoinNetwork, Transaction, TxConfirmedStatus, TxHashParams, TxUnspent } from './haskoin-api-types';
+/**
+ * Get account from address.
+ *
+ * @param {string} haskoinUrl The haskoin API url.
+ * @param {string} address The BCH address.
+ * @returns {AddressBalance}
+ *
+ * @throws {"failed to query account by a given address"} thrown if failed to query account by a given address
+ */
+export declare const getAccount: ({ haskoinUrl, network, address }: AddressParams) => Promise<AddressBalance>;
+/**
+ * Get address information.
+ *
+ * @param {string} haskoinUrl The haskoin node url.
+ * @param {string} network
+ * @param {string} address
+ * @returns {AddressDTO}
+ */
+export declare const getAddress: ({ haskoinUrl, network, address }: AddressParams) => Promise<AddressDTO>;
+/**
+ * Get transaction by hash.
+ *
+ * @param {string} haskoinUrl The haskoin API url.
+ * @param {string} txId The transaction id.
+ * @returns {Transaction}
+ *
+ * @throws {"failed to query transaction by a given hash"} thrown if failed to query transaction by a given hash
+ */
+export declare const getTx: ({ haskoinUrl, txId, network }: TxHashParams) => Promise<Transaction>;
+/**
+ * Get raw transaction by hash.
+ *
+ * @param {string} haskoinUrl The haskoin API url.
+ * @param {string} txId The transaction id.
+ * @returns {Transaction}
+ *
+ * @throws {"failed to query transaction by a given hash"} thrown if failed to query raw transaction by a given hash
+ */
+export declare const getRawTransaction: ({ haskoinUrl, network, txId }: TxHashParams) => Promise<string>;
+/**
+ * Get transactions
+ *
+ * @see https://haskoin.com/api#get-tx
+ *
+ * @param {string} haskoinUrl The haskoin node url.
+ * @param {string} network network id
+ * @param {string} hash The transaction hash.
+ * @returns {Transactions}
+ */
+export declare const getTxs: ({ address, haskoinUrl, network, limit, offset, }: {
+    address: string;
+    haskoinUrl: string;
+    network: HaskoinNetwork;
+    limit: number;
+    offset?: number | undefined;
+}) => Promise<Transaction[]>;
+/**
+ *
+ * @param param
+ * @returns Returns BaseAmount
+ */
+export declare const getBalance: ({ haskoinUrl, haskoinNetwork, address, confirmedOnly, assetDecimals, }: {
+    haskoinUrl: string;
+    haskoinNetwork: string;
+    address: string;
+    confirmedOnly: boolean;
+    assetDecimals: number;
+}) => Promise<BaseAmount>;
+/**
+ * Get unspent transactions.
+ *
+ * @param {string} haskoinUrl The haskoin API url.
+ * @param {string} address The BCH address.
+ * @returns {TxUnspent[]}
+ *
+ * @throws {"failed to query unspent transactions"} thrown if failed to query unspent transactions
+ */
+export declare const getUnspentTxs: ({ haskoinUrl, network, address }: AddressParams) => Promise<TxUnspent[]>;
+/**
+ * Get Tx Confirmation status
+ *
+ * @param {string} haskoinUrl The haskoin node url.
+ * @param {Network} network
+ * @param {string} hash tx id
+ * @returns {TxConfirmedStatus}
+ */
+export declare const getIsTxConfirmed: ({ haskoinUrl, network, txId }: TxHashParams) => Promise<TxConfirmedStatus>;
+/**
+ * Helper to get `confirmed` status of a tx.
+ *
+ * It will get it from cache or try to get it from haskoin (if not cached before)
+ */
+export declare const getConfirmedTxStatus: ({ txHash, haskoinUrl, network, }: {
+    haskoinUrl: string;
+    txHash: TxHash;
+    network: HaskoinNetwork;
+}) => Promise<boolean>;
+/**
+ * Get unspent txs and filter out pending UTXOs
+ *
+ * @see https://haskoin.com/api#get-unspent-tx
+ *
+ * @param {string} haskoinUrl The haskoin node url.
+ * @param {Network} network
+ * @param {string} address
+ * @returns {AddressUTXO[]}
+ */
+export declare const getConfirmedUnspentTxs: ({ haskoinUrl, network, address }: AddressParams) => Promise<TxUnspent[]>;
+/**
+ * Helper to get `hex` of `Tx`
+ *
+ * It will try to get it from cache before requesting it from Sochain
+ */
+export declare const getTxHex: ({ haskoinUrl, network, txId }: TxHashParams) => Promise<string>;
+/**
+ * Get unspent transactions.
+ *
+ * @param {string} haskoinUrl The haskoin API url.
+ * @param {string} address The BCH address.
+ * @returns {TxUnspent[]}
+ *
+ * @throws {"failed to query unspent transactions"} thrown if failed to query unspent transactions
+ */
+export declare const getUnspentTransactions: ({ haskoinUrl, network, address }: AddressParams) => Promise<TxUnspent[]>;
+/**
+ * Broadcast transaction.
+ *
+ * @see https://app.swaggerhub.com/apis/eligecode/blockchain-api/0.0.1-oas3#/blockchain/sendTransaction
+ *
+ * Note: Because of an Haskoin issue (@see https://github.com/haskoin/haskoin-store/issues/25),
+ * we need to broadcast same tx several times in case of `500` errors
+ * @see https://github.com/xchainjs/xchainjs-lib/issues/492
+ *
+ * @param {BroadcastTxParams} params
+ * @returns {TxHash} Transaction hash.
+ */
+export declare const broadcastTx: ({ txHex, haskoinUrl, haskoinNetwork, }: {
+    txHex: string;
+    haskoinUrl: string;
+    haskoinNetwork: string;
+}) => Promise<TxHash>;

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

@@ -1,37 +1,37 @@
-import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
-import { Address, Asset, Chain } from '@xchainjs/xchain-util';
-import { HaskoinNetwork } from './haskoin-api-types';
-export declare class HaskoinProvider implements UtxoOnlineDataProvider {
-    private baseUrl;
-    private chain;
-    private asset;
-    private assetDecimals;
-    private haskoinNetwork;
-    constructor(baseUrl: string | undefined, chain: Chain, asset: Asset, assetDecimals: number, haskoinNetwork: HaskoinNetwork);
-    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): Promise<TxsPage>;
-    private mapTransactionToTx;
-    /**
-     * 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>;
-    /**
-     *
-     * @param utxos
-     * @returns utxo array
-     */
-    private mapUTXOs;
-}
+import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Address, Asset, Chain } from '@xchainjs/xchain-util';
+import { HaskoinNetwork } from './haskoin-api-types';
+export declare class HaskoinProvider implements UtxoOnlineDataProvider {
+    private baseUrl;
+    private chain;
+    private asset;
+    private assetDecimals;
+    private haskoinNetwork;
+    constructor(baseUrl: string | undefined, chain: Chain, asset: Asset, assetDecimals: number, haskoinNetwork: HaskoinNetwork);
+    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): Promise<TxsPage>;
+    private mapTransactionToTx;
+    /**
+     * 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>;
+    /**
+     *
+     * @param utxos
+     * @returns utxo array
+     */
+    private mapUTXOs;
+}

package/lib/providers/index.d.ts

@@ -1,8 +1,8 @@
-export * from './sochainv3/sochain-api-types';
-export * from './sochainv3/sochain-api';
-export * from './sochainv3/sochain-data-provider';
-export { AddressDTO, AddressParams, AddressUTXO, BalanceData, GetTxsDTO, HaskoinNetwork, HaskoinResponse, Transaction, TxConfirmedStatus, TxHashParams, } from './haskoin/haskoin-api-types';
-export { getAddress, getBalance, getConfirmedTxStatus, getConfirmedUnspentTxs, getAccount, getIsTxConfirmed, getTx, getTxs, getUnspentTxs, broadcastTx, } from './haskoin/haskoin-api';
-export * from './haskoin/haskoin-data-provider';
-export * from './blockcypher/blockcypher-data-provider';
-export { BlockcypherNetwork } from './blockcypher/blockcypher-api-types';
+export * from './sochainv3/sochain-api-types';
+export * from './sochainv3/sochain-api';
+export * from './sochainv3/sochain-data-provider';
+export { AddressDTO, AddressParams, AddressUTXO, BalanceData, GetTxsDTO, HaskoinNetwork, HaskoinResponse, Transaction, TxConfirmedStatus, TxHashParams, } from './haskoin/haskoin-api-types';
+export { getAddress, getBalance, getConfirmedTxStatus, getConfirmedUnspentTxs, getAccount, getIsTxConfirmed, getTx, getTxs, getUnspentTxs, broadcastTx, } from './haskoin/haskoin-api';
+export * from './haskoin/haskoin-data-provider';
+export * from './blockcypher/blockcypher-data-provider';
+export { BlockcypherNetwork } from './blockcypher/blockcypher-api-types';

package/lib/providers/sochainv3/sochain-api-types.d.ts

@@ -1,101 +1,101 @@
-import { TxHash } from '@xchainjs/xchain-client';
-export declare enum SochainNetwork {
-    BTC = "BTC",
-    BTCTEST = "BTCTEST",
-    LTC = "LTC",
-    LTCTEST = "LTCTEST",
-    DOGE = "DOGE",
-    DOGETEST = "DOGETEST"
-}
-export declare type AddressParams = {
-    apiKey: string;
-    sochainUrl: string;
-    network: SochainNetwork;
-    address: string;
-    page: number;
-};
-export declare type BalanceParams = {
-    apiKey: string;
-    sochainUrl: string;
-    network: SochainNetwork;
-    address: string;
-    confirmedOnly: boolean;
-    assetDecimals: number;
-};
-export declare type TxHashParams = {
-    apiKey: string;
-    sochainUrl: string;
-    network: SochainNetwork;
-    hash: TxHash;
-};
-export declare type TxBroadcastParams = {
-    apiKey: string;
-    sochainUrl: string;
-    network: SochainNetwork;
-    txHex: string;
-};
-export interface SochainResponse<T> {
-    data: T;
-    status: string;
-}
-export interface TxIO {
-    index: number;
-    value: string;
-    address: string;
-    type?: string;
-    script: string;
-}
-export interface Transaction {
-    hash: string;
-    block_hash: string;
-    confirmations: number;
-    time: number;
-    tx_hex: string;
-    inputs: TxIO[];
-    outputs: TxIO[];
-}
-export declare type AddressUTXO = {
-    hash: string;
-    index: number;
-    script: string;
-    address: string;
-    tx_hex: string;
-    value: string;
-    block: number;
-};
-export declare type AddressTxDTO = {
-    hash: string;
-    block: number;
-    time: number;
-};
-export declare type AddressDTO = {
-    network: string;
-    address: string;
-    balance: string;
-    received_value: string;
-    pending_value: string;
-    total_txs: number;
-};
-export declare type GetTxsDTO = {
-    transactions: AddressTxDTO[];
-};
-export declare type GetBalanceDTO = {
-    confirmed: string;
-    unconfirmed: string;
-};
-export declare type BroadcastDTO = {
-    tx_hex: 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 SochainNetwork {
+    BTC = "BTC",
+    BTCTEST = "BTCTEST",
+    LTC = "LTC",
+    LTCTEST = "LTCTEST",
+    DOGE = "DOGE",
+    DOGETEST = "DOGETEST"
+}
+export type AddressParams = {
+    apiKey: string;
+    sochainUrl: string;
+    network: SochainNetwork;
+    address: string;
+    page: number;
+};
+export type BalanceParams = {
+    apiKey: string;
+    sochainUrl: string;
+    network: SochainNetwork;
+    address: string;
+    confirmedOnly: boolean;
+    assetDecimals: number;
+};
+export type TxHashParams = {
+    apiKey: string;
+    sochainUrl: string;
+    network: SochainNetwork;
+    hash: TxHash;
+};
+export type TxBroadcastParams = {
+    apiKey: string;
+    sochainUrl: string;
+    network: SochainNetwork;
+    txHex: string;
+};
+export interface SochainResponse<T> {
+    data: T;
+    status: string;
+}
+export interface TxIO {
+    index: number;
+    value: string;
+    address: string;
+    type?: string;
+    script: string;
+}
+export interface Transaction {
+    hash: string;
+    block_hash: string;
+    confirmations: number;
+    time: number;
+    tx_hex: string;
+    inputs: TxIO[];
+    outputs: TxIO[];
+}
+export type AddressUTXO = {
+    hash: string;
+    index: number;
+    script: string;
+    address: string;
+    tx_hex: string;
+    value: string;
+    block: number;
+};
+export type AddressTxDTO = {
+    hash: string;
+    block: number;
+    time: number;
+};
+export type AddressDTO = {
+    network: string;
+    address: string;
+    balance: string;
+    received_value: string;
+    pending_value: string;
+    total_txs: number;
+};
+export type GetTxsDTO = {
+    transactions: AddressTxDTO[];
+};
+export type GetBalanceDTO = {
+    confirmed: string;
+    unconfirmed: string;
+};
+export type BroadcastDTO = {
+    tx_hex: 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;
+};