@hyperledger/cactus-plugin-htlc-eth-besu v2.0.0

@hyperledger/cactus-plugin-htlc-eth-besu

Allows Cacti to interact with HTLC contract manager.

Summary

• Getting Started
• Installing
• Runing the tests
• Contributing
• License

Getting Started

The smart contracts and rationalle ane explained in detail in this Medium article .

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

Install Foundry: https://book.getfoundry.sh/getting-started/installation

Steps to compile the project: forge build.

Running the tests

The tests can be found in @hyperledger/cactus-test-htlc-eth-besu. To run this, in the root project execute:

npm run test:plugin-htlc-besu

To run the solidity tests (within the root directory of this package): forge test --match-contract PrivateHashTimeLockTest

To run a specific function: forge test --match-contract PrivateHashTimeLockTest --match-test testDeployment

Run ALL the solidity tests: forge test -vvvv

Contributing

We welcome contributions to Hyperledger Cactus in many forms, and there’s always plenty to do!

Please review CONTIRBUTING.md to get started.

Nohoist configuration

Foundry uses forge-stdand ds-testmodules for testing purposes. Given that Foundry cannot access files outside of the project, we use nohoist to force lerna to download the packages within the Forge project directory:

"nohoist": [ "**/iroha-helpers", "**/forge-std", "**/forge-std/**" ] },

If in the future Forge supports importing Solidity files from outside the project, the imports/re-mappings can be updated and the nohoist configuration removed.

License

This distribution is published under the Apache License Version 2.0 found in the LICENSE file.