Circles Documentation
  • Welcome to Circles
  • Overview
    • Understanding Personal and Group Currencies
      • Personal Currencies
      • Group Currencies
    • Why Build on Circles?
    • Circles Architecture
  • Developer Docs
    • The Circles Stack
    • Circles SDK Overview
    • Getting started with the SDK
    • Building with different Circles Avatars
      • Setting Circles Profiles
      • Personal / Human Avatars
        • Inviting and accepting human avatars
        • Mint personal tokens
        • Handle profile of an avatar
        • Manage trust connections
        • Get token balances of an avatar
        • Transfer personal Circles tokens to different avatar
      • Group Avatars
        • Creation of groups
        • Mint group tokens
        • Managing group invites
        • Find groups and memberships
        • Getting total supply of group tokens available
      • Organization Avatars
        • Creation of Organizations
  • Tutorials and Examples
    • Setting up Circles SDK with React
  • Querying Circles profiles and data
    • Query Circles Data
    • Subscribing to Avatar events
    • Utilising CirclesQuery Class
    • Query Circles profiles
  • Circles SDK Reference
    • Circles SDK interface
    • SDK Methods
    • Circles Data Methods
    • Circles Events Types
  • Developer Support
    • Glossary
    • Past Hackathon Projects on Circles
Powered by GitBook
On this page
  • Circles SDK
  • Circles Infrastructure
  • Circles Hub Contracts
  • Join the Technical Community

Was this helpful?

Export as PDF
  1. Developer Docs

The Circles Stack

Developers Hub for building with Circles.

PreviousCircles ArchitectureNextCircles SDK Overview

Last updated 7 days ago

Was this helpful?

Our developer documentation portal provides comprehensive guide to build using Circles SDK, 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

Circles Infrastructure

Circles Hub Contracts

Circles relies on hub contracts for V1 and V2 that you can utilize directly within applications. These deployed contracts exist on Gnosis Chain and are required by the SDK for configuration and initialization.

Here are the deployed addresses for V1 hub and V2 hub that you should consider for configuration or building tools on Circles protocol:

Contract Name
Deployed addresses

V1 hub contract

0x29b9a7fbb8995b2423a71cc17cf9810798f6c543

V2 hub contract

0xc12C1E50ABB450d6205Ea2C3Fa861b3B834d13e8

Name registry

0xA27566fD89162cC3D40Cb59c87AAaA49B85F3474

Migration contract

0xD44B8dcFBaDfC78EA64c55B705BFc68199B56376

Base mint policy

0xcCa27c26CF7BAC2a9928f42201d48220F0e3a549

If you want to skip directly to setting up Circles SDK in your application, you can jump to the SDK Configuration Guide which covers all the setup parameters.

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.

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

Getting started with the SDK

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 V2 contract source code

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

Circles V2 Reference docs

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

https://github.com/circlesubi/circles-contracts/
https://github.com/aboutcircles/circles-contracts-v2
https://aboutcircles.github.io/circles-contracts-v2/