From 2f47ccb153b884991486e696791c877451257a9f Mon Sep 17 00:00:00 2001 From: Eason Date: Sun, 8 Oct 2023 18:02:45 +0800 Subject: [PATCH] update some annotation --- .../contracts/ckb_light_client/CkbLightClient.sol | 3 +++ .../system-contract/contracts/image_cell/ImageCell.sol | 3 +++ .../system-contract/contracts/metadata/Metadata.sol | 2 +- core/executor/src/system_contract/ckb_light_client/store.rs | 4 ++-- core/executor/src/system_contract/image_cell/store.rs | 4 ++-- 5 files changed, 11 insertions(+), 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 index 4c47c2112..3dd27513b 100644 --- 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 index 769988ed3..a2285d927 100644 --- 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 index dd9284729..dc4d1b117 100644 --- 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 index 4d2d80cd0..d998f43e2 100644 --- 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 index c0a48e779..a47341893 100644 --- 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` |