Skip to content

Initial implementation of mockamoto stack-node mode #4001

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 1, 2023
Merged

Initial implementation of mockamoto stack-node mode #4001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e953df
feat: initial implementation of mockamoto stack-node mode
Oct 17, 2023
a675e1f
Merge remote-tracking branch 'origin/next' into feat/mock-node
Oct 31, 2023
060a29f
add comments to the mockamoto node
Oct 31, 2023
487126a
fix merge error
Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .vscode/launch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@
"request": "launch",
"name": "executable 'blockstack-core'",
"cargo": {
"args": ["build", "--bin=stacks-inspect", "--package=blockstack-core"],
"args": ["build", "--bin=stacks-node"],
"filter": {
"name": "stacks-inspect",
"kind": "bin"
}
},
"args": [],
"args": ["mockamoto"],
"cwd": "${workspaceFolder}"
},
{
Expand Down
102 changes: 75 additions & 27 deletions stackslib/src/chainstate/nakamoto/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,55 @@ impl NakamotoBlock {
}

impl NakamotoChainState {
pub fn get_chain_tip(
chainstate_conn: &Connection,
sortition_tip: &ConsensusHash,
sortition_db_conn: &Connection,
) -> Result<(BlockHeaderHash, ConsensusHash), ChainstateError> {
let block_sql =
"SELECT block_hash, consensus_hash, block_height FROM nakamoto_block_headers
WHERE consensus_hash = ?
UNION
SELECT block_hash, consensus_hash, block_height FROM block_headers
WHERE consensus_hash = ?
ORDER BY block_height DESC LIMIT 1";
let mut cur_sortition_tip = sortition_tip.clone();
loop {
if let Some(tip_pair) = chainstate_conn
.query_row(
block_sql,
params![&cur_sortition_tip, &cur_sortition_tip],
|row| {
let block_header_hash = row.get(0)?;
let consensus_hash = row.get(1)?;
Ok((block_header_hash, consensus_hash))
},
)
.optional()?
{
return Ok(tip_pair);
} else {
// no blocks are processed that were produced at `cur_sortition_tip`, check `cur_sortition_tip`'s parent.
let parent_sortition_id = SortitionDB::get_block_snapshot_consensus(
sortition_db_conn,
&cur_sortition_tip,
)?
.ok_or_else(|| ChainstateError::NoSuchBlockError)?
.parent_sortition_id;

cur_sortition_tip =
SortitionDB::get_block_snapshot(sortition_db_conn, &parent_sortition_id)?
.ok_or_else(|| ChainstateError::NoSuchBlockError)?
.consensus_hash;

// this is true at the "genesis" sortition: this means that there is no stacks block produced yet.
if cur_sortition_tip == FIRST_BURNCHAIN_CONSENSUS_HASH {
return Err(ChainstateError::NoSuchBlockError);
}
}
}
}

/// Notify the staging database that a given stacks block has been processed.
/// This will update the attachable status for children blocks, as well as marking the stacks
/// block itself as processed.
Expand Down Expand Up @@ -798,7 +847,7 @@ impl NakamotoChainState {
parent_block_id,
tenure_height,
tenure_changed)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17, ?18, ?19, ?20, ?21, ?22, ?23, ?24, ?25)",
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17, ?18, ?19, ?20, ?21, ?22, ?23, ?24, ?25, ?26)",
args
)?;

