UNPKG

@junobuild/admin

Version:

A library for interfacing with admin features of Juno

juno.build

junobuild/juno-js

17 lines (16 loc) • 1.33 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import type { MissionControlParameters } from '../types/actor.types'; import type { UpgradeCodeParams } from '../types/upgrade.types'; /** * Upgrades the Mission Control with the provided WASM module. * @param {Object} params - The parameters for upgrading the Mission Control. * @param {MissionControlParameters} params.missionControl - The Mission Control parameters, including the actor and mission control ID. * @param {Uint8Array} params.wasmModule - The WASM module to be installed during the upgrade. * @param {boolean} [params.preClearChunks] - Optional. Whether to force clearing chunks before uploading a chunked WASM module. Recommended if the WASM exceeds 2MB. * @param {boolean} [params.takeSnapshot=true] - Optional. Whether to take a snapshot before performing the upgrade. Defaults to true. * @param {function} [params.onProgress] - Optional. Callback function to report progress during the upgrade process. * @throws {Error} Will throw an error if the mission control principal is not defined. * @returns {Promise<void>} Resolves when the upgrade process is complete. */ export declare const upgradeMissionControl: ({ missionControl, ...rest }: { missionControl: MissionControlParameters; } & Pick<UpgradeCodeParams, "wasmModule" | "preClearChunks" | "takeSnapshot" | "onProgress">) => Promise<void>;