Class Agent

Generic agent for CosmWasm-enabled chains.

Hierarchy

Agent
- Agent
  - OKP4.Agent

Index

Constructors

constructor

new Agent(options?): Base.Agent
Parameters
- options: Partial<Base.Agent> = {}
Returns Base.Agent
Overrides Agent.constructor
- Defined in connect/cw/cw-base.ts:50

Properties

Bundle

Bundle: BundleClass<Bundle> = ...

The Bundle subclass to use.

`Optional` address

address?: string

The address from which transactions are signed and sent.

`Optional` api

api?: SigningCosmWasmClient

Signing API handle.

`Optional` bech32Prefix

bech32Prefix?: string

The bech32 prefix for the account's address

`Optional` chain

chain?: Chain

The chain on which this agent operates.

`Optional` coinType

coinType?: number

The coin type in the HD derivation path

`Optional` fees

fees?: AgentFees

Default fee maximums for send, upload, init, and execute.

`Optional` hdAccountIndex

hdAccountIndex?: number

The account index in the HD derivation path

log

log: Console = ...

`Optional` mnemonic

mnemonic?: string

The wallet's mnemonic.

`Optional` name

name?: string

The friendly name of the agent.

`Optional` publicKey

publicKey?: Uint8Array

Public key corresponding to private key derived from mnemonic.

signer

signer: OfflineSigner

The provided signer, which signs the transactions. TODO: Implement signing transactions without external signer.

`Static` Bundle

Bundle: BundleClass<Bundle>

The default Bundle class used by this Agent.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Inherited from Agent.[toStringTag]
- Defined in agent/agent-chain.ts:266

balance

get balance(): Promise<string>
This agent's balance in the chain's native token.

Returns Promise<string>
Inherited from Agent.balance
- Defined in agent/agent-chain.ts:290

defaultDenom

get defaultDenom(): string
The default denomination in which the agent operates.

Returns string
Inherited from Agent.defaultDenom
- Defined in agent/agent-chain.ts:286

height

get height(): Promise<number>
The chain's current block height.

Returns Promise<number>
Inherited from Agent.height
- Defined in agent/agent-chain.ts:294

nextBlock

get nextBlock(): Promise<number>
Wait until the block height increments.

Returns Promise<number>
Inherited from Agent.nextBlock
- Defined in agent/agent-chain.ts:298

ready

get ready(): Promise<this & {
api: SigningCosmWasmClient;
}>
Async initialization. Populates the api property.

Returns Promise<this & {
api: SigningCosmWasmClient;
}>
Overrides Agent.ready
- Defined in connect/cw/cw-base.ts:148

Methods

bundle

bundle(cb?): B
Execute a transaction bundle.
Type Parameters
- B extends Bundle
Parameters
- Optional cb: BundleCallback
Returns B
Bundle if called with no arguments
Inherited from Agent.bundle
- Defined in agent/agent-chain.ts:415

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>
Inherited from Agent.checkHash
- Defined in agent/agent-chain.ts:320

execute

execute(instance, msg, opts?): Promise<unknown>
Call a transaction method of a contract.
Parameters
- instance: Partial<Client>
- msg: Message
- opts: ExecOpts = {}
Returns Promise<unknown>
Overrides Agent.execute
- Defined in connect/cw/cw-base.ts:219

getBalance

getBalance(denom?, address?): Promise<string>
Query native token balance.
Parameters
- Optional denom: string
- Optional address: string
Returns Promise<string>
Overrides Agent.getBalance
- Defined in connect/cw/cw-base.ts:164

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
Inherited from Agent.getClient
- Defined in agent/agent-chain.ts:396

getCodeId

getCodeId(address): Promise<string>
Get the code ID of a contract.
Parameters
- address: string
Returns Promise<string>
Inherited from Agent.getCodeId
- Defined in agent/agent-chain.ts:308

getHash

getHash(address): Promise<string>
Get the code hash of a contract or template.
Parameters
- address: string | number
Returns Promise<string>
Inherited from Agent.getHash
- Defined in agent/agent-chain.ts:316

