Class Bundle

Base class for transaction-bundling Agent for both Secret Network implementations.

Hierarchy

Bundle
- Bundle

Index

Constructors

constructor

new Bundle(agent: Scrt.Agent, callback?: ((bundle: Scrt.Bundle) => unknown)): Scrt.Bundle
Parameters
- agent: Scrt.Agent
- Optional callback: ((bundle: Scrt.Bundle) => unknown)
  - - (bundle: Scrt.Bundle): unknown
    - Parameters
      
      bundle: Scrt.Bundle
      
      Returns unknown
Returns Scrt.Bundle
Overrides Bundle.constructor
- Defined in connect/scrt/scrt-chain.ts:590

Properties

Bundle

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

The Bundle subclass to use.

Type declaration

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

agent

agent: Scrt.Agent

The agent which will sign and/or broadcast the bundle.

`Optional` callback

callback?: ((bundle: Bundle) => unknown)

Type declaration

- (bundle: 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.

`Static` bundleCounter

bundleCounter: number = 0

Accessors

[toStringTag]

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

address

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

Returns undefined | string
Inherited from Bundle.address
- Defined in agent/agent-chain.ts:468

balance

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

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

chain

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

Returns undefined | Chain
Inherited from Bundle.chain
- Defined in agent/agent-chain.ts:466

`Private` conformedMsgs

get conformedMsgs(): (undefined | Scrt.SecretJS.MsgInstantiateContract | Scrt.SecretJS.MsgExecuteContract<any>)[]
Format the messages for API v1 like secretjs and encrypt them.

Returns (undefined | Scrt.SecretJS.MsgInstantiateContract | Scrt.SecretJS.MsgExecuteContract<any>)[]
- Defined in connect/scrt/scrt-chain.ts:727

defaultDenom

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

Returns string
Inherited from Bundle.defaultDenom
- Defined in agent/agent-chain.ts:474

fees

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

Returns undefined | AgentFees
Inherited from Bundle.fees
- Defined in agent/agent-chain.ts:472

getClient

get getClient(): (<C>($C: ClientClass<C>, address?: string, codeHash?: string, ...args: unknown[]) => C)
Returns (<C>($C: ClientClass<C>, address?: string, codeHash?: string, ...args: unknown[]) => C)
- - <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 Bundle.getClient
- Defined in agent/agent-chain.ts:478

getUploader

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

height

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

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

log

get log(): Console
Returns Console
Inherited from Bundle.log
- Defined in agent/agent-chain.ts:460

name

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

Returns string
Inherited from Bundle.name
- Defined in agent/agent-chain.ts:470

nextBlock

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

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

ready

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

Returns Promise<this>
Inherited from Bundle.ready
- Defined in agent/agent-chain.ts:464

Methods

add

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

assertMessages

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

Returns any[]
Inherited from Bundle.assertMessages
- Defined in agent/agent-chain.ts:524

bundle

bundle(cb?: BundleCallback): B
Nested bundles are flattened, i.e. trying to create a bundle from inside a bundle returns the same bundle.
Type Parameters
- B extends Bundle
Parameters
- Optional cb: BundleCallback
Returns B
Inherited from Bundle.bundle
- Defined in agent/agent-chain.ts:644

checkHash

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

`Private` composeUnsignedTx

composeUnsignedTx(encryptedMessages: any[], memo?: string): any
Parameters
- encryptedMessages: any[]
- Optional memo: string
Returns any
- Defined in connect/scrt/scrt-chain.ts:656

`Private` encryptExec

encryptExec(exec: any): Promise<any>
Parameters
- exec: any
Returns Promise<any>
- Defined in connect/scrt/scrt-chain.ts:643

`Private` encryptInit

encryptInit(init: any): Promise<any>
Parameters
- init: any
Returns Promise<any>
- Defined in connect/scrt/scrt-chain.ts:629

execute

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

getBalance

getBalance(denom: string): Promise<string>
Disallowed in bundle - do it beforehand or afterwards.
Parameters
- denom: string
Returns Promise<string>
Inherited from Bundle.getBalance
- Defined in agent/agent-chain.ts:630

getCodeId

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

getHash

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

getLabel

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

instantiate

instantiate<C>(instance: Contract<C>): Promise<{
 address: string;
 chainId: string;
 codeHash: string;
 initBy: undefined | string;
 label: string;
}>
Add an init message to the bundle.

Example
```
await agent.instantiate(template.define({ label, initMsg })
```
Returns
the unmodified input.
Type Parameters
- C extends Client<C>
Parameters
- instance: Contract<C>
Returns Promise<{
 address: string;
 chainId: string;
 codeHash: string;
 initBy: undefined | string;
 label: string;
}>
Inherited from Bundle.instantiate
- Defined in agent/agent-chain.ts:534

instantiateMany

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

Add multiple init messages to the bundle.

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 }),
    })
  })

