Struct forest_filecoin::blocks::tipset::Tipset
source · pub struct Tipset {
headers: Vec<CachingBlockHeader>,
key: OnceCell<TipsetKey>,
}
Expand description
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§
source§impl Tipset
impl Tipset
sourcepub fn new<H: Into<CachingBlockHeader>>(
headers: impl IntoIterator<Item = H>,
) -> Result<Self, CreateTipsetError>
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.
sourcepub fn load(store: &impl Blockstore, tsk: &TipsetKey) -> Result<Option<Tipset>>
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.
sourcepub fn load_heaviest(
store: &impl Blockstore,
settings: &impl SettingsStore,
) -> Result<Option<Tipset>>
pub fn load_heaviest( store: &impl Blockstore, settings: &impl SettingsStore, ) -> Result<Option<Tipset>>
Load the heaviest tipset from the blockstore
sourcepub fn load_required(store: &impl Blockstore, tsk: &TipsetKey) -> Result<Tipset>
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.
sourcepub fn fill_from_blockstore(
&self,
store: &impl Blockstore,
) -> Option<FullTipset>
pub fn fill_from_blockstore( &self, store: &impl Blockstore, ) -> Option<FullTipset>
Constructs and returns a full tipset if messages from storage exists
pub fn block_headers(&self) -> &NonEmpty<CachingBlockHeader>
pub fn into_block_headers(self) -> NonEmpty<CachingBlockHeader>
sourcepub fn min_ticket(&self) -> Option<&Ticket>
pub fn min_ticket(&self) -> Option<&Ticket>
Returns the smallest ticket of all blocks in the tipset
sourcepub fn min_ticket_block(&self) -> &CachingBlockHeader
pub fn min_ticket_block(&self) -> &CachingBlockHeader
Returns the block with the smallest ticket of all blocks in the tipset
sourcepub fn min_timestamp(&self) -> u64
pub fn min_timestamp(&self) -> u64
Returns the smallest timestamp of all blocks in the tipset
sourcepub fn cids(&self) -> NonEmpty<Cid>
pub fn cids(&self) -> NonEmpty<Cid>
Returns a non-empty collection of CIDs
for the current tipset
sourcepub fn parents(&self) -> &TipsetKey
pub fn parents(&self) -> &TipsetKey
Returns the keys of the parents of the blocks in the tipset.
sourcepub fn parent_state(&self) -> &Cid
pub fn parent_state(&self) -> &Cid
Returns the state root for the tipset parent.
sourcepub fn break_weight_tie(&self, other: &Tipset) -> bool
pub fn break_weight_tie(&self, other: &Tipset) -> bool
Returns true if self wins according to the Filecoin tie-break rule (FIP-0023)
sourcepub fn chain_owned(self, store: impl Blockstore) -> impl Iterator<Item = Tipset>
pub fn chain_owned(self, store: impl Blockstore) -> impl Iterator<Item = Tipset>
Returns an iterator of all tipsets, taking an owned Blockstore
sourcepub fn chain(self, store: &impl Blockstore) -> impl Iterator<Item = Tipset> + '_
pub fn chain(self, store: &impl Blockstore) -> impl Iterator<Item = Tipset> + '_
Returns an iterator of all tipsets
sourcepub fn chain_arc(
self: Arc<Self>,
store: &impl Blockstore,
) -> impl Iterator<Item = Arc<Tipset>> + '_
pub fn chain_arc( self: Arc<Self>, store: &impl Blockstore, ) -> impl Iterator<Item = Arc<Tipset>> + '_
Returns an iterator of all tipsets
sourcepub fn genesis(&self, store: &impl Blockstore) -> Result<CachingBlockHeader>
pub fn genesis(&self, store: &impl Blockstore) -> Result<CachingBlockHeader>
Fetch the genesis block header for a given tipset.
sourcepub fn is_child_of(&self, other: &Self) -> bool
pub fn is_child_of(&self, other: &Self) -> bool
Check if self
is the child of other
Trait Implementations§
source§impl From<&CachingBlockHeader> for Tipset
impl From<&CachingBlockHeader> for Tipset
source§fn from(value: &CachingBlockHeader) -> Self
fn from(value: &CachingBlockHeader) -> Self
source§impl From<CachingBlockHeader> for Tipset
impl From<CachingBlockHeader> for Tipset
source§fn from(value: CachingBlockHeader) -> Self
fn from(value: CachingBlockHeader) -> Self
source§impl From<FullTipset> for Tipset
impl From<FullTipset> for Tipset
source§fn from(full_tipset: FullTipset) -> Self
fn from(full_tipset: FullTipset) -> Self
source§impl From<RawBlockHeader> for Tipset
impl From<RawBlockHeader> for Tipset
source§fn from(value: RawBlockHeader) -> Self
fn from(value: RawBlockHeader) -> Self
source§impl HasLotusJson for Tipset
impl HasLotusJson for Tipset
§type LotusJson = TipsetLotusJson
type LotusJson = TipsetLotusJson
#[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>
Auto Trait Implementations§
impl !Freeze for Tipset
impl RefUnwindSafe for Tipset
impl Send for Tipset
impl Sync for Tipset
impl Unpin for Tipset
impl UnwindSafe for Tipset
Blanket Implementations§
source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.source§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T> References<RawCodec> for T
impl<T> References<RawCodec> for T
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.