Class Agent

Represents a connection to the Secret Network, authenticated as a specific address.

Hierarchy

Agent
- Agent

Index

Constructors

constructor

new Agent(options?: Partial<Scrt.Agent>): Scrt.Agent
Parameters
- options: Partial<Scrt.Agent> = {}
Returns Scrt.Agent
Overrides Agent.constructor
- Defined in connect/scrt/scrt-chain.ts:157

Properties

Bundle

Bundle: BundleClass<Scrt.Bundle> = ScrtAgent.Bundle

Bundle class used by this agent.

`Optional` address

address?: string

The address from which transactions are signed and sent.

chain

chain: Scrt.Chain

Downcast chain property to Scrt only.

fees

fees: AgentFees = ScrtChain.defaultFees

Default fees for this agent.

log

log: Scrt.Console = ...

`Optional` mnemonic

mnemonic?: string

The wallet's mnemonic.

`Optional` name

name?: string

The friendly name of the agent.

simulateForGas

simulateForGas: boolean = false

Whether to simulate each execution first to get a more accurate gas estimate.

`Static` Bundle

Bundle: BundleClass<Scrt.Bundle>

The default Bundle class used by this Agent.

Accessors

[toStringTag]

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

account

get account(): Promise<{
account?: Scrt.SecretJS.Account;
}>
Returns Promise<{
account?: Scrt.SecretJS.Account;
}>
- Defined in connect/scrt/scrt-chain.ts:251

api

get api(): undefined | Scrt.SecretJS.SecretNetworkClient
Instance of the underlying platform API provided by secretjs.

Returns undefined | Scrt.SecretJS.SecretNetworkClient
- Defined in connect/scrt/scrt-chain.ts:228
set api(value: undefined | Scrt.SecretJS.SecretNetworkClient): void
Parameters
- value: undefined | Scrt.SecretJS.SecretNetworkClient
Returns void
- Defined in connect/scrt/scrt-chain.ts:231

balance

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

Returns Promise<string>
Overrides Agent.balance
- Defined in connect/scrt/scrt-chain.ts:255

defaultDenom

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

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

encryptionUtils

get encryptionUtils(): undefined | Scrt.SecretJS.EncryptionUtils
Provide this to allow SecretJS to sign with keys stored in Keplr.

Returns undefined | Scrt.SecretJS.EncryptionUtils
- Defined in connect/scrt/scrt-chain.ts:244
set encryptionUtils(value: undefined | Scrt.SecretJS.EncryptionUtils): void
Parameters
- value: undefined | Scrt.SecretJS.EncryptionUtils
Returns void
- Defined in connect/scrt/scrt-chain.ts:247

height

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

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

nextBlock

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

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

ready

get ready(): Promise<this & {
api: Scrt.SecretJS.SecretNetworkClient;
}>
Complete the asynchronous initialization of this Agent.

Returns Promise<this & {
api: Scrt.SecretJS.SecretNetworkClient;
}>
Overrides Agent.ready
- Defined in connect/scrt/scrt-chain.ts:169

wallet

get wallet(): undefined | Scrt.SecretJS.Wallet
This agent's identity on the chain.

Returns undefined | Scrt.SecretJS.Wallet
- Defined in connect/scrt/scrt-chain.ts:236
set wallet(value: undefined | Scrt.SecretJS.Wallet): void
Parameters
- value: undefined | Scrt.SecretJS.Wallet
Returns void
- Defined in connect/scrt/scrt-chain.ts:239

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

decryptError

decryptError(result: Scrt.SecretJS.TxResponse): Scrt.Error & Scrt.SecretJS.TxResponse
Parameters
- result: Scrt.SecretJS.TxResponse
Returns Scrt.Error & Scrt.SecretJS.TxResponse
- Defined in connect/scrt/scrt-chain.ts:482

encrypt

encrypt(codeHash: string, msg: Message): Promise<string>
Parameters
- codeHash: string
- msg: Message
Returns Promise<string>
- Defined in connect/scrt/scrt-chain.ts:314

execute

execute(instance: Partial<Client>, msg: Message, opts?: ExecOpts): Promise<Scrt.SecretJS.TxResponse>
Call a transaction method on a smart contract.
Parameters
- instance: Partial<Client>
- msg: Message
- opts: ExecOpts = {}
Returns Promise<Scrt.SecretJS.TxResponse>
Overrides Agent.execute
- Defined in connect/scrt/scrt-chain.ts:440

getBalance

