Skip to content

Commit efb5681

Browse files
obycodeobycode
authored
Merge pull request #5816 from stacks-network/feat/add-tenure-extend-buffer
feat: add `tenure_extend_buffer_secs` signer config option
2 parents fd416d4 + 8693523 commit efb5681

File tree

9 files changed

+124
-3
lines changed

9 files changed

+124
-3
lines changed

‎stacks-signer/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ and this project adheres to the versioning scheme outlined in the [README.md](RE
1010
## Added
1111

1212
- Introduced the `reorg_attempts_activity_timeout_ms` configuration option for signers which is used to determine the length of time after the last block of a tenure is confirmed that an incoming miner's attempts to reorg it are considered valid miner activity.
13+
- Add signer configuration option `tenure_idle_timeout_buffer_secs` to specify the number of seconds of buffer the signer will add to its tenure extend time that it sends to miners. The idea is to allow for some clock skew between the miner and signers, preventing the case where the miner attempts to tenure extend too early.
1314

1415
### Changed
1516

‎stacks-signer/src/chainstate.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ pub struct ProposalEvalConfig {
124124
pub tenure_last_block_proposal_timeout: Duration,
125125
/// How much idle time must pass before allowing a tenure extend
126126
pub tenure_idle_timeout: Duration,
127+
/// How much buffer to add to the tenure idle timeout sent to miners to account for clock skew
128+
pub tenure_idle_timeout_buffer: Duration,
127129
/// Time following the last block of the previous tenure's global acceptance that a signer will consider an attempt by
128130
/// the new miner to reorg it as valid towards miner activity
129131
pub reorg_attempts_activity_timeout: Duration,
@@ -137,6 +139,7 @@ impl From<&SignerConfig> for ProposalEvalConfig {
137139
tenure_last_block_proposal_timeout: value.tenure_last_block_proposal_timeout,
138140
tenure_idle_timeout: value.tenure_idle_timeout,
139141
reorg_attempts_activity_timeout: value.reorg_attempts_activity_timeout,
142+
tenure_idle_timeout_buffer: value.tenure_idle_timeout_buffer,
140143
}
141144
}
142145
}

‎stacks-signer/src/client/mod.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,7 @@ pub(crate) mod tests {
416416
tenure_last_block_proposal_timeout: config.tenure_last_block_proposal_timeout,
417417
block_proposal_validation_timeout: config.block_proposal_validation_timeout,
418418
tenure_idle_timeout: config.tenure_idle_timeout,
419+
tenure_idle_timeout_buffer: config.tenure_idle_timeout_buffer,
419420
block_proposal_max_age_secs: config.block_proposal_max_age_secs,
420421
reorg_attempts_activity_timeout: config.reorg_attempts_activity_timeout,
421422
}

‎stacks-signer/src/config.rs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ const DEFAULT_TENURE_LAST_BLOCK_PROPOSAL_TIMEOUT_SECS: u64 = 30;
4242
const DEFAULT_DRY_RUN: bool = false;
4343
const TENURE_IDLE_TIMEOUT_SECS: u64 = 120;
4444
const DEFAULT_REORG_ATTEMPTS_ACTIVITY_TIMEOUT_MS: u64 = 200_000;
45+
/// Default number of seconds to add to the tenure extend time, after computing the idle timeout,
46+
/// to allow for clock skew between the signer and the miner
47+
const DEFAULT_TENURE_IDLE_TIMEOUT_BUFFER_SECS: u64 = 2;
4548

