Tea.xyz Token Contract

Tokens

src/TeaToken/Tea.sol

The primary tea token.

Minting permissions controlled by the registry.owner() with a minter role being given to the TeaMasterChef contract by the factory.

A minting cap (not a supply cap due to burning) is hardcoded.

Dev Dependencies

This repo uses PaulRBerg's foundry-template.

• node
• pnpm
• rust
• foundry

Writing Tests

To write a new test contract, you start by importing PRBTest and inherit from it in your test contract. PRBTest comes with a pre-instantiated cheatcodes environment accessible via the vm property. If you would like to view the logs in the terminal output you can add the -vvv flag and use console.log.

Usage

This is a list of the most frequently needed commands.

Build

Build the contracts:

forge build

Clean

Delete the build artifacts and cache directories:

forge clean

Compile

Compile the contracts:

forge build

Coverage

Get a test coverage report:

forge coverage

Format

Format the contracts:

forge fmt

Gas Usage

Get a gas report:

forge test --gas-report

Lint

Lint the contracts:

pnpm lint

Test

Run the tests:

forge test

Notes

1. Foundry uses git submodules to manage dependencies. For detailed instructions on working with dependencies, please refer to the guide in the book
2. You don't have to create a .env file, but filling in the environment variables may be useful when debugging and testing against a fork.

License

This project is licensed under Apache License, Version 2.0.