Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into feat/forwarder
Browse files Browse the repository at this point in the history
  • Loading branch information
mustermeiszer committed Nov 14, 2023
2 parents 4245295 + a6d2c83 commit 373a098
Show file tree
Hide file tree
Showing 42 changed files with 4,263 additions and 2,640 deletions.
6 changes: 6 additions & 0 deletions .env.centrifuge_demo
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
ADMIN=0x423420Ae467df6e90291fd0252c0A8a637C1e03f
PRIVATE_KEY=8e3ec2b1affade3231c6a81c299988176e0343dd8ce9f0986d66ed13e0f178d9
AXELAR_GATEWAY=0x6aF9C075d8C11b9A2CD66bbA801481b3c7A96488
RPC_URL=https://fullnode.demo.k-f.dev
CHAIN_ID=2031
ETHERSCAN_KEY=RESKUIN5V7MS5DCB3TZM6NC249B4FBTRZW
8 changes: 8 additions & 0 deletions .env.goerli
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
ADMIN=0x423420Ae467df6e90291fd0252c0A8a637C1e03f
PRIVATE_KEY=8e3ec2b1affade3231c6a81c299988176e0343dd8ce9f0986d66ed13e0f178d9
AXELAR_GATEWAY=0xe432150cce91c13a887f7D836923d5597adD8E31
CENTRIFUGE_FORWARDER=0xe6091b3Cc04584EaDbeCA59f2FdD0D81606f410b
RPC_URL=https://goerli.infura.io/v3/a4ba76cd4be643618572e7467a444e3a
ETHERSCAN_KEY=RESKUIN5V7MS5DCB3TZM6NC249B4FBTRZW
CHAIN_ID=5
SETUP_TEST_DATA=true
58 changes: 29 additions & 29 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,33 +113,33 @@ jobs:
coverage-files: ./lcov.info
minimum-coverage: 60 # Set coverage threshold.

slither-analyze:
runs-on: "ubuntu-latest"
permissions:
actions: "read"
contents: "read"
security-events: "write"
steps:
- name: "Check out the repo"
uses: "actions/checkout@v3"
with:
submodules: "recursive"

- name: "Run Slither analysis"
uses: "crytic/[email protected]"
id: "slither"
with:
fail-on: "none"
sarif: "results.sarif"
solc-version: "0.8.21"
target: "src/"

- name: Upload SARIF file
uses: github/codeql-action/upload-sarif@v2
with:
sarif_file: ${{ steps.slither.outputs.sarif }}
# slither-analyze:
# runs-on: "ubuntu-latest"
# permissions:
# actions: "read"
# contents: "read"
# security-events: "write"
# steps:
# - name: "Check out the repo"
# uses: "actions/checkout@v3"
# with:
# submodules: "recursive"

# - name: "Run Slither analysis"
# uses: "crytic/[email protected]"
# id: "slither"
# with:
# fail-on: "none"
# sarif: "results.sarif"
# solc-version: "0.8.21"
# target: "src/"

# - name: Upload SARIF file
# uses: github/codeql-action/upload-sarif@v2
# with:
# sarif_file: ${{ steps.slither.outputs.sarif }}

- name: "Add Slither summary"
run: |
echo "## Slither result" >> $GITHUB_STEP_SUMMARY
echo "✅ Uploaded to GitHub code scanning" >> $GITHUB_STEP_SUMMARY
# - name: "Add Slither summary"
# run: |
# echo "## Slither result" >> $GITHUB_STEP_SUMMARY
# echo "✅ Uploaded to GitHub code scanning" >> $GITHUB_STEP_SUMMARY
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Liquidity Pools enable seamless deployment of Centrifuge RWA pools on any EVM-co
![Architecture](./assets/architecture.svg)

Investors can invest in multiple tranches for each RWA pool. Each of these tranches is a separate deployment of a Liquidity Pool and a Tranche Token.
- [**Liquidity Pool**](https://github.com/centrifuge/liquidity-pools/blob/main/src/LiquidityPool.sol): 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.
- [**Liquidity Pool**](https://github.com/centrifuge/liquidity-pools/blob/main/src/LiquidityPool.sol): An [ERC-7540](https://eips.ethereum.org/EIPS/eip-7540) (extension of [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/Tranche.sol): An [ERC-20](https://ethereum.org/en/developers/docs/standards/tokens/erc-20/) token for the tranche, linked to a [`RestrictionManager`](https://github.com/centrifuge/liquidity-pools/blob/main/src/token/RestrictionManager.sol) that manages transfer restrictions. Prices for tranche tokens are computed on Centrifuge.

The deployment of these tranches and the management of investments is controlled by the underlying InvestmentManager, TokenManager, Gateway, and Routers.
Expand All @@ -33,5 +33,13 @@ To run all tests locally:
forge test
```

## Audit reports

| Auditor | Report link |
|---|---|
| Code4rena | [`September 2023 - Code4rena Report`](https://code4rena.com/reports/2023-09-centrifuge) |
| SRLabs | [`September 2023 - SRLabs Report`](https://github.com/centrifuge/liquidity-pools/blob/main/audits/2023-09-SRLabs.pdf) |
| Spearbit | [`October 2023 - Cantina Managed Report`](https://github.com/centrifuge/liquidity-pools/blob/main/audits/2023-10-Spearbit-Cantina-Managed.pdf) |

## License
This codebase is licensed under [GNU Lesser General Public License v3.0](https://github.com/centrifuge/centrifuge-chain/blob/main/LICENSE).
This codebase is licensed under [GNU Lesser General Public License v3.0](https://github.com/centrifuge/liquidity-pools/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion assets/architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 373a098

Please sign in to comment.