SubnetStatus

The SubnetStatus utility is used to request structured data directly from the IC public API. This data can be accessed using agent.readSubnetState, but SubnetStatus provides a helpful abstraction with some known paths.

The primary method for this namespace is SubnetStatus.request

Interfaces

SubnetStatusOptions

Defined in: packages/core/src/agent/subnetStatus/index.ts:82

Properties

agent

agent: HttpAgent

Defined in: packages/core/src/agent/subnetStatus/index.ts:91

The agent to use to make the subnet request.

disableCertificateTimeVerification?

optional disableCertificateTimeVerification?: boolean

Defined in: packages/core/src/agent/subnetStatus/index.ts:101

Whether to disable the certificate freshness checks.

Default

false

paths?

optional paths?: Set<Path> | Path[]

Defined in: packages/core/src/agent/subnetStatus/index.ts:96

The paths to request.

Default

[]

subnetId

subnetId: Principal

Defined in: packages/core/src/agent/subnetStatus/index.ts:87

The subnet ID to query. Use IC_ROOT_SUBNET_ID for the IC mainnet root subnet. You can use HttpAgent.getSubnetIdFromCanister to get a subnet ID from a canister.

Type Aliases

Path

Path = "time" | "canisterRanges" | "publicKey" | "nodeKeys" | CustomPath

Defined in: packages/core/src/agent/subnetStatus/index.ts:44

Pre-configured fields for subnet status paths

---

Status

Status = BaseStatus | SubnetNodeKeys | CanisterRanges

Defined in: packages/core/src/agent/subnetStatus/index.ts:39

---

StatusMap

StatusMap = Map<Path | string, Status>

Defined in: packages/core/src/agent/subnetStatus/index.ts:46

---

SubnetStatus

SubnetStatus = BaseSubnetStatus & object

Defined in: packages/core/src/agent/subnetStatus/index.ts:32

Type Declaration

publicKey

publicKey: Uint8Array

The public key of the subnet

Variables

IC_ROOT_SUBNET_ID

const IC_ROOT_SUBNET_ID: Principal

Defined in: packages/core/src/agent/utils/readState.ts:28

The root subnet ID for IC mainnet

Functions

encodePath()

encodePath(path, subnetId): Uint8Array<ArrayBufferLike>[]

Defined in: packages/core/src/agent/subnetStatus/index.ts:214

Encode a path for subnet state queries

Parameters

path

Path

the path to encode

subnetId

Principal

the subnet ID

Returns

Uint8Array<ArrayBufferLike>[]

the encoded path as an array of Uint8Arrays

Deprecated

Use HttpAgent.readState directly with StatePaths instead

---

lookupSubnetInfo()

lookupSubnetInfo(certificate, subnetId): SubnetStatus

Defined in: packages/core/src/agent/subnetStatus/index.ts:182

Fetch subnet info including node keys from a certificate

Parameters

certificate

Uint8Array

the certificate bytes

subnetId

Principal

the subnet ID

Returns

SubnetStatus

SubnetStatus with subnet ID and node keys

---

request()

request(options): Promise<StatusMap>

Defined in: packages/core/src/agent/subnetStatus/index.ts:121

Requests information from a subnet’s read_state endpoint. Can be used to request information about the subnet’s time, canister ranges, public key, node keys, and metrics.

Parameters

options

SubnetStatusOptions

The configuration for the subnet status request.

Returns

Promise<StatusMap>

A map populated with data from the requested paths. Each path is a key in the map, and the value is the data obtained from the certificate for that path.

See

SubnetStatusOptions for detailed options.

Deprecated

Use HttpAgent.readState directly with StatePaths instead. This function will be removed in a future release.

Example

const status = await subnetStatus.request({
  subnetId: IC_ROOT_SUBNET_ID,
  paths: ['time', 'nodeKeys'],
  agent,
});

const time = status.get('time');
const nodeKeys = status.get('nodeKeys');

References

CustomPath

Re-exports CustomPath

---

DecodeStrategy

Re-exports DecodeStrategy