Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #75

Merged
merged 2 commits into from
Aug 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Connectors
Connectors enables seamless deployment of Centrifuge RWA pools on any EVM-compatible blockchain.
# Liquidity Pools
Liquidity Pools enable seamless deployment of Centrifuge RWA pools on any EVM-compatible blockchain.

## How it works
<a href="https://github.com/centrifuge/connectors">
<a href="https://github.com/centrifuge/liquidity-pools">
<img alt="Centrifuge" src="contracts.png">
</a>

Investors can invest in multiple tranches for each RWA pool. Each of these tranches is a separate deployment of an Liquidity Pool and a Tranche Token.
- **Liquidity Pool** (WIP): A [ERC-4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/) compatible contract that enables investors to deposit and withdraw stablecoins to invest in tranches of pools.
- [**Tranche Token**](https://github.com/centrifuge/connectors/blob/main/src/token/restricted.sol): An [ERC-20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/) token for the tranche, linked to a [`Memberlist`](https://github.com/centrifuge/connectors/blob/main/src/token/memberlist.sol) that manages transfer restrictions.
- **Liquidity Pool**: A [ERC-4626](https://ethereum.org/en/developers/docs/standards/tokens/erc-4626/) compatible contract that enables investors to deposit and withdraw stablecoins to invest in tranches of pools.
- [**Tranche Token**](https://github.com/centrifuge/liquidity-pools/blob/main/src/token/restricted.sol): An [ERC-20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/) token for the tranche, linked to a [`Memberlist`](https://github.com/centrifuge/liquidity-pools/blob/main/src/token/memberlist.sol) that manages transfer restrictions.

The deployment of these tranches and the management of investments is controlled by the underlying Connector, Gateway, and Routers.
- [**Connector**](https://github.com/centrifuge/connectors/blob/main/src/Connector.sol): The core business logic contract that handles pool creation, tranche deployment, managing investments and sending tokens to the [`Escrow`](https://github.com/centrifuge/connectors/blob/main/src/Escrow.sol), and more.
- [**Gateway**](https://github.com/centrifuge/connectors/blob/main/src/routers/Gateway.sol): Intermediary contract that encodes and decodes messages using [`Messages`](https://github.com/centrifuge/connectors/blob/main/src/Messages.sol) and perform validations such as rate limits.
- [**Routers**](https://github.com/centrifuge/connectors/tree/main/src/routers): Contracts that handle communication of messages to and from Centrifuge Chain.
The deployment of these tranches and the management of investments is controlled by the underlying InvestmentManager, Gateway, and Routers.
- [**InvestmentManager**](https://github.com/centrifuge/liquidity-pools/blob/main/src/Connector.sol): The core business logic contract that handles pool creation, tranche deployment, managing investments and sending tokens to the [`Escrow`](https://github.com/centrifuge/liquidity-pools/blob/main/src/Escrow.sol), and more.
- [**Gateway**](https://github.com/centrifuge/liquidity-pools/blob/main/src/routers/Gateway.sol): Intermediary contract that encodes and decodes messages using [`Messages`](https://github.com/centrifuge/liquidity-pools/blob/main/src/Messages.sol) and perform validations such as rate limits.
- [**Routers**](https://github.com/centrifuge/liquidity-pools/tree/main/src/routers): Contracts that handle communication of messages to and from Centrifuge Chain.

## Developing
#### Getting started
Expand Down
Binary file modified contracts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.