Skip to content

Commit 4de9d53

Browse files
authored
address all the comments for ccdb tutorial (#2393)
1 parent e6826cf commit 4de9d53

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,9 @@
117117
* [How gas works](smart-contracts/filecoin-evm-runtime/how-gas-works.md)
118118
* [Precompiles](smart-contracts/filecoin-evm-runtime/precompiles.md)
119119
* [Programmatic storage](smart-contracts/programmatic-storage/README.md)
120-
* [Cross-Chain Data Bridge(CCDB)](smart-contracts/programmatic-storage/ccdb.md)
121120
* [Aggregated deal-making](smart-contracts/programmatic-storage/aggregated-deal-making.md)
122121
* [Direct deal-making](smart-contracts/programmatic-storage/direct-deal-making.md)
122+
* [Cross-Chain Data Bridge(CCDB)](smart-contracts/programmatic-storage/ccdb.md)
123123
* [Data replication, renewal and repair (RaaS)](smart-contracts/programmatic-storage/raas.md)
124124
* [RaaS interfaces](smart-contracts/programmatic-storage/raas-interfaces.md)
125125
* [Developing contracts](smart-contracts/developing-contracts/README.md)

smart-contracts/programmatic-storage/ccdb.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,30 @@ This tutorial will guide you through:
2020
## Architecture Overview
2121
A combination of on-chain contracts and off-chain services powers the cross-chain data bridge. At a high level, it consists of:
2222
1. [**Smart contracts**](https://github.com/FIL-Builders/onramp-contracts)
23-
- **On-Ramp Contract (Source Chain – Any EVM Chain)**
23+
- **OnRamp Contract (Source Chain – Any EVM Chain)**
2424
- This smart contract receives storage requests from users.
2525
- Verifies the data aggregation proof.
2626
- It holds the user’s payment in escrow and emits an event for off-chain agents.
2727
- **Oracle Contract (Source Chain – Same EVM Chain)**
2828
- Receives storage confirmations from Filecoin.
29-
- Validates proofs and triggers the On-Ramp to release escrowed funds.
29+
- Validates proofs and triggers the OnRamp to release escrowed funds.
3030
- **Prover Contract (Destination Chain – Filecoin Network)**
3131
- Verifies storage deals sealed on Filecoin.
3232
- Sends attestations (proofs) back to the source chain via a cross-chain messaging layer.
3333
- **Cross-Chain Messaging Bridge (e.g, Axelar)**
3434
- The system uses the Axelar network to transport messages between Avalanche and Filecoin.
3535
2. [**xChain Client (Off-Chain Agent)**](https://github.com/FIL-Builders/xchainClient)
36-
- Monitors the On-Ramp contract for new data offers.
36+
- Monitors the OnRamp contract for new data offers.
3737
- Handles file packaging (CAR file creation), CommP calculation, and deal submission to Filecoin.
3838
- It can also serve as a storage buffer for storage providers to retrieve data to make storage deals on Filecoin.
3939
### High-Level Workflow
4040
![](../../.gitbook/assets/CCDB.gif)
4141
The bridge’s workflow can be summarized in a multi-step process:
42-
1. **Store Data**: A user submits a storage offer to the On-Ramp contract on their EVM-compatible chain.
42+
1. **Upload Data**: A user submits a storage offer to the OnRamp contract on their EVM-compatible chain.
4343
1. **Data Aggregation**: The xChain client detects the offer from smart contract events, fetches the data, aggregates smaller data into a big piece, and sends the proof of aggregation back to the onramp contract.
4444
1. **Filecoin storage deal making**: The xChain client will send the storage deal proposal to the storage providers either through an on-chain smart contract or an off-chain process.
4545
1. **Bridging Proofs**: Once Filecoin confirms the data is stored, the Prover contract will receive the deal notification automatically and emit a proof via the Axelar cross-chain messaging network.
46-
1. **Payment Release**: The Oracle contract on the source chain verifies the proof and instructs the On-Ramp to release payment.
46+
1. **Payment Release**: The Oracle contract on the source chain verifies the proof and instructs the OnRamp to release payment.
4747

4848
Each component plays a vital role in ensuring trust-minimized and seamless data storage between chains. This modular design also makes the bridge extensible—one could integrate a different messaging layer or deal aggregator without changing the overall flow.
4949

@@ -53,7 +53,7 @@ Now that we understand the architecture, let’s see how to interact with the cr
5353
**Pre-Requisites**
5454
- **RPC endpoints** for your source EVM chain (e.g., Avalanche Fuji).
5555
- **Wallet** with enough native tokens (FIL & AVAX) and ERC-20 tokens for fees and storage payments.
56-
- Access to On-Ramp and Oracle contracts on Avalanche Fuji & Prover contract on the Filecoin network.
56+
- Access to OnRamp and Oracle contracts on Avalanche Fuji & Prover contract on the Filecoin network.
5757
- In this tutorial, we are going to use the pre-deployed contracts on Avalanche and Filecoin. The details are [here](#deployed-contracts-info).
5858
- In any case, if you need to deploy your version. Please follow the [deployment instructions](https://github.com/fil-builders/onramp-contracts?tab=readme-ov-file#-getting-started) on GitHub.
5959

@@ -208,7 +208,7 @@ The storage should be completed after some time (depending on the speed of the F
208208
const status = await onRamp.getOfferStatus(offerId);
209209
```
210210

211-
ou can also refer to this [dataBridgeDemo repo](https://github.com/FIL-Builders/dataBridgeDemo) as a reference for the implementation of storing your application data on Avalanche to the Filecoin network.
211+
You can also refer to this [dataBridgeDemo repo](https://github.com/FIL-Builders/dataBridgeDemo) as a reference for the implementation of storing your application data on Avalanche to the Filecoin network.
212212

213213
## Best Practices
214214

0 commit comments

Comments
 (0)