-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### Description Add warnings about the derivation path default changing in the future. as per https://forum.celo.org/t/deprecating-the-celo-derivation-path/9229 ### Other changes add derivationPath to the output ### Tested yes new `account:new` tests https://app.warp.dev/block/bYdy5uQ3WsAUT7rj1bT19l ### Related issues Prework for #352 ### Backwards compatibility yes unless you count the output of the command which we do not as it is designed for humans to read. ### Documentation improved! <!-- start pr-codex --> --- ## PR-Codex overview This PR focuses on updates to the `@celo/celocli` and `@celo/cryptographic-utils` packages, including the addition of a warning about the new default ETH derivation path, improvements to the `NewAccount` command, and modifications to key generation functions. ### Detailed summary - `@celo/celocli`: Allow `account:new` command to run without a node. - Added warning about default ETH derivation path in future versions. - Updated `generateKeys`, `generateSeed`, and related functions with parameter documentation. - Adjusted `NewAccount` command to reflect new derivation path logic. - Updated test cases to verify new behavior with derivation paths. > ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your question}` <!-- end pr-codex -->
- Loading branch information
Showing
8 changed files
with
212 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@celo/cryptographic-utils': patch | ||
| '@celo/celocli': patch | ||
| --- | ||
|
|
||
| Add warning that ETH derivation path will be the default in a future major breaking change. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@celo/celocli': patch | ||
| --- | ||
|
|
||
| Fix: account:new can now be called without a node |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| import { testWithAnvilL2 } from '@celo/dev-utils/lib/anvil-test' | ||
| import fs from 'node:fs' | ||
| import path from 'node:path' | ||
| import Web3 from 'web3' | ||
| import { | ||
| stripAnsiCodesAndTxHashes, | ||
| stripAnsiCodesFromNestedArray, | ||
| testLocallyWithWeb3Node, | ||
| } from '../../test-utils/cliUtils' | ||
| import NewAccount from './new' | ||
|
|
||
| process.env.NO_SYNCCHECK = 'true' | ||
|
|
||
| testWithAnvilL2('account:set-name cmd', (web3: Web3) => { | ||
| const writeMock = jest.spyOn(NewAccount.prototype, 'log') | ||
| const consoleMock = jest.spyOn(console, 'log') | ||
|
|
||
| beforeEach(() => { | ||
| writeMock.mockClear() | ||
| consoleMock.mockClear() | ||
| }) | ||
| it('generates mnemonic and lets people know which derivation path is being used when called with no flags', async () => { | ||
| await testLocallyWithWeb3Node(NewAccount, [], web3) | ||
|
|
||
| expect(stripAnsiCodesFromNestedArray(writeMock.mock.calls)).toMatchInlineSnapshot(` | ||
| [ | ||
| [ | ||
| " | ||
| Using celo-legacy path (m/44'/52752'/0') for derivation. This will be switched to eth derivation path (m/44'/60'/0') next major version. | ||
| ", | ||
| ], | ||
| [ | ||
| " | ||
| This is not being stored anywhere. Save the mnemonic somewhere to use this account at a later point. | ||
| ", | ||
| ], | ||
| ] | ||
| `) | ||
|
|
||
| expect(deRandomize(consoleMock.mock.lastCall?.[0])).toMatchInlineSnapshot(` | ||
| "mnemonic: *** *** | ||
| derivationPath: m/44'/52752'/0' | ||
| accountAddress: ADDRESS | ||
| privateKey: PUBLIC_KEY | ||
| publicKey: PRIVATE_KEY | ||
| address: ADDRESS" | ||
| `) | ||
| }) | ||
| it("when called with --derivationPath eth flag generates mnemonic using m/44'/60'/0'", async () => { | ||
| await testLocallyWithWeb3Node(NewAccount, ['--derivationPath', 'eth'], web3) | ||
|
|
||
| expect(deRandomize(consoleMock.mock.lastCall?.[0])).toMatchInlineSnapshot(` | ||
| "mnemonic: *** *** | ||
| derivationPath: m/44'/60'/0' | ||
| accountAddress: ADDRESS | ||
| privateKey: PUBLIC_KEY | ||
| publicKey: PRIVATE_KEY | ||
| address: ADDRESS" | ||
| `) | ||
| }) | ||
|
|
||
| describe('when called with --mnemonicPath', () => { | ||
| const MNEMONIC_PATH = path.join(__dirname, 'public_mnemonic') | ||
| const TEST_mnemonic = | ||
| 'hamster label near volume denial spawn stable orbit trade only crawl learn forest fire test feel bubble found angle also olympic obscure fork venue' | ||
| beforeEach(() => { | ||
| fs.writeFileSync(MNEMONIC_PATH, TEST_mnemonic, { | ||
| flag: 'w', | ||
| }) | ||
| }) | ||
| afterEach(async () => { | ||
| fs.rmSync(MNEMONIC_PATH) | ||
| }) | ||
|
|
||
| it('generates using celo derivation path', async () => { | ||
| await testLocallyWithWeb3Node(NewAccount, [`--mnemonicPath`, MNEMONIC_PATH], web3) | ||
|
|
||
| expect(stripAnsiCodesAndTxHashes(consoleMock.mock.lastCall?.[0])).toMatchInlineSnapshot(` | ||
| "mnemonic: hamster label near volume denial spawn stable orbit trade only crawl learn forest fire test feel bubble found angle also olympic obscure fork venue | ||
| derivationPath: m/44'/52752'/0' | ||
| accountAddress: 0x0a85BeCD036C86faD4Db5519634904be2021fb7d | ||
| privateKey: 6346d0cd7cfdb7904f08df48e442169d3333643de0351682f8b79cf714395471 | ||
| publicKey: 02269b3efc9c4c6b81037d06e73e936078e625fb0f12b9ea1e0fd14d2cd45775f2 | ||
| address: 0x0a85BeCD036C86faD4Db5519634904be2021fb7d" | ||
| `) | ||
| }) | ||
|
|
||
| it("and --derivationPath m/44'/60'/0' generates using eth derivation path", async () => { | ||
| await testLocallyWithWeb3Node( | ||
| NewAccount, | ||
| [`--mnemonicPath`, MNEMONIC_PATH, '--derivationPath', "m/44'/60'/0'"], | ||
| web3 | ||
| ) | ||
|
|
||
| expect(stripAnsiCodesAndTxHashes(consoleMock.mock.lastCall?.[0])).toMatchInlineSnapshot(` | ||
| "mnemonic: hamster label near volume denial spawn stable orbit trade only crawl learn forest fire test feel bubble found angle also olympic obscure fork venue | ||
| derivationPath: m/44'/60'/0' | ||
| accountAddress: 0x35A4d54B541fc7b2047fb5357cC706191E105cd3 | ||
| privateKey: e4816cbb93346760921264ea38a7fc54903f4dd688ae0923fefd89a43c5f58cc | ||
| publicKey: 034b3036d657a6dc2f322db52cca29ae72101a9cf56de4765d17b0507ea1e87b7c | ||
| address: 0x35A4d54B541fc7b2047fb5357cC706191E105cd3" | ||
| `) | ||
| }) | ||
| it("and --derivationPath m/44'/60'/0' and --changeIndex generates using eth derivation path", async () => { | ||
| await testLocallyWithWeb3Node( | ||
| NewAccount, | ||
| [`--mnemonicPath`, MNEMONIC_PATH, '--derivationPath', 'eth', '--changeIndex', '2'], | ||
| web3 | ||
| ) | ||
|
|
||
| expect(stripAnsiCodesAndTxHashes(consoleMock.mock.lastCall?.[0])).toMatchInlineSnapshot(` | ||
| "mnemonic: hamster label near volume denial spawn stable orbit trade only crawl learn forest fire test feel bubble found angle also olympic obscure fork venue | ||
| derivationPath: m/44'/60'/0' | ||
| accountAddress: 0xb3492799c55141e0B3507302F241f1c34c08E1e2 | ||
| privateKey: 3abc861ef3e9e31a6a7dc23e5903e41b3fe4a381d4fbb8f9db14e6730abd1c43 | ||
| publicKey: 0280df4d09cf8ebcad418327287be3f4ba0054112544ffa290ab3cc0a87949b32a | ||
| address: 0xb3492799c55141e0B3507302F241f1c34c08E1e2" | ||
| `) | ||
| }) | ||
| it('and --derivationPath eth and --addressIndex generates using eth derivation path', async () => { | ||
| await testLocallyWithWeb3Node( | ||
| NewAccount, | ||
| [`--mnemonicPath`, MNEMONIC_PATH, '--derivationPath', 'eth', '--addressIndex', '3'], | ||
| web3 | ||
| ) | ||
|
|
||
| expect(stripAnsiCodesAndTxHashes(consoleMock.mock.lastCall?.[0])).toMatchInlineSnapshot(` | ||
| "mnemonic: hamster label near volume denial spawn stable orbit trade only crawl learn forest fire test feel bubble found angle also olympic obscure fork venue | ||
| derivationPath: m/44'/60'/0' | ||
| accountAddress: 0x336E523118B6091e033F9715257e2E793002964c | ||
| privateKey: aa324b2efd0ebe6387c3bcf03387c78047d82a1d2e8b4e132e9e1b9fb93529d0 | ||
| publicKey: 0394cc7cc524079c545aef2067c9ea7e69decb4815004afecf215ea1e6f370ce6c | ||
| address: 0x336E523118B6091e033F9715257e2E793002964c" | ||
| `) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| function deRandomize(rawOutput: string) { | ||
| return stripAnsiCodesAndTxHashes(rawOutput) | ||
| .replace(/0x[A-Fa-f0-9]{40}/g, 'ADDRESS') | ||
| .replace(/ [A-Fa-f0-9]{66}/g, ' PRIVATE_KEY') | ||
| .replace(/ [A-Fa-f0-9]{64}/g, ' PUBLIC_KEY') | ||
| .replace(/mnemonic: ([a-z]+\s)+/, 'mnemonic: *** *** \n') | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters