Skip to content

Wp 6461 fix address verification during creation #7638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
danielzhao122 merged 4 commits into from
Nov 26, 2025
Merged

Wp 6461 fix address verification during creation #7638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ee66fb5
fix: pass wallet version during creation to determine if onchain or tss
danielzhao122 Nov 26, 2025
48b83ab
refactor: remove unneeded changes
danielzhao122 Nov 26, 2025
113cb89
test: add tests for wallet creation
danielzhao122 Nov 26, 2025
21302c3
test: add test to show old failing behaviour
danielzhao122 Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
296 changes: 296 additions & 0 deletions modules/sdk-coin-eth/test/unit/eth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1299,6 +1299,302 @@ describe('ETH:', function () {
});
});

describe('Address Creation', function () {
it('should pass walletVersion 6 to isWalletAddress during address creation', async function () {
const bgUrl = common.Environments[bitgo.getEnv()].uri;
const ethCoin = bitgo.coin('hteth') as Hteth;
const walletDataV6 = {
id: '598f606cd8fc24710d2ebadb1d9459bb',
coinSpecific: {
baseAddress: '0xdf07117705a9f8dc4c2a78de66b7f1797dba9d4e',
walletVersion: 6,
},
coin: 'hteth',
keys: [
'598f606cd8fc24710d2ebad89dce86c2',
'598f606cc8e43aef09fcb785221d9dd2',
'5935d59cf660764331bafcade1855fd7',
],
receiveAddress: {
address: '0xdf07117705a9f8dc4c2a78de66b7f1797dba9d4e',
},
};
const ethWalletV6 = new Wallet(bitgo, ethCoin, walletDataV6);
const isWalletAddressSpy = sinon.spy(ethCoin, 'isWalletAddress');

// Mock keychain requests
nock(bgUrl).get(`/api/v2/hteth/key/598f606cd8fc24710d2ebad89dce86c2`).reply(200, {
id: '598f606cd8fc24710d2ebad89dce86c2',
pub: 'xpub661MyMwAqRbcFXDcWD2vxuebcT1ZpTF4Vke6qmMW8yzddwNYpAPjvYEEL5jLfyYXW2fuxtAxY8TgjPUJLcf1C8qz9N6VgZxArKX4EwB8rH5',
commonKeychain:
'033b02aac4f038fef5118350b77d302ec6202931ca2e7122aad88994ffefcbc70a6069e662436236abb1619195232c41580204cb202c22357ed8f53e69eac5c69e',
source: 'user',
type: 'tss',
});
nock(bgUrl).get(`/api/v2/hteth/key/598f606cc8e43aef09fcb785221d9dd2`).reply(200, {
id: '598f606cc8e43aef09fcb785221d9dd2',
pub: 'xpub661MyMwAqRbcGhSaXikpuTC9KU88Xx9LrjKSw1JKsvXNgabpTdgjy7LSovh9ZHhcqhAHQu7uthu7FguNGdcC4aXTKK5gqTcPe4WvLYRbCSG',
commonKeychain:
'033b02aac4f038fef5118350b77d302ec6202931ca2e7122aad88994ffefcbc70a6069e662436236abb1619195232c41580204cb202c22357ed8f53e69eac5c69e',
source: 'backup',
type: 'tss',
});
nock(bgUrl).get(`/api/v2/hteth/key/5935d59cf660764331bafcade1855fd7`).reply(200, {
id: '5935d59cf660764331bafcade1855fd7',
pub: 'xpub661MyMwAqRbcFsXShW8R3hJsHNTYTUwzcejnLkY7KCtaJbDqcGkcBF99BrEJSjNZHeHveiYUrsAdwnjUMGwpgmEbiKcZWRuVA9HxnRaA3r3',
commonKeychain:
'033b02aac4f038fef5118350b77d302ec6202931ca2e7122aad88994ffefcbc70a6069e662436236abb1619195232c41580204cb202c22357ed8f53e69eac5c69e',
source: 'bitgo',
type: 'tss',
});

// Mock address creation API
nock(bgUrl)
.post(`/api/v2/hteth/wallet/${ethWalletV6.id()}/address`)
.reply(200, {
id: '638a48c6c3dba40007a3497fa49a080c',
address: '0xc012041dac143a59fa491db3a2b67b69bd78b685',
chain: 0,
index: 0,
coin: 'hteth',
wallet: ethWalletV6.id(),
coinSpecific: {
forwarderVersion: 4,
salt: '0x0',
feeAddress: '0xb1e725186990b86ca8efed08a3ccda9c9f400f09',
},
});

await ethWalletV6.createAddress({ chain: 0 });

isWalletAddressSpy.calledOnce.should.be.true();
const calledParams = isWalletAddressSpy.firstCall.args[0];
calledParams.should.have.property('walletVersion', 6);
});

it('should pass walletVersion 5 to isWalletAddress during address creation', async function () {
const bgUrl = common.Environments[bitgo.getEnv()].uri;
const ethCoin = bitgo.coin('hteth') as Hteth;
const walletDataV5 = {
id: '598f606cd8fc24710d2ebadb1d9459bb',
coinSpecific: {
baseAddress: '0xf1e3d30798acdf3a12fa5beb5fad8efb23d5be11',
walletVersion: 5,
},
coin: 'hteth',
keys: [
'598f606cd8fc24710d2ebad89dce86c2',
'598f606cc8e43aef09fcb785221d9dd2',
'5935d59cf660764331bafcade1855fd7',
],
receiveAddress: {
address: '0xf1e3d30798acdf3a12fa5beb5fad8efb23d5be11',
},
};
const ethWalletV5 = new Wallet(bitgo, ethCoin, walletDataV5);
const isWalletAddressSpy = sinon.spy(ethCoin, 'isWalletAddress');

// Mock keychain requests
nock(bgUrl).get(`/api/v2/hteth/key/598f606cd8fc24710d2ebad89dce86c2`).reply(200, {
id: '598f606cd8fc24710d2ebad89dce86c2',
pub: 'xpub661MyMwAqRbcFXDcWD2vxuebcT1ZpTF4Vke6qmMW8yzddwNYpAPjvYEEL5jLfyYXW2fuxtAxY8TgjPUJLcf1C8qz9N6VgZxArKX4EwB8rH5',
commonKeychain:
'02c8a496b16abfe2567520a279e2154642fc3c0e08e629775cb4d845c0c5fbf55ab7ba153e886de65748ed18f4ff8f5cee2242e687399ea3297a1f5524fdefd56c',
source: 'user',
type: 'tss',
});
nock(bgUrl).get(`/api/v2/hteth/key/598f606cc8e43aef09fcb785221d9dd2`).reply(200, {
id: '598f606cc8e43aef09fcb785221d9dd2',
pub: 'xpub661MyMwAqRbcGhSaXikpuTC9KU88Xx9LrjKSw1JKsvXNgabpTdgjy7LSovh9ZHhcqhAHQu7uthu7FguNGdcC4aXTKK5gqTcPe4WvLYRbCSG',
commonKeychain:
'02c8a496b16abfe2567520a279e2154642fc3c0e08e629775cb4d845c0c5fbf55ab7ba153e886de65748ed18f4ff8f5cee2242e687399ea3297a1f5524fdefd56c',
source: 'backup',
type: 'tss',
});
nock(bgUrl).get(`/api/v2/hteth/key/5935d59cf660764331bafcade1855fd7`).reply(200, {
id: '5935d59cf660764331bafcade1855fd7',
pub: 'xpub661MyMwAqRbcFsXShW8R3hJsHNTYTUwzcejnLkY7KCtaJbDqcGkcBF99BrEJSjNZHeHveiYUrsAdwnjUMGwpgmEbiKcZWRuVA9HxnRaA3r3',
commonKeychain:
'02c8a496b16abfe2567520a279e2154642fc3c0e08e629775cb4d845c0c5fbf55ab7ba153e886de65748ed18f4ff8f5cee2242e687399ea3297a1f5524fdefd56c',
source: 'bitgo',
type: 'tss',
});

// Mock address creation API
nock(bgUrl)
.post(`/api/v2/hteth/wallet/${ethWalletV5.id()}/address`)
.reply(200, {
id: '638a48c6c3dba40007a3497fa49a080c',
address: '0xd63b5e2b8d1b4fba3625460508900bf2a0499a4d',
chain: 0,
index: 117,
coin: 'hteth',
wallet: ethWalletV5.id(),
coinSpecific: {
forwarderVersion: 4,
salt: '0x75',
feeAddress: '0xb1e725186990b86ca8efed08a3ccda9c9f400f09',
},
});

await ethWalletV5.createAddress({ chain: 0 });

// Verify isWalletAddress was called with walletVersion 5
isWalletAddressSpy.calledOnce.should.be.true();
const calledParams = isWalletAddressSpy.firstCall.args[0];
calledParams.should.have.property('walletVersion', 5);
});

it('should pass walletVersion 2 to isWalletAddress during address creation', async function () {
const bgUrl = common.Environments[bitgo.getEnv()].uri;
const ethCoin = bitgo.coin('hteth') as Hteth;
const walletDataV2 = {
id: '598f606cd8fc24710d2ebadb1d9459bb',
coinSpecific: {
baseAddress: '0xdc485da076ed4a2b19584e9a1fdbb974f89b60f4',
walletVersion: 2,
},
coin: 'hteth',
keys: [
'598f606cd8fc24710d2ebad89dce86c2',
'598f606cc8e43aef09fcb785221d9dd2',
'5935d59cf660764331bafcade1855fd7',
],
receiveAddress: {
address: '0xdc485da076ed4a2b19584e9a1fdbb974f89b60f4',
},
};
const ethWalletV2 = new Wallet(bitgo, ethCoin, walletDataV2);
const isWalletAddressSpy = sinon.spy(ethCoin, 'isWalletAddress');

// Mock keychain requests
nock(bgUrl).get(`/api/v2/hteth/key/598f606cd8fc24710d2ebad89dce86c2`).reply(200, {
id: '598f606cd8fc24710d2ebad89dce86c2',
pub: 'xpub661MyMwAqRbcGrCxCX39zb3TvYjTqfUGwEUZHjnraRFm1WeMw9gfCD1wwc2wUDmBBZ2TkccJMwf5eBTja8r3z6HMxoTZGW6nvyoJMQFsecv',
ethAddress: '0x9d16bb867b792c5e3bf636a0275f2db8601bd7d4',
source: 'user',
type: 'independent',
});
nock(bgUrl).get(`/api/v2/hteth/key/598f606cc8e43aef09fcb785221d9dd2`).reply(200, {
id: '598f606cc8e43aef09fcb785221d9dd2',
pub: 'xpub661MyMwAqRbcGKhdeC4nr1ta8d27xThtfFFHgbxWMrVb595meMS8i3fBMrTz8EdQMWBKHHKzxapGgheoMymVvRcQmaGDykRTBbtXqbiu9ps',
ethAddress: '0x2dfce5cfeb5c03fbe680cd39ac0d2b25399b7d22',
source: 'backup',
type: 'independent',
});
nock(bgUrl).get(`/api/v2/hteth/key/5935d59cf660764331bafcade1855fd7`).reply(200, {
id: '5935d59cf660764331bafcade1855fd7',
pub: 'xpub661MyMwAqRbcGzTn5eyNGDkb18R43nH79HokYLc5PXZM19V8UrbuLdVRaCQMs4EeCAjnqmoYXqfyusTU46WoZMDyLpmTzoUX66ZBwGFjt1a',
ethAddress: '0xb1e725186990b86ca8efed08a3ccda9c9f400f09',
source: 'bitgo',
type: 'independent',
});

// Mock address creation API
nock(bgUrl)
.post(`/api/v2/hteth/wallet/${ethWalletV2.id()}/address`)
.reply(200, {
id: '638a48c6c3dba40007a3497fa49a080c',
address: '0xf636ceddffe41d106586875c0e56dc8feb6268f7',
chain: 0,
index: 23,
coin: 'hteth',
wallet: ethWalletV2.id(),
coinSpecific: {
forwarderVersion: 2,
salt: '0x17',
},
});

await ethWalletV2.createAddress({ chain: 0 });

// Verify isWalletAddress was called with walletVersion 2
isWalletAddressSpy.calledOnce.should.be.true();
const calledParams = isWalletAddressSpy.firstCall.args[0];
calledParams.should.have.property('walletVersion', 2);
});

it('should fail v6 address creation if walletVersion was not passed (simulates old bug)', async function () {
const bgUrl = common.Environments[bitgo.getEnv()].uri;
const ethCoin = bitgo.coin('hteth') as Hteth;
const walletDataV6 = {
id: '598f606cd8fc24710d2ebadb1d9459bb',
coinSpecific: {
baseAddress: '0xdf07117705a9f8dc4c2a78de66b7f1797dba9d4e',
walletVersion: 6,
},
coin: 'hteth',
keys: [
'598f606cd8fc24710d2ebad89dce86c2',
'598f606cc8e43aef09fcb785221d9dd2',
'5935d59cf660764331bafcade1855fd7',
],
receiveAddress: {
address: '0xdf07117705a9f8dc4c2a78de66b7f1797dba9d4e',
},
};
const ethWalletV6 = new Wallet(bitgo, ethCoin, walletDataV6);

// Stub isWalletAddress to simulate the OLD bug where walletVersion was not passed
const originalIsWalletAddress = ethCoin.isWalletAddress.bind(ethCoin);
const isWalletAddressStub = sinon.stub(ethCoin, 'isWalletAddress').callsFake(async (params) => {
// Remove walletVersion to simulate the old bug
const paramsWithoutWalletVersion = { ...params };
delete (paramsWithoutWalletVersion as any).walletVersion;
return originalIsWalletAddress(paramsWithoutWalletVersion);
});

// Mock keychain requests
nock(bgUrl).get(`/api/v2/hteth/key/598f606cd8fc24710d2ebad89dce86c2`).reply(200, {
id: '598f606cd8fc24710d2ebad89dce86c2',
pub: 'xpub661MyMwAqRbcFXDcWD2vxuebcT1ZpTF4Vke6qmMW8yzddwNYpAPjvYEEL5jLfyYXW2fuxtAxY8TgjPUJLcf1C8qz9N6VgZxArKX4EwB8rH5',
commonKeychain:
'033b02aac4f038fef5118350b77d302ec6202931ca2e7122aad88994ffefcbc70a6069e662436236abb1619195232c41580204cb202c22357ed8f53e69eac5c69e',
source: 'user',
type: 'tss',
});
nock(bgUrl).get(`/api/v2/hteth/key/598f606cc8e43aef09fcb785221d9dd2`).reply(200, {
id: '598f606cc8e43aef09fcb785221d9dd2',
pub: 'xpub661MyMwAqRbcGhSaXikpuTC9KU88Xx9LrjKSw1JKsvXNgabpTdgjy7LSovh9ZHhcqhAHQu7uthu7FguNGdcC4aXTKK5gqTcPe4WvLYRbCSG',
commonKeychain:
'033b02aac4f038fef5118350b77d302ec6202931ca2e7122aad88994ffefcbc70a6069e662436236abb1619195232c41580204cb202c22357ed8f53e69eac5c69e',
source: 'backup',
type: 'tss',
});
nock(bgUrl).get(`/api/v2/hteth/key/5935d59cf660764331bafcade1855fd7`).reply(200, {
id: '5935d59cf660764331bafcade1855fd7',
pub: 'xpub661MyMwAqRbcFsXShW8R3hJsHNTYTUwzcejnLkY7KCtaJbDqcGkcBF99BrEJSjNZHeHveiYUrsAdwnjUMGwpgmEbiKcZWRuVA9HxnRaA3r3',
commonKeychain:
'033b02aac4f038fef5118350b77d302ec6202931ca2e7122aad88994ffefcbc70a6069e662436236abb1619195232c41580204cb202c22357ed8f53e69eac5c69e',
source: 'bitgo',
type: 'tss',
});

// Mock address creation API
nock(bgUrl)
.post(`/api/v2/hteth/wallet/${ethWalletV6.id()}/address`)
.reply(200, {
id: '638a48c6c3dba40007a3497fa49a080c',
address: '0xc012041dac143a59fa491db3a2b67b69bd78b685',
chain: 0,
index: 0,
coin: 'hteth',
wallet: ethWalletV6.id(),
coinSpecific: {
forwarderVersion: 4,
salt: '0x0',
feeAddress: '0xb1e725186990b86ca8efed08a3ccda9c9f400f09',
},
});

// Without walletVersion, address creation should fail because
// the code doesn't know to use TSS verification for v6 wallets
await assert.rejects(async () => ethWalletV6.createAddress({ chain: 0 }), UnexpectedAddressError);

isWalletAddressStub.restore();
});
});

describe('EVM Cross Chain Recovery', function () {
const baseUrl = common.Environments.test.etherscanBaseUrl as string;
it('should build a recovery transaction for hot wallet', async function () {
Expand Down
5 changes: 4 additions & 1 deletion modules/sdk-core/src/bitgo/wallet/wallet.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1380,7 +1380,10 @@ export class Wallet implements IWallet {
newAddress.baseAddress = baseAddress ?? _.get(this._wallet, 'coinSpecific.baseAddress');
newAddress.format = addressParams.format;

const verificationData: VerifyAddressOptions = _.merge({}, newAddress, { rootAddress });
const verificationData: VerifyAddressOptions = _.merge({}, newAddress, {
rootAddress,
walletVersion: _.get(this._wallet, 'coinSpecific.walletVersion'),
});

if (verificationData.error) {
throw new AddressGenerationError(verificationData.error);
Expand Down