cdk-rs icon indicating copy to clipboard operation
cdk-rs copied to clipboard

Rust canister development kit for the Internet Computer.

Rust Canister Development Kit

Documentation Crates.io License Downloads CI

Rust CDK provides tools for building Canisters on Internet Computer (IC).

You may be looking for:

If you are looking for a crate to communicate with existing canisters on IC, you may want to check agent-rs.

Introduction

A canister is a WebAssembly (wasm) module that can run on the Internet Computer.

To be a canister, a wasm module should communicate with the execution environment using Canister interfaces (System API).

This repo provides libraries and tools to facilitate developing canisters in Rust.

  • ic-cdk: Bindings of the System API.
  • ic-cdk-macros: Annotate functions with attribute macros to make them exposed public interfaces.
  • ic-cdk-optimizer: A binary tool to reduing size of the compiled wasm module.
  • ic-certified-map: An implementation of map which support certified queries.

Rust CDK in Action

In Cargo.toml:

[lib]
crate-type = ["cdylib"]

[dependencies]
candid = "0.7.16" # this is required if you want to use the `#[import]` macro
ic-cdk = "0.5"
ic-cdk-macros = "0.5"

Then in your rust source code:

#[ic_cdk_macros::query]
fn print() {
    ic_cdk::print("Hello World from DFINITY!");
}

Check tutorial for a detailed guidance.