@xchainjs/xchain-wallet 0.1.3 → 0.1.5

package/lib/index.d.ts

@@ -1,2 +1,8 @@
+/**
+ * Import Wallet module
+ */
 import { Wallet } from './wallet';
+/**
+ * Export Wallet module
+ */
 export { Wallet };

package/lib/index.esm.js

@@ -11995,44 +11995,49 @@ const isApproved = ({ provider, contractAddress, spenderAddress, fromAddress, am
     return txAmount.lte(allowance);
 });
 
+// Class definition for a Wallet
 class Wallet {
     /**
      * Constructor to create a wallet with the desired clients
      *
-     * @param {Record<string>} clients Clients by chain the wallet work with
-     * @returns Wallet
+     * @param {Record<string>} clients Clients mapped by chain with which the wallet works
+     * @returns Wallet instance
      */
     constructor(clients) {
         this.clients = clients;
         this.network = Network.Mainnet;
+        // Check if clients array is not empty
         if (Object.values(clients).length) {
+            // Get the network of the first client
             const network = Object.values(clients)[0].getNetwork();
+            // Ensure all clients are on the same network
             if (!Object.values(clients).every((client) => client.getNetwork() === network)) {
                 throw Error('Clients not working on the same network');
             }
-            this.network = network;
+            this.network = network; // Set the network for the wallet
         }
     }
     /**
-     * Get the network clients are working in
-     * @returns {Network} network
+     * Get the network that the clients are working in
+     * @returns {Network} The network
      */
     getNetwork() {
         return this.network;
     }
     /**
-     * Set the network clients are working in
-     * @param {Network} network Network
+     * Set the network that the clients are working in
+     * @param {Network} network The Network to set
      */
     setNetwork(network) {
+        // Set network for each client
         Object.values(this.clients).forEach((client) => client.setNetwork(network));
         this.network = network;
     }
     /**
      * Add a new client to the wallet
-     * @param chain to remove the client of
-     * @returns {boolean} true if client is successfully added, otherwise, false
-     * @throws {Error} If client to add is working on different network compared to others
+     * @param chain - Chain to add the client for
+     * @returns {boolean} True if client is successfully added, otherwise false
+     * @throws {Error} If trying to add a client on a different network compared to others
      */
     addClient(chain, client) {
         if (chain in this.clients)
@@ -12049,9 +12054,9 @@ class Wallet {
         return true;
     }
     /**
-     * Purge and remove client from wallet
-     * @param chain to remove the client of
-     * @returns {true} true if the client is successfully purge and removed, otherwise, false
+     * Purge and remove client from the wallet
+     * @param chain Chain to remove the client for
+     * @returns {true} True if the client is successfully purged and removed, otherwise false
      */
     purgeClient(chain) {
         try {
@@ -12066,7 +12071,7 @@ class Wallet {
     }
     /**
      * Purge and remove all clients from wallet
-     * @returns {boolean} true if the wallet is successfully purge and removed, otherwise, false
+     * @returns {boolean} True if the wallet is successfully purged and removed, otherwise false
      */
     purgeWallet() {
         try {
@@ -12082,8 +12087,8 @@ class Wallet {
     }
     /**
      * Get chain address
-     * @param {Chain} chain
-     * @returns {string} the chain address
+     * @param {Chain} chain The chain
+     * @returns {string} The chain address
      */
     getAddress(chain) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12092,10 +12097,9 @@ class Wallet {
         });
     }
     /**
-     * Get wallet chain addresses.
-     * @param {Chain[]} chains Optional - Chains of which return the address of. If not provided, it will return
-     * the wallet chain addresses
-     * @returns the chains addresses
+     * Get the wallet chain addresses.
+     * @param {Chain[]} chains Optional chains to get addresses for, if not provided, returns all wallet addresses
+     * @returns Addresses mapped by chain
      */
     getAddresses(chains) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12113,8 +12117,8 @@ class Wallet {
     }
     /**
      * Check if address is valid
-     * @param {Chain} chain in which the address has to be valid
-     * @param {string} address to validate
+     * @param {Chain} chain The chain in which the address has to be valid
+     * @param {string} address The address to validate
      * @returns {boolean} true if it is a valid address, otherwise, false
      */
     validateAddress(chain, address) {
@@ -12123,7 +12127,7 @@ class Wallet {
     }
     /**
      * Get chain balances
-     * @param {Chain} chain to retrieve the balance of
+     * @param {Chain} chain The chain to retrieve the balance of
      * @returns {Balance[]} the chain balances
      */
     getBalance(chain, assets) {
@@ -12133,7 +12137,7 @@ class Wallet {
         });
     }
     /**
-     * Get wallet balances. By default, it returns all the wallet balances unless assets are provided, in that case,
+     * 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
      * @returns {Record<Chain, Balance[]>} Balances by chain
@@ -12176,7 +12180,8 @@ class Wallet {
         });
     }
     /**
-     * Get wallet histories. By default, it returns all the wallet histories unless chains are provided, in that case,
+     * Get wallet histories.
+     * By default, it returns all the wallet histories unless chains are provided, in that case,
      * only chain histories will be returned by chain
      * @param {Chain[]} chains - Optional. Chain of which return the transaction history
      * @returns {TxsPage} the chain transaction history
@@ -12197,8 +12202,8 @@ class Wallet {
     }
     /**
      * Get explorer url
-     * @param {Chain} chain to retrieve the explorer of
-     * @returns {string} the transaction url
+     * @param {Chain} chain The chain to retrieve the explorer of
+     * @returns {string} the transaction URL
      */
     getExplorerUrl(chain) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12207,10 +12212,10 @@ class Wallet {
         });
     }
     /**
-     * Get address url
-     * @param {Chain} chain of the address
-     * @param {string} address to retrieve the url of
-     * @returns {string} the transaction url
+     * Get address URL
+     * @param {Chain} chain Chain of the address
+     * @param {string} address The address to retrieve the URL of
+     * @returns {string} The address URL
      */
     getExplorerAddressUrl(chain, address) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12219,10 +12224,10 @@ class Wallet {
         });
     }
     /**
-     * Get transaction url
-     * @param {Chain} chain of the transaction
-     * @param {string} hash of the transaction
-     * @returns the transaction url
+     * Get transaction URL
+     * @param {Chain} chain Chain of the transaction
+     * @param {string} hash Hash of the transaction
+     * @returns the transaction URL
      */
     getExplorerTxUrl(chain, hash) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12232,9 +12237,9 @@ class Wallet {
     }
     /**
      * Get feeRates. Only available for EVM clients
-     * @param {Chain} chain of which return the feeRates
-     * @returns {GasPrices} the gas fee rates
-     * @throws {Error} if gas fee rates can not be returned from the chain
+     * @param {Chain} chain Chain of which return the feeRates
+     * @returns {GasPrices} Chain of which return the feeRates
+     * @throws {Error} If gas fee rates cannot be returned from the chain
      */
     getGasFeeRates(chain) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12246,8 +12251,8 @@ class Wallet {
     }
     /**
      * Make a transaction
-     * @param {TxParams} txParams to make the transfer
-     * @returns the transaction hash
+     * @param {TxParams} txParams txParams - The parameters to make the transfer
+     * @returns The transaction hash
      */
     transfer({ asset, amount, recipient, memo, walletIndex }) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12265,7 +12270,7 @@ class Wallet {
      * Make a deposit
      * @param {DepositParam} depositParams
      * @returns {string} the hash of the deposit
-     * @throws {Error} if can not make deposit with the asset
+     * @throws {Error} if cannot make deposit with the asset
      */
     deposit({ asset, amount, memo, walletIndex, sequence, gasLimit, }) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12277,12 +12282,12 @@ class Wallet {
     }
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
-     * @param {Asset} asset to check
-     * @param {BaseAmount} amount to check
-     * @param {string} fromAddress owner of the amount asset
-     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @param {Asset} asset The asset to check
+     * @param {BaseAmount} amount The amount to check
+     * @param {string} fromAddress The owner of the amount asset from
+     * @param {string} spenderAddress The spender to check if it is allowed to spend
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
-     * @throws {Error} if asset is a non ERC20 asset
+     * @throws {Error} If asset is a non ERC20 asset
      */
     approve(asset, amount, spenderAddress) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12297,12 +12302,12 @@ class Wallet {
     }
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
-     * @param {Asset} asset to check
-     * @param {BaseAmount} amount to check
-     * @param {string} fromAddress owner of the amount asset
-     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @param {Asset} asset The asset to check
+     * @param {BaseAmount} amount The amount to check
+     * @param {string} fromAddress oThe wner of the amount asset from
+     * @param {string} spenderAddress Spender to check if it is allowed to spend
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
-     * @throws {Error} if asset is a non ERC20 asset
+     * @throws {Error} If asset is a non ERC20 asset
      */
     isApproved(asset, amount, fromAddress, spenderAddress) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12323,7 +12328,7 @@ class Wallet {
     }
     /**
      * Broadcast transaction
-     * @param {Chain} chain in which broadcast the signed raw transaction
+     * @param {Chain} chain The chain in which broadcast the signed raw transaction
      * @param {string} txHex signed raw transaction
      * @returns {TxHash} the broadcasted transaction hash
      */
@@ -12347,9 +12352,9 @@ class Wallet {
     }
     /**
      * Get chain client
-     * @param {Chain} chain of which return the client
-     * @returns {XChainClient} the chain client
-     * @throws {Error} if client does not exist
+     * @param {Chain} chain The chain of which to return the client
+     * @returns {XChainClient} The chain client
+     * @throws {Error} If the client does not exist
      */
     getClient(chain) {
         const client = this.clients[chain];

package/lib/index.js

@@ -11999,44 +11999,49 @@ const isApproved = ({ provider, contractAddress, spenderAddress, fromAddress, am
     return txAmount.lte(allowance);
 });
 
+// Class definition for a Wallet
 class Wallet {
     /**
      * Constructor to create a wallet with the desired clients
      *
-     * @param {Record<string>} clients Clients by chain the wallet work with
-     * @returns Wallet
+     * @param {Record<string>} clients Clients mapped by chain with which the wallet works
+     * @returns Wallet instance
      */
     constructor(clients) {
         this.clients = clients;
         this.network = xchainClient.Network.Mainnet;
+        // Check if clients array is not empty
         if (Object.values(clients).length) {
+            // Get the network of the first client
             const network = Object.values(clients)[0].getNetwork();
+            // Ensure all clients are on the same network
             if (!Object.values(clients).every((client) => client.getNetwork() === network)) {
                 throw Error('Clients not working on the same network');
             }
-            this.network = network;
+            this.network = network; // Set the network for the wallet
         }
     }
     /**
-     * Get the network clients are working in
-     * @returns {Network} network
+     * Get the network that the clients are working in
+     * @returns {Network} The network
      */
     getNetwork() {
         return this.network;
     }
     /**
-     * Set the network clients are working in
-     * @param {Network} network Network
+     * Set the network that the clients are working in
+     * @param {Network} network The Network to set
      */
     setNetwork(network) {
+        // Set network for each client
         Object.values(this.clients).forEach((client) => client.setNetwork(network));
         this.network = network;
     }
     /**
      * Add a new client to the wallet
-     * @param chain to remove the client of
-     * @returns {boolean} true if client is successfully added, otherwise, false
-     * @throws {Error} If client to add is working on different network compared to others
+     * @param chain - Chain to add the client for
+     * @returns {boolean} True if client is successfully added, otherwise false
+     * @throws {Error} If trying to add a client on a different network compared to others
      */
     addClient(chain, client) {
         if (chain in this.clients)
@@ -12053,9 +12058,9 @@ class Wallet {
         return true;
     }
     /**
-     * Purge and remove client from wallet
-     * @param chain to remove the client of
-     * @returns {true} true if the client is successfully purge and removed, otherwise, false
+     * Purge and remove client from the wallet
+     * @param chain Chain to remove the client for
+     * @returns {true} True if the client is successfully purged and removed, otherwise false
      */
     purgeClient(chain) {
         try {
@@ -12070,7 +12075,7 @@ class Wallet {
     }
     /**
      * Purge and remove all clients from wallet
-     * @returns {boolean} true if the wallet is successfully purge and removed, otherwise, false
+     * @returns {boolean} True if the wallet is successfully purged and removed, otherwise false
      */
     purgeWallet() {
         try {
@@ -12086,8 +12091,8 @@ class Wallet {
     }
     /**
      * Get chain address
-     * @param {Chain} chain
-     * @returns {string} the chain address
+     * @param {Chain} chain The chain
+     * @returns {string} The chain address
      */
     getAddress(chain) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12096,10 +12101,9 @@ class Wallet {
         });
     }
     /**
-     * Get wallet chain addresses.
-     * @param {Chain[]} chains Optional - Chains of which return the address of. If not provided, it will return
-     * the wallet chain addresses
-     * @returns the chains addresses
+     * Get the wallet chain addresses.
+     * @param {Chain[]} chains Optional chains to get addresses for, if not provided, returns all wallet addresses
+     * @returns Addresses mapped by chain
      */
     getAddresses(chains) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12117,8 +12121,8 @@ class Wallet {
     }
     /**
      * Check if address is valid
-     * @param {Chain} chain in which the address has to be valid
-     * @param {string} address to validate
+     * @param {Chain} chain The chain in which the address has to be valid
+     * @param {string} address The address to validate
      * @returns {boolean} true if it is a valid address, otherwise, false
      */
     validateAddress(chain, address) {
@@ -12127,7 +12131,7 @@ class Wallet {
     }
     /**
      * Get chain balances
-     * @param {Chain} chain to retrieve the balance of
+     * @param {Chain} chain The chain to retrieve the balance of
      * @returns {Balance[]} the chain balances
      */
     getBalance(chain, assets) {
@@ -12137,7 +12141,7 @@ class Wallet {
         });
     }
     /**
-     * Get wallet balances. By default, it returns all the wallet balances unless assets are provided, in that case,
+     * 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
      * @returns {Record<Chain, Balance[]>} Balances by chain
@@ -12180,7 +12184,8 @@ class Wallet {
         });
     }
     /**
-     * Get wallet histories. By default, it returns all the wallet histories unless chains are provided, in that case,
+     * Get wallet histories.
+     * By default, it returns all the wallet histories unless chains are provided, in that case,
      * only chain histories will be returned by chain
      * @param {Chain[]} chains - Optional. Chain of which return the transaction history
      * @returns {TxsPage} the chain transaction history
@@ -12201,8 +12206,8 @@ class Wallet {
     }
     /**
      * Get explorer url
-     * @param {Chain} chain to retrieve the explorer of
-     * @returns {string} the transaction url
+     * @param {Chain} chain The chain to retrieve the explorer of
+     * @returns {string} the transaction URL
      */
     getExplorerUrl(chain) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12211,10 +12216,10 @@ class Wallet {
         });
     }
     /**
-     * Get address url
-     * @param {Chain} chain of the address
-     * @param {string} address to retrieve the url of
-     * @returns {string} the transaction url
+     * Get address URL
+     * @param {Chain} chain Chain of the address
+     * @param {string} address The address to retrieve the URL of
+     * @returns {string} The address URL
      */
     getExplorerAddressUrl(chain, address) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12223,10 +12228,10 @@ class Wallet {
         });
     }
     /**
-     * Get transaction url
-     * @param {Chain} chain of the transaction
-     * @param {string} hash of the transaction
-     * @returns the transaction url
+     * Get transaction URL
+     * @param {Chain} chain Chain of the transaction
+     * @param {string} hash Hash of the transaction
+     * @returns the transaction URL
      */
     getExplorerTxUrl(chain, hash) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12236,9 +12241,9 @@ class Wallet {
     }
     /**
      * Get feeRates. Only available for EVM clients
-     * @param {Chain} chain of which return the feeRates
-     * @returns {GasPrices} the gas fee rates
-     * @throws {Error} if gas fee rates can not be returned from the chain
+     * @param {Chain} chain Chain of which return the feeRates
+     * @returns {GasPrices} Chain of which return the feeRates
+     * @throws {Error} If gas fee rates cannot be returned from the chain
      */
     getGasFeeRates(chain) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12250,8 +12255,8 @@ class Wallet {
     }
     /**
      * Make a transaction
-     * @param {TxParams} txParams to make the transfer
-     * @returns the transaction hash
+     * @param {TxParams} txParams txParams - The parameters to make the transfer
+     * @returns The transaction hash
      */
     transfer({ asset, amount, recipient, memo, walletIndex }) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12269,7 +12274,7 @@ class Wallet {
      * Make a deposit
      * @param {DepositParam} depositParams
      * @returns {string} the hash of the deposit
-     * @throws {Error} if can not make deposit with the asset
+     * @throws {Error} if cannot make deposit with the asset
      */
     deposit({ asset, amount, memo, walletIndex, sequence, gasLimit, }) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12281,12 +12286,12 @@ class Wallet {
     }
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
-     * @param {Asset} asset to check
-     * @param {BaseAmount} amount to check
-     * @param {string} fromAddress owner of the amount asset
-     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @param {Asset} asset The asset to check
+     * @param {BaseAmount} amount The amount to check
+     * @param {string} fromAddress The owner of the amount asset from
+     * @param {string} spenderAddress The spender to check if it is allowed to spend
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
-     * @throws {Error} if asset is a non ERC20 asset
+     * @throws {Error} If asset is a non ERC20 asset
      */
     approve(asset, amount, spenderAddress) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12301,12 +12306,12 @@ class Wallet {
     }
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
-     * @param {Asset} asset to check
-     * @param {BaseAmount} amount to check
-     * @param {string} fromAddress owner of the amount asset
-     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @param {Asset} asset The asset to check
+     * @param {BaseAmount} amount The amount to check
+     * @param {string} fromAddress oThe wner of the amount asset from
+     * @param {string} spenderAddress Spender to check if it is allowed to spend
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
-     * @throws {Error} if asset is a non ERC20 asset
+     * @throws {Error} If asset is a non ERC20 asset
      */
     isApproved(asset, amount, fromAddress, spenderAddress) {
         return __awaiter$5(this, void 0, void 0, function* () {
@@ -12327,7 +12332,7 @@ class Wallet {
     }
     /**
      * Broadcast transaction
-     * @param {Chain} chain in which broadcast the signed raw transaction
+     * @param {Chain} chain The chain in which broadcast the signed raw transaction
      * @param {string} txHex signed raw transaction
      * @returns {TxHash} the broadcasted transaction hash
      */
@@ -12351,9 +12356,9 @@ class Wallet {
     }
     /**
      * Get chain client
-     * @param {Chain} chain of which return the client
-     * @returns {XChainClient} the chain client
-     * @throws {Error} if client does not exist
+     * @param {Chain} chain The chain of which to return the client
+     * @returns {XChainClient} The chain client
+     * @throws {Error} If the client does not exist
      */
     getClient(chain) {
         const client = this.clients[chain];

package/lib/wallet.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Import necessary modules and libraries
+ */
 import { Balance, Network, Tx, TxHash, TxParams, TxsPage, XChainClient } from '@xchainjs/xchain-client';
 import { GasPrices } from '@xchainjs/xchain-evm';
 import { DepositParam } from '@xchainjs/xchain-mayachain';
@@ -10,66 +13,65 @@ export declare class Wallet {
     /**
      * Constructor to create a wallet with the desired clients
      *
-     * @param {Record<string>} clients Clients by chain the wallet work with
-     * @returns Wallet
+     * @param {Record<string>} clients Clients mapped by chain with which the wallet works
+     * @returns Wallet instance
      */
     constructor(clients: Record<Chain, XChainClient>);
     /**
-     * Get the network clients are working in
-     * @returns {Network} network
+     * Get the network that the clients are working in
+     * @returns {Network} The network
      */
     getNetwork(): Network;
     /**
-     * Set the network clients are working in
-     * @param {Network} network Network
+     * Set the network that the clients are working in
+     * @param {Network} network The Network to set
      */
     setNetwork(network: Network): void;
     /**
      * Add a new client to the wallet
-     * @param chain to remove the client of
-     * @returns {boolean} true if client is successfully added, otherwise, false
-     * @throws {Error} If client to add is working on different network compared to others
+     * @param chain - Chain to add the client for
+     * @returns {boolean} True if client is successfully added, otherwise false
+     * @throws {Error} If trying to add a client on a different network compared to others
      */
     addClient(chain: Chain, client: XChainClient): boolean;
     /**
-     * Purge and remove client from wallet
-     * @param chain to remove the client of
-     * @returns {true} true if the client is successfully purge and removed, otherwise, false
+     * Purge and remove client from the wallet
+     * @param chain Chain to remove the client for
+     * @returns {true} True if the client is successfully purged and removed, otherwise false
      */
     purgeClient(chain: Chain): boolean;
     /**
      * Purge and remove all clients from wallet
-     * @returns {boolean} true if the wallet is successfully purge and removed, otherwise, false
+     * @returns {boolean} True if the wallet is successfully purged and removed, otherwise false
      */
     purgeWallet(): boolean;
     /**
      * Get chain address
-     * @param {Chain} chain
-     * @returns {string} the chain address
+     * @param {Chain} chain The chain
+     * @returns {string} The chain address
      */
     getAddress(chain: Chain): Promise<string>;
     /**
-     * Get wallet chain addresses.
-     * @param {Chain[]} chains Optional - Chains of which return the address of. If not provided, it will return
-     * the wallet chain addresses
-     * @returns the chains addresses
+     * Get the wallet chain addresses.
+     * @param {Chain[]} chains Optional chains to get addresses for, if not provided, returns all wallet addresses
+     * @returns Addresses mapped by chain
      */
     getAddresses(chains?: Chain[]): Promise<Record<Chain, Address>>;
     /**
      * Check if address is valid
-     * @param {Chain} chain in which the address has to be valid
-     * @param {string} address to validate
+     * @param {Chain} chain The chain in which the address has to be valid
+     * @param {string} address The address to validate
      * @returns {boolean} true if it is a valid address, otherwise, false
      */
     validateAddress(chain: Chain, address: string): boolean;
     /**
      * Get chain balances
-     * @param {Chain} chain to retrieve the balance of
+     * @param {Chain} chain The chain to retrieve the balance of
      * @returns {Balance[]} the chain balances
      */
     getBalance(chain: Chain, assets?: Asset[]): Promise<Balance[]>;
     /**
-     * Get wallet balances. By default, it returns all the wallet balances unless assets are provided, in that case,
+     * 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
      * @returns {Record<Chain, Balance[]>} Balances by chain
@@ -89,7 +91,8 @@ export declare class Wallet {
      */
     getTransactionsHistory(chain: Chain): Promise<TxsPage>;
     /**
-     * Get wallet histories. By default, it returns all the wallet histories unless chains are provided, in that case,
+     * Get wallet histories.
+     * By default, it returns all the wallet histories unless chains are provided, in that case,
      * only chain histories will be returned by chain
      * @param {Chain[]} chains - Optional. Chain of which return the transaction history
      * @returns {TxsPage} the chain transaction history
@@ -97,35 +100,35 @@ export declare class Wallet {
     getTransactionsHistories(chains?: Chain[]): Promise<Record<Chain, TxsPage>>;
     /**
      * Get explorer url
-     * @param {Chain} chain to retrieve the explorer of
-     * @returns {string} the transaction url
+     * @param {Chain} chain The chain to retrieve the explorer of
+     * @returns {string} the transaction URL
      */
     getExplorerUrl(chain: Chain): Promise<string>;
     /**
-     * Get address url
-     * @param {Chain} chain of the address
-     * @param {string} address to retrieve the url of
-     * @returns {string} the transaction url
+     * Get address URL
+     * @param {Chain} chain Chain of the address
+     * @param {string} address The address to retrieve the URL of
+     * @returns {string} The address URL
      */
     getExplorerAddressUrl(chain: Chain, address: string): Promise<string>;
     /**
-     * Get transaction url
-     * @param {Chain} chain of the transaction
-     * @param {string} hash of the transaction
-     * @returns the transaction url
+     * Get transaction URL
+     * @param {Chain} chain Chain of the transaction
+     * @param {string} hash Hash of the transaction
+     * @returns the transaction URL
      */
     getExplorerTxUrl(chain: Chain, hash: string): Promise<string>;
     /**
      * Get feeRates. Only available for EVM clients
-     * @param {Chain} chain of which return the feeRates
-     * @returns {GasPrices} the gas fee rates
-     * @throws {Error} if gas fee rates can not be returned from the chain
+     * @param {Chain} chain Chain of which return the feeRates
+     * @returns {GasPrices} Chain of which return the feeRates
+     * @throws {Error} If gas fee rates cannot be returned from the chain
      */
     getGasFeeRates(chain: Chain): Promise<GasPrices>;
     /**
      * Make a transaction
-     * @param {TxParams} txParams to make the transfer
-     * @returns the transaction hash
+     * @param {TxParams} txParams txParams - The parameters to make the transfer
+     * @returns The transaction hash
      */
     transfer({ asset, amount, recipient, memo, walletIndex }: TxParams & {
         asset: Asset;
@@ -134,34 +137,34 @@ export declare class Wallet {
      * Make a deposit
      * @param {DepositParam} depositParams
      * @returns {string} the hash of the deposit
-     * @throws {Error} if can not make deposit with the asset
+     * @throws {Error} if cannot make deposit with the asset
      */
     deposit({ asset, amount, memo, walletIndex, sequence, gasLimit, }: DepositParam & {
         asset: Asset;
     }): Promise<string>;
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
-     * @param {Asset} asset to check
-     * @param {BaseAmount} amount to check
-     * @param {string} fromAddress owner of the amount asset
-     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @param {Asset} asset The asset to check
+     * @param {BaseAmount} amount The amount to check
+     * @param {string} fromAddress The owner of the amount asset from
+     * @param {string} spenderAddress The spender to check if it is allowed to spend
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
-     * @throws {Error} if asset is a non ERC20 asset
+     * @throws {Error} If asset is a non ERC20 asset
      */
     approve(asset: Asset, amount: BaseAmount, spenderAddress: string): Promise<ethers.providers.TransactionResponse>;
     /**
      * Check if an spenderAddress is allowed to spend in name of another address certain asset amount
-     * @param {Asset} asset to check
-     * @param {BaseAmount} amount to check
-     * @param {string} fromAddress owner of the amount asset
-     * @param {string} spenderAddress spender to check if it is allowed to spend
+     * @param {Asset} asset The asset to check
+     * @param {BaseAmount} amount The amount to check
+     * @param {string} fromAddress oThe wner of the amount asset from
+     * @param {string} spenderAddress Spender to check if it is allowed to spend
      * @returns true if the spenderAddress is allowed to spend the amount, otherwise, false
-     * @throws {Error} if asset is a non ERC20 asset
+     * @throws {Error} If asset is a non ERC20 asset
      */
     isApproved(asset: Asset, amount: BaseAmount, fromAddress: string, spenderAddress: string): Promise<boolean>;
     /**
      * Broadcast transaction
-     * @param {Chain} chain in which broadcast the signed raw transaction
+     * @param {Chain} chain The chain in which broadcast the signed raw transaction
      * @param {string} txHex signed raw transaction
      * @returns {TxHash} the broadcasted transaction hash
      */
@@ -175,9 +178,9 @@ export declare class Wallet {
     getChainWallet(chain: Chain): ethers.Wallet;
     /**
      * Get chain client
-     * @param {Chain} chain of which return the client
-     * @returns {XChainClient} the chain client
-     * @throws {Error} if client does not exist
+     * @param {Chain} chain The chain of which to return the client
+     * @returns {XChainClient} The chain client
+     * @throws {Error} If the client does not exist
      */
     private getClient;
 }

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.3",
+  "version": "0.1.5",
   "license": "MIT",
   "main": "lib/index.js",
   "module": "lib/index.esm.js",
@@ -31,12 +31,12 @@
     "@xchainjs/xchain-evm": "0.4.4",
     "@xchainjs/xchain-util": "0.13.2",
     "@xchainjs/xchain-client": "0.16.1",
-    "@xchainjs/xchain-thorchain": "1.0.1",
+    "@xchainjs/xchain-thorchain": "1.0.3",
+    "@xchainjs/xchain-mayachain": "1.0.0",
     "ethers": "5.6.6"
   },
   "devDependencies": {
     "@xchainjs/xchain-bitcoin": "0.23.10",
-    "@xchainjs/xchain-ethereum": "0.31.5",
-    "@xchainjs/xchain-mayachain": "0.2.16"
+    "@xchainjs/xchain-ethereum": "0.31.5"
   }
 }