blockchain

type BlockBuilderFactory interface {
	// NewBlockBuilder creates block builder
	NewBlockBuilder(context.Context, func(action.Envelope) (*action.SealedEnvelope, error)) (*block.Builder, error)
}

type BlockCreationSubscriber interface {
	ReceiveBlock(*block.Block) error
}

type Blockchain interface {
	lifecycle.StartStopper

	// For exposing blockchain states
	// BlockHeaderByHeight return block header by height
	BlockHeaderByHeight(height uint64) (*block.Header, error)
	// BlockFooterByHeight return block footer by height
	BlockFooterByHeight(height uint64) (*block.Footer, error)
	// ChainID returns the chain ID
	ChainID() uint32
	// EvmNetworkID returns the evm network ID
	EvmNetworkID() uint32
	// ChainAddress returns chain address on parent chain, the root chain return empty.
	ChainAddress() string
	// TipHash returns tip block's hash
	TipHash() hash.Hash256
	// TipHeight returns tip block's height
	TipHeight() uint64
	// Genesis returns the genesis
	Genesis() genesis.Genesis
	// Context returns current context
	Context(context.Context) (context.Context, error)

	// For block operations
	// MintNewBlock creates a new block with given actions
	// Note: the coinbase transfer will be added to the given transfers when minting a new block
	MintNewBlock(timestamp time.Time) (*block.Block, error)
	// CommitBlock validates and appends a block to the chain
	CommitBlock(blk *block.Block) error
	// ValidateBlock validates a new block before adding it to the blockchain
	ValidateBlock(blk *block.Block) error

	// AddSubscriber make you listen to every single produced block
	AddSubscriber(BlockCreationSubscriber) error

	// RemoveSubscriber make you listen to every single produced block
	RemoveSubscriber(BlockCreationSubscriber) error
}

type Config struct {
	ChainDBPath                string           `yaml:"chainDBPath"`
	TrieDBPatchFile            string           `yaml:"trieDBPatchFile"`
	TrieDBPath                 string           `yaml:"trieDBPath"`
	StakingPatchDir            string           `yaml:"stakingPatchDir"`
	IndexDBPath                string           `yaml:"indexDBPath"`
	BloomfilterIndexDBPath     string           `yaml:"bloomfilterIndexDBPath"`
	CandidateIndexDBPath       string           `yaml:"candidateIndexDBPath"`
	StakingIndexDBPath         string           `yaml:"stakingIndexDBPath"`
	SGDIndexDBPath             string           `yaml:"sgdIndexDBPath"`
	ContractStakingIndexDBPath string           `yaml:"contractStakingIndexDBPath"`
	ID                         uint32           `yaml:"id"`
	EVMNetworkID               uint32           `yaml:"evmNetworkID"`
	Address                    string           `yaml:"address"`
	ProducerPrivKey            string           `yaml:"producerPrivKey"`
	ProducerPrivKeySchema      string           `yaml:"producerPrivKeySchema"`
	SignatureScheme            []string         `yaml:"signatureScheme"`
	EmptyGenesis               bool             `yaml:"emptyGenesis"`
	GravityChainDB             db.Config        `yaml:"gravityChainDB"`
	Committee                  committee.Config `yaml:"committee"`

	EnableTrielessStateDB bool `yaml:"enableTrielessStateDB"`
	// EnableStateDBCaching enables cachedStateDBOption
	EnableStateDBCaching bool `yaml:"enableStateDBCaching"`
	// EnableArchiveMode is only meaningful when EnableTrielessStateDB is false
	EnableArchiveMode bool `yaml:"enableArchiveMode"`
	// EnableAsyncIndexWrite enables writing the block actions' and receipts' index asynchronously
	EnableAsyncIndexWrite bool `yaml:"enableAsyncIndexWrite"`
	// deprecated
	EnableSystemLogIndexer bool `yaml:"enableSystemLog"`
	// EnableStakingProtocol enables staking protocol
	EnableStakingProtocol bool `yaml:"enableStakingProtocol"`
	// EnableStakingIndexer enables staking indexer
	EnableStakingIndexer bool `yaml:"enableStakingIndexer"`
	// AllowedBlockGasResidue is the amount of gas remained when block producer could stop processing more actions
	AllowedBlockGasResidue uint64 `yaml:"allowedBlockGasResidue"`
	// MaxCacheSize is the max number of blocks that will be put into an LRU cache. 0 means disabled
	MaxCacheSize int `yaml:"maxCacheSize"`
	// PollInitialCandidatesInterval is the config for committee init db
	PollInitialCandidatesInterval time.Duration `yaml:"pollInitialCandidatesInterval"`
	// StateDBCacheSize is the max size of statedb LRU cache
	StateDBCacheSize int `yaml:"stateDBCacheSize"`
	// WorkingSetCacheSize is the max size of workingset cache in state factory
	WorkingSetCacheSize uint64 `yaml:"workingSetCacheSize"`
	// StreamingBlockBufferSize
	StreamingBlockBufferSize uint64 `yaml:"streamingBlockBufferSize"`
	// PersistStakingPatchBlock is the block to persist staking patch
	PersistStakingPatchBlock uint64 `yaml:"persistStakingPatchBlock"`
}

type Option func(*blockchain) error

type PubSubManager interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
	AddBlockListener(BlockCreationSubscriber) error
	RemoveBlockListener(BlockCreationSubscriber) error
	SendBlockToSubscribers(*block.Block)
}