Animoca Ethereum Assets Bridging Contracts

Solidity contracts to manage bridging assets between blockchains.

Audits

| Date | Scope | Commit | Package version | Auditor | Report | | ---------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | 14/11/2022 | Full library (FxERC20) | ac07a577f4c6545f2543f793fea6d4ee7b1ea928 | 0.1.2 | Halborn | link |

Compilation artifacts

The compilation artifacts, including the debug information, are available in the artifacts folder, both in the git repository and the release packages. 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/ethereum-contracts-bridging/artifacts',
      },
    ],
  },

Installation

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

yarn add -D @animoca/ethereum-contracts hardhat

or

npm add --save-dev @animoca/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.