docs: migrate README from tmc

Author: moven0831

README.md

@@ -1,23 +1,77 @@
-# Overview
+# Cyferio SDK
 
-This package is a convenient starting point for building a rollup using the Sovereign SDK:
+> [!IMPORTANT]  
+> To try out the FHE module, please visit [`feat/confidential-token`](https://github.com/cyferio-labs/cyferio-sdk/tree/feat/confidential-token) branch
 
-## The repo structure:
+## Overview
 
-- `crates/stf`: The `STF` is derived from the `Runtime` and is used in the `rollup` and `provers` crates.
-- `crates/provers`: This crate is responsible for creating proofs for the `STF`.
-- `crates/rollup`: This crate runs the `STF` and offers additional full-node functionalities.
+Cyferio SDK is a modular rollup framework with Fully Homomorphic Encryption (FHE) integration that simplifies the creation and management of confidential rollups, providing developers with the necessary tools to build privacy-preserving applications.
 
-(!) Note for using WIP repo.
-This repo utilizes private [Sovereign SDK repo](https://github.com/Sovereign-Labs/sovereign-sdk-wip) and default cargo needs this environment variable to use an SSH key:
+By leveraging FHE, advanced modular rollup designs, and parallelism in computational proofs within a trustless computing layer, Cyferio SDK enables secure, near real-time computations on both public and private on-chain states while preserving composability and interoperability.
+
+## Key Features
+
+- **Modular Architecture**: Highly adaptable zk-rollup framework integrating state-of-the-art privacy-preserving solutions like FHE and Zero-Knowledge Proofs (ZKPs).
+  
+- **Module System Interface**:
+  - Supports both stateless and stateful modules, enhancing composability.
+  - Incorporates FHE-powered modules using the TFHE-rs library for computations on encrypted data.
+
+- **Data Availability Interface**:
+  - Integrates with various data availability solutions (e.g., Celestia, Avail).
+  - Compatible with mainstream Layer 1 blockchains for settlement layers.
+
+- **zkVM Interface**:
+  - Supports optimistic, zero-knowledge, and verifiable FHE virtual machines.
+  - Compatible with various zkVMs, including RISC Zero and SP1.
+  - Produces succinct verifiable proofs for transaction executions.
+
+- **Threshold Service Network**:
+  - Secure key management for FHE keys.
+  - Robust FHE key generation and threshold decryption using MPC protocols.
+
+<p align="center">
+ <img src="assets/Cyferio SDK Arch.png" alt="TMC architecture"/>
+    <br>
+    <em>The Architecture of Cyferio SDK</em>
+</p>
+
+## Use Cases
+
+- **DeFi**:
+  - **Dark Pools**: Enable private large trades to reduce market impact.
+  - **Blind Auctions**: Conduct auctions with hidden bids to prevent manipulation.
+  - **MEV-Resistant DEXs**: Build exchanges where transactions can't be front-run.
+  - **Private Prediction Markets**: Enable on-chain prediction markets with confidential betting.
+
+- **Social Applications**:
+  - **Efficient Identity Verification**: Perform identity checks without constant off-chain data retrieval.
+  - **Privacy-Preserving Interactions**: Ensure all user interactions remain private.
+
+- **Gaming**:
+  - **Real-Time Response**: Enable near real-time transaction responses in distributed systems.
+  - **Secure Interactions**: Operate nodes in a "dark forest" state for enhanced security.
+  - **Asset Integration**: Flexible combination of DeFi and GameFi assets.
+  - **Flexible Gas Fees**: Implement dynamic gas fee structures to lower entry barriers.
+
+<p align="center">
+ <img src="assets/Cyferio SDK flow.png" alt="Cyferio SDK flow"/>
+    <br>
+    <em>The Workflow of Cyferio SDK</em>
+</p>
+
+## Getting Started
+
+Cyferio SDK is integrated with the [`Cyferio Hub`](https://github.com/cyferio-labs/cyferio-hub-node) in default. That means for local development environment, you have to run the Cyferio Hub node as DA layer before creating your confidential rollup with Cyferio SDK. Please refer to the [Cyferio Hub README](https://github.com/cyferio-labs/cyferio-hub-node/blob/main/README.md) for more details.
+
+Note that for local debugging, you can simply switch to `mock_da` by changing the feature flag in `crates/rollup/Cargo.toml`
 
 ```
-export CARGO_NET_GIT_FETCH_WITH_CLI=true
+[features]
+default = ["mock_da", "risc0"]
 ```
 
-# Running the sov-rollup-starter
-
-## How to run the sov-rollup-starter with mock-da
+## How to run the demo rollup with mock-da
 
 1. Change the working directory:
 
@@ -46,14 +100,16 @@ $ make test-create-token
 ```
 
 5. Note the transaction hash from the output of the above command
-   ```text
-   Submitting tx: 0: 0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db
-   Transaction 0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db has been submitted: AcceptTxResponse { data: TxInfo { id: TxHash("0xa02ed59b5c698d49ad088584b86aff2134fd8e96746c1fce57b2518eb7c843e2"), status: Submitted }, meta: {} }
-   Triggering batch publishing
-   Your batch was submitted to the sequencer for publication. Response: SubmittedBatchInfo { da_height: 2, num_txs: 1 }
-   Going to wait for target slot number 2 to be processed, up to 300s
-   Rollup has processed target DA height=2!
-   ```
+
+```text
+Submitting tx: 0: 0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db
+Transaction 0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db has been submitted: AcceptTxResponse { data: TxInfo { id: TxHash("0xa02ed59b5c698d49ad088584b86aff2134fd8e96746c1fce57b2518eb7c843e2"), status: Submitted }, meta: {} }
+Triggering batch publishing
+Your batch was submitted to the sequencer for publication. Response: SubmittedBatchInfo { da_height: 2, num_txs: 1 }
+Going to wait for target slot number 2 to be processed, up to 300s
+Rollup has processed target DA height=2!
+```
+
 6. To get the token address, fetch the events of the transaction hash from #5
 
 ```bash,test-ci
@@ -126,67 +182,4 @@ $ curl -Ss http://127.0.0.1:12346/modules/bank/tokens/token_17zrpsyv06x7wmf2hg87
 {"data":{"amount":1000000,"token_id":"token_17zrpsyv06x7wmf2hg878gg5szwurckr3e2u77fvrdmanjhve8r2sj4jy42"},"meta":{}}
 ```
 
-## How to run the sov-rollup-starter using Celestia Da
-
-1. Change the working directory:
-   ```bash
-   $ cd crates/rollup/
-   ```
-2. If you want to run a fresh rollup, clean the database:
-   ```bash
-   $ make clean
-   ```
-3. Start the Celestia local docker service. (make sure you have docker daemon running).
-   ```bash
-   $ make start
-   ```
-4. Start the rollup node with the feature flag building with the celestia adapter. To build with the sp1 prover, you may replace `risc0` with `sp1`.
-   This will compile and start the rollup node:
-   ```bash
-   $ cargo run --bin node --no-default-features --features celestia_da,risc0
-   ```
-5. Submit a token creation transaction to the `bank` module.
-   To build with the sp1 prover, you may replace `risc0` with `sp1`.
-   Using `CELESTIA=1` will enable the client to be built with Celestia support and submit the test token
-   ```bash
-   $ CELESTIA=1 ZKVM=risc0 make test-create-token
-   ```
-6. Note the transaction hash from the output of the above command
-   ```text
-   Submitting tx: 0: 0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db
-   Transaction 0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db has been submitted: AcceptTxResponse { data: TxInfo { id: TxHash("0xa02ed59b5c698d49ad088584b86aff2134fd8e96746c1fce57b2518eb7c843e2"), status: Submitted }, meta: {} }
-   Triggering batch publishing
-   Your batch was submitted to the sequencer for publication. Response: SubmittedBatchInfo { da_height: 2, num_txs: 1 }
-   Going to wait for target slot number 2 to be processed, up to 300s
-   Rollup has processed target DA height=2!
-   ```
-7. To get the token address, fetch the events of the transaction hash from #5
-
-   ```bash
-   $ curl -sS http://127.0.0.1:12346/ledger/txs/0xc4a09c4bc4e0a2425384de1f9d468070f4616f03d503367287774c7191ef25db
-   # Output omitted, should be similar to what has been seen in mock-da section
-   ```
-
-8. Get a total supply of the token:
-
-```bash,test-ci,bashtestmd:compare-output
-$ curl -Ss http://127.0.0.1:12346/modules/bank/tokens/token_17zrpsyv06x7wmf2hg878gg5szwurckr3e2u77fvrdmanjhve8r2sj4jy42/total-supply | jq -c -M
-{"data":{"amount":1000000,"token_id":"token_17zrpsyv06x7wmf2hg878gg5szwurckr3e2u77fvrdmanjhve8r2sj4jy42"},"meta":{}}
-```
-
-## Enabling the prover
-
-By default, demo-rollup disables proving (i.e. the default behavior is. If we want to enable proving, several options are available:
-
-- `export SOV_PROVER_MODE=skip` Skips verification logic.
-- `export SOV_PROVER_MODE=simulate` Run the rollup verification logic inside the current process.
-- `export SOV_PROVER_MODE=execute` Run the rollup verifier in a zkVM executor.
-- `export SOV_PROVER_MODE=prove` Run the rollup verifier and create a SNARK of execution.
-
-#### Note: Check that users and sequencers have enough tokens to pay for the transactions.
-
-For the transaction to be processed successfully, you have to ensure that the sender account has enough funds to pay for the transaction fees and the sequencer has staked enough tokens to pay for the pre-execution checks. This `README` file uses addresses from the `./test-data/genesis/demo/mock` folder, which are pre-populated with enough funds.
-
-To be able to execute most simple transactions, the transaction sender should have about `1_000_000_000` tokens on their account and the sequencer should have staked `100_000_000` tokens in the registry.
-
-More details can be found in the Sovereign book [available here](https://github.com/Sovereign-Labs/sovereign-book).
+Feel free to explore and contribute to the project. For any questions or issues, please open an issue or contact the maintainers.