Skip to content

Latest commit

 

History

History
98 lines (65 loc) · 4.5 KB

README.md

File metadata and controls

98 lines (65 loc) · 4.5 KB
Raw

Velodrome Superchain Contracts

Core smart contracts for the Velodrome Superchain. This includes the Superchain specific contracts (message passing, xERC20, etc) as well as the base v2 contracts.

For information on specific contracts, see SPECIFICATION.md.. Integrators should refer to the integrators section below.

Installation

This repository depends on:

node v20 (recommend managing node versions using nvm) foundry yarn

To install & run:

yarn install
forge b

forge t -vv

This repository uses forge fmt to format code and bulloak for test layouts.

Deployment

Populate foundry.toml with the environment variables required for RPC and contract verification.

Run the following commands to check that the CreateX factory has the correct code. See here for more information. This is now done in the script, but feel free to check.

[[ $(cast keccak $(cast code 0xba5Ed099633D3B313e4D5F7bdc1305d3c28ba5Ed --rpc-url {RPC_URL})) == "0xbd8a7ea8cfca7b4e5f5041d7d4b17bc317c5ce42cfbc42066a00cf26b43eb53f" ]] && echo "Hash Matches" || echo "Hash Does Not Match"

Deploy Root contracts first:

forge script script/deployParameters/optimism/DeployRootBase.s.sol:DeployRootBase --slow --rpc-url optimism -vvvv
forge script script/deployParameters/optimism/DeployRootBase.s.sol:DeployRootBase --slow --rpc-url optimism --broadcast --verify -vvvv

Deploy Leaf contracts next:

Replace leaf with the chain you are deploying to.

forge script script/deployParameters/leaf/DeployBase.s.sol:DeployBase --slow --rpc-url leaf -vvvv
forge script script/deployParameters/leaf/DeployBase.s.sol:DeployBase --slow --rpc-url leaf --broadcast --verify -vvvv

If there is a verification failure, simply remove --broadcast and add --resume.

Verification

For verifications, fill out the verifier config in foundry.toml.

For blockscout verifications, append --verifier blockscout after --verify

Integrators

Existing contracts that manage nfts that vote on Velodrome must add support for additional logic in order to be able to participate in Superchain Velodrome.

Some additional information for developers building contracts that interact with Superchain Velodrome:

  • Contracts that wish to vote for a certain chain must explicitly set a rewards recipient for that chain by calling setRecipient on the RootVotingRewardsFactory contract.
  • Users interacting with smart contracts that are voting cross chain must approve a small amount of WETH to the RootMessageBridge as payment for gas.
  • The token bridge may be sunset in the future in favor of alternate token bridging mechanisms.
    • The interface will remain the same, but the implementation will change and be deployed as a new contract.

xERC20

The xERC20 implementation in this repository has been modified lightly from the moonwell xERC20 implementation to support native Superchain interop in the future.

Licensing

This project follows the Apache Foundation guideline for licensing. See LICENSE and NOTICE files.

Bug Bounty

Velodrome has a live bug bounty hosted on (Immunefi).

Deployments

Chain Addresses Deployment Commit
Optimism Addresses v1.0
Mode Addresses v1.0
Lisk Addresses v1.0
Fraxtal Addresses v1.0

Optimism contains the root deployment contracts, and these factory addresses are used by all leaf chains.