@iexec/voucher-contracts

iExec Voucher contracts

Contracts of iExec Voucher project.

API Documentation

The API documentation can be found in docs/.

UML diagram

UML class diagram for voucher contracts can be found here. Raw version is available here for better readability.

How to deploy?

Edit config/deployment.json file to provide deployment configuration of the target chain if missing.

Deployment configuration can also be provided/overridden using env variables:

• IEXEC_POCO_ADDRESS
• IEXEC_VOUCHER_MANAGER_ACCOUNT_INDEX
• IEXEC_VOUCHER_MINTER_ACCOUNT_INDEX

Run:

npx hardhat deploy --network <name>

Local Bellecour fork

Complete the .env file with the following variables:

IS_LOCAL_FORK=true
MNEMONIC=<mnemonic>

If a MNEMONIC is not provided, the default Hardhat one will be used.

npx hardhat node

Bellecour

With appropriate deployer key:

npx hardhat deploy --network bellecour

Verify contracts

npx hardhat run ./scripts/verify.ts --network bellecour

Once a Voucher (proxy) is deployed, it can be verified with:

npx hardhat verify <voucherProxyAddress> --network bellecour <beaconAddress>

Note: no need to verify all VoucherProxy contracts because Blockscout automatically matches all similar contracts with the submitted source code.

Audits

All contract audit files can be found in audit/ folder.

Changelog

v1.0.1

• Index first parameter of match an claim events in Voucher contract. (#61, #72)
• Add upgrade workflow. (#64)
• Add Halborn "Poco v5.5 & Voucher v1.0" audit report ( #70)
• Add type-checking script (#53)
• Run partial upgrade tests on fork.
  • Should maintain consistent voucher addresses (#61)
  • Should upgrade decimals (#58)
• Implement VoucherHub upgrade and test it on GitHub Action CI using a local fork. (#57)
• Relocate decimals() function in VoucherHub smart contract. (#56)
• Better handling for env variables. (#55)
• Remove references to blockscout v5. (#49)
• Override the decimals function of ERC-20 to set the token's decimal precision to 9, aligning with RLC standards. (#50)
• Verify VoucherProxy contracts. (#51)