[BA-2207] Adds script to generate jwks well known file & the private key#34
Closed
sakethkotamraju wants to merge 9 commits intoMobileWalletProtocol:domain-verificationfrom
Conversation
- domain verification key generation script for well known file - yarn generate-key-script - readme doc on how to use it
montycheese
reviewed
Jun 29, 2025
Comment on lines
19
to
21
| const cwdArgIndex = process.argv.indexOf('--cwd'); | ||
| if (cwdArgIndex !== -1 && process.argv[cwdArgIndex + 1]) { | ||
| return process.argv[cwdArgIndex + 1]; |
Collaborator
There was a problem hiding this comment.
this isn't documented anywhere - but we likely don't need it anyways.
| x, | ||
| y, | ||
| use: 'sig', | ||
| kid: 'coinbase-domain-verification', |
| try { | ||
| const outputDir = getOutputDir(); | ||
|
|
||
| console.log('🔑 Generating Coinbase domain verification keys...\n'); |
Comment on lines
69
to
70
| const wellKnownDir = join(outputDir, '.well-known'); | ||
| mkdirSync(wellKnownDir, { recursive: true }); |
Collaborator
There was a problem hiding this comment.
I don't think we need to output it to a local directory called .well-known. also its currently but created as a hidden directory which might be annoying
- no .well-known output directory - changed 'Coinbase' to 'base'
montycheese
reviewed
Jul 1, 2025
Collaborator
montycheese
left a comment
montycheese
left a comment
There was a problem hiding this comment.
Lgtm. One small update. I'm going to pull locally to verify running locally before approving
|
|
||
| function main() { | ||
| try { | ||
| console.log('🔑 Generating Coinbase domain verification keys...\n'); |
Collaborator
There was a problem hiding this comment.
Suggested change
| console.log('🔑 Generating Coinbase domain verification keys...\n'); | |
| console.log('🔑 Generating Base domain verification keys...\n'); |
montycheese
reviewed
Jul 8, 2025
| function generateDomainVerificationKeys() { | ||
| // Generate a random private key | ||
| const privateKeyBytes = randomBytes(32); | ||
| const privateKey = base64url(privateKeyBytes); |
Collaborator
There was a problem hiding this comment.
Does this need to be in base 64?
montycheese
reviewed
Jul 8, 2025
verify-signature.js
Outdated
| @@ -0,0 +1,68 @@ | |||
| const crypto = require('crypto'); | |||
Collaborator
There was a problem hiding this comment.
move this to scripts/verify-domain-keys-test.js
fan-zhang-sv
reviewed
Jul 8, 2025
| ``` | ||
|
|
||
| ## Output | ||
| - `.well-known/base-jwks.json`: Public key in JWKS format for domain verification |
Collaborator
There was a problem hiding this comment.
i think the output here is just base-jwk.json? cuz the file is generated in projectRoot/base-jek.json
- doesn't base64 encode the private key - yarn validate-key-script for testing sec256kp1 encoding/decoding.
fan-zhang-sv
approved these changes
Jul 11, 2025
montycheese
approved these changes
Jul 14, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
https://linear.app/coinbase/issue/BA-2207/wsdk-create-script-to-generate-well-known-jwks-file-as-well-as-the
Generates the sec256k1 public key & outputs it in the base-jwks.json file. It also outputs the corresponding private key in the domain-verification-private-key.txt file. I also made a docs/domain-verification-key-generation readme file for instructions on how to do all of this.
How did you test your changes?
I ran the command and verified the generated output contents were accurate and outputted in the correct folder/file path.
Screen.Recording.2025-06-27.at.9.16.05.AM.mov