Skip to content

Commit 6fd25bd

Browse files
committed
Improve RpcSyncParams documentation
1 parent 9eb738b commit 6fd25bd

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/blockchain/rpc.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,11 +98,12 @@ pub struct RpcConfig {
9898
/// how the `importdescriptors` RPC calls are to be made.
9999
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
100100
pub struct RpcSyncParams {
101-
/// The minimum number of scripts to scan for on initial sync.
101+
/// The minimum number of scripts to scan for on the first sync.
102102
pub start_script_count: usize,
103103
/// Time in unix seconds in which initial sync will start scanning from (0 to start from genesis).
104104
pub start_time: u64,
105-
/// Forces every sync to use `start_time` as import timestamp.
105+
/// Forces every sync to use [`crate::database::SyncTime`] as import timestamp. The default
106+
/// behavior is to use the last `sync_time` as the import timestamp.
106107
pub force_start_time: bool,
107108
/// RPC poll rate (in seconds) to get state updates.
108109
pub poll_rate_sec: u64,

0 commit comments

Comments
 (0)