update some annotation

axonweb3 · Oct 8, 2023 · 2f47ccb · 2f47ccb
1 parent b5fb318
commit 2f47ccb
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 5 deletions.
diff --git a/builtin-contract/system-contract/contracts/ckb_light_client/CkbLightClient.sol b/builtin-contract/system-contract/contracts/ckb_light_client/CkbLightClient.sol
@@ -3,6 +3,9 @@ pragma solidity >=0.8.0;
 
 import "../libraries/CkbType.sol";
 
+// **Notice**
+// This file only defines the interface of CKB light client contract. The real
+// implementation is in `core/executor/src/system_contract/ckb_light_client`.
 interface CkbLightClient {
     function setState(bool allowRead) public;
 

diff --git a/builtin-contract/system-contract/contracts/image_cell/ImageCell.sol b/builtin-contract/system-contract/contracts/image_cell/ImageCell.sol
@@ -17,6 +17,9 @@ library ImageCellType {
     }
 }
 
+// **Notice**
+// This file only defines the interface of image cell contract. The real
+// implementation is in `core/executor/src/system_contract/image_cell`.
 interface ImageCell {
     function setState(bool allowRead) public;
 

diff --git a/builtin-contract/system-contract/contracts/metadata/Metadata.sol b/builtin-contract/system-contract/contracts/metadata/Metadata.sol
@@ -51,7 +51,7 @@ library MetadataType {
 }
 
 // **Notice**
-// This solidity contract only defines the interface of metadata contract. The real
+// This file only defines the interface of metadata contract. The real
 // implementation is in `core/executor/src/system_contract/metadata`.
 interface MetadataManager {
     function appendMetadata(MetadataType.Metadata memory metadata) external;

diff --git a/core/executor/src/system_contract/ckb_light_client/store.rs b/core/executor/src/system_contract/ckb_light_client/store.rs
@@ -24,7 +24,7 @@ use crate::{adapter::RocksTrieDB, MPTTrie, CURRENT_HEADER_CELL_ROOT};
 /// client and image cell contract account as follow:
 ///
 /// **CKB light client Account**
-/// | address | `0xFFfffFFfFFfffFfFffFFfFfFfFffFfffFFFFFf02`|
+/// | address | `0xFfFfFFFfFFfFFFFfFFFFffFfFFfffFFFfffffF02`|
 /// | nonce   | `0x0`                                       |
 /// | balance | `0x0`                                       |
 /// | storage | `storage_root`                              |
@@ -33,7 +33,7 @@ use crate::{adapter::RocksTrieDB, MPTTrie, CURRENT_HEADER_CELL_ROOT};
 /// | HEADER_CELL_ROOT_KEY | HeaderCell MPT root |
 ///
 /// **Image cell Account**
-/// | address | `0xFFfffFFfFFfffFfFffFFfFfFfFffFfffFFFFFf03`|
+/// | address | `0xffffffffFfFFffffFFFfffFfFFfFffFffFFFff03`|
 /// | nonce   | `0x0`                                       |
 /// | balance | `0x0`                                       |
 /// | storage | `storage_root`                              |

diff --git a/core/executor/src/system_contract/image_cell/store.rs b/core/executor/src/system_contract/image_cell/store.rs
@@ -31,7 +31,7 @@ pub struct CellKey {
 /// client and image cell contract account as follow:
 ///
 /// **CKB light client Account**
-/// | address | `0xFFfffFFfFFfffFfFffFFfFfFfFffFfffFFFFFf02`|
+/// | address | `0xFfFfFFFfFFfFFFFfFFFFffFfFFfffFFFfffffF02`|
 /// | nonce   | `0x0`                                       |
 /// | balance | `0x0`                                       |
 /// | storage | `storage_root`                              |
@@ -40,7 +40,7 @@ pub struct CellKey {
 /// | HEADER_CELL_ROOT_KEY | HeaderCell MPT root |
 ///
 /// **Image cell Account**
-/// | address | `0xFFfffFFfFFfffFfFffFFfFfFfFffFfffFFFFFf03`|
+/// | address | `0xffffffffFfFFffffFFFfffFfFFfFffFffFFFff03`|
 /// | nonce   | `0x0`                                       |
 /// | balance | `0x0`                                       |
 /// | storage | `storage_root`                              |