https://github.com/dfinity/agent-rs

A collection of libraries and tools for building software around the Internet Computer, in Rust.
https://github.com/dfinity/agent-rs

agent blockchain dfinity icp internet-computer rust

Last synced: 5 days ago
JSON representation

A collection of libraries and tools for building software around the Internet Computer, in Rust.

• Host: GitHub
• URL: https://github.com/dfinity/agent-rs
• Owner: dfinity
• License: apache-2.0
• Created: 2020-07-23T19:53:20.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-25T18:34:46.000Z (13 days ago)
• Last Synced: 2024-10-26T23:53:31.886Z (11 days ago)
• Topics: agent, blockchain, dfinity, icp, internet-computer, rust
• Language: Rust
• Homepage: https://sdk.dfinity.org/
• Size: 2.19 MB
• Stars: 123
• Watchers: 34
• Forks: 76
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-internet-computer - agent-rs - Collection of libraries and tools for interfacing with the IC using Rust. (Client Libraries (Agents) / Rust)

README

        
# DFINITY's Rust Agent Repository

![GitHub Workflow Status](https://github.com/dfinity/agent-rs/workflows/Tests/badge.svg)

## Contributing

Please follow the guidelines in the [CONTRIBUTING.md](.github/CONTRIBUTING.md) document.

## Building

We use `cargo` to build this repo. Make sure you have rust stable installed. To build the repo:

```sh

cargo build

```

## Testing

There are two suites of tests that can be executed from this repo; the regular cargo tests and

the ic-ref tests. In order to run the ic-ref tests, you will need a running local reference

server. If you do not have one, those tests will be ignored.

## Release

To release, increase the version number in all crates and run `cargo build` to update the lock file.

## Packages

This repo has multiple packages in its Cargo workspace.

| Package Name | Links | Description |

|---|---|---|

| `ic-agent` | [![README](https://img.shields.io/badge/-README-green)](https://github.com/dfinity/agent-rs/tree/next/ic-agent) [![DOC](https://img.shields.io/badge/-DOC-blue)](https://docs.rs/ic_agent) | The `ic-agent` is a library to talk directly to the Replica. |  

| `ic-utils` | [![README](https://img.shields.io/badge/-README-green)](https://github.com/dfinity/agent-rs/tree/next/ic-utils) [![DOC](https://img.shields.io/badge/-DOC-blue)](https://docs.rs/ic_utils) | A library of utilities for managing calls and canisters. |  

| `icx` | [![README](https://img.shields.io/badge/-README-green)](https://github.com/dfinity/agent-rs/tree/next/icx) | A command line utility to use the agent. Not meant to be published, only available in this repo for tests. |

| `ref-tests` | | A package that only exists to run the ic-ref tests with the ic-agent as the connection. |