Mean Transformers

With this repository, we are now defining the concept of dependent tokens. These are tokens that depend on one or more underlying tokens, they can't exist on their own. This concept can apply to some known types of tokens, such as:

• Wrappers (WETH/WMATIC/WBNB)
• ERC-4626 tokens
• LP tokens

In this repository, we will build our Transformers. These are smart contract that knows how to map dependent tokens into their underlying counterparts, and vice-versa. We are doing this so that we can abstract the way tokens can be transformed between each other.

Finally, this repository also contains Mean's "transformers registry". All transformers will be registered to this contract, so that all clients can interact with the registry directly, without having to know all existing transformers.

🔒 Audits

Oracles has been audited by Omniscia and can be find here.

📦 NPM/YARN Package

• NPM Installation

npm install @mean-finance/transformers

• Yarn installation

yarn add @mean-finance/transformers

👨‍💻 Development environment

• Copy environment file

cp .env.example .env

• Fill environment file with your information

nano .env

🧪 Testing

Unit

yarn test:unit

Will run all tests under test/unit

E2E

yarn test:e2e

Will run all tests under test/e2e

Integration

You will need to set up the development environment first, please refer to the development environment section.

yarn test:integration

Will run all tests under test/integration

🚢 Deployment

You will need to set up the development environment first, please refer to the development environment section.

yarn deploy --network [network]

The plugin hardhat-deploy is used to deploy contracts.

📖 Deployment Registry

Contracts are deployed at the same address on all available networks via the deterministic contract factory

Available networks: Optimism, Arbitrum One, Polygon.

• TransformerRegistry: 0xC0136591Df365611B1452B5F8823dEF69Ff3A685
• ERC4626Transformer: 0x7CbdcA3c992953bdd536BE234973686D758DAabc
• ProtocolTokenWrapperTransformer: 0xfd55b5A6F61f22c70f4A1d8e63d181c6D0a290c6