Rustic is a framework for developing canisters on the Internet Computer.
Set environment variable RUSTIC_USER_PAGE_END. This value should NOT change across upgrades!
Once you set the user page range, you can never change it! Make sure to leave enough space for future upgrades. Be reasonable and don't set the value too high either, as you pay storage fees for the entire page range even if empty.
See examples.
The module must be initialized in the init hook of the main application. The rustic module must be initialized first before everything else.
```rust
pub fn init () { rustic::rustic_init();
// init code for your canister
} ```
The module has a post-upgrade method that you must call in your post-upgrade hook. ```rust
pub fn postupgrade () { rustic::rusticpost_upgrade(false, true, false);
// post upgrade code for your canister
} ```
The export-candid allows candid export using the mechanism introduced in ic-cdk v0.11. However due to how this mechanism works, the candid needs to be exported twice, once in your application and once from the Rustic library.
To export the candid from Rustic, use Rustic with the export-candid feature, and comment out ic_cdk::export_candid!() in your main canister to avoid conflicts. Then generate wasm once, and use candid-extractor to extract the candid.
Then to export candid from your main application, disable the export-candid feature, add ic_cdk::export_candid!() to your main canister, compile and extract candid again.
Manually combine the two candid files to get the final candid for your canister.
When using the lifecycle feature (enabled by default), in the post-upgrade hook of the new canister, the lifecycle_on_upgrade method is called via calling rustic::rustic_post_upgrade. For the semver you'll need to specify whether you want a major/minor/patchlevel version bump. If the stable memory layout changed (make sure you test compatibility as this is not checked by rustic), bump the stable memory version. If you bump the major version then the minor/patchlevel are ignored and will be set to start from 0.
Do NOT use the pre-upgrade hook in your application EVER. This feature shall be considered deprecated.
#[update(guard = "only_owner")] pub fn transfer_ownership expands to:
rust
# use candid::Principal;
# use rustic::access_control::only_owner;
// This exported function contains the guard
// #[export_name = "canister_update transfer_ownership"]
fn transfer_ownership_0_() {
ic_cdk::setup();
let r: Result<(), String> = only_owner();
if let Err(e) = r {
ic_cdk::api::call::reject(&e);
return;
}
ic_cdk::spawn(async {
let (new_owner,) = ic_cdk::api::call::arg_data();
let result = transfer_ownership(new_owner);
ic_cdk::api::call::reply(())
});
}
// This internal function does not contain the guard
pub fn transfer_ownership(new_owner: Option<Principal>) {
// implemantation of transfer_ownership
}
In order to have guards that work for both internal and external calls, the rustic-macros crate includes a modifiers macro that works for both internal and external calls.controller that could perform canister upgrades MIT