feat(scripts): add MACI key generation script #1869

programmerraja · 2024-10-23T23:30:48Z

Description

add MACI key generation script
- Add generateMaciKeys.js script
- Update package.json with new script command
- Update .gitignore to exclude maci-keys directory

feat for #1861

Additional Notes

Related issue(s)

Confirmation

I have read and understand MACI's contributor guidelines and code of conduct.
I have read and understand MACI's GitHub processes.
I have read and understand MACI's testing guide.

- Add generateMaciKeys.js script - Update package.json with new script command - Update .gitignore to exclude maci-keys directory

vercel · 2024-10-23T23:30:51Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
maci-website	❌ Failed (Inspect)		Oct 28, 2024 3:05pm

0xmad

@programmerraja thanks, there are some changes requested

0xmad · 2024-10-25T17:37:28Z

scripts/generateMaciKeys.js

Please use typescript

0xmad · 2024-10-25T17:38:01Z

scripts/generateMaciKeys.js

+    publicKey: pubKey.toString(),
+  };
+
+  const outputDir = path.join(__dirname, "..", "maci-keys");


Suggested change

const outputDir = path.join(__dirname, "..", "maci-keys");

const outputDir = path.resolve(__dirname, "..", "maci-keys");

0xmad · 2024-10-25T17:38:12Z

scripts/generateMaciKeys.js

+    fs.mkdirSync(outputDir, { recursive: true });
+  }
+
+  const outputFile = path.join(outputDir, "maci-keys.json");


Suggested change

const outputFile = path.join(outputDir, "maci-keys.json");

const outputFile = path.resolve(outputDir, "maci-keys.json");

0xmad · 2024-10-25T17:38:34Z

scripts/generateMaciKeys.js

+  if (!fs.existsSync(outputDir)) {
+    fs.mkdirSync(outputDir, { recursive: true });
+  }


Use async version here

0xmad · 2024-10-25T17:38:48Z

scripts/generateMaciKeys.js

+  }
+
+  const outputFile = path.join(outputDir, "maci-keys.json");
+  fs.writeFileSync(outputFile, JSON.stringify(keys, null, 2));


The same with async

programmerraja · 2024-10-26T03:44:23Z

@0xmad can you check and let me know anything else i want to change

0xmad · 2024-10-28T14:50:43Z

scripts/generateMaciKeys.ts

+import { promises as fs } from "fs";
+import * as path from "path";


Suggested change

import { promises as fs } from "fs";

import * as path from "path";

import fs from "fs";

import path from "path";

0xmad · 2024-10-28T14:50:55Z

scripts/generateMaciKeys.ts

+
+  const outputDir = path.resolve(__dirname, "..", "maci-keys");
+  try {
+    await fs.access(outputDir);


Suggested change

await fs.access(outputDir);

await fs.promises.access(outputDir);

And the same change for other fs calls

@0xmad done can you check

ctrlc03

I'm not sure writing coordinator keys to disk is something we should be encouraging. I'd probably only let the script print to console (basically just call the cli script using pnpm: node build/ts/index.js genMaciKeyPair)

…ci-script

programmerraja · 2024-11-01T04:05:33Z

@0xmad is everything fine or did i need to do any changes?

0xmad · 2024-11-01T14:33:59Z

I'm not sure writing coordinator keys to disk is something we should be encouraging. I'd probably only let the script print to console (basically just call the cli script using pnpm: node build/ts/index.js genMaciKeyPair)

@programmerraja here is a question and also there are failed ci jobs.

programmerraja · 2024-11-01T14:36:35Z

@0xmad can you give me guidance what next I need to do

0xmad · 2024-11-01T14:46:18Z

@0xmad can you give me guidance what next I need to do

You need to fix the errors from ci job so they are passed, squash all the commits into one and answer the question @ctrlc03 asked.

feat(scripts): add MACI key generation script

1ae8ad1

- Add generateMaciKeys.js script - Update package.json with new script command - Update .gitignore to exclude maci-keys directory

programmerraja requested review from ctrlc03, kittybest, 0xmad and crisgarner as code owners October 23, 2024 23:30

vercel bot had a problem deploying to Preview October 23, 2024 23:31 Failure

programmerraja mentioned this pull request Oct 23, 2024

Create a pnpm script to generate MACI keys #1861

Open

Fix (prettier) run a prettier fix

9cc4a09

vercel bot had a problem deploying to Preview October 23, 2024 23:58 Failure

0xmad requested changes Oct 25, 2024

View reviewed changes

Feat (script) converted the scrpit to ts

4d38399

vercel bot had a problem deploying to Preview October 26, 2024 03:44 Failure

0xmad reviewed Oct 28, 2024

View reviewed changes

ctrlc03 reviewed Oct 28, 2024

View reviewed changes

programmerraja added 3 commits October 28, 2024 20:29

Fix (maci) changed fs import way

176b575

Fix (pkg) updated pkg json for maci script

e5995a2

Merge branch 'dev' of programmerraja:programmerraja/maci into feat/ma…

84ad290

…ci-script

vercel bot had a problem deploying to Preview October 28, 2024 15:05 Failure

ctrlc03 self-requested a review October 28, 2024 15:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(scripts): add MACI key generation script #1869

feat(scripts): add MACI key generation script #1869

programmerraja commented Oct 23, 2024 •

edited

Loading

vercel bot commented Oct 23, 2024 •

edited

Loading

0xmad left a comment

0xmad Oct 25, 2024

0xmad Oct 25, 2024

0xmad Oct 25, 2024

0xmad Oct 25, 2024

0xmad Oct 25, 2024

programmerraja commented Oct 26, 2024

0xmad Oct 28, 2024

0xmad Oct 28, 2024

0xmad Oct 28, 2024

programmerraja Oct 28, 2024

ctrlc03 left a comment

programmerraja commented Nov 1, 2024

0xmad commented Nov 1, 2024

programmerraja commented Nov 1, 2024

0xmad commented Nov 1, 2024

	const outputDir = path.join(__dirname, "..", "maci-keys");
	const outputDir = path.resolve(__dirname, "..", "maci-keys");

	const outputFile = path.join(outputDir, "maci-keys.json");
	const outputFile = path.resolve(outputDir, "maci-keys.json");

		import { promises as fs } from "fs";
		import * as path from "path";

	await fs.access(outputDir);
	await fs.promises.access(outputDir);

feat(scripts): add MACI key generation script #1869

Are you sure you want to change the base?

feat(scripts): add MACI key generation script #1869

Conversation

programmerraja commented Oct 23, 2024 • edited Loading

Description

Additional Notes

Related issue(s)

Confirmation

vercel bot commented Oct 23, 2024 • edited Loading

0xmad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

programmerraja commented Oct 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ctrlc03 left a comment

Choose a reason for hiding this comment

programmerraja commented Nov 1, 2024

0xmad commented Nov 1, 2024

programmerraja commented Nov 1, 2024

0xmad commented Nov 1, 2024

programmerraja commented Oct 23, 2024 •

edited

Loading

vercel bot commented Oct 23, 2024 •

edited

Loading