Documentation
¶
Index ¶
- Constants
- Variables
- func FlowFeesAddress(chain flow.Chain) flow.Address
- func FlowTokenAddress(chain flow.Chain) flow.Address
- func FungibleTokenAddress(chain flow.Chain) flow.Address
- func NewInterpreterRuntime() runtime.Runtime
- type Blocks
- type BlocksFinder
- type BootstrapProcedure
- type BootstrapProcedureOption
- func WithAccountCreationFee(fee cadence.UFix64) BootstrapProcedureOption
- func WithEpochConfig(epochConfig epochs.EpochConfig) BootstrapProcedureOption
- func WithIdentities(identities flow.IdentityList) BootstrapProcedureOption
- func WithInitialTokenSupply(supply cadence.UFix64) BootstrapProcedureOption
- func WithMinimumStorageReservation(reservation cadence.UFix64) BootstrapProcedureOption
- func WithRestrictedAccountCreationEnabled(enabled cadence.Bool) BootstrapProcedureOption
- func WithRootBlock(rootBlock *flow.Header) BootstrapProcedureOption
- func WithStorageMBPerFLOW(ratio cadence.UFix64) BootstrapProcedureOption
- func WithTransactionFee(fee cadence.UFix64) BootstrapProcedureOption
- type Context
- type Enviornment
- type NoopBlockFinder
- type Option
- func WithAccountFreezeAvailable(accountFreezeAvailable bool) Option
- func WithAccountStorageLimit(enabled bool) Option
- func WithBlockHeader(header *flow.Header) Option
- func WithBlocks(blocks Blocks) Option
- func WithCadenceLogging(enabled bool) Option
- func WithChain(chain flow.Chain) Option
- func WithEventCollectionSizeLimit(limit uint64) Option
- func WithExtensiveTracing() Option
- func WithGasLimit(limit uint64) Option
- func WithMaxStateInteractionSize(limit uint64) Option
- func WithMaxStateKeySize(limit uint64) Option
- func WithMaxStateValueSize(limit uint64) Option
- func WithMetricsReporter(mr handler.MetricsReporter) Option
- func WithRestrictedDeployment(enabled bool) Option
- func WithServiceAccount(enabled bool) Option
- func WithServiceEventCollectionEnabled() Option
- func WithTracer(tr module.Tracer) Option
- func WithTransactionFeesEnabled(enabled bool) Option
- func WithTransactionProcessors(processors ...TransactionProcessor) Option
- type Procedure
- type ScriptEnv
- func (e *ScriptEnv) AccountExists(address common.Address) (exists bool, err error)
- func (e *ScriptEnv) AddAccountKey(_ runtime.Address, _ *runtime.PublicKey, _ runtime.HashAlgorithm, _ int) (*runtime.AccountKey, error)
- func (e *ScriptEnv) AddEncodedAccountKey(address runtime.Address, publicKey []byte) error
- func (e *ScriptEnv) Commit() ([]programs.ContractUpdateKey, error)
- func (e *ScriptEnv) CreateAccount(payer runtime.Address) (address runtime.Address, err error)
- func (e *ScriptEnv) DecodeArgument(b []byte, t cadence.Type) (cadence.Value, error)
- func (e *ScriptEnv) EmitEvent(event cadence.Event) error
- func (e *ScriptEnv) Events() []flow.Event
- func (e *ScriptEnv) GenerateUUID() (uint64, error)
- func (e *ScriptEnv) GetAccountAvailableBalance(address common.Address) (value uint64, err error)
- func (e *ScriptEnv) GetAccountBalance(address common.Address) (value uint64, err error)
- func (e *ScriptEnv) GetAccountContractCode(address runtime.Address, name string) (code []byte, err error)
- func (e *ScriptEnv) GetAccountKey(address runtime.Address, index int) (*runtime.AccountKey, error)
- func (e *ScriptEnv) GetBlockAtHeight(height uint64) (runtime.Block, bool, error)
- func (e *ScriptEnv) GetCode(location runtime.Location) ([]byte, error)
- func (e *ScriptEnv) GetComputationLimit() uint64
- func (e *ScriptEnv) GetComputationUsed() uint64
- func (e *ScriptEnv) GetCurrentBlockHeight() (uint64, error)
- func (e *ScriptEnv) GetProgram(location common.Location) (*interpreter.Program, error)
- func (e *ScriptEnv) GetSigningAccounts() ([]runtime.Address, error)
- func (e *ScriptEnv) GetStorageCapacity(address common.Address) (value uint64, err error)
- func (e *ScriptEnv) GetStorageUsed(address common.Address) (value uint64, err error)
- func (e *ScriptEnv) GetValue(owner, key []byte) ([]byte, error)
- func (e *ScriptEnv) Hash(data []byte, tag string, hashAlgorithm runtime.HashAlgorithm) ([]byte, error)
- func (e *ScriptEnv) ImplementationDebugLog(message string) error
- func (e *ScriptEnv) Logs() []string
- func (e *ScriptEnv) ProgramChecked(location common.Location, duration time.Duration)
- func (e *ScriptEnv) ProgramInterpreted(location common.Location, duration time.Duration)
- func (e *ScriptEnv) ProgramLog(message string) error
- func (e *ScriptEnv) ProgramParsed(location common.Location, duration time.Duration)
- func (e *ScriptEnv) RemoveAccountContractCode(address runtime.Address, name string) (err error)
- func (e *ScriptEnv) ResolveLocation(identifiers []runtime.Identifier, location runtime.Location) ([]runtime.ResolvedLocation, error)
- func (e *ScriptEnv) RevokeAccountKey(address runtime.Address, index int) (*runtime.AccountKey, error)
- func (e *ScriptEnv) RevokeEncodedAccountKey(address runtime.Address, index int) (publicKey []byte, err error)
- func (e *ScriptEnv) SetAccountFrozen(address common.Address, frozen bool) error
- func (e *ScriptEnv) SetComputationUsed(used uint64) error
- func (e *ScriptEnv) SetProgram(location common.Location, program *interpreter.Program) error
- func (e *ScriptEnv) SetValue(owner, key, value []byte) error
- func (e *ScriptEnv) UnsafeRandom() (uint64, error)
- func (e *ScriptEnv) UpdateAccountContractCode(address runtime.Address, name string, code []byte) (err error)
- func (e *ScriptEnv) ValidatePublicKey(pk *runtime.PublicKey) (bool, error)
- func (e *ScriptEnv) ValueDecoded(duration time.Duration)
- func (e *ScriptEnv) ValueEncoded(duration time.Duration)
- func (e *ScriptEnv) ValueExists(owner, key []byte) (exists bool, err error)
- func (e *ScriptEnv) VerifySignature(signature []byte, tag string, signedData []byte, publicKey []byte, ...) (bool, error)
- type ScriptInvocator
- type ScriptProcedure
- type ScriptProcessor
- type TransactionAccountFrozenChecker
- type TransactionAccountFrozenEnabler
- type TransactionContractFunctionInvocator
- type TransactionEnv
- func (e *TransactionEnv) AddAccountKey(address runtime.Address, publicKey *runtime.PublicKey, ...) (*runtime.AccountKey, error)
- func (e *TransactionEnv) AddEncodedAccountKey(address runtime.Address, publicKey []byte) error
- func (e *TransactionEnv) Commit() ([]programs.ContractUpdateKey, error)
- func (e *TransactionEnv) Context() *Context
- func (e *TransactionEnv) CreateAccount(payer runtime.Address) (address runtime.Address, err error)
- func (e *TransactionEnv) DecodeArgument(b []byte, t cadence.Type) (cadence.Value, error)
- func (e *TransactionEnv) EmitEvent(event cadence.Event) error
- func (e *TransactionEnv) Events() []flow.Event
- func (e *TransactionEnv) GenerateUUID() (uint64, error)
- func (e *TransactionEnv) GetAccountAvailableBalance(address common.Address) (value uint64, err error)
- func (e *TransactionEnv) GetAccountBalance(address common.Address) (value uint64, err error)
- func (e *TransactionEnv) GetAccountContractCode(address runtime.Address, name string) (code []byte, err error)
- func (e *TransactionEnv) GetAccountKey(address runtime.Address, keyIndex int) (*runtime.AccountKey, error)
- func (e *TransactionEnv) GetAuthorizedAccountsForContractUpdates() []common.Address
- func (e *TransactionEnv) GetBlockAtHeight(height uint64) (runtime.Block, bool, error)
- func (e *TransactionEnv) GetCode(location runtime.Location) ([]byte, error)
- func (e *TransactionEnv) GetComputationLimit() uint64
- func (e *TransactionEnv) GetComputationUsed() uint64
- func (e *TransactionEnv) GetCurrentBlockHeight() (uint64, error)
- func (e *TransactionEnv) GetProgram(location common.Location) (*interpreter.Program, error)
- func (e *TransactionEnv) GetSigningAccounts() ([]runtime.Address, error)
- func (e *TransactionEnv) GetStorageCapacity(address common.Address) (value uint64, err error)
- func (e *TransactionEnv) GetStorageUsed(address common.Address) (value uint64, err error)
- func (e *TransactionEnv) GetValue(owner, key []byte) ([]byte, error)
- func (e *TransactionEnv) Hash(data []byte, tag string, hashAlgorithm runtime.HashAlgorithm) ([]byte, error)
- func (e *TransactionEnv) ImplementationDebugLog(message string) error
- func (e *TransactionEnv) Logs() []string
- func (e *TransactionEnv) ProgramChecked(location common.Location, duration time.Duration)
- func (e *TransactionEnv) ProgramInterpreted(location common.Location, duration time.Duration)
- func (e *TransactionEnv) ProgramLog(message string) error
- func (e *TransactionEnv) ProgramParsed(location common.Location, duration time.Duration)
- func (e *TransactionEnv) RemoveAccountContractCode(address runtime.Address, name string) (err error)
- func (e *TransactionEnv) ResolveLocation(identifiers []runtime.Identifier, location runtime.Location) ([]runtime.ResolvedLocation, error)
- func (e *TransactionEnv) RevokeAccountKey(address runtime.Address, keyIndex int) (*runtime.AccountKey, error)
- func (e *TransactionEnv) RevokeEncodedAccountKey(address runtime.Address, index int) (publicKey []byte, err error)
- func (e *TransactionEnv) ServiceEvents() []flow.Event
- func (e *TransactionEnv) SetAccountFrozen(address common.Address, frozen bool) error
- func (e *TransactionEnv) SetComputationUsed(used uint64) error
- func (e *TransactionEnv) SetProgram(location common.Location, program *interpreter.Program) error
- func (e *TransactionEnv) SetValue(owner, key, value []byte) error
- func (e *TransactionEnv) TxID() flow.Identifier
- func (e *TransactionEnv) TxIndex() uint32
- func (e *TransactionEnv) UnsafeRandom() (uint64, error)
- func (e *TransactionEnv) UpdateAccountContractCode(address runtime.Address, name string, code []byte) (err error)
- func (e *TransactionEnv) VM() *VirtualMachine
- func (e *TransactionEnv) ValidatePublicKey(pk *runtime.PublicKey) (bool, error)
- func (e *TransactionEnv) ValueDecoded(duration time.Duration)
- func (e *TransactionEnv) ValueEncoded(duration time.Duration)
- func (e *TransactionEnv) ValueExists(owner, key []byte) (exists bool, err error)
- func (e *TransactionEnv) VerifySignature(signature []byte, tag string, signedData []byte, publicKey []byte, ...) (bool, error)
- type TransactionInvocator
- type TransactionProcedure
- type TransactionProcessor
- type TransactionSequenceNumberChecker
- type TransactionSignatureVerifier
- type TransactionStorageLimiter
- type VirtualMachine
Constants ¶
const ( DefaultGasLimit = 100_000 // 100K DefaultEventCollectionByteSizeLimit = 256_000 // 256KB DefaultMaxNumOfTxRetries = 3 )
const AccountKeyWeightThreshold = 1000
Variables ¶
var DefaultAccountCreationFee = func() cadence.UFix64 { value, err := cadence.NewUFix64("0.00100000") if err != nil { panic(fmt.Errorf("invalid default account creation fee: %w", err)) } return value }()
var DefaultMinimumStorageReservation = func() cadence.UFix64 { value, err := cadence.NewUFix64("0.00100000") if err != nil { panic(fmt.Errorf("invalid default minimum storage reservation: %w", err)) } return value }()
var DefaultStorageMBPerFLOW = func() cadence.UFix64 { value, err := cadence.NewUFix64("100.00000000") if err != nil { panic(fmt.Errorf("invalid default minimum storage reservation: %w", err)) } return value }()
var DefaultTransactionFees = func() cadence.UFix64 { value, err := cadence.NewUFix64("0.0001") if err != nil { panic(fmt.Errorf("invalid default transaction fees: %w", err)) } return value }()
DefaultTransactionFees are the default transaction fees if transaction fees are on. If they are off (which is the default behaviour) that means the transaction fees are 0.0.
Functions ¶
func NewInterpreterRuntime ¶ added in v0.15.1
Types ¶
type Blocks ¶
type Blocks interface { // ByHeight returns the block at the given height in the chain ending in `header` (or finalized // if `header` is nil). This enables querying un-finalized blocks by height with respect to the // chain defined by the block we are executing. ByHeightFrom(height uint64, header *flow.Header) (*flow.Header, error) }
func NewBlockFinder ¶ added in v0.13.0
NewBlockFinder constructs a new block finder
type BlocksFinder ¶ added in v0.13.0
type BlocksFinder struct {
// contains filtered or unexported fields
}
BlocksFinder finds blocks and return block headers
func (*BlocksFinder) ByHeightFrom ¶ added in v0.13.0
ByHeightFrom returns the block header by height.
type BootstrapProcedure ¶
type BootstrapProcedure struct {
// contains filtered or unexported fields
}
A BootstrapProcedure is an invokable that can be used to bootstrap the ledger state with the default accounts and contracts required by the Flow virtual machine.
func Bootstrap ¶
func Bootstrap( serviceAccountPublicKey flow.AccountPublicKey, opts ...BootstrapProcedureOption, ) *BootstrapProcedure
Bootstrap returns a new BootstrapProcedure instance configured with the provided genesis parameters.
func (*BootstrapProcedure) Run ¶
func (b *BootstrapProcedure) Run(vm *VirtualMachine, ctx Context, sth *state.StateHolder, programs *programs.Programs) error
type BootstrapProcedureOption ¶ added in v0.14.0
type BootstrapProcedureOption func(*BootstrapProcedure) *BootstrapProcedure
func WithAccountCreationFee ¶ added in v0.14.0
func WithAccountCreationFee(fee cadence.UFix64) BootstrapProcedureOption
func WithEpochConfig ¶ added in v0.20.0
func WithEpochConfig(epochConfig epochs.EpochConfig) BootstrapProcedureOption
func WithIdentities ¶ added in v0.20.0
func WithIdentities(identities flow.IdentityList) BootstrapProcedureOption
func WithInitialTokenSupply ¶ added in v0.14.0
func WithInitialTokenSupply(supply cadence.UFix64) BootstrapProcedureOption
func WithMinimumStorageReservation ¶ added in v0.14.0
func WithMinimumStorageReservation(reservation cadence.UFix64) BootstrapProcedureOption
func WithRestrictedAccountCreationEnabled ¶ added in v0.17.6
func WithRestrictedAccountCreationEnabled(enabled cadence.Bool) BootstrapProcedureOption
func WithRootBlock ¶ added in v0.20.0
func WithRootBlock(rootBlock *flow.Header) BootstrapProcedureOption
func WithStorageMBPerFLOW ¶ added in v0.16.1
func WithStorageMBPerFLOW(ratio cadence.UFix64) BootstrapProcedureOption
func WithTransactionFee ¶ added in v0.14.0
func WithTransactionFee(fee cadence.UFix64) BootstrapProcedureOption
type Context ¶
type Context struct { Chain flow.Chain Blocks Blocks Metrics handler.MetricsReporter Tracer module.Tracer GasLimit uint64 MaxStateKeySize uint64 MaxStateValueSize uint64 MaxStateInteractionSize uint64 EventCollectionByteSizeLimit uint64 MaxNumOfTxRetries uint8 BlockHeader *flow.Header ServiceAccountEnabled bool RestrictedDeploymentEnabled bool LimitAccountStorage bool TransactionFeesEnabled bool CadenceLoggingEnabled bool EventCollectionEnabled bool ServiceEventCollectionEnabled bool AccountFreezeAvailable bool ExtensiveTracing bool SignatureVerifier crypto.SignatureVerifier TransactionProcessors []TransactionProcessor ScriptProcessors []ScriptProcessor Logger zerolog.Logger }
A Context defines a set of execution parameters used by the virtual machine.
func NewContext ¶
NewContext initializes a new execution context with the provided options.
func NewContextFromParent ¶
NewContextFromParent spawns a child execution context with the provided options.
type Enviornment ¶ added in v0.20.0
type Enviornment interface { Context() *Context VM() *VirtualMachine runtime.Interface }
Enviornment accepts a context and a virtual machine instance and provides cadence runtime interface methods to the runtime.
type NoopBlockFinder ¶ added in v0.20.0
type NoopBlockFinder struct{}
NoopBlockFinder implements the Blocks interface. It is used in the bootstrapping process.
func (*NoopBlockFinder) ByHeightFrom ¶ added in v0.20.0
type Option ¶
An Option sets a configuration parameter for a virtual machine context.
func WithAccountFreezeAvailable ¶ added in v0.15.1
WithAccountFreezeAvailable sets availability of account freeze function for a virtual machine context.
With this option set to true, a setAccountFreeze function will be enabled for transactions processed by the VM
func WithAccountStorageLimit ¶ added in v0.14.0
WithAccountStorageLimit enables or disables checking if account storage used is over its storage capacity
func WithBlockHeader ¶
WithBlockHeader sets the block header for a virtual machine context.
The VM uses the header to provide current block information to the Cadence runtime, as well as to seed the pseudorandom number generator.
func WithBlocks ¶
WithBlocks sets the block storage provider for a virtual machine context.
The VM uses the block storage provider to provide historical block information to the Cadence runtime.
func WithCadenceLogging ¶ added in v0.13.1
WithCadenceLogging enables or disables Cadence logging for a virtual machine context.
func WithEventCollectionSizeLimit ¶ added in v0.13.1
WithEventCollectionSizeLimit sets the event collection byte size limit for a virtual machine context.
func WithExtensiveTracing ¶ added in v0.16.0
func WithExtensiveTracing() Option
WithExtensiveTracing sets the extensive tracing
func WithGasLimit ¶
WithGasLimit sets the gas limit for a virtual machine context.
func WithMaxStateInteractionSize ¶ added in v0.14.0
WithMaxStateInteractionSize sets the byte size limit for total interaction with ledger. this prevents attacks such as reading all large registers
func WithMaxStateKeySize ¶ added in v0.14.0
WithMaxStateKeySize sets the byte size limit for ledger keys
func WithMaxStateValueSize ¶ added in v0.14.0
WithMaxStateValueSize sets the byte size limit for ledger values
func WithMetricsReporter ¶ added in v0.17.6
func WithMetricsReporter(mr handler.MetricsReporter) Option
WithMetricsReporter sets the metrics collector for a virtual machine context.
A metrics collector is used to gather metrics reported by the Cadence runtime.
func WithRestrictedDeployment ¶
WithRestrictedDeployment enables or disables restricted contract deployment for a virtual machine context.
func WithServiceAccount ¶
WithServiceAccount enables or disables calls to the Flow service account.
func WithServiceEventCollectionEnabled ¶ added in v0.17.1
func WithServiceEventCollectionEnabled() Option
WithServiceEventCollectionEnabled enables service event collection
func WithTracer ¶ added in v0.14.5
WithTracer sets the tracer for a virtual machine context.
func WithTransactionFeesEnabled ¶ added in v0.17.1
WithTransactionFeesEnabled enables or disables deduction of transaction fees
func WithTransactionProcessors ¶
func WithTransactionProcessors(processors ...TransactionProcessor) Option
WithTransactionProcessors sets the transaction processors for a virtual machine context.
type Procedure ¶
type Procedure interface {
Run(vm *VirtualMachine, ctx Context, sth *state.StateHolder, programs *programs.Programs) error
}
An Procedure is an operation (or set of operations) that reads or writes ledger state.
type ScriptEnv ¶ added in v0.20.0
type ScriptEnv struct {
// contains filtered or unexported fields
}
ScriptEnv is a read-only mostly used for executing scripts.
func NewScriptEnvironment ¶ added in v0.20.0
func NewScriptEnvironment( ctx Context, vm *VirtualMachine, sth *state.StateHolder, programs *programs.Programs, ) *ScriptEnv
func (*ScriptEnv) AccountExists ¶ added in v0.20.0
func (*ScriptEnv) AddAccountKey ¶ added in v0.20.0
func (*ScriptEnv) AddEncodedAccountKey ¶ added in v0.20.0
func (*ScriptEnv) Commit ¶ added in v0.20.0
func (e *ScriptEnv) Commit() ([]programs.ContractUpdateKey, error)
Commit commits changes and return a list of updated keys
func (*ScriptEnv) CreateAccount ¶ added in v0.20.0
func (*ScriptEnv) DecodeArgument ¶ added in v0.20.0
func (*ScriptEnv) GenerateUUID ¶ added in v0.20.0
func (*ScriptEnv) GetAccountAvailableBalance ¶ added in v0.20.0
func (*ScriptEnv) GetAccountBalance ¶ added in v0.20.0
func (*ScriptEnv) GetAccountContractCode ¶ added in v0.20.0
func (*ScriptEnv) GetAccountKey ¶ added in v0.20.0
func (*ScriptEnv) GetBlockAtHeight ¶ added in v0.20.0
GetBlockAtHeight returns the block at the given height.
func (*ScriptEnv) GetComputationLimit ¶ added in v0.20.0
func (*ScriptEnv) GetComputationUsed ¶ added in v0.20.0
func (*ScriptEnv) GetCurrentBlockHeight ¶ added in v0.20.0
GetCurrentBlockHeight returns the current block height.
func (*ScriptEnv) GetProgram ¶ added in v0.20.0
func (*ScriptEnv) GetSigningAccounts ¶ added in v0.20.0
func (*ScriptEnv) GetStorageCapacity ¶ added in v0.20.0
func (*ScriptEnv) GetStorageUsed ¶ added in v0.20.0
func (*ScriptEnv) ImplementationDebugLog ¶ added in v0.20.0
func (*ScriptEnv) ProgramChecked ¶ added in v0.20.0
func (*ScriptEnv) ProgramInterpreted ¶ added in v0.20.0
func (*ScriptEnv) ProgramLog ¶ added in v0.20.0
func (*ScriptEnv) ProgramParsed ¶ added in v0.20.0
func (*ScriptEnv) RemoveAccountContractCode ¶ added in v0.20.0
func (*ScriptEnv) ResolveLocation ¶ added in v0.20.0
func (e *ScriptEnv) ResolveLocation( identifiers []runtime.Identifier, location runtime.Location, ) ([]runtime.ResolvedLocation, error)
func (*ScriptEnv) RevokeAccountKey ¶ added in v0.20.0
func (*ScriptEnv) RevokeEncodedAccountKey ¶ added in v0.20.0
func (*ScriptEnv) SetAccountFrozen ¶ added in v0.20.0
func (*ScriptEnv) SetComputationUsed ¶ added in v0.20.0
func (*ScriptEnv) SetProgram ¶ added in v0.20.0
func (*ScriptEnv) SetValue ¶ added in v0.20.0
TODO disable SetValue for scripts, right now the view changes are discarded
func (*ScriptEnv) UnsafeRandom ¶ added in v0.20.0
UnsafeRandom returns a random uint64, where the process of random number derivation is not cryptographically secure.
func (*ScriptEnv) UpdateAccountContractCode ¶ added in v0.20.0
func (*ScriptEnv) ValidatePublicKey ¶ added in v0.20.0
func (*ScriptEnv) ValueDecoded ¶ added in v0.20.0
func (*ScriptEnv) ValueEncoded ¶ added in v0.20.0
func (*ScriptEnv) ValueExists ¶ added in v0.20.0
func (*ScriptEnv) VerifySignature ¶ added in v0.20.0
type ScriptInvocator ¶
type ScriptInvocator struct{}
func NewScriptInvocator ¶
func NewScriptInvocator() ScriptInvocator
func (ScriptInvocator) Process ¶
func (i ScriptInvocator) Process( vm *VirtualMachine, ctx Context, proc *ScriptProcedure, sth *state.StateHolder, programs *programs.Programs, ) error
type ScriptProcedure ¶
type ScriptProcedure struct { ID flow.Identifier Script []byte Arguments [][]byte Value cadence.Value Logs []string Events []flow.Event GasUsed uint64 Err errors.Error }
func Script ¶
func Script(code []byte) *ScriptProcedure
func (*ScriptProcedure) Run ¶
func (proc *ScriptProcedure) Run(vm *VirtualMachine, ctx Context, sth *state.StateHolder, programs *programs.Programs) error
func (*ScriptProcedure) WithArguments ¶
func (proc *ScriptProcedure) WithArguments(args ...[]byte) *ScriptProcedure
type ScriptProcessor ¶
type ScriptProcessor interface {
Process(*VirtualMachine, Context, *ScriptProcedure, *state.StateHolder, *programs.Programs) error
}
type TransactionAccountFrozenChecker ¶ added in v0.15.1
type TransactionAccountFrozenChecker struct{}
func NewTransactionAccountFrozenChecker ¶ added in v0.15.1
func NewTransactionAccountFrozenChecker() *TransactionAccountFrozenChecker
func (*TransactionAccountFrozenChecker) Process ¶ added in v0.15.1
func (c *TransactionAccountFrozenChecker) Process( _ *VirtualMachine, _ *Context, proc *TransactionProcedure, sth *state.StateHolder, _ *programs.Programs, ) error
type TransactionAccountFrozenEnabler ¶ added in v0.15.1
type TransactionAccountFrozenEnabler struct{}
func NewTransactionAccountFrozenEnabler ¶ added in v0.15.1
func NewTransactionAccountFrozenEnabler() *TransactionAccountFrozenEnabler
func (*TransactionAccountFrozenEnabler) Process ¶ added in v0.15.1
func (c *TransactionAccountFrozenEnabler) Process( _ *VirtualMachine, ctx *Context, proc *TransactionProcedure, _ *state.StateHolder, _ *programs.Programs, ) error
type TransactionContractFunctionInvocator ¶ added in v0.17.1
type TransactionContractFunctionInvocator struct {
// contains filtered or unexported fields
}
func NewTransactionContractFunctionInvocator ¶ added in v0.17.1
func NewTransactionContractFunctionInvocator( contractLocation common.AddressLocation, functionName string, arguments []interpreter.Value, argumentTypes []sema.Type, logger zerolog.Logger) *TransactionContractFunctionInvocator
func (*TransactionContractFunctionInvocator) Invoke ¶ added in v0.17.1
func (i *TransactionContractFunctionInvocator) Invoke(env *TransactionEnv, parentTraceSpan opentracing.Span) (cadence.Value, error)
type TransactionEnv ¶ added in v0.20.0
type TransactionEnv struct {
// contains filtered or unexported fields
}
TransactionEnv is a read-write environment used for executing flow transactions.
func NewTransactionEnvironment ¶ added in v0.20.0
func NewTransactionEnvironment( ctx Context, vm *VirtualMachine, sth *state.StateHolder, programs *programs.Programs, tx *flow.TransactionBody, txIndex uint32, traceSpan opentracing.Span, ) *TransactionEnv
func (*TransactionEnv) AddAccountKey ¶ added in v0.20.0
func (e *TransactionEnv) AddAccountKey( address runtime.Address, publicKey *runtime.PublicKey, hashAlgo runtime.HashAlgorithm, weight int, ) ( *runtime.AccountKey, error, )
AddAccountKey adds a public key to an existing account.
This function returns an error if the specified account does not exist or if the key insertion fails.
func (*TransactionEnv) AddEncodedAccountKey ¶ added in v0.20.0
func (e *TransactionEnv) AddEncodedAccountKey(address runtime.Address, publicKey []byte) error
AddEncodedAccountKey adds an encoded public key to an existing account.
This function returns an error if the specified account does not exist or if the key insertion fails.
func (*TransactionEnv) Commit ¶ added in v0.20.0
func (e *TransactionEnv) Commit() ([]programs.ContractUpdateKey, error)
Commit commits changes and return a list of updated keys
func (*TransactionEnv) Context ¶ added in v0.20.0
func (e *TransactionEnv) Context() *Context
func (*TransactionEnv) CreateAccount ¶ added in v0.20.0
TODO (ramtin): check with Janez about not passing env
func (*TransactionEnv) DecodeArgument ¶ added in v0.20.0
func (*TransactionEnv) EmitEvent ¶ added in v0.20.0
func (e *TransactionEnv) EmitEvent(event cadence.Event) error
func (*TransactionEnv) Events ¶ added in v0.20.0
func (e *TransactionEnv) Events() []flow.Event
func (*TransactionEnv) GenerateUUID ¶ added in v0.20.0
func (e *TransactionEnv) GenerateUUID() (uint64, error)
func (*TransactionEnv) GetAccountAvailableBalance ¶ added in v0.20.0
func (e *TransactionEnv) GetAccountAvailableBalance(address common.Address) (value uint64, err error)
func (*TransactionEnv) GetAccountBalance ¶ added in v0.20.0
func (e *TransactionEnv) GetAccountBalance(address common.Address) (value uint64, err error)
func (*TransactionEnv) GetAccountContractCode ¶ added in v0.20.0
func (*TransactionEnv) GetAccountKey ¶ added in v0.20.0
func (e *TransactionEnv) GetAccountKey(address runtime.Address, keyIndex int) (*runtime.AccountKey, error)
GetAccountKey retrieves a public key by index from an existing account.
This function returns a nil key with no errors, if a key doesn't exist at the given index. An error is returned if the specified account does not exist, the provided index is not valid, or if the key retrieval fails.
func (*TransactionEnv) GetAuthorizedAccountsForContractUpdates ¶ added in v0.20.0
func (e *TransactionEnv) GetAuthorizedAccountsForContractUpdates() []common.Address
GetAuthorizedAccountsForContractUpdates returns a list of addresses that are authorized to update/deploy contracts
It reads a storage path from service account and parse the addresses. if any issue occurs on the process (missing registers, stored value properly not set) it gracefully handle it and falls back to default behaviour (only service account be authorized)
func (*TransactionEnv) GetBlockAtHeight ¶ added in v0.20.0
GetBlockAtHeight returns the block at the given height.
func (*TransactionEnv) GetCode ¶ added in v0.20.0
func (e *TransactionEnv) GetCode(location runtime.Location) ([]byte, error)
func (*TransactionEnv) GetComputationLimit ¶ added in v0.20.0
func (e *TransactionEnv) GetComputationLimit() uint64
func (*TransactionEnv) GetComputationUsed ¶ added in v0.20.0
func (e *TransactionEnv) GetComputationUsed() uint64
func (*TransactionEnv) GetCurrentBlockHeight ¶ added in v0.20.0
func (e *TransactionEnv) GetCurrentBlockHeight() (uint64, error)
GetCurrentBlockHeight returns the current block height.
func (*TransactionEnv) GetProgram ¶ added in v0.20.0
func (e *TransactionEnv) GetProgram(location common.Location) (*interpreter.Program, error)
func (*TransactionEnv) GetSigningAccounts ¶ added in v0.20.0
func (e *TransactionEnv) GetSigningAccounts() ([]runtime.Address, error)
func (*TransactionEnv) GetStorageCapacity ¶ added in v0.20.0
func (e *TransactionEnv) GetStorageCapacity(address common.Address) (value uint64, err error)
func (*TransactionEnv) GetStorageUsed ¶ added in v0.20.0
func (e *TransactionEnv) GetStorageUsed(address common.Address) (value uint64, err error)
func (*TransactionEnv) GetValue ¶ added in v0.20.0
func (e *TransactionEnv) GetValue(owner, key []byte) ([]byte, error)
func (*TransactionEnv) Hash ¶ added in v0.20.0
func (e *TransactionEnv) Hash(data []byte, tag string, hashAlgorithm runtime.HashAlgorithm) ([]byte, error)
func (*TransactionEnv) ImplementationDebugLog ¶ added in v0.20.0
func (e *TransactionEnv) ImplementationDebugLog(message string) error
func (*TransactionEnv) Logs ¶ added in v0.20.0
func (e *TransactionEnv) Logs() []string
func (*TransactionEnv) ProgramChecked ¶ added in v0.20.0
func (e *TransactionEnv) ProgramChecked(location common.Location, duration time.Duration)
func (*TransactionEnv) ProgramInterpreted ¶ added in v0.20.0
func (e *TransactionEnv) ProgramInterpreted(location common.Location, duration time.Duration)
func (*TransactionEnv) ProgramLog ¶ added in v0.20.0
func (e *TransactionEnv) ProgramLog(message string) error
func (*TransactionEnv) ProgramParsed ¶ added in v0.20.0
func (e *TransactionEnv) ProgramParsed(location common.Location, duration time.Duration)
func (*TransactionEnv) RemoveAccountContractCode ¶ added in v0.20.0
func (e *TransactionEnv) RemoveAccountContractCode(address runtime.Address, name string) (err error)
func (*TransactionEnv) ResolveLocation ¶ added in v0.20.0
func (e *TransactionEnv) ResolveLocation( identifiers []runtime.Identifier, location runtime.Location, ) ([]runtime.ResolvedLocation, error)
func (*TransactionEnv) RevokeAccountKey ¶ added in v0.20.0
func (e *TransactionEnv) RevokeAccountKey(address runtime.Address, keyIndex int) (*runtime.AccountKey, error)
RevokeAccountKey revokes a public key by index from an existing account, and returns the revoked key.
This function returns a nil key with no errors, if a key doesn't exist at the given index. An error is returned if the specified account does not exist, the provided index is not valid, or if the key revoking fails.
func (*TransactionEnv) RevokeEncodedAccountKey ¶ added in v0.20.0
func (e *TransactionEnv) RevokeEncodedAccountKey(address runtime.Address, index int) (publicKey []byte, err error)
RevokeEncodedAccountKey revokes a public key by index from an existing account.
This function returns an error if the specified account does not exist, the provided key is invalid, or if key revoking fails.
func (*TransactionEnv) ServiceEvents ¶ added in v0.20.0
func (e *TransactionEnv) ServiceEvents() []flow.Event
func (*TransactionEnv) SetAccountFrozen ¶ added in v0.20.0
func (e *TransactionEnv) SetAccountFrozen(address common.Address, frozen bool) error
func (*TransactionEnv) SetComputationUsed ¶ added in v0.20.0
func (e *TransactionEnv) SetComputationUsed(used uint64) error
func (*TransactionEnv) SetProgram ¶ added in v0.20.0
func (e *TransactionEnv) SetProgram(location common.Location, program *interpreter.Program) error
func (*TransactionEnv) SetValue ¶ added in v0.20.0
func (e *TransactionEnv) SetValue(owner, key, value []byte) error
func (*TransactionEnv) TxID ¶ added in v0.20.0
func (e *TransactionEnv) TxID() flow.Identifier
func (*TransactionEnv) TxIndex ¶ added in v0.20.0
func (e *TransactionEnv) TxIndex() uint32
func (*TransactionEnv) UnsafeRandom ¶ added in v0.20.0
func (e *TransactionEnv) UnsafeRandom() (uint64, error)
UnsafeRandom returns a random uint64, where the process of random number derivation is not cryptographically secure.
func (*TransactionEnv) UpdateAccountContractCode ¶ added in v0.20.0
func (*TransactionEnv) VM ¶ added in v0.20.0
func (e *TransactionEnv) VM() *VirtualMachine
func (*TransactionEnv) ValidatePublicKey ¶ added in v0.20.0
func (e *TransactionEnv) ValidatePublicKey(pk *runtime.PublicKey) (bool, error)
func (*TransactionEnv) ValueDecoded ¶ added in v0.20.0
func (e *TransactionEnv) ValueDecoded(duration time.Duration)
func (*TransactionEnv) ValueEncoded ¶ added in v0.20.0
func (e *TransactionEnv) ValueEncoded(duration time.Duration)
func (*TransactionEnv) ValueExists ¶ added in v0.20.0
func (e *TransactionEnv) ValueExists(owner, key []byte) (exists bool, err error)
func (*TransactionEnv) VerifySignature ¶ added in v0.20.0
func (e *TransactionEnv) VerifySignature( signature []byte, tag string, signedData []byte, publicKey []byte, signatureAlgorithm runtime.SignatureAlgorithm, hashAlgorithm runtime.HashAlgorithm, ) (bool, error)
type TransactionInvocator ¶
type TransactionInvocator struct {
// contains filtered or unexported fields
}
func NewTransactionInvocator ¶
func NewTransactionInvocator(logger zerolog.Logger) *TransactionInvocator
func (*TransactionInvocator) Process ¶
func (i *TransactionInvocator) Process( vm *VirtualMachine, ctx *Context, proc *TransactionProcedure, sth *state.StateHolder, programs *programs.Programs, ) (processErr error)
type TransactionProcedure ¶
type TransactionProcedure struct { ID flow.Identifier Transaction *flow.TransactionBody TxIndex uint32 Logs []string Events []flow.Event ServiceEvents []flow.Event ComputationUsed uint64 Err errors.Error Retried int TraceSpan opentracing.Span }
func Transaction ¶
func Transaction(tx *flow.TransactionBody, txIndex uint32) *TransactionProcedure
func (*TransactionProcedure) Run ¶
func (proc *TransactionProcedure) Run(vm *VirtualMachine, ctx Context, st *state.StateHolder, programs *programs.Programs) error
func (*TransactionProcedure) SetTraceSpan ¶ added in v0.14.5
func (proc *TransactionProcedure) SetTraceSpan(traceSpan opentracing.Span)
type TransactionProcessor ¶
type TransactionProcessor interface {
Process(*VirtualMachine, *Context, *TransactionProcedure, *state.StateHolder, *programs.Programs) error
}
type TransactionSequenceNumberChecker ¶
type TransactionSequenceNumberChecker struct{}
func NewTransactionSequenceNumberChecker ¶
func NewTransactionSequenceNumberChecker() *TransactionSequenceNumberChecker
func (*TransactionSequenceNumberChecker) Process ¶
func (c *TransactionSequenceNumberChecker) Process( _ *VirtualMachine, ctx *Context, proc *TransactionProcedure, sth *state.StateHolder, programs *programs.Programs, ) error
type TransactionSignatureVerifier ¶
type TransactionSignatureVerifier struct { SignatureVerifier crypto.SignatureVerifier KeyWeightThreshold int }
func NewTransactionSignatureVerifier ¶
func NewTransactionSignatureVerifier(keyWeightThreshold int) *TransactionSignatureVerifier
func (*TransactionSignatureVerifier) Process ¶
func (v *TransactionSignatureVerifier) Process( _ *VirtualMachine, ctx *Context, proc *TransactionProcedure, sth *state.StateHolder, programs *programs.Programs, ) error
type TransactionStorageLimiter ¶ added in v0.14.0
type TransactionStorageLimiter struct{}
func NewTransactionStorageLimiter ¶ added in v0.14.0
func NewTransactionStorageLimiter() *TransactionStorageLimiter
func (*TransactionStorageLimiter) CheckLimits ¶ added in v0.20.0
func (d *TransactionStorageLimiter) CheckLimits( env Enviornment, addresses []flow.Address, ) (err error)
type VirtualMachine ¶
A VirtualMachine augments the Cadence runtime with Flow host functionality.
func NewVirtualMachine ¶ added in v0.15.1
func NewVirtualMachine(rt runtime.Runtime) *VirtualMachine
NewVirtualMachine creates a new virtual machine instance with the provided runtime.
Source Files
¶
Directories
¶
Path | Synopsis |
---|---|
Package systemcontracts stores canonical address locations for all system smart contracts and service events.
|
Package systemcontracts stores canonical address locations for all system smart contracts and service events. |