stdlib

package
v0.39.13-stable-cadence Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 26, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source 
const AccountCapabilityStorageDomain = "acc_cap"

AccountCapabilityStorageDomain is the storage domain which records active account capability controller IDs

View Source 
const BlockHashLength = 32
View Source 
const CapabilityControllerStorageDomain = "cap_con"

CapabilityControllerStorageDomain is the storage domain which stores capability controllers by capability ID

View Source 
const CapabilityControllerTagStorageDomain = "cap_tag"

CapabilityControllerTagStorageDomain is the storage domain which stores capability controller tags by capability ID

View Source 
const CryptoCheckerLocation = common.IdentifierLocation("Crypto")
View Source 
const FlowLocationPrefix = "flow"
View Source 
const HashSize = 32
View Source 
const InboxStorageDomain = "inbox"
View Source 
const PathCapabilityStorageDomain = "path_cap"

PathCapabilityStorageDomain is the storage domain which stores capability ID dictionaries (sets) by storage path identifier

View Source 
const TestContractLocation = common.IdentifierLocation(testContractTypeName)

Variables

View Source 
var AccountContractAddedEventType = newFlowEventType(
	"AccountContractAdded",
	AccountEventAddressParameter,
	AccountEventCodeHashParameter,
	AccountEventContractParameter,
)
View Source 
var AccountContractRemovedEventType = newFlowEventType(
	"AccountContractRemoved",
	AccountEventAddressParameter,
	AccountEventCodeHashParameter,
	AccountEventContractParameter,
)
View Source 
var AccountContractUpdatedEventType = newFlowEventType(
	"AccountContractUpdated",
	AccountEventAddressParameter,
	AccountEventCodeHashParameter,
	AccountEventContractParameter,
)
View Source 
var AccountCreatedEventType = newFlowEventType(
	"AccountCreated",
	AccountEventAddressParameter,
)
View Source 
var AccountEventAddressParameter = sema.Parameter{
	Identifier:     "address",
	TypeAnnotation: sema.AddressTypeAnnotation,
}
View Source 
var AccountEventCodeHashParameter = sema.Parameter{
	Identifier:     "codeHash",
	TypeAnnotation: HashTypeAnnotation,
}
View Source 
var AccountEventContractParameter = sema.Parameter{
	Identifier:     "contract",
	TypeAnnotation: sema.StringTypeAnnotation,
}
View Source 
var AccountEventNameParameter = sema.Parameter{
	Identifier:     "name",
	TypeAnnotation: sema.StringTypeAnnotation,
}
View Source 
var AccountEventProviderParameter = sema.Parameter{
	Identifier:     "provider",
	TypeAnnotation: sema.AddressTypeAnnotation,
}
View Source 
var AccountEventPublicKeyIndexParameter = sema.Parameter{
	Identifier: "publicKey",
	TypeAnnotation: sema.NewTypeAnnotation(
		sema.IntType,
	),
}
View Source 
var AccountEventPublicKeyParameterAsCompositeType = sema.Parameter{
	Identifier: "publicKey",
	TypeAnnotation: sema.NewTypeAnnotation(
		sema.PublicKeyType,
	),
}
View Source 
var AccountEventRecipientParameter = sema.Parameter{
	Identifier:     "recipient",
	TypeAnnotation: sema.AddressTypeAnnotation,
}
View Source 
var AccountEventTypeParameter = sema.Parameter{
	Identifier:     "type",
	TypeAnnotation: sema.MetaTypeAnnotation,
}
View Source 
var AccountInboxClaimedEventType = newFlowEventType(
	"InboxValueClaimed",
	AccountEventProviderParameter,
	AccountEventRecipientParameter,
	AccountEventNameParameter,
)
View Source 
var AccountInboxPublishedEventType = newFlowEventType(
	"InboxValuePublished",
	AccountEventProviderParameter,
	AccountEventRecipientParameter,
	AccountEventNameParameter,
	AccountEventTypeParameter,
)
View Source 
var AccountInboxUnpublishedEventType = newFlowEventType(
	"InboxValueUnpublished",
	AccountEventProviderParameter,
	AccountEventNameParameter,
)
View Source 
var AccountKeyAddedFromPublicKeyEventType = newFlowEventType(
	"AccountKeyAdded",
	AccountEventAddressParameter,
	AccountEventPublicKeyParameterAsCompositeType,
)
View Source 
var AccountKeyRemovedFromPublicKeyIndexEventType = newFlowEventType(
	"AccountKeyRemoved",
	AccountEventAddressParameter,
	AccountEventPublicKeyIndexParameter,
)
View Source 
var AccountLinkedEventType = newFlowEventType(
	"AccountLinked",
	AccountEventAddressParameter,
	sema.Parameter{
		Identifier:     "path",
		TypeAnnotation: sema.AuthAccountTypeLinkAccountFunctionTypePathParameterTypeAnnotation,
	},
)
View Source 
var AssertFunction = NewStandardLibraryFunction(
	"assert",
	assertFunctionType,
	assertFunctionDocString,
	func(invocation interpreter.Invocation) interpreter.Value {
		result, ok := invocation.Arguments[0].(interpreter.BoolValue)
		if !ok {
			panic(errors.NewUnreachableError())
		}

		if !result {
			var message string
			if len(invocation.Arguments) > 1 {
				messageValue, ok := invocation.Arguments[1].(*interpreter.StringValue)
				if !ok {
					panic(errors.NewUnreachableError())
				}
				message = messageValue.Str
			}
			panic(AssertionError{
				Message:       message,
				LocationRange: invocation.LocationRange,
			})
		}
		return interpreter.Void
	},
)
View Source 
var BlockIDStaticType = interpreter.ConstantSizedStaticType{
	Type: interpreter.PrimitiveStaticTypeUInt8,
	Size: 32,
}
View Source 
var FlowEventTypes = map[common.TypeID]*sema.CompositeType{}
View Source 
var HashType = &sema.ConstantSizedType{
	Size: HashSize,
	Type: sema.UInt8Type,
}
View Source 
var HashTypeAnnotation = sema.NewTypeAnnotation(HashType)
View Source 
var LogFunctionType = sema.NewSimpleFunctionType(
	sema.FunctionPurityImpure,
	[]sema.Parameter{
		{
			Label:          sema.ArgumentLabelNotRequired,
			Identifier:     "value",
			TypeAnnotation: sema.AnyStructTypeAnnotation,
		},
	},
	sema.VoidTypeAnnotation,
)
View Source 
var PanicFunction = NewStandardLibraryFunction(
	"panic",
	panicFunctionType,
	panicFunctionDocString,
	func(invocation interpreter.Invocation) interpreter.Value {
		messageValue, ok := invocation.Arguments[0].(*interpreter.StringValue)
		if !ok {
			panic(errors.NewUnreachableError())
		}
		message := messageValue.Str

		panic(PanicError{
			Message:       message,
			LocationRange: invocation.LocationRange,
		})
	},
)
View Source 
var RLPContract = StandardLibraryValue{
	Name:  "RLP",
	Type:  rlpContractType,
	Value: rlpContractValue,
	Kind:  common.DeclarationKindContract,
}
View Source 
var SignatureAlgorithmConstructor = StandardLibraryValue{
	Name: sema.SignatureAlgorithmTypeName,
	Type: cryptoAlgorithmEnumConstructorType(
		sema.SignatureAlgorithmType,
		sema.SignatureAlgorithms,
	),
	Value: signatureAlgorithmConstructorValue,
	Kind:  common.DeclarationKindEnum,
}
View Source 
var _, SignatureAlgorithmCaseValues = cryptoAlgorithmEnumValueAndCaseValues(
	sema.SignatureAlgorithmType,
	sema.SignatureAlgorithms,
	NewSignatureAlgorithmCase,
)

