90 lines
3.4 KiB
Markdown
90 lines
3.4 KiB
Markdown
# Tornado Instances Factory
|
|
|
|
## About
|
|
|
|
This repository contains:
|
|
|
|
1. `InstanceFactory` - instance factory for the creation new Tornado ERC20 pools
|
|
2. `InstanceFactoryWithRegistry` - governance proposal factory for the addition of new Tornado ERC20 instances to the Tornado router
|
|
|
|
### InstanceFactory
|
|
|
|
Anyone can create a new ERC20 instance by calling `createInstanceClone` method of the factory with parameters:
|
|
|
|
1. `address token` - address of ERC20 token for a new instance
|
|
2. `uint256 denomination` - denomination for new instance (tokens can only be deposited in certain denominations into instances)
|
|
|
|
### InstanceFactoryWithRegistry
|
|
|
|
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):
|
|
|
|
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.
|
|
|
|
## Factory parameters
|
|
|
|
### InstanceFactoryWithRegistry
|
|
|
|
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`.
|
|
|
|
## Warnings
|
|
|
|
1. This version of the factory creates a proposal for **immutable** Tornado instance initialization.
|
|
2. For `InstanceFactoryWithRegistry` 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.
|
|
|
|
## Tests
|
|
|
|
Setting up the repository:
|
|
|
|
```bash
|
|
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.
|
|
|
|
To run test scripts:
|
|
|
|
```bash
|
|
yarn test
|
|
```
|
|
|
|
Test scripts cover instance factory deployment, proposal deployment and executing proposal.
|
|
|
|
## Deploy
|
|
|
|
Check config.js for actual values.
|
|
|
|
With `salt` = `0x0000000000000000000000000000000000000000000000000000000047941987` address must be:
|
|
|
|
1. `InstanceFactory` - `0x9A04e3F1091A69CB53D163abE7ad9bbc86C23823`
|
|
1. `InstanceFactoryWithRegistry` - `0xee994E045B9Ec5a37f3f85d34f9fD087A0c69236`
|
|
|
|
Check addresses with current config:
|
|
|
|
```shell
|
|
yarn compile
|
|
node -e 'require("./src/generateAddresses").generateWithLog()'
|
|
```
|
|
|
|
Deploy InstanceFactory:
|
|
|
|
```shell
|
|
yarn hardhat run scripts/deployInstanceFactory.js --network mainnet
|
|
```
|
|
|
|
Deploy InstanceFactoryWithRegistry:
|
|
|
|
```shell
|
|
yarn hardhat run scripts/deployInstanceFactoryWithRegistry.js --network mainnet
|
|
```
|
|
|
|
Verify InstanceFactory on Etherscan:
|
|
|
|
```
|
|
yarn hardhat verify --network <network-name> <contract-address> <constructor-arguments>
|
|
```
|