58 releases (38 breaking)
new 0.39.1 | Oct 24, 2024 |
---|---|
0.38.2 | Sep 30, 2024 |
0.37.1 | Jul 25, 2024 |
0.34.0 | Mar 18, 2024 |
0.1.0 | Sep 24, 2020 |
#468 in Magic Beans
20,586 downloads per month
Used in 37 crates
(24 directly)
360KB
7.5K
SLoC
ic-agent
is a simple-to-use library to interact with the Internet Computer
in Rust. It is the backend for dfx
.
Useful links
lib.rs
:
The ic-agent
is a simple-to-use library that enables you to
build applications and interact with the Internet Computer
in Rust. It serves as a Rust-based low-level backend for the
DFINITY Canister Software Development Kit (SDK) and the command-line execution environment
dfx
.
Overview
The ic-agent
is a Rust crate that can connect directly to the Internet
Computer through the Internet Computer protocol (ICP).
The key software components of the ICP are broadly referred to as the
replica.
The agent is designed to be compatible with multiple versions of the replica API, and to expose both low-level APIs for communicating with Internet Computer protocol components like the replica and to provide higher-level APIs for communicating with software applications deployed as canisters.
Example
The following example illustrates how to use the Agent interface to send
a call to an Internet Computer canister that performs network management
operations. In this example, the call to the Internet Computer management
canister (aaaaa-aa
) creates a placeholder for a new canister by
registering a network-specific identifier. The management canister then
returns the result in the form of the textual representation of the canister
identifier to the caller.
# // This test is ignored because it requires an ic to be running. We run these
# // in the ic-ref workflow.
use ic_agent::{Agent, export::Principal};
use candid::{Encode, Decode, CandidType, Nat};
use serde::Deserialize;
#[derive(CandidType)]
struct Argument {
amount: Option<Nat>,
}
#[derive(CandidType, Deserialize)]
struct CreateCanisterResult {
canister_id: Principal,
}
# fn create_identity() -> impl ic_agent::Identity {
# ic_agent::identity::BasicIdentity::from_signing_key(
# ed25519_consensus::SigningKey::new(rand::thread_rng()),
# )
# }
#
async fn create_a_canister() -> Result<Principal, Box<dyn std::error::Error>> {
# let url = format!("http://localhost:{}", option_env!("IC_REF_PORT").unwrap_or("4943"));
let agent = Agent::builder()
.with_url(url)
.with_identity(create_identity())
.build()?;
// Only do the following call when not contacting the IC main net (e.g. a local emulator).
// This is important as the main net public key is static and a rogue network could return
// a different key.
// If you know the root key ahead of time, you can use `agent.set_root_key(root_key);`.
agent.fetch_root_key().await?;
let management_canister_id = Principal::from_text("aaaaa-aa")?;
// Create a call to the management canister to create a new canister ID,
// and wait for a result.
// The effective canister id must belong to the canister ranges of the subnet at which the canister is created.
let effective_canister_id = Principal::from_text("rwlgt-iiaaa-aaaaa-aaaaa-cai").unwrap();
let response = agent.update(&management_canister_id, "provisional_create_canister_with_cycles")
.with_effective_canister_id(effective_canister_id)
.with_arg(Encode!(&Argument { amount: None})?)
.await?;
let result = Decode!(response.as_slice(), CreateCanisterResult)?;
let canister_id: Principal = result.canister_id;
Ok(canister_id)
}
# let mut runtime = tokio::runtime::Runtime::new().unwrap();
# runtime.block_on(async {
let canister_id = create_a_canister().await.unwrap();
eprintln!("{}", canister_id);
# });
For more information about the Agent interface used in this example, see the [Agent] documentation.
References
For an introduction to the Internet Computer and the DFINITY Canister SDK, see the following resources:
The Internet Computer protocol and interface specifications are not publicly available yet. When these specifications are made public and generally available, additional details about the versions supported will be available here.
Dependencies
~13–28MB
~473K SLoC