feat: generate keypair and add to .env if one doesn't exist #5
Conversation
src/index.ts
Outdated
| @@ -45,7 +46,13 @@ export const getKeypairFromFile = async (filepath?: string) => { | |||
| export const getKeypairFromEnvironment = (variableName: string) => { | |||
| const secretKeyString = process.env[variableName]; | |||
| if (!secretKeyString) { | |||
| throw new Error(`Please set '${variableName}' in environment.`); | |||
| // Generate a new keypair if one doesn't exist and add it to a `.env` file | |||
There was a problem hiding this comment.
Having an easy way to save keypairs is good PR, but my concern with adding this to an existing function is that something called getKeypairFromEnvironment() shouldn't have any side effects. Generally things called get() should be fetching data, not changing it. Also I'm concerned if someone wants to get a keypair with a particular name, it doesn't exist, and they get it made - it's possible we could be silently throwing away errors. Maybe I have a keypair called TEMP_WALLET and run getKeypairFromEnvironment('TEMPORARY_WALLET') and what should have failed succeeds.
I'd called the code that appends keypairs something like appendKeypairToFile(). Whatever you think is the most obvious for users.
| @@ -79,3 +73,17 @@ export const getKeypairFromEnvironment = (variableName: string) => { | |||
| } | |||
| return Keypair.fromSecretKey(decodedSecretKey); | |||
| }; | |||
|
|
|||
| export const addKeypairToEnvironment = (variableName: string) => { | |||
There was a problem hiding this comment.
I'd expect something that adds a keypair to be addKeypairToEnvironment(keyPair: Keypair, name: string) - I think we might have discussed this on Slack.
There was a problem hiding this comment.
Separately, as your comment already notes, this adds a keypair to the .env file, rather than the environment itself. The function name should reflect that, ie addKeypairToEnvFile()
There was a problem hiding this comment.
Ah it looks like you already updated this, just didn't reply! Woo I can merge in now.
| const keypair = Keypair.generate(); | ||
| appendFileSync( | ||
| ".env", | ||
| `\n${variableName}=${JSON.stringify(Array.from(keypair.secretKey))}`, |
There was a problem hiding this comment.
Not super important, but this (JSON.stringify(Array.from(keypair.secretKey))) is useful elsewhere so worth pulling out and exporting as keypairToJSON() or similar.
Update
getKeypairFromEnvironmentto generate a new keypair and write it to a.envfile if one does not already exist with the providedvariableName.