IC_Utils

Designed for rapid iteration in IC Canister development projects.

Summary

IcContext provides a context for invoking IC canister objects, facilitating storage and retrieval of object data within the canister.

NatUtils enables rapid generation and conversion of Nat types for natural numbers.

Guard supports locking operations on canisters to prevent data reentry anomalies.

Throws utility class handles exceptions, triggering panic for exceptional instances and returning data results for normal cases.

Details

IcContext

IcContext provides the context for ic canister object invocation, which is used to store the object type and facilitate the user to store and call the object data in canister.

let tll = context::get_mut::<VecDeque<SwapOrder>>();

In this example, an empty VecDeque of type VecDeque is returned if no object of type VecDeque exists in the context, or a stored object if one exists. The returned object is actually a mutable reference, and any user edits to the reference will modify the object.

NatUtils

nat_utils is used for rapidly generating Nat types as natural numbers and performing mutual conversions between different types.

 fstr_to_nat("3.1231313",1_000_000_000_000_000_000f64);

In this example, we are converting numeric characters of type 'str' into Nat numbers with 18-digit precision.

Guard

The tool supports locking operations requested to canister to prevent anomalies caused by data reentry.

//Add Exclusion Lock
let guard = CallerGuard::new(id().clone());
    if guard.is_err() {
    panic!("{}",guard.err().unwrap());
}

Throws

The throws utility class is used to handle exceptions when called, throwing panic when the received instance is an exception and returning data results when normal.

//Exception handling when creating a canister
let (cid, ) = throw(create_canister(CreateCanisterArgument {
        settings: Some(CanisterSettings {
            controllers: Some(vec![id()]),
            compute_allocation: None,
            memory_allocation: None,
            freezing_threshold: None,
        })
    }, 500000000000).await.map_err(|e| "Create Pool failed:".to_string() + &*e.1));

Feature Milestones

Developers continue to enhance this toolchain to support a broader range of application scenarios and to accelerate development efficiency on the IC platform.

• IcContext
• NatUtils
• Guard
• Throws
• LinkedHashMap:The LinkedHashMap is a custom data structure that combines the features of a hash map and a linked list. It maintains a hash map for fast key-value lookups and a linked list to preserve the order of insertion.
• MemoryStorage:A method for managing large objects.
• CommonCanister:A tool that integrates basic canister query interfaces such as cycles querying and memory querying services, serving as the foundational integration for any canister.