state

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 29, 2025 License: AGPL-3.0 Imports: 14 Imported by: 3

Documentation

Index

Constants

View Source 
const CBORChecksumLength = 5

Variables

View Source 
var (
	ErrUnitAlreadyUnlocked = errors.New("unit already unlocked")
)

Functions

func MarshalUnitData 

func MarshalUnitData(u types.UnitData) ([]byte, error)

func NewRecoveredState 

func NewRecoveredState(stateData io.Reader, udc UnitDataConstructor, opts ...Option) (*State, *Header, error)

func NewStateNodeCounter 

func NewStateNodeCounter() *stateNodeCounter

Types

type Action 

type Action func(s ShardState, hashAlgorithm crypto.Hash) error

func AddDummyUnit added in v1.0.0 

func AddDummyUnit(id types.UnitID) Action

AddDummyUnit adds a new "dummy" unit with the given identifier. A dummy unit is a unit without unit data.

func AddOrPromoteUnit added in v1.0.0 

func AddOrPromoteUnit(id types.UnitID, data types.UnitData) Action

AddOrPromoteUnit adds a new unit or promotes an existing dummy unit.

func AddUnit 

func AddUnit(id types.UnitID, data types.UnitData) Action

AddUnit adds a new unit with given identifier, owner predicate, unit data.

func AddUnitWithLock added in v1.0.0 

func AddUnitWithLock(id types.UnitID, data types.UnitData, l []byte) Action

AddUnitWithLock adds a new unit with given identifier, unit data and lock.

func DeleteUnit 

func DeleteUnit(id types.UnitID) Action

DeleteUnit removes the unit from the state with given identifier.

func MarkForDeletion added in v1.0.0 

func MarkForDeletion(id types.UnitID, deletionRound uint64) Action

MarkForDeletion marks the given unit to be deleted at future round i.e. logical delete. Logically deleted units cannot be used.

func RemoveStateLock added in v1.0.0 

func RemoveStateLock(id types.UnitID) Action

RemoveStateLock removes the existing state lock and increments counter

func SetStateLock added in v1.0.0 

func SetStateLock(id types.UnitID, stateLockTx []byte) Action

SetStateLock sets new state lock and increments counter

func UpdateUnitData 

func UpdateUnitData(id types.UnitID, f UpdateFunction) Action

UpdateUnitData changes the data of the item, leaves owner as is.

type CRC32Reader 

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

func NewCRC32Reader 

func NewCRC32Reader(reader io.Reader, checksumLength int) *CRC32Reader

func (*CRC32Reader) Read 

func (c *CRC32Reader) Read(p []byte) (n int, err error)

A hacky way to calculate the checksum of a data stream that has checksum appended to the end. Makes sure that the last checksumLength bytes are not included in the checksum calculation.

func (*CRC32Reader) Sum 

func (c *CRC32Reader) Sum() uint32

type CRC32Writer 

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

func NewCRC32Writer 

func NewCRC32Writer(writer io.Writer) *CRC32Writer

func (*CRC32Writer) Sum 

func (c *CRC32Writer) Sum() uint32

func (*CRC32Writer) Write 

func (c *CRC32Writer) Write(p []byte) (n int, err error)
type Header struct {
	Version types.ABVersion
	// new version of UC implies new version of the header struct
	UnicityCertificate   *types.UnicityCertificate
	NodeRecordCount      uint64
	ExecutedTransactions map[string]uint64
	// contains filtered or unexported fields
}

type Index added in v0.4.0 

type Index[T comparable] map[T][]types.UnitID

stateIndexer traverses the state tree and constructs an index using the keyExtractor

func CreateIndex added in v0.4.0 

func CreateIndex[T comparable](s *State, ke KeyExtractor[T]) (Index[T], error)

type InorderTraverser added in v1.0.0 

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

func NewInorderTraverser added in v1.0.0 

