Struct forest_filecoin::blocks::tipset::Tipset

pub struct Tipset {
    headers: Vec<CachingBlockHeader>,
    key: OnceCell<TipsetKey>,
}

An immutable set of blocks at the same height with the same parent set. Blocks in a tipset are canonically ordered by ticket size.

Represents non-null tipsets, see the documentation on crate::state_manager::apply_block_messages for more.

Fields

headers: Vec<CachingBlockHeader>

Sorted

key: OnceCell<TipsetKey>

Implementations

impl Tipset

pub fn new<H: Into<CachingBlockHeader>>( headers: impl IntoIterator<Item = H>, ) -> Result<Self, CreateTipsetError>

Builds a new Tipset from a collection of blocks. A valid tipset contains a non-empty collection of blocks that have distinct miners and all specify identical epoch, parents, weight, height, state root, receipt root; content-id for headers are supposed to be distinct but until encoding is added will be equal.

pub fn load(store: &impl Blockstore, tsk: &TipsetKey) -> Result<Option<Tipset>>

Fetch a tipset from the blockstore. This call fails if the tipset is present but invalid. If the tipset is missing, None is returned.

pub fn load_heaviest( store: &impl Blockstore, settings: &impl SettingsStore, ) -> Result<Option<Tipset>>

Load the heaviest tipset from the blockstore

pub fn load_required(store: &impl Blockstore, tsk: &TipsetKey) -> Result<Tipset>

Fetch a tipset from the blockstore. This calls fails if the tipset is missing or invalid.

pub fn fill_from_blockstore( &self, store: &impl Blockstore, ) -> Option<FullTipset>

Constructs and returns a full tipset if messages from storage exists

pub fn epoch(&self) -> i64

Returns epoch of the tipset.

pub fn block_headers(&self) -> &NonEmpty<CachingBlockHeader>

pub fn into_block_headers(self) -> NonEmpty<CachingBlockHeader>

pub fn min_ticket(&self) -> Option<&Ticket>

Returns the smallest ticket of all blocks in the tipset

pub fn min_ticket_block(&self) -> &CachingBlockHeader

Returns the block with the smallest ticket of all blocks in the tipset

pub fn min_timestamp(&self) -> u64

Returns the smallest timestamp of all blocks in the tipset

pub fn len(&self) -> usize

Returns the number of blocks in the tipset.

pub fn key(&self) -> &TipsetKey

Returns a key for the tipset.

pub fn cids(&self) -> NonEmpty<Cid>

Returns a non-empty collection of CIDs for the current tipset

pub fn parents(&self) -> &TipsetKey

Returns the keys of the parents of the blocks in the tipset.

pub fn parent_state(&self) -> &Cid

Returns the state root for the tipset parent.

pub fn weight(&self) -> &BigInt

Returns the tipset’s calculated weight

pub fn break_weight_tie(&self, other: &Tipset) -> bool

Returns true if self wins according to the Filecoin tie-break rule (FIP-0023)

pub fn chain_owned(self, store: impl Blockstore) -> impl Iterator<Item = Tipset>

Returns an iterator of all tipsets, taking an owned Blockstore

pub fn chain(self, store: &impl Blockstore) -> impl Iterator<Item = Tipset> + '_

Returns an iterator of all tipsets

pub fn chain_arc( self: Arc<Self>, store: &impl Blockstore, ) -> impl Iterator<Item = Arc<Tipset>> + '_

Returns an iterator of all tipsets

pub fn genesis(&self, store: &impl Blockstore) -> Result<CachingBlockHeader>

Fetch the genesis block header for a given tipset.

pub fn is_child_of(&self, other: &Self) -> bool

Check if self is the child of other

Trait Implementations

impl Clone for Tipset

fn clone(&self) -> Tipset

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Tipset

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&CachingBlockHeader> for Tipset

fn from(value: &CachingBlockHeader) -> Self

Converts to this type from the input type.

impl From<CachingBlockHeader> for Tipset

fn from(value: CachingBlockHeader) -> Self

Converts to this type from the input type.

impl From<FullTipset> for Tipset

fn from(full_tipset: FullTipset) -> Self

Converts to this type from the input type.

impl From<RawBlockHeader> for Tipset

fn from(value: RawBlockHeader) -> Self

Converts to this type from the input type.

impl From<Tipset> for F3TipSet

fn from(ts: Tipset) -> Self

Converts to this type from the input type.

impl HasLotusJson for Tipset

type LotusJson = TipsetLotusJson

The struct representing JSON. You should #[derive(Deserialize, Serialize)] on it.

fn into_lotus_json(self) -> Self::LotusJson

fn from_lotus_json(TipsetLotusJson: Self::LotusJson) -> Self

fn into_lotus_json_value(self) -> Result<Value>

fn into_lotus_json_string(self) -> Result<String>

fn into_lotus_json_string_pretty(self) -> Result<String>

impl PartialEq for Tipset

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<TipsetBundle> for Tipset

type Error = String

The type returned in the event of a conversion error.

fn try_from(tsb: TipsetBundle) -> Result<Self, Self::Error>

Performs the conversion.