Move getAccountResources to BaseCoin and rename tokenName to assetName

Co-authored-by: bhavidhingra <17147510+bhavidhingra@users.noreply.github.com>

Author: Copilot

modules/sdk-core/src/bitgo/baseCoin/baseCoin.ts

@@ -390,6 +390,29 @@ export abstract class BaseCoin implements IBaseCoin {
     return false;
   }
 
+  /**
+   * Get account resources for the given addresses
+   * @param addresses - array of address strings
+   * @param assetName - optional asset name
+   * @returns {Promise<any>} - response from WP API
+   */
+  async getAccountResources(addresses: string[], assetName?: string): Promise<any> {
+    if (!Array.isArray(addresses)) {
+      throw new Error('addresses must be an array');
+    }
+
+    if (addresses.length === 0) {
+      throw new Error('addresses array cannot be empty');
+    }
+
+    const query: any = { addresses };
+    if (assetName) {
+      query.assetName = assetName;
+    }
+
+    return this.bitgo.get(this.url('/accountResources')).query(query).result();
+  }
+
   /**
    * Check whether a coin supports signing of Typed data
    * @returns {boolean}

modules/sdk-core/src/bitgo/baseCoin/iBaseCoin.ts

@@ -654,4 +654,12 @@ export interface IBaseCoin {
    */
   assertIsValidKey({ publicKey, encryptedPrv, walletPassphrase, multiSigType }: AuditKeyParams): void;
   requiresWalletInitializationTransaction(): boolean;
+  
+  /**
+   * Get account resources for the given addresses
+   * @param addresses - array of address strings
+   * @param assetName - optional asset name
+   * @returns {Promise<any>} - response from WP API
+   */
+  getAccountResources(addresses: string[], assetName?: string): Promise<any>;
 }

modules/sdk-core/src/bitgo/wallet/iWallet.ts

@@ -539,11 +539,6 @@ export interface ForwarderBalanceOptions {
   maximumBalance?: number;
 }
 
