@mezo-org/contracts v0.4.0-dev.4

mezo-portal Contracts

Smart contracts powering the bridge to Mezo

Development

Installation

This project uses pnpm as a package manager (installation documentation).

To install dependencies run:

pnpm install

Testing

$ pnpm test

Environment Setup

This project uses dotenv-safer, which provides environment variable checking. If there is a field in .env.example but not .env, execution will halt early with an error.

Both pnpm run deploy and pnpm test will automatically create a blank .env from the .env.example template, if .env does not exist.

To do this manually:

$ pnpm run prepare:env

Deploying

We deploy our contracts with hardhat-deploy via

$ pnpm run deploy [--network <network>]

Check the "networks" entry of hardhat.config.ts for supported networks.

Deploying to real chains will require configuring the .env environment, detailed in .env.example.

Examples:

In-Memory Hardhat (great for development)

pnpm run deploy

Sepolia

To deploy contracts on Sepolia run:

$ pnpm run deploy --network sepolia

Or, alternatively, manually trigger the Solidity workflow (this will not only deploy the contracts, but also update the values of TBTC_CONTRACT_ADDRESS, WBTC_CONTRACT_ADDRESS and PORTAL_CONTRACT_ADDRESS environment variables in the settings of Netlify builds deploying dApp and its previews).

Contract Addresses

The official mainnet and testnet contract addresses are listed below.

Mainnet

Sepolia

Rebasing and Fee-on-Transfer Deposit Tokens

The smart contracts are incompatible with rebasing and fee-on-transfer tokens. Such tokens must not be added as supported tokens for deposits to the Portal contract.

This check should be a part of the checklist for the governance when adding new supported tokens.