Class Deployment

A collection of contracts.

Hierarchy

Map<Name, DeploymentUnit>
- Deployment

Index

Constructors

constructor

new Deployment(properties?): Deployment
Parameters
- properties: Partial<Deployment> = {}
Returns Deployment
Overrides Map<Name, DeploymentUnit>.constructor
- Defined in agent/deploy.ts:302

Properties

`Readonly` [toStringTag]

[toStringTag]: string

log

log: Core.Console = ...

name

name: string = ...

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[string, DeploymentUnit]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, DeploymentUnit]>
Inherited from Map.[iterator]
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

addContract

addContract(...args): Deployment
Parameters
- Rest ...args: [name: string, properties?: ({
  language: "rust";
  } & Partial<RustSourceCode> | {
  language?: undefined;
  } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode> & Partial<ContractInstance>]
Returns Deployment
- Defined in agent/deploy.ts:373

addContracts

addContracts(...args): Deployment
Parameters
- Rest ...args: [name: string, properties?: ({
  language: "rust";
  } & Partial<RustSourceCode> | {
  language?: undefined;
  } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode>]
Returns Deployment
- Defined in agent/deploy.ts:381

build

build(__namedParameters?): Promise<Record<string, CompiledCode & {
codeHash: string;
}>>
Parameters
- __namedParameters: {
      compiler?: Program.Compiler;
      rebuild?: boolean;
  } & {
      units?: string[];
  } = {}
Returns Promise<Record<string, CompiledCode & {
codeHash: string;
}>>
- Defined in agent/deploy.ts:389

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

contract

contract(name, properties?): ContractInstance
Define a contract that will be automatically compiled, uploaded, and instantiated as part of this deployment.
Parameters
- name: string
- Optional properties: ({
  language: "rust";
  } & Partial<RustSourceCode> | {
  language?: undefined;
  } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode> & Partial<ContractInstance>
Returns ContractInstance
- Defined in agent/deploy.ts:351

delete

delete(key): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from Map.delete
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:25

deploy

deploy(__namedParameters?): Promise<Record<string, ContractInstance & {
address: string;
}>>
Parameters
- __namedParameters: {
      compiler?: Program.Compiler;
      rebuild?: boolean;
  } & {
      reupload?: boolean;
      uploadFee?: ICoin[] | "auto";
      uploadMemo?: string;
      uploadStore?: UploadStore;
  } & {
      reupload?: boolean;
      uploader?: string | {
          upload: ((code, options?) => Promise<UploadedCode & {
              chainId: string;
              codeId: string;
          }>);
      };
  } & Partial<ContractInstance> & {
      deployer?: string | {
          instantiate: ((contract, options) => Promise<ContractInstance & {
              address: string;
          }>);
      };
      redeploy?: boolean;
  } & {
      deployStore?: DeployStore;
      units?: string[];
  } = {}
Returns Promise<Record<string, ContractInstance & {
address: string;
}>>
- Defined in agent/deploy.ts:443

entries

entries(): IterableIterator<[string, DeploymentUnit]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, DeploymentUnit]>
Inherited from Map.entries
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: DeploymentUnit
      key: string
      map: Map<string, DeploymentUnit>
      Returns void
- Optional thisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(key): DeploymentUnit
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
- key: string
Returns DeploymentUnit
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from Map.get
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:34

has

has(key): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from Map.has
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from Map.keys
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

serialize

serialize(): {
    name: string;
    units: {
        [k: string]: T;
    };
}
Returns {
    name: string;
    units: {
        [k: string]: T;
    };
}
- name: string
- units: {
  [k: string]: T;
  }
  - [k: string]: T
- Defined in agent/deploy.ts:309

set

set(name, unit): this
Parameters
- name: string
- unit: DeploymentUnit
Returns this
Overrides Map.set
- Defined in agent/deploy.ts:317

template

template(name, properties?): ContractTemplate
Define a template, representing code that can be compiled and uploaded, but will not be automatically instantiated. This can then be used to define multiple instances of the same code.
Parameters
- name: string
- Optional properties: ({
  language: "rust";
  } & Partial<RustSourceCode> | {
  language?: undefined;
  } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode>
Returns ContractTemplate
- Defined in agent/deploy.ts:328

upload

upload(__namedParameters?): Promise<Record<string, UploadedCode & {
codeId: string;
}>>
Parameters
- __namedParameters: {
      compiler?: Program.Compiler;
      rebuild?: boolean;
  } & {
      reupload?: boolean;
      uploadFee?: ICoin[] | "auto";
      uploadMemo?: string;
      uploadStore?: UploadStore;
  } & {
      reupload?: boolean;
      uploader?: string | {
          upload: ((code, options?) => Promise<UploadedCode & {
              chainId: string;
              codeId: string;
          }>);
      };
  } & {
      units?: string[];
      uploadStore?: UploadStore;
  } = {}
Returns Promise<Record<string, UploadedCode & {
codeId: string;
}>>
- Defined in agent/deploy.ts:426

values

values(): IterableIterator<DeploymentUnit>
Returns an iterable of values in the map

Returns IterableIterator<DeploymentUnit>
Inherited from Map.values
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

`Static` fromSnapshot

fromSnapshot(__namedParameters): Deployment
Parameters
- __namedParameters: Partial<{
      name: string;
      units: {
          [k: string]: T;
      };
  }>
Returns Deployment
- Defined in agent/deploy.ts:294

Class Deployment

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

properties: Partial<Deployment> = {}

Returns Deployment

Properties

Readonly [toStringTag]

log

name

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[string, DeploymentUnit]>

addContract

Parameters

Rest ...args: [name: string, properties?: ({ language: "rust"; } & Partial<RustSourceCode> | { language?: undefined; } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode> & Partial<ContractInstance>]

Returns Deployment

addContracts

Parameters

Rest ...args: [name: string, properties?: ({ language: "rust"; } & Partial<RustSourceCode> | { language?: undefined; } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode>]

Returns Deployment

build

Parameters

__namedParameters: { compiler?: Program.Compiler; rebuild?: boolean; } & { units?: string[]; } = {}

Returns Promise<Record<string, CompiledCode & { codeHash: string; }>>

clear

Returns void

contract

Parameters

name: string

Optional properties: ({ language: "rust"; } & Partial<RustSourceCode> | { language?: undefined; } & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode> & Partial<ContractInstance>

Returns ContractInstance

delete

Parameters

key: string

Returns boolean

deploy

Parameters

Returns Promise<Record<string, ContractInstance & { address: string; }>>

entries

Returns IterableIterator<[string, DeploymentUnit]>

forEach

Parameters

callbackfn: ((value, key, map) => void)

Parameters

value: DeploymentUnit

key: string

map: Map<string, DeploymentUnit>

Returns void

Optional thisArg: any

Returns void

get

Parameters

key: string

Returns DeploymentUnit

has

Parameters

key: string

Returns boolean

keys

Returns IterableIterator<string>

serialize

Returns { name: string; units: { [k: string]: T; }; }

name: string

units: { [k: string]: T; }

[k: string]: T

set

Parameters

name: string

unit: DeploymentUnit

Returns this

template

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Rest` ...args: [name: string, properties?: ({
language: "rust";
} & Partial<RustSourceCode> | {
language?: undefined;
} & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode> & Partial<ContractInstance>]

`Rest` ...args: [name: string, properties?: ({
language: "rust";
} & Partial<RustSourceCode> | {
language?: undefined;
} & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode>]

__namedParameters: {
compiler?: Program.Compiler;
rebuild?: boolean;
} & {
units?: string[];
} = {}

Returns Promise<Record<string, CompiledCode & {
codeHash: string;
}>>

`Optional` properties: ({
language: "rust";
} & Partial<RustSourceCode> | {
language?: undefined;
} & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode> & Partial<ContractInstance>

Returns Promise<Record<string, ContractInstance & {
address: string;
}>>

`Optional` thisArg: any

Returns {
name: string;
units: {
[k: string]: T;
};
}

units: {
[k: string]: T;
}

`Optional` properties: ({
language: "rust";
} & Partial<RustSourceCode> | {
language?: undefined;
} & Partial<SourceCode>) & Partial<CompiledCode> & Partial<UploadedCode>

Returns Promise<Record<string, UploadedCode & {
codeId: string;
}>>

`Static` fromSnapshot

__namedParameters: Partial<{
name: string;
units: {
[k: string]: T;
};
}>