storage

type BatchItem struct {
	Cmd  string
	Args []interface{}
}

type BeaconData struct {
	Height int64

	Epoch  beacon.EpochTime
	Beacon []byte
}

type ConsensusAllData struct {
	BlockData      *ConsensusBlockData
	BeaconData     *BeaconData
	RegistryData   *RegistryData
	RootHashData   *RootHashData
	StakingData    *StakingData
	SchedulerData  *SchedulerData
	GovernanceData *GovernanceData
}

type ConsensusBlockData struct {
	Height int64

	BlockHeader             *consensus.Block
	Epoch                   beacon.EpochTime
	TransactionsWithResults []nodeapi.TransactionWithResults
}

type ConsensusSourceStorage interface {
	// GenesisDocument returns the genesis document for the chain.
	GenesisDocument(ctx context.Context, chainContext string) (*genesisAPI.Document, error)

	// StateToGenesis returns a genesis-like struct encoding the state of the chain at the given height.
	StateToGenesis(ctx context.Context, height int64) (*genesisAPI.Document, error)

	// GetNodes returns the list of registered nodes at the given height.
	GetNodes(ctx context.Context, height int64) ([]nodeapi.Node, error)

	// AllData returns all data tied to a specific height.
	AllData(ctx context.Context, height int64, fastSync bool) (*ConsensusAllData, error)

	// LatestBlockHeight returns the latest height for which a block is available.
	LatestBlockHeight(ctx context.Context) (int64, error)

	// BlockData gets block data at the specified height. This includes all
	// block header information, as well as transactions and events included
	// within that block.
	BlockData(ctx context.Context, height int64) (*ConsensusBlockData, error)

	// BeaconData gets beacon data at the specified height. This includes
	// the epoch number at that height, as well as the beacon state.
	BeaconData(ctx context.Context, height int64) (*BeaconData, error)

	// RegistryData gets registry data at the specified height. This includes
	// all registered entities and their controlled nodes and statuses.
	RegistryData(ctx context.Context, height int64) (*RegistryData, error)

	// StakingData gets staking data at the specified height. This includes
	// staking backend events to be applied to indexed state.
	StakingData(ctx context.Context, height int64) (*StakingData, error)

	// SchedulerData gets scheduler data at the specified height. This
	// includes all validators and runtime committees.
	SchedulerData(ctx context.Context, height int64) (*SchedulerData, error)

	// GovernanceData gets governance data at the specified height. This
	// includes all proposals, their respective statuses and voting responses.
	GovernanceData(ctx context.Context, height int64) (*GovernanceData, error)

	// RootHashData gets root hash data at the specified height. This includes
	// root hash events.
	RootHashData(ctx context.Context, height int64) (*RootHashData, error)

	// Name returns the name of the source storage.
	Name() string

	// Close instructs the source storage to clean up resources. Calling other
	// methods after this one results in undefined behavior.
	Close() error
}

type GovernanceData struct {
	Height int64

	Events                []nodeapi.Event
	ProposalSubmissions   []nodeapi.Proposal
	ProposalExecutions    []nodeapi.ProposalExecutedEvent
	ProposalFinalizations []nodeapi.Proposal
	Votes                 []nodeapi.VoteEvent
}

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

type QueryResult = pgx.Row

type QueryResults = pgx.Rows

type RegistryData struct {
	Height int64

	Events                  []nodeapi.Event
	RuntimeRegisteredEvents []nodeapi.RuntimeRegisteredEvent
	EntityEvents            []nodeapi.EntityEvent
	NodeEvents              []nodeapi.NodeEvent
	NodeUnfrozenEvents      []nodeapi.NodeUnfrozenEvent
}

type RootHashData struct {
	Height int64

	Events []nodeapi.Event
}

type SchedulerData struct {
	Height int64

	Validators []nodeapi.Validator
	Committees map[coreCommon.Namespace][]nodeapi.Committee
}

type StakingData struct {
	Height int64
	Epoch  beacon.EpochTime

	Events                []nodeapi.Event
	Transfers             []nodeapi.TransferEvent
	Burns                 []nodeapi.BurnEvent
	AddEscrows            []nodeapi.AddEscrowEvent
	TakeEscrows           []nodeapi.TakeEscrowEvent
	ReclaimEscrows        []nodeapi.ReclaimEscrowEvent
	DebondingStartEscrows []nodeapi.DebondingStartEscrowEvent
	AllowanceChanges      []nodeapi.AllowanceChangeEvent
}

type TargetStorage interface {
	// SendBatch sends a batch of queries to be applied to target storage.
	SendBatch(ctx context.Context, batch *QueryBatch) error

	// SendBatchWithOptions is like SendBatch, with custom DB options (e.g. level of tx isolation).
	SendBatchWithOptions(ctx context.Context, batch *QueryBatch, opts TxOptions) error

	// Query submits a query to fetch data from target storage.
	Query(ctx context.Context, sql string, args ...interface{}) (QueryResults, error)

	// QueryRow submits a query to fetch a single row of data from target storage.
	QueryRow(ctx context.Context, sql string, args ...interface{}) QueryResult

	// Begin starts a new transaction.
	// XXX: Not the nicest that this exposes the underlying pgx.Tx interface. Could instead
	// return a `TargetStorage`-like interface wrapper, that only exposes Query/QueryRow/SendBatch/SendBatchWithOptions
	// and Commit/Rollback.
	Begin(ctx context.Context) (Tx, error)

	// Close shuts down the target storage client.
	Close()

	// Name returns the name of the target storage.
	Name() string

	// Wipe removes all contents of the target storage.
	Wipe(ctx context.Context) error

	// DisableTriggersAndFKConstraints disables all triggers and foreign key constraints
	// in nexus tables. This is useful when inserting blockchain data out of order,
	// so that later blocks can refer to (yet unindexed) earlier blocks without violating constraints.
	DisableTriggersAndFKConstraints(ctx context.Context) error

	// EnableTriggersAndFKConstraints enables all triggers and foreign key constraints
	// in the given schema.
	// WARNING: This might enable triggers not explicitly disabled by DisableTriggersAndFKConstraints.
	// WARNING: This does not enforce/check contraints on rows that were inserted while triggers were disabled.
	EnableTriggersAndFKConstraints(ctx context.Context) error
}

type Tx = pgx.Tx

type TxOptions = pgx.TxOptions