tornadocash/tornado-pool-factory
1
0
Fork 0
mirror of https://github.com/tornadocash/tornado-pool-factory synced 2024-02-02 15:04:08 +01:00
Code Issues Packages Projects Releases Wiki Activity
12 Commits 1 Branch 0 Tags 485 KiB
JavaScript 75.6%
Solidity 24.4%
657ad0a497
Go to file
Drygin 657ad0a497 add warnings
2022-02-23 17:03:05 +03:00
.github/workflows add two instance creation test 2022-02-22 23:03:16 +03:00
contracts add warnings 2022-02-23 17:03:05 +03:00
scripts add creation fee logic 2022-02-22 19:20:33 +03:00
test add two instance creation test 2022-02-22 23:03:16 +03:00
.editorconfig rebasing 2021-10-24 21:54:07 +02:00
.env.example add instance factory tests 2022-02-17 23:15:19 +03:00
.eslintrc rebasing 2021-10-24 21:54:07 +02:00
.gitattributes rebasing 2021-10-24 21:54:07 +02:00
.gitignore move to Alchemy node 2022-02-16 12:52:53 +03:00
.nvmrc rebasing 2021-10-24 21:54:07 +02:00
.prettierignore rebasing 2021-10-24 21:54:07 +02:00
.prettierrc rebasing 2021-10-24 21:54:07 +02:00
.solcover.js automatically detect n of instances 2021-10-29 20:10:37 +02:00
config.js add new instance tests 2022-02-22 20:18:35 +03:00
hardhat.config.js move relayer registry init 2022-02-22 14:55:02 +03:00
package.json add instance factory tests 2022-02-17 23:15:19 +03:00
README.md add warnings 2022-02-23 17:03:05 +03:00
yarn.lock add instance factory tests 2022-02-17 23:15:19 +03:00

README.md

Tornado Instances Factory

About

This repository contains governance proposal factory for the addition of new Tornado ERC20 instances to the Tornado router.

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

  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. 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:

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.

To run test scripts:

yarn test

Test scripts cover instance factory deployment, proposal deployment and executing proposal.