runtime

type CadenceRuntimeConstructor ¶ added in v0.30.0

type CadenceRuntimeConstructor func(config runtime.Config) runtime.Runtime

type ReusableCadenceRuntime ¶

type ReusableCadenceRuntime struct {
	runtime.Runtime

	TxRuntimeEnv     runtime.Environment
	ScriptRuntimeEnv runtime.Environment
	// contains filtered or unexported fields
}

ReusableCadenceRuntime is a wrapper around cadence Runtime and cadence Environment with pre-injected cadence context for: EVM, getTransactionIndex, ... it can be reused by changing the fvmEnv. The reuse happens accross blocks and between scripts and transactions

This exists because creating and setting up a cadence runtime and environment is a costly operation. This assumes that the following objects are safe to reuse across blocks: - cadence runtime - cadence environment - evm emulator (and related objects)

because the cadence environment differs between scripts and transactions there are 2 wrapper structs for ReusableCadenceRuntime that change what env ReadStored and InvokeContractFunction use.

func NewReusableCadenceRuntime(
	rt runtime.Runtime,
	chain flow.Chain,
	config runtime.Config,
) *ReusableCadenceRuntime

func (reusable *ReusableCadenceRuntime) CadenceScriptEnv() runtime.Environment

func (reusable *ReusableCadenceRuntime) CadenceTXEnv() runtime.Environment

func (reusable *ReusableCadenceRuntime) ExecuteScript(
	script runtime.Script,
	location common.Location,
) (
	cadence.Value,
	error,
)

func (reusable *ReusableCadenceRuntime) NewTransactionExecutor(
	script runtime.Script,
	location common.Location,
) runtime.Executor

func (reusable *ReusableCadenceRuntime) SetFvmEnvironment(fvmEnv environment.Environment)

type ReusableCadenceRuntimePool ¶

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

func NewCustomReusableCadenceRuntimePool(
	poolSize int,
	chain flow.Chain,
	config runtime.Config,
	newCustomRuntime CadenceRuntimeConstructor,
) ReusableCadenceRuntimePool

func NewReusableCadenceRuntimePool(
	poolSize int,
	chain flow.Chain,
	config runtime.Config,
) ReusableCadenceRuntimePool

func (pool ReusableCadenceRuntimePool) Borrow(
	fvmEnv environment.Environment,
	runtimeType environment.CadenceRuntimeType,
) environment.ReusableCadenceRuntime

func (pool ReusableCadenceRuntimePool) Return(
	reusable environment.ReusableCadenceRuntime,
)

type ReusableCadenceScriptRuntime ¶

type ReusableCadenceScriptRuntime struct {
	*ReusableCadenceRuntime
}

ReusableCadenceScriptRuntime is a wrapper around ReusableCadenceRuntime that is meant to be used in scripts. see: ReusableCadenceRuntime

func (reusable ReusableCadenceScriptRuntime) InvokeContractFunction(
	contractLocation common.AddressLocation,
	functionName string,
	arguments []cadence.Value,
	argumentTypes []sema.Type,
) (
	cadence.Value,
	error,
)

func (reusable ReusableCadenceScriptRuntime) ReadStored(
	address common.Address,
	path cadence.Path,
) (
	cadence.Value,
	error,
)

type ReusableCadenceTransactionRuntime ¶

type ReusableCadenceTransactionRuntime struct {
	*ReusableCadenceRuntime
}

ReusableCadenceTransactionRuntime is a wrapper around ReusableCadenceRuntime that is meant to be used in transactions. see: ReusableCadenceRuntime

func (reusable ReusableCadenceTransactionRuntime) InvokeContractFunction(
	contractLocation common.AddressLocation,
	functionName string,
	arguments []cadence.Value,
	argumentTypes []sema.Type,
) (
	cadence.Value,
	error,
)

func (reusable ReusableCadenceTransactionRuntime) ReadStored(
	address common.Address,
	path cadence.Path,
) (
	cadence.Value,
	error,
)

type SwappableEnvironment ¶

type SwappableEnvironment struct {
	environment.Environment
}

SwappableEnvironment is a wrapper type that extends the functionality of environment.Environment. It is designed to allow dynamic replacement of the underlying environment implementation.

type WrappedCadenceExecutor ¶

type WrappedCadenceExecutor struct {
	runtime.Executor
}

func (we WrappedCadenceExecutor) Execute() error

func (we WrappedCadenceExecutor) Preprocess() error

func (we WrappedCadenceExecutor) Result() (cadence.Value, error)

type WrappedCadenceRuntime ¶

type WrappedCadenceRuntime struct {
	runtime.Runtime
}

WrappedCadenceRuntime wraps cadence runtime to handle errors. Errors from cadence runtime should be handled with `errors.HandleRuntimeError` before the FVM can understand them. Handling all possible locations, where the error could be coming from, here, makes it impossible to forget to handle the error.

func (wr WrappedCadenceRuntime) ExecuteScript(s runtime.Script, c runtime.Context) (cadence.Value, error)

func (wr WrappedCadenceRuntime) ExecuteTransaction(s runtime.Script, c runtime.Context) error

func (wr WrappedCadenceRuntime) InvokeContractFunction(
	contractLocation common.AddressLocation,
	functionName string,
	arguments []cadence.Value,
	argumentTypes []sema.Type,
	context runtime.Context,
) (cadence.Value, error)

func (wr WrappedCadenceRuntime) NewContractFunctionExecutor(
	contractLocation common.AddressLocation,
	functionName string,
	arguments []cadence.Value,
	argumentTypes []sema.Type,
	context runtime.Context,
) runtime.Executor

func (wr WrappedCadenceRuntime) NewScriptExecutor(s runtime.Script, c runtime.Context) runtime.Executor

func (wr WrappedCadenceRuntime) NewTransactionExecutor(s runtime.Script, c runtime.Context) runtime.Executor

func (wr WrappedCadenceRuntime) ParseAndCheckProgram(source []byte, context runtime.Context) (*interpreter.Program, error)

func (wr WrappedCadenceRuntime) ReadStored(address common.Address, path cadence.Path, context runtime.Context) (cadence.Value, error)

func (wr WrappedCadenceRuntime) Storage(context runtime.Context) (*runtime.Storage, *interpreter.Interpreter, error)