retriever

Documentation

Index

• Constants
• type DefaultExtrinsicRetriever
  • func NewDefaultExtrinsicRetriever(extrinsicParser parser.DefaultExtrinsicParser, ...) (DefaultExtrinsicRetriever, error)
• type EventRetriever
  • func NewDefaultEventRetriever(eventProvider regState.EventProvider, stateRPC state.State, ...) (EventRetriever, error)
  • func NewEventRetriever(eventParser parser.EventParser, eventProvider regState.EventProvider, ...) (EventRetriever, error)
• type EventRetrieverMock
  • func NewEventRetrieverMock(t NewEventRetrieverMockT) *EventRetrieverMock
  • func (_m *EventRetrieverMock) GetEvents(blockHash types.Hash) ([]*parser.Event, error)
• type ExtrinsicRetriever
  • func NewExtrinsicRetriever[A, S, P any, B generic.GenericSignedBlock[A, S, P]](extrinsicParser parser.ExtrinsicParser[A, S, P], ...) (ExtrinsicRetriever[A, S, P], error)
• type ExtrinsicRetrieverMock
  • func NewExtrinsicRetrieverMock[A interface{}, S interface{}, P interface{}](t NewExtrinsicRetrieverMockT) *ExtrinsicRetrieverMock[A, S, P]
  • func (_m *ExtrinsicRetrieverMock[A, S, P]) GetExtrinsics(blockHash types.Hash) ([]*parser.Extrinsic[A, S, P], error)
• type NewEventRetrieverMockT
• type NewExtrinsicRetrieverMockT

Constants

const (
	ErrInternalStateUpdate   = libErr.Error("internal state update")
	ErrBlockRetrieval        = libErr.Error("block retrieval")
	ErrExtrinsicParsing      = libErr.Error("extrinsic parsing")
	ErrMetadataRetrieval     = libErr.Error("metadata retrieval")
	ErrCallRegistryCreation  = libErr.Error("call registry creation")
	ErrStorageEventRetrieval = libErr.Error("storage event retrieval")
	ErrEventParsing          = libErr.Error("event parsing")
	ErrEventRegistryCreation = libErr.Error("event registry creation")
)

Types

type DefaultExtrinsicRetriever

type DefaultExtrinsicRetriever = ExtrinsicRetriever[
	types.MultiAddress,
	types.MultiSignature,
	generic.DefaultPaymentFields,
]

DefaultExtrinsicRetriever is the ExtrinsicRetriever interface with default for the generic types:

Address - types.MultiAddress Signature - types.MultiSignature PaymentFields - generic.DefaultPaymentFields

func NewDefaultExtrinsicRetriever

func NewDefaultExtrinsicRetriever(
	extrinsicParser parser.DefaultExtrinsicParser,
	genericChain generic.DefaultChain,
	stateRPC state.State,
	registryFactory registry.Factory,
	chainExecutor exec.RetryableExecutor[*generic.DefaultGenericSignedBlock],
	extrinsicParsingExecutor exec.RetryableExecutor[[]*parser.DefaultExtrinsic],
) (DefaultExtrinsicRetriever, error)

NewDefaultExtrinsicRetriever returns a DefaultExtrinsicRetriever with defaults for the generic types:

Address - types.MultiAddress Signature - types.MultiSignature PaymentFields - generic.DefaultPaymentFields Block - *generic.DefaultGenericSignedBlock

Note that these generic defaults also apply to the args.

type EventRetriever

type EventRetriever interface {
	GetEvents(blockHash types.Hash) ([]*parser.Event, error)
}

EventRetriever is the interface used for retrieving and decoding events.

func NewDefaultEventRetriever

func NewDefaultEventRetriever(
	eventProvider regState.EventProvider,
	stateRPC state.State,
	fieldOverrides ...registry.FieldOverride,
) (EventRetriever, error)

NewDefaultEventRetriever creates a new EventRetriever using defaults for:

- parser.EventParser - registry.Factory - exec.RetryableExecutor - used for retrieving event storage data. - exec.RetryableExecutor - used for parsing events.

func NewEventRetriever

func NewEventRetriever(
	eventParser parser.EventParser,
	eventProvider regState.EventProvider,
	stateRPC state.State,
	registryFactory registry.Factory,
	eventStorageExecutor exec.RetryableExecutor[*types.StorageDataRaw],
	eventParsingExecutor exec.RetryableExecutor[[]*parser.Event],
) (EventRetriever, error)

NewEventRetriever creates a new EventRetriever.

type EventRetrieverMock

type EventRetrieverMock struct {
	mock.Mock
}

EventRetrieverMock is an autogenerated mock type for the EventRetriever type

func NewEventRetrieverMock

func NewEventRetrieverMock(t NewEventRetrieverMockT) *EventRetrieverMock

NewEventRetrieverMock creates a new instance of EventRetrieverMock. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.

func (*EventRetrieverMock) GetEvents

func (_m *EventRetrieverMock) GetEvents(blockHash types.Hash) ([]*parser.Event, error)

GetEvents provides a mock function with given fields: blockHash

type ExtrinsicRetriever

type ExtrinsicRetriever[A, S, P any] interface {
	GetExtrinsics(blockHash types.Hash) ([]*parser.Extrinsic[A, S, P], error)
}

ExtrinsicRetriever is the interface used for retrieving and decoding extrinsic information.

This interface is generic over types A, S, P, please check generic.GenericExtrinsicSignature for more information about these generic types.

func NewExtrinsicRetriever

func NewExtrinsicRetriever[
	A, S, P any,
	B generic.GenericSignedBlock[A, S, P],
](
	extrinsicParser parser.ExtrinsicParser[A, S, P],
	genericChain generic.Chain[A, S, P, B],
	stateRPC state.State,
	registryFactory registry.Factory,
	chainExecutor exec.RetryableExecutor[B],
	extrinsicParsingExecutor exec.RetryableExecutor[[]*parser.Extrinsic[A, S, P]],
) (ExtrinsicRetriever[A, S, P], error)

NewExtrinsicRetriever creates a new ExtrinsicRetriever.

type ExtrinsicRetrieverMock

type ExtrinsicRetrieverMock[A interface{}, S interface{}, P interface{}] struct {
	mock.Mock
}

ExtrinsicRetrieverMock is an autogenerated mock type for the ExtrinsicRetriever type

func NewExtrinsicRetrieverMock

func NewExtrinsicRetrieverMock[A interface{}, S interface{}, P interface{}](t NewExtrinsicRetrieverMockT) *ExtrinsicRetrieverMock[A, S, P]

NewExtrinsicRetrieverMock creates a new instance of ExtrinsicRetrieverMock. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.

func (*ExtrinsicRetrieverMock[A, S, P]) GetExtrinsics

func (_m *ExtrinsicRetrieverMock[A, S, P]) GetExtrinsics(blockHash types.Hash) ([]*parser.Extrinsic[A, S, P], error)

GetExtrinsics provides a mock function with given fields: blockHash

type NewEventRetrieverMockT

type NewEventRetrieverMockT interface {
	mock.TestingT
	Cleanup(func())
}

type NewExtrinsicRetrieverMockT

type NewExtrinsicRetrieverMockT interface {
	mock.TestingT
	Cleanup(func())
}