Class CWConnection

Generic agent for CosmWasm-enabled chains.

Hierarchy (view full)

Chain.Connection
- CWConnection
  - OKP4Connection

Constructors

constructor

new CWConnection(properties): CWConnection
Parameters
- properties: Partial<CWConnection>
Returns CWConnection
Overrides Connection.constructor
- Defined in cw/cw-connection.ts:29

Properties

alive

alive: boolean = true

Setting this to false stops retries.

api

api: Promise<CosmWasmClient | SigningCosmWasmClient>

API connects asynchronously, so API handle is a promise of either variant.

`Optional` bech32Prefix

bech32Prefix?: string

The bech32 prefix for the account's address

blockInterval

blockInterval: number = 250

Time to ping for next block.

`Optional` chainId

chainId?: string

Chain ID.

`Optional` coinType

coinType?: number

The coin type in the HD derivation path

`Optional` fees

fees?: {
    exec?: IFee;
    init?: IFee;
    send?: IFee;
    upload?: IFee;
}

Default transaction fees.

Type declaration

Optional exec?: IFee
Optional init?: IFee
Optional send?: IFee
Optional upload?: IFee

`Optional` hdAccountIndex

hdAccountIndex?: number

The account index in the HD derivation path

identity

identity: CWSignerIdentity | CWMnemonicIdentity

A supported method of authentication.

log

log: Core.Console

`Optional` url

url?: string

Connection URL.

`Static` gasToken

gasToken: Native = ...

Native token of chain.

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Inherited from Chain.Connection.[toStringTag]
- Defined in agent/chain.ts:113

address

get address(): string
Returns string
Inherited from Chain.Connection.address
- Defined in agent/chain.ts:124

balance

get balance(): Promise<unknown>
Returns Promise<unknown>
Inherited from Chain.Connection.balance
- Defined in agent/chain.ts:296

defaultDenom

get defaultDenom(): string
Returns string
Inherited from Chain.Connection.defaultDenom
- Defined in agent/chain.ts:128

height

get height(): Promise<number>
Returns Promise<number>
Inherited from Chain.Connection.height
- Defined in agent/chain.ts:132

nextBlock

get nextBlock(): Promise<number>
Wait for the block height to increment.

Returns Promise<number>
Inherited from Chain.Connection.nextBlock
- Defined in agent/chain.ts:140

Methods

batch

batch(): Chain.Batch<CWConnection>
Construct a transaction batch.

Returns Chain.Batch<CWConnection>
Overrides Connection.batch
- Defined in cw/cw-connection.ts:250

doExecute

doExecute(contract, message, __namedParameters?): Promise<unknown>
Call a transaction method of a contract.
Parameters
- contract: {
  address: string;
  }
  - address: string
- message: Message
- __namedParameters: Omit<{
      execFee?: IFee;
      execMemo?: string;
      execSend?: ICoin[];
  }, "execFee"> & {
      execFee?: number | IFee | "auto";
  } = {}
Returns Promise<unknown>
Overrides Connection.doExecute
- Defined in cw/cw-connection.ts:213

doGetBalance

doGetBalance(token?, address?): Promise<string>
Query native token balance.
Parameters
- token: string = ...
- address: string = ...
Returns Promise<string>
Overrides Connection.doGetBalance
- Defined in cw/cw-connection.ts:56

doGetBlockInfo

doGetBlockInfo(): Promise<Block>
Returns Promise<Block>
Overrides Connection.doGetBlockInfo
- Defined in cw/cw-connection.ts:45

doGetCodeHashOfAddress

doGetCodeHashOfAddress(address): Promise<string>
Stargate implementation of getting a code hash.
Parameters
- address: string
Returns Promise<string>
Overrides Connection.doGetCodeHashOfAddress
- Defined in cw/cw-connection.ts:104

doGetCodeHashOfCodeId

doGetCodeHashOfCodeId(codeId): Promise<string>
Stargate implementation of getting a code hash.
Parameters
- codeId: string
Returns Promise<string>
Overrides Connection.doGetCodeHashOfCodeId
- Defined in cw/cw-connection.ts:111

