Skip to content
Open
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
7 changes: 7 additions & 0 deletions docs/user-v2/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
label: User Guide v2
position: 2
collapsible: true
collapsed: true
link:
type: generated-index
title: User Guide v2
35 changes: 35 additions & 0 deletions docs/user-v2/get-started/01_issuers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
id: issuers
title: Quickstart for Issuers
---

# Quickstart for Issuers

Get your RWA pool up and running on Centrifuge.

## Prerequisites

- **Entity Implementation**: Legal wrapper for your pool (SPV).
- **Wallet**: An EVM-compatible wallet (e.g., MetaMask, Rabby).
- **KYC Provider**: A partner to handle investor onboarding.

## Steps to Launch

1. **Design your Pool**
- Define assets, share classes, and fee structures.
- Choose your Hub chain (e.g., Centrifuge Chain, Base).

2. **Deploy Contracts**
- Use the **Centrifuge Launchpad** to deploy your pool without coding.
- This creates your specialized Vaults and Token contracts.

3. **Configure Permissions**
- Set up your allowlist criteria.
- Link your identity provider.

4. **Open for Investment**
- Share the investment link with your investors.
- Approve their onboarding requests.
- Start originating assets!

> [Detailed Offering Creation Guide](/user-v2/issuer/offering-creation)
39 changes: 39 additions & 0 deletions docs/user-v2/get-started/02_investors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
id: investors
title: Quickstart for Investors
sidebar_position: 2
---

# Quickstart for Investors

Get started investing in Centrifuge pools.

## Prerequisites

- **Wallet**: An EVM-compatible wallet (e.g., MetaMask, Rabby).
- **Funds**: Stablecoins (e.g., USDC) on a supported chain.
- **Eligibility**: Some pools require KYC/AML verification.

## Steps to Invest

1. **Find a Pool**
- Browse available pools on the Centrifuge App.
- Review the investment terms, asset backing, and expected returns.

2. **Complete Onboarding (if required)**
- Some pools require you to be whitelisted.
- Complete KYC with the pool's identity provider.

3. **Deposit Funds**
- Select the pool and the amount you wish to invest.
- Approve the token spend and confirm the transaction.

4. **Receive Share Tokens**
- For **synchronous vaults**, you receive shares immediately.
- For **asynchronous vaults**, your request is queued. Claim your shares once the request is processed.

5. **Redeem (when ready)**
- Submit a redemption request through the app.
- Claim your underlying assets after processing.

> [Detailed Investor Guide](/user-v2/investor)
2 changes: 2 additions & 0 deletions docs/user-v2/get-started/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
position: 1
collapsed: false
11 changes: 11 additions & 0 deletions docs/user-v2/get-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: get-started
title: Get Started
---

# Get Started

Welcome to the Centrifuge User Guide. This section is designed for issuers, integrators, and investors looking to interact with the Centrifuge protocol.

## Quickstart Guides

7 changes: 7 additions & 0 deletions docs/user-v2/investor/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
label: Investor Guide
position: 4
collapsible: true
collapsed: false
link:
type: generated-index
title: Investor Guide
83 changes: 83 additions & 0 deletions docs/user-v2/investor/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
id: index
title: Investor Guide
sidebar_position: 1
---

# Investor Guide

Investors participate in Centrifuge pools by investing in share tokens, gaining exposure to tokenized strategies offered by issuers or curators. Each pool is customizable, so access, currency, and liquidity terms can vary.

## Access requirements

Each pool defines its own permissioning logic. Before investing, ensure you meet the eligibility requirements.

### Whitelisting

Some pools require whitelisting before investment or redemption. This may include:

- KYC/AML verification
- Jurisdictional restrictions
- Wallet pre-approval

Whitelisting can apply to:

- **Investing only**
- **Redeeming only**
- **Both investing and redeeming**

You'll be notified during the process if your address must be whitelisted before interacting with the pool.

## Supported currencies

The currencies accepted for investment are defined per pool. Common options include:

- USDC
- Other pool assets
- Other ERC-20 tokens approved by the pool's issuer or curator

Each vault supports one or more investment assets depending on configuration.

## Available chains

Centrifuge operates on a **hub-and-spoke** model. Investors interact with pools on the **spoke chains** where the vaults are deployed.

