Add CLI Foundry Template #854

timou0911 · 2024-09-09T16:03:10Z

Description

Create a CLI foundry template with a sample contract, a deploy script, and tests for it.
The contract itself is the same as in CLI hardhat template.

Related Issue(s)

Closes #185

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
My changes generate no new warnings
I have run yarn format and yarn lint without getting any errors
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

v1.9.2

…into new_branch

v4.0.3

v0.0.5

v5.0.2

v4.0.3

v0.0.5

v5.0.2

v4.0.3

v0.0.5

v5.0.2

v4.0.3

v0.0.5

v5.0.2

v4.0.3

v0.0.5

…s and private key

…rifier addresses for test chain

openzeppelin-code · 2024-09-09T16:05:35Z

New branch

Generated at commit: 072b11fc3b6aae2c0f32a5ffa96f6e7a649240d8

🚨 Report Summary

	Severity Level	Results
Contracts	Critical High Medium Low Note Total	0 0 0 4 15 19
Dependencies	Critical High Medium Low Note Total	0 0 0 0 0 0

For more details view the full report in OpenZeppelin Code Inspector

sripwoud

Thanks @timou0911 that's a great start, I could successfully test executing some of the tasks (make {build,test,coverage,gas-report...}).

I think there is still some work left to do (especially here).
The CLI template should become an npm package that we will publish so it can be selected as template when using the create command of the CLI.
.

Here is for instance a PR that added a previous template.

sripwoud · 2024-09-10T14:57:20Z

packages/cli-template-contracts-foundry/Makefile

I personally love Makefile as a task runner.
But I am wondering if it is appropriate for this repo.
This repo is very "node ecosystem" oriented. So we run tasks with yarn.
On one side I agree it may not make much sense to use yarn as a task runner for a template that does not include any js,ts files, making make a good choice.
One the other side, for the sake of consistency maybe we should stick to yarn: meaning all these make tasks belong rather in package.json scripts. And eventually we need a package.json in order to publish the template as an npm package... so...

What do you think @vplasencia @cedoor ?

I agree! As soon as we have 1 non-NPM package only we should make it a NPM package. If there are many other non-NPM packages we can think of a system to download templates that is more language-agnostic.

Good question. Regarding if it's better to use Makefile or yarn, I think it depends on what developers prefer when using Foundry. If most devs prefer to use Makefile, we should provide the Foundry template with Makefile and if they prefer yarn (npm, pnpm) we should provide the Foundry template with yarn. If there are no strong opinions on that we could decide one.

If we have to decide one, I see pros and cons. I think for just contracts, Makefile could be lighter and easier to add but for bigger projects yarn (npm, pnpm) could be better.

I have seen projects using both, so another alternative to discuss could be if it's better to add both.

What about having Makefile as a task runner and a package.json to make it compatible/downloadable with our CLI?

We could also add a package.json to download the template and then remove it after it's downloaded, the same way we create the yarn.lock file but removing a file instead of creating it.

Or if we keep the package.json and add the scripts so that people decide the one they prefer and remove the Makefile or the package.json and yarn.lock files.

What do you think?

I tend to prefer the first option.

@sripwoud ?

Yes let's go with the option of keeping the Makefile and removing the package.json after it having been downloaded. (That's was the 1st option right?)

@timou0911 @sripwoud Is this PR ready to be merged?

Sorry, I was busy in the past few weeks. I will start handling it next week.

No problem!

jimmychu0807 · 2024-11-07T03:45:21Z

@timou0911 @csiejimmyliu dear Taiwan fellows, may I pick up this PR and continue where it left off?

timou0911 · 2024-11-07T14:41:37Z

@timou0911 @csiejimmyliu dear Taiwan fellows, may I pick up this PR and continue where it left off?

Sure. I apologize for not being able to complete this issue sooner due to my busy schedule.
The tasks left are:

Make this template an npm package.
Keep the Makefile and remove the package.json after it has been downloaded. (Please refer to the discussion above for details)

cedoor · 2024-11-22T04:45:08Z

