Class Container

Interface to a Docker container.

Hierarchy (view full)

Constructors

constructor

Properties

address? chainId? codeHash? codeId? command? compiled? compiler? deployer? deployment? engine entrypoint? id? image initBy? initFee? initGas? initMemo? initMsg? initSend? initTx? isTemplate label? log name? options source? uploaded? uploader?

Accessors

[toStringTag] api shortId

Methods

compile connect create deploy exec exists export inspect ip isRunning isValid kill remove serialize start upload wait waitLog

Constructors

constructor

Properties

Optional address

address?: string

Address of this contract instance. Unique per chain.

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 command

command?: ContainerCommand

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.

engine

engine: Connection

Optional entrypoint

entrypoint?: ContainerCommand

Optional id

id?: string

image

image: Image

Optional initBy

initBy?: string | Chain.Connection

Address of agent that performed the init tx.

Optional initFee

initFee?: unknown

Fee to use for init.

Optional initGas

initGas?: unknown

Contents of init message.

Optional initMemo

initMemo?: string

Instantiation memo.

Optional initMsg

initMsg?: Into<Message>

Contents of init message.

Optional initSend

initSend?: ICoin[]

Native tokens to send to the new contract.

Optional initTx

initTx?: string

ID of transaction that performed the init.

Readonly isTemplate

isTemplate: false = false

Optional label

label?: string

Full label of the instance. Unique for a given chain.

log

log: Console

Optional name

name?: string

Name of this unit.

options

options: Partial<ContainerOptions> = {}

Optional source

source?: SourceCode

Optional uploaded

uploaded?: UploadedCode

Optional uploader

uploader?: string | Chain.Connection

Accessors

[toStringTag]

api

shortId

Methods

compile

connect

create

deploy

  • deploy(__namedParameters?): Promise<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;
      } = {}

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

exec

  • exec(...command): Promise<[string, string]>

  • Executes a command in the container.

    Parameters

    • Rest ...command: string[]

    Returns Promise<[string, string]>

    [stdout, stderr]

exists

  • exists(): Promise<boolean>

  • Returns Promise<boolean>

export

  • export(repository?, tag?): Promise<any>

  • Save a container as an image.

    Parameters

    • Optional repository: string
    • tag: string = 'latest'

    Returns Promise<any>

inspect

  • inspect(): Promise<ContainerInspectInfo>

  • Get info about a container.

    Returns Promise<ContainerInspectInfo>

ip

isRunning

  • isRunning(): Promise<boolean>

  • Is this container running?

    Returns Promise<boolean>

isValid

kill

remove

serialize

  • serialize(): {
        address: string;
        chainId: string;
        codeHash: string;
        codeId: string;
        initBy: string | Chain.Connection;
        initFee: unknown;
        initGas: unknown;
        initMemo: string;
        initMsg: Into<Message>;
        initSend: ICoin[];
        initTx: string;
        label: string;
        name: string;
    }

  • Returns {
        address: string;
        chainId: string;
        codeHash: string;
        codeId: string;
        initBy: string | Chain.Connection;
        initFee: unknown;
        initGas: unknown;
        initMemo: string;
        initMsg: Into<Message>;
        initSend: ICoin[];
        initTx: string;
        label: string;
        name: string;
    }

    • address: string
    • chainId: string
    • codeHash: string
    • codeId: string
    • initBy: string | Chain.Connection
    • initFee: unknown
    • initGas: unknown
    • initMemo: string
    • initMsg: Into<Message>
    • initSend: ICoin[]
    • initTx: string
    • label: string
    • name: string

start

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

wait

  • wait(): Promise<{
        code: any;
        error: any;
    }>

  • Wait for the container to exit.

    Returns Promise<{
        code: any;
        error: any;
    }>

waitLog

  • waitLog(expected, logFilter?, thenDetach?): Promise<void>

  • Wait for the container logs to emit an expected string.

    Parameters

    • expected: string
    • Optional logFilter: ((data) => boolean)
        • (data): boolean

        • Parameters

          • data: string

          Returns boolean

    • Optional thenDetach: boolean

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc