Class Chain

OKP4 chain.

Hierarchy

Base.Chain
- Chain

Index

Constructors

constructor

new Chain(options?): OKP4.Chain
Parameters
- options: Partial<OKP4.Chain> & {
  config?: OKP4.Config;
  } = ...
Returns OKP4.Chain
Overrides Chain.constructor
- Defined in connect/cw/cw-okp4.ts:50

Properties

Agent

Agent: AgentClass<OKP4.Agent>

Default Agent class to use.

`Optional` api

api?: CosmWasmClient

Query-only API handle.

defaultDenom

defaultDenom: string = OKP4Chain.defaultDenom

Default denomination of gas token.

`Optional` devnet

devnet?: DevnetHandle

If this is a devnet, this contains an interface to the devnet container.

id

id: string

The unique chain id.

log

log: Base.Console = ...

Logging handle.

mode

mode: ChainMode

Whether this is mainnet, public testnet, local devnet, or mocknet.

stopped

stopped: boolean = false

Whether this chain is stopped.

url

url: string = ''

The API URL to use.

`Static` Agent

Agent: AgentClass<Agent>

The default Agent subclass to use for interacting with this chain.

`Static` Mode

Mode: typeof ChainMode = ChainMode

Shorthand for the ChainMode enum.

`Static` defaultDenom

defaultDenom: string = 'uknow'

Default denomination of gas token.

`Static` defaultFees

defaultFees: AgentFees = ...

Set permissive fees by default.

`Static` variants

variants: ChainRegistry = ...

Async functions that return Chain instances in different modes. Values for FADROMA_CHAIN environment variable. Populated by @fadroma/connect.

Accessors

[toStringTag]

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

chain

get chain(): this
Return self.

Returns this
Inherited from Chain.chain
- Defined in agent/agent-chain.ts:116

devMode

get devMode(): boolean
Whether this is a devnet or mocknet.

Returns boolean
Inherited from Chain.devMode
- Defined in agent/agent-chain.ts:114

height

get height(): Promise<number>
Get the current block height.

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

isDevnet

get isDevnet(): boolean
Whether this is a devnet.

Returns boolean
Inherited from Chain.isDevnet
- Defined in agent/agent-chain.ts:110

isMainnet

get isMainnet(): boolean
Whether this is a mainnet.

Returns boolean
Inherited from Chain.isMainnet
- Defined in agent/agent-chain.ts:106

isMocknet

get isMocknet(): boolean
Whether this is a mocknet.

Returns boolean
Inherited from Chain.isMocknet
- Defined in agent/agent-chain.ts:112

isTestnet

get isTestnet(): boolean
Whether this is a testnet.

Returns boolean
Inherited from Chain.isTestnet
- Defined in agent/agent-chain.ts:108

nextBlock

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

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

ready

get ready(): Promise<this & {
api: CosmWasmClient;
}>
Async initialization. Populates the api property.

Returns Promise<this & {
api: CosmWasmClient;
}>
Inherited from Chain.ready
- Defined in connect/cw/cw-base.ts:31

Methods

checkHash

checkHash(address, expectedCodeHash?): Promise<string>
Get the code hash of a smart contract.
Parameters
- address: string
- Optional expectedCodeHash: string
Returns Promise<string>
Inherited from Chain.checkHash
- Defined in agent/agent-chain.ts:168

cognitaria

cognitaria(__namedParameters?): Promise<Record<string, Cognitarium>>
Get clients for all Cognitarium instances, keyed by address.
Parameters
- __namedParameters: {
  map: undefined | boolean;
  } = {}
  - map: undefined | boolean
Returns Promise<Record<string, Cognitarium>>
- Defined in connect/cw/cw-okp4.ts:68

getAgent

getAgent(options?): Agent
Get a new instance of the appropriate Agent subclass.
Parameters
- Optional options: Partial<Agent>
Returns Agent
Inherited from Chain.getAgent
- Defined in agent/agent-chain.ts:186
getAgent($A, options?): Agent
Parameters
- $A: AgentClass<Agent>
- Optional options: Partial<Agent>
Returns Agent
Inherited from Chain.getAgent
- Defined in agent/agent-chain.ts:187

getBalance

getBalance(denom, address): Promise<string>
Get the native balance of an address.
Parameters
- denom: string
- address: string
Returns Promise<string>
Inherited from Chain.getBalance
- Defined in agent/agent-chain.ts:148

getCodeId

getCodeId(address): Promise<string>
Get the code id of a smart contract.
Parameters
- address: string
Returns Promise<string>
Inherited from Chain.getCodeId
- Defined in agent/agent-chain.ts:158

