Class ConnectionAbstract

constructor

• new Connection(properties?): Connection

• Parameters

  • properties: Partial<Connection> = {}

  Returns Connection

blockInterval

Optional fees

Optional identity

Static gasToken

[toStringTag]

• get [toStringTag](): string

• Returns string

address

• get address(): string

• Returns string

balance

• get balance(): Promise<unknown>

• Returns Promise<unknown>

defaultDenom

• get defaultDenom(): string

• Returns string

height

• get height(): Promise<number>

• Returns Promise<number>

nextBlock

• get nextBlock(): Promise<number>

• Wait for the block height to increment.

  Returns Promise<number>

batch

• batch(): Batch<Connection>

• Construct a transaction batch.

  Returns Batch<Connection>

Abstract doExecute

• doExecute(contract, message, options): Promise<unknown>

• Parameters

  • contract: {
        address: string;
    }

    • address: string

  • message: Message

  • options: {
        execFee?: IFee;
        execMemo?: string;
        execSend?: ICoin[];
    }

    • Optional execFee?: IFee

    • Optional execMemo?: string

    • Optional execSend?: ICoin[]

  Returns Promise<unknown>

Abstract doGetBalance

• doGetBalance(token?, address?): Promise<string | number | bigint>

• Parameters

  • Optional token: string

  • Optional address: string

  Returns Promise<string | number | bigint>

Abstract doGetBlockInfo

• doGetBlockInfo(): Promise<unknown>

• Returns Promise<unknown>

Abstract doGetCodeHashOfAddress

• doGetCodeHashOfAddress(contract): Promise<string>

• Parameters

  • contract: string

  Returns Promise<string>

Abstract doGetCodeHashOfCodeId

• doGetCodeHashOfCodeId(codeId): Promise<string>

• Parameters

  • codeId: string

  Returns Promise<string>

Abstract doGetCodeId

• doGetCodeId(contract): Promise<string>

• Parameters

  • contract: string

  Returns Promise<string>

Abstract doGetCodes

• doGetCodes(): Promise<Record<string, UploadedCode>>

• Returns Promise<Record<string, UploadedCode>>

Abstract doGetContractsByCodeId

• doGetContractsByCodeId(id): Promise<Iterable<{
      address: string;
  }>>

• Parameters

  • id: string

  Returns Promise<Iterable<{
      address: string;
  }>>

Abstract doGetHeight

• doGetHeight(): Promise<number>

• Returns Promise<number>

Abstract doInstantiate

• doInstantiate(codeId, options): Promise<Partial<ContractInstance>>

• Parameters

  • codeId: string

  • options: Partial<ContractInstance>

  Returns Promise<Partial<ContractInstance>>

Abstract doQuery

• doQuery(contract, message): Promise<unknown>

• Parameters

  • contract: {
        address: string;
    }

    • address: string

  • message: Message

  Returns Promise<unknown>

Abstract doSend

• doSend(recipient, amounts, options?): Promise<unknown>

• Parameters

  • recipient: string

  • amounts: ICoin[]

  • Optional options: {
        sendFee?: IFee;
        sendMemo?: string;
    }

    • Optional sendFee?: IFee

    • Optional sendMemo?: string

  Returns Promise<unknown>

Abstract doSendMany

• doSendMany(outputs, options?): Promise<unknown>

• Parameters

  • outputs: [string, ICoin[]][]

  • Optional options: unknown

  Returns Promise<unknown>

Abstract doUpload

• doUpload(data, options): Promise<Partial<UploadedCode>>

• Parameters

  • data: Uint8Array

  • options: {
        reupload?: boolean;
        uploadFee?: ICoin[] | "auto";
        uploadMemo?: string;
        uploadStore?: UploadStore;
    }

    • Optional reupload?: boolean

    • Optional uploadFee?: ICoin[] | "auto"

    • Optional uploadMemo?: string

    • Optional uploadStore?: UploadStore

  Returns Promise<Partial<UploadedCode>>

execute

• execute(contract, message, options?): Promise<unknown>

• Call a given program's transaction method.

  Parameters

  • contract: string | Partial<ContractInstance>

  • message: Message

  • Optional options: {
        execFee?: IFee;
        execMemo?: string;
        execSend?: ICoin[];
    }

    • Optional execFee?: IFee

    • Optional execMemo?: string

    • Optional execSend?: ICoin[]

  Returns Promise<unknown>

getBalanceIn

• getBalanceIn(token, address?): Promise<unknown>

