Class Deployment

constructor

• new Deployment(properties?): Deployment

• Parameters

  • properties: Partial<Deployment> = {}

  Returns Deployment

log

name

addContract

• addContract(...args): Deployment

• Parameters

  • Rest ...args: [name: string, properties?: {
        [toStringTag]: string;
        address?: string;
        canCompile: boolean;
        canCompileInfo: string;
        canFetch: boolean;
        canFetchInfo: string;
        canInstantiate: boolean;
        canInstantiateInfo: string;
        canUpload: boolean;
        canUploadInfo: string;
        chainId?: string;
        codeData?: Uint8Array;
        codeHash?: string;
        codeId?: string;
        codePath?: string | URL;
        compiled?: CompiledCode;
        compiler?: Compiler;
        deployer?: string | Connection;
        deployment?: Deployment;
        initBy?: string | Connection;
        initFee?: unknown;
        initGas?: unknown;
        initMemo?: string;
        initMsg?: Into<Message>;
        initSend?: ICoin[];
        initTx?: string;
        isTemplate?: false;
        label?: string;
        language?: "rust";
        log?: Console;
        name?: string;
        source?: SourceCode;
        sourceDirty?: boolean;
        sourceOrigin?: string | URL;
        sourcePath?: string;
        sourceRef?: string;
        uploadBy?: string | Connection;
        uploadGas?: string | number;
        uploadTx?: string;
        uploaded?: UploadedCode;
        uploader?: string | Connection;
        compile?(__namedParameters?) => Promise<CompiledCode & {
            codeHash: string;
        }>;
        computeHash?() => Promise<CompiledCode & {
            codeHash: string;
        }>;
        connect?(agent?) => Contract;
        deploy?(__namedParameters?) => Promise<ContractInstance & {
            address: string;
        }>;
        fetch?() => Promise<Uint8Array>;
        isValid?() => this is ContractInstance & {
            address: string;
        };
        serialize?() => {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        };
        upload?(__namedParameters?) => Promise<UploadedCode & {
            codeId: string;
        }>;
    }]

  Returns Deployment

addContracts

• addContracts(...args): Deployment

• Parameters

  • Rest ...args: [name: string, properties?: {
        [toStringTag]: string;
        canCompile: boolean;
        canCompileInfo: string;
        canFetch: boolean;
        canFetchInfo: string;
        canInstantiate: boolean;
        canInstantiateInfo: string;
        canUpload: boolean;
        canUploadInfo: string;
        chainId?: string;
        codeData?: Uint8Array;
        codeHash?: string;
        codeId?: string;
        codePath?: string | URL;
        language?: "rust";
        log?: Console;
        sourceDirty?: boolean;
        sourceOrigin?: string | URL;
        sourcePath?: string;
        sourceRef?: string;
        uploadBy?: string | Connection;
        uploadGas?: string | number;
        uploadTx?: string;
        computeHash?() => Promise<CompiledCode & {
            codeHash: string;
        }>;
        fetch?() => Promise<Uint8Array>;
        serialize?() => {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        };
    }]

  Returns Deployment

build

• build(__namedParameters?): Promise<Record<string, CompiledCode & {
      codeHash: string;
  }>>

