fetsorn / kasner

Kasner

Commit-reveal for quizzes.

Documentation 📚

Smart contract documentation is here.

Developer Information and Tools 👩‍💻

Install dependencies 👷‍♂️

Note If you use nix, run nix develop to install all dependencies in PATH

You'll need to install nodejs >= 18.15.0. We use yarn but npm should work too. You'll also need to install foundry and solc. Assuming that's done, run yarn with no args:

yarn

Build the code 🧐

To compile the contracts:

yarn compile

Run tests 🦾

To run both foundry and hardhat tests:

yarn test

Running the linter 🧽

To run the linter in the default mode, where it will print all errors and not modify code, run:

yarn lint

Coverage 🔎

We use the solidity-coverage package to generate coverage reports for hardhat in coverage/ and forge coverage for foundry tests in coverage-foundry. You can generate the coverage reports locally by running:

yarn coverage
yarn hardhat coverage

The full reports can be viewed by opening the coverage/index.html and coverage-foundry/index.html files in a browser.

Deploy and interact 🚀

Enter your private key interactively when prompted.

forge build

forge create -i --legacy --rpc-url https://polygon-mumbai.blockpi.network/v1/rpc/public contracts/Kasner.sol:Kasner```

Verify 📄

To verify the source code with a network explorer, it's best to generate json metadata.

yarn hardhat solidity-json

Choose Standard-Json-Input in the explorer verification dialog and upload json from artifacts/solidity-json/contracts/.