doGetCodeId

doGetCodeId(address): Promise<string>
Stargate implementation of getting a code id.
Parameters
- address: string
Returns Promise<string>
Overrides Connection.doGetCodeId
- Defined in cw/cw-connection.ts:91

doGetCodes

doGetCodes(): Promise<Record<string, UploadedCode>>
Returns Promise<Record<string, UploadedCode>>
Overrides Connection.doGetCodes
- Defined in cw/cw-connection.ts:73

doGetContractsByCodeId

doGetContractsByCodeId(id): Promise<Iterable<{
address: string;
}>>
Parameters
- id: string
Returns Promise<Iterable<{
address: string;
}>>
Overrides Connection.doGetContractsByCodeId
- Defined in cw/cw-connection.ts:97

doGetHeight

doGetHeight(): Promise<number>
Returns Promise<number>
Overrides Connection.doGetHeight
- Defined in cw/cw-connection.ts:49

doInstantiate

doInstantiate(codeId, options): Promise<Partial<ContractInstance>>
Instantiate a contract via CosmJS Stargate.
Parameters
- codeId: string
- options: Partial<ContractInstance>
Returns Promise<Partial<ContractInstance>>
Overrides Connection.doInstantiate
- Defined in cw/cw-connection.ts:178

doQuery

doQuery<U>(contract, message): Promise<U>
Stargate implementation of querying a smart contract.
Type Parameters
- U
Parameters
- contract: string | {
  address: string;
  }
- message: Message
Returns Promise<U>
Overrides Connection.doQuery
- Defined in cw/cw-connection.ts:236

doSend

doSend(recipient, amounts, options?): Promise<DeliverTxResponse>
Stargate implementation of sending native token.
Parameters
- recipient: string
- amounts: ICoin[]
- Optional options: {
  sendFee?: IFee;
  sendMemo?: string;
  }
  - Optional sendFee?: IFee
  - Optional sendMemo?: string
Returns Promise<DeliverTxResponse>
Overrides Connection.doSend
- Defined in cw/cw-connection.ts:127

doSendMany

doSendMany(outputs, options?): Promise<unknown>
Stargate implementation of batch send.
Parameters
- outputs: [string, ICoin[]][]
- Optional options: unknown
Returns Promise<unknown>
Overrides Connection.doSendMany
- Defined in cw/cw-connection.ts:147

doUpload

doUpload(data): Promise<Partial<UploadedCode>>
Parameters
- data: Uint8Array
Returns Promise<Partial<UploadedCode>>
Overrides Connection.doUpload
- Defined in cw/cw-connection.ts:154

execute

execute(contract, message, options?): Promise<unknown>
Call a given program's transaction method.
Parameters
- contract: string | Partial<ContractInstance>
- message: Message
- Optional options: {
      execFee?: IFee;
      execMemo?: string;
      execSend?: ICoin[];
  }
  - Optional execFee?: IFee
  - Optional execMemo?: string
  - Optional execSend?: ICoin[]
Returns Promise<unknown>
Inherited from Connection.execute
- Defined in agent/chain.ts:507

getBalanceIn

getBalanceIn(token, address?): Promise<unknown>
Get the balance in a given native token, of either this connection's identity's address, or of another given address.
Parameters
- token: string
- Optional address: string | {
  address: string;
  }
Returns Promise<unknown>
Inherited from Connection.getBalanceIn
- Defined in agent/chain.ts:334

getBalanceOf

getBalanceOf(address, token?): Promise<unknown>
Get the balance in a native token of a given address, either in this connection's gas token, or in another given token.
Parameters
- address: string | {
  address: string;
  }
- Optional token: string
Returns Promise<unknown>
Inherited from Connection.getBalanceOf
- Defined in agent/chain.ts:309

getCodeHashOfAddress

getCodeHashOfAddress(contract): Promise<string>
Get the code hash of a given address.
Parameters
- contract: string | {
  address: string;
  }
