Class Agent`Abstract`

By authenticating to a network you obtain an Agent, which can perform transactions as the authenticated identity.

Hierarchy

Agent
- Scrt.Agent
- Mocknet.Agent

Implemented by

Bundle

Index

Constructors

constructor

new Agent(options?: Partial<Agent>): Agent
Parameters
- options: Partial<Agent> = {}
Returns Agent
- Defined in agent/agent-chain.ts:263

Properties

Bundle

Bundle: BundleClass<Bundle> = ...

The Bundle subclass to use.

`Optional` address

address?: string

The address from which transactions are signed and sent.

`Optional` chain

chain?: Chain

The chain on which this agent operates.

`Optional` fees

fees?: AgentFees

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

log

log: Console = ...

`Optional` mnemonic

mnemonic?: string

The wallet's mnemonic.

`Optional` name

name?: string

The friendly name of the agent.

`Static` Bundle

Bundle: BundleClass<Bundle>

The default Bundle class used by this Agent.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
- Defined in agent/agent-chain.ts:272

balance

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

Returns Promise<string>
- Defined in agent/agent-chain.ts:296

defaultDenom

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

Returns string
- Defined in agent/agent-chain.ts:292

height

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

Returns Promise<number>
- Defined in agent/agent-chain.ts:300

nextBlock

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

Returns Promise<number>
- Defined in agent/agent-chain.ts:304

ready

get ready(): Promise<this>
Complete the asynchronous initialization of this Agent.

Returns Promise<this>
- Defined in agent/agent-chain.ts:276

Methods

bundle

bundle(cb?: BundleCallback): B
Execute a transaction bundle.

Returns
Bundle if called with no arguments

Returns
Promise<any[]> if called with Bundle#wrap args
Type Parameters
- B extends Bundle
Parameters
- Optional cb: BundleCallback
Returns B
- Defined in agent/agent-chain.ts:421

checkHash

checkHash(address: string, codeHash?: string): 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>
- Defined in agent/agent-chain.ts:326

execute

execute(contract: Partial<Client>, msg: Message, opts?: ExecOpts): Promise<unknown>
Call a transaction method on a smart contract.
Parameters
- contract: Partial<Client>
- msg: Message
- Optional opts: ExecOpts
Returns Promise<unknown>
- Defined in agent/agent-chain.ts:408

getBalance

getBalance(denom?: string, address?: undefined | string): Promise<string>
Get the balance of this or another address.
Parameters
- denom: string = ...
- address: undefined | string = ...
Returns Promise<string>
- Defined in agent/agent-chain.ts:308

getClient

getClient<C>($C: ClientClass<C>, address?: string, codeHash?: string, ...args: unknown[]): C
Get a client instance for talking to a specific smart contract as this executor.
Type Parameters
- C extends Client<C>
Parameters
- $C: ClientClass<C>
- Optional address: string
- Optional codeHash: string
- Rest ...args: unknown[]
Returns C
- Defined in agent/agent-chain.ts:402

getCodeId

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

getHash

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

getLabel

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

getUploader

getUploader($U: UploaderClass, options?: Partial): 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
- Defined in agent/agent-chain.ts:349

instantiate

instantiate<C>(instance: Contract<C>): PromiseLike<Instantiated>
Create a new smart contract from a code id, label and init message.

Example
```
await agent.instantiate(template.define({ label, initMsg })
```
Returns
AnyContract with no address populated yet. This will be populated after executing the bundle.
Type Parameters
- C extends Client<C>
Parameters
- instance: Contract<C>
Returns PromiseLike<Instantiated>
- Defined in agent/agent-chain.ts:358

instantiateMany

instantiateMany<C>(instances: C): 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.

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 }),
 }))
```
Returns
either an Array or a Record<string, AnyContract>, depending on what is passed as inputs.
Type Parameters
- C extends Many<AnyContract>
Parameters
- instances: C
Returns Promise<C>
- Defined in agent/agent-chain.ts:382

query

query<R>(contract: Client, msg: Message): Promise<R>
Query a contract on the chain.
Type Parameters
- R
Parameters
- contract: Client
- msg: Message
Returns Promise<R>
- Defined in agent/agent-chain.ts:415

send

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

sendMany

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

upload

upload(data: Uint8Array, meta?: Partial<Uploadable>): Promise<Uploaded>
Upload code, generating a new code id/hash pair.
Parameters
- data: Uint8Array
- Optional meta: Partial<Uploadable>
Returns Promise<Uploaded>
- Defined in agent/agent-chain.ts:340

Class AgentAbstract

Hierarchy

Implemented by

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Agent> = {}

Returns Agent

Properties

Bundle

Optional address

Optional chain

Optional fees

log

Optional mnemonic

Optional name

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>

Methods

bundle

Returns

Returns

Type Parameters

B extends Bundle<B>

Parameters

Optional cb: BundleCallback<B>

Returns B

checkHash

Parameters

address: string

Optional codeHash: string

Returns Promise<string>

execute

Parameters

contract: Partial<Client>

msg: Message

Optional opts: ExecOpts

Returns Promise<unknown>

getBalance

Parameters

denom: string = ...

address: undefined | string = ...

Returns Promise<string>

getClient

Type Parameters

C extends Client<C>

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>

getLabel

Parameters

address: string

Class Agent`Abstract`

`Optional` address

`Optional` chain

`Optional` fees

`Optional` mnemonic

`Optional` name

`Static` Bundle

`Optional` cb: BundleCallback<B>

`Optional` codeHash: string

`Optional` opts: ExecOpts

`Optional` address: string

`Optional` codeHash: string

`Rest` ...args: unknown[]

`Optional` options: Partial<U>

`Optional` opts: ExecOpts

`Optional` opts: ExecOpts

`Optional` meta: Partial<Uploadable>