@dfinity/ic-management

ic-management-js

A library for interfacing with Internet Computer (IC) management canister.

Table of contents

• Installation
• Usage
• Features

Installation

You can use ic-management-js by installing it in your project.

npm i @dfinity/ic-management

The bundle needs peer dependencies, be sure that following resources are available in your project as well.

npm i @dfinity/agent @dfinity/candid @dfinity/principal @dfinity/utils

Usage

The features are available through the class ICMgmtCanister. It has to be instantiated with a canister ID.

e.g. fetching a token metadata.

import { ICMgmtCanister } from "@dfinity/ic-management";
import { createAgent } from "@dfinity/utils";

const agent = await createAgent({
  identity,
  host: HOST,
});

const { canisterStatus } = ICMgmtCanister.create({
  agent,
});

const { status, memory_size, ...rest } = await canisterStatus(YOUR_CANISTER_ID);

Features

ic-management-js implements following features:

:factory: ICManagementCanister

Methods

• create
• canisterStatus
• updateSettings

:gear: create

Method	Type
create	(options: ICManagementCanisterOptions) => ICManagementCanister

:gear: canisterStatus

Returns canister details (memory size, status, etc.)

Method	Type
canisterStatus	(canisterId: Principal) => Promise<CanisterStatusResponse>

:gear: updateSettings

Update canister settings

Method	Type
updateSettings	({ canisterId, settings: { controllers, freezingThreshold, memoryAllocation, computeAllocation, }, }: UpdateSettingsParams) => Promise<void>

Resources

• IC Interface Specification