You can invest directly from any supported chain selected by the issuer or curator, without needing to use the Hub chain yourself.

## Investing

To invest in a pool:

1. Navigate to the pool's page
2. Review the investment terms
3. Choose the amount and asset to deposit
4. Follow the onchain flow

### Vault behavior

Each pool uses one of the following vault types:

#### Synchronous vaults

- Follow the ERC-4626 standard
- Deposits are instant
- Shares are minted immediately to the investor
- Redemptions are processed through a request-based flow

#### Asynchronous vaults

- Follow the ERC-7540 standard
- Both deposits and redemptions happen in two steps:
- You submit a `requestDeposit` or `requestRedeem`
- Later, you complete the action using `claimDeposit` or `claimRedeem`
- Timing depends on the pool's processing schedule

Make sure to check whether the pool uses a synchronous or asynchronous flow before investing.

## What to consider

- **Access control**: Ensure your wallet is allowed to invest or redeem
- **Redemption timing**: Async vaults introduce a delay before funds are claimable
- **Chain experience**: Transactions must be performed on the same chain as the pool

Investors are encouraged to read the pool's documentation or terms carefully before participating.
49 changes: 49 additions & 0 deletions docs/user-v2/issuer/01_offering-creation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
id: offering-creation
title: Offering Creation
---

# Offering Creation

This guide covers the process of launching an asset-backed issuance using Centrifuge's RWA Launchpad.

## Issuance workflow

### 1. Configure your product

Use the Launchpad interface to configure:

- **Pool details**: Type, issuer info, providers, ratings.
- **Asset type**: Bond, equity, real estate, etc.
- **Share class structure**: Junior/senior tranches, token names.
- **Compliance rules**: Allowlist providers, jurisdictional controls.
- **Manager access controls**: Who can update the pool.

### 2. Deploy your pool

Launchpad deploys a suite of protocol-native contracts:

- ERC-20 share tokens with optional ERC-1404 restrictions
- Vaults using ERC-4626 (synchronous) or ERC-7540 (asynchronous)
- Pooled vaults using ERC-7575 to aggregate capital
- On/Off Ramp Manager to control asset movements
- Fee, accounting, and reporting modules

All contracts are upgrade-free and immutable once deployed.

### 3. Set up on/off-ramping

Configure on-chain and off-chain capital flows:

- **Onramp**: Any user can deposit approved ERC20 tokens into the pool.
- **Offramp**: Only authorized relayers can initiate withdrawals to predefined recipient addresses.

This ensures compliance and control over fund flows.

### 4. Launch your issuance

Once contracts are deployed and configured:

- Begin accepting deposits from whitelisted or open users.
- Mint and distribute share tokens.
- Fund vaults with capital or asset-backed flows.
31 changes: 31 additions & 0 deletions docs/user-v2/issuer/02_investor_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: investor-management
title: Investor Management
---

# Investor Management

Managing who can invest in your pool is a critical part of the Centrifuge protocol, especially for compliant RWA offerings.

## Access Control

Centrifuge pools use **Identity Providers** and **Verifiers** to ensure that only eligible addresses can hold share tokens.

### Whitelisting Investors

1. **Onboarding**: Investors undergo KYC/KYB with a third-party provider.
2. **Verification**: The provider signs a claim attached to the investor's onchain identity (DID).
3. **Permissioning**: The pool checks these claims against its allowed criteria (e.g., "Accredited Investor in US").

### Token Permissions

Each share class can have its own permission settings.
- **Permissioned Share Classes**: Restricted to whitelisted addresses. Transfers are gated by the token contract (ERC-1404).
- **Unrestricted Share Classes**: Can be held by any address (if configured).

## Investor Dashboard

Issuers can manage investor relationships through the Centrifuge App or their own portal, tracking:
- Active investors
- Pending onboarding requests
- Transaction history
31 changes: 31 additions & 0 deletions docs/user-v2/issuer/03_token_management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: token-management
title: Token Management
---

# Token Management

Managing who can invest in your pool is a critical part of the Centrifuge protocol, especially for compliant RWA offerings.

## Access Control

Centrifuge pools use **Identity Providers** and **Verifiers** to ensure that only eligible addresses can hold share tokens.