• Parameters

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

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

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: {
        [toStringTag]: string;
        address?: string;
        canCompile: boolean;
        canCompileInfo: string;
        canFetch: boolean;
        canFetchInfo: string;
        canInstantiate: boolean;
        canInstantiateInfo: string;
        canUpload: boolean;
        canUploadInfo: string;
        chainId?: string;
        codeData?: Uint8Array;
        codeHash?: string;
        codeId?: string;
        codePath?: string | URL;
        compiled?: CompiledCode;
        compiler?: Compiler;
        deployer?: string | Connection;
        deployment?: Deployment;
        initBy?: string | Connection;
        initFee?: unknown;
        initGas?: unknown;
        initMemo?: string;
        initMsg?: Into<Message>;
        initSend?: ICoin[];
        initTx?: string;
        isTemplate?: false;
        label?: string;
        language?: "rust";
        log?: Console;
        name?: string;
        source?: SourceCode;
        sourceDirty?: boolean;
        sourceOrigin?: string | URL;
        sourcePath?: string;
        sourceRef?: string;
        uploadBy?: string | Connection;
        uploadGas?: string | number;
        uploadTx?: string;
        uploaded?: UploadedCode;
        uploader?: string | Connection;
        compile?(__namedParameters?) => Promise<CompiledCode & {
            codeHash: string;
        }>;
        computeHash?() => Promise<CompiledCode & {
            codeHash: string;
        }>;
        connect?(agent?) => Contract;
        deploy?(__namedParameters?) => Promise<ContractInstance & {
            address: string;
        }>;
        fetch?() => Promise<Uint8Array>;
        isValid?() => this is ContractInstance & {
            address: string;
        };
        serialize?() => {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        };
        upload?(__namedParameters?) => Promise<UploadedCode & {
            codeId: string;
        }>;
    }

    • [toStringTag]: string

    • Optional address?: string

      Address of this contract instance. Unique per chain.

    • canCompile: boolean

    • canCompileInfo: string

    • canFetch: boolean

    • canFetchInfo: string

    • canInstantiate: boolean

    • canInstantiateInfo: string

    • canUpload: boolean

    • canUploadInfo: string

    • Optional chainId?: string

      ID of chain on which this contract is uploaded.

    • Optional codeData?: Uint8Array

      The compiled code.

    • Optional codeHash?: string

      Code hash uniquely identifying the compiled code.

    • Optional codeId?: string

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

    • Optional codePath?: string | URL

      Location of the compiled code.

    • Optional compiled?: CompiledCode

    • Optional compiler?: Compiler

    • Optional deployer?: string | Connection

    • Optional deployment?: Deployment

      Deployment to which this unit belongs.

    • Optional initBy?: string | Connection

      Address of agent that performed the init tx.

    • Optional initFee?: unknown

      Fee to use for init.

    • Optional initGas?: unknown

      Contents of init message.

    • Optional initMemo?: string

      Instantiation memo.

    • Optional initMsg?: Into<Message>

      Contents of init message.

    • Optional initSend?: ICoin[]

      Native tokens to send to the new contract.

    • Optional initTx?: string

      ID of transaction that performed the init.

    • Optional Readonly isTemplate?: false

    • Optional label?: string

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

    • Optional language?: "rust"

    • Optional log?: Console

    • Optional name?: string

      Name of this unit.

    • Optional source?: SourceCode

    • Optional sourceDirty?: boolean

      Whether the code contains uncommitted changes.

    • Optional sourceOrigin?: string | URL

      URL pointing to Git upstream containing the canonical source code.

    • Optional sourcePath?: string

      Path to local checkout of the source code (with .git directory if sourceRef is set).

    • Optional sourceRef?: string

      Pointer to the source commit.

    • Optional uploadBy?: string | Connection

      address of agent that performed the upload.

    • Optional uploadGas?: string | number

      address of agent that performed the upload.

    • Optional uploadTx?: string

      TXID of transaction that performed the upload.

    • Optional uploaded?: UploadedCode

    • Optional uploader?: string | Connection

    • compile?:function

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

    • computeHash?:function

      • computeHash(): Promise<CompiledCode & {
            codeHash: string;
        }>

      • Compute the code hash if missing; throw if different.

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

    • connect?:function

      • connect(agent?): Contract

      • Returns a client to this contract instance.

        Parameters

        • Optional agent: Connection

        Returns Contract

    • deploy?:function

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

    • fetch?:function

      • fetch(): Promise<Uint8Array>

      • Returns Promise<Uint8Array>

    • isValid?:function

      • isValid(): this is ContractInstance & {
            address: string;
        }

      • Returns this is ContractInstance & {
            address: string;
        }

    • serialize?:function

      • serialize(): {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        }

      • Returns {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        }

        • [key: string]: unknown

        • Optional sourceDirty?: boolean

        • Optional sourceOrigin?: string

        • Optional sourcePath?: string

        • Optional sourceRef?: string

    • upload?:function

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

  Returns ContractInstance

