Struct pocket_ic::PocketIc

pub struct PocketIc {
    pub instance_id: InstanceId,
    /* private fields */
}

Main entry point for interacting with PocketIC.

Fields

instance_id: InstanceId

The unique ID of this PocketIC instance.

Implementations

impl PocketIc

pub fn new() -> Self

Creates a new PocketIC instance with a single application subnet on the server. The server is started if it’s not already running.

pub fn from_config(config: impl Into<ExtendedSubnetConfigSet>) -> Self

Creates a new PocketIC instance with the specified subnet config. The server is started if it’s not already running.

pub fn topology(&self) -> Topology

Returns the topology of the different subnets of this PocketIC instance.

pub fn upload_blob(&self, blob: Vec<u8>, compression: BlobCompression) -> BlobId

Upload and store a binary blob to the PocketIC server.

pub fn set_stable_memory( &self, canister_id: CanisterId, data: Vec<u8>, compression: BlobCompression )

Set stable memory of a canister. Optional GZIP compression can be used for reduced data traffic.

pub fn get_stable_memory(&self, canister_id: CanisterId) -> Vec<u8>

Get stable memory of a canister.

pub fn list_instances() -> Vec<String>

List all instances and their status.

pub fn verify_canister_signature( &self, msg: Vec<u8>, sig: Vec<u8>, pubkey: Vec<u8>, root_pubkey: Vec<u8> ) -> Result<(), String>

Verify a canister signature.

pub fn tick(&self)

Make the IC produce and progress by one block.

pub fn root_key(&self) -> Option<Vec<u8>>

Get the root key of this IC instance. Returns None if the IC has no NNS subnet.

pub fn get_time(&self) -> SystemTime

Get the current time of the IC.

pub fn set_time(&self, time: SystemTime)

Set the current time of the IC, on all subnets.

pub fn advance_time(&self, duration: Duration)

Advance the time on the IC on all subnets by some nanoseconds.

pub fn cycle_balance(&self, canister_id: CanisterId) -> u128

Get the current cycles balance of a canister.

pub fn add_cycles(&self, canister_id: CanisterId, amount: u128) -> u128

Add cycles to a canister. Returns the new balance.

pub fn update_call( &self, canister_id: CanisterId, sender: Principal, method: &str, payload: Vec<u8> ) -> Result<WasmResult, UserError>

Execute an update call on a canister.

pub fn query_call( &self, canister_id: CanisterId, sender: Principal, method: &str, payload: Vec<u8> ) -> Result<WasmResult, UserError>

Execute a query call on a canister.

pub fn canister_status( &self, canister_id: CanisterId, sender: Option<Principal> ) -> Result<CanisterStatusResponse, CallError>

Request a canister’s status.

pub fn create_canister(&self) -> CanisterId

Create a canister with default settings as the anonymous principal.

pub fn create_canister_with_settings( &self, sender: Option<Principal>, settings: Option<CanisterSettings> ) -> CanisterId

Create a canister with optional custom settings and a sender.

pub fn create_canister_with_id( &self, sender: Option<Principal>, settings: Option<CanisterSettings>, canister_id: CanisterId ) -> Result<CanisterId, String>

Creates a canister with a specific canister ID and optional custom settings. Returns an error if the canister ID is already in use. Panics if the canister ID is not contained in any of the subnets.

The canister ID must be contained in the Bitcoin, Fiduciary, II, SNS or NNS subnet range, it is not intended to be used on regular app or system subnets, where it can lead to conflicts on which the function panics.

pub fn create_canister_on_subnet( &self, sender: Option<Principal>, settings: Option<CanisterSettings>, subnet_id: SubnetId ) -> CanisterId

Create a canister on a specific subnet with optional custom settings.

pub fn install_canister( &self, canister_id: CanisterId, wasm_module: Vec<u8>, arg: Vec<u8>, sender: Option<Principal> )

Install a WASM module on an existing canister.

pub fn upgrade_canister( &self, canister_id: CanisterId, wasm_module: Vec<u8>, arg: Vec<u8>, sender: Option<Principal> ) -> Result<(), CallError>

Upgrade a canister with a new WASM module.

pub fn reinstall_canister( &self, canister_id: CanisterId, wasm_module: Vec<u8>, arg: Vec<u8>, sender: Option<Principal> ) -> Result<(), CallError>

Reinstall a canister WASM module.

pub fn set_controllers( &self, canister_id: CanisterId, sender: Option<Principal>, new_controllers: Vec<Principal> ) -> Result<(), CallError>

Set canister’s controllers.

pub fn start_canister( &self, canister_id: CanisterId, sender: Option<Principal> ) -> Result<(), CallError>

Start a canister.

pub fn stop_canister( &self, canister_id: CanisterId, sender: Option<Principal> ) -> Result<(), CallError>

Stop a canister.

pub fn delete_canister( &self, canister_id: CanisterId, sender: Option<Principal> ) -> Result<(), CallError>

Delete a canister.

pub fn canister_exists(&self, canister_id: CanisterId) -> bool

Checks whether the provided canister exists.

pub fn get_subnet(&self, canister_id: CanisterId) -> Option<SubnetId>

Returns the subnet ID of the canister if the canister exists.

Trait Implementations

impl Default for PocketIc

fn default() -> Self

Returns the “default value” for a type.

impl Drop for PocketIc

fn drop(&mut self)

Executes the destructor for this type.