Class Image

A contract that is part of a deploment.

needed for deployment-wide deduplication
generates structured label

Hierarchy (view full)

ContractTemplate
- Image

Index

Constructors

Constructors

constructor

new Image(properties?): Image
Parameters
- properties: Partial<Image> = {}
Returns Image
Overrides ContractTemplate.constructor
- Defined in oci/oci.ts:114

Properties

`Protected` _available

_available: Promise<Image> = null

buildArgs

buildArgs: Record<string, string> = {}

`Optional` chainId

chainId?: string

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

`Optional` codeHash

codeHash?: string

Code hash uniquely identifying the compiled code.

`Optional` codeId

codeId?: string

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

`Optional` compiled

compiled?: CompiledCode

`Optional` compiler

compiler?: Program.Compiler

`Optional` deployer

deployer?: string | Chain.Connection

`Optional` deployment

deployment?: Deployment

Deployment to which this unit belongs.

dockerfile

dockerfile: string = null

engine

engine: Connection

inputFiles

inputFiles: string[] = []

`Readonly` isTemplate

isTemplate: true = true

log

log: Console

`Optional` name

name?: string

Name of this unit.

`Optional` source

source?: SourceCode

`Optional` uploaded

uploaded?: UploadedCode

`Optional` uploader

uploader?: string | Chain.Connection

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in oci/oci.ts:127

api

get api(): Image
Returns Image
- Defined in oci/oci.ts:131

Methods

assertExists

assertExists(): Promise<void>
Throws if inspected image does not exist locally.

Returns Promise<void>
- Defined in oci/oci.ts:174

build

build(): Promise<void>
Returns Promise<void>
- Defined in oci/oci.ts:243

compile

compile(__namedParameters?): Promise<CompiledCode & {
codeHash: string;
}>
Compile this contract, unless a valid binary is present and a rebuild is not requested.
Parameters
- __namedParameters: {
  compiler?: Program.Compiler;
  rebuild?: boolean;
  } = {}
  - Optional compiler?: Program.Compiler
  - Optional rebuild?: boolean
Returns Promise<CompiledCode & {
codeHash: string;
}>
Inherited from ContractTemplate.compile
- Defined in agent/deploy.ts:35

container

container(name?, options?, command?, entrypoint?): Container
Parameters
- Optional name: string
- Optional options: Partial<ContainerOptions>
- Optional command: ContainerCommand
- Optional entrypoint: ContainerCommand
Returns Container
- Defined in oci/oci.ts:138

contract

contract(name, parameters?): ContractInstance
Create a new instance of this contract.
Parameters
- name: string
- Optional parameters: Partial<ContractInstance>
Returns ContractInstance
Inherited from ContractTemplate.contract
- Defined in agent/deploy.ts:186

contracts

contracts(instanceParameters?): Record<string, ContractInstance>
Create multiple instances of this contract.
Parameters
- instanceParameters: Record<string, Partial<ContractInstance>> = {}
Returns Record<string, ContractInstance>
Inherited from ContractTemplate.contracts
- Defined in agent/deploy.ts:192

exists

exists(): Promise<boolean>
Check if the image exists.

Returns Promise<boolean>
- Defined in oci/oci.ts:160

getInstances

getInstances(__namedParameters?): Promise<Container[]>
Parameters
- __namedParameters: {
  all: boolean;
  } = {}
  - all: boolean
Returns Promise<Container[]>
- Defined in oci/oci.ts:295

inspect

inspect(): Promise<ImageInspectInfo>
Get info about a container.

Returns Promise<ImageInspectInfo>
- Defined in oci/oci.ts:155

pull

pull(): Promise<void>
Throws if inspected image does not exist in Docker Hub.

Returns Promise<void>
- Defined in oci/oci.ts:217

pullOrBuild

pullOrBuild(): Promise<Image>
Pull the image from the registry, or build it from a local file if not available there.

Returns Promise<Image>
- Defined in oci/oci.ts:187

remove

remove(): Promise<any>
Remove this image.

