[FEATURE] CLI: Diamond Template Projects

[maxnorm]

Feature Request

Description

Compose is now providing a CLI tool to scaffold diamonds project using our library in both Foundry & Hardhat.

Before the beta release, the goal would be to help scaffold all the basic starter:

• ERC20
• ERC721
• ERC1155
• and others (use your imagination & experiences)

Read the full documentation here: https://compose.diamonds/docs/contribution/cli/templates
You can refer to the default template: https://github.com/Perfect-Abstractions/Compose/tree/main/cli/src/templates/default

The CLI is still early in development. If you find anything or have any improvement ideas, feel free!

It is the first version of a powerful tool for diamond development.

New issues will be created for each template assigned to contributors.

Additional Context

Please note: it is normal that all the library imports doesn't resolve as we haven't published the library yet. (Soon)

Helpful Information

Have a question? Please check our contribution guide first - your answer might already be there!

Want to discuss something? For general questions, ideas, or brainstorming, please browse our discussions or start a new one.

You can also join our Discord to discuss the issue.

[GHexxerBrdv]

Can you elaborate more about this CLI tool? @maxnorm

[maxnorm]

@GHexxerBrdv Yes, of course!

Right now, the CLI is only to scaffold new diamond project with Compose library as a dependency in both Foundry or Hardhat

We want to evolve it into a comprehensive developer toolkit for diamonds from templates scaffolding, static code analysis for storage/selector collisions, pre-deployment checks and much more.

Hope that makes sense!

If you have any idea on what this cli could do to help developers avoid common pitfalls, streamline development & deployment, etc, Feel free to share it! This is a really early version of the envisioned toolkit

[0x76agabond]

Hey @maxnorm, how’s it going? I think I can help with this.

[maxnorm]

Hey @0x76agabond, doing great and you? Sorry for the delay, just came back from vacation.

How do you want to help?

For now, the idea is simple. We built a collection of common projects boilerplate to jump start development, like a counter, erc20, erc20 metadata, etc. This will make the tool a bit more relevant compared to the counter.

I'm also thinking of switching this approach to a builder prompt to configure the project based on the facets available and their compatibility. We could dynamically generate projects for the user’s needs.

[0x76agabond]

Hey @maxnorm,
Doing great, thanks.

My original idea was to help implement some Compose CLI features. I was also thinking about adding validation features later, such as checking for potential storage collisions using ERC-8042 storage-location annotations and ERC-8110 domain metadata.

The new approach of dynamically generating Diamond projects based on existing implementations sounds great and useful.
Would you mind sharing what kind of prompt flow you have in mind?

[maxnorm]

@0x76agabond Are you reading my mind? ahahah

This is the planned direction for the CLI. The end goal for it is to provide the complete toolkit from scaffolding to deployment (we will cover the full development lifecycle). I'm waiting on Nick for his reviews on the PRD. Once reviewed, we'll publish a public roadmap for it to get community ideas too.

If you want, we can get in touch on discord to get your review on the PRD as well.

For the diamond builder, i don't have any idea yet. I need to take the time to brainstorm a bit more on this. (I was actually pondering the idea on vacation without any computer access ahah).

If i'll say something quickly, maybe something like this:

1. Ownership/Access Control
2. ERC Standard (ERC20, ERC721, etc)
3. Standard Option (meta data, batchs, transfer, etc)

Do you have any ideas for this?

[0x76agabond]

@maxnorm
Yes, I’d be happy to review the PRD and discuss it on Discord.

Based on what you described, I think we could separate facets into a few categories:

1. Cross-cutting facets, such as ownership, access control, pausable, etc.
2. Main facets, such as ERC20, ERC721, ERC1155, etc.
3. Extension facets, such as metadata, mint, burn, batch operations, etc.

For the builder, one possible approach is to build a directory/component map from the existing directory and file structure. That map could later be used to determine which features or functions are available to add to a user’s project.

Based on the features selected by the user, the CLI could then generate the required project structure, including Diamond.sol, selected facets, dependencies, tests, and deployment scripts.

For the builder flow, I think we could support multiple modes:

1. Interactive command prompt
2. Pure CLI arguments
3. A JSON configuration file as input

This would make the builder useful both for humans using the CLI directly and for automated tools or agents.

I may have more ideas after reviewing the PRD.

Also, if I understand correctly, Compose currently focuses on the ERC-8153 diamond flow. Do you plan to support classic ERC-2535 diamonds in the future?

[GHexxerBrdv]

@0x76agabond Are you reading my mind? ahahah

This is the planned direction for the CLI. The end goal for it is to provide the complete toolkit from scaffolding to deployment (we will cover the full development lifecycle). I'm waiting on Nick for his reviews on the PRD. Once reviewed, we'll publish a public roadmap for it to get community ideas too.

If you want, we can get in touch on discord to get your review on the PRD as well.

For the diamond builder, i don't have any idea yet. I need to take the time to brainstorm a bit more on this. (I was actually pondering the idea on vacation without any computer access ahah).

If i'll say something quickly, maybe something like this:

1. Ownership/Access Control
2. ERC Standard (ERC20, ERC721, etc)
3. Standard Option (meta data, batchs, transfer, etc)

Do you have any ideas for this?

I am working on the same kind tool, but i will suggest you to make different repository for the tool. However i can contribute my already build tool to it or i can make new fresh initial MVP tool for compose project in that repository.

(Note:- it has built in rust for better security and performance)

[maxnorm]

Hey @GHexxerBrdv,

Would be curious to see the rust project?

For now, we are sticking to a monorepo approach to centralize contribution and we use the NPM registry for distribution. That bieng said, i'm always open to explore.