@xchainjs/xchain-utxo-providers 0.1.2 → 0.2.0

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

@@ -1,113 +1,113 @@
-import { TxHash } from '@xchainjs/xchain-client';
-import { BaseAmount } from '@xchainjs/xchain-util';
-import { AddressDTO, AddressParams, AddressUTXO, BalanceParams, GetTxsDTO, SochainNetwork, Transaction, TxConfirmedStatus, TxHashParams } from './sochain-api-types';
-/**
- * Get address information.
- *
- * @param {string} sochainUrl The sochain node url.
- * @param {string} network
- * @param {string} address
- * @returns {AddressDTO}
- */
-export declare const getAddress: ({ apiKey, sochainUrl, network, address }: AddressParams) => Promise<AddressDTO>;
-/**
- * Get transaction by hash.
- *
- * @see https://sochain.com/api#get-tx
- *
- * @param {string} sochainUrl The sochain node url.
- * @param {string} network network id
- * @param {string} hash The transaction hash.
- * @returns {Transactions}
- */
-export declare const getTx: ({ apiKey, sochainUrl, network, hash }: TxHashParams) => Promise<Transaction>;
-/**
- * Get transactions
- *
- * @see https://sochain.com/api#get-tx
- *
- * @param {string} sochainUrl The sochain node url.
- * @param {string} network network id
- * @param {string} hash The transaction hash.
- * @returns {Transactions}
- */
-export declare const getTxs: ({ apiKey, address, sochainUrl, network, page, }: {
-    apiKey: string;
-    address: string;
-    sochainUrl: string;
-    network: SochainNetwork;
-    page: number;
-}) => Promise<GetTxsDTO>;
-/**
- * Get address balance.
- *
- * @see https://sochain.com/api#get-balance
- *
- * @param {string} sochainUrl 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, sochainUrl, network, address, confirmedOnly, assetDecimals, }: BalanceParams) => Promise<BaseAmount>;
-/**
- * Get unspent txs
- *
- * @see https://sochain.com/api#get-unspent-tx
- *
- * @param {string} sochainUrl The sochain node url.
- * @param {string} network
- * @param {string} address
- * @returns {AddressUTXO[]}
- */
-export declare const getUnspentTxs: ({ apiKey, sochainUrl, network, address, page, }: AddressParams) => Promise<AddressUTXO[]>;
-/**
- * Get Tx Confirmation status
- *
- * @see https://sochain.com/api#get-is-tx-confirmed
- *
- * @param {string} sochainUrl The sochain node url.
- * @param {Network} network
- * @param {string} hash tx id
- * @returns {TxConfirmedStatus}
- */
-export declare const getIsTxConfirmed: ({ apiKey, sochainUrl, 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, sochainUrl, network, }: {
-    apiKey: string;
-    sochainUrl: string;
-    txHash: TxHash;
-    network: SochainNetwork;
-}) => Promise<boolean>;
-/**
- * Get unspent txs and filter out pending UTXOs
- *
- * @see https://sochain.com/api#get-unspent-tx
- *
- * @param {string} sochainUrl The sochain node url.
- * @param {Network} network
- * @param {string} address
- * @returns {AddressUTXO[]}
- */
-export declare const getConfirmedUnspentTxs: ({ apiKey, sochainUrl, network, address, }: AddressParams) => Promise<AddressUTXO[]>;
-/**
- * Get address balance.
- *
- * @see https://sochain.com/api#get-balance
- *
- * @param {string} sochainUrl 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 broadcastTx: ({ apiKey, sochainUrl, network, txHex, }: {
-    apiKey: string;
-    sochainUrl: string;
-    txHex: string;
-    network: SochainNetwork;
-}) => Promise<TxHash>;
+import { TxHash } from '@xchainjs/xchain-client';
+import { BaseAmount } from '@xchainjs/xchain-util';
+import { AddressDTO, AddressParams, AddressUTXO, BalanceParams, GetTxsDTO, SochainNetwork, Transaction, TxConfirmedStatus, TxHashParams } from './sochain-api-types';
+/**
+ * Get address information.
+ *
+ * @param {string} sochainUrl The sochain node url.
+ * @param {string} network
+ * @param {string} address
+ * @returns {AddressDTO}
+ */
+export declare const getAddress: ({ apiKey, sochainUrl, network, address }: AddressParams) => Promise<AddressDTO>;
+/**
+ * Get transaction by hash.
+ *
+ * @see https://sochain.com/api#get-tx
+ *
+ * @param {string} sochainUrl The sochain node url.
+ * @param {string} network network id
+ * @param {string} hash The transaction hash.
+ * @returns {Transactions}
+ */
+export declare const getTx: ({ apiKey, sochainUrl, network, hash }: TxHashParams) => Promise<Transaction>;
+/**
+ * Get transactions
+ *
+ * @see https://sochain.com/api#get-tx
+ *
+ * @param {string} sochainUrl The sochain node url.
+ * @param {string} network network id
+ * @param {string} hash The transaction hash.
+ * @returns {Transactions}
+ */
+export declare const getTxs: ({ apiKey, address, sochainUrl, network, page, }: {
+    apiKey: string;
+    address: string;
+    sochainUrl: string;
+    network: SochainNetwork;
+    page: number;
+}) => Promise<GetTxsDTO>;
+/**
+ * Get address balance.
+ *
+ * @see https://sochain.com/api#get-balance
+ *
+ * @param {string} sochainUrl 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, sochainUrl, network, address, confirmedOnly, assetDecimals, }: BalanceParams) => Promise<BaseAmount>;
+/**
+ * Get unspent txs
+ *
+ * @see https://sochain.com/api#get-unspent-tx
+ *
+ * @param {string} sochainUrl The sochain node url.
+ * @param {string} network
+ * @param {string} address
+ * @returns {AddressUTXO[]}
+ */
+export declare const getUnspentTxs: ({ apiKey, sochainUrl, network, address, page, }: AddressParams) => Promise<AddressUTXO[]>;
+/**
+ * Get Tx Confirmation status
+ *
+ * @see https://sochain.com/api#get-is-tx-confirmed
+ *
+ * @param {string} sochainUrl The sochain node url.
+ * @param {Network} network
+ * @param {string} hash tx id
+ * @returns {TxConfirmedStatus}
+ */
+export declare const getIsTxConfirmed: ({ apiKey, sochainUrl, 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, sochainUrl, network, }: {
+    apiKey: string;
+    sochainUrl: string;
+    txHash: TxHash;
+    network: SochainNetwork;
+}) => Promise<boolean>;
+/**
+ * Get unspent txs and filter out pending UTXOs
+ *
+ * @see https://sochain.com/api#get-unspent-tx
+ *
+ * @param {string} sochainUrl The sochain node url.
+ * @param {Network} network
+ * @param {string} address
+ * @returns {AddressUTXO[]}
+ */
+export declare const getConfirmedUnspentTxs: ({ apiKey, sochainUrl, network, address, }: AddressParams) => Promise<AddressUTXO[]>;
+/**
+ * Get address balance.
+ *
+ * @see https://sochain.com/api#get-balance
+ *
+ * @param {string} sochainUrl 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 broadcastTx: ({ apiKey, sochainUrl, network, txHex, }: {
+    apiKey: string;
+    sochainUrl: string;
+    txHex: string;
+    network: SochainNetwork;
+}) => Promise<TxHash>;

package/lib/providers/sochainv3/sochain-data-provider.d.ts

@@ -1,42 +1,42 @@
-import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
-import { Address, Asset, Chain } from '@xchainjs/xchain-util';
-import { SochainNetwork } from './sochain-api-types';
-export declare class SochainProvider implements UtxoOnlineDataProvider {
-    private baseUrl;
-    private _apiKey;
-    private chain;
-    private asset;
-    private assetDecimals;
-    private sochainNetwork;
-    constructor(baseUrl: string | undefined, apiKey: string, chain: Chain, asset: Asset, assetDecimals: number, sochainNetwork: SochainNetwork);
-    get apiKey(): string;
-    set apiKey(value: string);
-    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>;
-    /**
-     * 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 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;
-}
+import { Balance, Tx, TxHash, TxHistoryParams, TxsPage, UTXO, UtxoOnlineDataProvider } from '@xchainjs/xchain-client';
+import { Address, Asset, Chain } from '@xchainjs/xchain-util';
+import { SochainNetwork } from './sochain-api-types';
+export declare class SochainProvider implements UtxoOnlineDataProvider {
+    private baseUrl;
+    private _apiKey;
+    private chain;
+    private asset;
+    private assetDecimals;
+    private sochainNetwork;
+    constructor(baseUrl: string | undefined, apiKey: string, chain: Chain, asset: Asset, assetDecimals: number, sochainNetwork: SochainNetwork);
+    get apiKey(): string;
+    set apiKey(value: string);
+    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>;
+    /**
+     * 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 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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-utxo-providers",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -27,16 +27,16 @@
     "access": "public"
   },
   "devDependencies": {
-    "@xchainjs/xchain-client": "^0.13.7",
-    "@xchainjs/xchain-crypto": "^0.2.6",
-    "@xchainjs/xchain-util": "^0.12.0",
-    "axios": "^0.25.0"
+    "@xchainjs/xchain-client": "^0.14.0",
+    "@xchainjs/xchain-crypto": "^0.3.0",
+    "@xchainjs/xchain-util": "^0.13.0",
+    "axios": "^1.3.6"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.13.7",
-    "@xchainjs/xchain-crypto": "^0.2.6",
-    "@xchainjs/xchain-util": "^0.12.0",
-    "axios": "^0.25.0"
+    "@xchainjs/xchain-client": "^0.14.0",
+    "@xchainjs/xchain-crypto": "^0.3.0",
+    "@xchainjs/xchain-util": "^0.13.0",
+    "axios": "^1.3.6"
   },
   "dependencies": {
     "@supercharge/promise-pool": "^2.4.0"