func NewInorderTraverser(visitFn func(unitID types.UnitID, unit Unit) error) *InorderTraverser

func (*InorderTraverser) Traverse added in v1.0.0 

func (s *InorderTraverser) Traverse(n *node) error

type KeyExtractor added in v0.4.0 

type KeyExtractor[T comparable] func(unit Unit) (T, error)

stateIndexer traverses the state tree and constructs an index using the keyExtractor

type Log 

type Log struct {
	TxRecordHash       []byte // the hash of the transaction record that brought the unit to the state described by given log entry.
	UnitLedgerHeadHash []byte // the new head hash of the unit ledger
	NewUnitData        types.UnitData
	DeletionRound      uint64
	NewStateLockTx     []byte
}

Log contains a state changes of the unit during the transaction execution.

func NewUnitLog added in v1.0.0 

func NewUnitLog(txrHash []byte, unitLedgerHeadHash []byte, unitData types.UnitData, deletionRound uint64, stateLockTx []byte) *Log

func (*Log) Clone 

func (l *Log) Clone() *Log

func (*Log) Hash 

func (l *Log) Hash(algorithm crypto.Hash) ([]byte, error)

func (*Log) UnitState added in v1.0.0 

func (l *Log) UnitState() (*types.UnitState, error)

type Option 

type Option func(o *Options)

func WithHashAlgorithm 

func WithHashAlgorithm(hashAlgorithm crypto.Hash) Option

type Options 

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

type ShardState 

type ShardState interface {
	Add(id types.UnitID, u Unit) error
	Get(id types.UnitID) (Unit, error)
	Update(id types.UnitID, unit Unit) error
	Delete(id types.UnitID) error
}

type State 

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

State is a data structure that keeps track of units, unit ledgers, and calculates global state tree root hash.

State can be changed by calling Apply function with one or more Action function. Savepoint method can be used to add a special marker to the state that allows all actions that are executed after savepoint was established to be rolled back. In the other words, savepoint lets you roll back part of the state changes instead of the entire state. Releasing a savepoint does NOT trigger a state root hash calculation. To calculate the root hash of the state use method CalculateRoot. Calling a Commit method commits and releases all savepoints.

func NewEmptyState 

func NewEmptyState(opts ...Option) *State

func (*State) AddUnitLog 

func (s *State) AddUnitLog(id types.UnitID, txrHash []byte) error

func (*State) Apply 

func (s *State) Apply(actions ...Action) error

Apply applies given actions to the state. All Action functions are executed together as a single atomic operation. If any of the Action functions returns an error all previous state changes made by any of the action function will be reverted.

func (*State) CalculateRoot 

func (s *State) CalculateRoot() (uint64, []byte, error)

func (*State) Clone 

func (s *State) Clone() *State

Clone returns a clone of the state. The original state and the cloned state can be used by different goroutines but can never be merged. The cloned state is usually used by read only operations (e.g. unit proof generation).

func (*State) Commit 

func (s *State) Commit(uc *types.UnicityCertificate) error

Commit makes the changes in the latest savepoint permanent.

func (*State) CommittedUC 

func (s *State) CommittedUC() *types.UnicityCertificate

CommittedUC returns the Unicity Certificate of the committed state.

func (*State) CreateIndex added in v0.4.0 

func (s *State) CreateIndex(ke KeyExtractor[string]) (Index[string], error)

func (*State) CreateUnitStateProof 

func (s *State) CreateUnitStateProof(id types.UnitID, logIndex int) (*types.UnitStateProof, error)

func (*State) GetUnit 

func (s *State) GetUnit(id types.UnitID, committed bool) (Unit, error)

func (*State) GetUnits added in v1.0.0 

func (s *State) GetUnits(unitTypeIDPtr *uint32, pdr *types.PartitionDescriptionRecord) ([]types.UnitID, error)

func (*State) HashAlgorithm 

func (s *State) HashAlgorithm() crypto.Hash

