Merge pull request #4815 from libraries/public_data_location

chore(script): make DataLocation public
nervosnetwork · Feb 26, 2025 · c53044e · c53044e
2 parents 6c3ac8b + 550fdf1
commit c53044e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/script/src/lib.rs b/script/src/lib.rs
@@ -12,8 +12,8 @@ pub use crate::error::{ScriptError, TransactionScriptError};
 pub use crate::scheduler::{Scheduler, ROOT_VM_ID};
 pub use crate::syscalls::generator::generate_ckb_syscalls;
 pub use crate::types::{
-    ChunkCommand, CoreMachine, DataPieceId, RunMode, ScriptGroup, ScriptGroupType, ScriptVersion,
-    TransactionState, TxData, VerifyResult, VmIsa, VmState, VmVersion,
+    ChunkCommand, CoreMachine, DataLocation, DataPieceId, RunMode, ScriptGroup, ScriptGroupType,
+    ScriptVersion, TransactionState, TxData, VerifyResult, VmIsa, VmState, VmVersion,
 };
 pub use crate::verify::TransactionScriptsVerifier;
 pub use crate::verify_env::TxVerifyEnv;
diff --git a/script/src/types.rs b/script/src/types.rs
@@ -346,10 +346,14 @@ pub enum VmState {
     WaitForRead(ReadState),
 }
 
+/// Used to specify the location of script data.
 #[derive(Clone, Debug)]
 pub struct DataLocation {
+    /// A pointer to the data.
     pub data_piece_id: DataPieceId,
+    /// Data offset.
     pub offset: u64,
+    /// Data length.
     pub length: u64,
 }