Please follow the guidelines in the CONTRIBUTING.md document.

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

cargo build

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.

This repo has multiple packages in its Cargo workspace.

Package Name	Links	Description
ic-agent		The ic-agent is a library to talk directly to the Replica.
ic-types		A list of types relevant to talking to the Replica, and building canisters on the Internet Computer.
ic-utils		A library of utilities for managing calls and canisters.
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.