Functions

func BorrowCapabilityController added in v0.39.0 

func BorrowCapabilityController(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	capabilityAddress interpreter.AddressValue,
	capabilityID interpreter.UInt64Value,
	wantedBorrowType *sema.ReferenceType,
	capabilityBorrowType *sema.ReferenceType,
) interpreter.ReferenceValue

func CheckCapabilityController added in v0.39.0 

func CheckCapabilityController(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	capabilityAddress interpreter.AddressValue,
	capabilityID interpreter.UInt64Value,
	wantedBorrowType *sema.ReferenceType,
	capabilityBorrowType *sema.ReferenceType,
) interpreter.BoolValue

func CodeToHashValue added in v0.26.0 

func CodeToHashValue(inter *interpreter.Interpreter, code []byte) *interpreter.ArrayValue

func CryptoChecker added in v0.5.0 

func CryptoChecker() *sema.Checker

func CryptoContractInitializerTypes added in v0.30.0 

func CryptoContractInitializerTypes() []sema.Type

func CryptoContractType added in v0.30.0 

func CryptoContractType() *sema.CompositeType

func NewAccountKeyValue added in v0.26.0 

func NewAccountKeyValue(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	accountKey *AccountKey,
	publicKeySignatureVerifier PublicKeySignatureVerifier,
	blsPoPVerifier BLSPoPVerifier,
	hasher Hasher,
) interpreter.Value

func NewAuthAccountValue added in v0.26.0 

func NewAuthAccountValue(
	gauge common.MemoryGauge,
	handler AuthAccountHandler,
	addressValue interpreter.AddressValue,
) interpreter.Value

func NewBlockValue added in v0.26.0 

func NewBlockValue(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	block Block,
) interpreter.Value

func NewCryptoContract added in v0.5.0 

func NewCryptoContract(
	inter *interpreter.Interpreter,
	constructor interpreter.FunctionValue,
	invocationRange ast.Range,
) (
	*interpreter.CompositeValue,
	error,
)

func NewHashAlgorithmCase added in v0.18.0 

func NewHashAlgorithmCase(
	rawValue interpreter.UInt8Value,
	hasher Hasher,
) (
	interpreter.MemberAccessibleValue,
	error,
)

func NewHashAlgorithmFromValue added in v0.26.0 

func NewHashAlgorithmFromValue(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	value interpreter.Value,
) sema.HashAlgorithm

func NewPublicAccountValue added in v0.26.0 