Hi @jimmychu0807, be sure to create a branch from this PR, so that we can merge it here.

…-foundry re semaphore-protocol#854, semaphore-protocol#185

jimmychu0807 · 2024-11-29T07:08:04Z

Hi @jimmychu0807, be sure to create a branch from this PR, so that we can merge it here.

I tried to do this, and ended up with a new PR #905. If this is important to fix, could you point me to the doc? Thanks.

cedoor · 2024-12-02T07:37:09Z

@jimmychu0807 That PR is fine, thanks!

* Semaphore identity example code bug fix * Receive suggestion for consistency * chore: forge init * forge install: forge-std v1.9.2 * Foundry CLI First Draft * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * forge install: forge-std v1.9.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * forge install: forge-std v1.9.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * forge install: forge-std v1.9.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * forge install: forge-std v1.9.2 * modules * forge install: semaphore v4.0.3 * forge install: zk-kit.solidity * forge install: poseidon-solidity v0.0.5 * forge install: openzeppelin-contracts v5.0.2 * forge install: forge-std v1.9.2 * change test name * modify declaration of semaphore and verifier * Modify Test Function Name * Add Test Chain Target * forge std install * refactor(cli-template-contracts-foundry): change default Anvil address and private key * chore(cli-template-contracts-foundry): add comments * refactor(cli-template-contracts-foundry): add Semaphore & SemaphoreVerifier addresses for test chain * chore(cli-template-contracts-foundry): add forge coverage for Makefile * chore(cli-template-contracts-foundry): add env.example * docs(cli-template-contracts-foundry): add command instructions * updated * forge build works * Fixed for linting * chore(cli-template-contracts-foundry): make the lint, prettier, and lint-staged pass * chore(cli-template-contracts-foundry): replace Makefile(removed) with package.json * chore(cli-template-contracts-foundry): passing the ci test * updated test * feat(cli-template-contracts-foundry): complete cli-template-contracts-foundry re #854, #185 * Update dependencies * Add explanation on `yarn dev` * fix(cli-template-contracts-foundry): fix `yarn dev` command and add docs on integrate w/ boilerplate * Added yarnrc * updated version * Added Foundry in template option --------- Co-authored-by: weipooppys93030 <55434365+weipooppys93030@users.noreply.github.com> Co-authored-by: timou0911 <x0928048316@gmail.com> Co-authored-by: csiejimmyliu <91661606+csiejimmyliu@users.noreply.github.com>

vplasencia · 2024-12-17T13:54:03Z

Closing this PR as it was continued and completed here: #905

Thank you very much @timou0911 for the great work ✨

@gitpoap-bot @timou0911

gitpoap-bot · 2024-12-17T13:54:07Z

Congrats, @timou0911 ! You've earned a GitPOAP for your contribution!

GitPOAP: 2024 Semaphore Contributor:

Head to gitpoap.io & connect your GitHub account to mint!

Learn more about GitPOAPs here.

weipooppys93030 and others added 30 commits August 13, 2024 01:40

Semaphore identity example code bug fix

9a10b39

Receive suggestion for consistency

68df0d9

chore: forge init

845e49c

forge install: forge-std

7db237f

v1.9.2

Foundry CLI First Draft

3924f5f

Merge branch 'new_branch' of https://github.com/csiejimmyliu/semaphore …

c507097

…into new_branch

modules

8e73c32

forge install: semaphore

db8db8e

v4.0.3

forge install: zk-kit.solidity

1455706

forge install: poseidon-solidity

88b7b46

v0.0.5

forge install: openzeppelin-contracts

29228d9

v5.0.2

modules

a062c6a

forge install: semaphore

0ec856e

v4.0.3

forge install: zk-kit.solidity

de881bb

forge install: poseidon-solidity

967fade

v0.0.5

forge install: openzeppelin-contracts

4754073

v5.0.2

modules

caf1e7a

forge install: semaphore

3193f7d

v4.0.3

forge install: zk-kit.solidity

