Struct ChainStateBuilder Copy item path

impl<T: ChainStore> ChainStateBuilder<T>

pub fn new() -> Self

Creates a new instance of ChainStateBuilder.

pub fn build(self) -> Result<ChainState<T>, BlockchainBuilderError>

Builds the chain state. Returns error if the chainstore or chain_params are missing, or if only one of tip_header and tip is set (either set both or none).

pub fn with_chainstore(self, chainstore: T) -> Self

Set the chainstore backend, implementing ChainStore. Always required.

pub fn toggle_ibd(self, ibd: bool) -> Self

Enable or disable Initial Block Download (IBD) mode.

pub fn with_chain_params(self, chain_params: ChainParams) -> Self

Sets the chain parameters. Always required.

pub fn with_assume_valid(self, arg: AssumeValidArg, network: Network) -> Self

Sets the assume-valid argument, which can be Disabled, Hardcoded or UserInput. This option is used to skip script validation up to the specified block, speeding up IBD.

pub fn assume_utreexo(self, acc: Stump) -> Self

Sets the utreexo accumulator, assumed as the initial state.

pub fn with_tip(self, tip: (BlockHash, u32), header: BlockHeader) -> Self

Sets the tip block data, assumed as the initial state.

Trait Implementations§

impl<PersistedState: Clone + ChainStore> Clone for ChainStateBuilder<PersistedState>

fn clone(&self) -> ChainStateBuilder<PersistedState>

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<PersistedState: Debug + ChainStore> Debug for ChainStateBuilder<PersistedState>

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

Formats the value using the given formatter. Read more

impl<PersistedState: Default + ChainStore> Default for ChainStateBuilder<PersistedState>

fn default() -> ChainStateBuilder<PersistedState>

Returns the “default value” for a type. Read more

impl<T: ChainStore> TryFrom<ChainStateBuilder<T>> for ChainState<T>

type Error = BlockchainBuilderError

The type returned in the event of a conversion error.

fn try_from(builder: ChainStateBuilder<T>) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl<PersistedState> Freeze for ChainStateBuilder<PersistedState>
where PersistedState: Freeze,

impl<PersistedState> RefUnwindSafe for ChainStateBuilder<PersistedState>
where PersistedState: RefUnwindSafe,

impl<PersistedState> Send for ChainStateBuilder<PersistedState>
where PersistedState: Send,

impl<PersistedState> Sync for ChainStateBuilder<PersistedState>
where PersistedState: Sync,

impl<PersistedState> Unpin for ChainStateBuilder<PersistedState>
where PersistedState: Unpin,

impl<PersistedState> UnwindSafe for ChainStateBuilder<PersistedState>
where PersistedState: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more