Add method getAddressAsync and mark getAddress as deprecated

packages/xchain-arbitrum/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.1.1 (2023-11-16)
+
+## Update
+
+- Created method getAddressAsync
+
 # v.0.1.0 (2022-10-13)
 
 ## Update

packages/xchain-arbitrum/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-arbitrum",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Arbitrum EVM client for XChainJS",
   "keywords": [
     "XChain",
@@ -35,21 +35,21 @@
     "access": "public"
   },
   "devDependencies": {
-    "@xchainjs/xchain-client": "^0.15.2",
+    "@xchainjs/xchain-client": "^0.15.3",
     "@xchainjs/xchain-crypto": "^0.3.0",
-    "@xchainjs/xchain-evm": "^0.4.0",
+    "@xchainjs/xchain-evm": "^0.4.1",
     "@xchainjs/xchain-util": "^0.13.1",
-    "@xchainjs/xchain-evm-providers": "^0.1.2",
+    "@xchainjs/xchain-evm-providers": "^0.1.3",
     "axios": "^1.3.6",
     "ethers": "^5.7.2"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.15.2",
+    "@xchainjs/xchain-client": "^0.15.3",
     "@xchainjs/xchain-crypto": "^0.3.0",
-    "@xchainjs/xchain-evm": "^0.4.0",
+    "@xchainjs/xchain-evm": "^0.4.1",
     "@xchainjs/xchain-util": "^0.13.1",
-    "@xchainjs/xchain-evm-providers": "^0.1.2",
+    "@xchainjs/xchain-evm-providers": "^0.1.3",
     "axios": "^1.3.6",
     "ethers": "^5.7.2"
   }
-}
+}

packages/xchain-avax/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.4.1 (2023-11-16)
+
+## Update
+
+- Created method getAddressAsync
+
 # v0.4.0 (2023-11-15)
 
 ## Update

packages/xchain-avax/__e2e__/avax-client.e2e.ts