getLabel

getLabel(address): Promise<string>
Get the label of a contract.
Parameters
- address: string
Returns Promise<string>
Inherited from Agent.getLabel
- Defined in agent/agent-chain.ts:312

getUploader

getUploader($U, options?): U
Get an uploader instance which performs code uploads and optionally caches them.
Type Parameters
- U extends Uploader
Parameters
- $U: UploaderClass
- Optional options: Partial
Returns U
Inherited from Agent.getUploader
- Defined in agent/agent-chain.ts:343

instantiate

instantiate<C>(instance, init_funds?, memo?): Promise<Instantiated>
Instantiate a contract.
Type Parameters
- C extends Client
Parameters
- instance: Contract<C>
- init_funds: ICoin[] = []
- memo: string = ''
Returns Promise<Instantiated>
Overrides Agent.instantiate
- Defined in connect/cw/cw-base.ts:173

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 }),
 }))
```
Inherited from Agent.instantiateMany
- Defined in agent/agent-chain.ts:376

query

query(instance, query): Promise
Query a contract.
Type Parameters
- U
Parameters
- instance: Partial<Client>
- query: Message
Returns Promise
Overrides Agent.query
- Defined in connect/cw/cw-base.ts:231

send

send(to, amounts, opts?): Promise<unknown>
Send native tokens to 1 recipient.
Parameters
- to: string
- amounts: ICoin[]
- Optional opts: ExecOpts
Returns Promise<unknown>
Inherited from Agent.send
- Defined in agent/agent-chain.ts:324

sendMany

sendMany(outputs, opts?): Promise<unknown>
Send native tokens to multiple recipients.
Parameters
- outputs: [string, ICoin[]][]
- Optional opts: ExecOpts
Returns Promise<unknown>
Inherited from Agent.sendMany
- Defined in agent/agent-chain.ts:329

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>
Inherited from Agent.upload
- Defined in agent/agent-chain.ts:334

Class Agent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Base.Agent> = {}

Returns Base.Agent

Properties

Bundle

Optional address

Optional api

Optional bech32Prefix

Optional chain

Optional coinType

Optional fees

Optional hdAccountIndex

log

Optional mnemonic

Optional name

Optional publicKey

signer

Static Bundle

Accessors

[toStringTag]

Returns string

balance

Returns Promise<string>

defaultDenom

Returns string

height

Returns Promise<number>

nextBlock

Returns Promise<number>

ready

Returns Promise<this & { api: SigningCosmWasmClient; }>

Methods

bundle

Type Parameters

B extends Bundle

Parameters

Optional cb: BundleCallback<B>

Returns B

checkHash

Parameters

address: string

Optional codeHash: string

Returns Promise<string>

execute

Parameters

instance: Partial<Client>

msg: Message

opts: ExecOpts = {}

Returns Promise<unknown>

getBalance

Parameters

Optional denom: string

Optional address: string

Returns Promise<string>

getClient

Type Parameters

C extends Client

Parameters

$C: ClientClass<C>

Optional address: string

Optional codeHash: string

Rest ...args: unknown[]

Returns C

getCodeId

Parameters

address: string

Returns Promise<string>

getHash

Parameters

address: string | number

Returns Promise<string>

`Optional` address

`Optional` api

`Optional` bech32Prefix

`Optional` chain

`Optional` coinType

`Optional` fees

`Optional` hdAccountIndex

`Optional` mnemonic

`Optional` name

`Optional` publicKey

`Static` Bundle

Returns Promise<this & {
api: SigningCosmWasmClient;
}>

`Optional` cb: BundleCallback<B>

`Optional` codeHash: string

`Optional` denom: string

`Optional` address: string

`Optional` address: string

`Optional` codeHash: string

`Rest` ...args: unknown[]

`Optional` options: Partial<U>

`Optional` opts: ExecOpts

`Optional` opts: ExecOpts

`Optional` meta: Partial<Uploadable>