Class Deployment

A set of interrelated contracts, deployed under the same prefix.

Extend this class in client library to define how the contracts are found.
Extend this class in deployer script to define how the contracts are deployed.

Hierarchy

Deployment

Index

Constructors

constructor

new Deployment(options?: Partial<Omit<Deployment, "contracts">> & Partial<{
contracts?: Record<string, AnyContract> | Record<string, Partial<AnyContract>>;
}>): Deployment
Parameters
- options: Partial<Omit<Deployment, "contracts">> & Partial<{
  contracts?: Record<string, AnyContract> | Record<string, Partial<AnyContract>>;
  }> = {}
Returns Deployment
- Defined in agent/agent-deploy.ts:132

Properties

`Optional` agent

agent?: Agent

Agent to use when deploying contracts.

`Optional` builder

builder?: Builder

Build implementation. Contracts can't be built from source if this is missing.

`Optional` chain

chain?: Chain

Chain on which operations are executed.

contracts

contracts: Record<string, AnyContract>

Mapping of contract names to contract instances.

log

log: Console = ...

name

name: string

Name of deployment. Used as label prefix of deployed contracts.

`Optional` repository

repository?: string = undefined

Default Git ref from which contracts will be built if needed.

`Optional` revision

revision?: string = HEAD

Default Git ref from which contracts will be built if needed.

`Optional` store

store?: DeployStore

Default state store to which updates to this deployment's state will be saved.

`Optional` uploader

uploader?: Uploader

Upload implementation. Contracts can't be uploaded if this is missing -- except by using agent.upload directly, which does not cache or log uploads.

`Optional` workspace

workspace?: string = undefined

Default Cargo workspace from which contracts will be built if needed.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in agent/agent-deploy.ts:158

devMode

get devMode(): boolean
Returns
true if the chain is a devnet or mocknet

Returns boolean
- Defined in agent/agent-deploy.ts:162

isDevnet

get isDevnet(): boolean
Returns
true if the chain is a devnet

Returns boolean
- Defined in agent/agent-deploy.ts:168

isMainnet

get isMainnet(): boolean
Returns
true if the chain is a mainnet

Returns boolean
- Defined in agent/agent-deploy.ts:164

isMocknet

get isMocknet(): boolean
Returns
true if the chain is a mocknet

Returns boolean
- Defined in agent/agent-deploy.ts:170

isTestnet

get isTestnet(): boolean
Returns
true if the chain is a testnet

Returns boolean
- Defined in agent/agent-deploy.ts:166

size

get size(): number
Returns
the number of contracts in this deployment

Returns number
- Defined in agent/agent-deploy.ts:160

snapshot

get snapshot(): {
contracts: {};
}
Returns
a snapshot of the contracts state of this deployment

Returns {
contracts: {};
}
- contracts: {}
- Defined in agent/agent-deploy.ts:172

Methods

addContract

addContract<C>(id: string, contract: Contract<C>): Contract<C>
Set the Contract corresponding to a given name, attaching it to this deployment. =

Returns
the passed Contract
Type Parameters
- C extends Client<C>
Parameters
- id: string
- contract: Contract<C>
Returns Contract<C>
- Defined in agent/agent-deploy.ts:261

buildContracts

buildContracts(contracts: (string | AnyContract)[]): Promise<Built[]>
Compile multiple contracts.
Parameters
- contracts: (string | AnyContract)[]
Returns Promise<Built[]>
- Defined in agent/agent-deploy.ts:281

contract

contract<C>(opts?: Partial<Contract<C>>): Contract<C>
Specify a contract.

Returns
a callable instance of Contract bearing the specified parameters. Calling it will deploy the contract, or retrieve it if already deployed.
Type Parameters
- C extends Client<C>
Parameters
- opts: Partial<Contract<C>> = {}
Returns Contract<C>
- Defined in agent/agent-deploy.ts:214

defineContract

defineContract<C>(opts?: Partial<Contract<C>>): Contract<C>
Define a contract without adding it to the state.

Returns
a Contract object belonging to this Deployment.
Type Parameters
- C extends Client<C>
Parameters
- opts: Partial<Contract<C>> = {}
Returns Contract<C>
- Defined in agent/agent-deploy.ts:220

deploy

deploy(): Promise<this>
Returns
Promise

