feat: add various new nakamoto block fields to /new_block ingestion and StacksPayload
#659
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… and `StacksPayload`
zone117x
commented
Oct 22, 2024
Comment on lines
+39
to
+52
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub block_time: Option<u64>, | ||
|
|
||
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub signer_bitvec: Option<String>, | ||
|
|
||
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub signer_signature: Option<Vec<String>>, | ||
|
|
||
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub cycle_number: Option<u64>, | ||
|
|
||
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub reward_set: Option<RewardSet>, |
There was a problem hiding this comment.
stacks-core isn't very consistent with some of these fields being optional (undefined) vs nullable. So goal here is to just support either case during deserialization.
zone117x
commented
Oct 22, 2024
Comment on lines
+117
to
+139
|
|
||
| // Fields included in Nakamoto block headers | ||
| pub block_time: Option<u64>, | ||
| pub signer_bitvec: Option<String>, | ||
| pub signer_signature: Option<Vec<String>>, | ||
|
|
||
| // Available starting in epoch3, only included in blocks where the pox cycle rewards are first calculated | ||
| pub cycle_number: Option<u64>, | ||
| pub reward_set: Option<StacksBlockMetadataRewardSet>, | ||
| } | ||
|
|
||
| #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)] | ||
| pub struct StacksBlockMetadataRewardSet { | ||
| pub pox_ustx_threshold: String, | ||
| pub rewarded_addresses: Vec<String>, | ||
| pub signers: Option<Vec<StacksBlockMetadataRewardSetSigner>>, | ||
| } | ||
|
|
||
| #[derive(Debug, Clone, PartialEq, Deserialize, Serialize)] | ||
| pub struct StacksBlockMetadataRewardSetSigner { | ||
| pub signing_key: String, | ||
| pub weight: u32, | ||
| pub stacked_amt: String, |
There was a problem hiding this comment.
I'm simply re-using the same structure as the /new_block event for this payload so for now it looks like code duplication, however, it gives us room to restructure/rename/re-type these as needed.
zone117x
commented
Oct 22, 2024
Comment on lines
+467
to
+468
| // TODO: decode `signer_bitvec` into an easy to use bit string representation (e.g. "01010101") | ||
| signer_bitvec: block.signer_bitvec.clone(), |
There was a problem hiding this comment.
@rafaelcr we get these from /new_block in consesus-serialize format, e.g. 0x000800000001ff. Is there existing code I can call to decode this? We should deliver it in the payloads in a more typical (and easier to use) bitfield format (a string of 1 and/or 0).
There was a problem hiding this comment.
Yes, I believe so, it's probably included in the update we did to the stacks-codec here hirosystems/clarinet#1524
zone117x
requested a deployment
to
Development-mainnet
GitHub Actions
Waiting
zone117x
requested a deployment
to
Development-testnet
GitHub Actions
Waiting
github-actions bot
pushed a commit
that referenced
this pull request
Oct 25, 2024
## [1.9.0-stacks-signers.1](v1.8.0...v1.9.0-stacks-signers.1) (2024-10-25) ### Features * add various new nakamoto block fields to `/new_block` ingestion and `StacksPayload` ([#659](#659)) ([f48cda5](f48cda5)) * include recovered signer pubkeys in new block payload ([#662](#662)) ([b5ad4ba](b5ad4ba)) * include signer messages in Stacks predicate payloads ([#656](#656)) ([aee14bc](aee14bc)) * parse `/stackerdb_chunks` Stacks node event ([#653](#653)) ([e44d84a](e44d84a)) * store signer messages in local sqlite database ([#664](#664)) ([d12acd9](d12acd9)) * support tenure-height in block messages ([#661](#661)) ([99e5a61](99e5a61)) * **ts-client:** add persisted predicates and periodic health check ([#658](#658)) ([535226a](535226a)) * **ts-client:** add signer messages to stacks payloads ([#657](#657)) ([ff66bb2](ff66bb2)) ### Bug Fixes * add a configurable max timeout for outgoing predicate payload requests ([#642](#642)) ([6c1dfa9](6c1dfa9)), closes [#643](#643) * increase stacks event server body size limit to 500MB ([#660](#660)) ([21234c9](21234c9)) * return 500 status code to Stacks node when event ingestion fails ([#648](#648)) ([63c753c](63c753c)), closes [#646](#646) * signer pubkey calculation ([#665](#665)) ([cc93873](cc93873)) * update SignerMessage deserializing ([#663](#663)) ([71364c1](71364c1)) * validate ts client predicates before registering ([#639](#639)) ([2d08f72](2d08f72))
|
🎉 This PR is included in version 1.9.0-stacks-signers.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #651 -- we need these new fields to make the
StackerDBchunk messages useful.