4ac8c36

forge install: poseidon-solidity

7fba0cf

v0.0.5

forge install: openzeppelin-contracts

a4e5fe9

v5.0.2

modules

92dae03

forge install: semaphore

1f1214c

v4.0.3

forge install: zk-kit.solidity

4a26225

forge install: poseidon-solidity

1eba2a9

v0.0.5

forge install: openzeppelin-contracts

d553272

v5.0.2

modules

8197522

forge install: semaphore

18446f8

v4.0.3

forge install: zk-kit.solidity

eb9b2c2

forge install: poseidon-solidity

ba33b5d

v0.0.5

csiejimmyliu and others added 11 commits September 5, 2024 19:39

change test name

76afd09

modify declaration of semaphore and verifier

56ae53b

Modify Test Function Name

673b801

Add Test Chain Target

46b3c14

forge std install

721f26c

refactor(cli-template-contracts-foundry): change default Anvil addres…

4832baa

…s and private key

chore(cli-template-contracts-foundry): add comments

22ea215

refactor(cli-template-contracts-foundry): add Semaphore & SemaphoreVe…

52eea1b

…rifier addresses for test chain

chore(cli-template-contracts-foundry): add forge coverage for Makefile

f02da82

chore(cli-template-contracts-foundry): add env.example

5373034

docs(cli-template-contracts-foundry): add command instructions

072b11f

timou0911 requested a review from a team as a code owner September 9, 2024 16:03

timou0911 changed the title ~~New branch~~ Add CLI Foundry Template Sep 9, 2024

vercel bot deployed to Preview – semaphore-website September 9, 2024 16:05 View deployment

vercel bot deployed to Preview – semaphore-docs September 9, 2024 16:08 View deployment

sripwoud requested changes Sep 10, 2024

View reviewed changes

sripwoud assigned timou0911 Sep 10, 2024

sripwoud added the feature 🚀 This is enhancing something existing or creating something new label Sep 10, 2024

jimmychu0807 mentioned this pull request Nov 28, 2024

Add CLI Foundry Template (cont.) #905

Merged

10 tasks

jimmychu0807 added a commit to jimmychu0807/semaphore that referenced this pull request Nov 29, 2024

feat(cli-template-contracts-foundry): complete cli-template-contracts…

0556acc

…-foundry re semaphore-protocol#854, semaphore-protocol#185

vplasencia closed this Dec 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CLI Foundry Template #854

Add CLI Foundry Template #854

timou0911 commented Sep 9, 2024 •

edited by cedoor

Loading

openzeppelin-code bot commented Sep 9, 2024

sripwoud left a comment

sripwoud Sep 10, 2024

cedoor Sep 11, 2024

vplasencia Sep 11, 2024

cedoor Sep 12, 2024

vplasencia Sep 12, 2024

cedoor Sep 20, 2024

sripwoud Sep 22, 2024

cedoor Oct 3, 2024

timou0911 Oct 3, 2024

cedoor Oct 3, 2024

jimmychu0807 commented Nov 7, 2024

timou0911 commented Nov 7, 2024

cedoor commented Nov 22, 2024

jimmychu0807 commented Nov 29, 2024

cedoor commented Dec 2, 2024

vplasencia commented Dec 17, 2024

gitpoap-bot bot commented Dec 17, 2024

Add CLI Foundry Template #854

Add CLI Foundry Template #854

Conversation

timou0911 commented Sep 9, 2024 • edited by cedoor Loading

Description

Related Issue(s)

Checklist

openzeppelin-code bot commented Sep 9, 2024

New branch

🚨 Report Summary

sripwoud 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

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

jimmychu0807 commented Nov 7, 2024

timou0911 commented Nov 7, 2024

cedoor commented Nov 22, 2024

jimmychu0807 commented Nov 29, 2024

cedoor commented Dec 2, 2024

vplasencia commented Dec 17, 2024

gitpoap-bot bot commented Dec 17, 2024

timou0911 commented Sep 9, 2024 •

edited by cedoor

Loading