@xchainjs/xchain-utxo-providers 0.2.18 → 1.0.0

package/lib/index.d.ts

@@ -2,3 +2,4 @@
  * This file exports all symbols from the providers module.
  */
 export * from './providers';
+export * from './types';

package/lib/index.esm.js

@@ -191,7 +191,7 @@ class SochainProvider {
             return this.mapUTXOs(allUnspent);
         });
     }
-    getBalance(address, assets /*ignored*/, confirmedOnly) {
+    getBalance(address, confirmedOnly) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const amount = yield getBalance$2({
@@ -652,7 +652,7 @@ class HaskoinProvider {
             return yield this.mapUTXOs(allUnspent);
         });
     }
-    getBalance(address, assets /*ignored*/, confirmedOnly) {
+    getBalance(address, confirmedOnly) {
         return __awaiter(this, void 0, void 0, function* () {
             const amount = yield getBalance$1({
                 haskoinUrl: this.baseUrl,
@@ -882,7 +882,7 @@ class BlockcypherProvider {
             return this.mapUTXOs(address, allUnspent);
         });
     }
-    getBalance(address, assets /*ignored*/, confirmedOnly) {
+    getBalance(address, confirmedOnly) {
         return __awaiter(this, void 0, void 0, function* () {
             const amount = yield getBalance({
                 apiKey: this._apiKey,

package/lib/index.js

@@ -200,7 +200,7 @@ class SochainProvider {
             return this.mapUTXOs(allUnspent);
         });
     }
-    getBalance(address, assets /*ignored*/, confirmedOnly) {
+    getBalance(address, confirmedOnly) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const amount = yield getBalance$2({
@@ -661,7 +661,7 @@ class HaskoinProvider {
             return yield this.mapUTXOs(allUnspent);
         });
     }
-    getBalance(address, assets /*ignored*/, confirmedOnly) {
+    getBalance(address, confirmedOnly) {
         return __awaiter(this, void 0, void 0, function* () {
             const amount = yield getBalance$1({
                 haskoinUrl: this.baseUrl,
@@ -891,7 +891,7 @@ class BlockcypherProvider {
             return this.mapUTXOs(address, allUnspent);
         });
     }
-    getBalance(address, assets /*ignored*/, confirmedOnly) {
+    getBalance(address, confirmedOnly) {
         return __awaiter(this, void 0, void 0, function* () {
             const amount = yield getBalance({
                 apiKey: this._apiKey,

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

@@ -1,6 +1,6 @@
-import { Balance, FeeRates, Tx, TxsPage } from '@xchainjs/xchain-client';
+import { FeeRates } from '@xchainjs/xchain-client';
 import { Chain } from '@xchainjs/xchain-util';
-import { UTXO, UtxoOnlineDataProvider } from '../types';
+import { Balance, Tx, TxsPage, UTXO, UtxoOnlineDataProvider } from '../../types';
 export interface BitgoConfig {
     baseUrl: string;
     chain: Chain;

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

@@ -1,6 +1,6 @@
-import { Balance, FeeRates, Tx, TxHash, TxHistoryParams, TxsPage } from '@xchainjs/xchain-client';
+import { FeeRates, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain } from '@xchainjs/xchain-util';
-import { UTXO, UtxoOnlineDataProvider } from '../types';
+import { Balance, Tx, TxsPage, UTXO, UtxoOnlineDataProvider } from '../../types';
 import { BlockcypherNetwork } from './blockcypher-api-types';
 export declare class BlockcypherProvider implements UtxoOnlineDataProvider {
     private baseUrl;
@@ -15,7 +15,7 @@ export declare class BlockcypherProvider implements UtxoOnlineDataProvider {
     broadcastTx(txHex: string): Promise<TxHash>;
     getConfirmedUnspentTxs(address: string): Promise<UTXO[]>;
     getUnspentTxs(address: string): Promise<UTXO[]>;
-    getBalance(address: Address, assets?: Asset[], confirmedOnly?: boolean): Promise<Balance[]>;
+    getBalance(address: Address, 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.

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

@@ -1,6 +1,6 @@
-import { Balance, FeeRates, Tx, TxHash, TxHistoryParams, TxsPage } from '@xchainjs/xchain-client';
+import { FeeRates, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain } from '@xchainjs/xchain-util';
-import { UTXO, UtxoOnlineDataProvider } from '../types';
+import { Balance, Tx, TxsPage, UTXO, UtxoOnlineDataProvider } from '../../types';
 import { HaskoinNetwork } from './haskoin-api-types';
 export declare class HaskoinProvider implements UtxoOnlineDataProvider {
     private baseUrl;
@@ -12,7 +12,7 @@ export declare class HaskoinProvider implements UtxoOnlineDataProvider {
     broadcastTx(txHex: string): Promise<TxHash>;
     getConfirmedUnspentTxs(address: string): Promise<UTXO[]>;
     getUnspentTxs(address: string): Promise<UTXO[]>;
-    getBalance(address: Address, assets?: Asset[], confirmedOnly?: boolean): Promise<Balance[]>;
+    getBalance(address: Address, 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.

package/lib/providers/index.d.ts

@@ -1,7 +1,6 @@
 export * from './sochainv3/sochain-api-types';
 export * from './sochainv3/sochain-api';
 export * from './sochainv3/sochain-data-provider';
-export * from './types';
 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';

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

@@ -1,6 +1,6 @@
-import { Balance, FeeRates, Tx, TxHash, TxHistoryParams, TxsPage } from '@xchainjs/xchain-client';
+import { FeeRates, TxHash, TxHistoryParams } from '@xchainjs/xchain-client';
 import { Address, Asset, Chain } from '@xchainjs/xchain-util';
-import { UTXO, UtxoOnlineDataProvider } from '../types';
+import { Balance, Tx, TxsPage, UTXO, UtxoOnlineDataProvider } from '../../types';
 import { SochainNetwork } from './sochain-api-types';
 export declare class SochainProvider implements UtxoOnlineDataProvider {
     private baseUrl;
@@ -15,7 +15,7 @@ export declare class SochainProvider implements UtxoOnlineDataProvider {
     broadcastTx(txHex: string): Promise<TxHash>;
     getConfirmedUnspentTxs(address: string): Promise<UTXO[]>;
     getUnspentTxs(address: string): Promise<UTXO[]>;
-    getBalance(address: Address, assets?: Asset[], confirmedOnly?: boolean): Promise<Balance[]>;
+    getBalance(address: Address, 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.

package/lib/types/index.d.ts

@@ -0,0 +1,93 @@
+/// <reference types="node" />
+import { Balance as BaseBalance, FeeRates, Network, Tx as BaseTx, TxFrom as BaseTxFrom, TxHash, TxHistoryParams, TxTo as BaseTxTo, TxsPage as BaseTxsPage } from '@xchainjs/xchain-client';
+import { Address, Asset } from '@xchainjs/xchain-util';
+export type Witness = {
+    value: number;
+    script: Buffer;
+};
+export type UTXO = {
+    hash: string;
+    index: number;
+    value: number;
+    witnessUtxo?: Witness;
+    txHex?: string;
+    scriptPubKey?: string;
+};
+/**
+ * Type definition for UTXO balance.
+ */
+export type Balance = BaseBalance & {
+    asset: Asset;
+};
+/**
+ * Type definition for the sender of a UTXO transaction.
+ */
+export type TxFrom = BaseTxFrom & {
+    asset?: Asset;
+};
+/**
+ * Type definition for the recipient of a UTXO transaction.
+ */
+export type TxTo = BaseTxTo & {
+    asset?: Asset;
+};
+/**
+ * Type definition for a UTXO transaction.
+ */
+export type Tx = BaseTx & {
+    asset: Asset;
+    from: TxFrom[];
+    to: TxTo[];
+};
+/**
+ * Type definition for a page of UTXO transactions.
+ */
+export type TxsPage = BaseTxsPage & {
+    txs: Tx[];
+};
+export interface UtxoOnlineDataProvider {
+    /**
+     * Get the balance for a given address.
+     * @param {Address} address The address to get the balance for.
+     * @param {Asset[]} assets (Optional) An array of assets to get the balance for.
+     * @returns {Promise<Balance[]>} A promise that resolves to an array of balances.
+     */
+    getBalance(address: Address, confirmedOnly?: boolean): Promise<Balance[]>;
+    /**
+     * Get transactions based on provided parameters.
+     * @param {TxHistoryParams} params The parameters for fetching transactions.
+     * @returns {Promise<TxsPage>} A promise that resolves to a page of transactions.
+     */
+    getTransactions(params: TxHistoryParams): Promise<TxsPage>;
+    /**
+     * Get transaction data based on its ID.
+     * @param {string} txId The ID of the transaction.
+     * @param {Address} assetAddress (Optional) The address of the asset.
+     * @returns {Promise<Tx>} A promise that resolves to the transaction data.
+     */
+    getTransactionData(txId: string, assetAddress?: Address): Promise<Tx>;
+    /**
+     * Get the fee rates.
+     * @returns {Promise<FeeRates>} A promise that resolves to the fee rates.
+     */
+    getFeeRates(): Promise<FeeRates>;
+    /**
+     * Get confirmed unspent transaction outputs
+     * @param {Address} address Address of which return the confirmed unspent transaction outputs
+     * @returns {Promise<UTXO[]>} List of the confirmed unspent transaction outputs the address has
+     */
+    getConfirmedUnspentTxs(address: Address): Promise<UTXO[]>;
+    /**
+     * Get unspent transaction outputs
+     * @param {Address} address Address of which return the unspent transaction outputs
+     * @returns {Promise<UTXO[]>} List of the unspent transaction outputs the address has
+     */
+    getUnspentTxs(address: Address): Promise<UTXO[]>;
+    /**
+     * Broadcast a signed raw transaction
+     * @param {string} txHex Signed raw transaction
+     * @returns {Promise<UTXO[]>} Hash of the transaction broadcasted
+     */
+    broadcastTx(txHex: string): Promise<TxHash>;
+}
+export type UtxoOnlineDataProviders = Record<Network, UtxoOnlineDataProvider | undefined>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-utxo-providers",
-  "version": "0.2.18",
+  "version": "1.0.0",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -29,8 +29,8 @@
   },
   "dependencies": {
     "@supercharge/promise-pool": "2.4.0",
-    "@xchainjs/xchain-client": "0.16.8",
-    "@xchainjs/xchain-util": "0.13.7",
+    "@xchainjs/xchain-client": "1.0.0",
+    "@xchainjs/xchain-util": "1.0.0",
     "axios": "1.3.6"
   },
   "devDependencies": {

package/lib/providers/types/index.d.ts

@@ -1,21 +0,0 @@
-/// <reference types="node" />
-import { Network, OnlineDataProvider, TxHash } from '@xchainjs/xchain-client';
-import { Address } from '@xchainjs/xchain-util';
-export type Witness = {
-    value: number;
-    script: Buffer;
-};
-export type UTXO = {
-    hash: string;
-    index: number;
-    value: number;
-    witnessUtxo?: Witness;
-    txHex?: string;
-    scriptPubKey?: string;
-};
-export interface UtxoOnlineDataProvider extends OnlineDataProvider {
-    getConfirmedUnspentTxs(address: Address): Promise<UTXO[]>;
-    getUnspentTxs(address: Address): Promise<UTXO[]>;
-    broadcastTx(txHex: string): Promise<TxHash>;
-}
-export type UtxoOnlineDataProviders = Record<Network, UtxoOnlineDataProvider | undefined>;