Returns Promise<string>
Inherited from Connection.getCodeHashOfAddress
- Defined in agent/chain.ts:211

getCodeHashOfCodeId

getCodeHashOfCodeId(contract): Promise<string>
Get the code hash of a given code id.
Parameters
- contract: string | {
  codeId: string;
  }
Returns Promise<string>
Inherited from Connection.getCodeHashOfCodeId
- Defined in agent/chain.ts:195

getCodeId

getCodeId(contract): Promise<string>
Get the code id of a given address.
Parameters
- contract: string | {
  address: string;
  }
Returns Promise<string>
Inherited from Connection.getCodeId
- Defined in agent/chain.ts:179

getCodes

getCodes(): Promise<Record<string, UploadedCode>>
Returns Promise<Record<string, UploadedCode>>
Inherited from Connection.getCodes
- Defined in agent/chain.ts:241

getContract

getContract(options): Chain.Contract
Get a client handle for a specific smart contract, authenticated as as this agent.
Parameters
- options: string | {
  address: string;
  }
Returns Chain.Contract
Inherited from Connection.getContract
- Defined in agent/chain.ts:227

getContractsByCodeId

getContractsByCodeId(id): Promise<Record<string, Chain.Contract>>
Get client handles for all contracts that match a code ID
Parameters
- id: string
Returns Promise<Record<string, Chain.Contract>>
Inherited from Connection.getContractsByCodeId
- Defined in agent/chain.ts:249
getContractsByCodeId<C>(id, $C): Promise<Record<string, InstanceType<C>>>
Type Parameters
- C extends typeof Chain.Contract
Parameters
- id: string
- $C: C
Returns Promise<Record<string, InstanceType<C>>>
Inherited from Connection.getContractsByCodeId
- Defined in agent/chain.ts:251

getContractsByCodeIds

getContractsByCodeIds(ids): Promise<Record<string, Record<string, Chain.Contract>>>
Get client handles for all contracts that match multiple code IDs
Parameters
- ids: Iterable<string>
Returns Promise<Record<string, Record<string, Chain.Contract>>>
Inherited from Connection.getContractsByCodeIds
- Defined in agent/chain.ts:271
getContractsByCodeIds<C>(ids, $C?): Promise<Record<string, Record<string, InstanceType<C>>>>
Type Parameters
- C extends typeof Chain.Contract
Parameters
- ids: Iterable<string>
- Optional $C: C
Returns Promise<Record<string, Record<string, InstanceType<C>>>>
Inherited from Connection.getContractsByCodeIds
- Defined in agent/chain.ts:273
getContractsByCodeIds<C>(ids): Promise<Record<string, Record<string, InstanceType<C>>>>
Type Parameters
- C extends typeof Chain.Contract
Parameters
- ids: Record<string, C>
Returns Promise<Record<string, Record<string, InstanceType<C>>>>
Inherited from Connection.getContractsByCodeIds
- Defined in agent/chain.ts:275

getLabel

getLabel(address): Promise<string>
Stargate implementation of getting a contract label.
Parameters
- address: string
Returns Promise<string>
- Defined in cw/cw-connection.ts:118

instantiate

instantiate(contract, options): Promise<ContractInstance & {
address: string;
}>
Instantiate a new program from a code id, label and init message.
Parameters
- contract: string | Partial<UploadedCode>
- options: Partial<ContractInstance>
Returns Promise<ContractInstance & {
address: string;
}>
Deploy.ContractInstance with no address populated yet. This will be populated after executing the batch.
Example
```
await agent.instantiate(template.define({ label, initMsg })
```
Inherited from Connection.instantiate
- Defined in agent/chain.ts:463

query

query<Q>(contract, message): Promise<Q>
Query a contract.
Type Parameters
- Q
Parameters
- contract: string | {
  address: string;
  }
- message: Message
Returns Promise<Q>
Inherited from Connection.query
- Defined in agent/chain.ts:361

send

send(recipient, amounts, options?): Promise<unknown>
Send native tokens to 1 recipient.
Parameters
- recipient: string | {
  address?: string;
  }
