{"id":46523922,"url":"https://github.com/aboutcircles/sdk","last_synced_at":"2026-03-06T20:02:17.395Z","repository":{"id":318670211,"uuid":"1072176719","full_name":"aboutcircles/sdk","owner":"aboutcircles","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-23T18:55:47.000Z","size":1026,"stargazers_count":4,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-02-23T22:56:43.696Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aboutcircles.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-08T11:12:01.000Z","updated_at":"2026-02-23T18:55:50.000Z","dependencies_parsed_at":"2025-10-23T11:24:06.713Z","dependency_job_id":"69f3f340-cddc-4868-a2df-bf7832c408b7","html_url":"https://github.com/aboutcircles/sdk","commit_stats":null,"previous_names":["web3skeptic/sdk-v2","aboutcircles/sdk-v2","aboutcircles/sdk"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/aboutcircles/sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fsdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fsdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fsdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fsdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aboutcircles","download_url":"https://codeload.github.com/aboutcircles/sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aboutcircles%2Fsdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30195543,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T19:07:06.838Z","status":"ssl_error","status_checked_at":"2026-03-06T18:57:34.882Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-06T20:02:16.498Z","updated_at":"2026-03-06T20:02:17.364Z","avatar_url":"https://github.com/aboutcircles.png","language":"TypeScript","funding_links":[],"categories":["SDKs \u0026 Libraries"],"sub_categories":["Developer Demos"],"readme":"# Circles SDK v2\n\nA comprehensive TypeScript SDK for the Circles protocol.\n\n## 📚 API Documentation\n\n**[View Complete API Documentation →](docs/modules.md)**\n\nDetailed API reference with types, classes, and interfaces for all packages.\n\n## 🚀 Quick Start\n\n### Installation\n\n```bash\nbun install\nbun run build\n```\n\n### Basic Usage\n\n**Core SDK - Contract Interaction**\n\n```typescript\nimport { Core } from '@aboutcircles/sdk-core';\n\nconst core = new Core();\n\nconst tx = core.hubV2.groupMint(\n  '0x1234567890123456789012345678901234567890',\n  ['0xRecipient1', '0xRecipient2'],\n  [BigInt(100), BigInt(200)],\n  '0x'\n);\n```\n\n**RPC SDK - Data Queries**\n\n```typescript\nimport { CirclesRpc } from '@aboutcircles/sdk-rpc';\n\nconst rpc = new CirclesRpc('https://rpc.circlesubi.network/');\n\n// Get balance\nconst balance = await rpc.circlesV2.getTotalBalance('0xYourAddress');\n\n// Find transfer path\nconst path = await rpc.circlesV2.findPath({\n  from: '0xSenderAddress',\n  to: '0xRecipientAddress',\n  targetFlow: BigInt(100)\n});\n```\n\n## 📦 Packages\n\n- **[@aboutcircles/sdk](./packages/sdk/)** - Main SDK package\n- **[@aboutcircles/sdk-core](./packages/core/)** - Contract wrappers for direct blockchain interaction\n- **[@aboutcircles/sdk-rpc](./packages/rpc/)** - RPC client for querying Circles data and pathfinding\n- **[@aboutcircles/sdk-types](./packages/types/)** - Shared TypeScript types\n- **[@aboutcircles/sdk-abis](./packages/abis/)** - Contract ABIs\n- **[@aboutcircles/sdk-utils](./packages/utils/)** - Utility functions\n- **[@aboutcircles/sdk-profiles](./packages/profiles/)** - Profile management\n- **[@aboutcircles/sdk-pathfinder](./packages/pathfinder/)** - Transfer pathfinding algorithms\n- **[@aboutcircles/sdk-transfers](./packages/transfers/)** - Transfer operations\n- **[@aboutcircles/sdk-runner](./packages/runner/)** - Transaction execution\n\n## 💡 Examples\n\nExplore comprehensive examples in the [`examples/`](./examples/) directory:\n\n**Core SDK:**\n- [Basic Usage ](./examples/core/01-basic-usage.ts) - Core initialization\n- [HubV2 Operations](./examples/core/02-hubv2-examples.ts) - Contract operations\n- [BaseGroup Management](./examples/core/03-basegroup-examples.ts) - Group creation\n\n**RPC SDK:**\n- [RPC Client](./examples/rpc/01-basic-rpc.ts) - Client configuration\n- [Balance \u0026 Pathfinding](./examples/rpc/02-circlesv2-balance-and-pathfinding.ts)\n- [Trust Relations](./examples/rpc/04-trust-examples.ts)\n- [Avatar Info](./examples/rpc/06-avatar-examples.ts)\n- [Profiles](./examples/rpc/07-profile-examples.ts)\n\n[View all examples →](./examples/README.md)\n\n**Run examples:**\n```bash\nbun run examples                           # All examples\nbun run examples/core/01-basic-usage.ts    # Specific example\n```\n\n## 🛠️ Development\n\n```bash\n# Build\nbun run build              # All packages\nbun run build:core         # Core package\nbun run build:rpc          # RPC package\n\n# Development (watch mode)\nbun run dev               # All packages\nbun run dev:core          # Core package\n\n# Documentation\nbun run docs              # Generate API docs\n\n# Publishing\nbun run publish           # Build and publish all packages\n\n# Clean\nbun run clean             # Remove build artifacts\n```\n\n## 📄 License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutcircles%2Fsdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faboutcircles%2Fsdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faboutcircles%2Fsdk/lists"}