-export interface GetAccountResourcesOptions {
-  addresses: string[];
-  tokenName?: string;
-}
-
 export type CreateAddressFormat = 'base58' | 'cashaddr';
 
 export interface CreateAddressOptions {
@@ -993,7 +988,6 @@ export interface IWallet {
   getAddress(params?: GetAddressOptions): Promise<any>;
   createAddress(params?: CreateAddressOptions): Promise<any>;
   updateAddress(params?: UpdateAddressOptions): Promise<any>;
-  getAccountResources(addresses: string[], tokenName?: string): Promise<any>;
   listWebhooks(params?: PaginationOptions): Promise<any>;
   simulateWebhook(params?: SimulateWebhookOptions): Promise<any>;
   addWebhook(params?: ModifyWebhookOptions): Promise<any>;

modules/sdk-core/src/bitgo/wallet/wallet.ts

@@ -1465,29 +1465,6 @@ export class Wallet implements IWallet {
     return this.bitgo.put(url).send(putParams).result();
   }
 
-  /**
-   * Get account resources for the given addresses
-   * @param addresses - array of address strings
-   * @param tokenName - optional token name
-   * @returns {Promise<any>} - response from WP API
-   */
-  async getAccountResources(addresses: string[], tokenName?: string): Promise<any> {
-    if (!Array.isArray(addresses)) {
-      throw new Error('addresses must be an array');
-    }
-
-    if (addresses.length === 0) {
-      throw new Error('addresses array cannot be empty');
-    }
-
-    const query: any = { addresses };
-    if (tokenName) {
-      query.tokenName = tokenName;
-    }
-
-    return this.bitgo.get(this.url('/accountResources')).query(query).result();
-  }
-
   async updateWalletBuildDefaults(params: UpdateBuildDefaultOptions): Promise<unknown> {
     common.validateParams(params, [], ['minFeeRate', 'changeAddressType', 'txFormat']);
     return this.updateWallet({

…unit/bitgo/wallet/getAccountResources.ts …it/bitgo/baseCoin/getAccountResources.tsmodules/sdk-core/test/unit/bitgo/wallet/getAccountResources.ts renamed to modules/sdk-core/test/unit/bitgo/baseCoin/getAccountResources.ts modules/sdk-core/test/unit/bitgo/wallet/getAccountResources.ts renamed to modules/sdk-core/test/unit/bitgo/baseCoin/getAccountResources.ts

@@ -1,29 +1,42 @@
 import * as assert from 'assert';
 import * as sinon from 'sinon';
 import 'should';
-import { Wallet } from '../../../../src/bitgo/wallet/wallet';
-
-describe('Wallet - getAccountResources', function () {
-  let wallet: Wallet;
+import { BaseCoin } from '../../../../src/bitgo/baseCoin/baseCoin';
+import { BitGoBase } from '../../../../src/bitgo/bitgoBase';
+
+// Create a concrete test implementation of BaseCoin
+class TestBaseCoin extends BaseCoin {
+  getChain(): string {
+    return 'test';
+  }
+  getFamily(): string {
+    return 'test';
+  }
+  getFullName(): string {
+    return 'Test Coin';
+  }
+  getBaseFactor(): string | number {
+    return 1e8;
+  }
+  isValidAddress(address: string): boolean {
+    return true;
+  }
+  static createInstance(bitgo: BitGoBase): BaseCoin {
+    return new TestBaseCoin(bitgo);
+  }
+}
+
+describe('BaseCoin - getAccountResources', function () {
+  let baseCoin: BaseCoin;
   let mockBitGo: any;
-  let mockBaseCoin: any;
-  let mockWalletData: any;
 
   beforeEach(function () {
     mockBitGo = {
       get: sinon.stub(),
+      url: sinon.stub().returns('/api/v2/'),
     };
 
-    mockBaseCoin = {
-      url: sinon.stub().returns('/test/coin'),
-    };
-
-    mockWalletData = {
-      id: 'test-wallet-id',
-      keys: ['user-key', 'backup-key', 'bitgo-key'],
-    };
-
-    wallet = new Wallet(mockBitGo, mockBaseCoin, mockWalletData);
+    baseCoin = TestBaseCoin.createInstance(mockBitGo);
   });
 
   afterEach(function () {
@@ -46,18 +59,18 @@ describe('Wallet - getAccountResources', function () {
       });
 
       const addresses = ['address1', 'address2'];
-      const result = await wallet.getAccountResources(addresses);
+      const result = await baseCoin.getAccountResources(addresses);
 
       result.should.deepEqual(mockResponse);
       mockBitGo.get.should.have.been.calledOnce;
       const queryStub = mockBitGo.get.returnValues[0].query;
       queryStub.should.have.been.calledWith({ addresses });
     });
 
-    it('should call WP API with addresses and tokenName parameters', async function () {
+    it('should call WP API with addresses and assetName parameters', async function () {
       const mockResponse = {
         resources: [
-          { address: 'address1', balance: 100, token: 'USDT' },
+          { address: 'address1', balance: 100, asset: 'USDT' },
         ],
       };
 
@@ -68,18 +81,18 @@ describe('Wallet - getAccountResources', function () {
       });
 
       const addresses = ['address1'];
-      const tokenName = 'USDT';
-      const result = await wallet.getAccountResources(addresses, tokenName);
+      const assetName = 'USDT';
+      const result = await baseCoin.getAccountResources(addresses, assetName);
 
       result.should.deepEqual(mockResponse);
       mockBitGo.get.should.have.been.calledOnce;
       const queryStub = mockBitGo.get.returnValues[0].query;
-      queryStub.should.have.been.calledWith({ addresses, tokenName });
+      queryStub.should.have.been.calledWith({ addresses, assetName });
     });
 
     it('should throw error if addresses is not an array', async function () {
       try {
-        await wallet.getAccountResources('not-an-array' as any);
+        await baseCoin.getAccountResources('not-an-array' as any);
         assert.fail('Should have thrown error');
       } catch (error) {
         error.message.should.equal('addresses must be an array');
@@ -88,14 +101,14 @@ describe('Wallet - getAccountResources', function () {
 
     it('should throw error if addresses array is empty', async function () {
       try {
-        await wallet.getAccountResources([]);
+        await baseCoin.getAccountResources([]);
         assert.fail('Should have thrown error');
       } catch (error) {
         error.message.should.equal('addresses array cannot be empty');
       }
     });
 
-    it('should not include tokenName in query if not provided', async function () {
+    it('should not include assetName in query if not provided', async function () {
       const mockResponse = { resources: [] };
 
       mockBitGo.get.returns({
@@ -105,12 +118,12 @@ describe('Wallet - getAccountResources', function () {
       });
 
       const addresses = ['address1'];
-      await wallet.getAccountResources(addresses);
+      await baseCoin.getAccountResources(addresses);
 
       const queryStub = mockBitGo.get.returnValues[0].query;
       const queryArg = queryStub.firstCall.args[0];
       queryArg.should.deepEqual({ addresses });
-      queryArg.should.not.have.property('tokenName');
+      queryArg.should.not.have.property('assetName');
     });
   });
 });