Class Template<C>

Callable object: contract template. Can build and upload, but not instantiate. Can produce deployable Contract instances.

Type Parameters

Hierarchy

Constructors

constructor

Properties

agent? artifact? builder? builderId? chainId? client? codeHash? codeId? crate? deployment? dirty? features? log repository? revision? uploadBy? uploadTx? uploader? uploaderId? workspace?

Accessors

asContractCode built description uploaded

Methods

asAgent build define instance instances upload

Constructors

constructor

Properties

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.

log

log: Console = ...

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 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

asContractCode

built

description

uploaded

Methods

asAgent

  • Returns

    a copy of this object with a changed agent.

    Warning

    overriding constructor signature is discouraged.

    Parameters

    Returns this

build

define

  • Provide parameters for an existing instance.

    Returns

    mutated self

    Parameters

    Returns this

instance

instances

upload

Settings

Member Visibility

Theme

Generated using TypeDoc