getHash

getHash(address): Promise<string>
Get the code hash of a smart contract.
Parameters
- address: string | number
Returns Promise<string>
Inherited from Chain.getHash
- Defined in agent/agent-chain.ts:163

getLabel

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

lawStones

lawStones(__namedParameters?): Promise<Record<string, LawStone>>
Get clients for all Law Stone instances, keyed by address.
Parameters
- __namedParameters: {
  map: undefined | boolean;
  } = {}
  - map: undefined | boolean
Returns Promise<Record<string, LawStone>>
- Defined in connect/cw/cw-okp4.ts:82

objectaria

objectaria(__namedParameters?): Promise<Record<string, Objectarium>>
Get clients for all Objectarium instances, keyed by address.
Parameters
- __namedParameters: {
  map: undefined | boolean;
  } = {}
  - map: undefined | boolean
Returns Promise<Record<string, Objectarium>>
- Defined in connect/cw/cw-okp4.ts:75

query

query<U>(contract, msg): Promise<U>
Query a smart contract.
Type Parameters
- U
Parameters
- contract: Client
- msg: Message
Returns Promise<U>
Inherited from Chain.query
- Defined in agent/agent-chain.ts:153

`Static` devnet

devnet(options?): Chain
Parameters
- options: Partial<Chain> = {}
Returns Chain
a devnet instance of this chain.
Inherited from Chain.devnet
- Defined in agent/agent-chain.ts:209

`Static` gas

gas(amount): Fee
Parameters
- amount: string | number
Returns Fee
Fee in uscrt
- Defined in connect/cw/cw-okp4.ts:34

`Static` mainnet

mainnet(options?): Chain
Parameters
- options: Partial<Chain> = {}
Returns Chain
a mainnet instance of this chain.
Inherited from Chain.mainnet
- Defined in agent/agent-chain.ts:201

`Static` mocknet

mocknet(options?): Mocknet
Parameters
- Optional options: Partial<Mocknet>
Returns Mocknet
a mocknet instance of this chain.
Inherited from Chain.mocknet
- Defined in agent/agent-chain.ts:217

`Static` testnet

testnet(options?): OKP4.Chain
Connect to OKP4 in testnet mode.
Parameters
- options: Partial<OKP4.Chain> = {}
Returns OKP4.Chain
Overrides Chain.testnet
- Defined in connect/cw/cw-okp4.ts:57

Class Chain

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<OKP4.Chain> & { config?: OKP4.Config; } = ...

Returns OKP4.Chain

Properties

Agent

Optional api

defaultDenom

Optional devnet

id

log

mode

stopped

url

Static Agent

Static Mode

Static defaultDenom

Static defaultFees

Static variants

Accessors

[toStringTag]

Returns string

chain

Returns this

devMode

Returns boolean

height

Returns Promise<number>

isDevnet

Returns boolean

isMainnet

Returns boolean

isMocknet

Returns boolean

isTestnet

Returns boolean

nextBlock

Returns Promise<number>

ready

Returns Promise<this & { api: CosmWasmClient; }>

Methods

checkHash

Parameters

address: string

Optional expectedCodeHash: string

Returns Promise<string>

cognitaria

Parameters

__namedParameters: { map: undefined | boolean; } = {}

map: undefined | boolean

Returns Promise<Record<string, Cognitarium>>

getAgent

Parameters

Optional options: Partial<Agent>

Returns Agent

Parameters

$A: AgentClass<Agent>

Optional options: Partial<Agent>

Returns Agent

getBalance

Parameters

denom: string

address: string

Returns Promise<string>

getCodeId

Parameters

address: string

Returns Promise<string>

getHash

Parameters

address: string | number

Returns Promise<string>

options: Partial<OKP4.Chain> & {
config?: OKP4.Config;
} = ...

`Optional` api

`Optional` devnet

`Static` Agent

`Static` Mode

`Static` defaultDenom

`Static` defaultFees

`Static` variants

Returns Promise<this & {
api: CosmWasmClient;
}>

`Optional` expectedCodeHash: string

__namedParameters: {
map: undefined | boolean;
} = {}

`Optional` options: Partial<Agent>

`Optional` options: Partial<Agent>

__namedParameters: {
map: undefined | boolean;
} = {}

__namedParameters: {
map: undefined | boolean;
} = {}

`Static` devnet

`Static` gas

`Static` mainnet

`Static` mocknet

`Optional` options: Partial<Mocknet>

`Static` testnet