Merge 6ace0f7040 into 898350e271

* lib.rs

* architecture.md

* chunk_write_control.rs

README.md

@@ -1,8 +1,8 @@
-# 0G Storage
+# 0G Storage: Decentralized AI-Optimized Storage
 
-## Overview
+## **Overview**
 
-0G Storage is a decentralized data storage system designed to address the challenges of high-throughput and low-latency data storage and retrieval, particularly for areas such as AI. 
+0G Storage is a decentralized storage system designed for massive data workloads, particularly AI and Web3 applications. Unlike traditional centralized storage, 0G distributes data across a network, improving security, availability, and scalability. 
 
 ## System Architecture
 
@@ -11,10 +11,16 @@
 1. **Data Publishing Lane**: Ensures fast Merkle tree data root commitment and verification through 0G Chain.
 2. **Data Storage Lane**: Manages large data transfers and storage using an erasure-coding mechanism for redundancy and sharding for parallel processing.
 
-Across the two lanes, 0G Storage supports the following features:
+The system is powered by **Proof of Random Access (PoRA)**, a consensus mechanism that incentivizes miners to store and verify data efficiently.
 
-* **General Purpose Design**: Supports atomic transactions, mutable key-value stores, and archive log systems, enabling a wide range of applications with various data types.
+## **Key Features**  
-* **Validated Incentivization**: Utilizes the PoRA (Proof of Random Access) mining algorithm to mitigate the data outsourcing issue and to ensure rewards are distributed to nodes who contribute to the storage network.
+- **Layered Storage Architecture:**  
+  - **Log Layer:** Stores unstructured, append-only data for archival use.  
+  - **Key-Value Layer:** Enables fast, structured data retrieval for dynamic applications.  
+- **Decentralized Incentives:** Storage nodes earn rewards in 0G tokens by participating in the network.  
+- **Scalability:** Optimized for AI workloads, with seamless integration into decentralized AI ecosystems.
+
+![0G Storage Architecture](.gitbook/assets/zg-proof-of-random-access.png)  
 
 For in-depth technical details about 0G Storage, please read our [Intro to 0G Storage](https://docs.0g.ai/0g-storage).
 
@@ -25,8 +31,9 @@ For in-depth technical details about 0G Storage, please read our [Intro to 0G St
 - If you want to build a project using 0G storage, please refer to the [0G Storage SDK](https://docs.0g.ai/build-with-0g/storage-sdk) guide.
 
 ## Support and Additional Resources
-We want to do everything we can to help you be successful while working on your contribution and projects. Here you'll find various resources and communities that may help you complete a project or contribute to 0G. 
+We want to do everything we can to help you be successful while working on your contribution and projects. Here, you'll find various resources and communities that may help you complete a project or contribute to 0G. 
 
 ### Communities
 - [0G Telegram](https://t.me/web3_0glabs)
 - [0G Discord](https://discord.com/invite/0glabs)
+- [OG X](https://x.com/0G_labs)

common/unused_port/src/lib.rs

@@ -11,7 +11,7 @@ pub fn unused_tcp_port() -> Result<u16, String> {
     unused_port(Transport::Tcp)
 }
 
-/// A convenience function for `unused_port(Transport::Tcp)`.
+/// A convenience function for `unused_port(Transport::Udp)`.
 pub fn unused_udp_port() -> Result<u16, String> {
     unused_port(Transport::Udp)
 }

docs/architecture.md

@@ -4,7 +4,7 @@
 
 ZeroGravity system consists of a data availability layer (0G DA) on top of a decentralized storage system (0G Storage). There is a separate consensus network that is part of both the 0G DA and the 0G Storage. For 0G Storage, the consensus is responsible for determining the ordering of the uploaded data blocks, realizing the storage mining verification and the corresponding incentive mechanism through smart contracts.
 
-Figure 1 illustrates the architecture of the 0G system. When a data block enters the 0G DA, it is first erasure coded and organized into multiple consecutive chunks through erasure coding. The merkle root as a commitment of the encoded data block is then submitted to the consensus layer to keep the order of the data entering the system. The chunks are then dispersed to different storage nodes in 0G Storage where the data may be further replicated to other nodes depending on the storage fee that the user pays. The storage nodes periodically participate the mining process by interacting with the consensus network to accrue rewards from the system.
+Figure 1 illustrates the architecture of the 0G system. When a data block enters the 0G DA, it is first erasure coded and organized into multiple consecutive chunks through erasure coding. The merkle root as a commitment of the encoded data block is then submitted to the consensus layer to keep the order of the data entering the system. The chunks are then dispersed to different storage nodes in 0G Storage where the data may be further replicated to other nodes depending on the storage fee that the user pays. The storage nodes periodically participate in the mining process by interacting with the consensus network to accrue rewards from the system.
 
 <figure><img src="../.gitbook/assets/zg-storage-architecture.png" alt=""><figcaption><p>Figure 1. The Architecture of 0G System</p></figcaption></figure>
 

node/chunk_pool/src/mem_pool/chunk_write_control.rs

@@ -13,7 +13,7 @@ enum SlotStatus {
 }
 
 /// Sliding window is used to control the concurrent uploading process of a file.
-/// Bounded window allows segments to be uploaded concurrenly, while having a capacity
+/// Bounded window allows segments to be uploaded concurrently, while having a capacity
 /// limit on writing threads per file. Meanwhile, the left_boundary field records
 /// how many segments have been uploaded.
 struct CtrlWindow {
@@ -165,7 +165,7 @@ impl ChunkPoolWriteCtrl {
 
         if file_ctrl.total_segments != total_segments {
             bail!(
-                "file size in segment doesn't match with file size declared in previous segment. Previous total segments:{}, current total segments:{}s",
+                "file size in segment doesn't match with file size declared in previous segment. Previous total segments:{}, current total segments:{}",
                 file_ctrl.total_segments,
                 total_segments
             );