- amounts: (ICoin | Amount)[]
- Optional options: {
  sendFee?: IFee;
  sendMemo?: string;
  }
  - Optional sendFee?: IFee
  - Optional sendMemo?: string
Returns Promise<unknown>
Inherited from Connection.send
- Defined in agent/chain.ts:377

upload

upload(code, options?): Promise<UploadedCode & {
chainId: string;
codeId: string;
}>
Upload a contract's code, generating a new code id/hash pair.
Parameters
- code: string | Uint8Array | URL | Partial<CompiledCode>
- options: {
      reupload?: boolean;
      uploadFee?: ICoin[] | "auto";
      uploadMemo?: string;
      uploadStore?: UploadStore;
  } = {}
  - Optional reupload?: boolean
  - Optional uploadFee?: ICoin[] | "auto"
  - Optional uploadMemo?: string
  - Optional uploadStore?: UploadStore
Returns Promise<UploadedCode & {
chainId: string;
codeId: string;
}>
Inherited from Connection.upload
- Defined in agent/chain.ts:409

`Static` gas

gas(amount): Amount
Native token of chain.
Parameters
- amount: string | number
Returns Amount
Inherited from Connection.gas
- Defined in agent/chain.ts:86

Class CWConnection

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

properties: Partial<CWConnection>

Returns CWConnection

Properties

alive

api

Optional bech32Prefix

blockInterval

Optional chainId

Optional coinType

Optional fees

Type declaration

Optional exec?: IFee

Optional init?: IFee

Optional send?: IFee

Optional upload?: IFee

Optional hdAccountIndex

identity

log

Optional url

Static gasToken

Accessors

[toStringTag]

Returns string

address

Returns string

balance

Returns Promise<unknown>

defaultDenom

Returns string

height

Returns Promise<number>

nextBlock

Returns Promise<number>

Methods

batch

Returns Chain.Batch<CWConnection>

doExecute

Parameters

contract: { address: string; }

address: string

message: Message

__namedParameters: Omit<{ execFee?: IFee; execMemo?: string; execSend?: ICoin[]; }, "execFee"> & { execFee?: number | IFee | "auto"; } = {}

Returns Promise<unknown>

doGetBalance

Parameters

token: string = ...

address: string = ...

Returns Promise<string>

doGetBlockInfo

Returns Promise<Block>

doGetCodeHashOfAddress

Parameters

address: string

Returns Promise<string>

doGetCodeHashOfCodeId

Parameters

codeId: string

Returns Promise<string>

doGetCodeId

Parameters

address: string

Returns Promise<string>

doGetCodes

Returns Promise<Record<string, UploadedCode>>

doGetContractsByCodeId

Parameters

id: string

Returns Promise<Iterable<{ address: string; }>>

doGetHeight

Returns Promise<number>

`Optional` bech32Prefix

`Optional` chainId

`Optional` coinType

`Optional` fees

`Optional` exec?: IFee

`Optional` init?: IFee

`Optional` send?: IFee

`Optional` upload?: IFee

`Optional` hdAccountIndex

`Optional` url

`Static` gasToken

contract: {
address: string;
}

__namedParameters: Omit<{
execFee?: IFee;
execMemo?: string;
execSend?: ICoin[];
}, "execFee"> & {
execFee?: number | IFee | "auto";
} = {}

Returns Promise<Iterable<{
address: string;
}>>

contract: string | {
address: string;
}

`Optional` options: {
sendFee?: IFee;
sendMemo?: string;
}

`Optional` sendFee?: IFee

`Optional` sendMemo?: string

`Optional` options: unknown

`Optional` options: {
execFee?: IFee;
execMemo?: string;
execSend?: ICoin[];
}

`Optional` execFee?: IFee

`Optional` execMemo?: string

`Optional` execSend?: ICoin[]

`Optional` address: string | {
address: string;
}

address: string | {
address: string;
}

`Optional` token: string

contract: string | {
address: string;
}

contract: string | {
codeId: string;
}

contract: string | {
address: string;
}

options: string | {
address: string;
}