This repository contains smart contracts for various services of the Lisk project. This includes, for instance, the contract for the LSK token or the contracts required to migrate the LSK token distribution from the Lisk L1 to the L2. In order to function as designed, certain smart contracts must be deployed on L1 (Ethereum's Layer 1), while others are deployed on L2.
Additionally, it also includes various deployment scripts that are integral for deploying on different networks. These scripts handle the deployment of smart contracts to both L1 and L2 private test networks, as well as to public testnet and mainnet networks. They also ensure seamless deployment across different environments and the efficient movement of tokens to the appropriate accounts as per the project's requirements.
- Contracts Overview
- Installation
- Deploying on Private Test Network
- Deploying on Public Test Network
- Deployments
- Tips & Tricks
- Contributing
- Security
- License
| Name | Description |
|---|---|
L1LiskToken |
Lisk token (LSK) deployed on Ethereum L1 network |
L1VestingWallet |
Vesting wallet for LSK tokens on Ethereum L1 network |
| Name | Description |
|---|---|
L2Airdrop |
Smart contract responsible for the Lisk Migration Airdrop |
L2Claim |
Smart contract responsible for a claiming process of the LSK tokens |
L2Governor |
The Governor contract for the Lisk DAO which manages proposals |
L2LiskToken |
Bridged Lisk token (LSK) deployed on Lisk L2 network |
L2LockingPosition |
Stores all information of locking positions |
L2Reward |
Responsible for staking rewards |
L2Staking |
Responsible for locking, unlocking and editing locking positions |
L2TimelockController |
Timelock controller for the Lisk DAO which manages the delay of proposals execution |
L2VestingWallet |
Vesting wallet for LSK tokens on Lisk L2 network |
L2VotingPower |
The token contract for the Lisk DAO which manages the voting power of accounts |
In order to build, test and deploy the smart contracts a Foundry toolchain needs to be installed. The easiest way is to use Foundryup by below command:
curl -L https://foundry.paradigm.xyz | bashThis will install Foundryup, then simply follow the instructions on-screen, which will make the foundryup command available in your CLI. Running foundryup by itself will install the latest (nightly) precompiled binaries: forge, cast, anvil, and chisel.
To download all the necessary project files and libraries, execute the following commands:
git clone https://github.com/LiskHQ/lisk-contracts.gitInside newly created lisk-contracts directory:
git submodule update --init --recursiveNOTE: On a private test network, the deployment of smart contracts is feasible on both L1 and L2 networks. However, the transfer of tokens between these networks is not possible as it requires the operation of the Sequencer.
NOTE: To successfully deploy all smart contracts and execute the required transactions, the deployer (specified by PRIVATE_KEY in the .env file) must have funds available in its address on the respective networks. For a private test network, you can use any private key from the list provided by anvil when the network is created, or choose another private key with sufficient funds on both forked networks.
Private L1 and L2 test networks are established using the anvil tool, and the smart contracts are deployed using the forge script tool. To run private networks and deploy the smart contracts, follow these steps:
- Create
.envfile and set the varsPRIVATE_KEY,NETWORK,L1_TOKEN_OWNER_ADDRESS,L2_CLAIM_OWNER_ADDRESS,L2_STAKING_OWNER_ADDRESS,L2_LOCKING_POSITION_OWNER_ADDRESS,L2_REWARD_OWNER_ADDRESS,L2_GOVERNOR_OWNER_ADDRESS,L2_VOTING_POWER_OWNER_ADDRESS,L2_AIRDROP_OWNER_ADDRESS,L2_AIRDROP_WALLET_ADDRESS,DETERMINISTIC_ADDRESS_SALT,L1_STANDARD_BRIDGE_ADDR,L1_RPC_URL,L2_RPC_URL,L1_FORK_RPC_URL,L2_FORK_RPC_URLandTEST_NETWORK_MNEMONIC. You can copy and rename the.env.examplefile if the default values provided in.env.exampleare satisfactory.L1_RPC_URLshould be set tohttp://127.0.0.1:8545andL2_RPC_URLshould be set tohttp://127.0.0.1:8546if no changes are made in the./runL1TestNetwork.shor./runL2TestNetwork.shscript files. - Navigate to the
scriptdirectory. - Place the
accounts.jsonandmerkle-root.jsonfiles in the correct folder (data/devnet,data/testnet, ordata/mainnet) corresponding to the previously setNETWORKenvironment variable. Example files foraccounts.jsonandmerkle-root.jsonmay be found insidedata/devnetdirectory. - To create and launch a private test L1 network, execute the script:
./runL1TestNetwork.sh - To create and launch a private test L2 network, execute the script:
./runL2TestNetwork.sh - To deploy all smart contracts, execute the scripts:
./1_deployTokenContracts.sh,./2_deployStakingAndGovernance.sh,./3_deployVestingWallets.sh,./4_deployClaimContractand./5_deployAirdropContract.sh.
NOTE: To successfully deploy all smart contracts and execute the required transactions, the deployer (specified by PRIVATE_KEY in the .env file) must have funds available in its address. This implies that a private key with a sufficient balance on both public test networks is required.
To deploy smart contracts on both L1 and L2 public networks, you will need to provide for each network an URL for a public node from a RPC provider, such as Alchemy or Infura. Additionally, in order to verify smart contracts on Blockscout or Etherscan Block Explorers during the deployment process, it is necessary to provide verifier name along with additional information (URL and API key). Follow these steps to deploy the smart contracts:
- Create
.envfile and set the varsPRIVATE_KEY,NETWORK,L1_TOKEN_OWNER_ADDRESS,L2_CLAIM_OWNER_ADDRESS,L2_STAKING_OWNER_ADDRESS,L2_LOCKING_POSITION_OWNER_ADDRESS,L2_REWARD_OWNER_ADDRESS,L2_GOVERNOR_OWNER_ADDRESS,L2_VOTING_POWER_OWNER_ADDRESS,L2_AIRDROP_OWNER_ADDRESS,L2_AIRDROP_WALLET_ADDRESS,DETERMINISTIC_ADDRESS_SALT,L1_STANDARD_BRIDGE_ADDR,L1_RPC_URL,L2_RPC_URLandCONTRACT_VERIFIER. You can copy and rename the.env.examplefile if the default values provided in.env.exampleare satisfactory.CONTRACT_VERIFIERmay be empty to skip smart contracts verification process on Blockscout or Etherscan Block Explorers. - When
CONTRACT_VERIFIERis configured as eitherblockscoutoretherscan, there are specific additional variables that must be defined. Forblockscout, it is necessary to setL1_VERIFIER_URLandL2_VERIFIER_URL. Conversely, foretherscan, it is necessary to setL1_ETHERSCAN_API_KEYandL2_ETHERSCAN_API_KEY. - Navigate to the
scriptdirectory. - Place the
accounts.jsonandmerkle-root.jsonfiles in the correct folder (data/devnet,data/testnet, ordata/mainnet) corresponding to the previously setNETWORKenvironment variable. Example files foraccounts.jsonandmerkle-root.jsonmay be found insidedata/devnetdirectory. - To deploy all smart contracts, execute the scripts:
./1_deployTokenContracts.sh,./2_deployStakingAndGovernance.sh,./3_deployVestingWallets.sh,./4_deployClaimContractand./5_deployAirdropContract.sh.
You may find the addresses of the deployed smart contracts (including vesting wallets) on the Ethereum and Lisk mainnets inside deployment/addresses/mainnet/addresses.md file.
| Name | Proxy | Implementation |
|---|---|---|
L1LiskToken |
- | 0x6033F7f88332B8db6ad452B7C6D5bB643990aE3f |
L1VestingWallet |
- | 0xd590c2e71739c551ebA7AEBE00E7855dF4cF5fB7 |
You may find the addresses of the deployed smart contracts on the Ethereum and Lisk testnets inside deployment/addresses/sepolia/addresses.md file.
WARNING: Foundry installs the latest versions of openzeppelin-contracts and openzeppelin-contracts-upgradeable initially, but subsequent forge update commands will use the master branch which is a development branch that should be avoided in favor of tagged releases. The release process involves security measures that the master branch does not guarantee.
The NETWORK environment variable can be set to determine the folder where files will be generated during the deployment of smart contracts. This includes files like l1addresses.json and l2addresses.json. The acceptable values for this variable are mainnet, testnet or devnet, which correspond to the specific network environments where the deployment is taking place. Setting this variable helps in organizing and managing the deployment process by ensuring that all related files are stored in the correct network specific folder.
L2 Lisk Token is deployed using CREATE2 opcode to ensure deterministic smart contract address. The salt utilized for its creation is derived by hashing the concatenation of the DETERMINISTIC_ADDRESS_SALT environment variable, an underscore, and the name of the smart contract.
The distribution of newly minted Lisk tokens takes place in accordance with the instructions specified in the files accounts_1.json, accounts_2.json, vestingWallets_L1.json and vestingWallets_L2.json. The two files accounts_1.json and accounts_2.json contain a list of addresses and the respective amounts of tokens that need to be sent to various accounts on both the L1 and L2 networks. The funds specified in accounts_1.json will be transferred as part of 1_deployTokenContracts.sh and the funds of accounts_2.json as part of 4_deployClaimContract.sh. The funds specified in vestingWallets_L1.json and vestingWallets_L2.json are distributed to vesting wallets as part of 3_deployVestingWallets.sh. Moreover, some initial amount is transferred to the DAO treasury within the same script.
The process ensures that each address specified in the json files receives the designated amount of tokens accurately. Any remaining Lisk Tokens, those not allocated to the addresses listed in the files, are then transferred to the Claim smart contract. This systematic distribution is critical for ensuring that the tokens are correctly assigned to their intended recipients across the different network layers as part of the project's requirements.
Some of the smart contracts in this project are designed to be ownable, meaning they have an assigned owner. This ownership allows for certain privileges and actions. For instance, in the case of upgradable smart contracts like the Claim smart contract, the owner has the ability to upgrade the contract. This feature is crucial for making improvements or fixes to the contract after deployment.
Additionally, in the case of specific contracts like the L1 Lisk Token, the owner can assign special roles to certain Ethereum addresses. An example of such a role is the burner role, which grants the assigned address the capability to burn tokens. This ability to assign roles and upgrade contracts provides flexibility and control, ensuring that the contracts can be managed and updated effectively to suit evolving requirements or address any issues that may arise.
If you find any issues or have suggestions for improvements, please open an issue on the GitHub repository. You can also submit pull requests with bug fixes, new features, or documentation enhancements.
We take the security of our project very seriously. If you have any concerns about security or wish to report a security vulnerability, please refer to our Security Policy. This policy provides detailed information on how security issues are handled within our project and guides you through the process of reporting a security vulnerability.
Copyright 2024 Onchain Foundation
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.