getBalance(denom?: string, address: string): Promise<string>
Get the balance of this or another address.
Parameters
- denom: string = ...
- address: string
Returns Promise<string>
Overrides Agent.getBalance
- Defined in connect/scrt/scrt-chain.ts:259

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

getCodeId

getCodeId(contract_address: string): Promise<string>
Get the code ID of a contract.
Parameters
- contract_address: string
Returns Promise<string>
Overrides Agent.getCodeId
- Defined in connect/scrt/scrt-chain.ts:284

getHash

getHash(arg: string | number): Promise<string>
Get the code hash of a contract or template.
Parameters
- arg: string | number
Returns Promise<string>
Overrides Agent.getHash
- Defined in connect/scrt/scrt-chain.ts:290

getLabel

getLabel(contract_address: string): Promise<string>
Get the label of a contract.
Parameters
- contract_address: string
Returns Promise<string>
Overrides Agent.getLabel
- Defined in connect/scrt/scrt-chain.ts:278

getNonce

getNonce(): Promise<{
accountNumber: number;
sequence: number;
}>
Returns Promise<{
accountNumber: number;
sequence: number;
}>
- Defined in connect/scrt/scrt-chain.ts:303

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

instantiate

instantiate<C>(instance: Contract<C>, init_funds?: ICoin[]): Promise<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>
- init_funds: ICoin[] = []
Returns Promise<Instantiated>
Overrides Agent.instantiate
- Defined in connect/scrt/scrt-chain.ts:373

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

query

query(instance: Partial<Client>, query: Message): Promise
Query a Client.

Returns
the result of the query
Type Parameters
- U
Parameters
- instance: Partial<Client>
- query: Message
Returns Promise
Overrides Agent.query
- Defined in connect/scrt/scrt-chain.ts:324

send

send(to: string, amounts: ICoin[], opts?: any): Promise<Scrt.SecretJS.TxResponse>
Send native tokens to 1 recipient.
Parameters
- to: string
- amounts: ICoin[]
- Optional opts: any
Returns Promise<Scrt.SecretJS.TxResponse>
Overrides Agent.send
- Defined in connect/scrt/scrt-chain.ts:265

sendMany

sendMany(outputs: never, opts: never): Promise<void>
Send native tokens to multiple recipients.
Parameters
- outputs: never
- opts: never
Returns Promise<void>
Overrides Agent.sendMany
- Defined in connect/scrt/scrt-chain.ts:274

upload

upload(data: Uint8Array): Promise<Uploaded>
Upload a WASM binary.
Parameters
- data: Uint8Array
Returns Promise<Uploaded>
Overrides Agent.upload
- Defined in connect/scrt/scrt-chain.ts:334

Class Agent

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Scrt.Agent> = {}

Returns Scrt.Agent

Properties

Bundle

Optional address

chain

fees

log

Optional mnemonic

Optional name

simulateForGas

Static Bundle

Accessors

[toStringTag]

Returns string

account

Returns Promise<{ account?: Scrt.SecretJS.Account; }>

api

Returns undefined | Scrt.SecretJS.SecretNetworkClient

Parameters

value: undefined | Scrt.SecretJS.SecretNetworkClient

Returns void

balance

Returns Promise<string>

defaultDenom

Returns string

encryptionUtils

Returns undefined | Scrt.SecretJS.EncryptionUtils

Parameters

value: undefined | Scrt.SecretJS.EncryptionUtils

Returns void

height

Returns Promise<number>

nextBlock

Returns Promise<number>

ready

Returns Promise<this & { api: Scrt.SecretJS.SecretNetworkClient; }>

wallet

Returns undefined | Scrt.SecretJS.Wallet

Parameters

value: undefined | Scrt.SecretJS.Wallet

Returns void

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>

decryptError

Parameters

result: Scrt.SecretJS.TxResponse

Returns Scrt.Error & Scrt.SecretJS.TxResponse

encrypt

Parameters

codeHash: string

msg: Message

Returns Promise<string>

execute

Parameters

instance: Partial<Client>

msg: Message

opts: ExecOpts = {}

`Optional` address

`Optional` mnemonic

`Optional` name

`Static` Bundle

Returns Promise<{
account?: Scrt.SecretJS.Account;
}>

Returns Promise<this & {
api: Scrt.SecretJS.SecretNetworkClient;
}>

`Optional` cb: BundleCallback<B>

`Optional` codeHash: string

`Optional` address: string

`Optional` codeHash: string

`Rest` ...args: unknown[]

Returns Promise<{
accountNumber: number;
sequence: number;
}>

`Optional` options: Partial<U>

`Optional` opts: any