state

type ErrorType byte

type State interface {
	StateModifier
	StateStable
	StateNewest

	IsNotFound(err error) bool
}

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

type StateModifier interface {
	// Global mutex of state.
	Mutex() *lock.RwMutex
	// AddBlock adds single block to state.
	// It's not recommended to use this function when you are able to accumulate big blocks batch,
	// since it's much more efficient to add many blocks at once.
	AddBlock(block []byte) (*proto.Block, error)
	AddDeserializedBlock(block *proto.Block) (*proto.Block, error)
	// AddNewBlocks adds batch of new blocks to state.
	// Use it when blocks are logically new.
	AddNewBlocks(blocks [][]byte) error
	// AddNewDeserializedBlocks marshals blocks to binary and calls AddNewBlocks().
	AddNewDeserializedBlocks(blocks []*proto.Block) error
	// AddOldBlocks adds batch of old blocks to state.
	// Use it when importing historical blockchain.
	// It is faster than AddNewBlocks but it is only safe when importing from scratch when no rollbacks are possible at all.
	AddOldBlocks(blocks [][]byte) error
	// AddOldDeserializedBlocks marshals blocks to binary and calls AddOldBlocks().
	AddOldDeserializedBlocks(blocks []*proto.Block) error
	// Rollback functionality.
	RollbackToHeight(height proto.Height) error
	RollbackTo(removalEdge crypto.Signature) error

	// -------------------------
	// Validation functionality (for UTX).
	// -------------------------
	// ValidateNextTx() validates transaction against state, taking into account all the previous changes from transactions
	// that were added using ValidateNextTx() until you call ResetValidationList().
	// Does not change state.
	// Returns TxValidationError or nil.
	ValidateNextTx(tx proto.Transaction, currentTimestamp, parentTimestamp uint64, blockVersion proto.BlockVersion) error
	// ResetValidationList() resets the validation list, so you can ValidateNextTx() from scratch after calling it.
	ResetValidationList()

	// Create or replace Peers.
	SavePeers([]proto.TCPAddr) error

	Close() error
}

type StateNewest interface {
	AddingBlockHeight() (proto.Height, error)
	NewestHeight() (proto.Height, error)

	// Effective balance by account in given height range.
	// WARNING: this function takes into account newest blocks (which are currently being added)
	// and works correctly for height ranges exceeding current Height() if there are such blocks.
	// It does not work for heights older than rollbackMax blocks before the current block.
	EffectiveBalance(account proto.Recipient, startHeight, endHeight proto.Height) (uint64, error)

	NewestAccountBalance(account proto.Recipient, asset []byte) (uint64, error)

	// Aliases.
	NewestAddrByAlias(alias proto.Alias) (proto.Address, error)

	// Accounts data storage.
	RetrieveNewestEntry(account proto.Recipient, key string) (proto.DataEntry, error)
	RetrieveNewestIntegerEntry(account proto.Recipient, key string) (*proto.IntegerDataEntry, error)
	RetrieveNewestBooleanEntry(account proto.Recipient, key string) (*proto.BooleanDataEntry, error)
	RetrieveNewestStringEntry(account proto.Recipient, key string) (*proto.StringDataEntry, error)
	RetrieveNewestBinaryEntry(account proto.Recipient, key string) (*proto.BinaryDataEntry, error)

	// Transactions.
	NewestTransactionByID(id []byte) (proto.Transaction, error)
	NewestTransactionHeightByID(id []byte) (uint64, error)

	// Asset fee sponsorship.
	NewestAssetIsSponsored(assetID crypto.Digest) (bool, error)
	NewestAssetInfo(assetID crypto.Digest) (*proto.AssetInfo, error)

	NewestHeaderByHeight(height proto.Height) (*proto.BlockHeader, error)
}

type StateParams struct {
	StorageParams
	ValidationParams
}

type StateStable interface {
	// Block getters.
	Block(blockID crypto.Signature) (*proto.Block, error)
	BlockByHeight(height proto.Height) (*proto.Block, error)
	BlockBytes(blockID crypto.Signature) ([]byte, error)
	BlockBytesByHeight(height proto.Height) ([]byte, error)
	// Header getters.
	Header(blockID crypto.Signature) (*proto.BlockHeader, error)
	HeaderByHeight(height proto.Height) (*proto.BlockHeader, error)
	HeaderBytes(blockID crypto.Signature) ([]byte, error)
	HeaderBytesByHeight(height proto.Height) ([]byte, error)
	// Height returns current blockchain height.
	Height() (proto.Height, error)
	// Height <---> blockID converters.
	BlockIDToHeight(blockID crypto.Signature) (proto.Height, error)
	HeightToBlockID(height proto.Height) (crypto.Signature, error)
	// AccountBalance retrieves balance of account in specific currency, asset is asset's ID.
	// nil asset = Waves.
	AccountBalance(account proto.Recipient, asset []byte) (uint64, error)
	// WavesAddressesNumber returns total number of Waves addresses in state.
	// It is extremely slow, so it is recommended to only use for testing purposes.
	WavesAddressesNumber() (uint64, error)

	// Get cumulative blocks score at given height.
	ScoreAtHeight(height proto.Height) (*big.Int, error)
	// Get current blockchain score (at top height).
	CurrentScore() (*big.Int, error)

	// Retrieve current blockchain settings.
	BlockchainSettings() (*settings.BlockchainSettings, error)

	Peers() ([]proto.TCPAddr, error)

	// Features.
	IsActivated(featureID int16) (bool, error)
	ActivationHeight(featureID int16) (proto.Height, error)
	IsApproved(featureID int16) (bool, error)
	ApprovalHeight(featureID int16) (proto.Height, error)

	// Aliases.
	AddrByAlias(alias proto.Alias) (proto.Address, error)

	// Accounts data storage.
	RetrieveEntry(account proto.Recipient, key string) (proto.DataEntry, error)
	RetrieveIntegerEntry(account proto.Recipient, key string) (*proto.IntegerDataEntry, error)
	RetrieveBooleanEntry(account proto.Recipient, key string) (*proto.BooleanDataEntry, error)
	RetrieveStringEntry(account proto.Recipient, key string) (*proto.StringDataEntry, error)
	RetrieveBinaryEntry(account proto.Recipient, key string) (*proto.BinaryDataEntry, error)

	// Transactions.
	TransactionByID(id []byte) (proto.Transaction, error)
	TransactionHeightByID(id []byte) (uint64, error)

	// Asset fee sponsorship.
	AssetIsSponsored(assetID crypto.Digest) (bool, error)
	AssetInfo(assetID crypto.Digest) (*proto.AssetInfo, error)
}

type StorageParams struct {
	OffsetLen       int
	HeaderOffsetLen int
	DbParams        keyvalue.KeyValParams
}

type ValidationParams struct {
	VerificationGoroutinesNum int
}