Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/balmy-protocol/transformers

This repository contains both all Mean's transformers, and the transformer registry
https://github.com/balmy-protocol/transformers

Last synced: 5 days ago
JSON representation

This repository contains both all Mean's transformers, and the transformer registry

Host: GitHub
URL: https://github.com/balmy-protocol/transformers
Owner: Balmy-protocol
License: gpl-3.0
Created: 2022-06-23T17:15:12.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-03-18T19:34:54.000Z (8 months ago)
Last Synced: 2024-11-11T21:58:08.183Z (6 days ago)
Language: TypeScript
Size: 727 KB
Stars: 9
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Mean Transformers

[![Lint](https://github.com/Mean-Finance/mean-transformers/actions/workflows/lint.yml/badge.svg)](https://github.com/Mean-Finance/mean-transformers/actions/workflows/lint.yml)
[![Tests (unit, integration, e2e)](https://github.com/Mean-Finance/mean-transformers/actions/workflows/tests.yml/badge.svg)](https://github.com/Mean-Finance/mean-transformers/actions/workflows/tests.yml)
[![npm version](https://img.shields.io/npm/v/@mean-finance/mean-transformers/latest.svg)](https://www.npmjs.com/package/@mean-finance/mean-transformers/v/latest)

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](https://omniscia.io/) and can be find [here](https://omniscia.io/reports/mean-finance-transformers-module/).

## 📦 NPM/YARN Package

- NPM Installation

```bash
npm install @mean-finance/transformers
```

- Yarn installation

```bash
yarn add @mean-finance/transformers
```

## 👨‍💻 Development environment

- Copy environment file

```bash
cp .env.example .env
```

- Fill environment file with your information

```bash
nano .env
```

## 🧪 Testing

### Unit

```bash
yarn test:unit
```

Will run all tests under [test/unit](./test/unit)

### E2E

```bash
yarn test:e2e
```

Will run all tests under [test/e2e](./test/e2e)

### Integration

You will need to set up the development environment first, please refer to the [development environment](#-development-environment) section.

```bash
yarn test:integration
```

Will run all tests under [test/integration](./test/integration)

## 🚢 Deployment

You will need to set up the development environment first, please refer to the [development environment](#-development-environment) section.

```bash
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](https://github.com/Mean-Finance/deterministic-factory)

> Available networks: Optimism, Arbitrum One, Polygon.

- TransformerRegistry: `0xC0136591Df365611B1452B5F8823dEF69Ff3A685`
- ERC4626Transformer: `0x7CbdcA3c992953bdd536BE234973686D758DAabc`
- ProtocolTokenWrapperTransformer: `0xfd55b5A6F61f22c70f4A1d8e63d181c6D0a290c6`