4649
#[derive(thiserror::Error, Debug)]
4750
/// An error occurred parsing the provided configuration
@@ -162,6 +165,9 @@ pub struct SignerConfig {
162165
pub block_proposal_validation_timeout: Duration,
163166
/// How much idle time must pass before allowing a tenure extend
164167
pub tenure_idle_timeout: Duration,
168+
/// Amount of buffer time to add to the tenure extend time sent to miners to allow for
169+
/// clock skew
170+
pub tenure_idle_timeout_buffer: Duration,
165171
/// The maximum age of a block proposal in seconds that will be processed by the signer
166172
pub block_proposal_max_age_secs: u64,
167173
/// Time following the last block of the previous tenure's global acceptance that a signer will consider an attempt by
@@ -207,6 +213,9 @@ pub struct GlobalConfig {
207213
pub block_proposal_validation_timeout: Duration,
208214
/// How much idle time must pass before allowing a tenure extend
209215
pub tenure_idle_timeout: Duration,
216+
/// Amount of buffer time to add to the tenure extend time sent to miners to allow for
217+
/// clock skew
218+
pub tenure_idle_timeout_buffer: Duration,
210219
/// The maximum age of a block proposal that will be processed by the signer
211220
pub block_proposal_max_age_secs: u64,
212221
/// Time following the last block of the previous tenure's global acceptance that a signer will consider an attempt by
@@ -251,6 +260,9 @@ struct RawConfigFile {
251260
pub block_proposal_validation_timeout_ms: Option<u64>,
252261
/// How much idle time (in seconds) must pass before a tenure extend is allowed
253262
pub tenure_idle_timeout_secs: Option<u64>,
263+
/// Number of seconds of buffer to add to the tenure extend time sent to miners to allow for
264+
/// clock skew
265+
pub tenure_idle_timeout_buffer_secs: Option<u64>,
254266
/// The maximum age of a block proposal (in secs) that will be processed by the signer.
255267
pub block_proposal_max_age_secs: Option<u64>,
256268
/// Time (in millisecs) following a block's global acceptance that a signer will consider an attempt by a miner
@@ -367,6 +379,12 @@ impl TryFrom<RawConfigFile> for GlobalConfig {
367379

368380
let dry_run = raw_data.dry_run.unwrap_or(DEFAULT_DRY_RUN);
369381

382+
let tenure_idle_timeout_buffer = Duration::from_secs(
383+
raw_data
384+
.tenure_idle_timeout_buffer_secs
385+
.unwrap_or(DEFAULT_TENURE_IDLE_TIMEOUT_BUFFER_SECS),
386+
);
387+
370388
Ok(Self {
371389
node_host: raw_data.node_host,
372390
endpoint,
@@ -386,6 +404,7 @@ impl TryFrom<RawConfigFile> for GlobalConfig {
386404
block_proposal_max_age_secs,
387405
reorg_attempts_activity_timeout,
388406
dry_run,
407+
tenure_idle_timeout_buffer,
389408
})
390409
}
391410
}

‎stacks-signer/src/runloop.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,7 @@ impl<Signer: SignerTrait<T>, T: StacksMessageCodec + Clone + Send + Debug> RunLo
314314
tenure_last_block_proposal_timeout: self.config.tenure_last_block_proposal_timeout,
315315
block_proposal_validation_timeout: self.config.block_proposal_validation_timeout,
316316
tenure_idle_timeout: self.config.tenure_idle_timeout,
317+
tenure_idle_timeout_buffer: self.config.tenure_idle_timeout_buffer,
317318
block_proposal_max_age_secs: self.config.block_proposal_max_age_secs,
318319
reorg_attempts_activity_timeout: self.config.reorg_attempts_activity_timeout,
319320
}))

‎stacks-signer/src/tests/chainstate.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ fn setup_test_environment(
9191
block_proposal_timeout: Duration::from_secs(5),
9292
tenure_last_block_proposal_timeout: Duration::from_secs(30),
9393
tenure_idle_timeout: Duration::from_secs(300),
94+
tenure_idle_timeout_buffer: Duration::from_secs(2),
9495
reorg_attempts_activity_timeout: Duration::from_secs(3),
9596
},
9697
};