• Get the balance in a given native token, of either this connection's identity's address, or of another given address.

  Parameters

  • token: string

  • Optional address: string | {
        address: string;
    }

  Returns Promise<unknown>

getBalanceOf

• getBalanceOf(address, token?): Promise<unknown>

• Get the balance in a native token of a given address, either in this connection's gas token, or in another given token.

  Parameters

  • address: string | {
        address: string;
    }

  • Optional token: string

  Returns Promise<unknown>

getCodeHashOfAddress

• getCodeHashOfAddress(contract): Promise<string>

• Get the code hash of a given address.

  Parameters

  • contract: string | {
        address: string;
    }

  Returns Promise<string>

getCodeHashOfCodeId

• getCodeHashOfCodeId(contract): Promise<string>

• Get the code hash of a given code id.

  Parameters

  • contract: string | {
        codeId: string;
    }

  Returns Promise<string>

getCodeId

• getCodeId(contract): Promise<string>

• Get the code id of a given address.

  Parameters

  • contract: string | {
        address: string;
    }

  Returns Promise<string>

getCodes

• getCodes(): Promise<Record<string, UploadedCode>>

• Returns Promise<Record<string, UploadedCode>>

getContract

• getContract(options): Contract

• Get a client handle for a specific smart contract, authenticated as as this agent.

  Parameters

  • options: string | {
        address: string;
    }

  Returns Contract

getContractsByCodeId

• getContractsByCodeId(id): Promise<Record<string, Contract>>

• Get client handles for all contracts that match a code ID

  Parameters

  • id: string

  Returns Promise<Record<string, Contract>>
• getContractsByCodeId<C>(id, $C): Promise<Record<string, InstanceType<C>>>

• Type Parameters

  • C extends typeof Contract

  Parameters

  • id: string

  • $C: C

  Returns Promise<Record<string, InstanceType<C>>>

getContractsByCodeIds

• getContractsByCodeIds(ids): Promise<Record<string, Record<string, Contract>>>

• Get client handles for all contracts that match multiple code IDs

  Parameters

  • ids: Iterable<string>

  Returns Promise<Record<string, Record<string, Contract>>>
• getContractsByCodeIds<C>(ids, $C?): Promise<Record<string, Record<string, InstanceType<C>>>>

• Type Parameters

  • C extends typeof Contract

  Parameters

  • ids: Iterable<string>

  • Optional $C: C

  Returns Promise<Record<string, Record<string, InstanceType<C>>>>

• getContractsByCodeIds<C>(ids): Promise<Record<string, Record<string, InstanceType<C>>>>

• Type Parameters

  • C extends typeof Contract

  Parameters

  • ids: Record<string, C>

  Returns Promise<Record<string, Record<string, InstanceType<C>>>>

instantiate

• instantiate(contract, options): Promise<ContractInstance & {
      address: string;
  }>

• Instantiate a new program from a code id, label and init message.

  Parameters

  • contract: string | Partial<UploadedCode>

  • options: Partial<ContractInstance>

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

  Deploy.ContractInstance with no address populated yet. This will be populated after executing the batch.

  Example

  await agent.instantiate(template.define({ label, initMsg })
  Copy

query

• query<Q>(contract, message): Promise<Q>

• Query a contract.

  Type Parameters

  • Q

  Parameters

  • contract: string | {
        address: string;
    }

  • message: Message

  Returns Promise<Q>

send

• send(recipient, amounts, options?): Promise<unknown>

• Send native tokens to 1 recipient.

  Parameters

  • recipient: string | {
        address?: string;
    }

  • amounts: (ICoin | Amount)[]

  • Optional options: {
        sendFee?: IFee;
        sendMemo?: string;
    }

    • Optional sendFee?: IFee

    • Optional sendMemo?: string

  Returns Promise<unknown>

upload

• upload(code, options?): Promise<UploadedCode & {
      chainId: string;
      codeId: string;
  }>

• Upload a contract's code, generating a new code id/hash pair.

  Parameters

  • code: string | Uint8Array | URL | Partial<CompiledCode>

  • options: {
        reupload?: boolean;
        uploadFee?: ICoin[] | "auto";
        uploadMemo?: string;
        uploadStore?: UploadStore;
    } = {}

    • Optional reupload?: boolean

    • Optional uploadFee?: ICoin[] | "auto"

    • Optional uploadMemo?: string

    • Optional uploadStore?: UploadStore

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

Static gas

• gas(amount): Amount

• Native token of chain.

  Parameters

  • amount: string | number

  Returns Amount