blockstorage

Documentation

Index

• Constants
• Variables
• type Service
  • func NewBlockStorage(ctx context.Context, config config.BlockStorageConfig, ...) *Service
  • func (s *Service) CommitBlock(ctx context.Context, input *services.CommitBlockInput) (*services.CommitBlockOutput, error)
  • func (s *Service) GenerateReceiptProof(ctx context.Context, input *services.GenerateReceiptProofInput) (*services.GenerateReceiptProofOutput, error)
  • func (s *Service) GetBlock(height primitives.BlockHeight) (*protocol.BlockPairContainer, error)
  • func (s *Service) GetBlockPair(ctx context.Context, input *services.GetBlockPairInput) (*services.GetBlockPairOutput, error)
  • func (s *Service) GetBlockSlice(first primitives.BlockHeight, last primitives.BlockHeight) ([]*protocol.BlockPairContainer, primitives.BlockHeight, primitives.BlockHeight, ...)
  • func (s *Service) GetLastCommittedBlockHeight(ctx context.Context, input *services.GetLastCommittedBlockHeightInput) (*services.GetLastCommittedBlockHeightOutput, error)
  • func (s *Service) GetResultsBlockHeader(ctx context.Context, input *services.GetResultsBlockHeaderInput) (result *services.GetResultsBlockHeaderOutput, err error)
  • func (s *Service) GetSyncState() internodesync.SyncState
  • func (s *Service) GetTransactionReceipt(ctx context.Context, input *services.GetTransactionReceiptInput) (*services.GetTransactionReceiptOutput, error)
  • func (s *Service) GetTransactionsBlockHeader(ctx context.Context, input *services.GetTransactionsBlockHeaderInput) (result *services.GetTransactionsBlockHeaderOutput, err error)
  • func (s *Service) HandleBlockAvailabilityRequest(ctx context.Context, input *gossiptopics.BlockAvailabilityRequestInput) (*gossiptopics.EmptyOutput, error)
  • func (s *Service) HandleBlockAvailabilityResponse(ctx context.Context, input *gossiptopics.BlockAvailabilityResponseInput) (*gossiptopics.EmptyOutput, error)
  • func (s *Service) HandleBlockSyncRequest(ctx context.Context, input *gossiptopics.BlockSyncRequestInput) (*gossiptopics.EmptyOutput, error)
  • func (s *Service) HandleBlockSyncResponse(ctx context.Context, input *gossiptopics.BlockSyncResponseInput) (*gossiptopics.EmptyOutput, error)
  • func (s *Service) NodeSyncCommitBlock(ctx context.Context, input *services.CommitBlockInput) (*services.CommitBlockOutput, error)
  • func (s *Service) RegisterConsensusBlocksHandler(handler handlers.ConsensusBlocksHandler)
  • func (s *Service) UpdateConsensusAlgosAboutLastCommittedBlockInLocalPersistence(ctx context.Context)
  • func (s *Service) ValidateBlockForCommit(ctx context.Context, input *services.ValidateBlockForCommitInput) (*services.ValidateBlockForCommitOutput, error)

Constants

const UNKNOWN_BLOCK_HEIGHT = primitives.BlockHeight(0)

Variables

var LogTag = log.Service("block-storage")

Types

type Service

type Service struct {
	govnr.TreeSupervisor
	// contains filtered or unexported fields
}

func NewBlockStorage

func NewBlockStorage(
	ctx context.Context,
	config config.BlockStorageConfig,
	persistence adapter.BlockPersistence,
	gossip gossiptopics.BlockSync,
	parentLogger log.Logger,
	metricFactory metric.Factory,
	blockPairReceivers []servicesync.BlockPairCommitter,
) *Service

func (*Service) CommitBlock

func (s *Service) CommitBlock(ctx context.Context, input *services.CommitBlockInput) (*services.CommitBlockOutput, error)

func (*Service) GenerateReceiptProof

func (s *Service) GenerateReceiptProof(ctx context.Context, input *services.GenerateReceiptProofInput) (*services.GenerateReceiptProofOutput, error)

func (*Service) GetBlock

func (s *Service) GetBlock(height primitives.BlockHeight) (*protocol.BlockPairContainer, error)

func (*Service) GetBlockPair

func (s *Service) GetBlockPair(ctx context.Context, input *services.GetBlockPairInput) (*services.GetBlockPairOutput, error)

func (*Service) GetBlockSlice

func (s *Service) GetBlockSlice(first primitives.BlockHeight, last primitives.BlockHeight) ([]*protocol.BlockPairContainer, primitives.BlockHeight, primitives.BlockHeight, error)

Returns a slice of blocks containing first and last TODO kill this method signature or use a larger page size without returning too many blocks

func (*Service) GetLastCommittedBlockHeight

func (s *Service) GetLastCommittedBlockHeight(ctx context.Context, input *services.GetLastCommittedBlockHeightInput) (*services.GetLastCommittedBlockHeightOutput, error)

func (*Service) GetResultsBlockHeader

func (s *Service) GetResultsBlockHeader(ctx context.Context, input *services.GetResultsBlockHeaderInput) (result *services.GetResultsBlockHeaderOutput, err error)

func (*Service) GetSyncState

func (s *Service) GetSyncState() internodesync.SyncState

func (*Service) GetTransactionReceipt

func (s *Service) GetTransactionReceipt(ctx context.Context, input *services.GetTransactionReceiptInput) (*services.GetTransactionReceiptOutput, error)

func (*Service) GetTransactionsBlockHeader

func (s *Service) GetTransactionsBlockHeader(ctx context.Context, input *services.GetTransactionsBlockHeaderInput) (result *services.GetTransactionsBlockHeaderOutput, err error)

func (*Service) HandleBlockAvailabilityRequest

func (s *Service) HandleBlockAvailabilityRequest(ctx context.Context, input *gossiptopics.BlockAvailabilityRequestInput) (*gossiptopics.EmptyOutput, error)

func (*Service) HandleBlockAvailabilityResponse

func (s *Service) HandleBlockAvailabilityResponse(ctx context.Context, input *gossiptopics.BlockAvailabilityResponseInput) (*gossiptopics.EmptyOutput, error)

func (*Service) HandleBlockSyncRequest

func (s *Service) HandleBlockSyncRequest(ctx context.Context, input *gossiptopics.BlockSyncRequestInput) (*gossiptopics.EmptyOutput, error)

func (*Service) HandleBlockSyncResponse

func (s *Service) HandleBlockSyncResponse(ctx context.Context, input *gossiptopics.BlockSyncResponseInput) (*gossiptopics.EmptyOutput, error)

func (*Service) NodeSyncCommitBlock

func (s *Service) NodeSyncCommitBlock(ctx context.Context, input *services.CommitBlockInput) (*services.CommitBlockOutput, error)

func (*Service) RegisterConsensusBlocksHandler

func (s *Service) RegisterConsensusBlocksHandler(handler handlers.ConsensusBlocksHandler)

func (*Service) UpdateConsensusAlgosAboutLastCommittedBlockInLocalPersistence

func (s *Service) UpdateConsensusAlgosAboutLastCommittedBlockInLocalPersistence(ctx context.Context)

TODO(v1): this function should return an error

func (*Service) ValidateBlockForCommit

func (s *Service) ValidateBlockForCommit(ctx context.Context, input *services.ValidateBlockForCommitInput) (*services.ValidateBlockForCommitOutput, error)

TODO Implement optimization for full structural validation here (https://github.com/orbs-network/orbs-network-go/issues/684)