feat(sdk-coin-eth): add registerWithCoinMap for dynamic token registration

TICKET: CSHLD-24

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: manas-at-bitgo

modules/sdk-api/package.json

@@ -42,6 +42,7 @@
   "dependencies": {
     "@bitgo/argon2": "^1.1.0",
     "@bitgo/sdk-core": "^36.41.0",
+    "@bitgo/statics": "^58.36.0",
     "@bitgo/sdk-hmac": "^1.9.0",
     "@bitgo/sjcl": "^1.1.0",
     "@bitgo/unspents": "^0.51.3",

modules/sdk-coin-eth/src/register.ts

@@ -1,4 +1,4 @@
-import { BitGoBase } from '@bitgo/sdk-core';
+import { BitGoBase, GlobalCoinFactory } from '@bitgo/sdk-core';
 import { Erc20Token } from './erc20Token';
 import { Eth } from './eth';
 import { Gteth } from './gteth';
@@ -21,7 +21,16 @@ export const register = (sdk: BitGoBase): void => {
 };
 
 export const registerWithCoinMap = (sdk: BitGoBase, coinMap: CoinMap): void => {
-  Erc20Token.createTokenConstructors(getFormattedErc20Tokens(coinMap)).forEach(({ name, coinConstructor }) => {
+  register(sdk);
+
+  // Registration for dynamic ERC20 tokens that are not hardcoded in the SDK, but are present in the coin map generated using AMS.
+  const tokenConstructors = Erc20Token.createTokenConstructors(getFormattedErc20Tokens(coinMap));
+  tokenConstructors.forEach(({ name, coinConstructor }) => {
+    // Register constructor for both type names and contract addresses
     sdk.register(name, coinConstructor);
+    // Add new tokens to the global coin map so they're available for lookup
+    if (coinMap.has(name)) {
+      GlobalCoinFactory.registerToken(coinMap.get(name), coinConstructor);
+    }
   });
 };

modules/sdk-coin-eth/test/unit/register.ts

@@ -0,0 +1,81 @@
+import sinon from 'sinon';
+import assert from 'assert';
+import { BitGoAPI } from '@bitgo/sdk-api';
+import { GlobalCoinFactory } from '@bitgo/sdk-core';
+import { coins, Erc20Coin } from '@bitgo/statics';
+import { register, registerWithCoinMap } from '../../src/register';
+import { Erc20Token } from '../../src/erc20Token';
+import { Erc721Token } from '../../src/erc721Token';
+
+describe('ETH Register', function () {
+  let bitgo: BitGoAPI;
+  let registerSpy: sinon.SinonSpy;
+  let registerTokenSpy: sinon.SinonSpy;
+
+  beforeEach(function () {
+    bitgo = new BitGoAPI({ env: 'test' });
+    registerSpy = sinon.spy(bitgo, 'register');
+    registerTokenSpy = sinon.spy(GlobalCoinFactory, 'registerToken');
+  });
+
+  afterEach(function () {
+    registerSpy.restore();
+    registerTokenSpy.restore();
+  });
+
+  describe('register', function () {
+    it('should register base coins and token constructors', function () {
+      register(bitgo);
+
+      const registeredNames = registerSpy.getCalls().map((call) => call.args[0]);
+
+      // Base coins should be registered
+      assert.ok(registeredNames.includes('eth'));
+      assert.ok(registeredNames.includes('gteth'));
+      assert.ok(registeredNames.includes('teth'));
+      assert.ok(registeredNames.includes('hteth'));
+
+      // ERC20 and ERC721 tokens should be registered
+      const erc20Count = Erc20Token.createTokenConstructors().length;
+      const erc721Count = Erc721Token.createTokenConstructors().length;
+      assert.strictEqual(registerSpy.callCount, 4 + erc20Count + erc721Count);
+    });
+  });
+
+  describe('registerWithCoinMap', function () {
+    it('should call register internally for base coins and tokens', function () {
+      registerWithCoinMap(bitgo, coins);
+
+      const registeredNames = registerSpy.getCalls().map((call) => call.args[0]);
+
+      // Base coins should be registered via register()
+      assert.ok(registeredNames.includes('eth'));
+      assert.ok(registeredNames.includes('gteth'));
+      assert.ok(registeredNames.includes('teth'));
+      assert.ok(registeredNames.includes('hteth'));
+    });
+
+    it('should add dynamic ERC20 tokens to the global coin map', function () {
+      registerWithCoinMap(bitgo, coins);
+
+      // registerToken should have been called for dynamic tokens
+      assert.ok(registerTokenSpy.callCount > 0);
+
+      // Each call should pass a valid coin from the coinMap
+      for (let i = 0; i < registerTokenSpy.callCount; i++) {
+        const call = registerTokenSpy.getCall(i);
+        const staticsCoin = call.args[0];
+        assert.ok(coins.has(staticsCoin.name), `${staticsCoin.name} should exist in the coin map`);
+      }
+    });
+
+    it('should not add tokens to the global coin map when coin map has no ERC20 tokens', function () {
+      const limitedCoinMap = coins.filter((coin) => !(coin instanceof Erc20Coin));
+
+      registerWithCoinMap(bitgo, limitedCoinMap);
+
+      // registerToken should not be called since no ERC20 tokens are in the map
+      assert.strictEqual(registerTokenSpy.callCount, 0);
+    });
+  });
+});