Class Contract<C>

Callable object: contract. Can build and upload, and instantiate itself.

Type Parameters

Hierarchy

Constructors

constructor

Properties

address? agent? artifact? builder? builderId? chainId? client? codeHash? codeId? crate? deployment? dirty? features? initBy? initMsg? initTx? label? log name? prefix? repository? revision? suffix? uploadBy? uploadTx? uploader? uploaderId? workspace?

Accessors

[toStringTag] asContractCode asContractLink built deployed description uploaded

Methods

asAgent build define deploy expect instance instances matches upload

Constructors

constructor

Properties

Optional address

address?: string = undefined

Address of this contract instance. Unique per chain.

Optional agent

agent?: Agent = undefined

The Agent instance that will be used to upload and instantiate the contract.

Optional artifact

artifact?: string | URL = undefined

URL to the compiled code.

Optional builder

builder?: Builder = undefined

Build procedure implementation.

Optional builderId

builderId?: string = undefined

Builder implementation that produces a Contract from the Source.

Optional chainId

chainId?: string = undefined

ID of chain on which this contract is uploaded.

Optional client

client?: ClientClass<C> = undefined

The Client subclass that exposes the contract's methods.

Default

the base Client class.

Optional codeHash

codeHash?: string = undefined

Code hash uniquely identifying the compiled code.

Optional codeId

codeId?: string = undefined

Code ID representing the identity of the contract's code on a specific chain.

Optional crate

crate?: string = undefined

Name of crate in workspace.

Optional deployment

deployment?: Deployment = undefined

The deployment that this template belongs to.

Optional dirty

dirty?: boolean = undefined

Whether there were any uncommitted changes at build time.

Optional features

features?: string[] = undefined

List of crate features to enable during build.

Optional initBy

initBy?: string = undefined

Address of agent that performed the init tx.

Optional initMsg

initMsg?: Into<Message> = undefined

Address of agent that performed the init tx.

Optional initTx

initTx?: string = undefined

TXID of transaction that performed the init.

Optional label

label?: string = undefined

Full label of the instance. Unique for a given Chain.

log

log: Console

Optional name

name?: string

Proper name of the instance. Unique within the deployment. If the instance is not part of a Deployment, this is equal to the label. If the instance is part of a Deployment, this is used as storage key. You are encouraged to store application-specific versioning info in this field.

Optional prefix

prefix?: string = undefined

Prefix of the instance label. Identifies which Deployment the instance belongs to, if any. Prepended to contract label with a /: PREFIX/NAME...

Optional repository

repository?: string | URL = undefined

URL pointing to Git repository containing the source code.

Optional revision

revision?: string = undefined

Branch/tag pointing to the source commit.

Optional suffix

suffix?: string = undefined

Deduplication suffix. Appended to the contract label with a +: ...NAME+SUFFIX. This field has sometimes been used to redeploy an new instance within the same Deployment, taking the place of the old one. TODO: implement this field's semantics: last result of alphanumeric sort of suffixes is "the real one" (see https://stackoverflow.com/a/54427214.

Optional uploadBy

uploadBy?: string = undefined

Address of agent that performed the upload.

Optional uploadTx

uploadTx?: string = undefined

TXID of transaction that performed the upload.

Optional uploader

uploader?: Uploader = undefined

Upload procedure implementation.

Optional uploaderId

uploaderId?: string = undefined

Object containing upload logic.

Optional workspace

workspace?: string = undefined

Path to root directory of crate or workspace.

Accessors

[toStringTag]

asContractCode

asContractLink

built

deployed

  • get deployed(): Promise<C>

  • One-shot deployment task. After the first call, deploy redefines it to return the self-same deploying promise. Call deploy again to reset.

    Returns Promise<C>

description

uploaded

Methods

asAgent

build

define

deploy

  • Deploy the contract, or retrieve it if it's already deployed.

    Returns

    promise of instance of this.client

    Parameters

    Returns Promise<C>

expect

  • Returns

    an instance of this contract's client

    Throws

    tf the contract has no known address.

    Parameters

    • Optional message: string

    Returns C

instance

instances

matches

  • Returns

    true if the specified properties match the properties of this contract.

    Parameters

    Returns boolean

upload

Settings

Member Visibility

Theme

Generated using TypeDoc