Returns Promise<this>
- Defined in agent/agent-deploy.ts:265

findContract

findContract<C>(predicate?: ((meta: AnyContract) => boolean)): null | Contract<C>
Find the first contract that matches the passed filter function.

Returns
Contract or null
Type Parameters
- C extends Client<C>
Parameters
- predicate: ((meta: AnyContract) => boolean) = ...
  - - (meta: AnyContract): boolean
    - Parameters
      
      meta: AnyContract
      
      Returns boolean
Returns null | Contract<C>
- Defined in agent/agent-deploy.ts:246

findContracts

findContracts<C>(predicate?: ((meta: AnyContract) => boolean)): Contract<C>[]
Find all contracts that match the passed filter function.

Returns
Array
Type Parameters
- C extends Client<C>
Parameters
- predicate: ((meta: AnyContract) => boolean) = ...
  - - (meta: AnyContract): boolean
    - Parameters
      
      meta: AnyContract
      
      Returns boolean
Returns Contract<C>[]
- Defined in agent/agent-deploy.ts:253

getContract

getContract<C>(name: string, client?: ClientClass<C>): AnyContract
Get the Contract corresponding to a given name. If the data is not a Contract instance, converts it internally to a Contract

Returns
Contract
Type Parameters
- C extends Client<C>
Parameters
- name: string
- Optional client: ClientClass<C>
Returns AnyContract
- Defined in agent/agent-deploy.ts:234

hasContract

hasContract(name: string): boolean
Check if the deployment contains a contract with a certain name.

Returns
boolean
Parameters
- name: string
Returns boolean
- Defined in agent/agent-deploy.ts:228

save

save(store?: undefined | DeployStore): Promise<this>
Save current deployment state to deploy store.
Parameters
- store: undefined | DeployStore = ...
Returns Promise<this>
- Defined in agent/agent-deploy.ts:293

showStatus

showStatus(): this
Print the status of this deployment.

Returns this
- Defined in agent/agent-deploy.ts:199

template

template<C>(opts?: Partial<Template<C>>): Template<C>
Specify a contract template.

Returns
a callable instance of Template bearing the specified parameters. Calling it will build and upload the template.
Type Parameters
- C extends Client<C>
Parameters
- opts: Partial<Template<C>> = {}
Returns Template<C>
- Defined in agent/agent-deploy.ts:206

uploadContracts

uploadContracts(contracts: AnyContract[]): Promise<(null | Uploaded)[]>
Upload multiple contracts.
Parameters
- contracts: AnyContract[]
Returns Promise<(null | Uploaded)[]>
- Defined in agent/agent-deploy.ts:287

Class Deployment

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Omit<Deployment, "contracts">> & Partial<{ contracts?: Record<string, AnyContract> | Record<string, Partial<AnyContract>>; }> = {}

Returns Deployment

Properties

Optional agent

Optional builder

Optional chain

contracts

log

name

Optional repository

Optional revision

Optional store

Optional uploader

Optional workspace

Accessors

[toStringTag]

Returns string

devMode

Returns

Returns boolean

isDevnet

Returns

Returns boolean

isMainnet

Returns

Returns boolean

isMocknet

Returns

Returns boolean

isTestnet

Returns

Returns boolean

size

Returns

Returns number

snapshot

Returns

Returns { contracts: {}; }

contracts: {}

Methods

addContract

Returns

Type Parameters

C extends Client<C>

Parameters

id: string

contract: Contract<C>

Returns Contract<C>

buildContracts

Parameters

contracts: (string | AnyContract)[]

Returns Promise<Built[]>

contract

Returns

Type Parameters

C extends Client<C>

Parameters

opts: Partial<Contract<C>> = {}

Returns Contract<C>

defineContract

Returns

Type Parameters

C extends Client<C>

Parameters

opts: Partial<Contract<C>> = {}

Returns Contract<C>

deploy

Returns

Returns Promise<this>

findContract

options: Partial<Omit<Deployment, "contracts">> & Partial<{
contracts?: Record<string, AnyContract> | Record<string, Partial<AnyContract>>;
}> = {}

`Optional` agent

`Optional` builder

`Optional` chain

`Optional` repository

`Optional` revision

`Optional` store

`Optional` uploader

`Optional` workspace

Returns {
contracts: {};
}

`Optional` client: ClientClass<C>