Gear Ecosystem Contracts

This workspace contains reference implementations of standardized contracts & examples of contracts. More information about them & setting the environment up can be found on Gear Wiki.

Supported operating systems

Linux
The building and the test passing is fully supported & checked by CI.

macOS
The building and the test passing should work, but the workspace doesn't support the node downloading by cargo xtask. Not checked by CI.

Windows
Not supported.

Usage

The workspace consists of mainly contracts & a few libraries. Some of them have a clickable title in README.md, this means they have an article on Gear Wiki.

Above the title, there are clickable badges:

• opens a Gitpod workspace in your browser with the set up environment to play with code.
• opens the portal with generated documentation from the workspace.
  Note that it's built from the latest commit on the master branch. Therefore, when using the stable pre-built binaries, it's better to refer to the documentation from the corresponding stable release commit.

🏗️ Build all contract & states

cargo b

✅ Build & run tests

Run all tests, except gclient ones:

cargo t -- --skip gclient

Run all tests:

# Download the node binary.
cargo xtask node
cargo t

🚀 Run CI locally (should be done before a commit)

cargo xtask ci

Versioning & backwards compatibility

The workspace has the same version as the latest stable release of the Gear runtime, so there's no backwards compatibility, and it's recommended to be ready for any breaking change & always use the latest version.