@@ -56,7 +56,7 @@ function delay(ms: number) {
 }
 describe('xchain-evm (Avax) Integration Tests', () => {
   it('should fetch avax balances', async () => {
-    const address = client.getAddress(0)
+    const address = await client.getAddressAsync(0)
     console.log(address)
     const balances = await client.getBalance(address)
     balances.forEach((bal: Balance) => {
@@ -79,9 +79,9 @@ describe('xchain-evm (Avax) Integration Tests', () => {
     expect(tx.asset.chain).toBe(AVAXChain)
     expect(tx.asset.ticker).toBe(AssetAVAX.ticker)
     expect(tx.type).toBe(TxType.Transfer)
-    expect(tx.from[0].from).toBe(client.getAddress(0))
+    expect(tx.from[0].from).toBe(await client.getAddressAsync(0))
     expect(tx.from[0].amount.amount().toFixed()).toBe(amount.amount().toFixed())
-    expect(tx.to[0].to).toBe(client.getAddress(1))
+    expect(tx.to[0].to).toBe(await client.getAddressAsync(1))
     expect(tx.to[0].amount.amount().toFixed()).toBe(amount.amount().toFixed())
     expect(tx.hash).toBe(txId)
   })
@@ -94,22 +94,22 @@ describe('xchain-evm (Avax) Integration Tests', () => {
     expect(tx.asset.ticker).toBe(assetRIP.ticker)
     expect(tx.asset.symbol).toBe(assetRIP.symbol)
     expect(tx.type).toBe(TxType.Transfer)
-    expect(tx.from[0].from).toBe(client.getAddress(0))
+    expect(tx.from[0].from).toBe(await client.getAddressAsync(0))
     expect(tx.from[0].amount.amount().toFixed()).toBe(amount.amount().toFixed())
-    expect(tx.to[0].to).toBe(client.getAddress(1))
+    expect(tx.to[0].to).toBe(await client.getAddressAsync(1))
     expect(tx.to[0].amount.amount().toFixed()).toBe(amount.amount().toFixed())
     expect(tx.hash).toBe(txId)
   })
 
   it('should transfer 0.01 AVAX between wallet 0 and 1, with a memo', async () => {
-    const recipient = client.getAddress(1)
+    const recipient = await client.getAddressAsync(1)
     const amount = assetToBase(assetAmount('0.01', 18))
     const memo = `=:BNB.BUSD-BD1:bnb1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:100000000000`
     const txHash = await client.transfer({ amount, recipient, memo })
     console.log(txHash)
   })
   it('should transfer 0.01 AVAX following EIP1559 because of maxFeePerGas', async () => {
-    const recipient = client.getAddress(1)
+    const recipient = await client.getAddressAsync(1)
     const amount = assetToBase(assetAmount('0.01', 18))
     const txHash = await client.transfer({
       amount,
@@ -119,7 +119,7 @@ describe('xchain-evm (Avax) Integration Tests', () => {
     console.log(txHash)
   })
   it('should transfer 0.01 AVAX following EIP1559 because of maxPriorityFeePerGas', async () => {
-    const recipient = client.getAddress(1)
+    const recipient = await client.getAddressAsync(1)
     const amount = assetToBase(assetAmount('0.01', 18))
     const txHash = await client.transfer({
       amount,
@@ -137,7 +137,7 @@ describe('xchain-evm (Avax) Integration Tests', () => {
     console.log(txHash)
   })
   it('should approve 0.01 RIP(ERC-20) between wallet 0 and 1', async () => {
-    const recipient = client.getAddress(1)
+    const recipient = await client.getAddressAsync(1)
     const amount = assetToBase(assetAmount('0.01', 6))
     //ERC20 address The Crypt (RIP)
 
@@ -193,7 +193,7 @@ describe('xchain-evm (Avax) Integration Tests', () => {
     console.log(gasEstimate.toString())
     expect(gasEstimate.gte(0)).toBe(true)
 
-    const recipient = client.getAddress(1)
+    const recipient = await client.getAddressAsync(1)
     const amount = assetToBase(assetAmount('0.01', 18))
     const memo = '=:BNB.BUSD-BD1:bnb1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:100000000000'
     const gasEstimateWithMemo = await client.estimateFeesWithGasPricesAndLimits({ amount, recipient, memo })

packages/xchain-avax/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-avax",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "Avax EVM client for XChainJS",
   "keywords": [
     "XChain",
@@ -35,21 +35,21 @@
     "access": "public"
   },
   "devDependencies": {
-    "@xchainjs/xchain-client": "^0.15.2",
+    "@xchainjs/xchain-client": "^0.15.3",
     "@xchainjs/xchain-crypto": "^0.3.0",
-    "@xchainjs/xchain-evm": "^0.4.0",
+    "@xchainjs/xchain-evm": "^0.4.1",
     "@xchainjs/xchain-util": "^0.13.1",
-    "@xchainjs/xchain-evm-providers": "^0.1.2",
+    "@xchainjs/xchain-evm-providers": "^0.1.3",
     "axios": "^1.3.6",
     "ethers": "^5.7.2"
   },
   "peerDependencies": {
-    "@xchainjs/xchain-client": "^0.15.2",
+    "@xchainjs/xchain-client": "^0.15.3",
     "@xchainjs/xchain-crypto": "^0.3.0",
-    "@xchainjs/xchain-evm": "^0.4.0",
+    "@xchainjs/xchain-evm": "^0.4.1",
     "@xchainjs/xchain-util": "^0.13.1",
-    "@xchainjs/xchain-evm-providers": "^0.1.2",
+    "@xchainjs/xchain-evm-providers": "^0.1.3",
     "axios": "^1.3.6",
     "ethers": "^5.7.2"
   }
-}
+}

packages/xchain-binance/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v5.7.5 (2023-11-16)
+
+## Update
+
+- Created method getAddressAsync
+
 # v5.7.4 (2023-10-26)
 
 ## Update

packages/xchain-binance/__tests__/client.test.ts

@@ -89,30 +89,30 @@ describe('BinanceClient Test', () => {
 
   it('should start with empty wallet', async () => {
     const bnbClientEmptyMain = new BinanceClient({ phrase, network: 'mainnet' as Network })
-    const addressMain = bnbClientEmptyMain.getAddress()
+    const addressMain = await bnbClientEmptyMain.getAddressAsync()
     expect(addressMain).toEqual(mainnetaddress_path0)
 
     const bnbClientEmptyTest = new BinanceClient({ phrase, network: Network.Testnet })
-    const addressTest = bnbClientEmptyTest.getAddress()
+    const addressTest = await bnbClientEmptyTest.getAddressAsync()
     expect(addressTest).toEqual(testnetaddress_path0)
   })
 
   it('should support derivation index as string', async () => {
     const bnbForTxClientEmptyMain = new BinanceClient({ phrase: phraseForTX, network: Network.Testnet })
-    const address_path0ForTx = bnbForTxClientEmptyMain.getAddress()
+    const address_path0ForTx = await bnbForTxClientEmptyMain.getAddressAsync()
     expect(address_path0ForTx).toEqual(testnetaddress_path0ForTx)
 
     const bnbClientEmptyMain = new BinanceClient({ phrase, network: 'mainnet' as Network })
-    const addressMain = bnbClientEmptyMain.getAddress()
+    const addressMain = await bnbClientEmptyMain.getAddressAsync()
     expect(addressMain).toEqual(mainnetaddress_path0)
     const bnbClientEmptyMain_path1 = new BinanceClient({ phrase, network: 'mainnet' as Network })
-    expect(bnbClientEmptyMain_path1.getAddress(1)).toEqual(mainnetaddress_path1)
+    expect(await bnbClientEmptyMain_path1.getAddressAsync(1)).toEqual(mainnetaddress_path1)
 
     const bnbClientEmptyTest = new BinanceClient({ phrase, network: Network.Testnet })
-    const addressTest = bnbClientEmptyTest.getAddress()
+    const addressTest = await bnbClientEmptyTest.getAddressAsync()
     expect(addressTest).toEqual(testnetaddress_path0)
     const bnbClientEmptyTest_path1 = new BinanceClient({ phrase, network: Network.Testnet })
-    expect(bnbClientEmptyTest_path1.getAddress(1)).toEqual(testnetaddress_path1)
+    expect(await bnbClientEmptyTest_path1.getAddressAsync(1)).toEqual(testnetaddress_path1)
   })
 
   it('should not throw on a client without a phrase', () => {
@@ -134,15 +134,15 @@ describe('BinanceClient Test', () => {
   })
 
   it('should have right address', async () => {
-    expect(bnbClient.getAddress()).toEqual(mainnetaddress_path0)
-    expect(bnbClient.getAddress(1)).toEqual(mainnetaddress_path1)
+    expect(await bnbClient.getAddressAsync()).toEqual(mainnetaddress_path0)
+    expect(await bnbClient.getAddressAsync(1)).toEqual(mainnetaddress_path1)
   })
 
-  it('should update net', () => {
+  it('should update net', async () => {
     const client = new BinanceClient({ phrase, network: 'mainnet' as Network })
     client.setNetwork(Network.Testnet)
     expect(client.getNetwork()).toEqual('testnet')
-    expect(client.getAddress()).toEqual(testnetaddress_path0)
+    expect(await client.getAddressAsync()).toEqual(testnetaddress_path0)
   })
 
   it('setPhrase should return address', () => {
@@ -352,7 +352,7 @@ describe('BinanceClient Test', () => {
 
   it('should broadcast a transfer', async () => {
     const client = new BinanceClient({ phrase: phraseForTX, network: Network.Testnet })
-    expect(client.getAddress()).toEqual(testnetaddress_path0ForTx)
+    expect(await client.getAddressAsync()).toEqual(testnetaddress_path0ForTx)
 
     mockGetAccount(
       testnetClientURL,
@@ -404,7 +404,7 @@ describe('BinanceClient Test', () => {
       sequence: 0,
     })
 
-    const afterTransfer = await client.getBalance(client.getAddress(0))
+    const afterTransfer = await client.getBalance(await client.getAddressAsync(0))
     expect(afterTransfer.length).toEqual(1)
 
     const expected = beforeTransfer[0].amount
@@ -416,7 +416,7 @@ describe('BinanceClient Test', () => {
 
   it('should broadcast a multi transfer', async () => {
     const client = new BinanceClient({ phrase: phraseForTX, network: Network.Testnet })
-    expect(client.getAddress()).toEqual(testnetaddress_path0ForTx)
+    expect(await client.getAddressAsync()).toEqual(testnetaddress_path0ForTx)
 
     mockGetAccount(
       testnetClientURL,
@@ -494,7 +494,7 @@ describe('BinanceClient Test', () => {
       sequence: 0,
     })
 
-    const afterTransfer = await client.getBalance(client.getAddress(0))
+    const afterTransfer = await client.getBalance(await client.getAddressAsync(0))
     expect(afterTransfer.length).toEqual(1)
 
     const expected = beforeTransfer[0].amount

packages/xchain-binance/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-binance",
-  "version": "5.7.4",
+  "version": "5.7.5",
   "description": "Custom Binance client and utilities used by XChainJS clients",
   "keywords": [
     "BNB",
@@ -35,7 +35,7 @@
   "devDependencies": {
     "@binance-chain/javascript-sdk": "^4.2.0",
     "@types/big.js": "^6.1.6",
-    "@xchainjs/xchain-client": "^0.15.1",
+    "@xchainjs/xchain-client": "^0.15.3",
     "@xchainjs/xchain-crypto": "^0.3.0",
     "@xchainjs/xchain-util": "^0.13.1"
   },
@@ -44,7 +44,7 @@
   },
   "peerDependencies": {
     "@binance-chain/javascript-sdk": "^4.2.0",
-    "@xchainjs/xchain-client": "^0.15.1",
+    "@xchainjs/xchain-client": "^0.15.3",
     "@xchainjs/xchain-crypto": "^0.3.0",
     "@xchainjs/xchain-util": "^0.13.1"
   }

packages/xchain-binance/src/client.ts

@@ -210,6 +210,13 @@ class Client extends BaseXChainClient implements BinanceClient, XChainClient {
     return crypto.getPrivateKeyFromMnemonic(this.phrase, true, index)
   }
 
+  /**
+   * @deprecated this function eventually will be removed use getAddressAsync instead
+   */
+  getAddress(index = 0): string {
+    return crypto.getAddressFromPrivateKey(this.getPrivateKey(index), getPrefix(this.network))
+  }
+
   /**
    * Get the current address.
    *
@@ -218,9 +225,10 @@ class Client extends BaseXChainClient implements BinanceClient, XChainClient {
    *
    * @throws {Error} Thrown if phrase has not been set before. A phrase is needed to create a wallet and to derive an address from it.
    */
-  getAddress(index = 0): string {
-    return crypto.getAddressFromPrivateKey(this.getPrivateKey(index), getPrefix(this.network))
+  async getAddressAsync(index = 0): Promise<string> {
+    return this.getAddress(index)
   }
+
   /**
    * Validate the given address.
    *
@@ -251,7 +259,7 @@ class Client extends BaseXChainClient implements BinanceClient, XChainClient {
    * @returns {Account} account details of given address.
    */
   async getAccount(address?: Address, index = 0): Promise<Account> {
-    const accountAddress = address || this.getAddress(index)
+    const accountAddress = address || (await this.getAddressAsync(index))
     const response = await this.bncClient.getAccount(accountAddress)
     if (!response || !response.result || !isAccount(response.result))
       return Promise.reject(Error(`Could not get account data for address ${accountAddress}`))
@@ -407,7 +415,7 @@ class Client extends BaseXChainClient implements BinanceClient, XChainClient {
     await this.bncClient.setPrivateKey(this.getPrivateKey(walletIndex || 0))
 
     const transferResult = await this.bncClient.transfer(
-      this.getAddress(walletIndex),
+      await this.getAddressAsync(walletIndex),
       recipient,
       baseToAsset(amount).amount().toString(),
       asset ? asset.symbol : AssetBNB.symbol,

packages/xchain-bitcoin/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v0.23.4 (2023-11-16)
+
+## Update
+
+- Created method getAddressAsync
+
 # v0.23.3 (2023-11-10)
 
 ## Update

packages/xchain-bitcoin/__e2e__/blockcypher.bitcoin-client.e2e.ts

@@ -107,7 +107,7 @@ describe('Bitcoin Integration Tests for BlockCypher', () => {
   it('should send a testnet btc tx via blockcypher', async () => {
     try {
       // const from = btcClientTestnet.getAddress(0)
-      const to = btcClientTestnet.getAddress(1)
+      const to = await btcClientTestnet.getAddressAsync(1)
       // console.log(JSON.stringify(to, null, 2))
       const amount = assetToBase(assetAmount('0.000011'))
       const txid = await btcClientTestnet.transfer({
@@ -143,8 +143,8 @@ describe('Bitcoin Integration Tests for BlockCypher', () => {
   })
   it('Try to send max amount', async () => {
     try {
-      const firstAddress = btcClientTestnet.getAddress(0)
-      const address = btcClientTestnet.getAddress(1)
+      const firstAddress = await btcClientTestnet.getAddressAsync(0)
+      const address = await btcClientTestnet.getAddressAsync(1)
       console.log('address', address)
       const balance = await btcClientTestnet.getBalance(address)
       console.log(balance[0].amount.amount().toString())

packages/xchain-bitcoin/__e2e__/haskoin.bitcoin-client.e2e.ts

@@ -100,7 +100,7 @@ describe('Bitcoin Integration Tests for Haskoin', () => {
     try {
       // const from = btcClientTestnet.getAddress(0)
       // console.log(from)
-      const to = btcClientTestnet.getAddress(1)
+      const to = await btcClientTestnet.getAddressAsync(1)
       const amount = assetToBase(assetAmount('0.00001'))
       const txid = await btcClientTestnet.transfer({
         asset: AssetBTC,

packages/xchain-bitcoin/__e2e__/sochain.bitcoin-client.e2e.ts

@@ -76,7 +76,7 @@ describe('Bitcoin Integration Sochain Tests', () => {
   it('should send a testnet btc tx via sochain', async () => {
     try {
       //const from = btcClientTestnet.getAddress(0)
-      const to = btcClientTestnet.getAddress(1)
+      const to = await btcClientTestnet.getAddressAsync(1)
       console.log(JSON.stringify(to, null, 2))
       const amount = assetToBase(assetAmount('0.00001'))
       const txid = await btcClientTestnet.transfer({