func NewPublicAccountValue(
	gauge common.MemoryGauge,
	handler PublicAccountHandler,
	addressValue interpreter.AddressValue,
) interpreter.Value

func NewPublicKeyFromFields added in v0.30.0 

func NewPublicKeyFromFields(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	publicKey *interpreter.ArrayValue,
	signAlgo *interpreter.SimpleCompositeValue,
	publicKeyValidator PublicKeyValidator,
	publicKeySignatureVerifier PublicKeySignatureVerifier,
	blsPoPVerifier BLSPoPVerifier,
) *interpreter.CompositeValue

func NewPublicKeyValue added in v0.26.0 

func NewPublicKeyValue(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	publicKey *PublicKey,
	publicKeySignatureVerifier PublicKeySignatureVerifier,
	blsPoPVerifier BLSPoPVerifier,
) *interpreter.CompositeValue

func NewSignatureAlgorithmCase added in v0.18.0 

func NewSignatureAlgorithmCase(rawValue interpreter.UInt8Value) interpreter.MemberAccessibleValue

func NewTestInterpreterContractValueHandler added in v0.30.0 

func NewTestInterpreterContractValueHandler(
	testFramework TestFramework,
) interpreter.ContractValueHandlerFunc

func TestCheckerContractValueHandler added in v0.30.0 

func TestCheckerContractValueHandler(
	checker *sema.Checker,
	declaration *ast.CompositeDeclaration,
	compositeType *sema.CompositeType,
) sema.ValueDeclaration

Types

type Account added in v0.27.0 

type Account struct {
	PublicKey *PublicKey
	Address   common.Address
}

type AccountContractAdditionHandler added in v0.26.0 

type AccountContractAdditionHandler interface {
	EventEmitter
	AccountContractProvider
	ParseAndCheckProgram(
		code []byte,
		location common.Location,
		getAndSetProgram bool,
	) (*interpreter.Program, error)
	// UpdateAccountContractCode updates the code associated with an account contract.
	UpdateAccountContractCode(location common.AddressLocation, code []byte) error
	RecordContractUpdate(location common.AddressLocation, value *interpreter.CompositeValue)
	InterpretContract(
		location common.AddressLocation,
		program *interpreter.Program,
		name string,
		invocation DeployedContractConstructorInvocation,
	) (
		*interpreter.CompositeValue,
		error,
	)
	TemporarilyRecordCode(location common.AddressLocation, code []byte)
}

type AccountContractNamesProvider added in v0.26.0 

type AccountContractNamesProvider interface {
	// GetAccountContractNames returns the names of all contracts deployed in an account.
	GetAccountContractNames(address common.Address) ([]string, error)
}

type AccountContractProvider added in v0.26.0 

type AccountContractProvider interface {
	// GetAccountContractCode returns the code associated with an account contract.
	GetAccountContractCode(location common.AddressLocation) ([]byte, error)
}

type AccountContractRemovalHandler added in v0.26.0 

type AccountContractRemovalHandler interface {
	EventEmitter
	AccountContractProvider
	RemoveAccountContractCode(location common.AddressLocation) error
	RecordContractRemoval(location common.AddressLocation)
}

type AccountCreator added in v0.26.0 

type AccountCreator interface {
	EventEmitter
	AuthAccountHandler
	// CreateAccount creates a new account.
	CreateAccount(payer common.Address) (address common.Address, err error)
}

type AccountIDGenerator added in v0.39.0 

type AccountIDGenerator interface {
	// GenerateAccountID generates a new, *non-zero*, unique ID for the given account.
	GenerateAccountID(address common.Address) (uint64, error)
}

type AccountKey added in v0.26.0 

type AccountKey struct {
	PublicKey *PublicKey
	KeyIndex  int
	Weight    int
	HashAlgo  sema.HashAlgorithm
	IsRevoked bool
}

type AccountKeyAdditionHandler added in v0.26.0 

type AccountKeyAdditionHandler interface {
	EventEmitter
	PublicKeyValidator
	PublicKeySignatureVerifier
	BLSPoPVerifier
	Hasher
	// AddAccountKey appends a key to an account.
	AddAccountKey(address common.Address, key *PublicKey, algo sema.HashAlgorithm, weight int) (*AccountKey, error)
}

type AccountKeyProvider added in v0.26.0 

type AccountKeyProvider interface {
	PublicKeyValidator
	PublicKeySignatureVerifier
	BLSPoPVerifier
	Hasher
	// GetAccountKey retrieves a key from an account by index.
	GetAccountKey(address common.Address, index int) (*AccountKey, error)
	AccountKeysCount(address common.Address) (uint64, error)
}

type AccountKeyRevocationHandler added in v0.26.0 

type AccountKeyRevocationHandler interface {
	EventEmitter
	Hasher
	PublicKeyValidator
	PublicKeySignatureVerifier
	BLSPoPVerifier
	// RevokeAccountKey removes a key from an account by index.
	RevokeAccountKey(address common.Address, index int) (*AccountKey, error)
}

type AssertionError 

type AssertionError struct {
	interpreter.LocationRange
	Message string
}

func (AssertionError) Error 

func (e AssertionError) Error() string

func (AssertionError) IsUserError added in v0.25.0 

func (AssertionError) IsUserError()

