ChainClient

A generic interface for interacting with any Cosmos chain.

export default interface ChainClient {
  signingClient?: SigningCosmWasmClient | TxGrpcClient | LCDClient;
  queryClient?: CosmWasmClient;
  signer: string;
  isConnected: boolean;

Name	Type	Description
signingClient	SigningCosmwasmClient, TxGrpcClient, LCDClient	The client used to sign any transactions broadcast to the chain. SigningCosmWamClient is used by the CosmClient, TxGrpcClient is used by the by the Injective client, and LCDClient is used by the TerraClient.
queryClient	CosmWasmClient	The client used to query the chain.
signer	string	The current signer address.
isConnected	boolean	Whether the current chain is connected.

Methods

connect

Connects to the given chain. Assigns all clients used within the chain client, if a signer is provided a signing client is assigned.

connect(
    endpoint: string,
    signer?: OfflineSigner | OfflineDirectSigner,
    options?: SigningCosmWasmClientOptions
  ): Promise<void>;

disconnect

Disconnects from the current chain completely.

disconnect(): Promise<void>;

sign

Signs a given message with the connected signer.

sign(
    messages: EncodeObject[],
    fee?: Fee,
    memo?: string
  ): ReturnType<SigningCosmWasmClient["sign"]> | TerraTx;

broadcast

Broadcasts a given transaction to the connected chain.

broadcast(
    tx: TxRaw | InjTxRaw | TerraTx
  ): ReturnType<SigningCosmWasmClient["broadcastTx"]>;

signAndBroadcast

Signs a given message before broadcasting it to the connected chain.

signAndBroadcast(
    messages: EncodeObject[],
    fee?: Fee,
    memo?: string
  ): Promise<DeliverTxResponse>;

simulateMulti

Simulates all given messages and returns a gas fee estimate.

simulateMulti(
    messages: readonly EncodeObject[],
    fee?: Fee,
    memo?: string
  ): ReturnType<SigningCosmWasmClient["simulate"]>;

simulate

Simulates a given message and returns a gas fee estimate.

simulate(
    message: EncodeObject,
    fee?: Fee,
    memo?: string
  ): ReturnType<SigningCosmWasmClient["simulate"]>;

execute

Executes a message on the specified contract.

execute(
    contractAddress: string,
    msg: Msg,
    fee?: Fee,
    memo?: string,
    funds?: readonly Coin[]
  ): Promise<ExecuteResult>;

simulateExecute

Simulates an execute message and returns a gas fee estimate.

simulateExecute(
    address: string,
    msg: Msg,
    funds: Coin[],
    fee?: Fee,
    memo?: string
  ): Promise<number | undefined>;

upload

Uploads given contract code (Uint8Array) to the chain.

upload(code: Uint8Array, fee?: Fee, memo?: string): Promise<UploadResult>;

simulateUpload

Simulates an upload message and returns a gas fee estimate.

simulateUpload(
    code: Uint8Array,
    fee?: Fee,
    memo?: string
  ): Promise<number | undefined>;

instantiate

Instantiates a contract with the given code id using the provided instantiate message.

instantiate(
    codeId: number,
    msg: Msg,
    label: string,
    fee?: Fee,
    options?: InstantiateOptions
  ): Promise<InstantiateResult>;

simulateInstantiate

Simulates an instantiation message and returns a gas fee estimate.

simulateInstantiate(
    codeId: number,
    msg: Msg,
    label: string,
    fee?: Fee,
    options?: InstantiateOptions
  ): Promise<number | undefined>;

migrate

Migrates a contract to a given code id.

migrate(
    contractAddress: string,
    codeId: number,
    msg: Msg,
    fee?: Fee,
    memo?: string
  ): Promise<MigrateResult>;

simulateMigrate

Simulates a migrate message for a given contract address, code id and migrate message and returns a gas estimate.

simulateMigrate(
    contractAddress: string,
    codeId: number,
    msg: Msg,
    fee?: Fee,
    memo?: string
  ): Promise<number | undefined>;

encodeExecuteMsg

Converts an execute message to an EncodeObject for signing or simulating.

  encodeExecuteMsg(
    address: string,
    msg: Msg,
    funds: Coin[]
  ): MsgExecuteContractEncodeObject;

encodeInstantiateMsg

Converts an instantiate message to an EncodeObject for signing or simulating.

encodeInstantiateMsg(
    codeId: number,
    msg: Msg,
    label: string
  ): MsgInstantiateContractEncodeObject;

encodeUploadMessage

Converts an upload message to an EncodeObject for signing or simulating.

encodeUploadMessage(wasmByteCode: Uint8Array): MsgStoreCodeEncodeObject;

encodeMigrateMessage

Converts a migrate message to an EncodeObject for signing or simulating.

encodeMigrateMessage(
    address: string,
    codeId: number,
    msg: Msg
  ): MsgMigrateContractEncodeObject;

encodeSendMessage

Converts a sendTokens message to an EncodeObject for signing or simulating.

encodeSendMessage(
    receivingAddress: string,
    amount: Coin[]
  ): MsgSendEncodeObject;

sendTokens

Sends tokens from the signing address to the provided receiving address.

sendTokens(
    receivingAddress: string,
    amount: readonly Coin[],
    fee?: Fee,
    memo?: string
  ): Promise<DeliverTxResponse>;