Crates.io | ic-cdk |
lib.rs | ic-cdk |
version | 0.18.0-alpha.1 |
source | src |
created_at | 2020-10-02 18:24:01.329506+00 |
updated_at | 2025-02-26 02:14:38.816815+00 |
description | Canister Developer Kit for the Internet Computer. |
homepage | https://docs.rs/ic-cdk |
repository | https://github.com/dfinity/cdk-rs |
max_upload_size | |
id | 295503 |
size | 270,643 |
Canister Developer Kit for the Internet Computer.
On the Internet Computer, smart contracts come in the form of canisters which are WebAssembly modules.
Canisters expose entry points which can be called both by other canisters and by parties external to the IC.
This library aims to provide a Rust-ergonomic abstraction to implement Canister entry points.
ic-cdk
In Cargo.toml:
[lib]
crate-type = ["cdylib"]
[dependencies]
ic-cdk = "0.18"
candid = "0.10" # required if you want to define Candid data types
Then in Rust source code:
#[ic_cdk::query]
fn hello() -> String {
"world".to_string()
}
This will register a query entry point named hello
.
This library re-exports macros defined in ic-cdk-macros
crate.
The macros fall into two categories:
These macros are directly related to the Internet Computer Specification.
Canister entry points can be async
. The CDK embeds an asynchronous executor. Unfortunately anything tokio
-specific cannot be used.
Use the spawn
function to run more asynchronous functions in
the background. Panics can cause async tasks to cancel partway through; read the documentation for the
futures
module for more information.
Check Generating Candid files for Rust canisters for more details.
The examples repository offers numerous Rust examples demonstrating how to build functional Rust canisters.
For managing larger datasets and multiple data structures in stable memory, consider using the ic-stable-structures
crate. While the ic_cdk::storage::{stable_save, stable_restore}
API is straightforward, it may not be efficient for larger datasets. The ic-stable-structures
crate provides more scalable solutions for such scenarios.