type AuthAccountContractsHandler added in v0.26.0 

type AuthAccountContractsHandler interface {
	AccountContractProvider
	AccountContractAdditionHandler
	AccountContractRemovalHandler
	AccountContractNamesProvider
}

type AuthAccountHandler added in v0.26.0 

type AuthAccountHandler interface {
	AccountIDGenerator
	BalanceProvider
	AvailableBalanceProvider
	StorageUsedProvider
	StorageCapacityProvider
	AuthAccountKeysHandler
	AuthAccountContractsHandler
}

type AuthAccountKeysHandler added in v0.26.0 

type AuthAccountKeysHandler interface {
	AccountKeyProvider
	AccountKeyAdditionHandler
	AccountKeyRevocationHandler
}

type AvailableBalanceProvider added in v0.26.0 

type AvailableBalanceProvider interface {
	// GetAccountAvailableBalance gets accounts default flow token balance - balance that is reserved for storage.
	GetAccountAvailableBalance(address common.Address) (uint64, error)
}

type BLSContractHandler added in v0.30.0 

type BLSContractHandler interface {
	PublicKeyValidator
	PublicKeySignatureVerifier
	BLSPoPVerifier
	BLSPublicKeyAggregator
	BLSSignatureAggregator
}

type BLSPoPVerifier added in v0.30.0 

type BLSPoPVerifier interface {
	// BLSVerifyPOP verifies a proof of possession (PoP) for the receiver public key.
	BLSVerifyPOP(publicKey *PublicKey, signature []byte) (bool, error)
}

type BLSPublicKeyAggregator added in v0.30.0 

type BLSPublicKeyAggregator interface {
	PublicKeySignatureVerifier
	BLSPoPVerifier
	// BLSAggregatePublicKeys aggregate multiple BLS public keys into one.
	BLSAggregatePublicKeys(publicKeys []*PublicKey) (*PublicKey, error)
}

type BLSSignatureAggregator added in v0.30.0 

type BLSSignatureAggregator interface {
	// BLSAggregateSignatures aggregate multiple BLS signatures into one.
	BLSAggregateSignatures(signatures [][]byte) ([]byte, error)
}

type BalanceProvider added in v0.26.0 

type BalanceProvider interface {
	// GetAccountBalance gets accounts default flow token balance.
	GetAccountBalance(address common.Address) (uint64, error)
}

type Block added in v0.26.0 

type Block struct {
	Height    uint64
	View      uint64
	Hash      BlockHash
	Timestamp int64
}

type BlockAtHeightProvider added in v0.26.0 

type BlockAtHeightProvider interface {
	// GetBlockAtHeight returns the block at the given height.
	GetBlockAtHeight(height uint64) (block Block, exists bool, err error)
}

type BlockHash added in v0.26.0 

type BlockHash [BlockHashLength]byte

type CapabilityControllersMutatedDuringIterationError added in v0.39.0 

type CapabilityControllersMutatedDuringIterationError struct {
	interpreter.LocationRange
}

CapabilityControllersMutatedDuringIterationError

func (CapabilityControllersMutatedDuringIterationError) Error added in v0.39.0 

func (CapabilityControllersMutatedDuringIterationError) Error() string

func (CapabilityControllersMutatedDuringIterationError) IsUserError added in v0.39.0 

func (CapabilityControllersMutatedDuringIterationError) IsUserError()

type Configuration added in v0.27.0 

type Configuration struct {
	Addresses map[string]common.Address
}

type ConformanceMismatchError added in v0.26.0 

type ConformanceMismatchError struct {
	DeclName string
	ast.Range
}

ConformanceMismatchError is reported during a contract update, when the enum conformance of the new program does not match the existing one.

func (*ConformanceMismatchError) Error added in v0.26.0 

func (e *ConformanceMismatchError) Error() string

func (*ConformanceMismatchError) IsUserError added in v0.26.0 

func (*ConformanceMismatchError) IsUserError()

type ContractNotFoundError added in v0.26.0 

type ContractNotFoundError struct {
	ast.Range
}

ContractNotFoundError is reported during a contract update, if no contract can be found in the program.

func (*ContractNotFoundError) Error added in v0.26.0 

func (e *ContractNotFoundError) Error() string

func (*ContractNotFoundError) IsUserError added in v0.26.0 

func (*ContractNotFoundError) IsUserError()

type ContractRemovalError added in v0.26.0 

type ContractRemovalError struct {
	interpreter.LocationRange
	Name string
}

ContractRemovalError

func (*ContractRemovalError) Error added in v0.26.0 

func (e *ContractRemovalError) Error() string

func (*ContractRemovalError) IsUserError added in v0.26.0 

func (*ContractRemovalError) IsUserError()

type ContractUpdateError added in v0.26.0 

type ContractUpdateError struct {
	Location     common.Location
	ContractName string
	Errors       []error
}

ContractUpdateError is reported upon any invalid update to a contract or contract interface. It contains all the errors reported during the update validation.

func (*ContractUpdateError) ChildErrors added in v0.26.0 

func (e *ContractUpdateError) ChildErrors() []error

func (*ContractUpdateError) Error added in v0.26.0 

func (e *ContractUpdateError) Error() string

