Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CanisterStatus

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

You can request a canisters Controllers, ModuleHash, Candid interface, Subnet, or Time, or provide a custom path CanisterStatus.CustomPath and pass arbitrary buffers for valid paths identified in https://internetcomputer.org/docs/current/references/ic-interface-spec.

The primary method for this namespace is CanisterStatus.request

Index

Interfaces

Type Aliases

Functions

Type Aliases

CanisterStatusOptions

CanisterStatusOptions: { agent: HttpAgent; blsVerify?: CreateCertificateOptions["blsVerify"]; canisterId: Principal; paths?: Path[] | Set<Path> }

Type declaration

Path

Path: "time" | "controllers" | "subnet" | "module_hash" | "candid" | MetaData | CustomPath

Pre-configured fields for canister status paths

Status

Status: string | ArrayBuffer | Date | ArrayBuffer[] | Principal[] | SubnetStatus | bigint | null

Types of an entry on the canisterStatus map. An entry of null indicates that the request failed, due to lack of permissions or the result being missing.

StatusMap

StatusMap: Map<Path | string, Status>

SubnetStatus

SubnetStatus: { metrics?: { canister_state_bytes: bigint; consumed_cycles_total: { current: bigint; deleted: bigint }; num_canisters: bigint; update_transactions_total: bigint }; nodeKeys: Map<string, DerEncodedPublicKey>; subnetId: string }

Represents the useful information about a subnet

param subnetId

the principal id of the canister's subnet

param nodeKeys

the keys of the individual nodes in the subnet

Type declaration

  • Optional metrics?: { canister_state_bytes: bigint; consumed_cycles_total: { current: bigint; deleted: bigint }; num_canisters: bigint; update_transactions_total: bigint }
    • canister_state_bytes: bigint
    • consumed_cycles_total: { current: bigint; deleted: bigint }
      • current: bigint
      • deleted: bigint
    • num_canisters: bigint
    • update_transactions_total: bigint
  • nodeKeys: Map<string, DerEncodedPublicKey>
  • subnetId: string

Functions

encodePath

  • encodePath(path: Path, canisterId: Principal): ArrayBuffer[]

fetchNodeKeys

  • fetchNodeKeys(certificate: ArrayBuffer, canisterId: Principal, root_key?: ArrayBuffer | Uint8Array): SubnetStatus

request

  • example

    const status = await canisterStatus({ paths: ['controllers', 'candid'], ...options });

    const controllers = status.get('controllers');

    Parameters

    • options: { agent: HttpAgent; canisterId: Principal; paths?: Set<Path> | Path[] }

      CanisterStatusOptions

      • agent: HttpAgent

        HttpAgent optional authenticated agent to use to make the canister request. Useful for accessing private metadata under icp:private

      • canisterId: Principal

        {@link Principal}

      • Optional paths?: Set<Path> | Path[]

        {@link Path[]}

    Returns Promise<StatusMap>

    object populated with data from the requested paths

Generated using TypeDoc