state

Documentation

Index

• type ImmutableState
  • func NewImmutableState(ctx context.Context, state api.ApplicationQueryState, version int64) (*ImmutableState, error)
  • func (s *ImmutableState) ConsensusParameters(ctx context.Context) (*roothash.ConsensusParameters, error)
  • func (s *ImmutableState) EvidenceHashExists(ctx context.Context, runtimeID common.Namespace, round uint64, hash hash.Hash) (bool, error)
  • func (s *ImmutableState) IORoot(ctx context.Context, id common.Namespace) (hash.Hash, error)
  • func (s *ImmutableState) RejectTransactions(ctx context.Context) (bool, error)
  • func (s *ImmutableState) RuntimeState(ctx context.Context, id common.Namespace) (*roothash.RuntimeState, error)
  • func (s *ImmutableState) Runtimes(ctx context.Context) ([]*roothash.RuntimeState, error)
  • func (s *ImmutableState) RuntimesWithRoundTimeouts(ctx context.Context, height int64) ([]common.Namespace, error)
  • func (s *ImmutableState) RuntimesWithRoundTimeoutsAny(ctx context.Context) ([]common.Namespace, []int64, error)
  • func (s *ImmutableState) StateRoot(ctx context.Context, id common.Namespace) (hash.Hash, error)
• type MutableState
  • func NewMutableState(tree mkvs.KeyValueTree) *MutableState
  • func (s *MutableState) ClearRejectTransactions(ctx context.Context) error
  • func (s *MutableState) ClearRoundTimeout(ctx context.Context, runtimeID common.Namespace, height int64) error
  • func (s *MutableState) RemoveExpiredEvidence(ctx context.Context, runtimeID common.Namespace, minRound uint64) error
  • func (s *MutableState) ScheduleRoundTimeout(ctx context.Context, runtimeID common.Namespace, height int64) error
  • func (s *MutableState) SetConsensusParameters(ctx context.Context, params *roothash.ConsensusParameters) error
  • func (s *MutableState) SetEvidenceHash(ctx context.Context, runtimeID common.Namespace, round uint64, hash hash.Hash) error
  • func (s *MutableState) SetRejectTransactions(ctx context.Context) error
  • func (s *MutableState) SetRuntimeState(ctx context.Context, state *roothash.RuntimeState) error

Types

type ImmutableState

type ImmutableState struct {
	// contains filtered or unexported fields
}

ImmutableState is the immutable roothash state wrapper.

func NewImmutableState

func NewImmutableState(ctx context.Context, state api.ApplicationQueryState, version int64) (*ImmutableState, error)

func (*ImmutableState) ConsensusParameters

func (s *ImmutableState) ConsensusParameters(ctx context.Context) (*roothash.ConsensusParameters, error)

ConsensusParameters returns the roothash consensus parameters.

func (*ImmutableState) EvidenceHashExists

func (s *ImmutableState) EvidenceHashExists(ctx context.Context, runtimeID common.Namespace, round uint64, hash hash.Hash) (bool, error)

EvidenceHashExists returns true if the evidence hash for the runtime exists.

func (*ImmutableState) IORoot

func (s *ImmutableState) IORoot(ctx context.Context, id common.Namespace) (hash.Hash, error)

IORoot returns the state root for a specific runtime.

func (*ImmutableState) RejectTransactions

func (s *ImmutableState) RejectTransactions(ctx context.Context) (bool, error)

RejectTransactions returns true iff all transactions should be rejected.

func (*ImmutableState) RuntimeState

func (s *ImmutableState) RuntimeState(ctx context.Context, id common.Namespace) (*roothash.RuntimeState, error)

RuntimeState returns the roothash runtime state for a specific runtime.

func (*ImmutableState) Runtimes

func (s *ImmutableState) Runtimes(ctx context.Context) ([]*roothash.RuntimeState, error)

Runtimes returns the list of all roothash runtime states.

func (*ImmutableState) RuntimesWithRoundTimeouts

func (s *ImmutableState) RuntimesWithRoundTimeouts(ctx context.Context, height int64) ([]common.Namespace, error)

RuntimesWithRoundTimeouts returns the runtimes that have round timeouts scheduled at the given height.

func (*ImmutableState) RuntimesWithRoundTimeoutsAny

func (s *ImmutableState) RuntimesWithRoundTimeoutsAny(ctx context.Context) ([]common.Namespace, []int64, error)

RuntimesWithRoundTimeoutsAny returns the runtimes that have round timeouts scheduled at any height.

func (*ImmutableState) StateRoot

func (s *ImmutableState) StateRoot(ctx context.Context, id common.Namespace) (hash.Hash, error)

StateRoot returns the state root for a specific runtime.

type MutableState

type MutableState struct {
	*ImmutableState
	// contains filtered or unexported fields
}

MutableState is the mutable roothash state wrapper.

func NewMutableState

func NewMutableState(tree mkvs.KeyValueTree) *MutableState

func (*MutableState) ClearRejectTransactions

func (s *MutableState) ClearRejectTransactions(ctx context.Context) error

ClearRejectTransactions clears the transaction disable.

func (*MutableState) ClearRoundTimeout

func (s *MutableState) ClearRoundTimeout(ctx context.Context, runtimeID common.Namespace, height int64) error

ClearRoundTimeout clears a previously scheduled round timeout at a given height.

func (*MutableState) RemoveExpiredEvidence

func (s *MutableState) RemoveExpiredEvidence(ctx context.Context, runtimeID common.Namespace, minRound uint64) error

RemoveExpiredEvidence removes expired evidence.

func (*MutableState) ScheduleRoundTimeout

func (s *MutableState) ScheduleRoundTimeout(ctx context.Context, runtimeID common.Namespace, height int64) error

ScheduleRoundTimeout schedules a new runtime round timeout at a given height.

func (*MutableState) SetConsensusParameters

func (s *MutableState) SetConsensusParameters(ctx context.Context, params *roothash.ConsensusParameters) error

SetConsensusParameters sets roothash consensus parameters.

NOTE: This method must only be called from InitChain/EndBlock contexts.

func (*MutableState) SetEvidenceHash

func (s *MutableState) SetEvidenceHash(ctx context.Context, runtimeID common.Namespace, round uint64, hash hash.Hash) error

SetEvidenceHash sets the provided evidence hash.

func (*MutableState) SetRejectTransactions

func (s *MutableState) SetRejectTransactions(ctx context.Context) error

SetRejectTransactions sets the transaction disable.

func (*MutableState) SetRuntimeState

func (s *MutableState) SetRuntimeState(ctx context.Context, state *roothash.RuntimeState) error

SetRuntimeState sets a runtime's roothash state.