Returns

the unmodified inputs.

Type Parameters

C extends Many<AnyContract>

Parameters

inputs: C

Returns Promise<C>

query

query(contract: Client, msg: Message): 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>
Inherited from Bundle.query
- Defined in agent/agent-chain.ts:586

run

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

save

save(name?: string): Promise<{
 N: number;
 accountNumber: number;
 name: string;
 sequence: number;
 unsignedTxBody: string;
}>
Format the messages for API v1beta1 like secretcli and generate a multisig-ready unsigned transaction bundle; don't execute it, but save it in state/$CHAIN_ID/transactions and output a signing command for it to the console.
Parameters
- Optional name: string
Returns Promise<{
 N: number;
 accountNumber: number;
 name: string;
 sequence: number;
 unsignedTxBody: string;
}>
Overrides Bundle.save
- Defined in connect/scrt/scrt-chain.ts:599

send

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

sendMany

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

simulateForGas

simulateForGas(): Promise<SimulateResponse>
Returns Promise<SimulateResponse>
- Defined in connect/scrt/scrt-chain.ts:720

submit

submit(memo?: string): Promise<Scrt.ScrtBundleResult[]>
Broadcast a bundle to the chain.
Parameters
- memo: string = ""
Returns Promise<Scrt.ScrtBundleResult[]>
Overrides Bundle.submit
- Defined in connect/scrt/scrt-chain.ts:673

upload

upload(data: Uint8Array, meta?: Partial<Uploadable>): 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>
Inherited from Bundle.upload
- Defined in agent/agent-chain.ts:592

uploadMany

uploadMany(uploadables?: Uploadable[]): 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>
Inherited from Bundle.uploadMany
- Defined in agent/agent-chain.ts:598

Class Bundle

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

agent: Scrt.Agent

Optional callback: ((bundle: Scrt.Bundle) => unknown)

Parameters

bundle: Scrt.Bundle

Returns unknown

Returns Scrt.Bundle

Properties

Bundle

Type declaration

Default

Parameters

agent: Agent

Returns Bundle

agent

Optional callback

Type declaration

Parameters

bundle: Bundle

Returns unknown

depth

id

msgs

Static bundleCounter

Accessors

[toStringTag]

Returns string

address

Returns undefined | string

balance

Returns Promise<string>

chain

Returns undefined | Chain

Private conformedMsgs

Returns (undefined | Scrt.SecretJS.MsgInstantiateContract | Scrt.SecretJS.MsgExecuteContract<any>)[]

defaultDenom

Returns string

fees

Returns undefined | AgentFees

getClient

Returns (<C>($C: ClientClass<C>, address?: string, codeHash?: string, ...args: unknown[]) => C)

Type Parameters

C extends Client<C>

Parameters

$C: ClientClass<C>

Optional address: string

Optional codeHash: string

Rest ...args: unknown[]

Returns C

getUploader

Returns (<U>($U: UploaderClass<U>, options?: Partial<U>) => U)

Type Parameters

U extends Uploader<U>

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

`Optional` callback: ((bundle: Scrt.Bundle) => unknown)

`Optional` callback

`Static` bundleCounter

`Private` conformedMsgs

`Optional` address: string

`Optional` codeHash: string

`Rest` ...args: unknown[]

`Optional` options: Partial<U>

`Optional` cb: BundleCallback<B>

`Optional` codeHash: string

`Private` composeUnsignedTx

`Optional` memo: string

`Private` encryptExec

`Private` encryptInit

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