Skip to content
This repository has been archived by the owner on May 16, 2024. It is now read-only.

Commit

Permalink
Dx 2255 (#351)
Browse files Browse the repository at this point in the history 
* DX-2255: WIP Updated tests to compare numbers instead of strings
Co-authored-by: Carl Menezes <[email protected]>

* DX-2255: Updated generate legacy key logic to also use number comparision instead of string

* DX-2255: Fixed errors

* DX-2255: Linter fix
  • Loading branch information
@suluvai
suluvai authored Jul 27, 2023
1 parent e688709 commit e1e3c80
Show file tree
Hide file tree
Showing 2 changed files with 132 additions and 142 deletions.
240 changes: 105 additions & 135 deletions src/utils/stark/starkCurve.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
} from './starkCurve';
import { grindKey } from './legacy/crypto';
import { createStarkSigner } from './starkSigner';
import * as encUtils from 'enc-utils';

describe('Key generation', () => {
it('should generate random Stark key', async () => {
Expand All @@ -22,141 +23,110 @@ describe('Key generation', () => {
);
});

it('should generate Legacy Stark public key', async () => {
const signer = new Wallet(
'5c7b4b5cad9a3fc7b1ba235a49cd74e615488a18b0d6a531739fd1062935104d',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x0579f97e8084dfbbead9bffd750df780e06d8c09a3ba7f40ebe51d46b47df043',
);
});

it('Random Eth Private Key hashed with no index, should generate correct legacy (imx-sdk-js) stark key', async () => {
const signer = new Wallet(
'0x4aee6bb7807a684341e39303fb1292f1c66b0f0bcac81407d10e80ba9202fc4a',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x3c35bb183cc613d57e6c823a6c7a17a14fba9dc65a5ece97a87020e32cbbd9', // Compatible with legacy.GrindKey, With Expected Index of 0,0,0,... // Hash Iterated 0 times
);
});

it('Eth Private Key hashed with index once, should generate correct legacy (imx-sdk-js) stark key', async () => {
const signer = new Wallet(
'0xabb730db6bd22a773263c9266b0e157e6a9985c75ff68c68fdebdef3e500892c',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x0743a17b8a566fe39cfebc41db631210bf328b91ae6c3968f1f9a96ac48a02aa', // Compatible with legacy.GrindKey, With Expected Index of 0,0,0,... // Hash Iterated 1 time
);
});

it('Eth Private Key hashed with index more than once, should generate correct legacy (imx-sdk-js) stark key', async () => {
const signer = new Wallet(
'0x2b9b32d0ed8863016001ffb15af781dca725b1581a3d4d61c0e2c4c0c03ede8a',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x07d14076863573a2310a948472512331416ceb655a304b1811a127e6c710e350', // Compatible with legacy.GrindKey, with Expected Index of 0,0,0,... // Hash Iterated 2 times
);
});

it('Eth Private Key hashed with index once, should generate Legacy Stark key backwards compatible with versions between 1.0.0-beta.3 to 2.0.0', async () => {
const signer = new Wallet(
'0x1a245f2fa7c4f04a65d45a3877ad00b1423d081490dcc1a7050c8d7c11ec5c8f',
);

const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x07ca61905954bdd858ae63704b111da5ca52b30a21fa9aaeee9aef9b24e89607', // Compatible with GrindKeyV1, with Expected Index of 0,1,2,... // Hash Iterated 1 time
);
});

it('Eth Private Key hashed with index more than once, should generate Legacy Stark key backwards compatible with versions between 1.0.0-beta.3 to 2.0.0', async () => {
const signer = new Wallet(
'0xe516a5b715dc53ba4bf06ed98cbe50897921f45f76d4138f8a7d4ba02a89e10d',
);

const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x0157c6efcb2c69604c1b46ffeb568b3b10ea7093da762e1daf66b59d9b63b5f9', // Compatible with GrindKeyV1, with Expected Index of 0,1,2,... // Hash Iterated 2 times
);
});

it('should generate Legacy Stark key backwards compatible with versions between 1.0.0-beta.3 to 2.0.0', async () => {
const signer = new Wallet(
'ba3c969f4957e6bf24e5cf8a931bdba4f90d27c01bb7dff738e4593142826db7',
);

const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x04eb684f7318d2b90ef8703e6cd77e362414f4997934ee3c99ee50db3411dfef', // Compatible with GrindKeyV1, with Expected Index of 0,1,2,... // Hash Iterated 0 times
);
});

