The Circles Stack

Developers Hub for building with Circles.

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

Circles SDK

If you want to develop a server or client application that utilizes Circles, and allow you to utilize trust connection and personal/group currencies, then Circles SDK would be your entry point. Based on your need, you can pick to develop any avatar post initialization of SDK.

• Circles SDK package on npm

• Circles SDK source code

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

Sign Up

Sign up as a human, organization, or group effortlessly using Circles v1 and Circles v2 features.

Trust, Mint & Transfer

Trust, mint, and transfer personal and group Circles seamlessly.

Query Data

Query balances, trust relations, and transaction histories with ease.

Subscribe & Query Events

Subscribe to and query events within the Circles network.

Circles Infrastructure

Circles relies on some infrastructure components to make it work.

Pathfinder

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

Learn more about Pathfinder

Circles Nethermind Plug-in

Provides access to the Gnosis Chain and indexes Circles events for a seamless experience.

Learn more about Circles Nethermind Plug-in

Contracts

Incase, the circles SDK is not something that you can directly use in your application, you can also utilize the deployed contracts directly. In this case you can check out the source code on GitHub.

Circles V1 contract source code

Review the codebase for Circles Contracts V1, including all core features and specifications related to Hub Contract and minting.

Circles V1 Contract code

Circles V2 Reference docs

Explore the latest updates and functionalities of Circles v2.0 Contracts with detailed documentation.

Circles V2 Reference docs

Circles V2 contract source code

Review the codebase for Circles contracts V2 which follows ERC1155 standard, and manages personal, group and organisation avatars.

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.

Join Telegram Group as a Hacker or a Developer.