Class Bundle`Abstract`

Bundle is an alternate executor that collects collects messages to broadcast as a single transaction in order to execute them simultaneously. For that, it uses the API of its parent Agent. You can use it in scripts with: await agent.bundle().wrap(async bundle=>{ client.as(bundle).exec(...) })

Hierarchy

Bundle
- Mocknet.Bundle
- Base.Bundle
- Bundle

Implements

Agent

Index

Constructors

constructor

new Bundle(agent, callback?): Bundle
Parameters
- agent: Agent
  
  The agent that will execute the batched transaction.
- Optional callback: ((bundle) => unknown)
  
  Evaluating this defines the contents of the bundle.
  - - (bundle): unknown
    - Evaluating this defines the contents of the bundle.
      
      Parameters
      
      bundle: Bundle
      
      Returns unknown
Returns Bundle
- Defined in agent/agent-chain.ts:443

Properties

Bundle

Bundle: (new (agent) => Bundle) = ...

The Bundle subclass to use.

Type declaration

- new (agent): Bundle
- Bundle class to use when creating a bundle inside a bundle.
  Parameters
  - agent: Agent
  Returns Bundle
  Default
```
self
```

agent

agent: Agent

The agent that will execute the batched transaction.

`Optional` callback

callback?: ((bundle) => unknown)

Type declaration

- (bundle): unknown
- Evaluating this defines the contents of the bundle.
  Parameters
  - bundle: Bundle
  Returns unknown

depth

depth: number = 0

Nested bundles are flattened, this counts the depth.

id

id: number = 0

Next message id.

msgs

msgs: any[] = []

Messages in this bundle, unencrypted.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Implementation of Agent.[toStringTag]
- Defined in agent/agent-chain.ts:452

address

get address(): undefined | string
The address from which transactions are signed and sent.

Returns undefined | string
Implementation of Agent.address
- Defined in agent/agent-chain.ts:462

balance

get balance(): Promise<string>
Disallowed in bundle - do it beforehand or afterwards.

Returns Promise<string>
Implementation of Agent.balance
- Defined in agent/agent-chain.ts:599

chain

get chain(): undefined | Chain
The chain on which this agent operates.

Returns undefined | Chain
Implementation of Agent.chain
- Defined in agent/agent-chain.ts:460

defaultDenom

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

Returns string
Implementation of Agent.defaultDenom
- Defined in agent/agent-chain.ts:468

fees

get fees(): undefined | AgentFees
Default fee maximums for send, upload, init, and execute.

Returns undefined | AgentFees
Implementation of Agent.fees
- Defined in agent/agent-chain.ts:466

getClient

get getClient(): (<C>($C, address?, codeHash?, ...args) => C)
Returns (<C>($C, address?, codeHash?, ...args) => C)
- - <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
Implementation of Agent.getClient
- Defined in agent/agent-chain.ts:472

getUploader

