query

Documentation

Index

• Constants
• type EntropyProviderPerBlock
  • func NewProtocolStateWrapper(s protocol.State) EntropyProviderPerBlock
• type Executor
• type QueryConfig
  • func NewDefaultConfig() QueryConfig
• type QueryExecutor
  • func NewQueryExecutor(config QueryConfig, logger zerolog.Logger, metrics module.ExecutionMetrics, ...) *QueryExecutor
  • func (e *QueryExecutor) ExecuteScript(ctx context.Context, script []byte, arguments [][]byte, ...) (encodedValue []byte, computationUsed uint64, err error)
  • func (e *QueryExecutor) GetAccount(ctx context.Context, address flow.Address, blockHeader *flow.Header, ...) (*flow.Account, error)
  • func (e *QueryExecutor) GetAccountAvailableBalance(ctx context.Context, address flow.Address, blockHeader *flow.Header, ...) (uint64, error)
  • func (e *QueryExecutor) GetAccountBalance(ctx context.Context, address flow.Address, blockHeader *flow.Header, ...) (uint64, error)
  • func (e *QueryExecutor) GetAccountKey(ctx context.Context, address flow.Address, keyIndex uint64, ...) (*flow.AccountPublicKey, error)
  • func (e *QueryExecutor) GetAccountKeys(ctx context.Context, address flow.Address, blockHeader *flow.Header, ...) ([]flow.AccountPublicKey, error)

Constants

const (
	DefaultLogTimeThreshold    = 1 * time.Second
	DefaultExecutionTimeLimit  = 10 * time.Second
	DefaultMaxErrorMessageSize = 1000 // 1000 chars
)

Types

type EntropyProviderPerBlock

type EntropyProviderPerBlock interface {
	// AtBlockID returns an entropy provider at the given block ID.
	AtBlockID(blockID flow.Identifier) environment.EntropyProvider
}

EntropyProviderPerBlock is an abstraction for entropy providers that can be used in `QueryExecutor`.

`EntropyProvider` is defined in `fvm/environment` and abstracts the distributed random source used by the protocol.

For a full-protocol node implementation , `EntropyProvider` is implemented by the protocol `Snapshot`, while `EntropyProviderPerBlock` is implemented by the protocol `State`. For nodes answering script queries that do not participate in the protocol, `EntropyProvider` and `EntropyProviderPerBlock` can be implemented by other components that provide the source of randomness for each block.

func NewProtocolStateWrapper

func NewProtocolStateWrapper(s protocol.State) EntropyProviderPerBlock

NewProtocolStateWrapper wraps a protocol.State input as an `EntropyProviderPerBlock`

type Executor

type Executor interface {
	ExecuteScript(
		ctx context.Context,
		script []byte,
		arguments [][]byte,
		blockHeader *flow.Header,
		snapshot snapshot.StorageSnapshot,
	) (
		[]byte,
		uint64,
		error,
	)

	GetAccount(
		ctx context.Context,
		addr flow.Address,
		header *flow.Header,
		snapshot snapshot.StorageSnapshot,
	) (
		*flow.Account,
		error,
	)

	GetAccountBalance(
		ctx context.Context,
		addr flow.Address,
		header *flow.Header,
		snapshot snapshot.StorageSnapshot,
	) (
		uint64,
		error,
	)

	GetAccountAvailableBalance(
		ctx context.Context,
		addr flow.Address,
		header *flow.Header,
		snapshot snapshot.StorageSnapshot,
	) (
		uint64,
		error,
	)

	GetAccountKeys(
		ctx context.Context,
		addr flow.Address,
		header *flow.Header,
		snapshot snapshot.StorageSnapshot,
	) (
		[]flow.AccountPublicKey,
		error,
	)

	GetAccountKey(
		ctx context.Context,
		addr flow.Address,
		keyIndex uint64,
		header *flow.Header,
		snapshot snapshot.StorageSnapshot,
	) (
		*flow.AccountPublicKey,
		error,
	)
}

type QueryConfig

type QueryConfig struct {
	LogTimeThreshold    time.Duration
	ExecutionTimeLimit  time.Duration
	ComputationLimit    uint64
	MaxErrorMessageSize int
}

func NewDefaultConfig

func NewDefaultConfig() QueryConfig

type QueryExecutor

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

func NewQueryExecutor

func NewQueryExecutor(
	config QueryConfig,
	logger zerolog.Logger,
	metrics module.ExecutionMetrics,
	vm fvm.VM,
	vmCtx fvm.Context,
	derivedChainData *derived.DerivedChainData,
	entropyPerBlock EntropyProviderPerBlock,
) *QueryExecutor

func (*QueryExecutor) ExecuteScript

func (e *QueryExecutor) ExecuteScript(
	ctx context.Context,
	script []byte,
	arguments [][]byte,
	blockHeader *flow.Header,
	snapshot snapshot.StorageSnapshot,
) (
	encodedValue []byte,
	computationUsed uint64,
	err error,
)

func (*QueryExecutor) GetAccount

func (e *QueryExecutor) GetAccount(
	ctx context.Context,
	address flow.Address,
	blockHeader *flow.Header,
	snapshot snapshot.StorageSnapshot,
) (
	*flow.Account,
	error,
)

func (*QueryExecutor) GetAccountAvailableBalance

func (e *QueryExecutor) GetAccountAvailableBalance(
	ctx context.Context,
	address flow.Address,
	blockHeader *flow.Header,
	snapshot snapshot.StorageSnapshot,
) (uint64, error)

func (*QueryExecutor) GetAccountBalance

func (e *QueryExecutor) GetAccountBalance(
	ctx context.Context,
	address flow.Address,
	blockHeader *flow.Header,
	snapshot snapshot.StorageSnapshot,
) (uint64, error)

func (*QueryExecutor) GetAccountKey

func (e *QueryExecutor) GetAccountKey(
	ctx context.Context,
	address flow.Address,
	keyIndex uint64,
	blockHeader *flow.Header,
	snapshot snapshot.StorageSnapshot,
) (*flow.AccountPublicKey, error)

func (*QueryExecutor) GetAccountKeys

func (e *QueryExecutor) GetAccountKeys(
	ctx context.Context,
	address flow.Address,
	blockHeader *flow.Header,
	snapshot snapshot.StorageSnapshot,
) ([]flow.AccountPublicKey, error)