Returns Promise<any>
- Defined in oci/oci.ts:182

run

run(parameters?): Promise<Container>
Run a container from this image.
Parameters
- parameters: {
      command?: ContainerCommand;
      entrypoint?: ContainerCommand;
      name?: string;
      options?: Partial<ContainerOptions>;
      outputStream?: Writable;
  } = {}
  - Optional command?: ContainerCommand
  - Optional entrypoint?: ContainerCommand
  - Optional name?: string
  - Optional options?: Partial<ContainerOptions>
  - Optional outputStream?: Writable
Returns Promise<Container>
- Defined in oci/oci.ts:273

serialize

serialize(): {
    chainId: string;
    codeHash: string;
    codeId: string;
    name: string;
}
Returns {
    chainId: string;
    codeHash: string;
    codeId: string;
    name: string;
}
- chainId: string
- codeHash: string
- codeId: string
- name: string
Inherited from ContractTemplate.serialize
- Defined in agent/deploy.ts:177

upload

upload(__namedParameters?): Promise<UploadedCode & {
codeId: string;
}>
Upload this contract, unless a valid upload is present and a rebuild is not requested.
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;
          }>);
      };
  } = {}
Returns Promise<UploadedCode & {
codeId: string;
}>
Inherited from ContractTemplate.upload
- Defined in agent/deploy.ts:67

Class Image

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

properties: Partial<Image> = {}

Returns Image

Properties

Protected _available

buildArgs

Optional chainId

Optional codeHash

Optional codeId

Optional compiled

Optional compiler

Optional deployer

Optional deployment

dockerfile

engine

inputFiles

Readonly isTemplate

log

Optional name

Optional source

Optional uploaded

Optional uploader

Accessors

[toStringTag]

Returns string

api

Returns Image

Methods

assertExists

Returns Promise<void>

build

Returns Promise<void>

compile

Parameters

__namedParameters: { compiler?: Program.Compiler; rebuild?: boolean; } = {}

Optional compiler?: Program.Compiler

Optional rebuild?: boolean

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

container

Parameters

Optional name: string

Optional options: Partial<ContainerOptions>

Optional command: ContainerCommand

Optional entrypoint: ContainerCommand

Returns Container

contract

Parameters

name: string

Optional parameters: Partial<ContractInstance>

Returns ContractInstance

contracts

Parameters

instanceParameters: Record<string, Partial<ContractInstance>> = {}

Returns Record<string, ContractInstance>

exists

Returns Promise<boolean>

getInstances

Parameters

__namedParameters: { all: boolean; } = {}

all: boolean

Returns Promise<Container[]>

inspect

Returns Promise<ImageInspectInfo>

pull

Returns Promise<void>

pullOrBuild

Returns Promise<Image>

remove

Returns Promise<any>

run

Parameters

`Protected` _available

`Optional` chainId

`Optional` codeHash

`Optional` codeId

`Optional` compiled

`Optional` compiler

`Optional` deployer

`Optional` deployment

`Readonly` isTemplate

`Optional` name

`Optional` source

`Optional` uploaded

`Optional` uploader

__namedParameters: {
compiler?: Program.Compiler;
rebuild?: boolean;
} = {}

`Optional` compiler?: Program.Compiler

`Optional` rebuild?: boolean

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

`Optional` name: string

`Optional` options: Partial<ContainerOptions>

`Optional` command: ContainerCommand

`Optional` entrypoint: ContainerCommand

`Optional` parameters: Partial<ContractInstance>

__namedParameters: {
all: boolean;
} = {}

parameters: {
command?: ContainerCommand;
entrypoint?: ContainerCommand;
name?: string;
options?: Partial<ContainerOptions>;
outputStream?: Writable;
} = {}

`Optional` command?: ContainerCommand

`Optional` entrypoint?: ContainerCommand

`Optional` name?: string

`Optional` options?: Partial<ContainerOptions>

`Optional` outputStream?: Writable

Returns {
chainId: string;
codeHash: string;
codeId: string;
name: string;
}

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