Merge pull request #238 from yeousunn/main

Fix module name in README and comments
CESSProject · Oct 11, 2023 · a6e15a9 · a6e15a9
2 parents 1502f48 + 4b4c192
commit a6e15a9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/c-pallets/audit/README.md b/c-pallets/audit/README.md
@@ -1,9 +1,9 @@
-# Segment Book Module
+# Audit Module
 This file is the exclusive pallet of cess and the proof of podr2 adaptation
 
 ## OverView
 
-The job of this segment Book pallet is to process the proof of miner's service file and filling file,  and generate random challenges. Call some traits of Smith pallet to punish miners. Call the trail of file bank pallet to obtain random files or files with problems in handling challenges.
+The job of this aduit pallet is to process the proof of miner's service file and filling file,  and generate random challenges. Call some traits of Smith pallet to punish miners. Call the trail of file bank pallet to obtain random files or files with problems in handling challenges.
 
 ### Terminology
 

diff --git a/c-pallets/audit/src/lib.rs b/c-pallets/audit/src/lib.rs
@@ -1,10 +1,10 @@
-//! # Segemnt Book Module
+//! # Audit Module
 //!
 //!  This file is the exclusive pallet of cess and the proof of podr2 adaptation
 //!
 //! ## OverView
 //!
-//!  The job of this segment Book pallet is to process the proof of miner's service file and filling
+//!  The job of this audit pallet is to process the proof of miner's service file and filling
 //! file,  and generate random challenges. Call some traits of Smith pallet to punish miners.
 //!  Call the trail of file bank pallet to obtain random files or files with problems in handling
 //! challenges.

diff --git a/docs/designs-of-storage-mining.md b/docs/designs-of-storage-mining.md
@@ -1,6 +1,6 @@
 # Designs of Storage Mining
 
-Segment book is the interface about proof of storage, which mainly deals with the proofs submission and verification of the data segments.
+Audit is the interface about proof of storage, which mainly deals with the proofs submission and verification of the data segments.
 
 ![Image](https://raw.githubusercontent.com/CESSProject/W3F-illustration/main/cess-v0.1.1/Substrate-Node-Template-2.png)
 
@@ -13,16 +13,16 @@ Segment book is the interface about proof of storage, which mainly deals with th
 
 ```
 //pool of the proof of replication(PoRep) ready to verify which is generated by idle segment
-VerPoolA = StorageDoubleMap<accountid, segemnt_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
+VerPoolA = StorageDoubleMap<accountid, segment_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
 
 //pool of the proof of space time(PoSt) ready to verify which is generated by idle segment
-VerPoolB = StorageDoubleMap<accountid, segemnt_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
+VerPoolB = StorageDoubleMap<accountid, segment_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
 
 //pool of PoRep verified which is generated by idle segment
-PrePoolA = StorageDoubleMap<accountid, segemnt_id, (size_type, proof, sealed_cid, block_num)>
+PrePoolA = StorageDoubleMap<accountid, segment_id, (size_type, proof, sealed_cid, block_num)>
 
 //pool of PoSt verified which is generated by idle segment
-PrePoolB = StorageDoubleMap<accountid, segemnt_id, (size_type, proof, sealed_cid, block_num)>
+PrePoolB = StorageDoubleMap<accountid, segment_id, (size_type, proof, sealed_cid, block_num)>
 
 //count the total block height of all idle segments of miner
 BlockNumberB = StorageMap<accountid, (block_num, total_num)>
@@ -124,16 +124,16 @@ begin with input(sender, peer_id, segment_id, result):
 
 ```
 //pool of PoRep ready to verify which is generated by service segment
-VerPoolC = StorageDoubleMap<accountid, segemnt_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
+VerPoolC = StorageDoubleMap<accountid, segment_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
 
 //pool of PoSt ready to verify which is generated by service segment
-VerPoolD = StorageDoubleMap<accountid, segemnt_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
+VerPoolD = StorageDoubleMap<accountid, segment_id, (is_ready, size_type, proof, sealed_cid, rand, block_num)>
 
 //pool of PoRep verified which is generated by service segment
-PrePoolC = StorageDoubleMap<accountid, segemnt_id, (size_type, proof, sealed_cid, block_num)>
+PrePoolC = StorageDoubleMap<accountid, segment_id, (size_type, proof, sealed_cid, block_num)>
 
 //pool of PoSt verified which is generated by service segment
-PrePoolD = StorageDoubleMap<accountid, segemnt_id, (size_type, proof, sealed_cid, block_num)>
+PrePoolD = StorageDoubleMap<accountid, segment_id, (size_type, proof, sealed_cid, block_num)>
 
 //count the total block height of all service segments of miner
 BlockNumberD = StorageMap<accountid, (block_num, total_num)>