Interface Contract

interface: Contract
package: Governable
subpackage: Kernel
since: v1.0.0
description: Interface that describes digital contracts.

Hierarchy

Contract

Implemented by

Index

Properties

Methods

Properties

context

context: Context

description: The contract execution context

descriptor

descriptor: string

description: The contract on-chain descriptor

name

name: string

description: The contract name

Methods

canExecute

canExecute(actor: PublicAccount, argv: ContractOption[] | undefined): AllowanceResult

- Defined in src/kernel/Contract.ts:51
Verifies allowance of actor to execute contract. Arguments to the contract execution can be passed in argv.

Parameters
- actor: PublicAccount
- argv: ContractOption[] | undefined
Returns AllowanceResult

execute

execute(actor: PublicAccount, argv: ContractOption[] | undefined): TransactionURI<Transaction>

- Defined in src/kernel/Contract.ts:64
Execute the contract with actor operator account. Arguments to the contract execution can be passed in argv.

Parameters
- actor: PublicAccount
- argv: ContractOption[] | undefined
Returns TransactionURI<Transaction>

Generated using TypeDoc