Chronos Locker

Chronos Locker provides smart contracts for token lockup and vesting plans, designed for responsible token allocations to investors, employees, and contributors. This repository contains the EVM-compatible smart contracts for the Somnia Network.

The plans lock up ERC20 tokens and mint an ERC721 token to the recipient, representing their right to unlock those tokens over time. The vesting and unlocking schedules are linear and periodic, based on seconds, allowing for flexible frequencies (per second, day, week, etc.).

Key features include:

• Start Dates: Set a start date for the unlocking/vesting process, which can be in the past or future.
• Cliff Dates: Define a cliff date for when the first portion of tokens can be redeemed.
• Revocable Vesting Plans: A Vesting Admin can revoke plans if a beneficiary's relationship with the organization ends (e.g., an employee leaves).
• Non-Revocable Lockup Plans: Lockup plans are non-revocable but are transferable by default.
• Partial Redemption: Ability to redeem a portion of the unlocked tokens, rather than the entire available amount.
• Plan Segmentation: Break up lockup plans into smaller segments and recombine them, useful for secondary markets.

Contracts Overview

The following contracts are the primary points of interaction for users:

• TokenVestingPlans.sol: Vesting plans.
• TokenLockupPlans.sol: Lockup plans (NFTs are transferable).
• TokenLockupPlans_Bound.sol: Lockup plans (NFTs are not transferable).
• BatchPlanner.sol: A utility contract for creating multiple vesting or lockup plans in a single transaction.

Repository Navigation

All smart contracts are located in the ./contracts folder. The core contracts are in the ./contracts/LockupPlans and ./contracts/VestingPlans folders. Shared logic for storage, URI administration, and other functionalities is in ./contracts/sharedContracts.

Deployment

To deploy the contracts to the Somnia Network, create a .env file with your private key and the Somnia RPC URL. Then, run the deployment script:

npx hardhat run scripts/deploy.js --network somnia-testnet

## Deployed Contracts on Somnia Testnet

- **TokenVestingPlans:** `0xbB8c02810498b040B24451708985f37F79810c0a`
- **VotingTokenVestingPlans:** `0xC1Ce4c378300e5F8fA2CEb9707DeF7A493894fc0`
- **TokenLockupPlans:** `0x6487F2e1A008E0445fde29Ce9547f52FA8a927C1`
- **VotingTokenLockupPlans:** `0xF360fb7198EA47FBb45831DF6CBc32c29922087c`
- **TokenLockupPlans_Bound:** `0xa542C310977951774C74f6Ae8cEDE02b2f135286`
- **VotingTokenLockupPlans_Bound:** `0xed32f10322cea0ec198f94B3FF596537aD250041`
- **BatchPlanner:** `0xffD0b4C12e7C2D4FC169C396bf0dBfe9688b58Bf`
- **ClaimCampaigns:** `0xF9C7A97b702D2940F4Fa060E4e46E4390bDB66a2`