Class AgentAbstract

constructor

• new Agent(options?): Agent

• Parameters

  • options: Partial<Agent> = {}

  Returns Agent

Bundle

Optional address

Optional chain

Optional fees

log

Optional mnemonic

Optional name

Static Bundle

[toStringTag]

• get [toStringTag](): string

• Returns string

balance

• get balance(): Promise<string>

• This agent's balance in the chain's native token.

  Returns Promise<string>

defaultDenom

• get defaultDenom(): string

• The default denomination in which the agent operates.

  Returns string

height

• get height(): Promise<number>

• The chain's current block height.

  Returns Promise<number>

nextBlock

• get nextBlock(): Promise<number>

• Wait until the block height increments.

  Returns Promise<number>

ready

• get ready(): Promise<this>

• Complete the asynchronous initialization of this Agent.

  Returns Promise<this>

bundle

• bundle<B>(cb?): B

• Execute a transaction bundle.

  Type Parameters

  • B extends Bundle

  Parameters

  • Optional cb: BundleCallback<B>

  Returns B

  Bundle if called with no arguments

checkHash

• checkHash(address, codeHash?): Promise<string>

• Check the code hash of a contract at an address against an expected value.

  Parameters

  • address: string

  • Optional codeHash: string

  Returns Promise<string>

execute

• execute(contract, msg, opts?): Promise<unknown>

• Call a transaction method on a smart contract.

  Parameters

  • contract: Partial<Client>

  • msg: Message

  • Optional opts: ExecOpts

  Returns Promise<unknown>

getBalance

• getBalance(denom?, address?): Promise<string>

• Get the balance of this or another address.

  Parameters

  • denom: string = ...

  • address: undefined | string = ...

  Returns Promise<string>

getClient

• getClient<C>($C, address?, codeHash?, ...args): C

• Get a client instance for talking to a specific smart contract as this executor.

  Type Parameters

  • C extends Client

  Parameters

  • $C: ClientClass<C>

  • Optional address: string

  • Optional codeHash: string

  • Rest ...args: unknown[]

  Returns C

getCodeId

• getCodeId(address): Promise<string>

• Get the code ID of a contract.

  Parameters

  • address: string

  Returns Promise<string>

getHash

• getHash(address): Promise<string>

• Get the code hash of a contract or template.

  Parameters

  • address: string | number

  Returns Promise<string>

getLabel

• getLabel(address): Promise<string>

• Get the label of a contract.

  Parameters

  • address: string

  Returns Promise<string>

getUploader

• getUploader<U>($U, options?): U

• Get an uploader instance which performs code uploads and optionally caches them.

  Type Parameters

  • U extends Uploader

  Parameters

  • $U: UploaderClass<U>

  • Optional options: Partial<U>

  Returns U

instantiate

• instantiate<C>(instance): PromiseLike<Instantiated>

• Create a new smart contract from a code id, label and init message.

  Type Parameters

  • C extends Client

  Parameters

  • instance: Contract<C>

  Returns PromiseLike<Instantiated>

  AnyContract with no address populated yet. This will be populated after executing the bundle.

  Example

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

instantiateMany

• instantiateMany<C>(instances): Promise<C>

• Create multiple smart contracts from a Template (providing code id) and a list or map of label/initmsg pairs. Uses this agent's Bundle class to instantiate them in a single transaction.

  Type Parameters

  • C extends Many<AnyContract>

  Parameters

  • instances: C

  Returns Promise<C>

  either an Array or a Record<string, AnyContract>, depending on what is passed as inputs.

  Example

  await agent.instantiateMany(template.instances({
      One: { label, initMsg },
      Two: { label, initMsg },
    }))
    await agent.instantiateMany({
      One: template1.instance({ label, initMsg }),
      Two: template2.instance({ label, initMsg }),
    }))
  Copy

query

• query<R>(contract, msg): Promise<R>

• Query a contract on the chain.

  Type Parameters

  • R

  Parameters

  • contract: Client

  • msg: Message

  Returns Promise<R>

send

• send(to, amounts, opts?): Promise<unknown>

• Send native tokens to 1 recipient.

  Parameters

  • to: string

  • amounts: ICoin[]

  • Optional opts: ExecOpts

  Returns Promise<unknown>

sendMany

• sendMany(outputs, opts?): Promise<unknown>

• Send native tokens to multiple recipients.

  Parameters

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

  • Optional opts: ExecOpts

  Returns Promise<unknown>

upload

• upload(data, meta?): Promise<Uploaded>

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

  Parameters

  • data: Uint8Array

  • Optional meta: Partial<Uploadable>

  Returns Promise<Uploaded>