Practical overview
When it fits
Use it when building Ethereum applications that need Circles token deployment, trust-graph connections or transitive token transfers.
Who it is for
- Developers building clients that invoke Circles Hub signup, trust or transitive transaction methods.
- Teams creating personal-currency UBI systems or trust-graph-based token exchange applications.
Documented uses
- Deploy a Circles token through the Hub's signup method.
- Create trust connections between accounts within a Hub.
- Support transitive transfers among tokens deployed by the same Hub.
- Develop and run the repository's contract tests on a local blockchain.
Requirements & limits
The project is publicly available on GitHub and identifies its license as AGPL-3.0. The documented package installation requires Node.js version 14.
- Transitive transfers are limited to tokens associated with the same Hub.
- The Hub's system parameters are immutable, and it has no owner.
- Testing uses Truffle, Mocha and Chai with Ganache CLI and a local blockchain.
- The repository is JavaScript-based and licensed under AGPL-3.0.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install Circles Contracts for Node.js development
Install the npm package and its development dependencies.
Before you start
- Node.js version 14
Steps
Install the package with the command below.
npm i @circles/circles-contractsIn a development checkout, run the command below to install the required dependencies.
npm install
Expected outcome
The package is installed, and a development checkout has its dependencies installed.
Guide limitations
- These steps cover installation only; they do not configure a production network or deploy contracts.
Run the repository's contract tests
Rebuild the contracts and tests, then run the project's JavaScript test suite.
Before you start
- Node.js version 14
- A development checkout with dependencies installed
Steps
Run the command below to install required dependencies.
npm installRun the command below to rebuild the contracts and tests and execute the tests in the test directory.
npm test
Expected outcome
The documented test suite runs against a local blockchain started by Ganache CLI, unless one is already running.
Guide limitations
- The described test setup uses a local chain and does not document production deployment.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 9 October 2026
- Original website title
- CirclesUBI/circles-contracts · Official homepage title · retained in its source language