it('Eth Private Key hashed with index once, should generate Legacy Stark key backwards compatible with version 2.0.1', async () => {
const signer = new Wallet(
'0xa25022c521d884d195c119b705ac515fabb48971d3cf2369f188c96b0e6404ef',
);

const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x03aa9edf4a5b33f623d3dd37a6df62e5590f172fd4d1a9483532464aa13bcbb9', // Compatible with core-sdk GrindKey, with Expected Index of 0,0,1,... // Hash Iterated 1 time
);
});

it('Eth Private Key hashed with index more than once, should generate Legacy Stark key backwards compatible with version 2.0.1', async () => {
const signer = new Wallet(
'0x719b531dfdbf5e327646ccd992923c9d8846d60767b49d0589d631c1f54d1f12',
);

const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x057a8278637277ebaaa63b000185507eb847eec8f69c7758fc10a490d0226e7d', // Compatible with core-sdk GrindKey, with Expected Index of 0,0,1,... // Hash Iterated 2 times
);
});

it('Eth Private Key hashed with index once, should generate correct stark key', async () => {
const signer = new Wallet(
'0xe7ecb8f91175446248a6cfa45a9526c85bc4cd7cbd9427e3e65a82d3f5fb8cdc',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x05f8f00b03e896cb8c02a936bab73623fc3651fddabfe0d28fbc309c63642c10', // Hash Iterated 1 time
);
});

it('Eth Private Key hashed with index more than once, should generate correct stark key', async () => {
const signer = new Wallet(
'0x82930dfa052b198828f70529148b02178b03515e910217dab32bf9fc046bc9d9',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x04d34c9f519b2a3538b02c4e939188b591065eb8c2f210277c6ed1de85b16fab', // Hash Iterated 2 times
);
});

