Class Template<C>

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

Type Parameters

C extends Client

Hierarchy

Template
- Contract

Index

Constructors

constructor

new Template<C>(options?): Template<C>
Type Parameters
- C extends Client
Parameters
- options: Partial<Template<C>> = {}
Returns Template<C>
- Defined in agent/agent-deploy.ts:368

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

get asContractCode(): ContractCode
Returns ContractCode
- Defined in agent/agent-deploy.ts:391

built

get built(): Promise<this & Built>
Returns Promise<this & Built>
- Defined in agent/agent-deploy.ts:407

description

get description(): string
Returns string
- Defined in agent/agent-deploy.ts:397

uploaded

get uploaded(): Promise<this & Uploaded>
Returns Promise<this & Uploaded>
- Defined in agent/agent-deploy.ts:410

Methods

asAgent

asAgent(agent): this
Parameters
- agent: Agent
Returns this
a copy of this object with a changed agent.

Warning
overriding constructor signature is discouraged.
- Defined in agent/agent-deploy.ts:459

build

build(builder?): Promise<this & Built>
Compile the source using the selected builder.
Parameters
- builder: undefined | Builder = ...
Returns Promise<this & Built>
this
- Defined in agent/agent-deploy.ts:416

define

define(options?): this
Provide parameters for an existing instance.
Parameters
- options: Partial<Template<C>> = {}
Returns this
mutated self
- Defined in agent/agent-deploy.ts:463

instance

instance(options?): Contract<C>
Parameters
- Optional options: Partial<Contract<C>>
Returns Contract<C>
a Contract representing a specific instance of this Template.
- Defined in agent/agent-deploy.ts:444

instances

instances(contracts): Many<Contract<C>>
Get a collection of multiple contracts from this template.
Parameters
- contracts: Many<Partial<Contract<C>>>
Returns Many<Contract<C>>
task for deploying multiple contracts, resolving to their clients
- Defined in agent/agent-deploy.ts:455

upload

upload(uploader?): Promise<this & Uploaded>
Upload compiled source code to the selected chain.
Parameters
- uploader: undefined | Uploader = ...
Returns Promise<this & Uploaded>
task performing the upload
- Defined in agent/agent-deploy.ts:431

Class Template<C>

Type Parameters

C extends Client

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

C extends Client

Parameters

options: Partial<Template<C>> = {}

Returns Template<C>

Properties

Optional agent

Optional artifact

Optional builder

Optional builderId

Optional chainId

Optional client

Default

Optional codeHash

Optional codeId

Optional crate

Optional deployment

Optional dirty

Optional features

log

Optional repository

Optional revision

Optional uploadBy

Optional uploadTx

Optional uploader

Optional uploaderId

Optional workspace

Accessors

asContractCode

Returns ContractCode

built

Returns Promise<this & Built>

description

Returns string

uploaded

Returns Promise<this & Uploaded>

Methods

asAgent

Parameters

agent: Agent

Returns this

Warning

build

Parameters

builder: undefined | Builder = ...

Returns Promise<this & Built>

define

Parameters

options: Partial<Template<C>> = {}

Returns this

instance

Parameters

Optional options: Partial<Contract<C>>

Returns Contract<C>

instances

Parameters

contracts: Many<Partial<Contract<C>>>

Returns Many<Contract<C>>

upload

Parameters

uploader: undefined | Uploader = ...

Returns Promise<this & Uploaded>

Settings

Member Visibility

Theme

On This Page

`Optional` agent

`Optional` artifact

`Optional` builder

`Optional` builderId

`Optional` chainId

`Optional` client

`Optional` codeHash

`Optional` codeId

`Optional` crate

`Optional` deployment

`Optional` dirty

`Optional` features

`Optional` repository

`Optional` revision

`Optional` uploadBy

`Optional` uploadTx

`Optional` uploader

`Optional` uploaderId

`Optional` workspace

`Optional` options: Partial<Contract<C>>