retainer

Documentation

Index

• type BlockMetadata
  • func (m *BlockMetadata) BlockMetadataResponse() *api.BlockMetadataResponse
  • func (m *BlockMetadata) TransactionMetadataResponse() *api.TransactionMetadataResponse
• type Retainer

Types

type BlockMetadata

type BlockMetadata struct {
	BlockID            iotago.BlockID
	BlockState         api.BlockState
	BlockFailureReason api.BlockFailureReason

	TransactionID            iotago.TransactionID
	TransactionState         api.TransactionState
	TransactionFailureReason api.TransactionFailureReason
}

func (*BlockMetadata) BlockMetadataResponse

func (m *BlockMetadata) BlockMetadataResponse() *api.BlockMetadataResponse

func (*BlockMetadata) TransactionMetadataResponse

func (m *BlockMetadata) TransactionMetadataResponse() *api.TransactionMetadataResponse

type Retainer

type Retainer interface {
	BlockMetadata(blockID iotago.BlockID) (*BlockMetadata, error)

	RegisteredValidatorsCache(uint32) ([]*api.ValidatorResponse, bool)
	RetainRegisteredValidatorsCache(uint32, []*api.ValidatorResponse)

	RetainBlockFailure(iotago.BlockID, api.BlockFailureReason)
	RetainTransactionFailure(iotago.BlockID, error)

	// Reset resets the component to a clean state as if it was created at the last commitment.
	Reset()

	// Interface embeds the required methods of the module.Interface.
	module.Interface
}

Retainer keeps and resolves all the information needed in the API and INX.