https://github.com/dfinity/cdk-rs
Rust canister development kit for the Internet Computer.
https://github.com/dfinity/cdk-rs
blockchain canister cdk icp internet-computer rust sdk smart-contract
Last synced: 4 days ago
JSON representation
Rust canister development kit for the Internet Computer.
- Host: GitHub
- URL: https://github.com/dfinity/cdk-rs
- Owner: dfinity
- License: apache-2.0
- Created: 2020-05-15T20:54:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T20:26:32.000Z (11 days ago)
- Last Synced: 2025-05-07T21:34:22.634Z (11 days ago)
- Topics: blockchain, canister, cdk, icp, internet-computer, rust, sdk, smart-contract
- Language: Rust
- Homepage:
- Size: 1.7 MB
- Stars: 207
- Watchers: 45
- Forks: 101
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Rust Canister Development Kit
[](https://docs.rs/ic-cdk/)
[](https://crates.io/crates/ic-cdk)
[](https://github.com/dfinity/cdk-rs/blob/main/src/ic-cdk/LICENSE)
[](https://crates.io/crates/ic-cdk)
[](https://github.com/dfinity/cdk-rs/actions/workflows/ci.yml)
**Rust CDK provides tools for building Canisters on Internet Computer (IC).**
You may be looking for:
- [Documentation Site of the Internet Computer](https://internetcomputer.org/docs)
- [Tutorials of Rust CDK](https://internetcomputer.org/docs/current/developer-docs/build/cdks/cdk-rs-dfinity/)
- [Examples](https://github.com/dfinity/cdk-rs/tree/main/examples)
- [`dfx` for managing IC projects](https://github.com/dfinity/sdk)
If you are looking for a crate to communicate with existing canisters on IC,
you may want to check [agent-rs](https://github.com/dfinity/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)](https://internetcomputer.org/docs/current/references/ic-interface-spec/#system-api).
This repo provides libraries and tools to facilitate developing canisters in Rust.
- [`ic0`](src/ic0):
Internet Computer System API binding.
- [`ic-cdk`](src/ic-cdk):
Internet Computer Canister Development Kit.
- [`ic-cdk-bindgen`](src/ic-cdk-bindgen):
Generate Rust bindings from Candid to make inter-canister calls.
- [`ic-cdk-macros`](src/ic-cdk-macros):
Annotate functions with attribute macros to make them exposed public interfaces.
- [`ic-cdk-timers`](src/ic-cdk-timers):
The library implements multiple and periodic timers.
- [`candid-extractor`](src/candid-extractor/):
A CLI tool to extract candid definition from canister WASM.
- [`ic-certified-map`](library/ic-certified-map):
An implementation of map which support *certified queries*.
- [`ic-ledger-types`](library/ic-ledger-types):
Type definitions to communicate with the ICP ledger canister.
## Rust CDK in Action
In Cargo.toml:
```toml
[lib]
crate-type = ["cdylib"]
[dependencies]
ic-cdk = "0.15"
candid = "0.10" # required if you want to define Candid data types
```
Then in Rust source code:
```rust
#[ic_cdk::query]
fn hello() -> String{
"world".to_string()
}
```
Check [tutorial](https://internetcomputer.org/docs/current/developer-docs/build/cdks/cdk-rs-dfinity/rust-quickstart) for a detailed guidance.