search

webb-tools / gadget

A framework for building modular AVS and Tangle Blueprints: https://docs.tangle.tools/developers/blueprints.
https://tangle.tools
Apache License 2.0
12 stars 1 forks source link

[TASK] Issues creating a new blueprint #299

Open drewstone opened 5 days ago

drewstone commented 5 days ago

Overview

Submodules get committed in entirety to the git

Have noticed when developing new blueprints that when I go to add them to git (which is automatically set up for me) that it adds all the contract/lib submodule files to the repo! This is annoying as I keep having to reset my commit head (since it's usually my first commit) and this is frustrating. We should fix this so it works out of the box without creating issues for the developer besides their business logic.

The template provides no remappings.txt that actually have the proper tnt-core links.

Without any remappings this doesn't work out of the box.

Misc

We should avoid wrapping things more than needed. Developers using this will leverage our docs to know how to install libraries. We should be providing better READMEs and documentation. We need to be testing the software we are shipping. We need docs to be up-to-date. Test the software after you complete your work, review the docs, see if anything requires updates and if the documentation is sufficient and up-to-date.

drewstone commented 5 days ago

Additionally, we already have forge-std as part of tnt-core so we should just be modifying the remappings to use that one. Unless anyone thinks otherwise?

drewstone commented 5 days ago

Ok I'm actually starting to think that it might be better to have the CLI programmatically install the forge dependencies for the user on install instead of as part of the template? I can't seem to figure out how to avoid committing the entirety of the submodule repos while creating a blueprint template.

This may also provide an opportunity to switch between Tangle and Eigenlayer support at the CLI level. CC @shekohex