Skip to content

Add lockup events #2189

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 6 commits into from
Dec 30, 2020
Merged

Add lockup events #2189

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1504d80
feat: add lockup events
lgalabru Dec 17, 2020
34854e4
feat: add lockup receipt
lgalabru Dec 17, 2020
c540368
chore: cargo fmt
lgalabru Dec 17, 2020
035197a
Merge branch 'master' into feat/lockup-events
lgalabru Dec 22, 2020
13d2958
Merge branch 'feat/atlas-followup' into feat/lockup-events
lgalabru Dec 30, 2020
62d90f0
chore: cargo fmt
lgalabru Dec 30, 2020
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
39 changes: 37 additions & 2 deletions src/chainstate/stacks/db/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,6 +921,8 @@ impl StacksChainState {
}

let mut allocation_events: Vec<StacksTransactionEvent> = vec![];
let mut lockup_events: Vec<StacksTransactionEvent> = vec![];

info!(
"Initializing chain with {} config balances",
boot_data.initial_balances.len()
Expand Down Expand Up @@ -1001,12 +1003,27 @@ impl StacksChainState {
.with_clarity_db(|db| {
for (block_height, schedule) in lockups_per_block.into_iter() {
let key = Value::UInt(block_height.into());
let value = Value::list_from(schedule).unwrap();
db.insert_entry(
&lockup_contract_id,
"lockups",
key,
Value::list_from(schedule).unwrap(),
key.clone(),
value.clone(),
)?;

// Attach some events
let lookup_event = TupleData::from_data(vec![
(ClarityName::try_from("block-height").unwrap(), key),
(ClarityName::try_from("due-schedules").unwrap(), value),
])
.unwrap();
let lookup_event = StacksTransactionEvent::SmartContractEvent(
SmartContractEventData {
key: (boot_code_id("lockup"), "print".to_string()),
value: Value::Tuple(lookup_event),
},
);
lockup_events.push(lookup_event);
Copy link
Member

@jcnelson jcnelson Dec 30, 2020

Choose a reason for hiding this comment

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

So, these are all "synthetic" events -- they don't correspond to a real transaction on the blockchain. This could confuse users and block explorers -- they'll see a txid, but be unable to query it from the chainstate (we've had this problem before in Stacks 1.0 with "synthetic transactions" that achieved the same end).

Would it make sense to add a field in the StacksTransactionEvent struct to indicate whether or not the event came from a synthetic transaction, so people don't mistakenly believe that these genesis events correspond to on-chain transactions?

Copy link
Member

@jcnelson jcnelson Dec 30, 2020

Choose a reason for hiding this comment

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

No need to address it in this PR if you're pressed for time, but please do open an issue for it if you're not going to address it here.

Copy link
Member

@jcnelson jcnelson Dec 30, 2020

Choose a reason for hiding this comment

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

Also, any insight into how big this list will be in RAM?

Copy link
Contributor

@zone117x zone117x Dec 30, 2020

Choose a reason for hiding this comment

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

I share the concern about these transactions and events being odd one-offs, however, the event broadcaster attaches these to the initial block in a way that does not require any special handling by the sidecar/explorer. We've already been doing this for a while in order to get the boot contracts exposed in a normalized way.

I can imagine how an is_synthetic field could be useful, but I don't think it's worth the effort at the moment.

Copy link
Contributor Author

@lgalabru lgalabru Dec 30, 2020

Choose a reason for hiding this comment

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

Also, any insight into how big this list will be in RAM?

It's a couple of megabytes on disk, not sure about the representation in RAM.

Copy link
Contributor

@zone117x zone117x Dec 30, 2020

Choose a reason for hiding this comment

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

I'm doing some benchmarks on memory usage

Copy link
Contributor

@zone117x zone117x Dec 30, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

This PR appears to increase max memory usage from ~580MB to ~700MB. Measured a few times with
time -l stacks-node mocknet and looking at the reported maximum resident set size.
Tests performed without an event observer configured.

Copy link
Member

@jcnelson jcnelson Dec 30, 2020

Choose a reason for hiding this comment

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

That doesn't sound too bad.

Copy link
Contributor

@zone117x zone117x Dec 30, 2020

Choose a reason for hiding this comment

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

Also of note: with an event observer attached, memory usage is ~2.6GB. The content-size of the first block event payload is ~100MB.

}
Ok(())
})
Expand Down Expand Up @@ -1190,6 +1207,24 @@ impl StacksChainState {
);
receipts.push(allocations_receipt);

let lockup_tx = StacksTransaction::new(
tx_version.clone(),
boot_code_auth.clone(),
TransactionPayload::ContractCall(TransactionContractCall {
address: boot_code_address,
contract_name: ContractName::try_from("lockup").unwrap(),
function_name: ClarityName::try_from("genesis").unwrap(),
function_args: vec![],
}),
);
let lockup_receipt = StacksTransactionReceipt::from_stx_transfer(
lockup_tx,
lockup_events,
Value::okay_true(),
ExecutionCost::zero(),
);
receipts.push(lockup_receipt);

if let Some(callback) = boot_data.post_flight_callback.take() {
callback(&mut clarity_tx);
}
Expand Down