func (*ContractUpdateError) ImportLocation added in v0.26.0 

func (e *ContractUpdateError) ImportLocation() common.Location

func (*ContractUpdateError) IsUserError added in v0.26.0 

func (*ContractUpdateError) IsUserError()

type ContractUpdateValidator added in v0.26.0 

type ContractUpdateValidator struct {
	TypeComparator
	// contains filtered or unexported fields
}

func NewContractUpdateValidator added in v0.26.0 

func NewContractUpdateValidator(
	location common.Location,
	contractName string,
	oldProgram *ast.Program,
	newProgram *ast.Program,
) *ContractUpdateValidator

NewContractUpdateValidator initializes and returns a validator, without performing any validation. Invoke the `Validate()` method of the validator returned, to start validating the contract.

func (*ContractUpdateValidator) Validate added in v0.26.0 

func (validator *ContractUpdateValidator) Validate() error

Validate validates the contract update, and returns an error if it is an invalid update.

type CurrentBlockProvider added in v0.26.0 

type CurrentBlockProvider interface {
	BlockAtHeightProvider
	// GetCurrentBlockHeight returns the current block height.
	GetCurrentBlockHeight() (uint64, error)
}

type DeployedContractConstructorInvocation added in v0.26.0 

type DeployedContractConstructorInvocation struct {
	ContractType         *sema.CompositeType
	ConstructorArguments []interpreter.Value
	ArgumentTypes        []sema.Type
	ParameterTypes       []sema.Type
	Address              common.Address
}

type EnumCaseMismatchError added in v0.26.0 

type EnumCaseMismatchError struct {
	ExpectedName string
	FoundName    string
	ast.Range
}

EnumCaseMismatchError is reported during an enum update, when an updated enum case does not match the existing enum case.

func (*EnumCaseMismatchError) Error added in v0.26.0 

func (e *EnumCaseMismatchError) Error() string

func (*EnumCaseMismatchError) IsUserError added in v0.26.0 

func (*EnumCaseMismatchError) IsUserError()

type EventEmitter added in v0.26.0 

type EventEmitter interface {
	EmitEvent(
		inter *interpreter.Interpreter,
		eventType *sema.CompositeType,
		values []interpreter.Value,
		locationRange interpreter.LocationRange,
	)
}

type ExtraneousFieldError added in v0.26.0 

type ExtraneousFieldError struct {
	DeclName  string
	FieldName string
	ast.Range
}

ExtraneousFieldError is reported during a contract update, when an updated composite declaration has more fields than the existing declaration.

func (*ExtraneousFieldError) Error added in v0.26.0 

func (e *ExtraneousFieldError) Error() string

func (*ExtraneousFieldError) IsUserError added in v0.26.0 

func (*ExtraneousFieldError) IsUserError()

type FieldMismatchError added in v0.26.0 

type FieldMismatchError struct {
	Err       error
	DeclName  string
	FieldName string
	ast.Range
}

FieldMismatchError is reported during a contract update, when a type of a field does not match the existing type of the same field.

func (*FieldMismatchError) Error added in v0.26.0 

func (e *FieldMismatchError) Error() string

func (*FieldMismatchError) IsUserError added in v0.26.0 

func (*FieldMismatchError) IsUserError()

func (*FieldMismatchError) SecondaryError added in v0.26.0 

func (e *FieldMismatchError) SecondaryError() string

type FlowLocation added in v0.5.0 

type FlowLocation struct{}

func (FlowLocation) Description added in v0.25.0 

func (l FlowLocation) Description() string

func (FlowLocation) ID added in v0.5.0 

func (l FlowLocation) ID() string

func (FlowLocation) MarshalJSON added in v0.12.0 

func (l FlowLocation) MarshalJSON() ([]byte, error)

func (FlowLocation) QualifiedIdentifier added in v0.10.2 

func (l FlowLocation) QualifiedIdentifier(typeID common.TypeID) string

func (FlowLocation) String added in v0.12.0 

func (l FlowLocation) String() string

func (FlowLocation) TypeID added in v0.10.2 

func (l FlowLocation) TypeID(memoryGauge common.MemoryGauge, qualifiedIdentifier string) common.TypeID

type Hasher added in v0.30.0 

type Hasher interface {
	// Hash returns the digest of hashing the given data with using the given hash algorithm
	Hash(data []byte, tag string, algorithm sema.HashAlgorithm) ([]byte, error)
}

type InvalidContractArgumentError added in v0.30.0 

type InvalidContractArgumentError struct {
	ExpectedType sema.Type
	ActualType   sema.Type
	Index        int
}

func (*InvalidContractArgumentError) Error added in v0.30.0 

func (e *InvalidContractArgumentError) Error() string

func (*InvalidContractArgumentError) IsUserError added in v0.30.0 

func (*InvalidContractArgumentError) IsUserError()

type InvalidContractDeploymentError added in v0.26.0 

type InvalidContractDeploymentError struct {
	Err error
	interpreter.LocationRange
}

InvalidContractDeploymentError

func (*InvalidContractDeploymentError) ChildErrors added in v0.26.0 

func (e *InvalidContractDeploymentError) ChildErrors() []error

