REVV Solidity Contracts

This project contains the solidity contracts for the REVV project.

Audits

| Date | Scope | Commit | Package version | Auditor | Report | | ---------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | 14/11/2022 | REVVMotorsportShard & REVVRacingCatalyst | 0ffc859794d3cd70928559fa03e48aeea8d7c36b | 6.0.0 | Halborn | link |

Solidity contracts

Only the contracts corresponding to the features developed for the current version of the module are present. For previously developed contracts, check out older commits / package versions.

Compilation artifacts

The compilation artifacts, including the debug information, are available in the artifacts folder, both in the git repository and the release packages. The artifacts for the previous versions of the module are also available in the artifacts_previous folder. These artifacts can be imported in dependents projects and used in tests or migration scripts with the following hardhat configuration:

  external: {
    contracts: [
      {
        artifacts: 'node_modules/@animoca/revv-ethereum-contracts/artifacts',
      },
      {
        artifacts: 'node_modules/@animoca/revv-ethereum-contracts/artifacts_previous',
      },
    ],
  },

Installation

To install the module in your project, add it as an npm dependency:

yarn add -D @animoca/revv-ethereum-contracts hardhat

or

npm add --save-dev @animoca/revv-ethereum-contracts hardhat

Development

Install the dependencies:

yarn

Compile the contracts:

yarn compile

Run the tests:

yarn test

Run the tests (parallel mode):

yarn test-p

Run the coverage tests:

yarn coverage

Run the full pipeline (should be run before commiting code):

yarn run-all

See package.json for additional commands.

Note: this repository uses git lfs: the module should be installed before pushing changes.