‎stacks-signer/src/v0/signer.rs

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,9 @@ impl Signer {
357357
block.header.signer_signature_hash(),
358358
signature,
359359
self.signer_db.calculate_tenure_extend_timestamp(
360-
self.proposal_config.tenure_idle_timeout,
360+
self.proposal_config
361+
.tenure_idle_timeout
362+
.saturating_add(self.proposal_config.tenure_idle_timeout_buffer),
361363
block,
362364
true,
363365
),
@@ -375,7 +377,9 @@ impl Signer {
375377
&self.private_key,
376378
self.mainnet,
377379
self.signer_db.calculate_tenure_extend_timestamp(
378-
self.proposal_config.tenure_idle_timeout,
380+
self.proposal_config
381+
.tenure_idle_timeout
382+
.saturating_add(self.proposal_config.tenure_idle_timeout_buffer),
379383
block,
380384
false,
381385
),
@@ -813,7 +817,9 @@ impl Signer {
813817
&self.private_key,
814818
self.mainnet,
815819
self.signer_db.calculate_tenure_extend_timestamp(
816-
self.proposal_config.tenure_idle_timeout,
820+
self.proposal_config
821+
.tenure_idle_timeout
822+
.saturating_add(self.proposal_config.tenure_idle_timeout_buffer),
817823
&block_info.block,
818824
false,
819825
),

‎testnet/stacks-node/src/tests/nakamoto_integrations.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6575,6 +6575,7 @@ fn signer_chainstate() {
65756575
block_proposal_timeout: Duration::from_secs(100),
65766576
tenure_last_block_proposal_timeout: Duration::from_secs(30),
65776577
tenure_idle_timeout: Duration::from_secs(300),
6578+
tenure_idle_timeout_buffer: Duration::from_secs(2),
65786579
reorg_attempts_activity_timeout: Duration::from_secs(30),
65796580
};
65806581
let mut sortitions_view =
@@ -6707,6 +6708,7 @@ fn signer_chainstate() {
67076708
block_proposal_timeout: Duration::from_secs(100),
67086709
tenure_last_block_proposal_timeout: Duration::from_secs(30),
67096710
tenure_idle_timeout: Duration::from_secs(300),
6711+
tenure_idle_timeout_buffer: Duration::from_secs(2),
67106712
reorg_attempts_activity_timeout: Duration::from_secs(30),
67116713
};
67126714
let burn_block_height = SortitionDB::get_canonical_burn_chain_tip(sortdb.conn())
@@ -6787,6 +6789,7 @@ fn signer_chainstate() {
67876789
block_proposal_timeout: Duration::from_secs(100),
67886790
tenure_last_block_proposal_timeout: Duration::from_secs(30),
67896791
tenure_idle_timeout: Duration::from_secs(300),
6792+
tenure_idle_timeout_buffer: Duration::from_secs(2),
67906793
reorg_attempts_activity_timeout: Duration::from_secs(30),
67916794
};
67926795
let mut sortitions_view = SortitionsView::fetch_view(proposal_conf, &signer_client).unwrap();

‎testnet/stacks-node/src/tests/signer/v0.rs

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -499,6 +499,7 @@ fn block_proposal_rejection() {
499499
block_proposal_timeout: Duration::from_secs(100),
500500
tenure_last_block_proposal_timeout: Duration::from_secs(30),
501501
tenure_idle_timeout: Duration::from_secs(300),
502+
tenure_idle_timeout_buffer: Duration::from_secs(2),
502503
reorg_attempts_activity_timeout: Duration::from_secs(30),
503504
};
504505
let mut block = NakamotoBlock {
@@ -7811,6 +7812,7 @@ fn block_validation_response_timeout() {
78117812
tenure_last_block_proposal_timeout: Duration::from_secs(30),
78127813
block_proposal_timeout: Duration::from_secs(100),
78137814
tenure_idle_timeout: Duration::from_secs(300),
7815+
tenure_idle_timeout_buffer: Duration::from_secs(2),
78147816
reorg_attempts_activity_timeout: Duration::from_secs(30),
78157817
};
78167818
let mut block = NakamotoBlock {
@@ -8089,6 +8091,7 @@ fn block_validation_pending_table() {
80898091
block_proposal_timeout: Duration::from_secs(100),
80908092
tenure_last_block_proposal_timeout: Duration::from_secs(30),
80918093
tenure_idle_timeout: Duration::from_secs(300),
8094+
tenure_idle_timeout_buffer: Duration::from_secs(2),
80928095
reorg_attempts_activity_timeout: Duration::from_secs(30),
80938096
};
80948097
let mut block = NakamotoBlock {
@@ -10782,6 +10785,7 @@ fn incoming_signers_ignore_block_proposals() {
1078210785
block_proposal_timeout: Duration::from_secs(100),
1078310786
tenure_last_block_proposal_timeout: Duration::from_secs(30),
1078410787
tenure_idle_timeout: Duration::from_secs(300),
10788+
tenure_idle_timeout_buffer: Duration::from_secs(2),
1078510789
reorg_attempts_activity_timeout: Duration::from_secs(30),
1078610790
};
1078710791
let mut block = NakamotoBlock {
@@ -10958,6 +10962,7 @@ fn outgoing_signers_ignore_block_proposals() {
1095810962
block_proposal_timeout: Duration::from_secs(100),
1095910963
tenure_last_block_proposal_timeout: Duration::from_secs(30),
1096010964
tenure_idle_timeout: Duration::from_secs(300),
10965+
tenure_idle_timeout_buffer: Duration::from_secs(2),
1096110966
reorg_attempts_activity_timeout: Duration::from_secs(30),
1096210967
};
1096310968
let mut block = NakamotoBlock {
@@ -13503,3 +13508,84 @@ fn interrupt_miner_on_new_stacks_tip() {
1350313508
info!("------------------------- Shutdown -------------------------");
1350413509
signer_test.shutdown();
1350513510
}
13511+
13512+
#[test]
13513+
#[ignore]
13514+
/// This test verifies that a miner will produce a TenureExtend transaction
13515+
/// after the signers' idle timeout, plus buffer, is reached.
13516+
fn tenure_extend_after_idle_signers_with_buffer() {
13517+
if env::var("BITCOIND_TEST") != Ok("1".into()) {
13518+
return;
13519+
}
13520+
13521+
tracing_subscriber::registry()
13522+
.with(fmt::layer())
13523+
.with(EnvFilter::from_default_env())
13524+
.init();
13525+
13526+
info!("------------------------- Test Setup -------------------------");
13527+
let num_signers = 5;
13528+
let idle_timeout = Duration::from_secs(1);
13529+
let buffer = Duration::from_secs(20);
13530+
let mut signer_test: SignerTest<SpawnedSigner> = SignerTest::new_with_config_modifications(
13531+
num_signers,
13532+
vec![],
13533+
|config| {
13534+
config.tenure_idle_timeout = idle_timeout;
13535+
config.tenure_idle_timeout_buffer = buffer;
13536+
},
13537+
|config| {
13538+
config.miner.tenure_extend_cost_threshold = 0;
13539+
},
13540+
None,
13541+
None,
13542+
);
13543+
13544+
signer_test.boot_to_epoch_3();
13545+
13546+
info!("---- Nakamoto booted, starting test ----");
13547+
// Get the unix timestamp before the block is mined
13548+
let before_timestamp = get_epoch_time_secs();
13549+
signer_test.mine_nakamoto_block(Duration::from_secs(30), true);
13550+
13551+
// Check the tenure extend timestamps to verify that they have factored in the buffer
13552+
let blocks = test_observer::get_mined_nakamoto_blocks();
13553+
let last_block = blocks.last().expect("No blocks mined");
13554+
let signatures: HashSet<_> = test_observer::get_stackerdb_chunks()
13555+
.into_iter()
13556+
.flat_map(|chunk| chunk.modified_slots)
13557+
.filter_map(|chunk| {
13558+
let message = SignerMessage::consensus_deserialize(&mut chunk.data.as_slice())
13559+
.expect("Failed to deserialize SignerMessage");
13560+
13561+
match message {
13562+
SignerMessage::BlockResponse(BlockResponse::Accepted(accepted))
13563+
if accepted.signer_signature_hash == last_block.signer_signature_hash =>
13564+
{
13565+
Some(accepted.response_data.tenure_extend_timestamp)
13566+
}
13567+
_ => None,
13568+
}
13569+
})
13570+
.collect();
13571+
for timestamp in signatures {
13572+
assert!(
13573+
timestamp >= before_timestamp + buffer.as_secs(),
13574+
"Timestamp {} is not greater than or equal to {}",
13575+
timestamp,
13576+
before_timestamp + buffer.as_secs()
13577+
);
13578+
}
13579+
13580+
info!("---- Waiting for a tenure extend ----");
13581+
13582+
// Now, wait for a block with a tenure extend, to make sure it eventually does extend
13583+
wait_for((idle_timeout + buffer * 2).as_secs(), || {
13584+
Ok(last_block_contains_tenure_change_tx(
13585+
TenureChangeCause::Extended,
13586+
))
13587+
})
13588+
.expect("Timed out waiting for a block with a tenure extend");
13589+
13590+
signer_test.shutdown();
13591+
}

0 commit comments

Comments
 (0)