func (*InvalidContractDeploymentError) Error added in v0.26.0 

func (e *InvalidContractDeploymentError) Error() string

func (*InvalidContractDeploymentError) IsUserError added in v0.26.0 

func (*InvalidContractDeploymentError) IsUserError()

func (*InvalidContractDeploymentError) Unwrap added in v0.26.0 

func (e *InvalidContractDeploymentError) Unwrap() error

type InvalidContractDeploymentOriginError added in v0.26.0 

type InvalidContractDeploymentOriginError struct {
	interpreter.LocationRange
}

InvalidContractDeploymentOriginError

func (*InvalidContractDeploymentOriginError) Error added in v0.26.0 

func (*InvalidContractDeploymentOriginError) Error() string

func (*InvalidContractDeploymentOriginError) IsUserError added in v0.26.0 

func (*InvalidContractDeploymentOriginError) IsUserError()

type InvalidDeclarationKindChangeError added in v0.26.0 

type InvalidDeclarationKindChangeError struct {
	Name    string
	OldKind common.DeclarationKind
	NewKind common.DeclarationKind
	ast.Range
}

InvalidDeclarationKindChangeError is reported during a contract update, when an attempt is made to convert an existing contract to a contract interface, or vise versa.

func (*InvalidDeclarationKindChangeError) Error added in v0.26.0 

func (e *InvalidDeclarationKindChangeError) Error() string

func (*InvalidDeclarationKindChangeError) IsUserError added in v0.26.0 

func (*InvalidDeclarationKindChangeError) IsUserError()

type Logger added in v0.26.0 

type Logger interface {
	// ProgramLog logs program logs.
	ProgramLog(message string) error
}

type MissingDeclarationError added in v0.26.0 

type MissingDeclarationError struct {
	Name string
	Kind common.DeclarationKind
	ast.Range
}

MissingDeclarationError is reported during a contract update, if an existing declaration is removed.

func (*MissingDeclarationError) Error added in v0.26.0 

func (e *MissingDeclarationError) Error() string

func (*MissingDeclarationError) IsUserError added in v0.26.0 

func (*MissingDeclarationError) IsUserError()

type MissingEnumCasesError added in v0.26.0 

type MissingEnumCasesError struct {
	DeclName string
	Expected int
	Found    int
	ast.Range
}

MissingEnumCasesError is reported during an enum update, if any enum cases are removed from an existing enum.

func (*MissingEnumCasesError) Error added in v0.26.0 

func (e *MissingEnumCasesError) Error() string

func (*MissingEnumCasesError) IsUserError added in v0.26.0 

func (*MissingEnumCasesError) IsUserError()

type PanicError 

type PanicError struct {
	interpreter.LocationRange
	Message string
}

func (PanicError) Error 

func (e PanicError) Error() string

func (PanicError) IsUserError added in v0.25.0 

func (PanicError) IsUserError()

type PublicAccountContractsHandler added in v0.26.0 

type PublicAccountContractsHandler interface {
	AccountContractNamesProvider
	AccountContractProvider
}

type PublicAccountHandler added in v0.26.0 

type PublicAccountHandler interface {
	BalanceProvider
	AvailableBalanceProvider
	StorageUsedProvider
	StorageCapacityProvider
	PublicAccountKeysHandler
	PublicAccountContractsHandler
}

type PublicAccountKeysHandler added in v0.26.0 

type PublicAccountKeysHandler interface {
	AccountKeyProvider
}

type PublicKey added in v0.26.0 

type PublicKey struct {
	PublicKey []byte
	SignAlgo  sema.SignatureAlgorithm
}

func NewPublicKeyFromValue added in v0.26.0 

func NewPublicKeyFromValue(
	inter *interpreter.Interpreter,
	locationRange interpreter.LocationRange,
	publicKey interpreter.MemberAccessibleValue,
) (
	*PublicKey,
	error,
)

type PublicKeySignatureVerifier added in v0.30.0 

type PublicKeySignatureVerifier interface {
	// VerifySignature returns true if the given signature was produced by signing the given tag + data
	// using the given public key, signature algorithm, and hash algorithm.
	VerifySignature(
		signature []byte,
		tag string,
		signedData []byte,
		publicKey []byte,
		signatureAlgorithm sema.SignatureAlgorithm,
		hashAlgorithm sema.HashAlgorithm,
	) (bool, error)
}

type PublicKeyValidator added in v0.30.0 

type PublicKeyValidator interface {
	// ValidatePublicKey verifies the validity of a public key.
	ValidatePublicKey(key *PublicKey) error
}

type RLPDecodeListError added in v0.23.0 

type RLPDecodeListError struct {
	interpreter.LocationRange
	Msg string
}

func (RLPDecodeListError) Error added in v0.23.0 

func (e RLPDecodeListError) Error() string

func (RLPDecodeListError) IsUserError added in v0.25.0 

func (RLPDecodeListError) IsUserError()

type RLPDecodeStringError added in v0.23.0 

type RLPDecodeStringError struct {
	interpreter.LocationRange
	Msg string
}

func (RLPDecodeStringError) Error added in v0.23.0 

func (e RLPDecodeStringError) Error() string

