Cookies Protocol Token

Getting Started

Recommended Node version is 16.0.0.

$ yarn
$ yarn compile
$ yarn testf

Project Structure

This a hardhat typescript project with hardhat-deploy extension. Solidity version 0.8.15

Tests

Tests are found in the ./test/ folder.

To run tests

$ yarn testf

To run coverage

$ yarn coverage

Coverage result

  Token
    Time-lock transfer
      ✔ should transfer tokens if user is not locked (74ms)
      ✔ should deny transfer while user is locked (105ms)
      ✔ should let user transfer tokens if owner unlock him (72ms)
      ✔ should set unlock times for user only by owner
      ✔ should deny set unlock times with different length array
      ✔ should deny set more than 100 users per call (93ms)
    Antisnipe
      ✔ should set antisnipe address only by owner
      ✔ should disable antisnipe in one-way only by owner (38ms)
      ✔ should call antisnipe contract when enable (110ms)


  9 passing (787ms)

----------------------|----------|----------|----------|----------|----------------|
File                  |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
----------------------|----------|----------|----------|----------|----------------|
 contracts/           |      100 |      100 |      100 |      100 |                |
  CookiesProtocol.sol |      100 |      100 |      100 |      100 |                |
 contracts/mock/      |      100 |      100 |      100 |      100 |                |
  AntisnipeMock.sol   |      100 |      100 |      100 |      100 |                |
----------------------|----------|----------|----------|----------|----------------|
All files             |      100 |      100 |      100 |      100 |                |
----------------------|----------|----------|----------|----------|----------------|

Contracts

Solidity smart contracts are found in ./contracts/. ./contracts/mock folder contains contracts mocks that are used for testing purposes.

Deploy

Deploy script can be found in the ./deploy/localhost for local testing and ./deploy/mainnet for mainnet deploy

Generate .env file

$ cp .env.example .env

Add .env file to the project root.

To add the private key of a deployer account, assign the following variable

PRIVATE_TEST=
PRIVATE_MAIN=

To add API Keys for verifying

API_ETH=
API_BSC=
API_POLYGON=
API_AVAX=
API_FTM=
API_ARBITRUM=

To deploy contracts on Polygon chain

$ yarn deploy --network polygon_mainnet

Deployments

Deployments on mainnets and testnets store in ./deployments

Verify

To verify contracts on Polygon chain

$ yarn verify --network polygon_mainnet

Tokenomics

• Currency Name: Cookies Protocol
• Token symbol: CP
• Supported Chain: MATIC (Polygon Chain)
• Total supply: 100,000,000,000,000 CP
• Decimal number: 18

Tokenomics

Custom functionality

Antisnipe

3rd party dependecy to protect tokens from bot snipers

Function setAntisnipeAddress

function setAntisnipeAddress(address addr) external onlyOwner

Only owner can set antisnipe address

Function setAntisnipeDisable

function setAntisnipeDisable() external onlyOwner

Only owner can one-way disable antisnipe

Time-lock transfers

Ability to lock tokens for the user up to a certain moment

Function setUnlockTimes

function setUnlockTimes(address[] calldata users, uint256[] calldata timestamps) external onlyOwner

Only the owner can set the unlock time for users (100 users per call). This prevents users from transferring the token before the unlock time

Overriding _beforeTokenTransfer

ERC20 function _beforeTokenTransfer overriding in CookiesProtocol to implement Time-lock transfer and Antisnipe functionality