Expand Down Expand Up @@ -1000,11 +1049,12 @@ impl NakamotoChainState {
clarity_instance: &'a mut ClarityInstance,
sortition_dbconn: &'b dyn SortitionDBRef,
pox_constants: &PoxConstants,
chain_tip: &StacksHeaderInfo,
Copy link
Member

@jcnelson jcnelson Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you help me understand why replacing chain_tip with parent_stacks_height and parent_burn_height is required? This seems needless to me.

Copy link
Contributor Author

@kantai kantai Oct 31, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It reduces the amount that needs to be mocked: the chain_tip argument is only used for obtaining the parent stacks height and parent burn height (for epoch checks, mostly). It also makes writing unit tests easier. An argument like chain_tip which includes a bunch of information that the function doesn't use confuses the interface.

burn_view: BurnchainHeaderHash,
burn_view_height: u32,
parent_consensus_hash: ConsensusHash,
parent_header_hash: BlockHeaderHash,
parent_stacks_height: u64,
parent_burn_height: u32,
mainnet: bool,
miner_id_opt: Option<usize>,
tenure_changed: bool,
Expand All @@ -1014,7 +1064,7 @@ impl NakamotoChainState {
let parent_sortition_id = sortition_dbconn
.get_sortition_id_from_consensus_hash(&parent_consensus_hash)
.expect("Failed to get parent SortitionID from ConsensusHash");
let tip_index_hash = chain_tip.index_block_hash();
let tip_index_hash = StacksBlockId::new(&parent_consensus_hash, &parent_header_hash);

// find matured miner rewards, so we can grant them within the Clarity DB tx.
let matured_rewards_pair = if !tenure_changed {
Expand Down Expand Up @@ -1091,7 +1141,7 @@ impl NakamotoChainState {
StacksChainState::find_mature_miner_rewards(
&mut clarity_tx,
sortition_dbconn.sqlite_conn(),
&chain_tip,
parent_stacks_height,
latest_matured_miners,
matured_miner_parent,
)
Expand Down Expand Up @@ -1134,9 +1184,9 @@ impl NakamotoChainState {
StacksChainState::process_epoch_transition(&mut clarity_tx, burn_view_height)?;

debug!(
"Setup block: Processed epoch transition at {}/{}",
&chain_tip.consensus_hash,
&chain_tip.anchored_header.block_hash()
"Setup block: Processed epoch transition";
"parent_consensus_hash" => %parent_consensus_hash,
"parent_header_hash" => %parent_header_hash,
);

let evaluated_epoch = clarity_tx.get_epoch();
Expand All @@ -1147,13 +1197,13 @@ impl NakamotoChainState {
sortition_dbconn.as_burn_state_db(),
sortition_dbconn,
&mut clarity_tx,
chain_tip,
parent_burn_height,
&parent_sortition_id,
)?;
debug!(
"Setup block: Processed unlock events at {}/{}",
&chain_tip.consensus_hash,
&chain_tip.anchored_header.block_hash()
"Setup block: Processed unlock events";
"parent_consensus_hash" => %parent_consensus_hash,
"parent_header_hash" => %parent_header_hash,
);
unlock_events
} else {
Expand All @@ -1168,20 +1218,16 @@ impl NakamotoChainState {
stacking_burn_ops.clone(),
active_pox_contract,
));
debug!(
"Setup block: Processed burnchain stacking ops for {}/{}",
&chain_tip.consensus_hash,
&chain_tip.anchored_header.block_hash()
);
tx_receipts.extend(StacksChainState::process_transfer_ops(
&mut clarity_tx,
transfer_burn_ops.clone(),
));
debug!(
"Setup block: Processed burnchain transfer ops for {}/{}",
&chain_tip.consensus_hash,
&chain_tip.anchored_header.block_hash()
"Setup block: Processed burnchain stacking and transfer ops";
"parent_consensus_hash" => %parent_consensus_hash,
"parent_header_hash" => %parent_header_hash,
);

// DelegateStx ops are allowed from epoch 2.1 onward.
// The query for the delegate ops only returns anything in and after Epoch 2.1,
// but we do a second check here just to be safe.
Expand All @@ -1192,17 +1238,18 @@ impl NakamotoChainState {
active_pox_contract,
));
debug!(
"Setup block: Processed burnchain delegate ops for {}/{}",
&chain_tip.consensus_hash,
&chain_tip.anchored_header.block_hash()
"Setup block: Processed burnchain delegate ops";
"parent_consensus_hash" => %parent_consensus_hash,
"parent_header_hash" => %parent_header_hash,
);
}

debug!(
"Setup block: ready to go for {}/{}",
&chain_tip.consensus_hash,
&chain_tip.anchored_header.block_hash()
"Setup block: completed setup";
"parent_consensus_hash" => %parent_consensus_hash,
"parent_header_hash" => %parent_header_hash,
);

Ok(SetupBlockResult {
clarity_tx,
tx_receipts,
Expand All @@ -1216,7 +1263,7 @@ impl NakamotoChainState {
})
}

fn append_block<'a>(
pub fn append_block<'a>(
chainstate_tx: &mut ChainstateTx,
clarity_instance: &'a mut ClarityInstance,
burn_dbconn: &mut SortitionHandleTx,
Expand Down Expand Up @@ -1321,13 +1368,14 @@ impl NakamotoChainState {
clarity_instance,
burn_dbconn,
pox_constants,
&parent_chain_tip,
burn_view_hash,
burn_view_height.try_into().map_err(|_| {
ChainstateError::InvalidStacksBlock("Burn block height exceeded u32".into())
})?,
parent_ch,
parent_block_hash,
parent_chain_tip.stacks_block_height,
parent_chain_tip.burn_header_height,
mainnet,
None,
tenure_changed,
Expand Down
6 changes: 3 additions & 3 deletions stackslib/src/chainstate/stacks/db/accounts.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -991,17 +991,17 @@ impl StacksChainState {
pub fn find_mature_miner_rewards(
clarity_tx: &mut ClarityTx,
sortdb_conn: &Connection,
tip: &StacksHeaderInfo,
tip_stacks_height: u64,
mut latest_matured_miners: Vec<MinerPaymentSchedule>,
parent_miner: MinerPaymentSchedule,
) -> Result<Option<(MinerReward, Vec<MinerReward>, MinerReward, MinerRewardInfo)>, Error> {
let mainnet = clarity_tx.config.mainnet;
if tip.stacks_block_height <= MINER_REWARD_MATURITY {
if tip_stacks_height <= MINER_REWARD_MATURITY {
// no mature rewards exist
return Ok(None);
}

let reward_height = tip.stacks_block_height - MINER_REWARD_MATURITY;
let reward_height = tip_stacks_height - MINER_REWARD_MATURITY;

assert!(latest_matured_miners.len() > 0);
assert!(latest_matured_miners[0].vtxindex == 0);
Expand Down
9 changes: 5 additions & 4 deletions stackslib/src/chainstate/stacks/db/blocks.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4607,6 +4607,7 @@ impl StacksChainState {
current_epoch = StacksEpochId::Epoch24;
}
StacksEpochId::Epoch24 => {
receipts.append(&mut clarity_tx.block.initialize_epoch_3_0()?);
current_epoch = StacksEpochId::Epoch30;
}
StacksEpochId::Epoch30 => {
Expand Down Expand Up @@ -5226,7 +5227,7 @@ impl StacksChainState {
burn_dbconn: &dyn BurnStateDB,
sortition_dbconn: &dyn SortitionDBRef,
clarity_tx: &mut ClarityTx,
chain_tip: &StacksHeaderInfo,
chain_tip_burn_header_height: u32,
parent_sortition_id: &SortitionId,
) -> Result<Vec<StacksTransactionEvent>, Error> {
let pox_reward_cycle = Burnchain::static_block_height_to_reward_cycle(
Expand Down Expand Up @@ -5265,7 +5266,7 @@ impl StacksChainState {

let pox_start_cycle_info = sortition_dbconn.get_pox_start_cycle_info(
parent_sortition_id,
chain_tip.burn_header_height.into(),
chain_tip_burn_header_height.into(),
pox_reward_cycle,
)?;
debug!("check_and_handle_reward_start: got pox reward cycle info");
Expand Down Expand Up @@ -5405,7 +5406,7 @@ impl StacksChainState {
let matured_miner_rewards_opt = match StacksChainState::find_mature_miner_rewards(
&mut clarity_tx,
conn,
&chain_tip,
chain_tip.stacks_block_height,
latest_matured_miners,
matured_miner_parent,
) {
Expand Down Expand Up @@ -5494,7 +5495,7 @@ impl StacksChainState {
burn_dbconn,
sortition_dbconn,
&mut clarity_tx,
chain_tip,
chain_tip.burn_header_height,
&parent_sortition_id,
)?;
debug!(
Expand Down
8 changes: 3 additions & 5 deletions stackslib/src/chainstate/stacks/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -709,18 +709,16 @@ impl TransactionPayload {
}
}

#[repr(u8)]
#[derive(Debug, Clone, PartialEq, Copy, Serialize, Deserialize)]
pub enum TransactionPayloadID {
define_u8_enum!(TransactionPayloadID {
TokenTransfer = 0,
SmartContract = 1,
ContractCall = 2,
PoisonMicroblock = 3,
Coinbase = 4,
CoinbaseToAltRecipient = 5,
VersionedSmartContract = 6,
TenureChange = 7,
}
TenureChange = 7
});

/// Encoding of an asset type identifier
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
Expand Down
Loading