func (*State) IsCommitted 

func (s *State) IsCommitted() (bool, error)

Returns true if state is clean and contains no uncommitted changes. Does not care if the committed state is certified with an UC or not.

func (*State) Prune 

func (s *State) Prune() error

func (*State) ReleaseToSavepoint 

func (s *State) ReleaseToSavepoint(id int)

ReleaseToSavepoint destroys all savepoints, keeping all state changes after it was created. If a savepoint with given id does not exist then this method does nothing.

Releasing savepoints does NOT trigger a state root hash calculation. To calculate the root hash of the state a Commit method must be called.

func (*State) Revert 

func (s *State) Revert()

Revert rolls back all changes made to the state.

func (*State) RollbackToSavepoint 

func (s *State) RollbackToSavepoint(id int)

RollbackToSavepoint destroys savepoints without keeping the changes in the state tree. All actions that were executed after the savepoint was established are rolled back, restoring the state to what it was at the time of the savepoint.

func (*State) Savepoint 

func (s *State) Savepoint() (int, error)

Savepoint creates a new savepoint and returns an id of the savepoint. Use RollbackToSavepoint to roll back all changes made after calling Savepoint method. Use ReleaseToSavepoint to save all changes made to the state.

func (*State) Serialize 

func (s *State) Serialize(writer io.Writer, committed bool, executedTransactions map[string]uint64) error

Serialize writes the current committed state to the given writer. Not concurrency safe. Should clone the state before calling this.

func (*State) Size added in v1.0.0 

func (s *State) Size() (uint64, error)

func (*State) Traverse 

func (s *State) Traverse(traverser avl.Traverser[types.UnitID, Unit]) error

type Unit 

type Unit interface {
	types.Versioned
	avl.Value[Unit]

	Data() types.UnitData
}

type UnitDataConstructor 

type UnitDataConstructor func(types.UnitID) (types.UnitData, error)

UnitDataConstructor is a function that constructs an empty UnitData structure based on UnitID

type UnitV1 added in v1.0.0 

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

UnitV1 is a node in the state tree. It is used to build state tree and unit ledgers.

func NewUnit 

func NewUnit(data types.UnitData) *UnitV1

func ToUnitV1 added in v1.0.0 

func ToUnitV1(u Unit) (*UnitV1, error)

func (*UnitV1) AddUnitLog added in v1.0.0 

func (u *UnitV1) AddUnitLog(hashAlgorithm crypto.Hash, txrHash []byte) error

func (*UnitV1) Clone added in v1.0.0 

func (u *UnitV1) Clone() Unit

func (*UnitV1) Data added in v1.0.0 

func (u *UnitV1) Data() types.UnitData

func (*UnitV1) DeletionRound added in v1.0.0 

func (u *UnitV1) DeletionRound() uint64

func (*UnitV1) GetVersion added in v1.0.0 

func (u *UnitV1) GetVersion() types.ABVersion

func (*UnitV1) IsDummy added in v1.0.0 

func (u *UnitV1) IsDummy() bool

func (*UnitV1) IsExpired added in v1.0.0 

func (u *UnitV1) IsExpired(currentRoundNumber uint64) bool

func (*UnitV1) IsStateLocked added in v1.0.0 

func (u *UnitV1) IsStateLocked() bool

func (*UnitV1) LastLogIndex added in v1.0.0 

func (u *UnitV1) LastLogIndex() int

func (*UnitV1) Logs added in v1.0.0 

func (u *UnitV1) Logs() []*Log

func (*UnitV1) StateLockTx added in v1.0.0 

func (u *UnitV1) StateLockTx() []byte

func (*UnitV1) String added in v1.0.0 

func (u *UnitV1) String() string

type UpdateFunction 

type UpdateFunction func(data types.UnitData) (newData types.UnitData, err error)

UpdateFunction is a function for updating the data of an item. Taken in previous UnitData and returns new UnitData.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.