Skip to content

Latest commit

 

History

History
130 lines (83 loc) · 4.5 KB

README.md

File metadata and controls

130 lines (83 loc) · 4.5 KB
Raw

Token Lock

Lock ERC-20 token for a pre-defined amount of time

This is a mono-repo including two packages: contract and app

Contract

Build Status Coverage Status

A contract for locking balances of a designated ERC-20 token for a pre-defined amount of time after a deposit period.

  1. Deposit period: Anyone can deposit the designated token, receiving an equivalent balance of non-transferrable lock claim token. Withdrawals are possible.
  2. Lock period: No more deposits and withdrawals are possible.
  3. After the lock period: Tokens can be withdrawn in redemption for lock claim tokens.

Setup

We deploy the contract via the @openzeppelin/hardhat-upgrades plugin so it can be upgraded to modify its code, while preserving the address, state, and balances.

Configuration

The contract is initialized with the following set of parameters:

  • owner: Address of the owner
  • token: Address of the token to lock
  • depositDeadline: Unix timestamp (seconds) of the deposit deadline,
  • lockDuration: Lock duration in seconds, period starts after the deposit deadline
  • name: Name of the token representing the claim on the locked token, e.g.: "Locked Gnosis"
  • symbol: Symbol of the token representing the claim on the locked token, e.g.: "LGNO"

Before running any of the hardhat tasks below, make sure to create a .env file based on the provided .env.template file.

Initial deployment

Deploys the implementation contract and an upgradable proxy. When run multiple times, it will create multiple proxies sharing the same implementation contract.

cd packages/contracts
yarn build
yarn deploy rinkeby \
  --owner <OWNER> \
  --token 0xd0dab4e640d95e9e8a47545598c33e31bdb53c7c \
  --deposit-deadline 1642498466 \
  --lock-duration 31536000 \
  --name 'Locked Gnosis' \
  --symbol LGNO

The task prints the addresses of the proxy and the implementation contracts, which you'll need for verification and future upgrades. You can also find these values in .openzeppelin/.json.

Verification

Verifies the implementation contract at the specified address in Etherscan.

cd packages/contracts
yarn verify rinkeby --implementation <IMPLEMENTATION_CONTRACT>

You still need to manually mark the proxy contract as a proxy on Etherscan. This is done with a simple click on a button in Etherscan.

Upgrade

Deploys the latest version of the implementation contract (if necessary) and upgrades the existing proxy contract to use this one.

cd packages/contracts
yarn run upgrade rinkeby --proxy <PROXY_CONTRACT>

(Note that you must not omit run, because upgrade is also the name of a yarn command.)

Solidity Compiler

The contracts have been developed with Solidity 0.8.6. This version of Solidity made all arithmetic checked by default, therefore eliminating the need for explicit overflow or underflow (or other arithmetic) checks. This version of solidity was chosen as it allows to easily cast bytes to bytes4 and bytes32.

Audits

TokenLock.sol has been audited by the G0 group.

All issues and notes of the audit have been addressed in commit f974d1e8643c30d07dc005d10f9389085e74556d.

The audit results are available as a pdf in this repo.

Security and Liability

All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

App

A front-end for the token lock contract based on next.js.

Setup

Config

In local development you might want to connect the app to different contract instances on Rinkeby. To do this edit CONTRACT_ADDRESSES map in ./packages/app/config.ts

Start local dev server

cd packages/app
yarn install
yarn dev

Build for production

cd packages/app
yarn install
yarn static

The output is written to packages/app/out

License

Created under the LGPL-3.0+ license.