From 898350e271f917d1a6e8abf9396f3d98e8bebe1d Mon Sep 17 00:00:00 2001 From: Eric Norberg Date: Tue, 18 Feb 2025 13:47:01 +0500 Subject: [PATCH] fix: errors in code comments (#333) * lib.rs * architecture.md * chunk_write_control.rs --- common/unused_port/src/lib.rs | 2 +- docs/architecture.md | 2 +- node/chunk_pool/src/mem_pool/chunk_write_control.rs | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/common/unused_port/src/lib.rs b/common/unused_port/src/lib.rs index 4a8cf17..4aa4770 100644 --- a/common/unused_port/src/lib.rs +++ b/common/unused_port/src/lib.rs @@ -11,7 +11,7 @@ pub fn unused_tcp_port() -> Result { 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 { unused_port(Transport::Udp) } diff --git a/docs/architecture.md b/docs/architecture.md index 63d86e0..3897fff 100644 --- a/docs/architecture.md +++ b/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 1. The Architecture of 0G System

diff --git a/node/chunk_pool/src/mem_pool/chunk_write_control.rs b/node/chunk_pool/src/mem_pool/chunk_write_control.rs index 768c149..bf5c1e7 100644 --- a/node/chunk_pool/src/mem_pool/chunk_write_control.rs +++ b/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 );