deploy

• deploy(__namedParameters?): Promise<Record<string, 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;
    } & {
        deployStore?: DeployStore;
        units?: string[];
    } = {}

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

serialize

• serialize(): {
      name: string;
      units: {
          [k: string]: T;
      };
  }

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

  • name: string

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

    • [k: string]: T

set

• set(name, unit): Deployment

• Parameters

  • name: string

  • unit: DeploymentUnit

  Returns Deployment

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: {
        [toStringTag]: string;
        canCompile: boolean;
        canCompileInfo: string;
        canFetch: boolean;
        canFetchInfo: string;
        canInstantiate: boolean;
        canInstantiateInfo: string;
        canUpload: boolean;
        canUploadInfo: string;
        chainId?: string;
        codeData?: Uint8Array;
        codeHash?: string;
        codeId?: string;
        codePath?: string | URL;
        language?: "rust";
        log?: Console;
        sourceDirty?: boolean;
        sourceOrigin?: string | URL;
        sourcePath?: string;
        sourceRef?: string;
        uploadBy?: string | Connection;
        uploadGas?: string | number;
        uploadTx?: string;
        computeHash?() => Promise<CompiledCode & {
            codeHash: string;
        }>;
        fetch?() => Promise<Uint8Array>;
        serialize?() => {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        };
    }

    • [toStringTag]: string

    • canCompile: boolean

    • canCompileInfo: string

    • canFetch: boolean

    • canFetchInfo: string

    • canInstantiate: boolean

    • canInstantiateInfo: string

    • canUpload: boolean

    • canUploadInfo: string

    • Optional chainId?: string

      ID of chain on which this contract is uploaded.

    • Optional codeData?: Uint8Array

      The compiled code.

    • Optional codeHash?: string

      Code hash uniquely identifying the compiled code.

    • Optional codeId?: string

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

    • Optional codePath?: string | URL

      Location of the compiled code.

    • Optional language?: "rust"

    • Optional log?: Console

    • Optional sourceDirty?: boolean

      Whether the code contains uncommitted changes.

    • Optional sourceOrigin?: string | URL

      URL pointing to Git upstream containing the canonical source code.

    • Optional sourcePath?: string

      Path to local checkout of the source code (with .git directory if sourceRef is set).

    • Optional sourceRef?: string

      Pointer to the source commit.

    • Optional uploadBy?: string | Connection

      address of agent that performed the upload.

    • Optional uploadGas?: string | number

      address of agent that performed the upload.

    • Optional uploadTx?: string

      TXID of transaction that performed the upload.

    • computeHash?:function

      • computeHash(): Promise<CompiledCode & {
            codeHash: string;
        }>

      • Compute the code hash if missing; throw if different.

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

    • fetch?:function

      • fetch(): Promise<Uint8Array>

      • Returns Promise<Uint8Array>

    • serialize?:function

      • serialize(): {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        }

      • Returns {
            sourceDirty?: boolean;
            sourceOrigin?: string;
            sourcePath?: string;
            sourceRef?: string;
            [key: string]: unknown;
        }

        • [key: string]: unknown

        • Optional sourceDirty?: boolean

        • Optional sourceOrigin?: string

        • Optional sourcePath?: string

        • Optional sourceRef?: string

  Returns ContractTemplate

upload

• upload(__namedParameters?): Promise<Record<string, UploadedCode & {
      codeId: 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;
            }>);
        };
    } & {
        units?: string[];
        uploadStore?: UploadStore;
    } = {}

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

Static fromSnapshot

• fromSnapshot(__namedParameters): Deployment

• Parameters

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

  Returns Deployment