func (RLPDecodeStringError) IsUserError added in v0.25.0 

func (RLPDecodeStringError) IsUserError()

type RequiredEntitlementMismatchError 

type RequiredEntitlementMismatchError struct {
	DeclName string
	ast.Range
}

RequiredEntitlementMismatchError is reported during a contract update, when the required entitlements of the new attachment does not match the existing one.

func (*RequiredEntitlementMismatchError) Error 

func (e *RequiredEntitlementMismatchError) Error() string

func (*RequiredEntitlementMismatchError) IsUserError 

func (*RequiredEntitlementMismatchError) IsUserError()

type ScriptResult added in v0.27.0 

type ScriptResult struct {
	Value interpreter.Value
	Error error
}

type StandardLibraryHandler added in v0.27.0 

type StandardLibraryHandler interface {
	Logger
	UnsafeRandomGenerator
	BlockAtHeightProvider
	CurrentBlockProvider
	PublicAccountHandler
	AccountCreator
	PublicKeyValidator
	PublicKeySignatureVerifier
	BLSPoPVerifier
	BLSPublicKeyAggregator
	BLSSignatureAggregator
	Hasher
}

type StandardLibraryType 

type StandardLibraryType struct {
	Type sema.Type
	Name string
	Kind common.DeclarationKind
}

func (StandardLibraryType) TypeDeclarationKind 

func (t StandardLibraryType) TypeDeclarationKind() common.DeclarationKind

func (StandardLibraryType) TypeDeclarationName added in v0.12.0 

func (t StandardLibraryType) TypeDeclarationName() string

func (StandardLibraryType) TypeDeclarationPosition 

func (StandardLibraryType) TypeDeclarationPosition() *ast.Position

func (StandardLibraryType) TypeDeclarationType 

func (t StandardLibraryType) TypeDeclarationType() sema.Type

type StandardLibraryValue 

type StandardLibraryValue struct {
	Type           sema.Type
	Value          interpreter.Value
	Position       *ast.Position
	Name           string
	DocString      string
	ArgumentLabels []string
	Kind           common.DeclarationKind
}

func DefaultScriptStandardLibraryValues added in v0.27.0 

func DefaultScriptStandardLibraryValues(handler StandardLibraryHandler) []StandardLibraryValue

func DefaultStandardLibraryValues added in v0.27.0 

func DefaultStandardLibraryValues(handler StandardLibraryHandler) []StandardLibraryValue

func NewAuthAccountConstructor added in v0.26.0 

func NewAuthAccountConstructor(creator AccountCreator) StandardLibraryValue

func NewBLSContract added in v0.30.0 

func NewBLSContract(
	gauge common.MemoryGauge,
	handler BLSContractHandler,
) StandardLibraryValue

func NewGetAccountFunction added in v0.26.0 

func NewGetAccountFunction(handler PublicAccountHandler) StandardLibraryValue

func NewGetAuthAccountFunction added in v0.26.0 

func NewGetAuthAccountFunction(handler AuthAccountHandler) StandardLibraryValue

func NewGetBlockFunction added in v0.26.0 

func NewGetBlockFunction(provider BlockAtHeightProvider) StandardLibraryValue

func NewGetCurrentBlockFunction added in v0.26.0 

func NewGetCurrentBlockFunction(provider CurrentBlockProvider) StandardLibraryValue

func NewHashAlgorithmConstructor added in v0.30.0 

func NewHashAlgorithmConstructor(hasher Hasher) StandardLibraryValue

func NewLogFunction added in v0.26.0 

func NewLogFunction(logger Logger) StandardLibraryValue

func NewPublicKeyConstructor added in v0.30.0 

func NewPublicKeyConstructor(
	publicKeyValidator PublicKeyValidator,
	publicKeySignatureVerifier PublicKeySignatureVerifier,
	blsPoPVerifier BLSPoPVerifier,
) StandardLibraryValue

func NewStandardLibraryFunction 

func NewStandardLibraryFunction(
	name string,
	functionType *sema.FunctionType,
	docString string,
	function interpreter.HostFunction,
) StandardLibraryValue

func NewUnsafeRandomFunction added in v0.26.0 

func NewUnsafeRandomFunction(generator UnsafeRandomGenerator) StandardLibraryValue

func (StandardLibraryValue) ValueDeclarationArgumentLabels 

func (v StandardLibraryValue) ValueDeclarationArgumentLabels() []string

func (StandardLibraryValue) ValueDeclarationDocString added in v0.17.0 

func (v StandardLibraryValue) ValueDeclarationDocString() string

func (StandardLibraryValue) ValueDeclarationIsConstant 

func (v StandardLibraryValue) ValueDeclarationIsConstant() bool

func (StandardLibraryValue) ValueDeclarationKind 

func (v StandardLibraryValue) ValueDeclarationKind() common.DeclarationKind

func (StandardLibraryValue) ValueDeclarationName added in v0.12.0 

func (v StandardLibraryValue) ValueDeclarationName() string

func (StandardLibraryValue) ValueDeclarationPosition 

func (v StandardLibraryValue) ValueDeclarationPosition() *ast.Position

func (StandardLibraryValue) ValueDeclarationType 

