πŸͺœThe Circles Stack

Developers Hub for building with Circles.

Building on the Circles protocol

Our developer documentation portal provides comprehensive guides, API references, and code examples to help you integrate Circles into your applications and build upon our ecosystem.

Contracts

Depending on what you want to achieve, you'll might want to use the contracts directly from solidity. In this case you can check out the source code on GitHub. For Circles v2 there is an a reference available.

Deployments

SDK

If you want to develop a server or client application that utilizes Circles, you can check out the SDK and just keep reading (This documentation pages are mostly about the SDK).

The SDK allows you to seamlessly use all features of Circles v1 and Circles v2. These include:

  • Signing up as a human, organisation, or group

  • Trusting, minting, and transferring personal and group Circles

  • Querying balances, trust relations, and transaction histories

  • Subscribing to and querying events

Infrastructure

Circles relies on some infrastructure components to make it work. Most importantly:

  • Pathfinder - Finds liquid paths between two accounts in the trust network. These are used as input for the contract's transfer methods.

  • Circles Nethermind plug-in - Provides access to the Gnosis Chain and indexes Circles events.

Join the Technical Community

To collaborate with fellow developers, ask questions, and share your insights, join our technical community channels on Discord, GitHub, and other platforms.

Last updated