tornado-pool-factory/README.md

44 lines
2.1 KiB
Markdown
Raw Normal View History

2022-02-22 20:15:37 +01:00
# Tornado Instances Factory
2022-02-22 21:03:16 +01:00
2021-10-24 21:54:07 +02:00
## About
2022-02-22 20:15:37 +01:00
This repository contains governance proposal factory for the addition of new Tornado ERC20 instances to the Tornado router.
2021-10-24 21:54:07 +02:00
2022-02-22 21:03:16 +01:00
Anyone can create governance proposal for the addition of a new ERC20 instance by calling `createProposalApprove/createProposalPermit` method of the factory with parameters (proposal creation fee in TORN is charged from sender):
2022-02-22 20:15:37 +01:00
1. `address token` - address of ERC20 token for a new instance
2. `uint24 uniswapPoolSwappingFee` - fee value of Uniswap instance which will be used for `TORN/token` price determination. `3000` means 0.3% fee Uniswap pool.
3. `uint256[] denominations` - list of denominations for each new instance (tokens can only be deposited in certain denominations into instances).
4. `uint32[] protocolFees` - list of protocol fees for each new instance (this fee is only charged from registrated relayer during withdrawal process). `100` means 1% of instance denomination fee for withdrawal throw registrated relayer.
2022-02-22 21:03:16 +01:00
2022-02-22 20:15:37 +01:00
## Factory parameters
2022-02-22 21:03:16 +01:00
2022-02-22 20:15:37 +01:00
1. `max number of new instances in one proposal` - the current version supports the addition of a maximum of 3 instances at once.
2. `proposal creation fee` - this fee is charged from creator of proposal during `createProposalApprove/createProposalPermit` factory method execution. It can be changed by governance. Default value is stored in `config.js`.
2022-02-22 21:03:16 +01:00
2022-02-23 15:03:05 +01:00
## Warnings
1. This version of the factory creates a proposal for **immutable** Tornado instance initialization.
2. Users should manually propose a proposal after its creation using the factory (in governance UI for example). As `propose()` method caller must have 1000 TORN locked in the governance. Moreover, the proposer can't propose more than one proposal simultaneously.
2022-02-22 20:15:37 +01:00
## Tests
2021-10-24 21:54:07 +02:00
Setting up the repository:
```bash
git clone https://github.com/mirru2532/tornado-instances.git
cd tornado-instances
yarn
cp .env.example .env
```
Please fill out .env according to the template provided in it. Please ensure that all of the example values are set to the correct addresses.
2021-10-24 21:54:07 +02:00
To run test scripts:
```bash
yarn test
```
2022-02-22 20:15:37 +01:00
Test scripts cover instance factory deployment, proposal deployment and executing proposal.