func (v StandardLibraryValue) ValueDeclarationType() sema.Type

func (StandardLibraryValue) ValueDeclarationValue added in v0.12.0 

func (v StandardLibraryValue) ValueDeclarationValue() interpreter.Value

type StorageCapacityProvider added in v0.26.0 

type StorageCapacityProvider interface {
	CommitStorageTemporarily(inter *interpreter.Interpreter) error
	// GetStorageCapacity gets storage capacity in bytes on the address.
	GetStorageCapacity(address common.Address) (uint64, error)
}

type StorageUsedProvider added in v0.26.0 

type StorageUsedProvider interface {
	CommitStorageTemporarily(inter *interpreter.Interpreter) error
	// GetStorageUsed gets storage used in bytes by the address at the moment of the function call.
	GetStorageUsed(address common.Address) (uint64, error)
}

type TestContractType added in v0.39.0 

type TestContractType struct {
	Checker          *sema.Checker
	CompositeType    *sema.CompositeType
	InitializerTypes []sema.Type
	// contains filtered or unexported fields
}

func GetTestContractType added in v0.39.0 

func GetTestContractType() *TestContractType

func (*TestContractType) NewTestContract added in v0.39.0 

func (t *TestContractType) NewTestContract(
	inter *interpreter.Interpreter,
	testFramework TestFramework,
	constructor interpreter.FunctionValue,
	invocationRange ast.Range,
) (
	*interpreter.CompositeValue,
	error,
)

type TestFailedError added in v0.27.0 

type TestFailedError struct {
	Err error
}

func (TestFailedError) Error added in v0.27.0 

func (e TestFailedError) Error() string

func (TestFailedError) IsUserError added in v0.27.0 

func (TestFailedError) IsUserError()

func (TestFailedError) Unwrap added in v0.27.0 

func (e TestFailedError) Unwrap() error

type TestFramework added in v0.27.0 

type TestFramework interface {
	RunScript(
		inter *interpreter.Interpreter,
		code string, arguments []interpreter.Value,
	) *ScriptResult

	CreateAccount() (*Account, error)

	AddTransaction(
		inter *interpreter.Interpreter,
		code string,
		authorizers []common.Address,
		signers []*Account,
		arguments []interpreter.Value,
	) error

	ExecuteNextTransaction() *TransactionResult

	CommitBlock() error

	DeployContract(
		inter *interpreter.Interpreter,
		name string,
		code string,
		account *Account,
		arguments []interpreter.Value,
	) error

	ReadFile(string) (string, error)

	UseConfiguration(configuration *Configuration)

	StandardLibraryHandler() StandardLibraryHandler

	Logs() []string

	ServiceAccount() (*Account, error)

	Events(
		inter *interpreter.Interpreter,
		eventType interpreter.StaticType,
	) interpreter.Value

	Reset()
}

TestFramework is the interface to be implemented by the test providers. Cadence standard library talks to test providers via this interface. This is used as a way to inject test provider dependencies dynamically.

type TransactionResult added in v0.27.0 

type TransactionResult struct {
	Error error
}

type TypeComparator added in v0.26.0 

type TypeComparator struct {
	RootDeclIdentifier *ast.Identifier
}

func (*TypeComparator) CheckConstantSizedTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckConstantSizedTypeEquality(expected *ast.ConstantSizedType, found ast.Type) error

func (*TypeComparator) CheckDictionaryTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckDictionaryTypeEquality(expected *ast.DictionaryType, found ast.Type) error

func (*TypeComparator) CheckFunctionTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckFunctionTypeEquality(expected *ast.FunctionType, found ast.Type) error

func (*TypeComparator) CheckInstantiationTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckInstantiationTypeEquality(expected *ast.InstantiationType, found ast.Type) error

func (*TypeComparator) CheckNominalTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckNominalTypeEquality(expected *ast.NominalType, found ast.Type) error

func (*TypeComparator) CheckOptionalTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckOptionalTypeEquality(expected *ast.OptionalType, found ast.Type) error

func (*TypeComparator) CheckReferenceTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckReferenceTypeEquality(expected *ast.ReferenceType, found ast.Type) error

func (*TypeComparator) CheckRestrictedTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckRestrictedTypeEquality(expected *ast.RestrictedType, found ast.Type) error

func (*TypeComparator) CheckVariableSizedTypeEquality added in v0.26.0 

func (c *TypeComparator) CheckVariableSizedTypeEquality(expected *ast.VariableSizedType, found ast.Type) error

type TypeMismatchError added in v0.26.0 

type TypeMismatchError struct {
	ExpectedType ast.Type
	FoundType    ast.Type
	ast.Range
}

TypeMismatchError is reported during a contract update, when a type of the new program does not match the existing type.

func (*TypeMismatchError) Error added in v0.26.0 

func (e *TypeMismatchError) Error() string

func (*TypeMismatchError) IsUserError added in v0.26.0 

func (*TypeMismatchError) IsUserError()

type UnsafeRandomGenerator added in v0.26.0 

type UnsafeRandomGenerator interface {
	// UnsafeRandom returns a random uint64,
	// where the process of random number derivation is not cryptographically secure.
	UnsafeRandom() (uint64, error)
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.