get getUploader(): (($U, options?) => U)
Returns (($U, options?) => U)
- - ($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
Implementation of Agent.getUploader
- Defined in agent/agent-chain.ts:470

height

get height(): Promise<number>
Disallowed in bundle - do it beforehand or afterwards.

Returns Promise<number>
Implementation of Agent.height
- Defined in agent/agent-chain.ts:603

log

get log(): Console
Returns Console
Implementation of Agent.log
- Defined in agent/agent-chain.ts:454

name

get name(): string
The friendly name of the agent.

Returns string
Implementation of Agent.name
- Defined in agent/agent-chain.ts:464

nextBlock

get nextBlock(): Promise<number>
Disallowed in bundle - do it beforehand or afterwards.

Returns Promise<number>
Implementation of Agent.nextBlock
- Defined in agent/agent-chain.ts:607

ready

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

Returns Promise<this>
Implementation of Agent.ready
- Defined in agent/agent-chain.ts:458

Methods

add

add(msg): number
Add a message to the bundle.
Parameters
- msg: Message
Returns number
- Defined in agent/agent-chain.ts:475

assertMessages

assertMessages(): any[]
Throws if the bundle is invalid.

Returns any[]
- Defined in agent/agent-chain.ts:518

bundle

bundle(cb?): B
Nested bundles are "flattened": trying to create a bundle from inside a bundle returns the same bundle.
Type Parameters
- B extends Bundle
Parameters
- Optional cb: BundleCallback
Returns B
Implementation of Agent.bundle
- Defined in agent/agent-chain.ts:640

checkHash

checkHash(address, codeHash?): Promise<string>
This doesnt change over time so it's allowed when building bundles.
Parameters
- address: string
- Optional codeHash: string
Returns Promise<string>
Implementation of Agent.checkHash
- Defined in agent/agent-chain.ts:623

execute

execute(__namedParameters, msg, __namedParameters?): Promise<Bundle>
Add an exec message to the bundle.
Parameters
- __namedParameters: Partial<Client>
- msg: Message
- __namedParameters: ExecOpts = {}
Returns Promise<Bundle>
Implementation of Agent.execute
- Defined in agent/agent-chain.ts:570

getBalance

getBalance(denom): Promise<string>
Disallowed in bundle - do it beforehand or afterwards.
Parameters
- denom: string
Returns Promise<string>
Implementation of Agent.getBalance
- Defined in agent/agent-chain.ts:627

getCodeId

getCodeId(address): Promise<string>
This doesnt change over time so it's allowed when building bundles.
Parameters
- address: string
Returns Promise<string>
Implementation of Agent.getCodeId
- Defined in agent/agent-chain.ts:611

getHash

getHash(address): Promise<string>
This doesnt change over time so it's allowed when building bundles.
Parameters
- address: string | number
Returns Promise<string>
Implementation of Agent.getHash
- Defined in agent/agent-chain.ts:619

getLabel

getLabel(address): Promise<string>
This doesnt change over time so it's allowed when building bundles.
Parameters
- address: string
Returns Promise<string>
Implementation of Agent.getLabel
- Defined in agent/agent-chain.ts:615

instantiate

instantiate<C>(instance): Promise<{
 address: string;
 chainId: string;
 codeHash: string;
 initBy: undefined | string;
 label: string;
}>
Add an init message to the bundle.
Type Parameters
- C extends Client
Parameters
- instance: Contract<C>
Returns Promise<{
 address: string;
 chainId: string;
 codeHash: string;
 initBy: undefined | string;
 label: string;
}>
the unmodified input.
Example
```
await agent.instantiate(template.define({ label, initMsg })
```
Implementation of Agent.instantiate
- Defined in agent/agent-chain.ts:531

instantiateMany

instantiateMany<C>(inputs): Promise<C>

Add multiple init messages to the bundle.

Type Parameters

C extends Many<AnyContract>

Parameters

inputs: C

Returns Promise<C>

the unmodified inputs.

Example

await agent.bundle().wrap(async bundle=>{
    await bundle.instantiateMany(template.instances({
      One: { label, initMsg },
      Two: { label, initMsg },
    }))
    await agent.instantiateMany({
      One: template1.instance({ label, initMsg }),
      Two: template2.instance({ label, initMsg }),
    })
  })

query

query(contract, msg): Promise<never>
Queries are disallowed in the middle of a bundle because even though the bundle API is structured as multiple function calls, the bundle is ultimately submitted as a single transaction and it doesn't make sense to query state in the middle of that.
Type Parameters
- U
Parameters
- contract: Client
- msg: Message
Returns Promise<never>
Implementation of Agent.query
- Defined in agent/agent-chain.ts:583

run

run(opts?, save?): Promise<any>
Either submit or save the bundle.
Parameters
- opts: string | ExecOpts = ""
- save: boolean = false
Returns Promise<any>
- Defined in agent/agent-chain.ts:482

save

save(name?): Promise<unknown>
Save a bundle for manual broadcast.
Parameters
- Optional name: string
Returns Promise<unknown>
- Defined in agent/agent-chain.ts:508

send

send(to, amounts, opts?): Promise<unknown>
Disallowed in bundle - do it beforehand or afterwards.
Parameters
- to: string
- amounts: ICoin[]
- Optional opts: ExecOpts
Returns Promise<unknown>
Implementation of Agent.send
- Defined in agent/agent-chain.ts:631

sendMany

sendMany(outputs, opts?): Promise<unknown>
Disallowed in bundle - do it beforehand or afterwards.
Parameters
- outputs: [string, ICoin[]][]
- Optional opts: ExecOpts
Returns Promise<unknown>
Implementation of Agent.sendMany
- Defined in agent/agent-chain.ts:635

submit

submit(memo?): Promise<unknown>
Broadcast a bundle to the chain.
Parameters
- Optional memo: string
Returns Promise<unknown>
- Defined in agent/agent-chain.ts:498

upload

upload(data, meta?): Promise<never>
Uploads are disallowed in the middle of a bundle because it's easy to go over the max request size, and difficult to know what that is in advance.
Parameters
- data: Uint8Array
- Optional meta: Partial<Uploadable>
Returns Promise<never>
Implementation of Agent.upload
- Defined in agent/agent-chain.ts:589

uploadMany

uploadMany(uploadables?): Promise<never>
Uploads are disallowed in the middle of a bundle because it's easy to go over the max request size, and difficult to know what that is in advance.
Parameters
- uploadables: Uploadable[] = []
Returns Promise<never>
- Defined in agent/agent-chain.ts:595

Class BundleAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

agent: Agent

Optional callback: ((bundle) => unknown)

Parameters

bundle: Bundle

Returns unknown

Returns Bundle

Properties

Bundle

Type declaration

Parameters

agent: Agent

Returns Bundle

Default

agent

Optional callback

Type declaration

Parameters

bundle: Bundle

Returns unknown

depth

id

msgs

Accessors

[toStringTag]

Returns string

address

Returns undefined | string

balance

Returns Promise<string>

chain

Returns undefined | Chain

defaultDenom

Returns string

fees

Returns undefined | AgentFees

getClient

Returns (<C>($C, address?, codeHash?, ...args) => C)

Type Parameters

C extends Client

Parameters

$C: ClientClass<C>

Optional address: string

Optional codeHash: string

Rest ...args: unknown[]

Returns C

getUploader

Returns (<U>($U, options?) => U)

Type Parameters

U extends Uploader

Parameters

$U: UploaderClass<U>

Optional options: Partial<U>

Returns U

height

Returns Promise<number>

log

Returns Console

name

Returns string

nextBlock

Returns Promise<number>

ready

Returns Promise<this>

Methods

add

Parameters

msg: Message

Returns number

assertMessages

Class Bundle`Abstract`

`Optional` callback: ((bundle) => unknown)

`Optional` callback

`Optional` address: string

`Optional` codeHash: string

`Rest` ...args: unknown[]

`Optional` options: Partial<U>

`Optional` cb: BundleCallback<B>

`Optional` codeHash: string

Returns Promise<{
address: string;
chainId: string;
codeHash: string;
initBy: undefined | string;
label: string;
}>

`Optional` name: string

`Optional` opts: ExecOpts