it('Random Eth Private Key hashed with no index, should generate correct legacy stark key', async () => {
const signer = new Wallet(
'0x0ac63e2143a49a14a87d865c8d7993806ff16ac1c3288ff97101569881f0d306',
);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = createStarkSigner(starkKey).getAddress();
expect(starkPublicKey).toEqual(
'0x06e6ac4bb44f3295b881532452f90eccb5601314fafe306db17684b47aa388bd', // Hash Iterated 0 times
);
describe('Stark Key', () => {
const tests = [
{
name: 'case 1 - Should generate Legacy Stark public key',
privateKey:
'5c7b4b5cad9a3fc7b1ba235a49cd74e615488a18b0d6a531739fd1062935104d',
wantPublicKey:
'0x0579f97e8084dfbbead9bffd750df780e06d8c09a3ba7f40ebe51d46b47df043',
},
{
name: 'case 2 - Random Eth Private Key hashed with no index, should generate correct legacy (imx-sdk-js) stark key',
privateKey:
'0x4aee6bb7807a684341e39303fb1292f1c66b0f0bcac81407d10e80ba9202fc4a',
wantPublicKey:
'0x3c35bb183cc613d57e6c823a6c7a17a14fba9dc65a5ece97a87020e32cbbd9', // Compatible with legacy.GrindKey, With Expected Index of 0,0,0,... // Hash Iterated 0 times
},
{
name: 'case 3 - Eth Private Key hashed with index once, should generate correct legacy (imx-sdk-js) stark key',
privateKey:
'0xabb730db6bd22a773263c9266b0e157e6a9985c75ff68c68fdebdef3e500892c',
wantPublicKey:
'0x0743a17b8a566fe39cfebc41db631210bf328b91ae6c3968f1f9a96ac48a02aa', // Compatible with legacy.GrindKey, With Expected Index of 0,0,0,... // Hash Iterated 1 time
},
{
name: 'case 4 - Eth Private Key hashed with index more than once, should generate correct legacy (imx-sdk-js) stark key',
privateKey:
'0x2b9b32d0ed8863016001ffb15af781dca725b1581a3d4d61c0e2c4c0c03ede8a',
wantPublicKey:
'0x07d14076863573a2310a948472512331416ceb655a304b1811a127e6c710e350', // Compatible with legacy.GrindKey, with Expected Index of 0,0,0,... // Hash Iterated 2 times
},
{
name: 'case 5 - Eth Private Key hashed with index once, should generate Legacy Stark key compatible with versions between 1.0.0-beta.3 to 2.0.0, 2.0.2 and above',
privateKey:
'0x1a245f2fa7c4f04a65d45a3877ad00b1423d081490dcc1a7050c8d7c11ec5c8f',
wantPublicKey:
'0x07ca61905954bdd858ae63704b111da5ca52b30a21fa9aaeee9aef9b24e89607', // Compatible with GrindKey, with Expected Index of 0,1,2,... // Hash Iterated 1 time
},
{
name: 'case 6 - Eth Private Key hashed with index more than once, should generate Legacy Stark key compatible with versions between 1.0.0-beta.3 to 2.0.0, 2.0.2 and above',
privateKey:
'0xe516a5b715dc53ba4bf06ed98cbe50897921f45f76d4138f8a7d4ba02a89e10d',
wantPublicKey:
'0x0157c6efcb2c69604c1b46ffeb568b3b10ea7093da762e1daf66b59d9b63b5f9', // Compatible with GrindKey, with Expected Index of 0,1,2,... // Hash Iterated 2 times
},
{
name: 'case 7 - should generate Legacy Stark key compatible with versions between 1.0.0-beta.3 to 2.0.0, 2.0.2 and above',
privateKey:
'ba3c969f4957e6bf24e5cf8a931bdba4f90d27c01bb7dff738e4593142826db7',
wantPublicKey:
'0x04eb684f7318d2b90ef8703e6cd77e362414f4997934ee3c99ee50db3411dfef', // Compatible with GrindKey, with Expected Index of 0,1,2,... // Hash Iterated 0 times
},
{
name: 'case 8 - Eth Private Key hashed with index once, should generate Legacy Stark key backwards compatible with version 2.0.1',
privateKey:
'0xa25022c521d884d195c119b705ac515fabb48971d3cf2369f188c96b0e6404ef',
wantPublicKey:
'0x03aa9edf4a5b33f623d3dd37a6df62e5590f172fd4d1a9483532464aa13bcbb9', // Compatible with core-sdk GrindKey, with Expected Index of 0,0,1,... // Hash Iterated 1 time
},
{
name: 'case 9 - Eth Private Key hashed with index more than once, should generate Legacy Stark key backwards compatible with version 2.0.1',
privateKey:
'0x719b531dfdbf5e327646ccd992923c9d8846d60767b49d0589d631c1f54d1f12',
wantPublicKey:
'0x057a8278637277ebaaa63b000185507eb847eec8f69c7758fc10a490d0226e7d', // Compatible with core-sdk GrindKey, with Expected Index of 0,0,1,... // Hash Iterated 2 times
},
{
name: 'case 10 - Eth Private Key hashed with index once, should generate correct stark key',
privateKey:
'0xe7ecb8f91175446248a6cfa45a9526c85bc4cd7cbd9427e3e65a82d3f5fb8cdc',
wantPublicKey:
'0x05f8f00b03e896cb8c02a936bab73623fc3651fddabfe0d28fbc309c63642c10', // Hash Iterated 1 time
},
{
name: 'case 11 - Eth Private Key hashed with index more than once, should generate correct stark key',
privateKey:
'0x82930dfa052b198828f70529148b02178b03515e910217dab32bf9fc046bc9d9',
wantPublicKey:
'0x04d34c9f519b2a3538b02c4e939188b591065eb8c2f210277c6ed1de85b16fab', // Hash Iterated 2 times
},
{
name: 'case 12 - Random Eth Private Key hashed with no index, should generate correct legacy stark key',
privateKey:
'0x0ac63e2143a49a14a87d865c8d7993806ff16ac1c3288ff97101569881f0d306',
wantPublicKey:
'0x06e6ac4bb44f3295b881532452f90eccb5601314fafe306db17684b47aa388bd', // Hash Iterated 0 times
},
];
tests.forEach(test => {
it(test.name, async () => {
const expectedStarkPubKeyBN = new BN(
encUtils.removeHexPrefix(test.wantPublicKey),
16,
);

const signer = new Wallet(test.privateKey);
const starkKey = await generateLegacyStarkPrivateKey(signer);
const starkPublicKey = await createStarkSigner(starkKey).getAddress();
const starkPublicKeyBN = new BN(
encUtils.removeHexPrefix(starkPublicKey),
16,
);
expect(starkPublicKeyBN).toEqual(expectedStarkPubKeyBN);
});
});
});
});