### Whitelisting Investors

1. **Onboarding**: Investors undergo KYC/KYB with a third-party provider.
2. **Verification**: The provider signs a claim attached to the investor's onchain identity (DID).
3. **Permissioning**: The pool checks these claims against its allowed criteria (e.g., "Accredited Investor in US").

### Token Permissions

Each share class can have its own permission settings.
- **Permissioned Share Classes**: Restricted to whitelisted addresses. Transfers are gated by the token contract (ERC-1404).
- **Unrestricted Share Classes**: Can be held by any address (if configured).

## Investor Dashboard

Issuers can manage investor relationships through the Centrifuge App or their own portal, tracking:
- Active investors
- Pending onboarding requests
- Transaction history
50 changes: 50 additions & 0 deletions docs/user-v2/issuer/04_distribution_mangement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
id: vault
title: Distribution Management
---

# Distribution Management

Vaults are how users interact with pools in Centrifuge. They define how assets are deposited, redeemed, and allocated across strategies.

Each share token is backed by one or more vaults. These vaults live on spoke chains, allowing users to invest directly from the chain of their choice. Vaults are configured to support either synchronous or asynchronous flows.

## Vault types

Centrifuge supports two types of vaults. Pool managers choose the right type depending on their product needs.

### Synchronous vaults

Synchronous vaults use the ERC-4626 standard. When users deposit, they immediately receive share tokens. These vaults offer real-time minting and are best suited for highly liquid strategies where on-demand issuance is feasible.

- Real-time minting
- Easy DeFi integration
- Ideal for liquid, onchain strategies

### Asynchronous vaults

Asynchronous vaults follow the ERC-7540 standard. In this model, deposits and redemptions are processed through a request lifecycle managed by the hub chain. Users submit a request and receive or redeem tokens after it’s been approved and priced.

- Request-based flow (invest and redeem)
- Suited for RWA strategies with offchain components
- Requests are queued, approved, priced, and fulfilled

## Multi-asset support

A single share token can be backed by **multiple vaults**, each accepting a different asset. For example, one share class might accept both USDC and DAI by deploying two separate vaults—each linked to the same token.

This setup is supported by [ERC-7575], allowing flexible entry points while consolidating capital into one balance sheet.

- Users can deposit different currencies
- Capital is aggregated and managed centrally
- Investors all receive the same share token regardless of entry asset

## How vaults connect to the protocol

Each vault is deployed to a spoke chain and connected to a pool via:

- A defined share class and share token
- Asset configuration (what currencies are accepted)
- Logic for investing, pricing, and redemption

Vaults can interact with external DeFi protocols or offchain strategies, depending on how the balance sheet and permissions are configured.
32 changes: 32 additions & 0 deletions docs/user-v2/issuer/05_defi-workflows.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
id: defi-workflows
title: DeFi Workflows
---

# DeFi Workflows

Centrifuge brings real-world assets into the DeFi ecosystem. Because share tokens are standard ERC-20s, they can be integrated into various DeFi protocols to unlock liquidity and utility.

## Lending & Borrowing

Tokenized assets can serve as collateral in lending markets.
- **MakerDAO**: Centrifuge assets have been used as collateral to mint DAI.
- **Aave / Compound**: Potential integration allows share tokens to be supplied as collateral to borrow stablecoins.

## Yield Aggregation

DeFi protocols can aggregate yield from Centrifuge pools.
- **ERC-4626 Vaults**: Protocols can deposit stablecoins into Centrifuge synchronous vaults to earn RWA yield programmatically.

## Secondary Markets

While primary issuance happens through the pool, secondary trading can occur on AMMs if permissions allow.
- **Liquidity Pools**: Restricted share tokens can be traded on permissioned liquidity pools.
- **OTC**: Large blocks can be traded over-the-counter between whitelisted institutions.

## Automating Strategies

Smart contacts can be written to:
1. Rebalance portfolios between different RWA vaults.
2. Automatically reinvest yield.
3. Programmably redeem based on risk parameters.
7 changes: 7 additions & 0 deletions docs/user-v2/issuer/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
label: Issuer Guide
position: 3
collapsible: true
collapsed: true
link:
type: generated-index
title: Issuer Guide
Loading