Add ds-test as NPM modules for Hardhat backwards compatibility

Question

Add ds-test as NPM modules for Hardhat backwards compatibility

0xTenzo opened this issue 2 years ago · comments

Describe the feature you would like

Issue described in detail here.

Many of use would like to use Foundry + Hardhat, which still has tons of use cases (integration testing, complex deployment scripts, etc) and should really not be treated as a direct competitor. However, there are some small inconveniences that we have found when trying to do this.

As shown in the issue, it can almost be tidied up into one source of truth for all dependencies by mapping the paths the Forge uses to node_modules. But since ds-test and forge-std do not have NPM modules, you still need to maintain a ./lib directory and remappings.txt.

The simplest fix would probably be to wrap these dependencies in NPM modules. This probably has use-cases outside just the one described above, but would help immensely for all the Hardhat folks that want to give Foundry a go.

forge-std will do this but they need help with ds-test NPM package: foundry-rs/forge-std#39 (comment)

Thanks! 🙏

dxo · Answer 1 · Sat Apr 23 2022 17:11:34 GMT+0800 (China Standard Time)

I'm hesitant here, Im not involved with the npm ecosystem at all and I'm not sure what kind of extra maintenance burden this would impose.

Can you help me understand:

What exactly would be involved here? Adding a package json and publishing to npm? does npm enforce certain versioning schemes or folder layouts?
Which issue would actually be fixed here? Is this actually blocking anyone from working, or is it more an aesthetic consideration when working in mixed repos? Could mixed hardhat / foundry repos store all their deps in submodules instead of relying on npm?

Tenzo · Answer 2 · Thu May 05 2022 22:19:47 GMT+0800 (China Standard Time)

@d-xo For (2), it doesn't necessarily block, but you send up with multiple files acting as a source of truth for dependencies. When doing mixed hardhat / foundry repos, the NPM dependency method will always be required as hardhat (and all the JavaScript / TypeScript dependencies it has) are all in NPM. Currently though, all foundry submodules have an NPM equivalent except ds-test, so this is the last remaining dependencies from making these repositories more clear and easier to work with.

For (1), forge-std just added this to their's and it was pretty seamless. Their example should be able to be followed by going to foundry-rs/forge-std#39 (comment) and https://www.npmjs.com/package/@float-capital/ds-test.

dxo · Answer 3 · Mon May 23 2022 17:52:02 GMT+0800 (China Standard Time)

I don't see an official forge-std package on npm. https://www.npmjs.com/search?q=forge-std.

dxo · Answer 4 · Mon May 23 2022 17:53:13 GMT+0800 (China Standard Time)

I also don't understand why you can't keep solidity dependencies in lib as submodules and have contracts that you want to use with hardhat import from there?

dxo · Answer 5 · Mon May 23 2022 19:28:59 GMT+0800 (China Standard Time)

cc @brockelmore are you planning on uploading / have you uploaded forge-std to npm?

Tenzo · Answer 6 · Mon May 23 2022 22:55:52 GMT+0800 (China Standard Time)

@d-xo Sorry if the request wasn't clear, it is my understanding that forge-std doesn't have an NPM package, so the request is that one is added. Its a huge improvement in project organization for Foundry + HH structures, since forge-std is the only remaining dependency that cannot use normal NPM installation.

Tenzo · Answer 7 · Wed May 25 2022 22:07:52 GMT+0800 (China Standard Time)

Closing since @float-capital/ds-test exists in NPM, now just trying to see if we can get one for forge-std: foundry-rs/forge-std#39

dxo · Answer 8 · Thu May 26 2022 16:53:39 GMT+0800 (China Standard Time)

I also don't understand why you can't keep solidity dependencies in lib as submodules and have contracts that you want to use with hardhat import from there?

fwiw this is the approach taken in the official foundry / hardhat template: https://github.com/foundry-rs/hardhat-foundry-template

Tenzo · Answer 9 · Thu May 26 2022 23:52:17 GMT+0800 (China Standard Time)

I also don't understand why you can't keep solidity dependencies in lib as submodules and have contracts that you want to use with hardhat import from there?

fwiw this is the approach taken in the official foundry / hardhat template: https://github.com/foundry-rs/hardhat-foundry-template

It's about having multiple, (potentially) overlapping sources of truth for dependencies, which can be very tedious in larger projects. It's also about ease-of-use and clarify: every other dependency I've found has an NPM package, so with the 1-2 exceptions, /lib, .gitmodules, remappings.txt don't need to exist at all and don't need to be updated on every new dependency.

And because NPM dependencies can be used is JavaScript / deploy code as well as Solidity code (instead of just Solidity code), it is the better place to consolidate this logic.