Expand Down
34 changes: 27 additions & 7 deletions src/utils/stark/starkCurve.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,15 +212,27 @@ async function getKeyFromPath(
// If the account is not found or account matches we just return the key pair at the end of this method.
// Only need to so alternative method if the account is found but the stark public key does not match.

if (imxResponse === undefined) {
throw new Error('Error fetching stark public key from IMX');
}

// If the account is not found it is a new account, just return the Stark Private Key that is generated by grindKey function.
if (imxResponse?.accountNotFound) {
if (imxResponse.accountNotFound) {
return starkPrivateKey;
}

const registeredStarkPublicKeyBN = new BN(
encUtils.removeHexPrefix(imxResponse.starkPublicKey),
16,
);

let starkPublicKey = await createStarkSigner(starkPrivateKey).getAddress();

// If the user account matches with generated stark public key user, just return Stark Private Key.
if (
imxResponse?.starkPublicKey ===
createStarkSigner(starkPrivateKey).getAddress()
registeredStarkPublicKeyBN.eq(
new BN(encUtils.removeHexPrefix(starkPublicKey), 16),
)
) {
return starkPrivateKey;
}
Expand All @@ -231,9 +243,14 @@ async function getKeyFromPath(
// If we are here, we found the account but did not match with the recorded user account.
// Lets try to use grindKeyV201 method from backwards compatible logic to generate a key and see if that matches.
const starkPrivateKeyV201Compatible = grindKeyV201(privateKeySeed);
starkPublicKey = await createStarkSigner(
starkPrivateKeyV201Compatible,
).getAddress();

if (
imxResponse?.starkPublicKey ===
createStarkSigner(starkPrivateKeyV201Compatible).getAddress()
registeredStarkPublicKeyBN.eq(
new BN(encUtils.removeHexPrefix(starkPublicKey), 16),
)
) {
return starkPrivateKeyV201Compatible;
}
Expand All @@ -243,13 +260,16 @@ async function getKeyFromPath(

const privateKeyString = legacy.getPrivateKeyFromPath(seed, path);
const starkPrivateKeyLegacy = legacy.grindKey(privateKeyString);
starkPublicKey = await createStarkSigner(starkPrivateKeyLegacy).getAddress();

if (
imxResponse?.starkPublicKey ===
createStarkSigner(starkPrivateKeyLegacy).getAddress()
registeredStarkPublicKeyBN.eq(
new BN(encUtils.removeHexPrefix(starkPublicKey), 16),
)
) {
return starkPrivateKeyLegacy;
}

// >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

// Account is found, but did not match with stark public keys generated by either grindKey or grindKeyV1 method.
Expand Down

0 comments on commit e1e3c80

Please sign in to comment.