Merge pull request #5 from solana-developers/add-env-keypair

feat: generate keypair and add to .env if one doesn't exist

.gitignore

@@ -1,2 +1,3 @@
 src/temp
 dist
+node_modules

package.json

@@ -21,6 +21,7 @@
   "dependencies": {
     "@digitak/esrun": "^3.2.24",
     "bs58": "^5.0.0",
+    "dotenv": "^16.3.1",
     "prettier": "^3.0.3",
     "typescript": "^5.2.2"
   },

src/index.test.ts

@@ -1,12 +1,19 @@
-import { describe, test, before } from "node:test";
+import { before, describe, test } from "node:test";
+import {
+  getKeypairFromEnvironment,
+  getKeypairFromFile,
+  addKeypairToEnvironment,
+} from "./index";
+
+import { Keypair } from "@solana/web3.js";
 import assert from "node:assert/strict";
-import { promisify } from "util";
+import base58 from "bs58";
 import { exec as execForOldPeople } from "child_process";
+import { promisify } from "util";
+import { writeFile, unlink } from "node:fs/promises";
+import dotenv from "dotenv";
+
 const exec = promisify(execForOldPeople);
-import { Keypair } from "@solana/web3.js";
-import { getKeypairFromFile, getKeypairFromEnvironment } from "./index";
-import { writeFile } from "node:fs/promises";
-import base58 from "bs58";
 
 const log = console.log;
 
@@ -83,3 +90,43 @@ describe("getKeypairFromEnvironment", () => {
     );
   });
 });
+
+describe("addKeypairToEnvironment", () => {
+  let TEST_ENV_VAR_ARRAY_OF_NUMBERS = "TEST_ENV_VAR_ARRAY_OF_NUMBERS";
+
+  before(async () => {
+    const randomKeypair = Keypair.generate();
+
+    process.env[TEST_ENV_VAR_ARRAY_OF_NUMBERS] = JSON.stringify(
+      Object.values(randomKeypair.secretKey),
+    );
+  });
+
+  test("generates new keypair and writes to env if variable doesn't exist", async () => {
+    // Generates new keypair and writes it to the .env file
+    addKeypairToEnvironment("TEMP_KEYPAIR");
+    // Load the .env file
+    dotenv.config();
+    // Get the secret from the .env file
+    const secretKeyString = process.env["TEMP_KEYPAIR"];
+
+    if (!secretKeyString) {
+      throw new Error("TEMP_KEYPAIR not found in environment");
+    }
+    const decodedSecretKey = Uint8Array.from(JSON.parse(secretKeyString));
+    const envKeypair = Keypair.fromSecretKey(decodedSecretKey);
+
+    assert.ok(envKeypair.secretKey);
+
+    unlink(".env");
+  });
+
+  test("throws a nice error if the env var already exists", async () => {
+    assert.rejects(
+      async () => addKeypairToEnvironment(TEST_ENV_VAR_ARRAY_OF_NUMBERS),
+      {
+        message: `'TEST_ENV_VAR_ARRAY_OF_NUMBERS' already exists in environment.`,
+      },
+    );
+  });
+});

src/index.ts

@@ -1,7 +1,8 @@
 import { Keypair } from "@solana/web3.js";
-import { readFile } from "fs/promises";
 import base58 from "bs58";
 import path from "path";
+import { readFile } from "fs/promises";
+import { appendFileSync } from "node:fs";
 const log = console.log;
 
 // Default value from Solana CLI
@@ -72,3 +73,17 @@ export const getKeypairFromEnvironment = (variableName: string) => {
   }
   return Keypair.fromSecretKey(decodedSecretKey);
 };
+
+export const addKeypairToEnvironment = (variableName: string) => {
+  const secretKeyString = process.env[variableName];
+  if (!secretKeyString) {
+    // Generate a new keypair if one doesn't exist and add it to a `.env` file
+    const keypair = Keypair.generate();
+    appendFileSync(
+      ".env",
+      `\n${variableName}=${JSON.stringify(Array.from(keypair.secretKey))}`,
+    );
+  } else {
+    throw new Error(`'${variableName}' already exists in environment.`);
+  }
+};