Making the repo hardhat compatible

[sullof]

After a chat with @nik-suri I found an hour today to make a simple change to the repo in order to make it publishable to npm for hardhat users.
It works well.
I just published it to Npm at
https://www.npmjs.com/package/wormhole-solidity-sdk

When running scripts/publish.sh, the script copies src to contracts, modifies the files to remove the remapping, not currently supported by hardhat, and set a new package.json to publish just the contracts' files.

[nonergodic]

Let me know what you think!

[nonergodic]

Why error here instead of running the script? Presumably because the script is modifying the package.json?

I think the package.json should probably not have any scripts and instead publish should be implemented as a target in the Makefile (so we stick to one method of building / doing things).

[sullof]

This is the same method used by OpenZeppelin and major libraries developers to be sure that you can import files without specifying src or contracts. In other words, the package.json file that is used to publish is a modified version of the primary one, in order to specify the files we want to publish and exclude anything else.

I wrote a publish.sh script because it was simpler and less invasive. Of course, you guys can put that stuff in your building/deploying process, which I think would be better.

[sullof]

BTW, if you do not block the prePublish, someone can accidentally publish it not in the best way, creating a potential disaster for devs who are using the package.

[nonergodic]

This package should be published under the @wormhole-foundation scope.

[sullof]

Of course, but since I contacted someone there for a while and nobody cared about it, months ago I published an Hardhat version of it by myself, in order to use it in my projects and to allow a couple of friends who had the same issue to work easily inside hardhat. The beauty of open source is that it allows work-around, even when the official published doesn't give a s**t about something :-)

[nonergodic]

Yeah, I agree. I apologize about the neglect here, the ecosystem is still in the process of slowly getting its shit together. But I'm now the new Sheriff in town and this sort of neglect will not happen under my watch.

[nonergodic]

What's the purpose of this example contract? I see that it's being compiled as a test and then deleted before publishing, but it's unclear to me what it really is testing, if the rest of the repo compiles successfully.

[sullof]

In my previous version, even when the contracts where compiling well, during the import it was failing. So, my workaround is to create a temporary contract that imports the SDK, verify that everything compiles correctly, and then remove the no-more-useful temporary contract. When we are sure that there isn't that problem anymore, we can of course skip that. Consider it as a double-check test.

[nonergodic]

Just to keep you updated: I'll soon be picking this up and modify it a bit further, and eventually release an npm package for hardhat consumption under the @wormhole-foundation npm scope. I'd like to hit v1.0 before that though.