txsystem

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

type Observability interface {
	Meter(name string, opts ...metric.MeterOption) metric.Meter
	Logger() *slog.Logger
	RoundLogger(curRound func() uint64) *slog.Logger
}

type Option func(*Options)

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

type StateReader interface {
	GetUnit(id types.UnitID, committed bool) (*state.Unit, error)

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

	CreateIndex(state.KeyExtractor[string]) (state.Index[string], error)

	// Serialize writes the serialized state to the given writer.
	Serialize(writer io.Writer, committed bool) error
}

type StateSummary interface {
	// Root returns the root hash of the TransactionSystem.
	Root() []byte
	// Summary returns the summary value of the state.
	Summary() []byte
}

type StateUnlockProof struct {
	Kind  StateUnlockProofKind
	Proof []byte
}

type StateUnlockProofKind byte

type TransactionExecutor interface {
	// Execute method executes the transaction order. An error must be returned if the transaction order execution
	// was not successful.
	Execute(order *types.TransactionOrder) (*types.TransactionRecord, error)
}

type TransactionSystem interface {
	TransactionExecutor

	// StateSummary returns the summary of the current state of the transaction system or an ErrStateContainsUncommittedChanges if
	// current state contains uncommitted changes.
	StateSummary() (StateSummary, error)

	StateSize() (uint64, error)

	// BeginBlock signals the start of a new block and is invoked before any Execute method calls.
	BeginBlock(uint64) error

	// EndBlock signals the end of the block and is called after all transactions have been delivered to the
	// transaction system.
	EndBlock() (StateSummary, error)

	// Revert signals the unsuccessful consensus round. When called the transaction system must revert all the changes
	// made during the BeginBlock, EndBlock, and Execute method calls.
	Revert()

	// Commit signals the successful consensus round. Called after the block was approved by the root chain. When called
	// the transaction system must commit all the changes made during the BeginBlock,
	// EndBlock, and Execute method calls.
	Commit(uc *types.UnicityCertificate) error

	// CommittedUC returns the unicity certificate of the latest commit.
	CommittedUC() *types.UnicityCertificate

	// State returns clone of transaction system state
	State() StateReader

	// IsPermissionedMode returns true if permissioned mode is enabled and only transactions from approved parties
	// are executed.
	IsPermissionedMode() bool

	// IsFeelessMode returns true if feeless mode is enabled and the cost of executing transactions is 0.
	IsFeelessMode() bool

	// TypeID returns the type identifier of the transaction system.
	TypeID() types.PartitionTypeID
}