Class ContractInstance

A contract that is part of a deploment.

  • needed for deployment-wide deduplication
  • generates structured label

Hierarchy (view full)

Constructors

constructor

Properties

address? chainId? codeHash? codeId? compiled? compiler? deployer? deployment? initBy? initFee? initGas? initMemo? initMsg? initSend? initTx? isTemplate label? log name? source? uploaded? uploader?

Methods

compile connect deploy isValid serialize upload

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 compiled

compiled?: CompiledCode

Optional compiler

compiler?: Compiler

Optional deployer

deployer?: string | Connection

Optional deployment

deployment?: Deployment

Deployment to which this unit belongs.

Optional initBy

initBy?: string | 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.

Optional source

source?: SourceCode

Optional uploaded

uploaded?: UploadedCode

Optional uploader

uploader?: string | Connection

Methods

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?: Compiler;
          rebuild?: boolean;
      } = {}
      • Optional compiler?: Compiler
      • Optional rebuild?: boolean

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

connect

deploy

  • deploy(__namedParameters?): Promise<ContractInstance & {
        address: string;
    }>

  • Parameters

    • __namedParameters: {
          compiler?: 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;
    }>

isValid

serialize

  • serialize(): {
        address: string;
        chainId: string;
        codeHash: string;
        codeId: string;
        initBy: string | 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 | 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 | Connection
    • initFee: unknown
    • initGas: unknown
    • initMemo: string
    • initMsg: Into<Message>
    • initSend: ICoin[]
    • initTx: string
    • label: string
    • name: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc