@xchainjs/xchain-wallet 0.1.19 → 1.0.1

package/lib/index.d.ts

@@ -6,4 +6,4 @@ import { Wallet } from './wallet';
  * Export Wallet module
  */
 export { Wallet };
-export { ChainBalances, EvmTxParams, UtxoTxParams } from './types';
+export { ChainBalances, EvmTxParams, UtxoTxParams, CosmosTxParams } from './types';

package/lib/index.esm.js

@@ -168,6 +168,7 @@ class Wallet {
     /**
      * Get chain balances
      * @param {Chain} chain The chain to retrieve the balance of
+     * @param {AnyAsset[]} chain Optional - Assets to retrieve the balance of
      * @returns {Balance[]} the chain balances
      */
     getBalance(chain, assets) {
@@ -179,7 +180,7 @@ class Wallet {
     /**
      * By default, it returns all the wallet balances unless assets are provided, in that case,
      * only asset balances will be returned by chain
-     * @param {Assets[]} assets - Optional. Assets of which return the balance
+     * @param {AnyAsset[]} assets - Optional. Assets of which return the balance
      * @returns {Record<Chain, Balance[]>} Balances by chain
      */
     getBalances(assets = Object.keys(this.clients).reduce((prev, client) => {
@@ -322,7 +323,7 @@ class Wallet {
     }
     /**
      * Estimate transfer fees
-     * @param {UtxoTxParams | EvmTxParams} params to make the transfer estimation
+     * @param {UtxoTxParams | EvmTxParams | CosmosTxParams} params to make the transfer estimation
      * @returns {Fees} Estimated fees
      */
     estimateTransferFees(params) {
@@ -350,7 +351,7 @@ class Wallet {
     }
     /**
      * Make a transaction
-     * @param {TxParams} txParams txParams - The parameters to make the transfer
+     * @param {UtxoTxParams | EvmTxParams | CosmosTxParams} params txParams - The parameters to make the transfer
      * @returns The transaction hash
      */
     transfer(params) {

package/lib/index.js

@@ -172,6 +172,7 @@ class Wallet {
     /**
      * Get chain balances
      * @param {Chain} chain The chain to retrieve the balance of
+     * @param {AnyAsset[]} chain Optional - Assets to retrieve the balance of
      * @returns {Balance[]} the chain balances
      */
     getBalance(chain, assets) {
@@ -183,7 +184,7 @@ class Wallet {
     /**
      * By default, it returns all the wallet balances unless assets are provided, in that case,
      * only asset balances will be returned by chain
-     * @param {Assets[]} assets - Optional. Assets of which return the balance
+     * @param {AnyAsset[]} assets - Optional. Assets of which return the balance
      * @returns {Record<Chain, Balance[]>} Balances by chain
      */
     getBalances(assets = Object.keys(this.clients).reduce((prev, client) => {
@@ -326,7 +327,7 @@ class Wallet {
     }
     /**
      * Estimate transfer fees
-     * @param {UtxoTxParams | EvmTxParams} params to make the transfer estimation
+     * @param {UtxoTxParams | EvmTxParams | CosmosTxParams} params to make the transfer estimation
      * @returns {Fees} Estimated fees
      */
     estimateTransferFees(params) {
@@ -354,7 +355,7 @@ class Wallet {
     }
     /**
      * Make a transaction
-     * @param {TxParams} txParams txParams - The parameters to make the transfer
+     * @param {UtxoTxParams | EvmTxParams | CosmosTxParams} params txParams - The parameters to make the transfer
      * @returns The transaction hash
      */
     transfer(params) {

package/lib/types.d.ts

@@ -1,10 +1,11 @@
 import { Balance, TxParams as BaseTxParams } from '@xchainjs/xchain-client';
 import { TxParams as BaseEvmTxParams } from '@xchainjs/xchain-evm';
-import { Asset, BaseAmount, Chain } from '@xchainjs/xchain-util';
+import { Asset, BaseAmount, Chain, SynthAsset, TokenAsset } from '@xchainjs/xchain-util';
+import { TxParams as BaseUtxoTxParams } from '@xchainjs/xchain-utxo';
 /**
  * UTXO transfer params
  */
-export type UtxoTxParams = BaseTxParams & {
+export type UtxoTxParams = BaseUtxoTxParams & {
     asset: Asset;
     feeRate?: BaseAmount;
 };
@@ -12,7 +13,13 @@ export type UtxoTxParams = BaseTxParams & {
  * EVM transfer params
  */
 export type EvmTxParams = BaseEvmTxParams & {
-    asset: Asset;
+    asset: Asset | TokenAsset;
+};
+/**
+ * Cosmos transfer params
+ */
+export type CosmosTxParams = BaseTxParams & {
+    asset: Asset | TokenAsset | SynthAsset;
 };
 /**
  * Fulfilled balance from a Chain

package/lib/wallet.d.ts

@@ -4,8 +4,8 @@
 import { AssetInfo, Balance, FeeOption, Fees, Network, Protocol, Tx, TxHash, TxsPage, XChainClient } from '@xchainjs/xchain-client';
 import { GasPrices } from '@xchainjs/xchain-evm';
 import { DepositParam } from '@xchainjs/xchain-mayachain';
-import { Address, Asset, BaseAmount, Chain } from '@xchainjs/xchain-util';
-import { ChainBalances, EvmTxParams, UtxoTxParams } from './types';
+import { Address, AnyAsset, BaseAmount, Chain, TokenAsset } from '@xchainjs/xchain-util';
+import { ChainBalances, CosmosTxParams, EvmTxParams, UtxoTxParams } from './types';
 export type NodeUrls = Record<Network, string>;
 export declare class Wallet {
     private clients;
@@ -73,16 +73,17 @@ export declare class Wallet {
     /**
      * Get chain balances
      * @param {Chain} chain The chain to retrieve the balance of
+     * @param {AnyAsset[]} chain Optional - Assets to retrieve the balance of
      * @returns {Balance[]} the chain balances
      */
-    getBalance(chain: Chain, assets?: Asset[]): Promise<Balance[]>;
+    getBalance(chain: Chain, assets?: AnyAsset[]): Promise<Balance[]>;
     /**
      * By default, it returns all the wallet balances unless assets are provided, in that case,
      * only asset balances will be returned by chain
-     * @param {Assets[]} assets - Optional. Assets of which return the balance
+     * @param {AnyAsset[]} assets - Optional. Assets of which return the balance
      * @returns {Record<Chain, Balance[]>} Balances by chain
      */
-    getBalances(assets?: Record<Chain, Asset[] | undefined>): Promise<ChainBalances>;
+    getBalances(assets?: Record<Chain, AnyAsset[] | undefined>): Promise<ChainBalances>;
     /**
      * Get transaction data from hash
      * @param {Chain} chain - Chain in which the transaction was done
@@ -142,16 +143,16 @@ export declare class Wallet {
     getFeeRates(chain: Chain, protocol?: Protocol): Promise<Record<FeeOption, BaseAmount>>;
     /**
      * Estimate transfer fees
-     * @param {UtxoTxParams | EvmTxParams} params to make the transfer estimation
+     * @param {UtxoTxParams | EvmTxParams | CosmosTxParams} params to make the transfer estimation
      * @returns {Fees} Estimated fees
      */
-    estimateTransferFees(params: UtxoTxParams | EvmTxParams): Promise<Fees>;
+    estimateTransferFees(params: UtxoTxParams | EvmTxParams | CosmosTxParams): Promise<Fees>;
     /**
      * Make a transaction
-     * @param {TxParams} txParams txParams - The parameters to make the transfer
+     * @param {UtxoTxParams | EvmTxParams | CosmosTxParams} params txParams - The parameters to make the transfer
      * @returns The transaction hash
      */
-    transfer(params: UtxoTxParams | EvmTxParams): Promise<string>;
+    transfer(params: UtxoTxParams | EvmTxParams | CosmosTxParams): Promise<string>;
     /**
      * Make a deposit
      * @param {DepositParam} depositParams
@@ -159,7 +160,7 @@ export declare class Wallet {
      * @throws {Error} if cannot make deposit with the asset
      */
     deposit({ asset, amount, memo, walletIndex, sequence, gasLimit, chain, }: DepositParam & {
-        asset: Asset;
+        asset: AnyAsset;
         chain: Chain;
     }): Promise<string>;
     /**
@@ -171,7 +172,7 @@ export declare class Wallet {
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
      * @throws {Error} If asset is a non ERC20 asset
      */
-    approve(asset: Asset, amount: BaseAmount, spenderAddress: string): Promise<string>;
+    approve(asset: TokenAsset, amount: BaseAmount, spenderAddress: string): Promise<string>;
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
      * @param {Asset} asset The asset to check
@@ -181,7 +182,7 @@ export declare class Wallet {
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
      * @throws {Error} If asset is a non ERC20 asset
      */
-    isApproved(asset: Asset, amount: BaseAmount, fromAddress: string, spenderAddress: string): Promise<boolean>;
+    isApproved(asset: TokenAsset, amount: BaseAmount, fromAddress: string, spenderAddress: string): Promise<boolean>;
     /**
      * Broadcast transaction
      * @param {Chain} chain The chain in which broadcast the signed raw transaction

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@xchainjs/xchain-wallet",
   "description": "XChainjs clients wrapper to work with several chains at the same time",
-  "version": "0.1.19",
+  "version": "1.0.1",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -29,16 +29,16 @@
     "directory": "release/package"
   },
   "dependencies": {
-    "@xchainjs/xchain-client": "0.16.8",
-    "@xchainjs/xchain-evm": "0.6.4",
-    "@xchainjs/xchain-mayachain": "1.0.11",
-    "@xchainjs/xchain-thorchain": "1.1.1",
-    "@xchainjs/xchain-util": "0.13.7",
-    "@xchainjs/xchain-utxo": "0.1.10"
+    "@xchainjs/xchain-client": "1.0.1",
+    "@xchainjs/xchain-evm": "1.0.1",
+    "@xchainjs/xchain-mayachain": "2.0.1",
+    "@xchainjs/xchain-thorchain": "2.0.1",
+    "@xchainjs/xchain-util": "1.0.0",
+    "@xchainjs/xchain-utxo": "1.0.1"
   },
   "devDependencies": {
-    "@xchainjs/xchain-bitcoin": "0.23.19",
-    "@xchainjs/xchain-bitcoincash": "0.17.17",
-    "@xchainjs/xchain-ethereum": "0.32.6"
+    "@xchainjs/xchain-bitcoin": "1.0.1",
+    "@xchainjs/xchain-bitcoincash": "1.0.1",
+    "@xchainjs/xchain-ethereum": "1.0.1"
   }
 }