Options
All
  • Public
  • Public/Protected
  • All
Menu
interface

Organization

package

Governable

subpackage

Kernel

since

v1.0.0

description

Interface that describes a governable organization.

Hierarchy

  • Organization

Implemented by

Index

Properties

Methods

Properties

reader

reader: Reader
description

A blockchain reader adapter.

Methods

canExecute

  • Verifies the autorization for \a actor to execute a contract \a contract given a \a governAssetId organization governance asset identifier.

    access

    public

    Parameters

    • actor: PublicAccount

      The actor is whom executes a contract.

    • governAssetId: AssetIdentifier

      The organization's governance asset identifier.

    • contract: string

      The digital contract name.

    • argv: ContractOption[]

      The contract execution options (arguments).

    Returns AllowanceResult

    Returns whether an actor is authorized to execute said contract.

execute

  • Executes \a contract given \a governAssetId organization governance asset identifier, \a actor public account and \a argv contract execution options and \a parameters for network broadcasting.

    internal

    This method MUST use the Contract.execute() method.

    internal

    This method MUST call the synchronize() method.

    Parameters

    • actor: PublicAccount

      The actor is whom executes the command.

    • assetId: AssetIdentifier
    • contract: string

      The digital contract name. (e.g. "CreateVote").

    • parameters: TransactionParameters

      The transaction parameters (network specific).

    • argv: ContractOption[]

      The contract execution options (arguments).

    Returns Promise<TransactionURI<Transaction>>

synchronize

  • synchronize(): Promise<boolean>
  • Synchronizes a contract execution with the network. This method shall be used to fetch data required for execution (sometimes optional).

    async

    Returns Promise<boolean>

Generated using TypeDoc