From 728ed56ae403705dd0611172ecb47abfdf296ed3 Mon Sep 17 00:00:00 2001 From: Tobias Leinss Date: Mon, 5 Jan 2026 14:48:02 +0700 Subject: [PATCH 1/5] feat: add referrals service client with store, retrieve, and list methods --- packages/referrals/package.json | 36 +++++++++ packages/referrals/src/index.ts | 8 ++ packages/referrals/src/referrals.ts | 113 ++++++++++++++++++++++++++++ packages/referrals/src/types.ts | 53 +++++++++++++ packages/referrals/tsconfig.json | 12 +++ packages/sdk/package.json | 1 + packages/sdk/src/Sdk.ts | 65 ++++++++++++++++ packages/types/src/config.ts | 2 + 8 files changed, 290 insertions(+) create mode 100644 packages/referrals/package.json create mode 100644 packages/referrals/src/index.ts create mode 100644 packages/referrals/src/referrals.ts create mode 100644 packages/referrals/src/types.ts create mode 100644 packages/referrals/tsconfig.json diff --git a/packages/referrals/package.json b/packages/referrals/package.json new file mode 100644 index 0000000..c7cc90f --- /dev/null +++ b/packages/referrals/package.json @@ -0,0 +1,36 @@ +{ + "name": "@aboutcircles/sdk-referrals", + "version": "0.1.0", + "description": "Referrals service client for Circles SDK - store and retrieve referral links", + "type": "module", + "main": "./dist/index.js", + "types": "./dist/index.d.ts", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "default": "./dist/index.js" + } + }, + "scripts": { + "build": "bun build ./src/index.ts --outdir ./dist --format esm --splitting && tsc --emitDeclarationOnly", + "dev": "tsc --build --watch", + "clean": "rm -rf dist tsconfig.tsbuildinfo" + }, + "files": [ + "dist" + ], + "keywords": [ + "circles", + "referrals", + "invitations", + "sdk" + ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, + "license": "MIT", + "devDependencies": { + "typescript": "^5.0.4" + } +} diff --git a/packages/referrals/src/index.ts b/packages/referrals/src/index.ts new file mode 100644 index 0000000..15e3c1a --- /dev/null +++ b/packages/referrals/src/index.ts @@ -0,0 +1,8 @@ +export { Referrals } from "./referrals.js"; +export type { + ReferralStatus, + ReferralInfo, + Referral, + ReferralList, + ApiError, +} from "./types.js"; diff --git a/packages/referrals/src/referrals.ts b/packages/referrals/src/referrals.ts new file mode 100644 index 0000000..b9db599 --- /dev/null +++ b/packages/referrals/src/referrals.ts @@ -0,0 +1,113 @@ +import type { ReferralInfo, ReferralList, ApiError } from "./types.js"; + +/** + * Referrals service client for storing and retrieving referral links + * + * The referrals backend enables Circles SDK users to invite others via referral links. + * - Store: Save a referral private key with on-chain validation + * - Retrieve: Get referral info by private key (public) + * - List: Get all referrals created by authenticated user + */ +export class Referrals { + /** + * Create a new Referrals client + * + * @param baseUrl - The referrals service base URL (e.g., "https://referrals.circles.example") + * @param getToken - Optional function to get auth token for authenticated endpoints + */ + constructor( + private readonly baseUrl: string, + private readonly getToken?: () => Promise + ) {} + + private getBaseUrl(): string { + return this.baseUrl.endsWith("/") + ? this.baseUrl.slice(0, -1) + : this.baseUrl; + } + + private async getAuthHeaders(): Promise { + if (!this.getToken) { + return { "Content-Type": "application/json" }; + } + + const token = await this.getToken(); + return { + "Content-Type": "application/json", + Authorization: `Bearer ${token}`, + }; + } + + /** + * Store a referral private key + * + * The private key is validated on-chain via ReferralsModule.accounts() to ensure + * the account exists and has not been claimed. The inviter address is self-declared + * for dashboard visibility only - the on-chain indexer captures the true inviter. + * + * @param privateKey - The referral private key (0x-prefixed, 64 hex chars) + * @param inviter - Self-declared inviter address for dashboard visibility + * @throws Error if validation fails or key already exists + */ + async store(privateKey: string, inviter: string): Promise { + const response = await fetch(`${this.getBaseUrl()}/referral/store`, { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ privateKey, inviter }), + }); + + if (!response.ok) { + const error = (await response.json()) as ApiError; + throw new Error(error.error || `Failed to store referral: ${response.statusText}`); + } + } + + /** + * Retrieve referral info by private key + * + * This is a public endpoint - no authentication required. + * Used by invitees to look up who invited them. + * + * @param privateKey - The referral private key + * @returns Referral info including inviter and status + * @throws Error if referral not found or expired + */ + async retrieve(privateKey: string): Promise { + const response = await fetch( + `${this.getBaseUrl()}/referral/retrieve?key=${encodeURIComponent(privateKey)}` + ); + + if (!response.ok) { + const error = (await response.json()) as ApiError; + throw new Error(error.error || `Failed to retrieve referral: ${response.statusText}`); + } + + return response.json() as Promise; + } + + /** + * List all referrals created by the authenticated user + * + * Requires authentication - the user's address is extracted from the JWT token. + * + * @returns List of referrals with their status and metadata + * @throws Error if not authenticated or request fails + */ + async listMine(): Promise { + if (!this.getToken) { + throw new Error("Authentication required to list referrals"); + } + + const headers = await this.getAuthHeaders(); + const response = await fetch(`${this.getBaseUrl()}/referral/my-referrals`, { + headers, + }); + + if (!response.ok) { + const error = (await response.json()) as ApiError; + throw new Error(error.error || `Failed to list referrals: ${response.statusText}`); + } + + return response.json() as Promise; + } +} diff --git a/packages/referrals/src/types.ts b/packages/referrals/src/types.ts new file mode 100644 index 0000000..0c6ef4e --- /dev/null +++ b/packages/referrals/src/types.ts @@ -0,0 +1,53 @@ +/** + * Referral status lifecycle + */ +export type ReferralStatus = "pending" | "confirmed" | "claimed" | "expired"; + +/** + * Referral info returned from retrieve endpoint + */ +export interface ReferralInfo { + /** The inviter's Ethereum address */ + inviter: string; + /** Current status of the referral */ + status: ReferralStatus; + /** The Safe account address (if available) */ + accountAddress?: string; +} + +/** + * Full referral record returned from my-referrals endpoint + */ +export interface Referral { + /** Unique identifier */ + id: string; + /** The referral private key */ + privateKey: string; + /** Current status */ + status: ReferralStatus; + /** The Safe account address */ + accountAddress?: string; + /** When the referral was created */ + createdAt: string; + /** When the account was confirmed on-chain */ + confirmedAt: string | null; + /** When the account was claimed */ + claimedAt: string | null; +} + +/** + * Response from my-referrals endpoint + */ +export interface ReferralList { + /** List of referrals */ + referrals: Referral[]; + /** Total count */ + count: number; +} + +/** + * Error response from API + */ +export interface ApiError { + error: string; +} diff --git a/packages/referrals/tsconfig.json b/packages/referrals/tsconfig.json new file mode 100644 index 0000000..2766962 --- /dev/null +++ b/packages/referrals/tsconfig.json @@ -0,0 +1,12 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "./dist", + "rootDir": "./src", + "composite": true, + "declaration": true, + "declarationMap": true + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "dist"] +} diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 67f5066..9e4db75 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -36,6 +36,7 @@ "@aboutcircles/sdk-core": "*", "@aboutcircles/sdk-rpc": "*", "@aboutcircles/sdk-profiles": "*", + "@aboutcircles/sdk-referrals": "*", "@aboutcircles/sdk-utils": "*", "@aboutcircles/sdk-runner": "*", "@aboutcircles/sdk-pathfinder": "*", diff --git a/packages/sdk/src/Sdk.ts b/packages/sdk/src/Sdk.ts index c6b8a74..9e97e72 100644 --- a/packages/sdk/src/Sdk.ts +++ b/packages/sdk/src/Sdk.ts @@ -11,6 +11,7 @@ import type { import type { GroupTokenHolderRow } from '@aboutcircles/sdk-rpc'; import { circlesConfig, Core, CirclesType, BaseGroupContract } from '@aboutcircles/sdk-core'; import { Profiles } from '@aboutcircles/sdk-profiles'; +import { Referrals } from '@aboutcircles/sdk-referrals'; import { CirclesRpc, PagedQuery } from '@aboutcircles/sdk-rpc'; import { cidV0ToHex } from '@aboutcircles/sdk-utils'; import { HumanAvatar, OrganisationAvatar, BaseGroupAvatar } from './avatars'; @@ -54,6 +55,7 @@ export class Sdk { public readonly core: Core; public readonly rpc: CirclesRpc; private readonly profilesClient: Profiles; + private readonly referralsClient?: Referrals; public readonly data: CirclesData = { getAvatar: async (address: Address): Promise => { @@ -81,6 +83,11 @@ export class Sdk { this.rpc = new CirclesRpc(config.circlesRpcUrl); this.profilesClient = new Profiles(config.profileServiceUrl); + // Initialize referrals client if service URL is configured + if (config.referralsServiceUrl) { + this.referralsClient = new Referrals(config.referralsServiceUrl); + } + // Validate and extract sender address from contract runner if (contractRunner) { if (!contractRunner.sendTransaction) { @@ -456,6 +463,64 @@ export class Sdk { }, }; + /** + * Referral/invitation management methods + * + * The referrals backend enables users to invite others via referral links. + * Requires referralsServiceUrl to be configured in CirclesConfig. + */ + public readonly referrals = { + /** + * Store a referral private key + * + * The private key is validated on-chain via ReferralsModule.accounts() to ensure + * the account exists and has not been claimed. The inviter address is self-declared + * for dashboard visibility only. + * + * @param privateKey - The referral private key (0x-prefixed, 64 hex chars) + * @param inviter - Self-declared inviter address for dashboard visibility + * @throws Error if referrals service not configured or validation fails + */ + store: async (privateKey: string, inviter: Address): Promise => { + if (!this.referralsClient) { + throw SdkError.configError('Referrals service not configured. Set referralsServiceUrl in CirclesConfig.'); + } + return await this.referralsClient.store(privateKey, inviter); + }, + + /** + * Retrieve referral info by private key + * + * This is a public endpoint - no authentication required. + * Used by invitees to look up who invited them. + * + * @param privateKey - The referral private key + * @returns Referral info including inviter and status + * @throws Error if referrals service not configured or referral not found + */ + retrieve: async (privateKey: string) => { + if (!this.referralsClient) { + throw SdkError.configError('Referrals service not configured. Set referralsServiceUrl in CirclesConfig.'); + } + return await this.referralsClient.retrieve(privateKey); + }, + + /** + * List all referrals created by the authenticated user + * + * Requires authentication - must configure a token provider. + * + * @returns List of referrals with their status and metadata + * @throws Error if referrals service not configured or not authenticated + */ + listMine: async () => { + if (!this.referralsClient) { + throw SdkError.configError('Referrals service not configured. Set referralsServiceUrl in CirclesConfig.'); + } + return await this.referralsClient.listMine(); + }, + }; + /** * Token utilities */ diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts index ea8d86e..9936728 100644 --- a/packages/types/src/config.ts +++ b/packages/types/src/config.ts @@ -14,6 +14,8 @@ export interface CirclesConfig { pathfinderUrl: string; /** Profile service URL for user profiles and metadata */ profileServiceUrl: string; + /** Referrals service URL for referral/invitation links (optional) */ + referralsServiceUrl?: string; /** Circles V1 Hub contract address */ v1HubAddress: Address; /** Circles V2 Hub contract address */ From d93c5485243505702cd4737e16431eb294109cdb Mon Sep 17 00:00:00 2001 From: Tobias Leinss Date: Mon, 5 Jan 2026 15:01:25 +0700 Subject: [PATCH 2/5] feat: update bun.lock and package.json for referrals package integration --- bun.lock | 44 +++++++++++++++++++++++++++---------- package.json | 4 +++- packages/sdk/tsconfig.json | 1 + packages/utils/package.json | 1 + tsconfig.json | 1 + 5 files changed, 39 insertions(+), 12 deletions(-) diff --git a/bun.lock b/bun.lock index c9f5eba..6ca6954 100644 --- a/bun.lock +++ b/bun.lock @@ -1,5 +1,6 @@ { "lockfileVersion": 1, + "configVersion": 0, "workspaces": { "": { "devDependencies": { @@ -11,7 +12,7 @@ }, "packages/abis": { "name": "@aboutcircles/sdk-abis", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "abitype": "^1.1.1", }, @@ -21,7 +22,7 @@ }, "packages/core": { "name": "@aboutcircles/sdk-core", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-abis": "*", "@aboutcircles/sdk-types": "*", @@ -37,7 +38,7 @@ }, "packages/pathfinder": { "name": "@aboutcircles/sdk-pathfinder", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-rpc": "*", "@aboutcircles/sdk-types": "*", @@ -50,7 +51,7 @@ }, "packages/profiles": { "name": "@aboutcircles/sdk-profiles", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-types": "*", }, @@ -58,9 +59,16 @@ "typescript": "^5.0.4", }, }, + "packages/referrals": { + "name": "@aboutcircles/sdk-referrals", + "version": "0.1.0", + "devDependencies": { + "typescript": "^5.0.4", + }, + }, "packages/rpc": { "name": "@aboutcircles/sdk-rpc", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-types": "*", "@aboutcircles/sdk-utils": "*", @@ -74,7 +82,7 @@ }, "packages/runner": { "name": "@aboutcircles/sdk-runner", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-types": "*", "@safe-global/protocol-kit": "^5.1.1", @@ -87,11 +95,12 @@ }, "packages/sdk": { "name": "@aboutcircles/sdk", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-core": "*", "@aboutcircles/sdk-pathfinder": "*", "@aboutcircles/sdk-profiles": "*", + "@aboutcircles/sdk-referrals": "*", "@aboutcircles/sdk-rpc": "*", "@aboutcircles/sdk-runner": "*", "@aboutcircles/sdk-transfers": "*", @@ -105,7 +114,7 @@ }, "packages/transfers": { "name": "@aboutcircles/sdk-transfers", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-core": "*", "@aboutcircles/sdk-pathfinder": "*", @@ -120,7 +129,7 @@ }, "packages/types": { "name": "@aboutcircles/sdk-types", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "abitype": "^1.1.1", }, @@ -130,9 +139,10 @@ }, "packages/utils": { "name": "@aboutcircles/sdk-utils", - "version": "0.1.4", + "version": "0.1.5", "dependencies": { "@aboutcircles/sdk-types": "*", + "@noble/hashes": "^2.0.1", "multiformats": "^13.4.1", }, }, @@ -148,6 +158,8 @@ "@aboutcircles/sdk-profiles": ["@aboutcircles/sdk-profiles@workspace:packages/profiles"], + "@aboutcircles/sdk-referrals": ["@aboutcircles/sdk-referrals@workspace:packages/referrals"], + "@aboutcircles/sdk-rpc": ["@aboutcircles/sdk-rpc@workspace:packages/rpc"], "@aboutcircles/sdk-runner": ["@aboutcircles/sdk-runner@workspace:packages/runner"], @@ -222,7 +234,7 @@ "@noble/curves": ["@noble/curves@1.9.1", "", { "dependencies": { "@noble/hashes": "1.8.0" } }, "sha512-k11yZxZg+t+gWvBbIswW0yoJlu8cHOC7dhunwOzoWH/mXGBiYyR4YY6hAEK/3EUs4UpB8la1RfdRpeGsFHkWsA=="], - "@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="], + "@noble/hashes": ["@noble/hashes@2.0.1", "", {}, "sha512-XlOlEbQcE9fmuXxrVTXCTlG2nlRXa9Rj3rr5Ue/+tX+nmkgbX720YHh0VR3hBF9xDvwnb8D2shVGOwNx+ulArw=="], "@peculiar/asn1-schema": ["@peculiar/asn1-schema@2.6.0", "", { "dependencies": { "asn1js": "^3.0.6", "pvtsutils": "^1.3.6", "tslib": "^2.8.1" } }, "sha512-xNLYLBFTBKkCzEZIw842BxytQQATQv+lDTCEMZ8C196iJcJJMBUZxrhSTxLaohMyKK8QlzRNTRkUmanucnDSqg=="], @@ -332,6 +344,16 @@ "@esbuild-kit/core-utils/esbuild": ["esbuild@0.18.20", "", { "optionalDependencies": { "@esbuild/android-arm": "0.18.20", "@esbuild/android-arm64": "0.18.20", "@esbuild/android-x64": "0.18.20", "@esbuild/darwin-arm64": "0.18.20", "@esbuild/darwin-x64": "0.18.20", "@esbuild/freebsd-arm64": "0.18.20", "@esbuild/freebsd-x64": "0.18.20", "@esbuild/linux-arm": "0.18.20", "@esbuild/linux-arm64": "0.18.20", "@esbuild/linux-ia32": "0.18.20", "@esbuild/linux-loong64": "0.18.20", "@esbuild/linux-mips64el": "0.18.20", "@esbuild/linux-ppc64": "0.18.20", "@esbuild/linux-riscv64": "0.18.20", "@esbuild/linux-s390x": "0.18.20", "@esbuild/linux-x64": "0.18.20", "@esbuild/netbsd-x64": "0.18.20", "@esbuild/openbsd-x64": "0.18.20", "@esbuild/sunos-x64": "0.18.20", "@esbuild/win32-arm64": "0.18.20", "@esbuild/win32-ia32": "0.18.20", "@esbuild/win32-x64": "0.18.20" }, "bin": { "esbuild": "bin/esbuild" } }, "sha512-ceqxoedUrcayh7Y7ZX6NdbbDzGROiyVBgC4PriJThBKSVPWnnFHZAkfI1lJT8QFkOwH4qOS2SJkS4wvpGl8BpA=="], + "@noble/curves/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="], + + "@scure/bip32/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="], + + "@scure/bip39/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="], + + "ox/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="], + + "viem/@noble/hashes": ["@noble/hashes@1.8.0", "", {}, "sha512-jCs9ldd7NwzpgXDIf6P3+NrHh9/sD6CQdxHyjQI+h/6rDNo88ypBxxz45UDuZHz9r3tNz7N/VInSVoVdtXEI4A=="], + "viem/abitype": ["abitype@1.1.0", "", { "peerDependencies": { "typescript": ">=5.0.4", "zod": "^3.22.0 || ^4.0.0" }, "optionalPeers": ["typescript", "zod"] }, "sha512-6Vh4HcRxNMLA0puzPjM5GBgT4aAcFGKZzSgAXvuZ27shJP6NEpielTuqbBmZILR5/xd0PizkBGy5hReKz9jl5A=="], "@esbuild-kit/core-utils/esbuild/@esbuild/android-arm": ["@esbuild/android-arm@0.18.20", "", { "os": "android", "cpu": "arm" }, "sha512-fyi7TDI/ijKKNZTUJAQqiG5T7YjJXgnzkURqmGj13C6dCqckZBLdl4h7bkhHt/t0WP+zO9/zwroDvANaOqO5Sw=="], diff --git a/package.json b/package.json index 99fc6d8..275370e 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,8 @@ "version:patch": "bun scripts/bump-version.ts patch", "version:minor": "bun scripts/bump-version.ts minor", "version:major": "bun scripts/bump-version.ts major", - "build": "tsc --build && bun run --filter '@aboutcircles/sdk-types' build && bun run --filter '@aboutcircles/sdk-abis' build && bun run --filter '@aboutcircles/sdk-utils' build && bun run --filter '@aboutcircles/sdk-profiles' build && bun run --filter '@aboutcircles/sdk-core' build && bun run --filter '@aboutcircles/sdk-rpc' build && bun run --filter '@aboutcircles/sdk-pathfinder' build && bun run --filter '@aboutcircles/sdk-transfers' build && bun run --filter '@aboutcircles/sdk' build && bun run --filter '@aboutcircles/sdk-runner' build", + "build": "tsc --build && bun run --filter '@aboutcircles/sdk-types' build && bun run --filter '@aboutcircles/sdk-abis' build && bun run --filter '@aboutcircles/sdk-utils' build && bun run --filter '@aboutcircles/sdk-profiles' build && bun run --filter '@aboutcircles/sdk-referrals' build && bun run --filter '@aboutcircles/sdk-core' build && bun run --filter '@aboutcircles/sdk-rpc' build && bun run --filter '@aboutcircles/sdk-pathfinder' build && bun run --filter '@aboutcircles/sdk-transfers' build && bun run --filter '@aboutcircles/sdk' build && bun run --filter '@aboutcircles/sdk-runner' build", + "build:referrals": "bun run --filter '@aboutcircles/sdk-referrals' build", "build:types": "bun run --filter '@aboutcircles/sdk-types' build", "build:abis": "bun run --filter '@aboutcircles/sdk-abis' build", "build:core": "bun run --filter '@aboutcircles/sdk-core' build", @@ -54,6 +55,7 @@ "packages/runner", "packages/pathfinder", "packages/profiles", + "packages/referrals", "packages/transfers", "packages/sdk" ] diff --git a/packages/sdk/tsconfig.json b/packages/sdk/tsconfig.json index d85ec3f..8399ffd 100644 --- a/packages/sdk/tsconfig.json +++ b/packages/sdk/tsconfig.json @@ -14,6 +14,7 @@ { "path": "../core" }, { "path": "../rpc" }, { "path": "../profiles" }, + { "path": "../referrals" }, { "path": "../utils" }, { "path": "../runner" }, { "path": "../pathfinder" }, diff --git a/packages/utils/package.json b/packages/utils/package.json index 311c0aa..6aef5b2 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -32,6 +32,7 @@ "license": "MIT", "dependencies": { "@aboutcircles/sdk-types": "*", + "@noble/hashes": "^2.0.1", "multiformats": "^13.4.1" } } diff --git a/tsconfig.json b/tsconfig.json index e2a5670..32890b7 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -21,6 +21,7 @@ { "path": "./packages/core" }, { "path": "./packages/rpc" }, { "path": "./packages/profiles" }, + { "path": "./packages/referrals" }, { "path": "./packages/pathfinder" }, { "path": "./packages/transfers" }, { "path": "./packages/sdk" }, From 285d2dce773e77fc6e265ca795c3e33d55a796ec Mon Sep 17 00:00:00 2001 From: Tobias Leinss Date: Mon, 5 Jan 2026 15:03:05 +0700 Subject: [PATCH 3/5] feat: add examples for referrals usage and SDK integration --- examples/referrals/01-basic-usage.ts | 160 +++++++++++++++++++++++ examples/referrals/02-sdk-integration.ts | 132 +++++++++++++++++++ 2 files changed, 292 insertions(+) create mode 100644 examples/referrals/01-basic-usage.ts create mode 100644 examples/referrals/02-sdk-integration.ts diff --git a/examples/referrals/01-basic-usage.ts b/examples/referrals/01-basic-usage.ts new file mode 100644 index 0000000..6d6e1cf --- /dev/null +++ b/examples/referrals/01-basic-usage.ts @@ -0,0 +1,160 @@ +import { Referrals } from '@aboutcircles/sdk-referrals'; +import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts'; + +/** + * Referrals Basic Usage Example + * + * This example demonstrates the referral/invitation workflow: + * 1. Inviter creates a referral link (generates private key) + * 2. Inviter stores the referral in the backend + * 3. Invitee retrieves referral info using the private key + * 4. Inviter can list all their referrals + * + * Backend: https://staging.circlesubi.network/referrals + */ + +const REFERRALS_URL = 'https://staging.circlesubi.network/referrals'; + +// Initialize the Referrals client (no auth needed for store/retrieve) +const referrals = new Referrals(REFERRALS_URL); + +// Example inviter address (replace with actual address in production) +const INVITER_ADDRESS = '0x1234567890123456789012345678901234567890'; + +// Example 1: Generate a referral link +function exampleGenerateReferral() { + console.log('=== Example 1: Generate Referral Link ===\n'); + + // Generate a new private key for the referral + const privateKey = generatePrivateKey(); + const account = privateKeyToAccount(privateKey); + + console.log('Generated referral:'); + console.log('- Private Key:', privateKey); + console.log('- Account Address:', account.address); + console.log('\nShare this private key with your invitee.'); + console.log('They will use it to claim their invitation.\n'); + + return privateKey; +} + +// Example 2: Store a referral in the backend +async function exampleStoreReferral(privateKey: string, inviter: string) { + console.log('=== Example 2: Store Referral ===\n'); + + console.log('Storing referral:'); + console.log('- Private Key:', privateKey.slice(0, 10) + '...'); + console.log('- Inviter:', inviter); + + try { + await referrals.store(privateKey, inviter); + console.log('\n✓ Referral stored successfully!'); + console.log('The backend validated the private key on-chain.'); + } catch (error) { + console.error('\n✗ Failed to store referral:', error); + throw error; + } +} + +// Example 3: Retrieve referral info (what invitee would do) +async function exampleRetrieveReferral(privateKey: string) { + console.log('\n\n=== Example 3: Retrieve Referral (Invitee Flow) ===\n'); + + console.log('Looking up referral with private key...'); + + try { + const info = await referrals.retrieve(privateKey); + + console.log('\n✓ Referral found!'); + console.log('- Inviter:', info.inviter); + console.log('- Status:', info.status); + if (info.accountAddress) { + console.log('- Account Address:', info.accountAddress); + } + + return info; + } catch (error) { + console.error('\n✗ Failed to retrieve referral:', error); + throw error; + } +} + +// Example 4: List all referrals (requires authentication) +async function exampleListMyReferrals() { + console.log('\n\n=== Example 4: List My Referrals (Authenticated) ===\n'); + + // For authenticated endpoints, you need a token provider + const AUTH_URL = 'https://staging.circlesubi.network/auth'; + + // In production, implement proper JWT token fetching + const getAuthToken = async (): Promise => { + // This would typically: + // 1. Sign a message with the user's wallet + // 2. Exchange the signature for a JWT at the auth endpoint + // Example: + // const response = await fetch(`${AUTH_URL}/login`, { ... }); + // return response.json().token; + throw new Error('Implement auth token fetching for your app'); + }; + + const authenticatedClient = new Referrals(REFERRALS_URL, getAuthToken); + + try { + const result = await authenticatedClient.listMine(); + + console.log(`✓ Found ${result.count} referrals:\n`); + + for (const referral of result.referrals) { + console.log(`Referral ${referral.id}:`); + console.log(` - Status: ${referral.status}`); + console.log(` - Created: ${referral.createdAt}`); + if (referral.accountAddress) { + console.log(` - Account: ${referral.accountAddress}`); + } + if (referral.confirmedAt) { + console.log(` - Confirmed: ${referral.confirmedAt}`); + } + if (referral.claimedAt) { + console.log(` - Claimed: ${referral.claimedAt}`); + } + console.log(); + } + + return result; + } catch (error) { + console.error('\n✗ Failed to list referrals:', error); + console.log('(This is expected if auth is not configured)'); + } +} + +// Run examples +async function runExamples() { + try { + // Step 1: Generate a referral (inviter side) + const privateKey = exampleGenerateReferral(); + + // Step 2: Store the referral in backend + // Note: This will fail with a mock address - use a real registered avatar + console.log('Skipping store example (requires real on-chain account)\n'); + // await exampleStoreReferral(privateKey, INVITER_ADDRESS); + + // Step 3: Retrieve referral info (invitee side) + // Note: This will fail without a stored referral + console.log('Skipping retrieve example (no stored referral)\n'); + // await exampleRetrieveReferral(privateKey); + + // Step 4: List my referrals (requires auth) + // await exampleListMyReferrals(); + + console.log('=== Examples Complete ==='); + console.log('\nTo run the full flow:'); + console.log('1. Use a real inviter address with an on-chain account'); + console.log('2. Configure authentication for listMine()'); + } catch (error) { + console.error('\nError running examples:', error); + } +} + +runExamples(); + +export { exampleGenerateReferral, exampleStoreReferral, exampleRetrieveReferral, exampleListMyReferrals }; diff --git a/examples/referrals/02-sdk-integration.ts b/examples/referrals/02-sdk-integration.ts new file mode 100644 index 0000000..88bbad7 --- /dev/null +++ b/examples/referrals/02-sdk-integration.ts @@ -0,0 +1,132 @@ +import { Sdk } from '@aboutcircles/sdk'; +import { circlesConfig } from '@aboutcircles/sdk-core'; +import { generatePrivateKey } from 'viem/accounts'; + +/** + * Referrals SDK Integration Example + * + * This example shows how to use referrals through the main Sdk class + * rather than the standalone Referrals client. + * + * The Sdk provides a unified interface for all Circles operations. + */ + +// Configure with referrals service URL +const config = { + ...circlesConfig[100], // Gnosis Chain + referralsServiceUrl: 'https://staging.circlesubi.network/referrals', +}; + +// Initialize SDK (read-only, no contract runner) +const sdk = new Sdk(config); + +// Example 1: Store a referral via SDK +async function exampleSdkStoreReferral() { + console.log('=== SDK: Store Referral ===\n'); + + const privateKey = generatePrivateKey(); + const inviterAddress = '0x1234567890123456789012345678901234567890'; + + console.log('Generated private key:', privateKey.slice(0, 10) + '...'); + + try { + await sdk.referrals.store(privateKey, inviterAddress); + console.log('✓ Referral stored via SDK'); + return privateKey; + } catch (error) { + console.error('✗ Store failed:', error); + throw error; + } +} + +// Example 2: Retrieve referral via SDK +async function exampleSdkRetrieveReferral(privateKey: string) { + console.log('\n=== SDK: Retrieve Referral ===\n'); + + try { + const info = await sdk.referrals.retrieve(privateKey); + + console.log('✓ Referral info:'); + console.log(' - Inviter:', info.inviter); + console.log(' - Status:', info.status); + + return info; + } catch (error) { + console.error('✗ Retrieve failed:', error); + throw error; + } +} + +// Example 3: Full invitation flow +async function exampleFullInvitationFlow() { + console.log('=== Full Invitation Flow ===\n'); + + // This demonstrates the complete flow an app would implement: + // + // INVITER SIDE: + // 1. Generate a referral private key + // 2. Store it in the backend (validates on-chain) + // 3. Share the private key with invitee (e.g., as URL param) + // + // INVITEE SIDE: + // 4. Receive the private key from invite link + // 5. Retrieve referral info to see who invited them + // 6. Use sdk.register.asHuman() which checks for pending invitations + + console.log('Inviter creates referral:'); + const referralKey = generatePrivateKey(); + console.log('- Generated key:', referralKey.slice(0, 20) + '...'); + + // In a real app, the inviter would be the logged-in user's address + const inviterAddress = '0xInviterSafeAddress' as `0x${string}`; + + console.log('\nInviter stores referral in backend...'); + console.log('(Skipping - requires real on-chain account)\n'); + // await sdk.referrals.store(referralKey, inviterAddress); + + console.log('Invitee receives link and looks up referral...'); + console.log('(Skipping - no stored referral)\n'); + // const info = await sdk.referrals.retrieve(referralKey); + // console.log('Invited by:', info.inviter); + + console.log('Invitee registers using the inviter address...'); + console.log('(Skipping - requires contract runner)\n'); + // const avatar = await sdk.register.asHuman(info.inviter, { name: 'NewUser' }); +} + +// Example 4: Error handling when service not configured +function exampleMissingConfig() { + console.log('=== Error Handling: Missing Config ===\n'); + + // SDK without referrals URL + const sdkNoReferrals = new Sdk(circlesConfig[100]); + + try { + // This will throw because referralsServiceUrl is not set + sdkNoReferrals.referrals.retrieve('0x...'); + } catch (error: any) { + console.log('✓ Expected error:', error.message); + console.log('\nTo fix: Include referralsServiceUrl in your config'); + } +} + +// Run examples +async function runExamples() { + console.log('Referrals SDK Integration Examples\n'); + console.log('Backend:', config.referralsServiceUrl); + console.log('─'.repeat(50) + '\n'); + + // Show error handling for missing config + exampleMissingConfig(); + + console.log('\n'); + + // Show the conceptual flow + await exampleFullInvitationFlow(); + + console.log('=== Examples Complete ==='); +} + +runExamples(); + +export { exampleSdkStoreReferral, exampleSdkRetrieveReferral, exampleFullInvitationFlow }; From 742f4a12897c218e749ca884066797a8946d7647 Mon Sep 17 00:00:00 2001 From: Tobias Leinss Date: Mon, 5 Jan 2026 15:03:13 +0700 Subject: [PATCH 4/5] fix: update return type of getAuthHeaders method to Record --- packages/referrals/src/referrals.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/referrals/src/referrals.ts b/packages/referrals/src/referrals.ts index b9db599..2842ea2 100644 --- a/packages/referrals/src/referrals.ts +++ b/packages/referrals/src/referrals.ts @@ -26,7 +26,7 @@ export class Referrals { : this.baseUrl; } - private async getAuthHeaders(): Promise { + private async getAuthHeaders(): Promise> { if (!this.getToken) { return { "Content-Type": "application/json" }; } From 5232586808662058b4cd95b0412e85650e482b3e Mon Sep 17 00:00:00 2001 From: Tobias Leinss Date: Mon, 5 Jan 2026 15:03:33 +0700 Subject: [PATCH 5/5] chore: update documentation links in error classes and functions - Updated links in ContractError, EncodingError, and ValidationError documentation to reflect the latest commit hash. - Adjusted links for utility functions such as bytesToHex, checksumAddress, and cidV0ToHex to point to the correct lines in the updated codebase. - Added missing documentation links for functions related to error handling and ABI encoding. - Included the referrals package in the TypeDoc configuration for better documentation coverage. --- docs/_media/abis/package.json | 7 +- docs/_media/abis/src/index.ts | 2 + docs/_media/abis/src/invitationFarm.ts | 532 +++++++++++++ docs/_media/abis/src/referralsModule.ts | 486 ++++++++++++ docs/_media/core/package.json | 7 +- docs/_media/core/src/config.ts | 4 +- docs/_media/core/src/contracts/index.ts | 2 + .../core/src/contracts/invitationFarm.ts | 119 +++ .../core/src/contracts/referralsModule.ts | 258 ++++++ docs/_media/core/src/core.ts | 14 +- docs/_media/examples/profiles/02-check-cid.ts | 105 --- .../examples/referrals/01-basic-usage.ts | 160 ++++ .../examples/referrals/02-sdk-integration.ts | 132 ++++ docs/_media/examples/rpc/10-group-queries.ts | 35 +- .../examples/rpc/13-pagination-examples.ts | 145 ---- .../examples/rpc/14-check-avatar-info.ts | 265 ------- .../runner/example-trust-zero-address.ts | 159 ---- docs/_media/examples/sdk/error-handling.ts | 206 ----- .../examples/sdk/events-subscription.ts | 60 -- docs/_media/examples/sdk/example-avatar.ts | 95 --- docs/_media/examples/sdk/example-profile.ts | 95 --- .../examples/sdk/example-register-group.ts | 97 --- .../examples/sdk/example-register-org.ts | 58 -- docs/_media/examples/sdk/human-avatar.ts | 54 -- docs/_media/examples/sdk/invite-test.ts | 88 --- .../examples/sdk/personal-token-mintable.ts | 72 -- docs/_media/examples/sdk/test-replenish.ts | 45 -- docs/_media/examples/sdk/test-wrapper.ts | 16 - .../examples/sdk/transfer-builder-example.ts | 197 ----- docs/_media/examples/sdk/transfer-test.ts | 78 -- docs/_media/modules.md | 1 + docs/_media/pathfinder/package.json | 6 +- docs/_media/profiles/package.json | 6 +- docs/_media/rpc/package.json | 7 +- docs/_media/rpc/src/utils.ts | 6 +- docs/_media/runner/package.json | 6 +- docs/_media/sdk/README.md | 41 +- docs/_media/sdk/package.json | 9 +- docs/_media/sdk/src/Sdk.ts | 90 ++- docs/_media/sdk/src/avatars/CommonAvatar.ts | 25 +- docs/_media/sdk/src/avatars/HumanAvatar.ts | 137 +++- docs/_media/sdk/tsconfig.json | 1 + docs/_media/transfers/package.json | 8 +- .../transfers/src/TransferBuilder.test.ts | 598 -------------- docs/_media/types/package.json | 6 +- docs/_media/types/src/config.ts | 6 + docs/_media/types/src/index.ts | 1 + docs/_media/types/src/pathfinding.ts | 9 + docs/_media/utils/package.json | 7 +- docs/abis/src/README.md | 2 + docs/abis/src/variables/baseGroupAbi.md | 2 +- .../abis/src/variables/baseGroupFactoryAbi.md | 2 +- .../abis/src/variables/demurrageCirclesAbi.md | 2 +- docs/abis/src/variables/hubV2Abi.md | 2 +- .../src/variables/inflationaryCirclesAbi.md | 2 +- .../abis/src/variables/invitationEscrowAbi.md | 2 +- docs/abis/src/variables/invitationFarmAbi.md | 420 ++++++++++ docs/abis/src/variables/liftERC20Abi.md | 2 +- docs/abis/src/variables/nameRegistryAbi.md | 2 +- docs/abis/src/variables/referralsModuleAbi.md | 385 +++++++++ docs/core/src/README.md | 2 + docs/core/src/classes/BaseGroupContract.md | 48 +- .../src/classes/BaseGroupFactoryContract.md | 18 +- docs/core/src/classes/Contract.md | 16 +- docs/core/src/classes/ContractError.md | 16 +- docs/core/src/classes/Core.md | 38 +- .../src/classes/DemurrageCirclesContract.md | 74 +- docs/core/src/classes/HubV2Contract.md | 66 +- .../classes/InflationaryCirclesContract.md | 70 +- .../src/classes/InvitationEscrowContract.md | 26 +- .../src/classes/InvitationFarmContract.md | 427 ++++++++++ docs/core/src/classes/LiftERC20Contract.md | 26 +- docs/core/src/classes/NameRegistryContract.md | 58 +- docs/core/src/classes/NetworkError.md | 10 +- .../src/classes/ReferralsModuleContract.md | 745 ++++++++++++++++++ docs/core/src/type-aliases/CoreErrorSource.md | 2 +- docs/core/src/variables/circlesConfig.md | 2 +- docs/modules.md | 1 + .../functions/assertNoNettedFlowMismatch.md | 2 +- .../src/functions/computeNettedFlow.md | 2 +- .../src/functions/createFlowMatrix.md | 2 +- .../getExpectedUnwrappedTokenTotals.md | 2 +- .../src/functions/getTokenInfoMapFromPath.md | 2 +- .../src/functions/getWrappedTokensFromPath.md | 2 +- .../src/functions/packCoordinates.md | 2 +- .../src/functions/replaceWrappedTokens.md | 2 +- .../replaceWrappedTokensWithAvatars.md | 2 +- .../src/functions/shrinkPathValues.md | 2 +- .../src/functions/transformToFlowVertices.md | 2 +- docs/profiles/src/classes/Profiles.md | 8 +- docs/referrals/src/README.md | 22 + docs/referrals/src/classes/Referrals.md | 141 ++++ docs/referrals/src/interfaces/ApiError.md | 21 + docs/referrals/src/interfaces/Referral.md | 95 +++ docs/referrals/src/interfaces/ReferralInfo.md | 47 ++ docs/referrals/src/interfaces/ReferralList.md | 35 + .../src/type-aliases/ReferralStatus.md | 15 + docs/rpc/src/classes/AvatarMethods.md | 10 +- docs/rpc/src/classes/BalanceMethods.md | 8 +- docs/rpc/src/classes/CirclesRpc.md | 30 +- docs/rpc/src/classes/GroupMethods.md | 14 +- docs/rpc/src/classes/InvitationMethods.md | 10 +- docs/rpc/src/classes/Observable.md | 10 +- docs/rpc/src/classes/PagedQuery.md | 10 +- docs/rpc/src/classes/PathfinderMethods.md | 8 +- docs/rpc/src/classes/ProfileMethods.md | 16 +- docs/rpc/src/classes/QueryMethods.md | 10 +- docs/rpc/src/classes/RpcClient.md | 12 +- docs/rpc/src/classes/RpcError.md | 14 +- docs/rpc/src/classes/TokenMethods.md | 10 +- docs/rpc/src/classes/TransactionMethods.md | 6 +- docs/rpc/src/classes/TrustMethods.md | 16 +- docs/rpc/src/functions/isCirclesEvent.md | 2 +- docs/rpc/src/functions/normalizeAddress.md | 2 +- docs/rpc/src/functions/normalizeAddresses.md | 2 +- docs/rpc/src/functions/parseRpcEvent.md | 2 +- .../functions/parseRpcSubscriptionMessage.md | 2 +- .../rpc/src/functions/parseStringsToBigInt.md | 2 +- docs/rpc/src/interfaces/CursorColumn.md | 8 +- .../rpc/src/interfaces/FlexiblePagedResult.md | 16 +- .../rpc/src/interfaces/GroupTokenHolderRow.md | 12 +- .../rpc/src/interfaces/SearchResultProfile.md | 26 +- .../src/interfaces/TransactionHistoryRow.md | 36 +- docs/rpc/src/type-aliases/RpcErrorSource.md | 2 +- docs/runner/src/classes/RunnerError.md | 18 +- docs/runner/src/classes/SafeBatchRun.md | 10 +- .../runner/src/classes/SafeBrowserBatchRun.md | 10 +- docs/runner/src/classes/SafeBrowserRunner.md | 22 +- docs/runner/src/classes/SafeContractRunner.md | 22 +- .../src/type-aliases/RunnerErrorSource.md | 2 +- docs/sdk/src/classes/BaseGroupAvatar.md | 53 +- docs/sdk/src/classes/HumanAvatar.md | 116 ++- docs/sdk/src/classes/OrganisationAvatar.md | 53 +- docs/sdk/src/classes/Sdk.md | 135 +++- docs/sdk/src/classes/SdkError.md | 26 +- docs/sdk/src/interfaces/CirclesData.md | 8 +- docs/sdk/src/type-aliases/Avatar.md | 2 +- .../src/type-aliases/PathfindingOptions.md | 2 +- docs/sdk/src/type-aliases/SdkErrorSource.md | 2 +- docs/transfers/src/classes/TransferBuilder.md | 8 +- docs/transfers/src/classes/TransferError.md | 16 +- .../src/type-aliases/TransfersErrorSource.md | 2 +- docs/types/src/README.md | 1 + docs/types/src/enumerations/CirclesType.md | 6 +- docs/types/src/enumerations/GroupType.md | 6 +- .../src/interfaces/AdvancedTransferOptions.md | 32 +- .../src/interfaces/AggregatedTrustRelation.md | 10 +- docs/types/src/interfaces/AvatarInfo.md | 36 +- docs/types/src/interfaces/AvatarRow.md | 10 +- docs/types/src/interfaces/BatchRun.md | 6 +- docs/types/src/interfaces/CallResult.md | 8 +- docs/types/src/interfaces/CirclesConfig.md | 62 +- docs/types/src/interfaces/CirclesQuery.md | 8 +- .../src/interfaces/CirclesQueryResponse.md | 6 +- docs/types/src/interfaces/Conjunction.md | 8 +- docs/types/src/interfaces/ContractConfig.md | 6 +- docs/types/src/interfaces/ContractRunner.md | 18 +- docs/types/src/interfaces/Cursor.md | 12 +- .../src/interfaces/DecodedContractError.md | 12 +- .../src/interfaces/EscrowedAmountAndDays.md | 6 +- docs/types/src/interfaces/EventRow.md | 12 +- docs/types/src/interfaces/FilterPredicate.md | 10 +- docs/types/src/interfaces/FindPathParams.md | 32 +- docs/types/src/interfaces/FlowEdgeStruct.md | 6 +- docs/types/src/interfaces/FlowMatrix.md | 12 +- .../src/interfaces/GroupMembershipRow.md | 18 +- docs/types/src/interfaces/GroupProfile.md | 18 +- docs/types/src/interfaces/GroupQueryParams.md | 16 +- docs/types/src/interfaces/GroupRow.md | 40 +- docs/types/src/interfaces/JsonRpcRequest.md | 10 +- docs/types/src/interfaces/JsonRpcResponse.md | 10 +- docs/types/src/interfaces/NetworkSnapshot.md | 10 +- docs/types/src/interfaces/OrderBy.md | 6 +- docs/types/src/interfaces/PagedQueryParams.md | 14 +- docs/types/src/interfaces/PagedResult.md | 16 +- .../types/src/interfaces/PathfindingResult.md | 6 +- docs/types/src/interfaces/Profile.md | 16 +- docs/types/src/interfaces/QueryParams.md | 14 +- docs/types/src/interfaces/QueryResponse.md | 6 +- docs/types/src/interfaces/SimulatedBalance.md | 12 +- docs/types/src/interfaces/SimulatedTrust.md | 31 + docs/types/src/interfaces/StreamStruct.md | 8 +- docs/types/src/interfaces/TableInfo.md | 8 +- docs/types/src/interfaces/TokenBalance.md | 34 +- docs/types/src/interfaces/TokenBalanceRow.md | 6 +- docs/types/src/interfaces/TokenHolder.md | 8 +- docs/types/src/interfaces/TokenInfo.md | 22 +- .../src/interfaces/TransactionRequest.md | 16 +- docs/types/src/interfaces/TransferStep.md | 10 +- docs/types/src/interfaces/TrustRelation.md | 18 +- docs/types/src/interfaces/TrustRelationRow.md | 8 +- docs/types/src/type-aliases/Address.md | 2 +- .../src/type-aliases/CirclesBaseEvent.md | 12 +- docs/types/src/type-aliases/CirclesEvent.md | 2 +- .../src/type-aliases/CirclesEventOfType.md | 2 +- .../src/type-aliases/CirclesEventType.md | 2 +- .../types/src/type-aliases/ConjunctionType.md | 2 +- docs/types/src/type-aliases/EventType.md | 2 +- docs/types/src/type-aliases/Filter.md | 2 +- docs/types/src/type-aliases/FilterType.md | 2 +- docs/types/src/type-aliases/Hash.md | 2 +- docs/types/src/type-aliases/Hex.md | 2 +- .../src/type-aliases/RpcSubscriptionEvent.md | 6 +- docs/types/src/type-aliases/SortOrder.md | 2 +- .../src/type-aliases/TrustRelationType.md | 2 +- .../src/type-aliases/WrappedTokenInfo.md | 6 +- .../src/type-aliases/WrappedTokensRecord.md | 2 +- docs/utils/src/classes/CirclesConverter.md | 56 +- docs/utils/src/classes/CirclesError.md | 18 +- docs/utils/src/classes/ContractError.md | 22 +- docs/utils/src/classes/EncodingError.md | 22 +- docs/utils/src/classes/ValidationError.md | 26 +- docs/utils/src/functions/bytesToHex.md | 2 +- docs/utils/src/functions/checksumAddress.md | 2 +- docs/utils/src/functions/cidV0ToHex.md | 2 +- docs/utils/src/functions/cidV0ToUint8Array.md | 2 +- docs/utils/src/functions/decodeErrorResult.md | 2 +- .../src/functions/decodeFunctionResult.md | 2 +- .../utils/src/functions/encodeFunctionData.md | 2 +- docs/utils/src/functions/getErrorMessage.md | 2 +- docs/utils/src/functions/isCirclesError.md | 2 +- .../utils/src/functions/parseContractError.md | 2 +- docs/utils/src/functions/uint256ToAddress.md | 2 +- docs/utils/src/functions/wrapError.md | 2 +- .../utils/src/type-aliases/BaseErrorSource.md | 2 +- .../src/type-aliases/UtilsErrorSource.md | 2 +- docs/utils/src/variables/ZERO_ADDRESS.md | 2 +- typedoc.json | 1 + 228 files changed, 5692 insertions(+), 3479 deletions(-) create mode 100644 docs/_media/abis/src/invitationFarm.ts create mode 100644 docs/_media/abis/src/referralsModule.ts create mode 100644 docs/_media/core/src/contracts/invitationFarm.ts create mode 100644 docs/_media/core/src/contracts/referralsModule.ts delete mode 100644 docs/_media/examples/profiles/02-check-cid.ts create mode 100644 docs/_media/examples/referrals/01-basic-usage.ts create mode 100644 docs/_media/examples/referrals/02-sdk-integration.ts delete mode 100644 docs/_media/examples/rpc/13-pagination-examples.ts delete mode 100644 docs/_media/examples/rpc/14-check-avatar-info.ts delete mode 100644 docs/_media/examples/runner/example-trust-zero-address.ts delete mode 100644 docs/_media/examples/sdk/error-handling.ts delete mode 100644 docs/_media/examples/sdk/events-subscription.ts delete mode 100644 docs/_media/examples/sdk/example-avatar.ts delete mode 100644 docs/_media/examples/sdk/example-profile.ts delete mode 100644 docs/_media/examples/sdk/example-register-group.ts delete mode 100644 docs/_media/examples/sdk/example-register-org.ts delete mode 100644 docs/_media/examples/sdk/human-avatar.ts delete mode 100644 docs/_media/examples/sdk/invite-test.ts delete mode 100644 docs/_media/examples/sdk/personal-token-mintable.ts delete mode 100644 docs/_media/examples/sdk/test-replenish.ts delete mode 100644 docs/_media/examples/sdk/test-wrapper.ts delete mode 100644 docs/_media/examples/sdk/transfer-builder-example.ts delete mode 100644 docs/_media/examples/sdk/transfer-test.ts delete mode 100644 docs/_media/transfers/src/TransferBuilder.test.ts create mode 100644 docs/abis/src/variables/invitationFarmAbi.md create mode 100644 docs/abis/src/variables/referralsModuleAbi.md create mode 100644 docs/core/src/classes/InvitationFarmContract.md create mode 100644 docs/core/src/classes/ReferralsModuleContract.md create mode 100644 docs/referrals/src/README.md create mode 100644 docs/referrals/src/classes/Referrals.md create mode 100644 docs/referrals/src/interfaces/ApiError.md create mode 100644 docs/referrals/src/interfaces/Referral.md create mode 100644 docs/referrals/src/interfaces/ReferralInfo.md create mode 100644 docs/referrals/src/interfaces/ReferralList.md create mode 100644 docs/referrals/src/type-aliases/ReferralStatus.md create mode 100644 docs/types/src/interfaces/SimulatedTrust.md diff --git a/docs/_media/abis/package.json b/docs/_media/abis/package.json index e202cd7..dbdb98f 100644 --- a/docs/_media/abis/package.json +++ b/docs/_media/abis/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-abis", - "version": "0.1.0", + "version": "0.1.5", "description": "Circles Contract ABIs", "type": "module", "main": "./dist/index.js", @@ -15,6 +15,11 @@ "files": [ "dist" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, + "license": "MIT", "scripts": { "build": "bun build ./src/index.ts --outdir ./dist --format esm --splitting && tsc --emitDeclarationOnly", "dev": "tsc --watch" diff --git a/docs/_media/abis/src/index.ts b/docs/_media/abis/src/index.ts index 6e964e8..c7fcc2f 100644 --- a/docs/_media/abis/src/index.ts +++ b/docs/_media/abis/src/index.ts @@ -9,3 +9,5 @@ export { inflationaryCirclesAbi } from './inflationaryCircles'; export { demurrageCirclesAbi } from './demurrageCircles'; export { liftERC20Abi } from './liftERC20'; export { invitationEscrowAbi } from './invitationEscrow'; +export { invitationFarmAbi } from './invitationFarm'; +export { referralsModuleAbi } from './referralsModule'; diff --git a/docs/_media/abis/src/invitationFarm.ts b/docs/_media/abis/src/invitationFarm.ts new file mode 100644 index 0000000..728761e --- /dev/null +++ b/docs/_media/abis/src/invitationFarm.ts @@ -0,0 +1,532 @@ +export const invitationFarmAbi = [ + { + type: "constructor", + inputs: [ + { + name: "_invitationModule", + type: "address", + internalType: "address", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "INVITATION_FEE", + inputs: [], + outputs: [ + { + name: "", + type: "uint256", + internalType: "uint256", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "HUB", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "contract IHub", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "NAME_REGISTRY", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "admin", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "bots", + inputs: [ + { + name: "bot", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "nextBot", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "claimInvite", + inputs: [], + outputs: [ + { + name: "id", + type: "uint256", + internalType: "uint256", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "claimInvites", + inputs: [ + { + name: "numberOfInvites", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [ + { + name: "ids", + type: "uint256[]", + internalType: "uint256[]", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "createBot", + inputs: [], + outputs: [ + { + name: "createdBot", + type: "address", + internalType: "address", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "createBots", + inputs: [ + { + name: "numberOfBots", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [ + { + name: "createdBots", + type: "address[]", + internalType: "address[]", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "growFarm", + inputs: [ + { + name: "numberOfBots", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "invitationModule", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "inviterQuota", + inputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "", + type: "uint256", + internalType: "uint256", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "lastUsedBot", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "maintainBots", + inputs: [ + { + name: "iterations", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "maintainer", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "seeder", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "setAdmin", + inputs: [ + { + name: "newAdmin", + type: "address", + internalType: "address", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "setInviterQuota", + inputs: [ + { + name: "inviter", + type: "address", + internalType: "address", + }, + { + name: "quota", + type: "uint256", + internalType: "uint256", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "setMaintainer", + inputs: [ + { + name: "newMaintainer", + type: "address", + internalType: "address", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "setSeeder", + inputs: [ + { + name: "newSeeder", + type: "address", + internalType: "address", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "totalBots", + inputs: [], + outputs: [ + { + name: "", + type: "uint256", + internalType: "uint256", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "updateBotMetadataDigest", + inputs: [ + { + name: "startBot", + type: "address", + internalType: "address", + }, + { + name: "numberOfBots", + type: "uint256", + internalType: "uint256", + }, + { + name: "metadataDigest", + type: "bytes32", + internalType: "bytes32", + }, + ], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "updateInvitationModule", + inputs: [ + { + name: "newInvitationModule", + type: "address", + internalType: "address", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "event", + name: "AdminSet", + inputs: [ + { + name: "newAdmin", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "BotCreated", + inputs: [ + { + name: "createdBot", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "FarmGrown", + inputs: [ + { + name: "maintainer", + type: "address", + indexed: true, + internalType: "address", + }, + { + name: "numberOfBots", + type: "uint256", + indexed: true, + internalType: "uint256", + }, + { + name: "totalNumberOfBots", + type: "uint256", + indexed: true, + internalType: "uint256", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "InvitationModuleUpdated", + inputs: [ + { + name: "module", + type: "address", + indexed: true, + internalType: "address", + }, + { + name: "genericCallProxy", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "InvitesClaimed", + inputs: [ + { + name: "inviter", + type: "address", + indexed: true, + internalType: "address", + }, + { + name: "count", + type: "uint256", + indexed: true, + internalType: "uint256", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "InviterQuotaUpdated", + inputs: [ + { + name: "inviter", + type: "address", + indexed: true, + internalType: "address", + }, + { + name: "quota", + type: "uint256", + indexed: true, + internalType: "uint256", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "MaintainerSet", + inputs: [ + { + name: "maintainer", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "SeederSet", + inputs: [ + { + name: "seeder", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "error", + name: "ExceedsInviteQuota", + inputs: [], + }, + { + type: "error", + name: "FarmIsDrained", + inputs: [], + }, + { + type: "error", + name: "OnlyAdmin", + inputs: [], + }, + { + type: "error", + name: "OnlyGenericCallProxy", + inputs: [], + }, + { + type: "error", + name: "OnlyHumanAvatarsAreInviters", + inputs: [ + { + name: "avatar", + type: "address", + internalType: "address", + }, + ], + }, + { + type: "error", + name: "OnlyMaintainer", + inputs: [], + }, + { + type: "error", + name: "OnlySeederOrBot", + inputs: [], + }, +] as const; diff --git a/docs/_media/abis/src/referralsModule.ts b/docs/_media/abis/src/referralsModule.ts new file mode 100644 index 0000000..6a129a2 --- /dev/null +++ b/docs/_media/abis/src/referralsModule.ts @@ -0,0 +1,486 @@ +export const referralsModuleAbi = [ + { + type: "constructor", + inputs: [ + { + name: "invitationModule", + type: "address", + internalType: "address", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "AFFILIATE_GROUP_REGISTRY", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "DOMAIN_SEPARATOR", + inputs: [], + outputs: [ + { + name: "", + type: "bytes32", + internalType: "bytes32", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "GENERIC_CALL_PROXY", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "HUB", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "INVITATION_MODULE", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "NAME_REGISTRY", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "SAFE_4337_MODULE", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "SAFE_MODULE_SETUP", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "SAFE_PROXY_FACTORY", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "contract ISafeProxyFactory", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "SAFE_SINGLETON", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "SAFE_WEB_AUTHN_SHARED_SIGNER", + inputs: [], + outputs: [ + { + name: "", + type: "address", + internalType: "address", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "WELCOME_BONUS", + inputs: [], + outputs: [ + { + name: "", + type: "uint256", + internalType: "uint256", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "accounts", + inputs: [ + { + name: "signer", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "account", + type: "address", + internalType: "address", + }, + { + name: "claimed", + type: "bool", + internalType: "bool", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "claimAccount", + inputs: [ + { + name: "x", + type: "uint256", + internalType: "uint256", + }, + { + name: "y", + type: "uint256", + internalType: "uint256", + }, + { + name: "verifier", + type: "address", + internalType: "address", + }, + { + name: "signature", + type: "bytes", + internalType: "bytes", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "claimAccount", + inputs: [ + { + name: "x", + type: "uint256", + internalType: "uint256", + }, + { + name: "y", + type: "uint256", + internalType: "uint256", + }, + { + name: "verifier", + type: "address", + internalType: "address", + }, + { + name: "signature", + type: "bytes", + internalType: "bytes", + }, + { + name: "metadataDigest", + type: "bytes32", + internalType: "bytes32", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "claimAccount", + inputs: [ + { + name: "x", + type: "uint256", + internalType: "uint256", + }, + { + name: "y", + type: "uint256", + internalType: "uint256", + }, + { + name: "verifier", + type: "address", + internalType: "address", + }, + { + name: "signature", + type: "bytes", + internalType: "bytes", + }, + { + name: "affiliateGroup", + type: "address", + internalType: "address", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "claimAccount", + inputs: [ + { + name: "x", + type: "uint256", + internalType: "uint256", + }, + { + name: "y", + type: "uint256", + internalType: "uint256", + }, + { + name: "verifier", + type: "address", + internalType: "address", + }, + { + name: "signature", + type: "bytes", + internalType: "bytes", + }, + { + name: "metadataDigest", + type: "bytes32", + internalType: "bytes32", + }, + { + name: "affiliateGroup", + type: "address", + internalType: "address", + }, + ], + outputs: [], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "computeAddress", + inputs: [ + { + name: "signer", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "predictedAddress", + type: "address", + internalType: "address", + }, + ], + stateMutability: "pure", + }, + { + type: "function", + name: "createAccount", + inputs: [ + { + name: "signer", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "account", + type: "address", + internalType: "address", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "createAccounts", + inputs: [ + { + name: "signers", + type: "address[]", + internalType: "address[]", + }, + ], + outputs: [ + { + name: "_accounts", + type: "address[]", + internalType: "address[]", + }, + ], + stateMutability: "nonpayable", + }, + { + type: "function", + name: "encodePasskeyData", + inputs: [ + { + name: "x", + type: "uint256", + internalType: "uint256", + }, + { + name: "y", + type: "uint256", + internalType: "uint256", + }, + { + name: "verifier", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "", + type: "bytes", + internalType: "bytes", + }, + ], + stateMutability: "view", + }, + { + type: "function", + name: "getPasskeyHash", + inputs: [ + { + name: "x", + type: "uint256", + internalType: "uint256", + }, + { + name: "y", + type: "uint256", + internalType: "uint256", + }, + { + name: "verifier", + type: "address", + internalType: "address", + }, + ], + outputs: [ + { + name: "", + type: "bytes32", + internalType: "bytes32", + }, + ], + stateMutability: "view", + }, + { + type: "event", + name: "AccountClaimed", + inputs: [ + { + name: "account", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "event", + name: "AccountCreated", + inputs: [ + { + name: "account", + type: "address", + indexed: true, + internalType: "address", + }, + ], + anonymous: false, + }, + { + type: "error", + name: "AccountAlreadyClaimed", + inputs: [], + }, + { + type: "error", + name: "InvalidSignature", + inputs: [], + }, + { + type: "error", + name: "OnlyGenericCallProxy", + inputs: [], + }, + { + type: "error", + name: "SignerAlreadyUsed", + inputs: [], + }, +] as const; diff --git a/docs/_media/core/package.json b/docs/_media/core/package.json index 653f860..fc67450 100644 --- a/docs/_media/core/package.json +++ b/docs/_media/core/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-core", - "version": "0.1.0", + "version": "0.1.5", "description": "Circles Contracts wrapper", "type": "module", "main": "./dist/index.js", @@ -16,6 +16,11 @@ "files": [ "dist" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, + "license": "MIT", "scripts": { "build": "bun build ./src/index.ts --outdir ./dist --format esm --minify && tsc --emitDeclarationOnly", "dev": "tsc --watch" diff --git a/docs/_media/core/src/config.ts b/docs/_media/core/src/config.ts index 4c9bb81..8bd97fb 100644 --- a/docs/_media/core/src/config.ts +++ b/docs/_media/core/src/config.ts @@ -19,6 +19,8 @@ export const circlesConfig: { [chainId: number]: CirclesConfig } = { coreMembersGroupDeployer: "0xFEca40Eb02FB1f4F5F795fC7a03c1A27819B1Ded", baseGroupFactoryAddress: "0xD0B5Bd9962197BEaC4cbA24244ec3587f19Bd06d", liftERC20Address: "0x5F99a795dD2743C36D63511f0D4bc667e6d3cDB5", - invitationEscrowAddress: "0x8F8B74fa13eaaff4176D061a0F98ad5c8E19c903" + invitationEscrowAddress: "0x8F8B74fa13eaaff4176D061a0F98ad5c8E19c903", + invitationFarmAddress: "0x0000000000000000000000000000000000000000", + referralsModuleAddress: "0xd6dF7cc2C2DB03ec91761f4469D8dBAac7e538C9" } }; diff --git a/docs/_media/core/src/contracts/index.ts b/docs/_media/core/src/contracts/index.ts index eb6cb27..5a7c01e 100644 --- a/docs/_media/core/src/contracts/index.ts +++ b/docs/_media/core/src/contracts/index.ts @@ -10,4 +10,6 @@ export { DemurrageCirclesContract } from './demurrageCircles'; export { LiftERC20Contract } from './liftERC20'; export { CirclesType } from '@aboutcircles/sdk-types'; export { InvitationEscrowContract } from './invitationEscrow'; +export { InvitationFarmContract } from './invitationFarm'; +export { ReferralsModuleContract } from './referralsModule'; export { Contract } from './contract'; \ No newline at end of file diff --git a/docs/_media/core/src/contracts/invitationFarm.ts b/docs/_media/core/src/contracts/invitationFarm.ts new file mode 100644 index 0000000..306d6e2 --- /dev/null +++ b/docs/_media/core/src/contracts/invitationFarm.ts @@ -0,0 +1,119 @@ +import { Contract } from './contract'; +import { invitationFarmAbi } from '@aboutcircles/sdk-abis'; +import type { Address, TransactionRequest } from '@aboutcircles/sdk-types'; + +/** + * InvitationFarm Contract Wrapper + * Provides type-safe methods for interacting with the InvitationFarm contract + * + * This contract manages a farm of InvitationBot instances, distributes/claims invite capacity, + * and grows the farm. Users can claim invites from the farm using their allocated quota. + */ +export class InvitationFarmContract extends Contract { + constructor(config: { address: Address; rpcUrl: string }) { + super({ + address: config.address, + abi: invitationFarmAbi, + rpcUrl: config.rpcUrl, + }); + } + + /** + * Claims multiple invites for the caller, consuming their quota + * @param numberOfInvites Number of invites to claim + * @returns Transaction request + */ + claimInvites(numberOfInvites: bigint): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('claimInvites', [numberOfInvites]), + value: BigInt(0), + }; + } + + /** + * Claims a single invite for the caller, consuming their quota by 1 + * @returns Transaction request + */ + claimInvite(): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('claimInvite', []), + value: BigInt(0), + }; + } + + /** + * Get the invitation fee amount in CRC (cost per invite) + * @returns The invitation fee constant + */ + async invitationFee(): Promise { + return this.read('INVITATION_FEE') as Promise; + } + + /** + * Get the remaining invite quota for a specific inviter + * @param inviter The address of the inviter + * @returns The remaining quota + */ + async inviterQuota(inviter: Address): Promise { + return this.read('inviterQuota', [inviter]) as Promise; + } + + /** + * Get the total number of bots in the farm + * @returns The total number of bots + */ + async totalBots(): Promise { + return this.read('totalBots') as Promise; + } + + /** + * Get the admin address + * @returns The admin address + */ + async admin(): Promise
{ + return this.read('admin') as Promise
; + } + + /** + * Get the maintainer address + * @returns The maintainer address + */ + async maintainer(): Promise
{ + return this.read('maintainer') as Promise
; + } + + /** + * Get the seeder address + * @returns The seeder address + */ + async seeder(): Promise
{ + return this.read('seeder') as Promise
; + } + + /** + * Get the invitation module address + * @returns The invitation module address + */ + async invitationModule(): Promise
{ + return this.read('invitationModule') as Promise
; + } + + /** + * Get the last used bot in the round-robin allocation + * @returns The address of the last used bot + */ + async lastUsedBot(): Promise
{ + return this.read('lastUsedBot') as Promise
; + } + + /** + * Get the next bot in the linked list for a given bot + * @param bot The bot address + * @returns The next bot address + */ + async bots(bot: Address): Promise
{ + return this.read('bots', [bot]) as Promise
; + } +} diff --git a/docs/_media/core/src/contracts/referralsModule.ts b/docs/_media/core/src/contracts/referralsModule.ts new file mode 100644 index 0000000..95de825 --- /dev/null +++ b/docs/_media/core/src/contracts/referralsModule.ts @@ -0,0 +1,258 @@ +import { Contract } from './contract'; +import { referralsModuleAbi } from '@aboutcircles/sdk-abis'; +import type { Address, TransactionRequest, Hex } from '@aboutcircles/sdk-types'; + +/** + * ReferralsModule Contract Wrapper + * Provides type-safe methods for interacting with the ReferralsModule contract + * + * This contract pre-deploys "pre-made" human CRC Safe accounts on behalf of origin inviters, + * and lets invited humans claim those Safes using a device WebAuthn passkey plus an offchain + * secret provided by the origin inviter. + */ +export class ReferralsModuleContract extends Contract { + constructor(config: { address: Address; rpcUrl: string }) { + super({ + address: config.address, + abi: referralsModuleAbi, + rpcUrl: config.rpcUrl, + }); + } + + // ========== CREATE ACCOUNT FUNCTIONS ========== + + /** + * Pre-deploys a Safe for an origin inviter's offchain signer + * Only callable by the Invitation Module Generic Call Proxy + * @param signer The public address derived from the origin inviter's offchain secret key + * @returns Transaction request + */ + createAccount(signer: Address): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('createAccount', [signer]), + value: BigInt(0), + }; + } + + /** + * Batch pre-deploys Safes for multiple signers + * Only callable by the Invitation Module Generic Call Proxy + * @param signers The list of public addresses derived from origin inviters' offchain secrets + * @returns Transaction request + */ + createAccounts(signers: Address[]): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('createAccounts', [signers]), + value: BigInt(0), + }; + } + + /** + * Predicts the pre-made Safe address for a given signer without deploying it + * @param signer The offchain public address chosen by the origin inviter + * @returns The predicted Safe address + */ + async computeAddress(signer: Address): Promise
{ + return this.read('computeAddress', [signer]) as Promise
; + } + + // ========== CLAIM ACCOUNT FUNCTIONS ========== + + /** + * Claims the pre-made Safe by proving knowledge of the offchain secret + * and configuring the device WebAuthn passkey + * @param x The X coordinate of the WebAuthn public key + * @param y The Y coordinate of the WebAuthn public key + * @param verifier The WebAuthn verifier/authenticator contract address + * @param signature The 65-byte ECDSA signature over the EIP-712 passkey digest + * @returns Transaction request + */ + claimAccount(x: bigint, y: bigint, verifier: Address, signature: Hex): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('claimAccount', [x, y, verifier, signature]), + value: BigInt(0), + }; + } + + /** + * Claims the pre-made Safe and sets Name Registry metadata in a single transaction + * @param x The X coordinate of the passkey public key + * @param y The Y coordinate of the passkey public key + * @param verifier The verifier/authenticator contract address + * @param signature The 65-byte ECDSA signature over the EIP-712 passkey digest + * @param metadataDigest The metadata digest to set in the Name Registry + * @returns Transaction request + */ + claimAccountWithMetadata( + x: bigint, + y: bigint, + verifier: Address, + signature: Hex, + metadataDigest: Hex + ): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('claimAccount', [x, y, verifier, signature, metadataDigest]), + value: BigInt(0), + }; + } + + /** + * Claims the pre-made Safe and sets the affiliate group in a single transaction + * @param x The X coordinate of the passkey public key + * @param y The Y coordinate of the passkey public key + * @param verifier The verifier/authenticator contract address + * @param signature The 65-byte ECDSA signature over the EIP-712 passkey digest + * @param affiliateGroup The affiliate group address to register + * @returns Transaction request + */ + claimAccountWithAffiliateGroup( + x: bigint, + y: bigint, + verifier: Address, + signature: Hex, + affiliateGroup: Address + ): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('claimAccount', [x, y, verifier, signature, affiliateGroup]), + value: BigInt(0), + }; + } + + /** + * Claims the pre-made Safe, sets Name Registry metadata and affiliate group + * @param x The X coordinate of the passkey public key + * @param y The Y coordinate of the passkey public key + * @param verifier The verifier/authenticator contract address + * @param signature The 65-byte ECDSA signature over the EIP-712 passkey digest + * @param metadataDigest The metadata digest to set in the Name Registry + * @param affiliateGroup The affiliate group address to register + * @returns Transaction request + */ + claimAccountWithMetadataAndAffiliateGroup( + x: bigint, + y: bigint, + verifier: Address, + signature: Hex, + metadataDigest: Hex, + affiliateGroup: Address + ): TransactionRequest { + return { + to: this.address, + data: this.encodeWrite('claimAccount', [x, y, verifier, signature, metadataDigest, affiliateGroup]), + value: BigInt(0), + }; + } + + // ========== VIEW FUNCTIONS ========== + + /** + * Get the account record for a given signer + * @param signer The offchain public address + * @returns Object with account address and claimed status + */ + async accounts(signer: Address): Promise<{ account: Address; claimed: boolean }> { + const [account, claimed] = (await this.read('accounts', [signer])) as [Address, boolean]; + return { account, claimed }; + } + + /** + * Get the EIP-712 domain separator + * @returns The domain separator + */ + async domainSeparator(): Promise { + return this.read('DOMAIN_SEPARATOR') as Promise; + } + + /** + * Get the welcome bonus amount (target CRC balance after claim) + * @returns The welcome bonus amount + */ + async welcomeBonus(): Promise { + return this.read('WELCOME_BONUS') as Promise; + } + + /** + * Get the Hub contract address + * @returns The Hub address + */ + async hub(): Promise
{ + return this.read('HUB') as Promise
; + } + + /** + * Get the Invitation Module address + * @returns The Invitation Module address + */ + async invitationModule(): Promise
{ + return this.read('INVITATION_MODULE') as Promise
; + } + + /** + * Get the Generic Call Proxy address + * @returns The Generic Call Proxy address + */ + async genericCallProxy(): Promise
{ + return this.read('GENERIC_CALL_PROXY') as Promise
; + } + + /** + * Get the Name Registry address + * @returns The Name Registry address + */ + async nameRegistry(): Promise
{ + return this.read('NAME_REGISTRY') as Promise
; + } + + /** + * Get the Affiliate Group Registry address + * @returns The Affiliate Group Registry address + */ + async affiliateGroupRegistry(): Promise
{ + return this.read('AFFILIATE_GROUP_REGISTRY') as Promise
; + } + + /** + * Get the Safe Proxy Factory address + * @returns The Safe Proxy Factory address + */ + async safeProxyFactory(): Promise
{ + return this.read('SAFE_PROXY_FACTORY') as Promise
; + } + + /** + * Get the Safe Singleton address + * @returns The Safe Singleton address + */ + async safeSingleton(): Promise
{ + return this.read('SAFE_SINGLETON') as Promise
; + } + + /** + * Get the Safe 4337 Module address + * @returns The Safe 4337 Module address + */ + async safe4337Module(): Promise
{ + return this.read('SAFE_4337_MODULE') as Promise
; + } + + /** + * Get the Safe Module Setup address + * @returns The Safe Module Setup address + */ + async safeModuleSetup(): Promise
{ + return this.read('SAFE_MODULE_SETUP') as Promise
; + } + + /** + * Get the Safe WebAuthn Shared Signer address + * @returns The Safe WebAuthn Shared Signer address + */ + async safeWebAuthnSharedSigner(): Promise
{ + return this.read('SAFE_WEB_AUTHN_SHARED_SIGNER') as Promise
; + } +} diff --git a/docs/_media/core/src/core.ts b/docs/_media/core/src/core.ts index 5e5bed8..1df3ead 100644 --- a/docs/_media/core/src/core.ts +++ b/docs/_media/core/src/core.ts @@ -1,4 +1,4 @@ -import { HubV2Contract, BaseGroupFactoryContract, NameRegistryContract, LiftERC20Contract, InvitationEscrowContract } from './contracts'; +import { HubV2Contract, BaseGroupFactoryContract, NameRegistryContract, LiftERC20Contract, InvitationEscrowContract, InvitationFarmContract, ReferralsModuleContract } from './contracts'; import type { CirclesConfig } from '@aboutcircles/sdk-types'; import { circlesConfig } from './config'; @@ -45,6 +45,8 @@ export class Core { public readonly nameRegistry: NameRegistryContract; public readonly liftERC20: LiftERC20Contract; public readonly invitationEscrow: InvitationEscrowContract; + public readonly invitationFarm: InvitationFarmContract; + public readonly referralsModule: ReferralsModuleContract; /** * Create a new Core SDK instance @@ -81,5 +83,15 @@ export class Core { address: config.invitationEscrowAddress, rpcUrl: this.rpcUrl, }); + + this.invitationFarm = new InvitationFarmContract({ + address: config.invitationFarmAddress, + rpcUrl: this.rpcUrl, + }); + + this.referralsModule = new ReferralsModuleContract({ + address: config.referralsModuleAddress, + rpcUrl: this.rpcUrl, + }); } } diff --git a/docs/_media/examples/profiles/02-check-cid.ts b/docs/_media/examples/profiles/02-check-cid.ts deleted file mode 100644 index d712288..0000000 --- a/docs/_media/examples/profiles/02-check-cid.ts +++ /dev/null @@ -1,105 +0,0 @@ -import { Profiles } from '@aboutcircles/sdk-profiles'; -import { CID } from 'multiformats/cid'; -import { sha256 } from 'multiformats/hashes/sha2'; -import { base58btc } from 'multiformats/bases/base58'; - -/** - * Check Profile by Hex CID Digest - * - * This example demonstrates: - * - Converting a hex hash digest to CIDv0 format - * - Retrieving profile data from the pinning service - */ - -// The hex CID digest to check (without 0x prefix) -const HEX_DIGEST = '9885BE4E009FE3E32235329D13C0B078D5456BFFEBAA5982301D95F3BC7CB122'; - -async function checkProfileByCid() { - console.log('═══════════════════════════════════════════════════════════'); - console.log(' CHECK PROFILE BY CID DIGEST'); - console.log('═══════════════════════════════════════════════════════════'); - console.log(); - console.log(`Hex Digest: ${HEX_DIGEST}`); - console.log(); - - try { - // Convert hex digest to Uint8Array - const hexDigest = HEX_DIGEST.toLowerCase(); - const digestBytes = new Uint8Array( - hexDigest.match(/.{1,2}/g)!.map(byte => parseInt(byte, 16)) - ); - - console.log('Step 1: Converting hex digest to CIDv0 format...'); - - // Create a multihash with SHA-256 code (0x12) - const multihash = { - code: 0x12, // SHA-256 - digest: digestBytes, - bytes: new Uint8Array([ - 0x12, // SHA-256 code - 0x20, // 32 bytes length - ...digestBytes - ]) - }; - - // Create CIDv0 from the multihash - const cid = CID.create(0, 0x70, multihash); // version 0, dag-pb codec (0x70) - const cidV0String = cid.toString(base58btc); - - console.log(`✓ CIDv0: ${cidV0String}`); - console.log(); - - // Initialize the Profiles client - const profiles = new Profiles('https://rpc.aboutcircles.com/profiles/'); - - console.log('Step 2: Querying profile service...'); - console.log(`URL: https://rpc.aboutcircles.com/profiles/get?cid=${cidV0String}`); - console.log(); - - // Try to get the profile - const profile = await profiles.get(cidV0String); - - if (profile) { - console.log('✅ Profile found!'); - console.log('─'.repeat(60)); - console.log(); - console.log('Profile Data:'); - console.log(JSON.stringify(profile, null, 2)); - console.log(); - - if (profile.name) { - console.log(`Name: ${profile.name}`); - } - if (profile.description) { - console.log(`Description: ${profile.description}`); - } - if (profile.location) { - console.log(`Location: ${profile.location}`); - } - if (profile.imageUrl) { - console.log(`Image URL: ${profile.imageUrl}`); - } - if (profile.previewImageUrl) { - console.log(`Preview: ${profile.previewImageUrl}`); - } - } else { - console.log('❌ No profile found for this CID'); - console.log(); - console.log('This could mean:'); - console.log(' - The CID is not pinned in the profile service'); - console.log(' - The content has been unpinned'); - console.log(' - The CID format is incorrect'); - } - - } catch (error) { - console.error('❌ Error:', error instanceof Error ? error.message : error); - console.error(); - console.error('Full error:', error); - } - - console.log(); - console.log('═══════════════════════════════════════════════════════════'); -} - -// Run the check -checkProfileByCid().catch(console.error); diff --git a/docs/_media/examples/referrals/01-basic-usage.ts b/docs/_media/examples/referrals/01-basic-usage.ts new file mode 100644 index 0000000..6d6e1cf --- /dev/null +++ b/docs/_media/examples/referrals/01-basic-usage.ts @@ -0,0 +1,160 @@ +import { Referrals } from '@aboutcircles/sdk-referrals'; +import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts'; + +/** + * Referrals Basic Usage Example + * + * This example demonstrates the referral/invitation workflow: + * 1. Inviter creates a referral link (generates private key) + * 2. Inviter stores the referral in the backend + * 3. Invitee retrieves referral info using the private key + * 4. Inviter can list all their referrals + * + * Backend: https://staging.circlesubi.network/referrals + */ + +const REFERRALS_URL = 'https://staging.circlesubi.network/referrals'; + +// Initialize the Referrals client (no auth needed for store/retrieve) +const referrals = new Referrals(REFERRALS_URL); + +// Example inviter address (replace with actual address in production) +const INVITER_ADDRESS = '0x1234567890123456789012345678901234567890'; + +// Example 1: Generate a referral link +function exampleGenerateReferral() { + console.log('=== Example 1: Generate Referral Link ===\n'); + + // Generate a new private key for the referral + const privateKey = generatePrivateKey(); + const account = privateKeyToAccount(privateKey); + + console.log('Generated referral:'); + console.log('- Private Key:', privateKey); + console.log('- Account Address:', account.address); + console.log('\nShare this private key with your invitee.'); + console.log('They will use it to claim their invitation.\n'); + + return privateKey; +} + +// Example 2: Store a referral in the backend +async function exampleStoreReferral(privateKey: string, inviter: string) { + console.log('=== Example 2: Store Referral ===\n'); + + console.log('Storing referral:'); + console.log('- Private Key:', privateKey.slice(0, 10) + '...'); + console.log('- Inviter:', inviter); + + try { + await referrals.store(privateKey, inviter); + console.log('\n✓ Referral stored successfully!'); + console.log('The backend validated the private key on-chain.'); + } catch (error) { + console.error('\n✗ Failed to store referral:', error); + throw error; + } +} + +// Example 3: Retrieve referral info (what invitee would do) +async function exampleRetrieveReferral(privateKey: string) { + console.log('\n\n=== Example 3: Retrieve Referral (Invitee Flow) ===\n'); + + console.log('Looking up referral with private key...'); + + try { + const info = await referrals.retrieve(privateKey); + + console.log('\n✓ Referral found!'); + console.log('- Inviter:', info.inviter); + console.log('- Status:', info.status); + if (info.accountAddress) { + console.log('- Account Address:', info.accountAddress); + } + + return info; + } catch (error) { + console.error('\n✗ Failed to retrieve referral:', error); + throw error; + } +} + +// Example 4: List all referrals (requires authentication) +async function exampleListMyReferrals() { + console.log('\n\n=== Example 4: List My Referrals (Authenticated) ===\n'); + + // For authenticated endpoints, you need a token provider + const AUTH_URL = 'https://staging.circlesubi.network/auth'; + + // In production, implement proper JWT token fetching + const getAuthToken = async (): Promise => { + // This would typically: + // 1. Sign a message with the user's wallet + // 2. Exchange the signature for a JWT at the auth endpoint + // Example: + // const response = await fetch(`${AUTH_URL}/login`, { ... }); + // return response.json().token; + throw new Error('Implement auth token fetching for your app'); + }; + + const authenticatedClient = new Referrals(REFERRALS_URL, getAuthToken); + + try { + const result = await authenticatedClient.listMine(); + + console.log(`✓ Found ${result.count} referrals:\n`); + + for (const referral of result.referrals) { + console.log(`Referral ${referral.id}:`); + console.log(` - Status: ${referral.status}`); + console.log(` - Created: ${referral.createdAt}`); + if (referral.accountAddress) { + console.log(` - Account: ${referral.accountAddress}`); + } + if (referral.confirmedAt) { + console.log(` - Confirmed: ${referral.confirmedAt}`); + } + if (referral.claimedAt) { + console.log(` - Claimed: ${referral.claimedAt}`); + } + console.log(); + } + + return result; + } catch (error) { + console.error('\n✗ Failed to list referrals:', error); + console.log('(This is expected if auth is not configured)'); + } +} + +// Run examples +async function runExamples() { + try { + // Step 1: Generate a referral (inviter side) + const privateKey = exampleGenerateReferral(); + + // Step 2: Store the referral in backend + // Note: This will fail with a mock address - use a real registered avatar + console.log('Skipping store example (requires real on-chain account)\n'); + // await exampleStoreReferral(privateKey, INVITER_ADDRESS); + + // Step 3: Retrieve referral info (invitee side) + // Note: This will fail without a stored referral + console.log('Skipping retrieve example (no stored referral)\n'); + // await exampleRetrieveReferral(privateKey); + + // Step 4: List my referrals (requires auth) + // await exampleListMyReferrals(); + + console.log('=== Examples Complete ==='); + console.log('\nTo run the full flow:'); + console.log('1. Use a real inviter address with an on-chain account'); + console.log('2. Configure authentication for listMine()'); + } catch (error) { + console.error('\nError running examples:', error); + } +} + +runExamples(); + +export { exampleGenerateReferral, exampleStoreReferral, exampleRetrieveReferral, exampleListMyReferrals }; diff --git a/docs/_media/examples/referrals/02-sdk-integration.ts b/docs/_media/examples/referrals/02-sdk-integration.ts new file mode 100644 index 0000000..88bbad7 --- /dev/null +++ b/docs/_media/examples/referrals/02-sdk-integration.ts @@ -0,0 +1,132 @@ +import { Sdk } from '@aboutcircles/sdk'; +import { circlesConfig } from '@aboutcircles/sdk-core'; +import { generatePrivateKey } from 'viem/accounts'; + +/** + * Referrals SDK Integration Example + * + * This example shows how to use referrals through the main Sdk class + * rather than the standalone Referrals client. + * + * The Sdk provides a unified interface for all Circles operations. + */ + +// Configure with referrals service URL +const config = { + ...circlesConfig[100], // Gnosis Chain + referralsServiceUrl: 'https://staging.circlesubi.network/referrals', +}; + +// Initialize SDK (read-only, no contract runner) +const sdk = new Sdk(config); + +// Example 1: Store a referral via SDK +async function exampleSdkStoreReferral() { + console.log('=== SDK: Store Referral ===\n'); + + const privateKey = generatePrivateKey(); + const inviterAddress = '0x1234567890123456789012345678901234567890'; + + console.log('Generated private key:', privateKey.slice(0, 10) + '...'); + + try { + await sdk.referrals.store(privateKey, inviterAddress); + console.log('✓ Referral stored via SDK'); + return privateKey; + } catch (error) { + console.error('✗ Store failed:', error); + throw error; + } +} + +// Example 2: Retrieve referral via SDK +async function exampleSdkRetrieveReferral(privateKey: string) { + console.log('\n=== SDK: Retrieve Referral ===\n'); + + try { + const info = await sdk.referrals.retrieve(privateKey); + + console.log('✓ Referral info:'); + console.log(' - Inviter:', info.inviter); + console.log(' - Status:', info.status); + + return info; + } catch (error) { + console.error('✗ Retrieve failed:', error); + throw error; + } +} + +// Example 3: Full invitation flow +async function exampleFullInvitationFlow() { + console.log('=== Full Invitation Flow ===\n'); + + // This demonstrates the complete flow an app would implement: + // + // INVITER SIDE: + // 1. Generate a referral private key + // 2. Store it in the backend (validates on-chain) + // 3. Share the private key with invitee (e.g., as URL param) + // + // INVITEE SIDE: + // 4. Receive the private key from invite link + // 5. Retrieve referral info to see who invited them + // 6. Use sdk.register.asHuman() which checks for pending invitations + + console.log('Inviter creates referral:'); + const referralKey = generatePrivateKey(); + console.log('- Generated key:', referralKey.slice(0, 20) + '...'); + + // In a real app, the inviter would be the logged-in user's address + const inviterAddress = '0xInviterSafeAddress' as `0x${string}`; + + console.log('\nInviter stores referral in backend...'); + console.log('(Skipping - requires real on-chain account)\n'); + // await sdk.referrals.store(referralKey, inviterAddress); + + console.log('Invitee receives link and looks up referral...'); + console.log('(Skipping - no stored referral)\n'); + // const info = await sdk.referrals.retrieve(referralKey); + // console.log('Invited by:', info.inviter); + + console.log('Invitee registers using the inviter address...'); + console.log('(Skipping - requires contract runner)\n'); + // const avatar = await sdk.register.asHuman(info.inviter, { name: 'NewUser' }); +} + +// Example 4: Error handling when service not configured +function exampleMissingConfig() { + console.log('=== Error Handling: Missing Config ===\n'); + + // SDK without referrals URL + const sdkNoReferrals = new Sdk(circlesConfig[100]); + + try { + // This will throw because referralsServiceUrl is not set + sdkNoReferrals.referrals.retrieve('0x...'); + } catch (error: any) { + console.log('✓ Expected error:', error.message); + console.log('\nTo fix: Include referralsServiceUrl in your config'); + } +} + +// Run examples +async function runExamples() { + console.log('Referrals SDK Integration Examples\n'); + console.log('Backend:', config.referralsServiceUrl); + console.log('─'.repeat(50) + '\n'); + + // Show error handling for missing config + exampleMissingConfig(); + + console.log('\n'); + + // Show the conceptual flow + await exampleFullInvitationFlow(); + + console.log('=== Examples Complete ==='); +} + +runExamples(); + +export { exampleSdkStoreReferral, exampleSdkRetrieveReferral, exampleFullInvitationFlow }; diff --git a/docs/_media/examples/rpc/10-group-queries.ts b/docs/_media/examples/rpc/10-group-queries.ts index 8cae754..3c8dc8d 100644 --- a/docs/_media/examples/rpc/10-group-queries.ts +++ b/docs/_media/examples/rpc/10-group-queries.ts @@ -4,7 +4,7 @@ * Demonstrates how to query groups and group memberships */ -import { CirclesRpc } from '@aboutcircles/sdk-rpc'; +import { CirclesRpc } from '@circles-sdk/rpc'; const TEST_ADDRESS = '0xc7d3dF890952a327Af94D5Ba6fdC1Bf145188a1b'; @@ -60,10 +60,10 @@ async function main() { } console.log(); - // 4. Find groups by owner (supports multiple owners with OR query) + // 4. Find groups by owner console.log('4. Finding groups owned by test address...'); const ownedGroups = await rpc.group.findGroups(10, { - ownerIn: [TEST_ADDRESS], + ownerEquals: TEST_ADDRESS, }); console.log(`Found ${ownedGroups.length} groups owned by test address`); if (ownedGroups.length > 0) { @@ -78,16 +78,11 @@ async function main() { // 5. Get group memberships for test address console.log('5. Getting group memberships for test address...'); - const membershipsQuery = rpc.group.getGroupMemberships(TEST_ADDRESS, 50); - - // Fetch first page - await membershipsQuery.queryNextPage(); - const memberships = membershipsQuery.currentPage?.results || []; - + const memberships = await rpc.group.getGroupMemberships(TEST_ADDRESS, 20); console.log(`Found ${memberships.length} group memberships`); if (memberships.length > 0) { - console.log('Group memberships (showing first 5):'); + console.log('Group memberships:'); for (const membership of memberships.slice(0, 5)) { const joinedDate = new Date(membership.timestamp * 1000); console.log(` - Group: ${membership.group}`); @@ -99,10 +94,6 @@ async function main() { } console.log(); } - - if (membershipsQuery.currentPage?.hasMore) { - console.log('(More memberships available - use pagination to fetch additional pages)'); - } } else { console.log('Test address is not a member of any groups'); } @@ -120,7 +111,21 @@ async function main() { } console.log(); - + // 7. Complex query - find groups with multiple filters + console.log('7. Complex query - groups with member count > 0...'); + const allGroupsLarge = await rpc.group.findGroups(50); + const groupsWithMembers = allGroupsLarge.filter(g => (g.memberCount || 0) > 0); + console.log(`Found ${groupsWithMembers.length} groups with members`); + + if (groupsWithMembers.length > 0) { + // Sort by member count + const sortedGroups = groupsWithMembers.sort((a, b) => (b.memberCount || 0) - (a.memberCount || 0)); + console.log('Top 5 groups by member count:'); + sortedGroups.slice(0, 5).forEach((group, index) => { + console.log(` ${index + 1}. ${group.name || 'Unnamed'} - ${group.memberCount} members`); + console.log(` ${group.group}`); + }); + } } main().catch(console.error); diff --git a/docs/_media/examples/rpc/13-pagination-examples.ts b/docs/_media/examples/rpc/13-pagination-examples.ts deleted file mode 100644 index a5907e0..0000000 --- a/docs/_media/examples/rpc/13-pagination-examples.ts +++ /dev/null @@ -1,145 +0,0 @@ -import { CirclesRpc } from '@aboutcircles/sdk-rpc'; - -/** - * This example demonstrates cursor-based pagination using the PagedQuery utility. - * Cursor-based pagination is more efficient than offset-based pagination, - * especially for large datasets. - */ - -const RPC_URL = process.env.RPC_URL || 'https://rpc.aboutcircles.com'; -const AVATAR_ADDRESS = process.env.AVATAR_ADDRESS || '0xYourAvatarAddress'; -const GROUP_ADDRESS = process.env.GROUP_ADDRESS || '0xGroupAddress'; - -async function main() { - const rpc = new CirclesRpc(RPC_URL); - - console.log('=== Cursor-Based Pagination Examples ===\n'); - - // Example 1: Paginate through group members - console.log('1. Fetching group members with pagination:'); - const membersQuery = rpc.group.getGroupMembers(GROUP_ADDRESS, 10); // 10 per page - - let pageNum = 1; - while (await membersQuery.queryNextPage()) { - const page = membersQuery.currentPage!; - console.log(`\n Page ${pageNum}:`); - console.log(` - Found ${page.size} members`); - console.log(` - Has more: ${page.hasMore}`); - console.log(` - Members:`, page.results.map((m) => m.member).slice(0, 3)); - - pageNum++; - if (pageNum > 3) break; // Limit to 3 pages for demo - } - - // Example 2: Paginate through transaction history - console.log('\n\n2. Fetching transaction history with pagination:'); - const txQuery = rpc.transaction.getTransactionHistory(AVATAR_ADDRESS, 5); // 5 per page - - if (await txQuery.queryNextPage()) { - const page = txQuery.currentPage!; - console.log(` - Found ${page.size} transactions`); - console.log(` - First cursor:`, page.firstCursor); - console.log(` - Last cursor:`, page.lastCursor); - console.log(' - Transactions:'); - page.results.forEach((tx) => { - console.log(` ${tx.from} -> ${tx.to}: ${tx.circles} CRC`); - }); - } - - // Example 3: Paginate through trust relations - console.log('\n\n3. Fetching trust relations with pagination:'); - const trustQuery = rpc.trust.getTrustRelations(AVATAR_ADDRESS, 10); - - if (await trustQuery.queryNextPage()) { - const page = trustQuery.currentPage!; - console.log(` - Found ${page.size} trust relations`); - console.log(` - Has more: ${page.hasMore}`); - console.log(' - Relations:'); - page.results.slice(0, 5).forEach((rel) => { - console.log(` ${rel.truster} -> ${rel.trustee}`); - }); - } - - // Example 4: Paginate through groups - console.log('\n\n4. Fetching groups with pagination:'); - const groupsQuery = rpc.group.getGroups(5); - - if (await groupsQuery.queryNextPage()) { - const page = groupsQuery.currentPage!; - console.log(` - Found ${page.size} groups`); - console.log(' - Groups:'); - page.results.forEach((g) => { - console.log(` ${g.group}: ${g.name || 'No name'} (${g.symbol || 'No symbol'})`); - }); - } - - // Example 5: Paginate through group memberships for an avatar - console.log('\n\n5. Fetching group memberships with pagination:'); - const membershipsQuery = rpc.group.getGroupMemberships(AVATAR_ADDRESS, 10); - - if (await membershipsQuery.queryNextPage()) { - const page = membershipsQuery.currentPage!; - console.log(` - Found ${page.size} memberships`); - console.log(' - Memberships:'); - page.results.forEach((m) => { - console.log(` Group: ${m.group}`); - }); - } - - // Example 6: Reset and restart pagination - console.log('\n\n6. Demonstrating query reset:'); - membersQuery.reset(); - console.log(' - Query reset. Starting fresh...'); - if (await membersQuery.queryNextPage()) { - console.log(` - Got ${membersQuery.currentPage!.size} members from first page again`); - } - - // Example 7: Check pagination state - console.log('\n\n7. Pagination state inspection:'); - const stateQuery = rpc.group.getGroupMembers(GROUP_ADDRESS, 5); - - console.log(' - Before first query:'); - console.log(` Current page: ${stateQuery.currentPage || 'undefined'}`); - - await stateQuery.queryNextPage(); - console.log(' - After first query:'); - console.log(` Current page size: ${stateQuery.currentPage?.size}`); - console.log(` Has more: ${stateQuery.currentPage?.hasMore}`); - console.log(` Sort order: ${stateQuery.currentPage?.sortOrder}`); - - // Example 8: Paginate through group token holders (ordered by balance) - console.log('\n\n8. Fetching group token holders with pagination:'); - console.log(' Note: Results ordered by totalBalance DESC (highest first)'); - - try { - const holdersQuery = rpc.group.getGroupHolders(GROUP_ADDRESS, 5); // 5 per page - - let holderPageNum = 1; - while (await holdersQuery.queryNextPage()) { - const page = holdersQuery.currentPage!; - console.log(`\n Page ${holderPageNum}:`); - console.log(` - Found ${page.size} holders`); - console.log(` - Has more: ${page.hasMore}`); - - if (page.results.length > 0) { - console.log(' - Top holders:'); - page.results.slice(0, 3).forEach((holder: (typeof page.results)[0]) => { - const balanceInCrc = Number(holder.totalBalance) / 1e18; - console.log(` ${holder.holder}: ${balanceInCrc.toFixed(2)} CRC (${(holder.fractionOwnership * 100).toFixed(2)}%)`); - }); - } - - holderPageNum++; - if (holderPageNum > 2) break; // Limit to 2 pages for demo - } - } catch (error) { - console.log(` - Could not fetch holders: ${error instanceof Error ? error.message : 'Unknown error'}`); - } - - console.log('\n=== Pagination Examples Complete ==='); -} - -main().catch((error) => { - console.error('Error:', error); - process.exit(1); -}); diff --git a/docs/_media/examples/rpc/14-check-avatar-info.ts b/docs/_media/examples/rpc/14-check-avatar-info.ts deleted file mode 100644 index d9239c5..0000000 --- a/docs/_media/examples/rpc/14-check-avatar-info.ts +++ /dev/null @@ -1,265 +0,0 @@ -/** - * Check Avatar Information - * - * Comprehensive example to retrieve and display detailed information - * about a specific Circles avatar address. - * - * This example demonstrates: - * - Getting basic avatar information - * - Retrieving profile data - * - Checking token balances - * - Analyzing trust network - * - Viewing transaction history - * - Checking group memberships - * - Reviewing invitation information - * - * Note: This example requires a working internet connection and access - * to the Circles RPC endpoint. If you encounter connection errors, - * please verify your network connectivity. - */ - -import { CirclesRpc } from '@aboutcircles/sdk-rpc'; - -// The address to check -const TARGET_ADDRESS = '0xf3f59984a5bab94938a44229f3ee6f6d2d8e2cbe'; - -async function checkAvatarInfo() { - // Use default RPC endpoint or specify custom one - const rpc = new CirclesRpc(); - - console.log('═══════════════════════════════════════════════════════════'); - console.log(' CIRCLES AVATAR INFORMATION CHECK'); - console.log('═══════════════════════════════════════════════════════════'); - console.log(); - console.log(`Address: ${TARGET_ADDRESS}`); - console.log(); - console.log('═══════════════════════════════════════════════════════════'); - console.log(); - - // 1. Basic Avatar Information - console.log('📋 BASIC AVATAR INFORMATION'); - console.log('─'.repeat(60)); - - try { - const avatarInfo = await rpc.avatar.getAvatarInfo(TARGET_ADDRESS); - - if (!avatarInfo) { - console.log('❌ This address is not registered in Circles network'); - return; - } - - console.log('✅ Avatar found in Circles network\n'); - console.log('Avatar Details:'); - console.log(` Type: ${avatarInfo.type}`); - console.log(` Is Human: ${avatarInfo.isHuman ? '✓ Yes' : '✗ No'}`); - console.log(` Version: ${avatarInfo.version}`); - if (avatarInfo.timestamp) { - console.log(` Registered: ${new Date(avatarInfo.timestamp * 1000).toLocaleString()}`); - } - console.log(` Block Number: ${avatarInfo.blockNumber}`); - console.log(` Transaction: ${avatarInfo.transactionHash || 'N/A'}`); - - if (avatarInfo.tokenId) { - console.log(` Token ID: ${avatarInfo.tokenId}`); - } - if (avatarInfo.v1Token) { - console.log(` V1 Token: ${avatarInfo.v1Token}`); - } - if (avatarInfo.name) { - console.log(` Name: ${avatarInfo.name}`); - } - if (avatarInfo.symbol) { - console.log(` Symbol: ${avatarInfo.symbol}`); - } - if (avatarInfo.cidV0) { - console.log(` CID V0: ${avatarInfo.cidV0}`); - } - } catch (error) { - console.log('❌ Error fetching avatar info:', error instanceof Error ? error.message : error); - } - console.log(); - - // 2. Profile Information - console.log('👤 PROFILE INFORMATION'); - console.log('─'.repeat(60)); - - try { - const profile = await rpc.profile.getProfileByAddress(TARGET_ADDRESS); - - if (profile) { - console.log(` Name: ${profile.name || 'Not set'}`); - console.log(` Description: ${profile.description || 'Not set'}`); - console.log(` Location: ${profile.location || 'Not set'}`); - - if (profile.imageUrl) { - console.log(` Image URL: ${profile.imageUrl}`); - } - if (profile.previewImageUrl) { - console.log(` Preview Image: ${profile.previewImageUrl}`); - } - } else { - console.log(' No profile information set'); - } - } catch (error) { - console.log(' Error fetching profile:', error instanceof Error ? error.message : error); - } - console.log(); - - // 3. Balance Information - console.log('💰 BALANCE INFORMATION'); - console.log('─'.repeat(60)); - - try { - const totalBalance = await rpc.balance.getTotalBalance(TARGET_ADDRESS); - console.log(` Total V2 Balance: ${(Number(totalBalance) / 1e18).toFixed(4)} CRC\n`); - - const tokenBalances = await rpc.balance.getTokenBalances(TARGET_ADDRESS); - console.log(` Holds ${tokenBalances.length} different token types\n`); - - if (tokenBalances.length > 0) { - const sortedBalances = tokenBalances.sort((a, b) => b.circles - a.circles); - console.log(' Top 5 Token Holdings:'); - - sortedBalances.slice(0, 5).forEach((balance, index) => { - const isOwnToken = balance.tokenAddress.toLowerCase() === TARGET_ADDRESS.toLowerCase(); - console.log(` ${index + 1}. ${balance.circles.toFixed(4)} CRC`); - console.log(` Token: ${balance.tokenAddress}${isOwnToken ? ' (own token)' : ''}`); - console.log(` Version: v${balance.version} | ${balance.isErc20 ? 'ERC20' : 'ERC1155'}`); - console.log(); - }); - } - } catch (error) { - console.log(' Error fetching balances:', error instanceof Error ? error.message : error); - } - console.log(); - - // 4. Trust Network - console.log('🤝 TRUST NETWORK'); - console.log('─'.repeat(60)); - - try { - const aggregated = await rpc.trust.getAggregatedTrustRelations(TARGET_ADDRESS); - const mutualTrusts = await rpc.trust.getMutualTrusts(TARGET_ADDRESS); - const trusts = await rpc.trust.getTrusts(TARGET_ADDRESS); - const trustedBy = await rpc.trust.getTrustedBy(TARGET_ADDRESS); - - console.log(` Total Connections: ${aggregated.length}`); - console.log(` Mutual Trusts: ${mutualTrusts.length}`); - console.log(` Trusts (outgoing): ${trusts.length}`); - console.log(` Trusted By (incoming): ${trustedBy.length}\n`); - - if (mutualTrusts.length > 0) { - console.log(' Recent Mutual Trusts (max 5):'); - mutualTrusts.slice(0, 5).forEach((relation, index) => { - const date = new Date(relation.timestamp * 1000).toLocaleDateString(); - console.log(` ${index + 1}. ${relation.objectAvatar}`); - console.log(` Date: ${date}\n`); - }); - } - } catch (error) { - console.log(' Error fetching trust relations:', error instanceof Error ? error.message : error); - } - console.log(); - - // 5. Transaction Activity - console.log('💸 TRANSACTION ACTIVITY'); - console.log('─'.repeat(60)); - - try { - const transactions = await rpc.transaction.getTransactionHistory(TARGET_ADDRESS, 10); - console.log(` Recent Transactions: ${transactions.length}\n`); - - if (transactions && transactions.length > 0) { - const incoming = transactions.filter((tx: any) => - tx.to.toLowerCase() === TARGET_ADDRESS.toLowerCase() - ); - const outgoing = transactions.filter((tx: any) => - tx.from.toLowerCase() === TARGET_ADDRESS.toLowerCase() - ); - - console.log(` Incoming: ${incoming.length} | Outgoing: ${outgoing.length}\n`); - - console.log(' Last 5 Transactions:'); - transactions.slice(0, 5).forEach((tx: any, index: number) => { - const date = new Date(tx.timestamp * 1000).toLocaleString(); - const direction = tx.to.toLowerCase() === TARGET_ADDRESS.toLowerCase() ? '←' : '→'; - const counterparty = direction === '←' ? tx.from : tx.to; - - console.log(` ${index + 1}. ${direction} ${date}`); - console.log(` ${counterparty}`); - console.log(` Value: ${tx.value} | Version: v${tx.version}`); - console.log(` Hash: ${tx.transactionHash}\n`); - }); - } else { - console.log(' No recent transactions found'); - } - } catch (error) { - console.log(' Error fetching transactions:', error instanceof Error ? error.message : error); - } - console.log(); - - // 6. Group Memberships - console.log('👥 GROUP MEMBERSHIPS'); - console.log('─'.repeat(60)); - - try { - const membershipsQuery = rpc.group.getGroupMemberships(TARGET_ADDRESS, 50); - await membershipsQuery.queryNextPage(); - const memberships = membershipsQuery.currentPage?.results || []; - - console.log(` Member of ${memberships.length} groups\n`); - - if (memberships.length > 0) { - console.log(' Groups:'); - for (const membership of memberships.slice(0, 5)) { - console.log(` - ${membership.group}`); - console.log(` Joined: ${new Date(membership.timestamp * 1000).toLocaleDateString()}\n`); - } - } - } catch (error) { - console.log(' Error fetching group memberships:', error instanceof Error ? error.message : error); - } - console.log(); - - // 7. Invitation Information - console.log('📨 INVITATION INFORMATION'); - console.log('─'.repeat(60)); - - try { - const invitedBy = await rpc.invitation.getInvitedBy(TARGET_ADDRESS); - const acceptedInvites = await rpc.invitation.getInvitationsFrom(TARGET_ADDRESS, true); - const pendingInvites = await rpc.invitation.getInvitationsFrom(TARGET_ADDRESS, false); - - console.log(` Invited By: ${invitedBy || 'Self-registered or unknown'}`); - console.log(` Invitations Sent:`); - console.log(` Accepted: ${acceptedInvites.length}`); - console.log(` Pending: ${pendingInvites.length}`); - - if (acceptedInvites.length > 0) { - console.log(`\n Recent Accepted Invitations (max 3):`); - acceptedInvites.slice(0, 3).forEach((inviteeAddress, index) => { - console.log(` ${index + 1}. ${inviteeAddress}`); - }); - } - - if (pendingInvites.length > 0) { - console.log(`\n Pending Invitations (max 3):`); - pendingInvites.slice(0, 3).forEach((inviteeAddress, index) => { - console.log(` ${index + 1}. ${inviteeAddress}`); - }); - } - } catch (error) { - console.log(' Error fetching invitation info:', error instanceof Error ? error.message : error); - } - console.log(); - - console.log('═══════════════════════════════════════════════════════════'); - console.log('✅ Avatar information check complete!'); - console.log('═══════════════════════════════════════════════════════════'); -} - -// Run the check -checkAvatarInfo().catch((error) => { - console.error('\n❌ Fatal error:', error.message); - process.exit(1); -}); diff --git a/docs/_media/examples/runner/example-trust-zero-address.ts b/docs/_media/examples/runner/example-trust-zero-address.ts deleted file mode 100644 index dea3b66..0000000 --- a/docs/_media/examples/runner/example-trust-zero-address.ts +++ /dev/null @@ -1,159 +0,0 @@ -/** - * Example: Trust Zero Address using Circles SDK with Safe - * - * This example demonstrates how to: - * 1. Initialize the Core SDK - * 2. Create a SafeContractRunner with a human avatar - * 3. Execute a trust operation to trust the zero address - * - * The zero address (0x0000000000000000000000000000000000000000) is used - * for testing purposes to demonstrate the trust mechanism. - * - * Environment variables required (see .env): - * - PRIVATE_KEY: Private key of one of the Safe signers - * - SAFE_ADDRESS: Address of the Safe multisig wallet (human avatar) - */ - -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { parseContractError } from '@aboutcircles/sdk-utils'; -import { hubV2Abi } from '@aboutcircles/sdk-abis'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - // Configuration - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const ZERO_ADDRESS = '0x0000000000000000000000000000000000000000' as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY) { - throw new Error('PRIVATE_KEY environment variable is required'); - } - - if (!SAFE_ADDRESS) { - throw new Error('SAFE_ADDRESS environment variable is required'); - } - - console.log('🔄 Initializing Circles SDK...\n'); - - // Step 1: Initialize the Core SDK - const core = new Core(); - console.log('✅ Core SDK initialized'); - console.log(` Hub V2 Address: ${core.config.v2HubAddress}\n`); - - // Step 2: Create a public client for reading blockchain state - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - // Step 3: Create the Safe contract runner for the human avatar - const runner = new SafeContractRunner( - publicClient, - PRIVATE_KEY, - RPC_URL, - SAFE_ADDRESS - ); - - // Initialize the runner - await runner.init(); - console.log('✅ Safe contract runner initialized'); - console.log(` Human Avatar Address: ${runner.address}\n`); - - // Step 4: Check current trust status with zero address - console.log('🔍 Checking current trust status with zero address...'); - const isTrusted = await core.hubV2.isTrusted(runner.address!, ZERO_ADDRESS); - console.log(` Current trust status: ${isTrusted ? 'TRUSTED' : 'NOT TRUSTED'}\n`); - - if (isTrusted) { - console.log('ℹ️ Zero address is already trusted. No action needed.'); - return; - } - - // Step 5: Create the trust transaction - // Trust for 1 year (current time + 365 days) - const oneYearFromNow = BigInt(Math.floor(Date.now() / 1000) + 365 * 24 * 60 * 60); - - console.log('📝 Creating trust transaction for zero address...'); - const trustTx = core.hubV2.trust( - ZERO_ADDRESS, - oneYearFromNow - ); - - console.log(' Transaction details:'); - console.log(` - To: ${trustTx.to}`); - console.log(` - Target: ${ZERO_ADDRESS}`); - console.log(` - Expiry: ${oneYearFromNow} (${new Date(Number(oneYearFromNow) * 1000).toISOString()})`); - console.log(` - Data: ${trustTx.data}`); - console.log(` - Value: ${trustTx.value || 0}\n`); - - // Step 6: Estimate gas and send transaction with error handling - try { - console.log('⛽ Estimating gas...'); - const gasEstimate = await runner.estimateGas!(trustTx); - console.log(` Estimated gas: ${gasEstimate}\n`); - - // Step 7: Send the transaction - console.log('🚀 Sending trust transaction...'); - const txResponse = await runner.sendTransaction!([trustTx]); - console.log('✅ Transaction sent!'); - console.log(` Transaction hash: ${txResponse.transactionHash}`); - console.log(` Block number: ${txResponse.blockNumber}`); - console.log(` Block hash: ${txResponse.blockHash}\n`); - - // Step 8: Verify the trust was successful - console.log('🔍 Verifying trust...'); - const newTrustStatus = await core.hubV2.isTrusted(runner.address!, ZERO_ADDRESS); - console.log(` New trust status: ${newTrustStatus ? 'TRUSTED' : 'NOT TRUSTED'}\n`); - - if (newTrustStatus) { - console.log('🎉 Successfully trusted the zero address!'); - } else { - console.log('⚠️ Warning: Zero address is not trusted. The transaction may need more time to be processed.'); - } - } catch (error: any) { - // Parse the contract error - console.log('❌ Transaction failed!\n'); - - const decodedError = parseContractError(error, hubV2Abi); - - if (decodedError) { - console.log('📋 Decoded Contract Error:'); - console.log(` Error Name: ${decodedError.errorName}`); - console.log(` Error Message: ${decodedError.formattedMessage}`); - console.log(` Error Selector: ${decodedError.selector}`); - - if (decodedError.args && decodedError.args.length > 0) { - console.log(` Error Arguments:`); - decodedError.args.forEach((arg: any, index: number) => { - const value = typeof arg === 'bigint' ? arg.toString() : arg; - console.log(` [${index}]: ${value} (0x${typeof arg === 'bigint' || typeof arg === 'number' ? arg.toString(16) : arg})`); - }); - } - - console.log(`\n Raw Error Data: ${decodedError.rawData}`); - } else { - console.log('⚠️ Could not decode contract error'); - console.log(` Error Message: ${error.message}`); - } - - throw error; - } -} - -// Run the example -main() - .then(() => { - console.log('\n✨ Example completed successfully'); - process.exit(0); - }) - .catch((error) => { - console.error('\n❌ Error:', error.message); - if (error.stack) { - console.error(error.stack); - } - process.exit(1); - }); diff --git a/docs/_media/examples/sdk/error-handling.ts b/docs/_media/examples/sdk/error-handling.ts deleted file mode 100644 index 5fbec9e..0000000 --- a/docs/_media/examples/sdk/error-handling.ts +++ /dev/null @@ -1,206 +0,0 @@ -// Max is tge best -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http, type PublicClient } from 'viem'; -import { gnosis } from 'viem/chains'; -import { - CirclesError, - ValidationError, - isCirclesError, - getErrorMessage, -} from '@aboutcircles/sdk-utils'; -import { RpcError, CirclesRpc } from '@aboutcircles/sdk-rpc'; -import { ContractError, NetworkError } from '@aboutcircles/sdk-core'; -import { SdkError } from '@aboutcircles/sdk'; -import { RunnerError } from '@aboutcircles/sdk-runner'; - -async function demonstrateErrorHandling() { - console.log('🔍 Circles SDK Error Handling Examples\n'); - - // Example 1: RPC Connection Error - console.log('1️⃣ RPC Connection Error'); - try { - const invalidRpc = new CirclesRpc('https://invalid-rpc-endpoint.example.com'); - await invalidRpc.avatar.getAvatarInfo('0x0000000000000000000000000000000000000000'); - } catch (error) { - if (isCirclesError(error)) { - console.log(` Error: ${error.name}`); - console.log(` Source: ${error.source}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - if (error.context) { - console.log(` Context:`, error.context); - } - } else { - console.log(` Unexpected error: ${getErrorMessage(error)}`); - } - } - console.log(''); - - // Example 2: Validation Error - Invalid Address - console.log('2️⃣ Validation Error - Invalid Address'); - try { - throw ValidationError.invalidAddress('not-an-address'); - } catch (error) { - if (error instanceof ValidationError) { - console.log(` Error: ${error.name}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - console.log(` Context:`, error.context); - } - } - console.log(''); - - // Example 3: Validation Error - Invalid Amount - console.log('3️⃣ Validation Error - Invalid Amount'); - try { - throw ValidationError.invalidAmount(-100, 'Amount must be positive'); - } catch (error) { - if (error instanceof ValidationError) { - console.log(` Error: ${error.name}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - console.log(` Context:`, error.context); - } - } - console.log(''); - - // Example 4: Contract Error - Transaction Failed - console.log('4️⃣ Contract Error - Transaction Failed'); - try { - throw ContractError.transactionFailed( - '0x1234567890abcdef', - 'Insufficient balance', - new Error('Execution reverted') - ); - } catch (error) { - if (error instanceof ContractError) { - console.log(` Error: ${error.name}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - console.log(` Context:`, error.context); - if (error.cause instanceof Error) { - console.log(` Cause: ${error.cause.message}`); - } - } - } - console.log(''); - - // Example 5: Network Error - Wrong Network - console.log('5️⃣ Network Error - Wrong Network'); - try { - throw NetworkError.wrongNetwork(100, 1); // Expected Gnosis, got Ethereum - } catch (error) { - if (error instanceof NetworkError) { - console.log(` Error: ${error.name}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - console.log(` Context:`, error.context); - } - } - console.log(''); - - // Example 6: SDK Error - Not Initialized - console.log('6️⃣ SDK Error - Not Initialized'); - try { - throw SdkError.notInitialized('ContractRunner'); - } catch (error) { - if (error instanceof SdkError) { - console.log(` Error: ${error.name}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - console.log(` Context:`, error.context); - } - } - console.log(''); - - // Example 6b: Runner Error - Execution Failed - console.log('6️⃣b Runner Error - Execution Failed'); - try { - throw RunnerError.executionFailed( - 'Transaction reverted', - new Error('Insufficient funds') - ); - } catch (error) { - if (error instanceof RunnerError) { - console.log(` Error: ${error.name}`); - console.log(` Message: ${error.message}`); - console.log(` Code: ${error.code}`); - console.log(` Source: ${error.source}`); - if (error.cause instanceof Error) { - console.log(` Cause: ${error.cause.message}`); - } - } - } - console.log(''); - - // Example 7: Error with full context - console.log('7️⃣ Detailed Error with Context'); - try { - throw new RpcError('Failed to fetch avatar data', { - code: 'RPC_QUERY_FAILED', - cause: new Error('Network timeout'), - context: { - method: 'circles_query', - avatar: '0xde374ece6fa50e781e81aac78e811b33d16912c7', - table: 'V_Crc.Avatars', - timestamp: Date.now(), - }, - }); - } catch (error) { - if (error instanceof RpcError) { - console.log(' Full error details:'); - console.log(JSON.stringify(error.toJSON(), null, 2)); - } - } - console.log(''); - - // Example 8: Real RPC call with error handling - console.log('8️⃣ Real RPC Call with Error Handling'); - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - console.log(' ⚠️ Skipped - PRIVATE_KEY and SAFE_ADDRESS required'); - return; - } - - try { - const core = new Core(); - const publicClient = createPublicClient({ - chain: gnosis, - transport: http('https://rpc.aboutcircles.com/'), - }) as PublicClient; - - const runner = new SafeContractRunner( - publicClient, - PRIVATE_KEY, - 'https://rpc.aboutcircles.com/', - SAFE_ADDRESS - ); - await runner.init(); - - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - - // Try to get transaction history - const transactions = await avatar.history.getTransactions(5); - console.log(` ✅ Successfully fetched ${transactions.length} transactions`); - } catch (error) { - if (isCirclesError(error)) { - console.log(` ❌ Circles Error: ${error.source} - ${error.name}`); - console.log(` Message: ${error.message}`); - if (error.code) { - console.log(` Code: ${error.code}`); - } - } else { - console.log(` ❌ Unexpected error: ${getErrorMessage(error)}`); - } - } -} - -demonstrateErrorHandling().catch((error) => { - console.error('Fatal error:', error); - process.exit(1); -}); diff --git a/docs/_media/examples/sdk/events-subscription.ts b/docs/_media/examples/sdk/events-subscription.ts deleted file mode 100644 index 24d473c..0000000 --- a/docs/_media/examples/sdk/events-subscription.ts +++ /dev/null @@ -1,60 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('PRIVATE_KEY and SAFE_ADDRESS required'); - } - - console.log('🔄 Initializing SDK...\n'); - - const core = new Core(); - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - const runner = new SafeContractRunner( - publicClient, - PRIVATE_KEY, - RPC_URL, - SAFE_ADDRESS - ); - await runner.init(); - - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - - console.log('✅ SDK initialized'); - console.log(` Avatar: ${avatar.address}\n`); - - console.log('🔄 Subscribing to events...\n'); - await avatar.subscribeToEvents(); - - avatar.events.subscribe((event) => { - console.log(`📡 Event: ${event.$event}`); - console.log(` Block: ${event.blockNumber}`); - console.log(` Data:`, event); - console.log(''); - }); - - console.log('✅ Subscribed. Listening for events...'); - console.log(' Press Ctrl+C to exit\n'); - - process.on('SIGINT', () => { - console.log('\n👋 Unsubscribing...'); - avatar.unsubscribeFromEvents(); - process.exit(0); - }); - - await new Promise(() => {}); -} - -main().catch(console.error); diff --git a/docs/_media/examples/sdk/example-avatar.ts b/docs/_media/examples/sdk/example-avatar.ts deleted file mode 100644 index e53edd7..0000000 --- a/docs/_media/examples/sdk/example-avatar.ts +++ /dev/null @@ -1,95 +0,0 @@ -/** - * Example: Transaction Confirmation with Circles SDK - * - * Demonstrates transaction execution with full receipt data: - * - Transaction confirmation (waits for block inclusion) - * - Status checking (success/reverted) - * - Gas usage details - * - Event logs - * - * Environment variables required: - * - PRIVATE_KEY: Private key of one of the Safe signers - * - SAFE_ADDRESS: Address of the Safe multisig wallet (your avatar) - * - AVATAR_TO_TRUST: Address of another avatar to trust - */ - -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - // Configuration - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const AVATAR_TO_TRUST = process.env.AVATAR_TO as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS || !AVATAR_TO_TRUST) { - throw new Error('Required environment variables: PRIVATE_KEY, SAFE_ADDRESS, AVATAR_TO_TRUST'); - } - - console.log('🔄 Initializing Circles SDK...\n'); - - // Initialize Core SDK - const core = new Core(); - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - // Create and initialize Safe runner - const runner = new SafeContractRunner(publicClient, PRIVATE_KEY, RPC_URL, SAFE_ADDRESS); - await runner.init(); - - // Create HumanAvatar instance - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - console.log(`✅ Avatar initialized: ${avatar.address}\n`); - - // ============================================ - // TRANSACTION WITH CONFIRMATION - // ============================================ - console.log('═══════════════════════════════════════'); - console.log(' TRANSACTION CONFIRMATION DEMO'); - console.log('═══════════════════════════════════════\n'); - - console.log('🚀 Sending trust transaction...'); - console.log(` Trusting: ${AVATAR_TO_TRUST}`); - console.log(' Waiting for confirmation...\n'); - - try { - // Send transaction and wait for confirmation - const receipt = await avatar.trust.add(AVATAR_TO_TRUST); - - // Display transaction receipt details - console.log('✅ Transaction confirmed!\n'); - console.dir(receipt, { depth: null }); - - // Calculate transaction cost - const txCost = receipt.gasUsed * receipt.effectiveGasPrice; - const costInEth = Number(txCost) / 1e18; - console.log(` Total Cost: ${costInEth.toFixed(6)} xDAI\n`); - - } catch (error: any) { - console.error('❌ Transaction failed!\n'); - if (error.code === 'RUNNER_TX_REVERTED') { - console.error('Transaction Status: REVERTED'); - console.error('Context:', error.context); - } else { - console.error('Error:', error.message); - } - throw error; - } -} - -main() - .then(() => { - console.log('✨ Example completed successfully'); - process.exit(0); - }) - .catch((error) => { - console.error('\n❌ Error:', error.message); - process.exit(1); - }); diff --git a/docs/_media/examples/sdk/example-profile.ts b/docs/_media/examples/sdk/example-profile.ts deleted file mode 100644 index 4aeb55c..0000000 --- a/docs/_media/examples/sdk/example-profile.ts +++ /dev/null @@ -1,95 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; -import type { Profile } from '@aboutcircles/sdk-types'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('PRIVATE_KEY and SAFE_ADDRESS environment variables are required'); - } - - console.log('🔄 Initializing SDK...\n'); - - // Initialize Core SDK - const core = new Core(); - - // Create public client - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - // Create Safe contract runner - const runner = new SafeContractRunner( - publicClient, - PRIVATE_KEY, - RPC_URL, - SAFE_ADDRESS - ); - await runner.init(); - - // Create HumanAvatar instance - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - - console.log('✅ SDK initialized'); - console.log(` Avatar Address: ${avatar.address}\n`); - - // Get current profile - console.log('🔍 Fetching current profile...'); - const currentProfile = await avatar.profile.get(); - if (currentProfile) { - console.log(' Current profile:'); - console.log(` - Name: ${currentProfile.name || 'N/A'}`); - console.log(` - Description: ${currentProfile.description || 'N/A'}\n`); - } else { - console.log(' No profile found\n'); - } - - // Create new profile data - const newProfile: Profile = { - name: 'web3skeptic', - description: 'building Circles', - }; - - console.log('📝 Updating profile...'); - console.log(` Name: ${newProfile.name}`); - console.log(` Description: ${newProfile.description}\n`); - - // Update profile (pins to IPFS and updates on-chain metadata) - console.log('🚀 Sending update transaction...'); - const cid = await avatar.profile.update(newProfile); - - console.log('✅ Profile updated!'); - console.log(` CID: ${cid}\n`); - - // Verify the update - console.log('🔍 Verifying update...'); - const updatedProfile = await avatar.profile.get(); - if (updatedProfile) { - console.log(' Updated profile:'); - console.log(` - Name: ${updatedProfile.name}`); - console.log(` - Description: ${updatedProfile.description}\n`); - } - - console.log('✨ Profile update completed successfully!'); -} - -main() - .then(() => { - console.log('\n✅ Example completed'); - process.exit(0); - }) - .catch((error) => { - console.error('\n❌ Error:', error.message); - if (error.stack) { - console.error(error.stack); - } - process.exit(1); - }); diff --git a/docs/_media/examples/sdk/example-register-group.ts b/docs/_media/examples/sdk/example-register-group.ts deleted file mode 100644 index 3424c50..0000000 --- a/docs/_media/examples/sdk/example-register-group.ts +++ /dev/null @@ -1,97 +0,0 @@ -/** - * Example: Register Base Group - * - * Demonstrates how to create and register a new base group using the SDK. - * - * Environment variables required: - * - PRIVATE_KEY: Private key of one of the Safe signers - * - SAFE_ADDRESS: Address of the Safe multisig wallet that will own the group - */ - -import 'dotenv/config'; -import { Sdk } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('Required environment variables: PRIVATE_KEY, SAFE_ADDRESS'); - } - - console.log('🔄 Initializing SDK...\n'); - - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - const runner = new SafeContractRunner(publicClient, PRIVATE_KEY, RPC_URL, SAFE_ADDRESS); - await runner.init(); - - const sdk = new Sdk(undefined, runner); - console.log(`✅ SDK initialized: ${sdk.senderAddress}\n`); - - console.log('🚀 Registering base group...\n'); - - // Register a new base group - // Parameters: - // - owner: The Safe that will own the group - // - service: Service address (can be zero address if not using services) - // - feeCollection: Fee collection address (can be zero address) - // - initialConditions: Array of membership condition contract addresses - // - name: The group name (must be 19 characters or fewer) - // - symbol: The group symbol - // - profile: Profile with description, images, and other metadata - const groupAvatar = await sdk.register.asGroup( - SAFE_ADDRESS, // owner - '0x0000000000000000000000000000000000000000', // service (zero address for now) - '0x0000000000000000000000000000000000000000', // feeCollection (zero address for now) - [], // initialConditions (empty for now) - 'Test Circle Group', // name - 'TMCG', // symbol - { - name: 'Test Circle Group', - description: 'A community-managed base group in the Circles ecosystem', - imageUrl: 'https://example.com/group-image.png' - } - ); - - console.log('✅ Base group registered!'); - console.log(` Group Address: ${groupAvatar.address}`); - console.log(` Owner: ${SAFE_ADDRESS}\n`); - - // Get group properties - console.log('📋 Group Properties:'); - const owner = await groupAvatar.properties.owner(); - const service = await groupAvatar.properties.service(); - const feeCollection = await groupAvatar.properties.feeCollection(); - console.log(` Owner: ${owner}`); - console.log(` Service: ${service}`); - console.log(` Fee Collection: ${feeCollection}\n`); - - // Get the group profile - const profile = await groupAvatar.profile.get(); - if (profile) { - console.log('📝 Group Profile:'); - console.log(` Name: ${profile.name}`); - console.log(` Description: ${profile.description}`); - if ('symbol' in profile) { - console.log(` Symbol: ${profile.symbol}`); - } - } -} - -main() - .then(() => { - console.log('\n✨ Example completed'); - process.exit(0); - }) - .catch((error) => { - console.error('❌ Error:', error.message); - process.exit(1); - }); diff --git a/docs/_media/examples/sdk/example-register-org.ts b/docs/_media/examples/sdk/example-register-org.ts deleted file mode 100644 index 8a114e7..0000000 --- a/docs/_media/examples/sdk/example-register-org.ts +++ /dev/null @@ -1,58 +0,0 @@ -/** - * Example: Register Organization - * - * Minimal example to test organization registration. - * - * Environment variables required: - * - PRIVATE_KEY: Private key of one of the Safe signers - * - SAFE_ADDRESS: Address of the Safe multisig wallet (must not be registered yet) - */ - -import 'dotenv/config'; -import { Sdk } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('Required environment variables: PRIVATE_KEY, SAFE_ADDRESS'); - } - - console.log('🔄 Initializing SDK...\n'); - - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - const runner = new SafeContractRunner(publicClient, PRIVATE_KEY, RPC_URL, SAFE_ADDRESS); - await runner.init(); - - const sdk = new Sdk(undefined, runner); - console.log(`✅ SDK initialized: ${sdk.senderAddress}\n`); - - console.log('🚀 Registering organization...\n'); - - const orgAvatar = await sdk.register.asOrganization({ - name: 'Test Organization', - description: 'A test organization for Circles' - }); - - console.log('✅ Organization registered!'); - console.log(` Address: ${orgAvatar.address}\n`); -} - -main() - .then(() => { - console.log('✨ Example completed'); - process.exit(0); - }) - .catch((error) => { - console.error('❌ Error:', error.message); - process.exit(1); - }); diff --git a/docs/_media/examples/sdk/human-avatar.ts b/docs/_media/examples/sdk/human-avatar.ts deleted file mode 100644 index b5c75bc..0000000 --- a/docs/_media/examples/sdk/human-avatar.ts +++ /dev/null @@ -1,54 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('PRIVATE_KEY and SAFE_ADDRESS environment variables are required'); - } - - console.log('🔄 Initializing SDK...\n'); - - const core = new Core(); - - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - const runner = new SafeContractRunner( - publicClient, - PRIVATE_KEY, - RPC_URL, - SAFE_ADDRESS - ); - await runner.init(); - - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - - console.log('✅ SDK initialized'); - console.log(` Avatar Address: ${avatar.address}\n`); - - // Wrapping - //await avatar.wrap.asDemurraged("0xfc957a6405165ba3396362d3f8e1aee487dabc95", BigInt(10e18)); - //await avatar.wrap.asInflationary(AVATAR_ADDRESS, BigInt(100)); - - // Unwrapping - //await avatar.wrap.unwrapDemurraged("0xB0C18D263D777FAEfDe6D9038bAFCa86B4EB675B", BigInt(5e18)); - //await avatar.wrap.unwrapInflationary(WRAPPER_ADDRESS, BigInt(50)); - // Max Flow - const result = await avatar.transfer.getMaxAmountAdvanced("0xfc957a6405165ba3396362d3f8e1aee487dabc95", { - useWrappedBalances: false, - fromTokens: ["0xc7d3dF890952a327Af94D5Ba6fdC1Bf145188a1b"] - }) - console.log("Max transfer flow: ", result); -} - -main().catch(console.error); diff --git a/docs/_media/examples/sdk/invite-test.ts b/docs/_media/examples/sdk/invite-test.ts deleted file mode 100644 index f2d3fe1..0000000 --- a/docs/_media/examples/sdk/invite-test.ts +++ /dev/null @@ -1,88 +0,0 @@ -import 'dotenv/config'; -import { Sdk } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { circlesConfig } from '@aboutcircles/sdk-core'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const INVITEE_SAFE = '0xAF1A6234BdF783af95e4501e23af8b30a1Ddcef7'; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('PRIVATE_KEY and SAFE_ADDRESS environment variables are required'); - } - - console.log('🔄 Initializing...\n'); - const publicClient = createPublicClient({ chain: gnosis, transport: http(RPC_URL) }); - - // Inviter setup - const inviterRunner = new SafeContractRunner(publicClient, PRIVATE_KEY, RPC_URL, SAFE_ADDRESS); - await inviterRunner.init(); - const inviterSdk = new Sdk(circlesConfig[100], inviterRunner); - const inviter = await inviterSdk.getAvatar(SAFE_ADDRESS); - - console.log(`📬 Inviter: ${SAFE_ADDRESS}`); - console.log(`📬 Invitee: ${INVITEE_SAFE}\n`); - - try { - // Step 1: Inviter sends invitation (trust + 100 CRC to escrow) - console.log('🚀 Sending invitation...'); - const inviteTxReceipt = await inviter.invite.send(INVITEE_SAFE); - - // Verify transaction was included in blockchain - if (!inviteTxReceipt) { - throw new Error('No transaction receipt returned from invite.send()'); - } - - const txHash = (inviteTxReceipt as any).transactionHash || (inviteTxReceipt as any).hash; - console.log(`📝 Transaction: ${txHash}`); - - if (txHash) { - console.log('⏳ Waiting for blockchain confirmation...'); - const receipt = await publicClient.waitForTransactionReceipt({ hash: txHash as `0x${string}` }); - console.log(`✅ Confirmed in block #${receipt.blockNumber}`); - console.log(` Status: ${receipt.status === 'success' ? '✓ Success' : '✗ Failed'}\n`); - - if (receipt.status !== 'success') { - throw new Error('Transaction failed on blockchain'); - } - } - - // Step 2: Invitee setup (same private key, different Safe) - - const inviteeRunner = new SafeContractRunner(publicClient, PRIVATE_KEY, RPC_URL, INVITEE_SAFE); - await inviteeRunner.init(); - const inviteeSdk = new Sdk(circlesConfig[100], inviteeRunner); - - // Step 3: Invitee redeems invitation & registers - console.log('🚀 Invitee redeeming invitation and registering...'); - const regTxReceipt = await inviteeSdk.register.asHuman(SAFE_ADDRESS, { - name: 'InvitationOracle', - description: 'Created to invite others' - }); - console.log(`✅ Registered: ${regTxReceipt.address}`); - - // Verify registration was included in blockchain - const regTxHash = (regTxReceipt as any).transactionHash || (regTxReceipt as any).hash; - if (regTxHash) { - console.log(`📝 Registration TX: ${regTxHash}`); - console.log('⏳ Waiting for blockchain confirmation...'); - const regReceipt = await publicClient.waitForTransactionReceipt({ hash: regTxHash as `0x${string}` }); - console.log(`✅ Confirmed in block #${regReceipt.blockNumber}\n`); - } - - // Step 4: Verify invitation was redeemed - const invitees = await inviter.invite.getInvitees(); - console.log(`✅ Workflow complete!`); - console.log(` Inviter sent ${invitees.length} invitation(s)`); - console.log(` Invitee registered successfully`); - } catch (error) { - console.error('\n❌ Error:', error instanceof Error ? error.message : error); - throw error; - } -} - -main().catch(console.error); diff --git a/docs/_media/examples/sdk/personal-token-mintable.ts b/docs/_media/examples/sdk/personal-token-mintable.ts deleted file mode 100644 index 5091197..0000000 --- a/docs/_media/examples/sdk/personal-token-mintable.ts +++ /dev/null @@ -1,72 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { CirclesConverter } from '@aboutcircles/sdk-utils'; -import type { Address } from '@aboutcircles/sdk-types'; - -/** - * Personal Token Mintable Amount Example - * - * This example demonstrates: - * - Checking mintable amounts for a human avatar - * - Getting issuance details including amount, start period, and end period - * - Converting between atto-circles and human-readable CRC format - * - * Usage: - * - Set AVATAR_ADDRESS in your .env file (must be a registered human avatar) - * - Run: bun examples/sdk/personal-token-mintable.ts - * - * Example addresses you can try: - * - 0x764E314b52681a4dA39b442d399af07Ce46632Ca (has ~113 CRC available) - */ - -async function main() { - const AVATAR_ADDRESS = ( - process.env.AVATAR_ADDRESS || - '0x764E314b52681a4dA39b442d399af07Ce46632Ca' - ) as Address; - - console.log('🔄 Initializing Core...\n'); - - const core = new Core(); - - console.log('✅ Core initialized'); - console.log(` Avatar Address: ${AVATAR_ADDRESS}\n`); - - try { - console.log('📊 Fetching personal token issuance information...\n'); - - // Call calculateIssuance directly from HubV2 contract - const [amount, startPeriod, endPeriod] = await core.hubV2.calculateIssuance(AVATAR_ADDRESS); - - // Display results - console.log('=== Personal Token Issuance ===\n'); - console.log(`Mintable Amount (atto-circles): ${amount.toString()}`); - console.log(`Mintable Amount (CRC): ${CirclesConverter.attoCirclesToCircles(amount).toFixed(4)} CRC\n`); - console.log(`Start Period: ${startPeriod.toString()}`); - console.log(`End Period: ${endPeriod.toString()}`); - console.log(`Period Range: ${(endPeriod - startPeriod).toString()} periods\n`); - - // Additional helpful info - if (amount > 0n) { - console.log('✅ Tokens are available to mint!'); - console.log(` You can call avatar.personalToken.mint() to claim ${CirclesConverter.attoCirclesToCircles(amount).toFixed(4)} CRC\n`); - console.log(`Note: This is equivalent to calling avatar.personalToken.getMintableAmount() in the SDK\n`); - } else { - console.log('ℹ️ No tokens available to mint at this time.\n'); - } - - } catch (error: any) { - console.error('❌ Error:', error.message || error); - throw error; - } -} - -main() - .then(() => { - console.log('✅ Example completed successfully'); - process.exit(0); - }) - .catch((error) => { - console.error('❌ Example failed:', error); - process.exit(1); - }); diff --git a/docs/_media/examples/sdk/test-replenish.ts b/docs/_media/examples/sdk/test-replenish.ts deleted file mode 100644 index c7ac022..0000000 --- a/docs/_media/examples/sdk/test-replenish.ts +++ /dev/null @@ -1,45 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; -import { CirclesConverter } from '@aboutcircles/sdk-utils'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('PRIVATE_KEY and SAFE_ADDRESS required'); - } - - const core = new Core(); - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - const runner = new SafeContractRunner(publicClient, PRIVATE_KEY, RPC_URL, SAFE_ADDRESS); - await runner.init(); - - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - - console.log(`Avatar: ${avatar.address}\n`); - - // Check max replenishable amount - const maxReplenishable = await avatar.balances.getMaxReplenishable(); - console.log(`Max replenishable: ${CirclesConverter.attoCirclesToCircles(maxReplenishable)} CRC\n`); - - if (maxReplenishable === 0n) { - console.log('No tokens available to replenish'); - return; - } - - // Replenish: convert wrapped/other tokens to unwrapped personal CRC - const receipt = await avatar.balances.replenish(); - console.log(`Replenished successfully: ${receipt.blockHash}`); -} - -main().catch(console.error); diff --git a/docs/_media/examples/sdk/test-wrapper.ts b/docs/_media/examples/sdk/test-wrapper.ts deleted file mode 100644 index ece399e..0000000 --- a/docs/_media/examples/sdk/test-wrapper.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { Sdk } from '../../packages/sdk/src'; - -async function main() { - const sdk = new Sdk(); - - // Test with a known avatar address - const avatarAddress = '0xfc957a6405165ba3396362d3f8e1aee487dabc95' as const; - - const inflationaryWrapper = await sdk.tokens.getDemurragedWrapper(avatarAddress); - console.log(inflationaryWrapper); - - //const demurragedWrapper = await sdk.tokens.getDemurragedWrapper(avatarAddress); - //console.log(demurragedWrapper); -} - -main().catch(console.error); diff --git a/docs/_media/examples/sdk/transfer-builder-example.ts b/docs/_media/examples/sdk/transfer-builder-example.ts deleted file mode 100644 index b2a0414..0000000 --- a/docs/_media/examples/sdk/transfer-builder-example.ts +++ /dev/null @@ -1,197 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { TransferBuilder } from '@aboutcircles/sdk-transfers'; -import { CirclesConverter } from '@aboutcircles/sdk-utils'; -import { Address } from '@aboutcircles/sdk-types'; - -/** - * Example demonstrating the TransferBuilder.constructAdvancedTransfer method - * - * This example shows how to construct transfer transactions with wrapped tokens (ERC20) - * without executing them immediately. The builder handles: - * - * 1. Fetching balances and filtering wrapped tokens - * 2. Creating unwrap calls for ERC20 tokens (demurraged and inflationary) - * 3. Building the operateFlowMatrix call - * 4. Creating wrap calls for leftover inflationary tokens - */ -async function main() { - const RPC_URL = process.env.RPC_URL || 'https://rpc.aboutcircles.com/'; - const CIRCLES_RPC_URL = process.env.CIRCLES_RPC_URL || 'https://rpc.aboutcircles.com/'; - - console.log('='.repeat(80)); - console.log('TransferBuilder.constructAdvancedTransfer Example'); - console.log('='.repeat(80)); - console.log(); - - // Initialize Core - console.log('🔄 Initializing Core...'); - const core = new Core({ - rpcUrl: RPC_URL, - circlesRpcUrl: CIRCLES_RPC_URL, - }); - console.log('✅ Core initialized\n'); - - // Initialize TransferBuilder - console.log('🔄 Initializing TransferBuilder...'); - const transferBuilder = new TransferBuilder(core); - console.log('✅ TransferBuilder initialized\n'); - - // Example addresses - replace with actual addresses - const fromAddress = process.env.FROM_ADDRESS as Address || '0x7CadF434b692ca029D950607A4b3F139c30d4e98' as Address; - const toAddress = process.env.TO_ADDRESS as Address || '0x764E314b52681a4dA39b442d399af07Ce46632Ca' as Address; - - // Amount to transfer: 10 CRC - const amountInCircles = 10; - const amountInAttoCircles = CirclesConverter.circlesToAttoCircles(amountInCircles); - - console.log('📊 Transfer Parameters:'); - console.log(` From: ${fromAddress}`); - console.log(` To: ${toAddress}`); - console.log(` Amount: ${amountInCircles} CRC (${amountInAttoCircles} attoCircles)`); - console.log(); - - try { - // Scenario 1: Basic transfer without wrapped tokens - console.log('━'.repeat(80)); - console.log('Scenario 1: Basic Transfer (no wrapped tokens)'); - console.log('━'.repeat(80)); - console.log(); - - const basicOptions = { - useWrappedBalances: false, - }; - - console.log('🚀 Constructing basic transfer...\n'); - const basicTxs = await transferBuilder.constructAdvancedTransfer( - fromAddress, - toAddress, - amountInAttoCircles, - basicOptions - ); - - console.log(`\n✅ Basic transfer constructed: ${basicTxs.length} transaction(s)`); - basicTxs.forEach((tx, index) => { - console.log(` ${index + 1}. to: ${tx.to}`); - console.log(` data: ${tx.data.substring(0, 66)}...`); - console.log(` value: ${tx.value}`); - }); - console.log(); - - // Scenario 2: Advanced transfer with wrapped tokens - console.log('━'.repeat(80)); - console.log('Scenario 2: Advanced Transfer (with wrapped tokens)'); - console.log('━'.repeat(80)); - console.log(); - - const advancedOptions = { - useWrappedBalances: true, // Enable wrapped ERC20 tokens - // Optional: exclude specific tokens - // excludeFromTokens: ['0x...' as Address], - // Optional: specify which tokens to use - // fromTokens: ['0x...' as Address], - // toTokens: ['0x...' as Address], - }; - - console.log('🚀 Constructing advanced transfer with wrapped tokens...\n'); - const advancedTxs = await transferBuilder.constructAdvancedTransfer( - fromAddress, - toAddress, - amountInAttoCircles, - advancedOptions - ); - - console.log(`\n✅ Advanced transfer constructed: ${advancedTxs.length} transaction(s)`); - console.log('\n📋 Transaction Details:'); - advancedTxs.forEach((tx, index) => { - console.log(`\n Transaction ${index + 1}:`); - console.log(` Target: ${tx.to}`); - console.log(` Data: ${tx.data.substring(0, 66)}...`); - console.log(` Value: ${tx.value}`); - - // Try to identify transaction type - const dataPrefix = tx.data.substring(0, 10); - let txType = 'Unknown'; - if (dataPrefix === '0xa22cb465') txType = 'setApprovalForAll'; - else if (dataPrefix === '0xde0e9a3e') txType = 'unwrap'; - else if (dataPrefix === '0xea598cb0') txType = 'wrap'; - else if (dataPrefix.includes('f4f3bdc1')) txType = 'operateFlowMatrix'; - - console.log(` Type: ${txType}`); - }); - console.log(); - - // Scenario 3: Self-transfer unwrap operation - console.log('━'.repeat(80)); - console.log('Scenario 3: Self-Transfer Unwrap (optimized path)'); - console.log('━'.repeat(80)); - console.log(); - - console.log('🚀 Constructing self-transfer unwrap...\n'); - - // This would be a wrapped token address owned by the sender - const wrappedTokenAddress = '0x...' as Address; // Replace with actual wrapper - const ownTokenAddress = fromAddress; // The underlying token - - const unwrapOptions = { - useWrappedBalances: true, - fromTokens: [wrappedTokenAddress], - toTokens: [ownTokenAddress], - }; - - try { - const unwrapTxs = await transferBuilder.constructAdvancedTransfer( - fromAddress, - fromAddress, // Same address = self-transfer - amountInAttoCircles, - unwrapOptions - ); - - console.log(`\n✅ Self-transfer unwrap constructed: ${unwrapTxs.length} transaction(s)`); - unwrapTxs.forEach((tx, index) => { - console.log(` ${index + 1}. to: ${tx.to}`); - console.log(` data: ${tx.data.substring(0, 66)}...`); - }); - } catch (error: any) { - console.log('⚠️ Self-transfer scenario skipped (may need valid wrapped token)'); - console.log(` Error: ${error.message}`); - } - console.log(); - - // Summary - console.log('━'.repeat(80)); - console.log('Summary'); - console.log('━'.repeat(80)); - console.log(); - console.log('✅ TransferBuilder.constructAdvancedTransfer handles:'); - console.log(' 1. Balance fetching and validation'); - console.log(' 2. Pathfinding with wrapped token support'); - console.log(' 3. Unwrapping ERC20 tokens (demurraged: exact amount, inflationary: full balance)'); - console.log(' 4. Flow matrix construction'); - console.log(' 5. Wrapping leftover inflationary tokens back'); - console.log(); - console.log('💡 Transaction order:'); - console.log(' 1. Self-approval (if needed)'); - console.log(' 2. Unwrap calls (for wrapped ERC20 tokens)'); - console.log(' 3. operateFlowMatrix (the actual transfer)'); - console.log(' 4. Wrap calls (for leftover inflationary tokens)'); - console.log(); - console.log('🎯 These transactions can be:'); - console.log(' - Sent directly to a wallet/signer'); - console.log(' - Batched together in a Safe multisig'); - console.log(' - Executed through any compatible runner'); - console.log(); - - } catch (error: any) { - console.error('\n❌ Error:', error.message); - if (error.code) { - console.error(` Code: ${error.code}`); - } - if (error.context) { - console.error(' Context:', JSON.stringify(error.context, null, 2)); - } - console.error('\n Stack:', error.stack); - } -} - -main().catch(console.error); diff --git a/docs/_media/examples/sdk/transfer-test.ts b/docs/_media/examples/sdk/transfer-test.ts deleted file mode 100644 index c057407..0000000 --- a/docs/_media/examples/sdk/transfer-test.ts +++ /dev/null @@ -1,78 +0,0 @@ -import 'dotenv/config'; -import { Core } from '@aboutcircles/sdk-core'; -import { HumanAvatar } from '@aboutcircles/sdk'; -import { SafeContractRunner } from '@aboutcircles/sdk-runner'; -import { createPublicClient, http } from 'viem'; -import { gnosis } from 'viem/chains'; -import { CirclesConverter } from '@aboutcircles/sdk-utils'; -import { Address } from '@aboutcircles/sdk-types'; - -async function main() { - const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`; - const SAFE_ADDRESS = process.env.SAFE_ADDRESS as `0x${string}`; - const RPC_URL = 'https://rpc.aboutcircles.com/'; - - if (!PRIVATE_KEY || !SAFE_ADDRESS) { - throw new Error('PRIVATE_KEY and SAFE_ADDRESS environment variables are required'); - } - - console.log('🔄 Initializing SDK...\n'); - - const core = new Core(); - - const publicClient = createPublicClient({ - chain: gnosis, - transport: http(RPC_URL), - }); - - const runner = new SafeContractRunner( - publicClient, - PRIVATE_KEY, - RPC_URL, - SAFE_ADDRESS - ); - await runner.init(); - - const avatar = new HumanAvatar(SAFE_ADDRESS, core, runner); - - console.log('✅ SDK initialized'); - console.log(` Avatar Address: ${avatar.address}\n`); - - // Recipient address - const recipientAddress = '0x764E314b52681a4dA39b442d399af07Ce46632Ca'; - - // Amount to transfer: 8 CRC - const amountInCircles = 10; - const amountInAttoCircles = CirclesConverter.circlesToAttoCircles(amountInCircles); - - try { - const options = { - fromTokens: [ - "0x62cff728961f4db36cca294cb430ae15025b1f24", - "0x25f3abed092086cc5d569488d9de9012153f19a4", - "0xfb4e4ca590b0ea4fdcf1d4764b64052dd599c62a" - ] as Address[], - useWrappedBalances: true, // Enable this to use wrapped tokens (ERC20 wrappers) - }; - // First, check the maximum transferable amount - console.log('🔍 Checking maximum transferable amount...'); - const maxAmount = await avatar.transfer.getMaxAmountAdvanced(recipientAddress, options); - console.log(`✅ Maximum transferable amount: ${CirclesConverter.attoCirclesToCircles(maxAmount)} CRC\n`); - - - // Perform the advanced transfer - console.log('🚀 Executing advanced transfer...'); - - const receipt = await avatar.transfer.advanced( - recipientAddress, - amountInAttoCircles, - options - ); - - console.log('\n✅ Transfer successful:', receipt.blockHash); - } catch (error) { - console.error('\n❌ Transfer failed:', error); - } -} - -main().catch(console.error); diff --git a/docs/_media/modules.md b/docs/_media/modules.md index f84e8d7..985bec1 100644 --- a/docs/_media/modules.md +++ b/docs/_media/modules.md @@ -11,6 +11,7 @@ - [core/src](core/src/README.md) - [pathfinder/src](pathfinder/src/README.md) - [profiles/src](profiles/src/README.md) +- [referrals/src](referrals/src/README.md) - [rpc/src](rpc/src/README.md) - [runner/src](runner/src/README.md) - [transfers/src](transfers/src/README.md) diff --git a/docs/_media/pathfinder/package.json b/docs/_media/pathfinder/package.json index 7f6aac0..8e0cbdf 100644 --- a/docs/_media/pathfinder/package.json +++ b/docs/_media/pathfinder/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-pathfinder", - "version": "0.1.0", + "version": "0.1.5", "description": "Pathfinding utilities for Circles SDK", "type": "module", "main": "./dist/index.js", @@ -23,6 +23,10 @@ "circles", "pathfinding" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "@aboutcircles/sdk-rpc": "*", diff --git a/docs/_media/profiles/package.json b/docs/_media/profiles/package.json index 81a2709..5aca08f 100644 --- a/docs/_media/profiles/package.json +++ b/docs/_media/profiles/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-profiles", - "version": "0.1.0", + "version": "0.1.5", "description": "Minimal IPFS/CID pinning service for Circles profiles", "type": "module", "main": "./dist/index.js", @@ -26,6 +26,10 @@ "profiles", "pinning" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "@aboutcircles/sdk-types": "*" diff --git a/docs/_media/rpc/package.json b/docs/_media/rpc/package.json index 87e52b6..9d184d4 100644 --- a/docs/_media/rpc/package.json +++ b/docs/_media/rpc/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-rpc", - "version": "0.1.0", + "version": "0.1.5", "description": "Circles RPC wrapper", "type": "module", "main": "./dist/index.js", @@ -15,6 +15,11 @@ "files": [ "dist" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, + "license": "MIT", "scripts": { "build": "bun build ./src/index.ts --outdir ./dist --format esm --splitting && tsc --emitDeclarationOnly", "dev": "tsc --watch" diff --git a/docs/_media/rpc/src/utils.ts b/docs/_media/rpc/src/utils.ts index 3b61388..944c074 100644 --- a/docs/_media/rpc/src/utils.ts +++ b/docs/_media/rpc/src/utils.ts @@ -1,4 +1,4 @@ -import type { Address, FindPathParams, SimulatedBalance } from '@aboutcircles/sdk-types'; +import type { Address, FindPathParams, SimulatedBalance, SimulatedTrust } from '@aboutcircles/sdk-types'; import { checksumAddress as toChecksumAddress } from '@aboutcircles/sdk-utils'; /** @@ -86,6 +86,10 @@ export function normalizeFindPathParams(params: FindPathParams): Record ({ + Truster: normalizeAddress(trust.truster), + Trustee: normalizeAddress(trust.trustee), + })), MaxTransfers: params.maxTransfers, }; } diff --git a/docs/_media/runner/package.json b/docs/_media/runner/package.json index 3a24555..ca6cc15 100644 --- a/docs/_media/runner/package.json +++ b/docs/_media/runner/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-runner", - "version": "0.1.0", + "version": "0.1.5", "description": "Contract runner implementations for Circles SDK", "type": "module", "main": "./dist/index.js", @@ -25,6 +25,10 @@ "ethereum", "viem" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "@aboutcircles/sdk-types": "*", diff --git a/docs/_media/sdk/README.md b/docs/_media/sdk/README.md index 75ba6f5..6d92221 100644 --- a/docs/_media/sdk/README.md +++ b/docs/_media/sdk/README.md @@ -203,27 +203,23 @@ await sdk.profiles.createOrUpdate({ ## Implementation Status -⚠️ **Note**: This package is currently a skeleton implementation. Most methods throw "Not yet implemented" errors and are marked with TODO comments. The purpose is to establish the API surface for future implementation. +✅ **Status**: This SDK is feature-complete and production-ready. All core functionality has been implemented. ### Implemented Features - ✅ SDK initialization with configuration -- ✅ Avatar retrieval (getAvatar) -- ✅ Profile retrieval by CID (via profiles package) - -### Not Yet Implemented - -Most features are marked with TODO and will throw errors: - -- Registration methods (asHuman, asOrganization, asGroup) -- Balance operations -- Transfer operations -- Trust operations -- Personal token minting -- Profile updates -- Group operations -- Token wrapping -- Event streaming +- ✅ Avatar retrieval and type detection (getAvatar) +- ✅ Registration methods (asHuman, asOrganization, asGroup) +- ✅ Balance operations (total, detailed token balances) +- ✅ Transfer operations (direct transfers, pathfinding with advanced options) +- ✅ Trust operations (add, remove, check trust status) +- ✅ Personal token minting and management +- ✅ Profile management (get, update, metadata, short names) +- ✅ Group operations (members, holders, collateral, treasury) +- ✅ Token wrapping (demurraged and inflationary ERC20) +- ✅ Event subscriptions and streaming +- ✅ Transaction history +- ✅ Profile creation and management via IPFS ## Architecture @@ -237,12 +233,13 @@ The SDK package wraps and simplifies the following packages: ## Contributing -To implement a method: +To extend or improve the SDK: -1. Remove the "TODO" comment -2. Replace the `throw new Error('not yet implemented')` with actual implementation -3. Use the underlying packages (core, rpc, profiles, etc.) to implement functionality -4. Add tests and update documentation +1. Update existing methods or add new features as needed +2. Leverage the underlying packages (core, rpc, profiles, transfers, etc.) +3. Add tests and update documentation +4. Ensure all changes maintain backward compatibility +5. Follow the established patterns and code style in the SDK ## License diff --git a/docs/_media/sdk/package.json b/docs/_media/sdk/package.json index 3f49a7f..9e4db75 100644 --- a/docs/_media/sdk/package.json +++ b/docs/_media/sdk/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk", - "version": "0.1.0", + "version": "0.1.5", "description": "Simplified Circles SDK for non-crypto users with low entrance barrier", "type": "module", "main": "./dist/index.js", @@ -12,7 +12,7 @@ } }, "scripts": { - "build": "bun build ./src/index.ts --outdir ./dist --format esm --splitting && tsc --emitDeclarationOnly", + "build": "bun build ./src/index.ts --outdir ./dist --format esm && tsc --emitDeclarationOnly", "dev": "tsc --build --watch", "clean": "rm -rf dist tsconfig.tsbuildinfo" }, @@ -26,12 +26,17 @@ "web3", "ubi" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "@aboutcircles/sdk-types": "*", "@aboutcircles/sdk-core": "*", "@aboutcircles/sdk-rpc": "*", "@aboutcircles/sdk-profiles": "*", + "@aboutcircles/sdk-referrals": "*", "@aboutcircles/sdk-utils": "*", "@aboutcircles/sdk-runner": "*", "@aboutcircles/sdk-pathfinder": "*", diff --git a/docs/_media/sdk/src/Sdk.ts b/docs/_media/sdk/src/Sdk.ts index 31ba7d2..9e97e72 100644 --- a/docs/_media/sdk/src/Sdk.ts +++ b/docs/_media/sdk/src/Sdk.ts @@ -11,6 +11,7 @@ import type { import type { GroupTokenHolderRow } from '@aboutcircles/sdk-rpc'; import { circlesConfig, Core, CirclesType, BaseGroupContract } from '@aboutcircles/sdk-core'; import { Profiles } from '@aboutcircles/sdk-profiles'; +import { Referrals } from '@aboutcircles/sdk-referrals'; import { CirclesRpc, PagedQuery } from '@aboutcircles/sdk-rpc'; import { cidV0ToHex } from '@aboutcircles/sdk-utils'; import { HumanAvatar, OrganisationAvatar, BaseGroupAvatar } from './avatars'; @@ -54,6 +55,7 @@ export class Sdk { public readonly core: Core; public readonly rpc: CirclesRpc; private readonly profilesClient: Profiles; + private readonly referralsClient?: Referrals; public readonly data: CirclesData = { getAvatar: async (address: Address): Promise => { @@ -81,6 +83,11 @@ export class Sdk { this.rpc = new CirclesRpc(config.circlesRpcUrl); this.profilesClient = new Profiles(config.profileServiceUrl); + // Initialize referrals client if service URL is configured + if (config.referralsServiceUrl) { + this.referralsClient = new Referrals(config.referralsServiceUrl); + } + // Validate and extract sender address from contract runner if (contractRunner) { if (!contractRunner.sendTransaction) { @@ -99,25 +106,38 @@ export class Sdk { /** * Get an avatar by address * Automatically detects the avatar type and returns the appropriate avatar instance + * + * @param avatarAddress The address of the avatar to fetch + * @param autoSubscribeEvents Whether to automatically subscribe to events for this avatar (default: false) + * If true, waits for event subscription to complete before returning * @returns HumanAvatar, OrganisationAvatar, or BaseGroupAvatar depending on type */ - async getAvatar(avatarAddress: Address): Promise { + async getAvatar(avatarAddress: Address, autoSubscribeEvents: boolean = false): Promise { try { const avatarInfo = await this.rpc.avatar.getAvatarInfo(avatarAddress); // Detect avatar type and return appropriate avatar class const avatarType = (avatarInfo as any)?.type; + let avatar: HumanAvatar | OrganisationAvatar | BaseGroupAvatar; + if (avatarType === 'CrcV2_RegisterGroup') { - return new BaseGroupAvatar(avatarAddress, this.core, this.contractRunner, avatarInfo as any); + avatar = new BaseGroupAvatar(avatarAddress, this.core, this.contractRunner, avatarInfo as any); + } else if (avatarType === 'CrcV2_RegisterOrganization') { + avatar = new OrganisationAvatar(avatarAddress, this.core, this.contractRunner, avatarInfo as any); + } else { + // Default to HumanAvatar for human type + avatar = new HumanAvatar(avatarAddress, this.core, this.contractRunner, avatarInfo as any); } - if (avatarType === 'CrcV2_RegisterOrganization') { - return new OrganisationAvatar(avatarAddress, this.core, this.contractRunner, avatarInfo as any); + // If auto-subscription is enabled, wait for it to complete before returning + // This prevents race conditions where stores subscribe to avatar.events before it's ready + if (autoSubscribeEvents) { + console.log('🔔 Sdk.getAvatar: Auto-subscribing to events for', avatarAddress); + await avatar.subscribeToEvents(); } - // Default to HumanAvatar for human type - return new HumanAvatar(avatarAddress, this.core, this.contractRunner, avatarInfo as any); + return avatar; } catch (error) { throw SdkError.avatarNotFound(avatarAddress); } @@ -443,6 +463,64 @@ export class Sdk { }, }; + /** + * Referral/invitation management methods + * + * The referrals backend enables users to invite others via referral links. + * Requires referralsServiceUrl to be configured in CirclesConfig. + */ + public readonly referrals = { + /** + * Store a referral private key + * + * The private key is validated on-chain via ReferralsModule.accounts() to ensure + * the account exists and has not been claimed. The inviter address is self-declared + * for dashboard visibility only. + * + * @param privateKey - The referral private key (0x-prefixed, 64 hex chars) + * @param inviter - Self-declared inviter address for dashboard visibility + * @throws Error if referrals service not configured or validation fails + */ + store: async (privateKey: string, inviter: Address): Promise => { + if (!this.referralsClient) { + throw SdkError.configError('Referrals service not configured. Set referralsServiceUrl in CirclesConfig.'); + } + return await this.referralsClient.store(privateKey, inviter); + }, + + /** + * Retrieve referral info by private key + * + * This is a public endpoint - no authentication required. + * Used by invitees to look up who invited them. + * + * @param privateKey - The referral private key + * @returns Referral info including inviter and status + * @throws Error if referrals service not configured or referral not found + */ + retrieve: async (privateKey: string) => { + if (!this.referralsClient) { + throw SdkError.configError('Referrals service not configured. Set referralsServiceUrl in CirclesConfig.'); + } + return await this.referralsClient.retrieve(privateKey); + }, + + /** + * List all referrals created by the authenticated user + * + * Requires authentication - must configure a token provider. + * + * @returns List of referrals with their status and metadata + * @throws Error if referrals service not configured or not authenticated + */ + listMine: async () => { + if (!this.referralsClient) { + throw SdkError.configError('Referrals service not configured. Set referralsServiceUrl in CirclesConfig.'); + } + return await this.referralsClient.listMine(); + }, + }; + /** * Token utilities */ diff --git a/docs/_media/sdk/src/avatars/CommonAvatar.ts b/docs/_media/sdk/src/avatars/CommonAvatar.ts index f93db98..c26c6af 100644 --- a/docs/_media/sdk/src/avatars/CommonAvatar.ts +++ b/docs/_media/sdk/src/avatars/CommonAvatar.ts @@ -52,6 +52,7 @@ export abstract class CommonAvatar { protected _cachedProfile?: Profile; protected _cachedProfileCid?: string; protected _eventSubscription?: () => void; + private _hasSubscribed = false; constructor( address: Address, @@ -88,6 +89,7 @@ export abstract class CommonAvatar { this.transferBuilder = new TransferBuilder(core); // Event subscription is optional - initialize with stub observable + // Actual subscription is handled by Sdk.getAvatar() when autoSubscribeEvents is enabled const stub = ObservableClass.create(); this.events = stub.property; } @@ -689,6 +691,7 @@ export abstract class CommonAvatar { /** * Subscribe to Circles events for this avatar * Events are filtered to only include events related to this avatar's address + * This method is idempotent - calling it multiple times will not create duplicate subscriptions * * @returns Promise that resolves when subscription is established * @@ -707,9 +710,25 @@ export abstract class CommonAvatar { * ``` */ async subscribeToEvents(): Promise { - // Subscribe to events via RPC WebSocket - const observable = await this.rpc.client.subscribe(this.address); - this.events = observable; + // Make idempotent - only subscribe once + if (this._hasSubscribed) { + return; + } + this._hasSubscribed = true; + + try { + // Subscribe to events via RPC WebSocket + const observable = await this.rpc.client.subscribe(this.address); + this.events = observable; + } catch (e) { + // Reset flag on error so it can be retried + this._hasSubscribed = false; + throw SdkError.operationFailed( + 'subscribeToEvents', + 'Failed to subscribe to avatar events', + e + ); + } } /** diff --git a/docs/_media/sdk/src/avatars/HumanAvatar.ts b/docs/_media/sdk/src/avatars/HumanAvatar.ts index f41add0..2f3b1e7 100644 --- a/docs/_media/sdk/src/avatars/HumanAvatar.ts +++ b/docs/_media/sdk/src/avatars/HumanAvatar.ts @@ -7,12 +7,14 @@ import type { GroupRow, AggregatedTrustRelation } from '@aboutcircles/sdk-types'; -import type { TransactionReceipt } from 'viem'; +import type { TransactionReceipt, Hex } from 'viem'; import type { Core } from '@aboutcircles/sdk-core'; import { ValidationError } from '@aboutcircles/sdk-utils'; import { SdkError } from '../errors'; import { BaseGroupContract } from '@aboutcircles/sdk-core'; -import { encodeAbiParameters, parseAbiParameters } from 'viem'; +import { encodeAbiParameters, parseAbiParameters, encodeFunctionData } from 'viem'; +import { referralsModuleAbi } from '@aboutcircles/sdk-abis'; +import { generatePrivateKey, privateKeyToAccount } from 'viem/accounts'; import { CommonAvatar, type PathfindingOptions } from './CommonAvatar'; /** @@ -301,6 +303,137 @@ export class HumanAvatar extends CommonAvatar { getEscrowedAmount: async (inviter: Address, invitee: Address) => { return await this.core.invitationEscrow.getEscrowedAmountAndDays(inviter, invitee); }, + + /** + * Generate new invitations and return associated secrets and signer addresses + * + * This function: + * 1. Calls invitationFarm.claimInvites() to get invitation IDs via eth_call + * 2. Generates random secrets for each invitation + * 3. Derives signer addresses from the secrets using ECDSA + * 4. Batches the claimInvites write call with safeBatchTransferFrom to transfer + * invitation tokens (96 CRC each) to the invitation module + * 5. Returns the list of secrets and corresponding signers + * + * The data field in the batch transfer contains the count of generated secrets, + * which the contract uses to validate the transfer. + * + * @param numberOfInvites The number of invitations to generate + * @returns Promise containing arrays of secrets and signers for each generated invitation + * + * @throws {SdkError} If the transaction fails or invitations cannot be claimed + * + * @example + * ```typescript + * // Generate 5 invitations + * const result = await avatar.invite.generateInvites(5n); + * + * console.log('Generated invitations:'); + * result.secrets.forEach((secret, index) => { + * console.log(`Invitation ${index + 1}:`); + * console.log(` Secret: ${secret}`); + * console.log(` Signer: ${result.signers[index]}`); + * }); + * ``` + */ + generateInvites: async ( + numberOfInvites: bigint + ): Promise<{ + secrets: Hex[]; + signers: Address[]; + transactionReceipt: TransactionReceipt; + }> => { + if (numberOfInvites <= 0n) { + throw SdkError.operationFailed( + 'generateInvites', + 'numberOfInvites must be greater than 0' + ); + } + + // Step 1: Call eth_call to claimInvites to get invitation IDs (read-only simulation) + // This simulates the claimInvites call without actually modifying state + // to get the IDs that would be returned + const ids = (await this.core.invitationFarm.read('claimInvites', [numberOfInvites], { + from: this.address + })) as unknown as bigint[]; + console.log("ids", ids) + if (!ids || ids.length === 0) { + throw SdkError.operationFailed( + 'generateInvites', + 'No invitation IDs returned from claimInvites' + ); + } + + // Step 2: Generate random secrets and derive signers + const secrets: Hex[] = []; + const signers: Address[] = []; + + for (let i = 0; i < numberOfInvites; i++) { + // Generate a random private key + const privateKey = generatePrivateKey(); + secrets.push(privateKey); + + // Derive the signer address from the private key + const account = privateKeyToAccount(privateKey); + signers.push(account.address.toLowerCase() as Address); + } + + // Step 3: Get invitation module address + const invitationModuleAddress = await this.core.invitationFarm.invitationModule(); + + // Step 4: Referrals module address + const referralsModuleAddress = this.core.config.referralsModuleAddress; + + // Step 5: Build the batch transaction + // - claimInvites write call (to actually claim the invites) + // - safeBatchTransferFrom to transfer invitation tokens to the invitation module + + // Create the claimInvites write transaction + const claimInvitesWriteTx = this.core.invitationFarm.claimInvites(numberOfInvites); + + // Step 6: Encode the createAccounts function call to the referrals module + // This call will be executed by the invitation module via the generic call proxy + const createAccountsCallData = encodeFunctionData({ + abi: referralsModuleAbi, + functionName: 'createAccounts', + args: [signers], + }); + + // Step 7: Create safeBatchTransferFrom transaction to transfer invitation tokens to the invitation module + // - from: this avatar + // - to: invitation module + // - ids: the invitation IDs returned from claimInvites + // - amounts: all 96 CRC (96 * 10^18) per invitation + // - data: encoded as (address referralsModule, bytes callData) for the invitation module to execute + + const amounts: bigint[] = []; + for (let i = 0; i < ids.length; i++) { + amounts.push(BigInt(96e18)); // 96 CRC in atto-circles + } + + // Encode the data as (address, bytes) - referrals module address + createAccounts call data + const encodedData = encodeAbiParameters( + parseAbiParameters('address, bytes'), + [referralsModuleAddress, createAccountsCallData] + ); + + const batchTransferTx = this.core.hubV2.safeBatchTransferFrom( + this.address, + invitationModuleAddress, + ids, + amounts, + encodedData + ); + + // Step 7: Execute the batch transaction + const receipt = await this.runner.sendTransaction!([claimInvitesWriteTx, batchTransferTx]); + + return { + secrets, + signers, + transactionReceipt: receipt, + }; + }, }; // Personal token / Minting methods diff --git a/docs/_media/sdk/tsconfig.json b/docs/_media/sdk/tsconfig.json index d85ec3f..8399ffd 100644 --- a/docs/_media/sdk/tsconfig.json +++ b/docs/_media/sdk/tsconfig.json @@ -14,6 +14,7 @@ { "path": "../core" }, { "path": "../rpc" }, { "path": "../profiles" }, + { "path": "../referrals" }, { "path": "../utils" }, { "path": "../runner" }, { "path": "../pathfinder" }, diff --git a/docs/_media/transfers/package.json b/docs/_media/transfers/package.json index f910076..482a60c 100644 --- a/docs/_media/transfers/package.json +++ b/docs/_media/transfers/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-transfers", - "version": "0.1.0", + "version": "0.1.5", "description": "Transfer data construction for Circles SDK", "type": "module", "main": "./dist/index.js", @@ -26,6 +26,10 @@ "pathfinding", "web3" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "@aboutcircles/sdk-types": "*", @@ -38,4 +42,4 @@ "devDependencies": { "typescript": "^5.0.4" } -} \ No newline at end of file +} diff --git a/docs/_media/transfers/src/TransferBuilder.test.ts b/docs/_media/transfers/src/TransferBuilder.test.ts deleted file mode 100644 index 889d7ca..0000000 --- a/docs/_media/transfers/src/TransferBuilder.test.ts +++ /dev/null @@ -1,598 +0,0 @@ -import { describe, test, expect } from 'bun:test'; -import { TransferBuilder } from './TransferBuilder'; -import { Core, circlesConfig } from '@aboutcircles/sdk-core'; -import type { Address, PathfindingResult, TokenInfo } from '@aboutcircles/sdk-types'; -import { CirclesRpc } from '@aboutcircles/sdk-rpc'; -import { - assertNoNettedFlowMismatch, - createFlowMatrix, - getTokenInfoMapFromPath, - getWrappedTokensFromPath, - replaceWrappedTokensWithAvatars, - shrinkPathValues, -} from '@aboutcircles/sdk-pathfinder'; -import { CirclesConverter } from '@aboutcircles/sdk-utils'; - -// Test configuration - using real Circles RPC for integration tests -const CIRCLES_RPC_URL = 'https://rpc.circlesubi.network'; -const HUB_ADDRESS = '0xc12C1E50ABB450d6205Ea2C3Fa861b3B834d13e8' as Address; - -// Test addresses from the old SDK test -const SOURCE_SAFE_ADDRESS = '0xDE374ece6fA50e781E81Aac78e811b33D16912c7'.toLowerCase() as Address; -const SINK_ADDRESS = '0xbcaaab068caf7da7764fa280590d5f5b2fc75d73'.toLowerCase() as Address; -// Use a more realistic amount - 1500 CRC (18 decimals) -const AMOUNT = BigInt('1500000000000000000000'); - -/** - * Helper to get static wrapped token totals from sender - * This replicates the functionality from the old SDK test - */ -async function getStaticWrappedTokenTotalsFromSender( - rpcUrl: string, - senderAddress: string -): Promise> { - const res = await fetch(rpcUrl, { - method: 'POST', - headers: { 'Content-Type': 'application/json' }, - body: JSON.stringify({ - jsonrpc: '2.0', - id: 1, - method: 'circles_getBalanceBreakdown', - params: [senderAddress], - }), - }); - - const resJson = await res.json() as { - result?: Array<{ - tokenAddress: string; - tokenOwner: string; - tokenType: string; - staticAttoCircles: string; - attoCircles: string; - }>; - error?: unknown; - }; - - if (!resJson.result) { - throw new Error(`Failed to fetch wrapped token totals: ${JSON.stringify(resJson.error)}`); - } - - const result = resJson.result; - - return result.filter((o) => o.tokenType === 'CrcV2_ERC20WrapperDeployed_Inflationary'); -} - -/** - * Helper to get default token exclude list - * Checks if the recipient is a group minter and excludes group tokens - */ -async function getDefaultTokenExcludeList( - circlesRpcUrl: string, - to: Address, - excludeFromTokens?: Address[] -): Promise { - const rpc = new CirclesRpc(circlesRpcUrl); - const groups = await rpc.group.findGroups(1, { - mintHandlerEquals: to, - }); - - const completeExcludeFromTokenList = new Set
(); - - if (groups.length > 0) { - const groupInfo = groups[0]; - completeExcludeFromTokenList.add(groupInfo.group.toLowerCase() as Address); - - if (groupInfo.erc20WrapperDemurraged) { - completeExcludeFromTokenList.add(groupInfo.erc20WrapperDemurraged.toLowerCase() as Address); - } - - if (groupInfo.erc20WrapperStatic) { - completeExcludeFromTokenList.add(groupInfo.erc20WrapperStatic.toLowerCase() as Address); - } - } - - excludeFromTokens?.forEach((token) => completeExcludeFromTokenList.add(token.toLowerCase() as Address)); - - if (completeExcludeFromTokenList.size === 0) return undefined; - - return Array.from(completeExcludeFromTokenList); -} - -/** - * Helper to verify that all flow vertices are registered on-chain - */ -async function assertAllVerticesRegistered( - rpcUrl: string, - hubAddress: Address, - vertices: readonly Address[] -): Promise { - // This would query the hub contract to verify all vertices are registered - // For now, we'll skip this check in the test as it requires contract queries - // In production, you'd implement proper on-chain verification - console.log(`Verifying ${vertices.length} vertices are registered...`); -} - -/** - * Helper to verify that vertices are in strictly ascending order - */ -async function assertVerticesStrictlyAscending(vertices: readonly Address[]): Promise { - for (let i = 1; i < vertices.length; i++) { - const prev = BigInt(vertices[i - 1]); - const curr = BigInt(vertices[i]); - if (curr <= prev) { - throw new Error( - `Vertices not strictly ascending: ${vertices[i - 1]} (${prev}) >= ${vertices[i]} (${curr})` - ); - } - } -} - -describe('TransferBuilder - unwrap and path transfer', () => { - test( - 'should send exactly the amount requested even if static tokens are involved', - async () => { - /* - This test verifies that the TransferBuilder correctly handles: - 1. Finding a transfer path with wrapped tokens - 2. Unwrapping static tokens fully (entire balance) - 3. Unwrapping demurraged tokens exactly (amount needed) - 4. Creating the correct flow matrix - 5. Re-wrapping leftover static tokens after transfer - */ - - // Initialize Core and TransferBuilder - const core = new Core({ - ...circlesConfig[100], - circlesRpcUrl: CIRCLES_RPC_URL, - pathfinderUrl: CIRCLES_RPC_URL, - }); - const transferBuilder = new TransferBuilder(core); - const rpc = new CirclesRpc(CIRCLES_RPC_URL); - - let logString = ''; - - try { - const excludeFromTokens = await getDefaultTokenExcludeList( - CIRCLES_RPC_URL, - SOURCE_SAFE_ADDRESS - ); - - // Log the pathfinder input parameters - const pathfinderParams = { - from: SOURCE_SAFE_ADDRESS, - to: SINK_ADDRESS, - targetFlow: AMOUNT, - useWrappedBalances: true, - excludeFromTokens: excludeFromTokens, - }; - console.log('\n=== PATHFINDER INPUT ==='); - console.log('From:', pathfinderParams.from); - console.log('To:', pathfinderParams.to); - console.log('Target Flow:', pathfinderParams.targetFlow.toString(), 'CRC'); - console.log('Use Wrapped Balances:', pathfinderParams.useWrappedBalances); - console.log('Exclude From Tokens:', excludeFromTokens?.length || 0, 'tokens'); - console.log('========================\n'); - - // Get current balances before pathfinding - const balances = await rpc.balance.getTokenBalances(SOURCE_SAFE_ADDRESS); - console.log('=== SENDER TOKEN BALANCES ==='); - console.log('Total tokens:', balances.length); - const wrappedBalances = balances.filter((b: any) => - b.tokenType === 'CrcV2_ERC20WrapperDeployed_Inflationary' || - b.tokenType === 'CrcV2_ERC20WrapperDeployed_Demurraged' - ); - console.log('Wrapped tokens:', wrappedBalances.length); - wrappedBalances.forEach((b: any) => { - console.log(` - ${b.tokenAddress} (${b.tokenType}): ${b.attoCircles} (${Number(b.attoCircles) / 1e18} CRC)`); - }); - console.log('=============================\n'); - - // Find a path using the pathfinder RPC - const transferPath = await rpc.pathfinder.findPath(pathfinderParams); - - console.log('\n=== PATHFINDER OUTPUT ==='); - console.log('Transfers:', transferPath.transfers.length); - console.log('Max Flow:', transferPath.maxFlow.toString(), `(${Number(transferPath.maxFlow) / 1e18} CRC)`); - console.log('Target Flow:', AMOUNT.toString(), `(${Number(AMOUNT) / 1e18} CRC)`); - - // Show which tokens are being used in the path - console.log('\n=== TOKENS USED IN PATH ==='); - const tokensUsed = new Map(); - transferPath.transfers.forEach(t => { - if (t.from.toLowerCase() === SOURCE_SAFE_ADDRESS.toLowerCase()) { - const current = tokensUsed.get(t.tokenOwner) || { type: 'unknown', amount: 0n }; - tokensUsed.set(t.tokenOwner, { - type: current.type, - amount: current.amount + BigInt(t.value) - }); - } - }); - - console.log('Tokens from sender:', tokensUsed.size); - tokensUsed.forEach((info, token) => { - const balance = balances.find((b: any) => b.tokenAddress.toLowerCase() === token.toLowerCase()); - const tokenType = balance?.tokenType || 'Unknown'; - const isWrapped = tokenType.includes('Wrapper'); - console.log(` - ${token} (${tokenType}${isWrapped ? ' - WRAPPED' : ''}): ${info.amount} (${Number(info.amount) / 1e18} CRC)`); - }); - - console.log('\n=== WHY NO WRAPPED TOKENS? ==='); - console.log('Wrapped tokens available:', wrappedBalances.length); - console.log('Wrapped tokens used in path:', [...tokensUsed.values()].filter(t => t.type.includes('Wrapper')).length); - console.log('Possible reasons:'); - console.log(' 1. Pathfinder found better paths using unwrapped tokens'); - console.log(' 2. Wrapped tokens may have less trust connections'); - console.log(' 3. Unwrapped tokens may have lower transfer costs'); - console.log('=========================\n'); - - logString += `Found path with ${transferPath.transfers.length} transfers and max flow: ${transferPath.maxFlow}\n`; - - // Verify no netted flow mismatch - assertNoNettedFlowMismatch(transferPath); - - // Get token info for all tokens in the path - const tokenInfoMap = await getTokenInfoMapFromPath( - SOURCE_SAFE_ADDRESS, - CIRCLES_RPC_URL, - transferPath - ); - logString += `The path contains ${transferPath.transfers.length} transfers over ${tokenInfoMap.size} different token owners.\n`; - - // Find all wrapped edges (can only originate from the sender) - const allWrappedEdges = transferPath.transfers - .filter((o) => o.from === SOURCE_SAFE_ADDRESS) - .filter((o) => - tokenInfoMap.get(o.tokenOwner.toLowerCase())?.tokenType.startsWith('CrcV2_ERC20WrapperDeployed') - ); - - logString += `The path contains ${allWrappedEdges.length} wrapped edges originating from the sender.\n`; - - // Filter static edges - const wrappedStaticEdges = allWrappedEdges.filter( - (o) => tokenInfoMap.get(o.tokenOwner.toLowerCase())?.tokenType === 'CrcV2_ERC20WrapperDeployed_Inflationary' - ); - const wrappedStaticEdgeTotalsByToken: Record = {}; - logString += ` - Of which ${wrappedStaticEdges.length} use static wrapped tokens:\n`; - wrappedStaticEdges.forEach((o) => { - logString += ` - ${o.tokenOwner} (demurraged: ${o.value})\n`; - if (!wrappedStaticEdgeTotalsByToken[o.tokenOwner]) { - wrappedStaticEdgeTotalsByToken[o.tokenOwner] = BigInt(0); - } - wrappedStaticEdgeTotalsByToken[o.tokenOwner] += BigInt(o.value); - }); - - // Filter demurraged edges - const wrappedDemurragedEdges = allWrappedEdges.filter( - (o) => tokenInfoMap.get(o.tokenOwner.toLowerCase())?.tokenType === 'CrcV2_ERC20WrapperDeployed_Demurraged' - ); - const wrappedDemurragedEdgeTotalsByToken: Record = {}; - logString += ` - Of which ${wrappedDemurragedEdges.length} use demurraged wrapped tokens:\n`; - wrappedDemurragedEdges.forEach((o) => { - logString += ` - ${o.tokenOwner} (demurraged: ${o.value})\n`; - if (!wrappedDemurragedEdgeTotalsByToken[o.tokenOwner]) { - wrappedDemurragedEdgeTotalsByToken[o.tokenOwner] = BigInt(0); - } - wrappedDemurragedEdgeTotalsByToken[o.tokenOwner] += BigInt(o.value); - }); - - logString += '\n'; - - // Now use TransferBuilder to construct the transfer - const transactions = await transferBuilder.constructAdvancedTransfer( - SOURCE_SAFE_ADDRESS, - SINK_ADDRESS, - AMOUNT, - { - useWrappedBalances: true, - excludeFromTokens: excludeFromTokens, - } - ); - - logString += `TransferBuilder generated ${transactions.length} transactions\n`; - - // Verify that transactions were generated - expect(transactions.length).toBeGreaterThan(0); - - // The first transaction should be self-approval or an unwrap - // The last transaction before operateFlowMatrix should be unwraps - // Then operateFlowMatrix - // Then re-wraps for leftover static tokens - - // Find the operateFlowMatrix transaction - const operateFlowMatrixTx = transactions.find((tx) => - tx.data.startsWith('0x') && tx.data.length > 10 - ); - expect(operateFlowMatrixTx).toBeDefined(); - - logString += 'Successfully generated transfer transactions with wrapped token handling\n'; - - // Log detailed information about static token unwrapping - const usedStaticTokenCount = Object.keys(wrappedStaticEdgeTotalsByToken).length; - if (usedStaticTokenCount > 0) { - logString += `\nThe path uses ${usedStaticTokenCount} different static tokens which must be unwrapped completely.\n`; - - const senderWrappedStaticTotals = await getStaticWrappedTokenTotalsFromSender( - CIRCLES_RPC_URL, - SOURCE_SAFE_ADDRESS - ); - - const relevantWrappedStaticBalances = senderWrappedStaticTotals.filter( - (o) => !!wrappedStaticEdgeTotalsByToken[o.tokenAddress] - ); - - relevantWrappedStaticBalances.forEach((o) => { - const staticBalance = BigInt(o.staticAttoCircles); - const demurragedBalance = CirclesConverter.attoStaticCirclesToAttoCircles(staticBalance); - logString += ` - ${o.tokenAddress} (static: ${staticBalance}, demurraged: ${demurragedBalance})\n`; - logString += ` > Full unwrap amount: (static: ${staticBalance})\n`; - logString += ` Available after unwrap: (demurraged: ${demurragedBalance})\n`; - - // Calculate how much will be used vs left over - const usedAmount = wrappedStaticEdgeTotalsByToken[o.tokenAddress]; - const leftoverAmount = demurragedBalance - usedAmount; - const percentage = (usedAmount * BigInt(100)) / demurragedBalance; - - logString += ` > Using ${percentage}% (${usedAmount}) of total balance\n`; - logString += ` > Leftover to re-wrap: ${leftoverAmount}\n`; - }); - } - - console.log(logString); - - // Expect at least some transactions - // Note: If approval is already set, we may only have 1 transaction (operateFlowMatrix) - expect(transactions.length).toBeGreaterThanOrEqual(1); - } finally { - console.log(logString); - } - }, - 120_000 // 2-minute timeout - pathfinder + RPC calls can be slow - ); - - test( - 'should work when sender == receiver (self-transfer)', - async () => { - /* - This test verifies self-transfer scenarios where sender == receiver - This is useful for "replenishing" - converting wrapped/other tokens - into the sender's own unwrapped personal tokens - */ - - const core = new Core({ - ...circlesConfig[100], - circlesRpcUrl: CIRCLES_RPC_URL, - pathfinderUrl: CIRCLES_RPC_URL, - }); - const transferBuilder = new TransferBuilder(core); - const rpc = new CirclesRpc(CIRCLES_RPC_URL); - - const excludeFromTokens = await getDefaultTokenExcludeList( - CIRCLES_RPC_URL, - SOURCE_SAFE_ADDRESS - ); - - // For self-transfer, we need to use a smaller amount as there's less capacity - // Get available balance first - const balances = await rpc.balance.getTokenBalances(SOURCE_SAFE_ADDRESS); - const totalAvailable = balances.reduce((sum: bigint, b: any) => sum + BigInt(b.attoCircles), 0n); - const selfTransferAmount = totalAvailable > AMOUNT ? AMOUNT : totalAvailable / 2n; // Use half of available - - console.log(`Self-transfer: Using ${selfTransferAmount} (${Number(selfTransferAmount) / 1e18} CRC) out of ${totalAvailable} (${Number(totalAvailable) / 1e18} CRC) available`); - - // Find a self-transfer path - const transferPath = await rpc.pathfinder.findPath({ - from: SOURCE_SAFE_ADDRESS, - to: SOURCE_SAFE_ADDRESS, - targetFlow: selfTransferAmount, - useWrappedBalances: true, - excludeFromTokens: excludeFromTokens, - toTokens: [SOURCE_SAFE_ADDRESS], - }); - - console.log(`Found self-transfer path with ${transferPath.transfers.length} transfers`); - console.log(`Max flow: ${transferPath.maxFlow}`); - - // Verify no netted flow mismatch - assertNoNettedFlowMismatch(transferPath, SOURCE_SAFE_ADDRESS, SOURCE_SAFE_ADDRESS); - - // Get token info - const tokenInfoMap = await getTokenInfoMapFromPath( - SOURCE_SAFE_ADDRESS, - CIRCLES_RPC_URL, - transferPath - ); - - const wrappedTokens = getWrappedTokensFromPath(transferPath, tokenInfoMap); - const hasInflationaryWrapper = Object.values(wrappedTokens).some( - ([, type]) => type === 'CrcV2_ERC20WrapperDeployed_Inflationary' - ); - - // Replace wrapped tokens with avatars - let processedPath = replaceWrappedTokensWithAvatars(transferPath, tokenInfoMap); - - // If there are inflationary wrappers, shrink the path slightly to account for rounding - if (hasInflationaryWrapper) { - console.log('Shrinking path values due to inflationary wrapper...'); - processedPath = shrinkPathValues(processedPath, SOURCE_SAFE_ADDRESS); - - // Ensure max flow is positive after shrinking - if (processedPath.maxFlow === BigInt(0)) { - console.warn('Path shrinking resulted in zero max flow, using original path'); - processedPath = replaceWrappedTokensWithAvatars(transferPath, tokenInfoMap); - } - } - - console.log(`Path max flow after processing: ${processedPath.maxFlow}`); - - // Verify flow conservation after shrinking (only if we have a valid flow) - if (processedPath.maxFlow > BigInt(0)) { - assertNoNettedFlowMismatch(processedPath, SOURCE_SAFE_ADDRESS, SOURCE_SAFE_ADDRESS); - } - - // Create flow matrix - const fm = createFlowMatrix( - SOURCE_SAFE_ADDRESS, - SOURCE_SAFE_ADDRESS, - processedPath.maxFlow, - processedPath.transfers - ); - - await assertAllVerticesRegistered(CIRCLES_RPC_URL, HUB_ADDRESS, fm.flowVertices as Address[]); - await assertVerticesStrictlyAscending(fm.flowVertices as Address[]); - - console.log(`Flow matrix created with ${fm.flowVertices.length} vertices and ${fm.flowEdges.length} edges`); - - // Now use TransferBuilder to construct the actual transfer - const transactions = await transferBuilder.constructAdvancedTransfer( - SOURCE_SAFE_ADDRESS, - SOURCE_SAFE_ADDRESS, - AMOUNT, - { - useWrappedBalances: true, - excludeFromTokens: excludeFromTokens, - toTokens: [SOURCE_SAFE_ADDRESS], - } - ); - - console.log(`TransferBuilder generated ${transactions.length} transactions for self-transfer`); - - // Verify transactions were generated - expect(transactions.length).toBeGreaterThan(0); - - // The transactions should include operateFlowMatrix (and potentially unwraps/approval) - // Note: If approval is already set and no unwraps needed, we may only have 1 transaction - expect(transactions.length).toBeGreaterThanOrEqual(1); - }, - 120_000 // 2-minute timeout - ); - - test( - 'should return an executable path with wrapped tokens', - async () => { - /* - This test verifies the complete flow: - 1. Find a path with wrapped tokens - 2. Process unwrapping bookkeeping - 3. Rewrite path to replace wrappers with avatars - 4. Shrink path if needed for inflationary wrappers - 5. Create flow matrix - 6. Generate executable transactions - */ - - const core = new Core({ - ...circlesConfig[100], - circlesRpcUrl: CIRCLES_RPC_URL, - pathfinderUrl: CIRCLES_RPC_URL, - }); - const transferBuilder = new TransferBuilder(core); - const rpc = new CirclesRpc(CIRCLES_RPC_URL); - - const excludeFromTokens = await getDefaultTokenExcludeList(CIRCLES_RPC_URL, SINK_ADDRESS); - - // Step 1: Call pathfinder - const transferPath = await rpc.pathfinder.findPath({ - from: SOURCE_SAFE_ADDRESS, - to: SINK_ADDRESS, - targetFlow: AMOUNT, - useWrappedBalances: true, - excludeFromTokens: excludeFromTokens, - }); - - console.log(`Path pre-processing: ${transferPath.transfers.length} transfers, max flow: ${transferPath.maxFlow}`); - - // Step 2: Original path sanity checks - assertNoNettedFlowMismatch(transferPath); - - // Step 3: Unwrap bookkeeping - const tokenInfoMap = await getTokenInfoMapFromPath( - SOURCE_SAFE_ADDRESS, - CIRCLES_RPC_URL, - transferPath - ); - const wrappedTotals = getWrappedTokensFromPath(transferPath, tokenInfoMap); - - console.log(`Found ${Object.keys(wrappedTotals).length} wrapped tokens in path`); - - // Step 4: Rewrite path - replace ERC-20 wrappers with their avatars - let pathUnwrapped = replaceWrappedTokensWithAvatars(transferPath, tokenInfoMap); - - console.log('Path post-replacement: transfers count =', pathUnwrapped.transfers.length); - - const hasInflationaryWrapper = Object.values(wrappedTotals).some( - ([, type]) => type === 'CrcV2_ERC20WrapperDeployed_Inflationary' - ); - - let shrunkPath = hasInflationaryWrapper - ? shrinkPathValues(pathUnwrapped, SINK_ADDRESS) // shrink all values by 0.0000...1% - : pathUnwrapped; - - // Ensure max flow is positive after shrinking - if (hasInflationaryWrapper && shrunkPath.maxFlow === BigInt(0)) { - console.warn('Path shrinking resulted in zero max flow, using original path'); - shrunkPath = pathUnwrapped; - } - - console.log('Path post-shrinking: transfers count =', shrunkPath.transfers.length); - console.log(`Total flow before shrinking: ${transferPath.maxFlow}`); - console.log(`Total flow after shrinking: ${shrunkPath.maxFlow}`); - - // Step 5: Flow conservation still holds after shrinking - assertNoNettedFlowMismatch(shrunkPath); - - // Step 6: Produce flow matrix + Hub calldata - const fm = createFlowMatrix(SOURCE_SAFE_ADDRESS, SINK_ADDRESS, shrunkPath.maxFlow, shrunkPath.transfers); - - await assertAllVerticesRegistered(CIRCLES_RPC_URL, HUB_ADDRESS, fm.flowVertices as Address[]); - await assertVerticesStrictlyAscending(fm.flowVertices as Address[]); - - console.log(`Flow matrix: ${fm.flowVertices.length} vertices, ${fm.flowEdges.length} edges`); - - // Step 7: Use TransferBuilder to generate executable transactions - const transactions = await transferBuilder.constructAdvancedTransfer( - SOURCE_SAFE_ADDRESS, - SINK_ADDRESS, - AMOUNT, - { - useWrappedBalances: true, - excludeFromTokens: excludeFromTokens, - } - ); - - console.log(`Generated ${transactions.length} executable transactions`); - - // Verify we have transactions - expect(transactions.length).toBeGreaterThan(0); - - // Verify structure of transactions - transactions.forEach((tx, idx) => { - console.log(`Transaction ${idx}:`, { - to: tx?.to, - dataLength: tx?.data?.length, - value: tx?.value?.toString(), - keys: Object.keys(tx || {}) - }); - - expect(tx).toBeDefined(); - // Some transactions might not have all fields, which is okay for testing - if (tx.data) { - expect(tx.data).toMatch(/^0x[0-9a-fA-F]*$/); - } - }); - - // The transactions should include: - // - Potential self-approval (if not already approved) - // - Unwrap calls (if wrapped tokens are used) - // - operateFlowMatrix call (always included) - // - Potential wrap calls for leftover static tokens - // Note: If approval is already set and no wrapped tokens, we may only have 1 transaction - expect(transactions.length).toBeGreaterThanOrEqual(1); - }, - 120_000 // 2-minute timeout - ); -}); diff --git a/docs/_media/types/package.json b/docs/_media/types/package.json index 0189cd9..8d1299d 100644 --- a/docs/_media/types/package.json +++ b/docs/_media/types/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-types", - "version": "0.1.0", + "version": "0.1.5", "description": "TypeScript type definitions for Circles SDK", "type": "module", "main": "./dist/index.js", @@ -24,6 +24,10 @@ "types", "typescript" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "abitype": "^1.1.1" diff --git a/docs/_media/types/src/config.ts b/docs/_media/types/src/config.ts index 879df22..9936728 100644 --- a/docs/_media/types/src/config.ts +++ b/docs/_media/types/src/config.ts @@ -14,6 +14,8 @@ export interface CirclesConfig { pathfinderUrl: string; /** Profile service URL for user profiles and metadata */ profileServiceUrl: string; + /** Referrals service URL for referral/invitation links (optional) */ + referralsServiceUrl?: string; /** Circles V1 Hub contract address */ v1HubAddress: Address; /** Circles V2 Hub contract address */ @@ -32,4 +34,8 @@ export interface CirclesConfig { liftERC20Address: Address; /** Invitation Escrow contract address */ invitationEscrowAddress: Address; + /** Invitation Farm contract address */ + invitationFarmAddress: Address; + /** Referrals Module contract address */ + referralsModuleAddress: Address; } diff --git a/docs/_media/types/src/index.ts b/docs/_media/types/src/index.ts index e4812fb..737c6b8 100644 --- a/docs/_media/types/src/index.ts +++ b/docs/_media/types/src/index.ts @@ -49,6 +49,7 @@ export type { GroupRow, GroupMembershipRow, GroupQueryParams } from './group'; // Pathfinding types export type { SimulatedBalance, + SimulatedTrust, FindPathParams, TransferStep, PathfindingResult, diff --git a/docs/_media/types/src/pathfinding.ts b/docs/_media/types/src/pathfinding.ts index cdf498f..90f6e13 100644 --- a/docs/_media/types/src/pathfinding.ts +++ b/docs/_media/types/src/pathfinding.ts @@ -15,6 +15,14 @@ export interface SimulatedBalance { isStatic: boolean; } +/** + * Simulated trust connection for path finding + */ +export interface SimulatedTrust { + truster: Address; + trustee: Address; +} + /** * Path finding parameters for circlesV2_findPath */ @@ -28,6 +36,7 @@ export interface FindPathParams { excludeFromTokens?: Address[]; excludeToTokens?: Address[]; simulatedBalances?: SimulatedBalance[]; + simulatedTrusts?: SimulatedTrust[]; maxTransfers?: number; } diff --git a/docs/_media/utils/package.json b/docs/_media/utils/package.json index bad19a8..6aef5b2 100644 --- a/docs/_media/utils/package.json +++ b/docs/_media/utils/package.json @@ -1,6 +1,6 @@ { "name": "@aboutcircles/sdk-utils", - "version": "0.1.0", + "version": "0.1.5", "description": "Utility functions for Circles SDK including demurrage calculations and conversions", "type": "module", "main": "./dist/index.js", @@ -25,9 +25,14 @@ "converter", "utils" ], + "repository": { + "type": "git", + "url": "https://github.com/aboutcircles/sdk" + }, "license": "MIT", "dependencies": { "@aboutcircles/sdk-types": "*", + "@noble/hashes": "^2.0.1", "multiformats": "^13.4.1" } } diff --git a/docs/abis/src/README.md b/docs/abis/src/README.md index c36eaa2..3a55a3f 100644 --- a/docs/abis/src/README.md +++ b/docs/abis/src/README.md @@ -14,5 +14,7 @@ - [hubV2Abi](variables/hubV2Abi.md) - [inflationaryCirclesAbi](variables/inflationaryCirclesAbi.md) - [invitationEscrowAbi](variables/invitationEscrowAbi.md) +- [invitationFarmAbi](variables/invitationFarmAbi.md) - [liftERC20Abi](variables/liftERC20Abi.md) - [nameRegistryAbi](variables/nameRegistryAbi.md) +- [referralsModuleAbi](variables/referralsModuleAbi.md) diff --git a/docs/abis/src/variables/baseGroupAbi.md b/docs/abis/src/variables/baseGroupAbi.md index aa9eaf9..0a2bbb7 100644 --- a/docs/abis/src/variables/baseGroupAbi.md +++ b/docs/abis/src/variables/baseGroupAbi.md @@ -53,6 +53,6 @@ const baseGroupAbi: [{ }]; ``` -Defined in: [packages/abis/src/baseGroup.ts:6](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/baseGroup.ts#L6) +Defined in: [packages/abis/src/baseGroup.ts:6](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/baseGroup.ts#L6) BaseGroup Contract ABI diff --git a/docs/abis/src/variables/baseGroupFactoryAbi.md b/docs/abis/src/variables/baseGroupFactoryAbi.md index 9c345bb..7e1fdab 100644 --- a/docs/abis/src/variables/baseGroupFactoryAbi.md +++ b/docs/abis/src/variables/baseGroupFactoryAbi.md @@ -34,6 +34,6 @@ const baseGroupFactoryAbi: ( })[]; ``` -Defined in: [packages/abis/src/baseGroupFactory.ts:4](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/baseGroupFactory.ts#L4) +Defined in: [packages/abis/src/baseGroupFactory.ts:4](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/baseGroupFactory.ts#L4) BaseGroupFactory Contract ABI diff --git a/docs/abis/src/variables/demurrageCirclesAbi.md b/docs/abis/src/variables/demurrageCirclesAbi.md index 368377c..5e2b431 100644 --- a/docs/abis/src/variables/demurrageCirclesAbi.md +++ b/docs/abis/src/variables/demurrageCirclesAbi.md @@ -760,4 +760,4 @@ const demurrageCirclesAbi: readonly [{ }]; ``` -Defined in: [packages/abis/src/demurrageCircles.ts:2](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/demurrageCircles.ts#L2) +Defined in: [packages/abis/src/demurrageCircles.ts:2](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/demurrageCircles.ts#L2) diff --git a/docs/abis/src/variables/hubV2Abi.md b/docs/abis/src/variables/hubV2Abi.md index 82c541d..0ff11e0 100644 --- a/docs/abis/src/variables/hubV2Abi.md +++ b/docs/abis/src/variables/hubV2Abi.md @@ -1107,6 +1107,6 @@ const hubV2Abi: readonly [{ }]; ``` -Defined in: [packages/abis/src/hubV2.ts:4](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/hubV2.ts#L4) +Defined in: [packages/abis/src/hubV2.ts:4](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/hubV2.ts#L4) HubV2 Contract ABI diff --git a/docs/abis/src/variables/inflationaryCirclesAbi.md b/docs/abis/src/variables/inflationaryCirclesAbi.md index d54115f..aa3172c 100644 --- a/docs/abis/src/variables/inflationaryCirclesAbi.md +++ b/docs/abis/src/variables/inflationaryCirclesAbi.md @@ -714,4 +714,4 @@ const inflationaryCirclesAbi: readonly [{ }]; ``` -Defined in: [packages/abis/src/inflationaryCircles.ts:1](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/inflationaryCircles.ts#L1) +Defined in: [packages/abis/src/inflationaryCircles.ts:1](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/inflationaryCircles.ts#L1) diff --git a/docs/abis/src/variables/invitationEscrowAbi.md b/docs/abis/src/variables/invitationEscrowAbi.md index 4fef411..ba529ba 100644 --- a/docs/abis/src/variables/invitationEscrowAbi.md +++ b/docs/abis/src/variables/invitationEscrowAbi.md @@ -207,6 +207,6 @@ const invitationEscrowAbi: readonly [{ }]; ``` -Defined in: [packages/abis/src/invitationEscrow.ts:4](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/invitationEscrow.ts#L4) +Defined in: [packages/abis/src/invitationEscrow.ts:4](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/invitationEscrow.ts#L4) InvitationEscrow Contract ABI diff --git a/docs/abis/src/variables/invitationFarmAbi.md b/docs/abis/src/variables/invitationFarmAbi.md new file mode 100644 index 0000000..819a330 --- /dev/null +++ b/docs/abis/src/variables/invitationFarmAbi.md @@ -0,0 +1,420 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [abis/src](../README.md) / invitationFarmAbi + +# Variable: invitationFarmAbi + +```ts +const invitationFarmAbi: readonly [{ + type: "constructor"; + inputs: readonly [{ + name: "_invitationModule"; + type: "address"; + internalType: "address"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "INVITATION_FEE"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "uint256"; + internalType: "uint256"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "HUB"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "contract IHub"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "NAME_REGISTRY"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "admin"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "bots"; + inputs: readonly [{ + name: "bot"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: "nextBot"; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "claimInvite"; + inputs: readonly []; + outputs: readonly [{ + name: "id"; + type: "uint256"; + internalType: "uint256"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "claimInvites"; + inputs: readonly [{ + name: "numberOfInvites"; + type: "uint256"; + internalType: "uint256"; + }]; + outputs: readonly [{ + name: "ids"; + type: "uint256[]"; + internalType: "uint256[]"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "createBot"; + inputs: readonly []; + outputs: readonly [{ + name: "createdBot"; + type: "address"; + internalType: "address"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "createBots"; + inputs: readonly [{ + name: "numberOfBots"; + type: "uint256"; + internalType: "uint256"; + }]; + outputs: readonly [{ + name: "createdBots"; + type: "address[]"; + internalType: "address[]"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "growFarm"; + inputs: readonly [{ + name: "numberOfBots"; + type: "uint256"; + internalType: "uint256"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "invitationModule"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "inviterQuota"; + inputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: ""; + type: "uint256"; + internalType: "uint256"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "lastUsedBot"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "maintainBots"; + inputs: readonly [{ + name: "iterations"; + type: "uint256"; + internalType: "uint256"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "maintainer"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "seeder"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "setAdmin"; + inputs: readonly [{ + name: "newAdmin"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "setInviterQuota"; + inputs: readonly [{ + name: "inviter"; + type: "address"; + internalType: "address"; + }, { + name: "quota"; + type: "uint256"; + internalType: "uint256"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "setMaintainer"; + inputs: readonly [{ + name: "newMaintainer"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "setSeeder"; + inputs: readonly [{ + name: "newSeeder"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "totalBots"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "uint256"; + internalType: "uint256"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "updateBotMetadataDigest"; + inputs: readonly [{ + name: "startBot"; + type: "address"; + internalType: "address"; + }, { + name: "numberOfBots"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "metadataDigest"; + type: "bytes32"; + internalType: "bytes32"; + }]; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "updateInvitationModule"; + inputs: readonly [{ + name: "newInvitationModule"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "event"; + name: "AdminSet"; + inputs: readonly [{ + name: "newAdmin"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "event"; + name: "BotCreated"; + inputs: readonly [{ + name: "createdBot"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "event"; + name: "FarmGrown"; + inputs: readonly [{ + name: "maintainer"; + type: "address"; + indexed: true; + internalType: "address"; + }, { + name: "numberOfBots"; + type: "uint256"; + indexed: true; + internalType: "uint256"; + }, { + name: "totalNumberOfBots"; + type: "uint256"; + indexed: true; + internalType: "uint256"; + }]; + anonymous: false; +}, { + type: "event"; + name: "InvitationModuleUpdated"; + inputs: readonly [{ + name: "module"; + type: "address"; + indexed: true; + internalType: "address"; + }, { + name: "genericCallProxy"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "event"; + name: "InvitesClaimed"; + inputs: readonly [{ + name: "inviter"; + type: "address"; + indexed: true; + internalType: "address"; + }, { + name: "count"; + type: "uint256"; + indexed: true; + internalType: "uint256"; + }]; + anonymous: false; +}, { + type: "event"; + name: "InviterQuotaUpdated"; + inputs: readonly [{ + name: "inviter"; + type: "address"; + indexed: true; + internalType: "address"; + }, { + name: "quota"; + type: "uint256"; + indexed: true; + internalType: "uint256"; + }]; + anonymous: false; +}, { + type: "event"; + name: "MaintainerSet"; + inputs: readonly [{ + name: "maintainer"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "event"; + name: "SeederSet"; + inputs: readonly [{ + name: "seeder"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "error"; + name: "ExceedsInviteQuota"; + inputs: readonly []; +}, { + type: "error"; + name: "FarmIsDrained"; + inputs: readonly []; +}, { + type: "error"; + name: "OnlyAdmin"; + inputs: readonly []; +}, { + type: "error"; + name: "OnlyGenericCallProxy"; + inputs: readonly []; +}, { + type: "error"; + name: "OnlyHumanAvatarsAreInviters"; + inputs: readonly [{ + name: "avatar"; + type: "address"; + internalType: "address"; + }]; +}, { + type: "error"; + name: "OnlyMaintainer"; + inputs: readonly []; +}, { + type: "error"; + name: "OnlySeederOrBot"; + inputs: readonly []; +}]; +``` + +Defined in: [packages/abis/src/invitationFarm.ts:1](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/invitationFarm.ts#L1) diff --git a/docs/abis/src/variables/liftERC20Abi.md b/docs/abis/src/variables/liftERC20Abi.md index 70da273..6dfc515 100644 --- a/docs/abis/src/variables/liftERC20Abi.md +++ b/docs/abis/src/variables/liftERC20Abi.md @@ -139,4 +139,4 @@ const liftERC20Abi: readonly [{ }]; ``` -Defined in: [packages/abis/src/liftERC20.ts:1](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/liftERC20.ts#L1) +Defined in: [packages/abis/src/liftERC20.ts:1](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/liftERC20.ts#L1) diff --git a/docs/abis/src/variables/nameRegistryAbi.md b/docs/abis/src/variables/nameRegistryAbi.md index 4ad2e91..bf4fa34 100644 --- a/docs/abis/src/variables/nameRegistryAbi.md +++ b/docs/abis/src/variables/nameRegistryAbi.md @@ -449,4 +449,4 @@ const nameRegistryAbi: readonly [{ }]; ``` -Defined in: [packages/abis/src/nameRegistry.ts:1](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/abis/src/nameRegistry.ts#L1) +Defined in: [packages/abis/src/nameRegistry.ts:1](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/nameRegistry.ts#L1) diff --git a/docs/abis/src/variables/referralsModuleAbi.md b/docs/abis/src/variables/referralsModuleAbi.md new file mode 100644 index 0000000..e3988e3 --- /dev/null +++ b/docs/abis/src/variables/referralsModuleAbi.md @@ -0,0 +1,385 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [abis/src](../README.md) / referralsModuleAbi + +# Variable: referralsModuleAbi + +```ts +const referralsModuleAbi: readonly [{ + type: "constructor"; + inputs: readonly [{ + name: "invitationModule"; + type: "address"; + internalType: "address"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "AFFILIATE_GROUP_REGISTRY"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "DOMAIN_SEPARATOR"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "bytes32"; + internalType: "bytes32"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "GENERIC_CALL_PROXY"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "HUB"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "INVITATION_MODULE"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "NAME_REGISTRY"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "SAFE_4337_MODULE"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "SAFE_MODULE_SETUP"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "SAFE_PROXY_FACTORY"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "contract ISafeProxyFactory"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "SAFE_SINGLETON"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "SAFE_WEB_AUTHN_SHARED_SIGNER"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "address"; + internalType: "address"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "WELCOME_BONUS"; + inputs: readonly []; + outputs: readonly [{ + name: ""; + type: "uint256"; + internalType: "uint256"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "accounts"; + inputs: readonly [{ + name: "signer"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: "account"; + type: "address"; + internalType: "address"; + }, { + name: "claimed"; + type: "bool"; + internalType: "bool"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "claimAccount"; + inputs: readonly [{ + name: "x"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "y"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "verifier"; + type: "address"; + internalType: "address"; + }, { + name: "signature"; + type: "bytes"; + internalType: "bytes"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "claimAccount"; + inputs: readonly [{ + name: "x"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "y"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "verifier"; + type: "address"; + internalType: "address"; + }, { + name: "signature"; + type: "bytes"; + internalType: "bytes"; + }, { + name: "metadataDigest"; + type: "bytes32"; + internalType: "bytes32"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "claimAccount"; + inputs: readonly [{ + name: "x"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "y"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "verifier"; + type: "address"; + internalType: "address"; + }, { + name: "signature"; + type: "bytes"; + internalType: "bytes"; + }, { + name: "affiliateGroup"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "claimAccount"; + inputs: readonly [{ + name: "x"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "y"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "verifier"; + type: "address"; + internalType: "address"; + }, { + name: "signature"; + type: "bytes"; + internalType: "bytes"; + }, { + name: "metadataDigest"; + type: "bytes32"; + internalType: "bytes32"; + }, { + name: "affiliateGroup"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly []; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "computeAddress"; + inputs: readonly [{ + name: "signer"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: "predictedAddress"; + type: "address"; + internalType: "address"; + }]; + stateMutability: "pure"; +}, { + type: "function"; + name: "createAccount"; + inputs: readonly [{ + name: "signer"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: "account"; + type: "address"; + internalType: "address"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "createAccounts"; + inputs: readonly [{ + name: "signers"; + type: "address[]"; + internalType: "address[]"; + }]; + outputs: readonly [{ + name: "_accounts"; + type: "address[]"; + internalType: "address[]"; + }]; + stateMutability: "nonpayable"; +}, { + type: "function"; + name: "encodePasskeyData"; + inputs: readonly [{ + name: "x"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "y"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "verifier"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: ""; + type: "bytes"; + internalType: "bytes"; + }]; + stateMutability: "view"; +}, { + type: "function"; + name: "getPasskeyHash"; + inputs: readonly [{ + name: "x"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "y"; + type: "uint256"; + internalType: "uint256"; + }, { + name: "verifier"; + type: "address"; + internalType: "address"; + }]; + outputs: readonly [{ + name: ""; + type: "bytes32"; + internalType: "bytes32"; + }]; + stateMutability: "view"; +}, { + type: "event"; + name: "AccountClaimed"; + inputs: readonly [{ + name: "account"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "event"; + name: "AccountCreated"; + inputs: readonly [{ + name: "account"; + type: "address"; + indexed: true; + internalType: "address"; + }]; + anonymous: false; +}, { + type: "error"; + name: "AccountAlreadyClaimed"; + inputs: readonly []; +}, { + type: "error"; + name: "InvalidSignature"; + inputs: readonly []; +}, { + type: "error"; + name: "OnlyGenericCallProxy"; + inputs: readonly []; +}, { + type: "error"; + name: "SignerAlreadyUsed"; + inputs: readonly []; +}]; +``` + +Defined in: [packages/abis/src/referralsModule.ts:1](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/abis/src/referralsModule.ts#L1) diff --git a/docs/core/src/README.md b/docs/core/src/README.md index 237ab53..471d25d 100644 --- a/docs/core/src/README.md +++ b/docs/core/src/README.md @@ -15,8 +15,10 @@ - [HubV2Contract](classes/HubV2Contract.md) - [InflationaryCirclesContract](classes/InflationaryCirclesContract.md) - [InvitationEscrowContract](classes/InvitationEscrowContract.md) +- [InvitationFarmContract](classes/InvitationFarmContract.md) - [LiftERC20Contract](classes/LiftERC20Contract.md) - [NameRegistryContract](classes/NameRegistryContract.md) +- [ReferralsModuleContract](classes/ReferralsModuleContract.md) - [Core](classes/Core.md) - [ContractError](classes/ContractError.md) - [NetworkError](classes/NetworkError.md) diff --git a/docs/core/src/classes/BaseGroupContract.md b/docs/core/src/classes/BaseGroupContract.md index 368a4fa..b9ceb70 100644 --- a/docs/core/src/classes/BaseGroupContract.md +++ b/docs/core/src/classes/BaseGroupContract.md @@ -6,7 +6,7 @@ # Class: BaseGroupContract -Defined in: [packages/core/src/contracts/baseGroup.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L20) +Defined in: [packages/core/src/contracts/baseGroup.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L20) BaseGroup Contract Wrapper Provides type-safe methods for interacting with Circles BaseGroup contracts @@ -35,7 +35,7 @@ const baseGroup = new BaseGroupContract({ new BaseGroupContract(config): BaseGroupContract; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L21) +Defined in: [packages/core/src/contracts/baseGroup.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L21) #### Parameters @@ -65,7 +65,7 @@ Defined in: [packages/core/src/contracts/baseGroup.ts:21](https://github.com/abo readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -82,7 +82,7 @@ readonly abi: [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -96,7 +96,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -110,7 +110,7 @@ Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/abou BASE_MINT_HANDLER(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L32) +Defined in: [packages/core/src/contracts/baseGroup.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L32) Get the BaseMintHandler contract address @@ -126,7 +126,7 @@ Get the BaseMintHandler contract address BASE_MINT_POLICY(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L39) +Defined in: [packages/core/src/contracts/baseGroup.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L39) Get the base mint policy address (constant) @@ -142,7 +142,7 @@ Get the base mint policy address (constant) BASE_TREASURY(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L46) +Defined in: [packages/core/src/contracts/baseGroup.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L46) Get the BaseTreasury contract address @@ -158,7 +158,7 @@ Get the BaseTreasury contract address MAX_CONDITIONS(): Promise; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L53) +Defined in: [packages/core/src/contracts/baseGroup.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L53) Get the maximum number of membership conditions allowed (constant) @@ -174,7 +174,7 @@ Get the maximum number of membership conditions allowed (constant) owner(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:60](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L60) +Defined in: [packages/core/src/contracts/baseGroup.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L60) Get the current owner address @@ -190,7 +190,7 @@ Get the current owner address service(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:67](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L67) +Defined in: [packages/core/src/contracts/baseGroup.ts:67](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L67) Get the current service address @@ -206,7 +206,7 @@ Get the current service address feeCollection(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:74](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L74) +Defined in: [packages/core/src/contracts/baseGroup.ts:74](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L74) Get the current fee collection address @@ -222,7 +222,7 @@ Get the current fee collection address getMembershipConditions(): Promise; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L81) +Defined in: [packages/core/src/contracts/baseGroup.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L81) Get all membership condition addresses @@ -238,7 +238,7 @@ Get all membership condition addresses membershipConditions(index): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:88](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L88) +Defined in: [packages/core/src/contracts/baseGroup.ts:88](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L88) Get a membership condition address by index @@ -260,7 +260,7 @@ Get a membership condition address by index setOwner(newOwner): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:95](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L95) +Defined in: [packages/core/src/contracts/baseGroup.ts:95](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L95) Create a transaction to set a new owner @@ -282,7 +282,7 @@ Create a transaction to set a new owner setService(newService): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:106](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L106) +Defined in: [packages/core/src/contracts/baseGroup.ts:106](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L106) Create a transaction to set a new service address @@ -304,7 +304,7 @@ Create a transaction to set a new service address setFeeCollection(newFeeCollection): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:117](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L117) +Defined in: [packages/core/src/contracts/baseGroup.ts:117](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L117) Create a transaction to set a new fee collection address @@ -326,7 +326,7 @@ Create a transaction to set a new fee collection address setMembershipCondition(condition, enabled): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L128) +Defined in: [packages/core/src/contracts/baseGroup.ts:128](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L128) Create a transaction to enable or disable a membership condition @@ -352,7 +352,7 @@ Create a transaction to enable or disable a membership condition trust(trustReceiver, expiry): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:142](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L142) +Defined in: [packages/core/src/contracts/baseGroup.ts:142](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L142) Create a transaction to trust a member (without membership checks) @@ -378,7 +378,7 @@ Create a transaction to trust a member (without membership checks) trustBatchWithConditions(members, expiry): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:153](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L153) +Defined in: [packages/core/src/contracts/baseGroup.ts:153](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L153) Create a transaction to trust or untrust a batch of members with membership condition checks @@ -404,7 +404,7 @@ readonly `` `0x${string}` ``[] updateMetadataDigest(metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:167](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L167) +Defined in: [packages/core/src/contracts/baseGroup.ts:167](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L167) Create a transaction to update the metadata digest @@ -426,7 +426,7 @@ Create a transaction to update the metadata digest registerShortNameWithNonce(nonce): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroup.ts:178](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroup.ts#L178) +Defined in: [packages/core/src/contracts/baseGroup.ts:178](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroup.ts#L178) Create a transaction to register a short name with a specific nonce @@ -451,7 +451,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -493,7 +493,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions diff --git a/docs/core/src/classes/BaseGroupFactoryContract.md b/docs/core/src/classes/BaseGroupFactoryContract.md index f4ea0f1..c5eedaf 100644 --- a/docs/core/src/classes/BaseGroupFactoryContract.md +++ b/docs/core/src/classes/BaseGroupFactoryContract.md @@ -6,7 +6,7 @@ # Class: BaseGroupFactoryContract -Defined in: [packages/core/src/contracts/baseGroupFactory.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroupFactory.ts#L11) +Defined in: [packages/core/src/contracts/baseGroupFactory.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroupFactory.ts#L11) BaseGroupFactory Contract Wrapper Provides type-safe methods for creating and managing BaseGroup instances @@ -25,7 +25,7 @@ This is a singleton contract deployed at a fixed address. new BaseGroupFactoryContract(config): BaseGroupFactoryContract; ``` -Defined in: [packages/core/src/contracts/baseGroupFactory.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroupFactory.ts#L12) +Defined in: [packages/core/src/contracts/baseGroupFactory.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroupFactory.ts#L12) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/core/src/contracts/baseGroupFactory.ts:12](https://github. readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -75,7 +75,7 @@ readonly abi: ( })[]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/abou deployedByFactory(group): Promise; ``` -Defined in: [packages/core/src/contracts/baseGroupFactory.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroupFactory.ts#L23) +Defined in: [packages/core/src/contracts/baseGroupFactory.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroupFactory.ts#L23) Check if a group was deployed by this factory @@ -132,7 +132,7 @@ createBaseGroup( metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseGroupFactory.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseGroupFactory.ts#L39) +Defined in: [packages/core/src/contracts/baseGroupFactory.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseGroupFactory.ts#L39) Create a new BaseGroup instance @@ -197,7 +197,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -239,7 +239,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions diff --git a/docs/core/src/classes/Contract.md b/docs/core/src/classes/Contract.md index 88e14b7..b044cca 100644 --- a/docs/core/src/classes/Contract.md +++ b/docs/core/src/classes/Contract.md @@ -6,7 +6,7 @@ # Class: Contract\ -Defined in: [packages/core/src/contracts/contract.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L8) +Defined in: [packages/core/src/contracts/contract.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L8) Generic Contract class for type-safe contract interactions @@ -18,6 +18,8 @@ Generic Contract class for type-safe contract interactions - [`NameRegistryContract`](NameRegistryContract.md) - [`LiftERC20Contract`](LiftERC20Contract.md) - [`InvitationEscrowContract`](InvitationEscrowContract.md) +- [`InvitationFarmContract`](InvitationFarmContract.md) +- [`ReferralsModuleContract`](ReferralsModuleContract.md) ## Type Parameters @@ -33,7 +35,7 @@ Generic Contract class for type-safe contract interactions new Contract(config): Contract; ``` -Defined in: [packages/core/src/contracts/contract.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L13) +Defined in: [packages/core/src/contracts/contract.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L13) #### Parameters @@ -63,7 +65,7 @@ Defined in: [packages/core/src/contracts/contract.ts:13](https://github.com/abou readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) *** @@ -73,7 +75,7 @@ Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/about readonly abi: TAbi; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) *** @@ -83,7 +85,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) ## Methods @@ -96,7 +98,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -134,7 +136,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions diff --git a/docs/core/src/classes/ContractError.md b/docs/core/src/classes/ContractError.md index 3070a44..21b05be 100644 --- a/docs/core/src/classes/ContractError.md +++ b/docs/core/src/classes/ContractError.md @@ -6,7 +6,7 @@ # Class: ContractError -Defined in: [packages/core/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L20) +Defined in: [packages/core/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L20) Contract and transaction errors @@ -22,7 +22,7 @@ Contract and transaction errors new ContractError(message, options?): ContractError; ``` -Defined in: [packages/core/src/errors.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L21) +Defined in: [packages/core/src/errors.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L21) #### Parameters @@ -69,7 +69,7 @@ static transactionFailed( cause?): ContractError; ``` -Defined in: [packages/core/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L36) +Defined in: [packages/core/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L36) Create error for transaction failures @@ -102,7 +102,7 @@ static revert( cause?): ContractError; ``` -Defined in: [packages/core/src/errors.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L48) +Defined in: [packages/core/src/errors.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L48) Create error for contract reverts @@ -132,7 +132,7 @@ Create error for contract reverts static insufficientGas(estimated, provided?): ContractError; ``` -Defined in: [packages/core/src/errors.ts:63](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L63) +Defined in: [packages/core/src/errors.ts:63](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L63) Create error for insufficient gas @@ -158,7 +158,7 @@ Create error for insufficient gas static gasEstimationFailed(method, cause?): ContractError; ``` -Defined in: [packages/core/src/errors.ts:74](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L74) +Defined in: [packages/core/src/errors.ts:74](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L74) Create error for gas estimation failures @@ -184,7 +184,7 @@ Create error for gas estimation failures static encodingError(method, cause?): ContractError; ``` -Defined in: [packages/core/src/errors.ts:86](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L86) +Defined in: [packages/core/src/errors.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L86) Create error for encoding failures @@ -210,7 +210,7 @@ Create error for encoding failures static notFound(address, contractType): ContractError; ``` -Defined in: [packages/core/src/errors.ts:98](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L98) +Defined in: [packages/core/src/errors.ts:98](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L98) Create error for contract not found diff --git a/docs/core/src/classes/Core.md b/docs/core/src/classes/Core.md index 66414f0..7e0e6b8 100644 --- a/docs/core/src/classes/Core.md +++ b/docs/core/src/classes/Core.md @@ -6,7 +6,7 @@ # Class: Core -Defined in: [packages/core/src/core.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L40) +Defined in: [packages/core/src/core.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L40) Core SDK class for managing Circles protocol contract interactions @@ -51,7 +51,7 @@ const createGroupTx = core.baseGroupFactory.createBaseGroup( new Core(config): Core; ``` -Defined in: [packages/core/src/core.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L54) +Defined in: [packages/core/src/core.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L56) Create a new Core SDK instance @@ -75,7 +75,7 @@ Circles configuration (defaults to Gnosis Chain mainnet) readonly config: CirclesConfig; ``` -Defined in: [packages/core/src/core.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L41) +Defined in: [packages/core/src/core.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L41) *** @@ -85,7 +85,7 @@ Defined in: [packages/core/src/core.ts:41](https://github.com/aboutcircles/sdk-v readonly rpcUrl: string; ``` -Defined in: [packages/core/src/core.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L42) +Defined in: [packages/core/src/core.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L42) *** @@ -95,7 +95,7 @@ Defined in: [packages/core/src/core.ts:42](https://github.com/aboutcircles/sdk-v readonly hubV2: HubV2Contract; ``` -Defined in: [packages/core/src/core.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L43) +Defined in: [packages/core/src/core.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L43) *** @@ -105,7 +105,7 @@ Defined in: [packages/core/src/core.ts:43](https://github.com/aboutcircles/sdk-v readonly baseGroupFactory: BaseGroupFactoryContract; ``` -Defined in: [packages/core/src/core.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L44) +Defined in: [packages/core/src/core.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L44) *** @@ -115,7 +115,7 @@ Defined in: [packages/core/src/core.ts:44](https://github.com/aboutcircles/sdk-v readonly nameRegistry: NameRegistryContract; ``` -Defined in: [packages/core/src/core.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L45) +Defined in: [packages/core/src/core.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L45) *** @@ -125,7 +125,7 @@ Defined in: [packages/core/src/core.ts:45](https://github.com/aboutcircles/sdk-v readonly liftERC20: LiftERC20Contract; ``` -Defined in: [packages/core/src/core.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L46) +Defined in: [packages/core/src/core.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L46) *** @@ -135,4 +135,24 @@ Defined in: [packages/core/src/core.ts:46](https://github.com/aboutcircles/sdk-v readonly invitationEscrow: InvitationEscrowContract; ``` -Defined in: [packages/core/src/core.ts:47](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/core.ts#L47) +Defined in: [packages/core/src/core.ts:47](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L47) + +*** + +### invitationFarm + +```ts +readonly invitationFarm: InvitationFarmContract; +``` + +Defined in: [packages/core/src/core.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L48) + +*** + +### referralsModule + +```ts +readonly referralsModule: ReferralsModuleContract; +``` + +Defined in: [packages/core/src/core.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/core.ts#L49) diff --git a/docs/core/src/classes/DemurrageCirclesContract.md b/docs/core/src/classes/DemurrageCirclesContract.md index d5b48d3..280d842 100644 --- a/docs/core/src/classes/DemurrageCirclesContract.md +++ b/docs/core/src/classes/DemurrageCirclesContract.md @@ -6,7 +6,7 @@ # Class: DemurrageCirclesContract -Defined in: [packages/core/src/contracts/demurrageCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/demurrageCircles.ts#L23) +Defined in: [packages/core/src/contracts/demurrageCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/demurrageCircles.ts#L23) DemurrageCircles Contract Wrapper Provides type-safe methods for interacting with Circles DemurrageCircles (ERC20 wrapper) contracts @@ -38,7 +38,7 @@ const demurrageCircles = new DemurrageCirclesContract({ new DemurrageCirclesContract(config): DemurrageCirclesContract; ``` -Defined in: [packages/core/src/contracts/demurrageCircles.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/demurrageCircles.ts#L24) +Defined in: [packages/core/src/contracts/demurrageCircles.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/demurrageCircles.ts#L24) #### Parameters @@ -70,7 +70,7 @@ BaseWrappedCirclesContract.constructor readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -150,7 +150,7 @@ readonly abi: readonly [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -166,7 +166,7 @@ BaseWrappedCirclesContract.abi protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -182,7 +182,7 @@ BaseWrappedCirclesContract.rpcUrl DOMAIN_SEPARATOR(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L16) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L16) Get the EIP-712 domain separator @@ -204,7 +204,7 @@ BaseWrappedCirclesContract.DOMAIN_SEPARATOR avatar(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L23) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L23) Get the avatar address associated with this wrapper @@ -226,7 +226,7 @@ BaseWrappedCirclesContract.avatar circlesIdentifier(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L30) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L30) Get the Circles identifier (token ID) @@ -248,7 +248,7 @@ BaseWrappedCirclesContract.circlesIdentifier hub(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L37) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L37) Get the Hub contract address @@ -270,7 +270,7 @@ BaseWrappedCirclesContract.hub nameRegistry(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L44) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L44) Get the NameRegistry contract address @@ -292,7 +292,7 @@ BaseWrappedCirclesContract.nameRegistry inflationDayZero(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L51) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L51) Get the inflation day zero timestamp @@ -314,7 +314,7 @@ BaseWrappedCirclesContract.inflationDayZero name(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:58](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L58) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:58](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L58) Get the token name @@ -336,7 +336,7 @@ BaseWrappedCirclesContract.name symbol(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:65](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L65) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:65](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L65) Get the token symbol @@ -358,7 +358,7 @@ BaseWrappedCirclesContract.symbol decimals(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:72](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L72) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:72](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L72) Get the token decimals @@ -380,7 +380,7 @@ BaseWrappedCirclesContract.decimals totalSupply(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L79) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L79) Get the total supply @@ -402,7 +402,7 @@ BaseWrappedCirclesContract.totalSupply balanceOf(account): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:86](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L86) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L86) Get the balance of an account @@ -430,7 +430,7 @@ BaseWrappedCirclesContract.balanceOf allowance(owner, spender): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:93](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L93) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:93](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L93) Get the allowance of a spender for an owner @@ -462,7 +462,7 @@ BaseWrappedCirclesContract.allowance nonces(owner): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:100](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L100) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L100) Get the nonce for permit signatures @@ -490,7 +490,7 @@ BaseWrappedCirclesContract.nonces day(timestamp): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:107](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L107) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:107](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L107) Calculate the current day from a timestamp @@ -518,7 +518,7 @@ BaseWrappedCirclesContract.day convertDemurrageToInflationaryValue(demurrageValue, dayUpdated): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:114](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L114) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:114](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L114) Convert a demurraged value to inflationary value @@ -550,7 +550,7 @@ BaseWrappedCirclesContract.convertDemurrageToInflationaryValue convertInflationaryToDemurrageValue(inflationaryValue, day): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:121](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L121) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:121](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L121) Convert an inflationary value to demurraged value @@ -582,7 +582,7 @@ BaseWrappedCirclesContract.convertInflationaryToDemurrageValue convertBatchDemurrageToInflationaryValues(demurrageValues, dayUpdated): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L128) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:128](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L128) Convert batch of demurraged values to inflationary values @@ -614,7 +614,7 @@ BaseWrappedCirclesContract.convertBatchDemurrageToInflationaryValues convertBatchInflationaryToDemurrageValues(inflationaryValues, day): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:135](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L135) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:135](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L135) Convert batch of inflationary values to demurraged values @@ -646,7 +646,7 @@ BaseWrappedCirclesContract.convertBatchInflationaryToDemurrageValues toTokenId(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:142](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L142) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:142](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L142) Convert avatar address to token ID @@ -674,7 +674,7 @@ BaseWrappedCirclesContract.toTokenId eip712Domain(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:149](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L149) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:149](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L149) Get EIP-712 domain information @@ -696,7 +696,7 @@ BaseWrappedCirclesContract.eip712Domain supportsInterface(interfaceId): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:156](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L156) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:156](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L156) Check if interface is supported @@ -724,7 +724,7 @@ BaseWrappedCirclesContract.supportsInterface transfer(to, amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:163](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L163) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:163](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L163) Transfer tokens to another address @@ -759,7 +759,7 @@ transferFrom( amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:174](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L174) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:174](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L174) Transfer tokens from one address to another @@ -795,7 +795,7 @@ BaseWrappedCirclesContract.transferFrom approve(spender, amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:185](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L185) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:185](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L185) Approve a spender to spend tokens @@ -827,7 +827,7 @@ BaseWrappedCirclesContract.approve increaseAllowance(spender, addedValue): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:196](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L196) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:196](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L196) Increase the allowance of a spender @@ -859,7 +859,7 @@ BaseWrappedCirclesContract.increaseAllowance decreaseAllowance(spender, subtractedValue): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:207](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L207) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:207](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L207) Decrease the allowance of a spender @@ -891,7 +891,7 @@ BaseWrappedCirclesContract.decreaseAllowance unwrap(amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:218](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L218) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:218](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L218) Unwrap Circles back to ERC1155 @@ -926,7 +926,7 @@ permit( s): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:229](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L229) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:229](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L229) Permit approval via signature (EIP-2612) @@ -981,7 +981,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -1025,7 +1025,7 @@ BaseWrappedCirclesContract.read encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions @@ -1057,7 +1057,7 @@ BaseWrappedCirclesContract.encodeWrite balanceOfOnDay(account, day): Promise; ``` -Defined in: [packages/core/src/contracts/demurrageCircles.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/demurrageCircles.ts#L46) +Defined in: [packages/core/src/contracts/demurrageCircles.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/demurrageCircles.ts#L46) Get the balance of an account on a specific day This is a demurrage-specific feature that calculates historical balance @@ -1091,7 +1091,7 @@ The day number to check the balance for discountedBalances(account): Promise; ``` -Defined in: [packages/core/src/contracts/demurrageCircles.ts:57](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/demurrageCircles.ts#L57) +Defined in: [packages/core/src/contracts/demurrageCircles.ts:57](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/demurrageCircles.ts#L57) Get the discounted balance information for an account Returns the current discounted balance and when it was last updated. diff --git a/docs/core/src/classes/HubV2Contract.md b/docs/core/src/classes/HubV2Contract.md index 0d4db93..6628443 100644 --- a/docs/core/src/classes/HubV2Contract.md +++ b/docs/core/src/classes/HubV2Contract.md @@ -6,7 +6,7 @@ # Class: HubV2Contract -Defined in: [packages/core/src/contracts/hubV2.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L9) +Defined in: [packages/core/src/contracts/hubV2.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L9) HubV2 Contract Wrapper Provides type-safe methods for interacting with Circles HubV2 contract @@ -23,7 +23,7 @@ Provides type-safe methods for interacting with Circles HubV2 contract new HubV2Contract(config): HubV2Contract; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L10) +Defined in: [packages/core/src/contracts/hubV2.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L10) #### Parameters @@ -53,7 +53,7 @@ Defined in: [packages/core/src/contracts/hubV2.ts:10](https://github.com/aboutci readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -146,7 +146,7 @@ readonly abi: readonly [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -160,7 +160,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -177,7 +177,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -219,7 +219,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions @@ -249,7 +249,7 @@ readonly `unknown`[] isHuman(address): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L20) +Defined in: [packages/core/src/contracts/hubV2.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L20) Check if an address is registered as a human @@ -271,7 +271,7 @@ Check if an address is registered as a human isGroup(address): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L27) +Defined in: [packages/core/src/contracts/hubV2.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L27) Check if an address is registered as a group @@ -293,7 +293,7 @@ Check if an address is registered as a group isOrganization(address): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L34) +Defined in: [packages/core/src/contracts/hubV2.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L34) Check if an address is registered as an organization @@ -315,7 +315,7 @@ Check if an address is registered as an organization balanceOf(account, id): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L41) +Defined in: [packages/core/src/contracts/hubV2.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L41) Get balance of a specific token ID for an account @@ -341,7 +341,7 @@ Get balance of a specific token ID for an account balanceOfBatch(accounts, ids): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L48) +Defined in: [packages/core/src/contracts/hubV2.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L48) Get balances of multiple token IDs for multiple accounts @@ -367,7 +367,7 @@ readonly `bigint`[] totalSupply(id): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:55](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L55) +Defined in: [packages/core/src/contracts/hubV2.ts:55](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L55) Get total supply of a specific token ID @@ -389,7 +389,7 @@ Get total supply of a specific token ID isTrusted(truster, trustee): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:62](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L62) +Defined in: [packages/core/src/contracts/hubV2.ts:62](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L62) Check if an address trusts another address @@ -415,7 +415,7 @@ Check if an address trusts another address isApprovedForAll(owner, operator): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:69](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L69) +Defined in: [packages/core/src/contracts/hubV2.ts:69](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L69) Check if an operator is approved to manage all tokens for an owner @@ -441,7 +441,7 @@ Check if an operator is approved to manage all tokens for an owner toTokenId(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:76](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L76) +Defined in: [packages/core/src/contracts/hubV2.ts:76](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L76) Convert token ID to avatar address @@ -463,7 +463,7 @@ Convert token ID to avatar address calculateIssuance(human): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:84](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L84) +Defined in: [packages/core/src/contracts/hubV2.ts:84](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L84) Calculate issuance for a human avatar @@ -485,7 +485,7 @@ Calculate issuance for a human avatar day(timestamp): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:91](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L91) +Defined in: [packages/core/src/contracts/hubV2.ts:91](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L91) Get the current day based on timestamp @@ -507,7 +507,7 @@ Get the current day based on timestamp inflationDayZero(): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:98](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L98) +Defined in: [packages/core/src/contracts/hubV2.ts:98](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L98) Get inflation day zero @@ -523,7 +523,7 @@ Get inflation day zero stopped(human, options?): Promise; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:107](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L107) +Defined in: [packages/core/src/contracts/hubV2.ts:107](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L107) Check if a human has stopped their Circles minting @@ -555,7 +555,7 @@ Optional call options (e.g., { from: Address }) personalMint(): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:115](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L115) +Defined in: [packages/core/src/contracts/hubV2.ts:115](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L115) Create a personal mint transaction Mints personal Circles tokens for the caller @@ -576,7 +576,7 @@ groupMint( data): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:132](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L132) +Defined in: [packages/core/src/contracts/hubV2.ts:132](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L132) Create a group mint transaction Mints group tokens backed by collateral from avatars @@ -619,7 +619,7 @@ Additional data to pass to the contract (use '0x' for no data) trust(trustReceiver, expiry): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:149](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L149) +Defined in: [packages/core/src/contracts/hubV2.ts:149](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L149) Create a trust transaction Trust another address until the specified expiry time @@ -646,7 +646,7 @@ Trust another address until the specified expiry time registerHuman(inviter, metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:160](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L160) +Defined in: [packages/core/src/contracts/hubV2.ts:160](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L160) Create a register human transaction @@ -672,7 +672,7 @@ Create a register human transaction registerOrganization(name, metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:171](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L171) +Defined in: [packages/core/src/contracts/hubV2.ts:171](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L171) Create a register organization transaction @@ -702,7 +702,7 @@ registerGroup( metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:182](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L182) +Defined in: [packages/core/src/contracts/hubV2.ts:182](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L182) Create a register group transaction @@ -741,7 +741,7 @@ safeTransferFrom( data): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:198](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L198) +Defined in: [packages/core/src/contracts/hubV2.ts:198](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L198) Create a safe transfer transaction @@ -784,7 +784,7 @@ safeBatchTransferFrom( data): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:215](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L215) +Defined in: [packages/core/src/contracts/hubV2.ts:215](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L215) Create a batch transfer transaction @@ -822,7 +822,7 @@ readonly `bigint`[] setApprovalForAll(operator, approved): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:232](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L232) +Defined in: [packages/core/src/contracts/hubV2.ts:232](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L232) Create an approval for all transaction @@ -851,7 +851,7 @@ burn( data): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:243](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L243) +Defined in: [packages/core/src/contracts/hubV2.ts:243](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L243) Create a burn transaction @@ -881,7 +881,7 @@ Create a burn transaction stop(): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:256](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L256) +Defined in: [packages/core/src/contracts/hubV2.ts:256](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L256) Create a stop transaction Permanently stops the ability to mint new personal tokens @@ -902,7 +902,7 @@ wrap( circlesType): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:273](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L273) +Defined in: [packages/core/src/contracts/hubV2.ts:273](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L273) Create a wrap transaction Wraps ERC1155 Circles tokens into ERC20 format @@ -945,7 +945,7 @@ operateFlowMatrix( packedCoordinates): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/hubV2.ts:294](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/hubV2.ts#L294) +Defined in: [packages/core/src/contracts/hubV2.ts:294](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/hubV2.ts#L294) Create an operateFlowMatrix transaction Executes a batch of token transfers based on the flow matrix diff --git a/docs/core/src/classes/InflationaryCirclesContract.md b/docs/core/src/classes/InflationaryCirclesContract.md index 8171091..7aadb89 100644 --- a/docs/core/src/classes/InflationaryCirclesContract.md +++ b/docs/core/src/classes/InflationaryCirclesContract.md @@ -6,7 +6,7 @@ # Class: InflationaryCirclesContract -Defined in: [packages/core/src/contracts/inflationaryCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/inflationaryCircles.ts#L23) +Defined in: [packages/core/src/contracts/inflationaryCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/inflationaryCircles.ts#L23) InflationaryCircles Contract Wrapper Provides type-safe methods for interacting with Circles InflationaryCircles (ERC20 wrapper) contracts @@ -38,7 +38,7 @@ const inflationaryCircles = new InflationaryCirclesContract({ new InflationaryCirclesContract(config): InflationaryCirclesContract; ``` -Defined in: [packages/core/src/contracts/inflationaryCircles.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/inflationaryCircles.ts#L24) +Defined in: [packages/core/src/contracts/inflationaryCircles.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/inflationaryCircles.ts#L24) #### Parameters @@ -70,7 +70,7 @@ BaseWrappedCirclesContract.constructor readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -147,7 +147,7 @@ readonly abi: readonly [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -163,7 +163,7 @@ BaseWrappedCirclesContract.abi protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -179,7 +179,7 @@ BaseWrappedCirclesContract.rpcUrl DOMAIN_SEPARATOR(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L16) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L16) Get the EIP-712 domain separator @@ -201,7 +201,7 @@ BaseWrappedCirclesContract.DOMAIN_SEPARATOR avatar(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L23) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L23) Get the avatar address associated with this wrapper @@ -223,7 +223,7 @@ BaseWrappedCirclesContract.avatar circlesIdentifier(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L30) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L30) Get the Circles identifier (token ID) @@ -245,7 +245,7 @@ BaseWrappedCirclesContract.circlesIdentifier hub(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L37) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L37) Get the Hub contract address @@ -267,7 +267,7 @@ BaseWrappedCirclesContract.hub nameRegistry(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L44) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L44) Get the NameRegistry contract address @@ -289,7 +289,7 @@ BaseWrappedCirclesContract.nameRegistry inflationDayZero(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L51) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L51) Get the inflation day zero timestamp @@ -311,7 +311,7 @@ BaseWrappedCirclesContract.inflationDayZero name(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:58](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L58) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:58](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L58) Get the token name @@ -333,7 +333,7 @@ BaseWrappedCirclesContract.name symbol(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:65](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L65) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:65](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L65) Get the token symbol @@ -355,7 +355,7 @@ BaseWrappedCirclesContract.symbol decimals(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:72](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L72) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:72](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L72) Get the token decimals @@ -377,7 +377,7 @@ BaseWrappedCirclesContract.decimals totalSupply(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L79) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L79) Get the total supply @@ -399,7 +399,7 @@ BaseWrappedCirclesContract.totalSupply balanceOf(account): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:86](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L86) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L86) Get the balance of an account @@ -427,7 +427,7 @@ BaseWrappedCirclesContract.balanceOf allowance(owner, spender): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:93](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L93) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:93](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L93) Get the allowance of a spender for an owner @@ -459,7 +459,7 @@ BaseWrappedCirclesContract.allowance nonces(owner): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:100](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L100) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L100) Get the nonce for permit signatures @@ -487,7 +487,7 @@ BaseWrappedCirclesContract.nonces day(timestamp): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:107](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L107) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:107](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L107) Calculate the current day from a timestamp @@ -515,7 +515,7 @@ BaseWrappedCirclesContract.day convertDemurrageToInflationaryValue(demurrageValue, dayUpdated): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:114](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L114) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:114](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L114) Convert a demurraged value to inflationary value @@ -547,7 +547,7 @@ BaseWrappedCirclesContract.convertDemurrageToInflationaryValue convertInflationaryToDemurrageValue(inflationaryValue, day): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:121](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L121) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:121](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L121) Convert an inflationary value to demurraged value @@ -579,7 +579,7 @@ BaseWrappedCirclesContract.convertInflationaryToDemurrageValue convertBatchDemurrageToInflationaryValues(demurrageValues, dayUpdated): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L128) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:128](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L128) Convert batch of demurraged values to inflationary values @@ -611,7 +611,7 @@ BaseWrappedCirclesContract.convertBatchDemurrageToInflationaryValues convertBatchInflationaryToDemurrageValues(inflationaryValues, day): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:135](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L135) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:135](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L135) Convert batch of inflationary values to demurraged values @@ -643,7 +643,7 @@ BaseWrappedCirclesContract.convertBatchInflationaryToDemurrageValues toTokenId(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:142](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L142) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:142](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L142) Convert avatar address to token ID @@ -671,7 +671,7 @@ BaseWrappedCirclesContract.toTokenId eip712Domain(): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:149](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L149) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:149](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L149) Get EIP-712 domain information @@ -693,7 +693,7 @@ BaseWrappedCirclesContract.eip712Domain supportsInterface(interfaceId): Promise; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:156](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L156) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:156](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L156) Check if interface is supported @@ -721,7 +721,7 @@ BaseWrappedCirclesContract.supportsInterface transfer(to, amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:163](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L163) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:163](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L163) Transfer tokens to another address @@ -756,7 +756,7 @@ transferFrom( amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:174](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L174) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:174](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L174) Transfer tokens from one address to another @@ -792,7 +792,7 @@ BaseWrappedCirclesContract.transferFrom approve(spender, amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:185](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L185) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:185](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L185) Approve a spender to spend tokens @@ -824,7 +824,7 @@ BaseWrappedCirclesContract.approve increaseAllowance(spender, addedValue): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:196](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L196) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:196](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L196) Increase the allowance of a spender @@ -856,7 +856,7 @@ BaseWrappedCirclesContract.increaseAllowance decreaseAllowance(spender, subtractedValue): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:207](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L207) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:207](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L207) Decrease the allowance of a spender @@ -888,7 +888,7 @@ BaseWrappedCirclesContract.decreaseAllowance unwrap(amount): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:218](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L218) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:218](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L218) Unwrap Circles back to ERC1155 @@ -923,7 +923,7 @@ permit( s): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:229](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/baseWrappedCircles.ts#L229) +Defined in: [packages/core/src/contracts/baseWrappedCircles.ts:229](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/baseWrappedCircles.ts#L229) Permit approval via signature (EIP-2612) @@ -978,7 +978,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -1022,7 +1022,7 @@ BaseWrappedCirclesContract.read encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions diff --git a/docs/core/src/classes/InvitationEscrowContract.md b/docs/core/src/classes/InvitationEscrowContract.md index dffd352..6cb73d8 100644 --- a/docs/core/src/classes/InvitationEscrowContract.md +++ b/docs/core/src/classes/InvitationEscrowContract.md @@ -6,7 +6,7 @@ # Class: InvitationEscrowContract -Defined in: [packages/core/src/contracts/invitationEscrow.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L12) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L12) InvitationEscrow Contract Wrapper Provides type-safe methods for interacting with the InvitationEscrow contract @@ -26,7 +26,7 @@ applying demurrage over time and allowing redemption or revocation of invitation new InvitationEscrowContract(config): InvitationEscrowContract; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L13) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L13) #### Parameters @@ -56,7 +56,7 @@ Defined in: [packages/core/src/contracts/invitationEscrow.ts:13](https://github. readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -91,7 +91,7 @@ readonly abi: readonly [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -105,7 +105,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -122,7 +122,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -164,7 +164,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions @@ -194,7 +194,7 @@ readonly `unknown`[] redeemInvitation(inviter): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L26) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L26) Redeem the invitation escrow from a specific inviter @@ -220,7 +220,7 @@ Transaction request revokeInvitation(invitee): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L39) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L39) Revoke a single invitation escrow @@ -246,7 +246,7 @@ Transaction request revokeAllInvitations(): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L51) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L51) Revoke all active invitation escrows @@ -264,7 +264,7 @@ Transaction request getInviters(invitee): Promise<`0x${string}`[]>; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L64) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L64) Get all active inviters for a given invitee @@ -290,7 +290,7 @@ Array of inviter addresses getInvitees(inviter): Promise<`0x${string}`[]>; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:73](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L73) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:73](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L73) Get all active invitees for a given inviter @@ -316,7 +316,7 @@ Array of invitee addresses getEscrowedAmountAndDays(inviter, invitee): Promise; ``` -Defined in: [packages/core/src/contracts/invitationEscrow.ts:83](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/invitationEscrow.ts#L83) +Defined in: [packages/core/src/contracts/invitationEscrow.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationEscrow.ts#L83) Get the current escrowed amount (after demurrage) and days since last update diff --git a/docs/core/src/classes/InvitationFarmContract.md b/docs/core/src/classes/InvitationFarmContract.md new file mode 100644 index 0000000..bdf45d9 --- /dev/null +++ b/docs/core/src/classes/InvitationFarmContract.md @@ -0,0 +1,427 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [core/src](../README.md) / InvitationFarmContract + +# Class: InvitationFarmContract + +Defined in: [packages/core/src/contracts/invitationFarm.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L12) + +InvitationFarm Contract Wrapper +Provides type-safe methods for interacting with the InvitationFarm contract + +This contract manages a farm of InvitationBot instances, distributes/claims invite capacity, +and grows the farm. Users can claim invites from the farm using their allocated quota. + +## Extends + +- [`Contract`](Contract.md)\<*typeof* `invitationFarmAbi`\> + +## Constructors + +### Constructor + +```ts +new InvitationFarmContract(config): InvitationFarmContract; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L13) + +#### Parameters + +##### config + +###### address + +`` `0x${string}` `` + +###### rpcUrl + +`string` + +#### Returns + +`InvitationFarmContract` + +#### Overrides + +[`Contract`](Contract.md).[`constructor`](Contract.md#constructor) + +## Properties + +### address + +```ts +readonly address: `0x${string}`; +``` + +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) + +#### Inherited from + +[`Contract`](Contract.md).[`address`](Contract.md#address) + +*** + +### abi + +```ts +readonly abi: readonly [{ +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}]; +``` + +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) + +#### Inherited from + +[`Contract`](Contract.md).[`abi`](Contract.md#abi) + +*** + +### rpcUrl + +```ts +protected rpcUrl: string; +``` + +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) + +#### Inherited from + +[`Contract`](Contract.md).[`rpcUrl`](Contract.md#rpcurl) + +## Methods + +### read() + +```ts +read( + functionName, + args?, +options?): Promise; +``` + +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) + +Read from contract (view/pure functions) using direct JSON-RPC call + +#### Parameters + +##### functionName + +`string` + +The contract function to call + +##### args? + +readonly `unknown`[] + +Function arguments + +##### options? + +Optional call options + +###### from? + +`` `0x${string}` `` + +#### Returns + +`Promise`\<`unknown`\> + +#### Inherited from + +[`Contract`](Contract.md).[`read`](Contract.md#read) + +*** + +### encodeWrite() + +```ts +encodeWrite(functionName, args?): `0x${string}`; +``` + +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) + +Encode transaction data for write functions + +#### Parameters + +##### functionName + +`string` + +##### args? + +readonly `unknown`[] + +#### Returns + +`` `0x${string}` `` + +#### Inherited from + +[`Contract`](Contract.md).[`encodeWrite`](Contract.md#encodewrite) + +*** + +### claimInvites() + +```ts +claimInvites(numberOfInvites): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L26) + +Claims multiple invites for the caller, consuming their quota + +#### Parameters + +##### numberOfInvites + +`bigint` + +Number of invites to claim + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### claimInvite() + +```ts +claimInvite(): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L38) + +Claims a single invite for the caller, consuming their quota by 1 + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### invitationFee() + +```ts +invitationFee(): Promise; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L50) + +Get the invitation fee amount in CRC (cost per invite) + +#### Returns + +`Promise`\<`bigint`\> + +The invitation fee constant + +*** + +### inviterQuota() + +```ts +inviterQuota(inviter): Promise; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:59](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L59) + +Get the remaining invite quota for a specific inviter + +#### Parameters + +##### inviter + +`` `0x${string}` `` + +The address of the inviter + +#### Returns + +`Promise`\<`bigint`\> + +The remaining quota + +*** + +### totalBots() + +```ts +totalBots(): Promise; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:67](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L67) + +Get the total number of bots in the farm + +#### Returns + +`Promise`\<`bigint`\> + +The total number of bots + +*** + +### admin() + +```ts +admin(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:75](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L75) + +Get the admin address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The admin address + +*** + +### maintainer() + +```ts +maintainer(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L83) + +Get the maintainer address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The maintainer address + +*** + +### seeder() + +```ts +seeder(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:91](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L91) + +Get the seeder address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The seeder address + +*** + +### invitationModule() + +```ts +invitationModule(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:99](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L99) + +Get the invitation module address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The invitation module address + +*** + +### lastUsedBot() + +```ts +lastUsedBot(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:107](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L107) + +Get the last used bot in the round-robin allocation + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The address of the last used bot + +*** + +### bots() + +```ts +bots(bot): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/invitationFarm.ts:116](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/invitationFarm.ts#L116) + +Get the next bot in the linked list for a given bot + +#### Parameters + +##### bot + +`` `0x${string}` `` + +The bot address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The next bot address diff --git a/docs/core/src/classes/LiftERC20Contract.md b/docs/core/src/classes/LiftERC20Contract.md index aac0fbe..904a63e 100644 --- a/docs/core/src/classes/LiftERC20Contract.md +++ b/docs/core/src/classes/LiftERC20Contract.md @@ -6,7 +6,7 @@ # Class: LiftERC20Contract -Defined in: [packages/core/src/contracts/liftERC20.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L15) +Defined in: [packages/core/src/contracts/liftERC20.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L15) LiftERC20 Contract Wrapper Provides type-safe methods for interacting with the Circles Lift (ERC20Lift) contract @@ -28,7 +28,7 @@ This is a singleton contract deployed at a fixed address. new LiftERC20Contract(config): LiftERC20Contract; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L16) +Defined in: [packages/core/src/contracts/liftERC20.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L16) #### Parameters @@ -58,7 +58,7 @@ Defined in: [packages/core/src/contracts/liftERC20.ts:16](https://github.com/abo readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -83,7 +83,7 @@ readonly abi: readonly [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -97,7 +97,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -114,7 +114,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -156,7 +156,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions @@ -186,7 +186,7 @@ readonly `unknown`[] ERC20_WRAPPER_SETUP_CALLPREFIX(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L27) +Defined in: [packages/core/src/contracts/liftERC20.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L27) Get the ERC20 wrapper setup call prefix constant @@ -202,7 +202,7 @@ Get the ERC20 wrapper setup call prefix constant hub(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L34) +Defined in: [packages/core/src/contracts/liftERC20.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L34) Get the Hub contract address @@ -218,7 +218,7 @@ Get the Hub contract address nameRegistry(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L41) +Defined in: [packages/core/src/contracts/liftERC20.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L41) Get the NameRegistry contract address @@ -234,7 +234,7 @@ Get the NameRegistry contract address masterCopyERC20Wrapper(circlesType): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L49) +Defined in: [packages/core/src/contracts/liftERC20.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L49) Get the master copy address for a specific CirclesType @@ -258,7 +258,7 @@ Get the master copy address for a specific CirclesType erc20Circles(circlesType, avatar): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:59](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L59) +Defined in: [packages/core/src/contracts/liftERC20.ts:59](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L59) Get the ERC20 wrapper address for a specific avatar and CirclesType @@ -290,7 +290,7 @@ The ERC20 wrapper address, or zero address if not deployed ensureERC20(avatar, circlesType): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/liftERC20.ts:71](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/liftERC20.ts#L71) +Defined in: [packages/core/src/contracts/liftERC20.ts:71](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/liftERC20.ts#L71) Ensure an ERC20 wrapper exists for an avatar Creates a new wrapper if it doesn't exist, or returns the existing one diff --git a/docs/core/src/classes/NameRegistryContract.md b/docs/core/src/classes/NameRegistryContract.md index 9057e23..474ec25 100644 --- a/docs/core/src/classes/NameRegistryContract.md +++ b/docs/core/src/classes/NameRegistryContract.md @@ -6,7 +6,7 @@ # Class: NameRegistryContract -Defined in: [packages/core/src/contracts/nameRegistry.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L11) +Defined in: [packages/core/src/contracts/nameRegistry.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L11) NameRegistry Contract Wrapper Provides type-safe methods for interacting with Circles NameRegistry contract @@ -25,7 +25,7 @@ This is a singleton contract deployed at a fixed address. new NameRegistryContract(config): NameRegistryContract; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L12) +Defined in: [packages/core/src/contracts/nameRegistry.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L12) #### Parameters @@ -55,7 +55,7 @@ Defined in: [packages/core/src/contracts/nameRegistry.ts:12](https://github.com/ readonly address: `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L9) +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) #### Inherited from @@ -109,7 +109,7 @@ readonly abi: readonly [{ }]; ``` -Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L10) +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) #### Inherited from @@ -123,7 +123,7 @@ Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/abou protected rpcUrl: string; ``` -Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L11) +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) #### Inherited from @@ -140,7 +140,7 @@ read( options?): Promise; ``` -Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L29) +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) Read from contract (view/pure functions) using direct JSON-RPC call @@ -182,7 +182,7 @@ Optional call options encodeWrite(functionName, args?): `0x${string}`; ``` -Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/contract.ts#L81) +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) Encode transaction data for write functions @@ -212,7 +212,7 @@ readonly `unknown`[] DEFAULT_CIRCLES_NAME_PREFIX(): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L23) +Defined in: [packages/core/src/contracts/nameRegistry.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L23) Get the default Circles name prefix constant @@ -228,7 +228,7 @@ Get the default Circles name prefix constant DEFAULT_CIRCLES_SYMBOL(): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L30) +Defined in: [packages/core/src/contracts/nameRegistry.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L30) Get the default Circles symbol constant @@ -244,7 +244,7 @@ Get the default Circles symbol constant MAX_SHORT_NAME(): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L37) +Defined in: [packages/core/src/contracts/nameRegistry.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L37) Get the maximum short name value constant @@ -260,7 +260,7 @@ Get the maximum short name value constant hub(): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L44) +Defined in: [packages/core/src/contracts/nameRegistry.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L44) Get the Hub contract address @@ -276,7 +276,7 @@ Get the Hub contract address name(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L51) +Defined in: [packages/core/src/contracts/nameRegistry.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L51) Get the name for an avatar @@ -298,7 +298,7 @@ Get the name for an avatar symbol(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:58](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L58) +Defined in: [packages/core/src/contracts/nameRegistry.ts:58](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L58) Get the symbol for an avatar @@ -320,7 +320,7 @@ Get the symbol for an avatar customNames(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:65](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L65) +Defined in: [packages/core/src/contracts/nameRegistry.ts:65](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L65) Get the custom name for an avatar @@ -342,7 +342,7 @@ Get the custom name for an avatar customSymbols(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:72](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L72) +Defined in: [packages/core/src/contracts/nameRegistry.ts:72](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L72) Get the custom symbol for an avatar @@ -364,7 +364,7 @@ Get the custom symbol for an avatar getMetadataDigest(avatar): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L79) +Defined in: [packages/core/src/contracts/nameRegistry.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L79) Get the metadata digest for an avatar @@ -386,7 +386,7 @@ Get the metadata digest for an avatar avatarToMetaDataDigest(avatar): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:86](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L86) +Defined in: [packages/core/src/contracts/nameRegistry.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L86) Get the metadata digest for an avatar (mapping access) @@ -408,7 +408,7 @@ Get the metadata digest for an avatar (mapping access) shortNames(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:93](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L93) +Defined in: [packages/core/src/contracts/nameRegistry.ts:93](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L93) Get the short name for an avatar @@ -430,7 +430,7 @@ Get the short name for an avatar shortNameToAvatar(shortName): Promise<`0x${string}`>; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:100](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L100) +Defined in: [packages/core/src/contracts/nameRegistry.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L100) Get the avatar address for a short name @@ -452,7 +452,7 @@ Get the avatar address for a short name searchShortName(avatar): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:108](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L108) +Defined in: [packages/core/src/contracts/nameRegistry.ts:108](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L108) Search for a valid short name for an avatar @@ -476,7 +476,7 @@ Search for a valid short name for an avatar calculateShortNameWithNonce(avatar, nonce): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:115](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L115) +Defined in: [packages/core/src/contracts/nameRegistry.ts:115](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L115) Calculate what short name would be generated for an avatar with a specific nonce @@ -502,7 +502,7 @@ Calculate what short name would be generated for an avatar with a specific nonce isValidName(name): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:122](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L122) +Defined in: [packages/core/src/contracts/nameRegistry.ts:122](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L122) Check if a name is valid according to Circles naming rules @@ -524,7 +524,7 @@ Check if a name is valid according to Circles naming rules isValidSymbol(symbol): Promise; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:129](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L129) +Defined in: [packages/core/src/contracts/nameRegistry.ts:129](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L129) Check if a symbol is valid according to Circles naming rules @@ -546,7 +546,7 @@ Check if a symbol is valid according to Circles naming rules registerCustomName(avatar, name): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:136](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L136) +Defined in: [packages/core/src/contracts/nameRegistry.ts:136](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L136) Register a custom name for an avatar @@ -572,7 +572,7 @@ Register a custom name for an avatar registerCustomSymbol(avatar, symbol): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:147](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L147) +Defined in: [packages/core/src/contracts/nameRegistry.ts:147](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L147) Register a custom symbol for an avatar @@ -598,7 +598,7 @@ Register a custom symbol for an avatar registerShortName(value): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:158](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L158) +Defined in: [packages/core/src/contracts/nameRegistry.ts:158](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L158) Register a short name for the caller (searches for available nonce) @@ -620,7 +620,7 @@ Register a short name for the caller (searches for available nonce) registerShortNameWithNonce(nonce): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:169](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L169) +Defined in: [packages/core/src/contracts/nameRegistry.ts:169](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L169) Register a short name with a specific nonce @@ -642,7 +642,7 @@ Register a short name with a specific nonce setMetadataDigest(avatar, metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:180](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L180) +Defined in: [packages/core/src/contracts/nameRegistry.ts:180](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L180) Set metadata digest for an avatar (admin function) @@ -668,7 +668,7 @@ Set metadata digest for an avatar (admin function) updateMetadataDigest(metadataDigest): TransactionRequest; ``` -Defined in: [packages/core/src/contracts/nameRegistry.ts:191](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/contracts/nameRegistry.ts#L191) +Defined in: [packages/core/src/contracts/nameRegistry.ts:191](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/nameRegistry.ts#L191) Update metadata digest for the caller diff --git a/docs/core/src/classes/NetworkError.md b/docs/core/src/classes/NetworkError.md index 045e964..c9298fe 100644 --- a/docs/core/src/classes/NetworkError.md +++ b/docs/core/src/classes/NetworkError.md @@ -6,7 +6,7 @@ # Class: NetworkError -Defined in: [packages/core/src/errors.ts:110](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L110) +Defined in: [packages/core/src/errors.ts:110](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L110) Network-related errors @@ -22,7 +22,7 @@ Network-related errors new NetworkError(message, options?): NetworkError; ``` -Defined in: [packages/core/src/errors.ts:111](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L111) +Defined in: [packages/core/src/errors.ts:111](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L111) #### Parameters @@ -62,7 +62,7 @@ CirclesError.constructor static wrongNetwork(expectedChainId, actualChainId): NetworkError; ``` -Defined in: [packages/core/src/errors.ts:125](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L125) +Defined in: [packages/core/src/errors.ts:125](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L125) Create error for wrong network @@ -88,7 +88,7 @@ Create error for wrong network static connectionFailed(reason, cause?): NetworkError; ``` -Defined in: [packages/core/src/errors.ts:138](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L138) +Defined in: [packages/core/src/errors.ts:138](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L138) Create error for network connection issues @@ -114,7 +114,7 @@ Create error for network connection issues static unsupportedNetwork(chainId): NetworkError; ``` -Defined in: [packages/core/src/errors.ts:149](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L149) +Defined in: [packages/core/src/errors.ts:149](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L149) Create error for unsupported network diff --git a/docs/core/src/classes/ReferralsModuleContract.md b/docs/core/src/classes/ReferralsModuleContract.md new file mode 100644 index 0000000..d8f90b0 --- /dev/null +++ b/docs/core/src/classes/ReferralsModuleContract.md @@ -0,0 +1,745 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [core/src](../README.md) / ReferralsModuleContract + +# Class: ReferralsModuleContract + +Defined in: [packages/core/src/contracts/referralsModule.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L13) + +ReferralsModule Contract Wrapper +Provides type-safe methods for interacting with the ReferralsModule contract + +This contract pre-deploys "pre-made" human CRC Safe accounts on behalf of origin inviters, +and lets invited humans claim those Safes using a device WebAuthn passkey plus an offchain +secret provided by the origin inviter. + +## Extends + +- [`Contract`](Contract.md)\<*typeof* `referralsModuleAbi`\> + +## Constructors + +### Constructor + +```ts +new ReferralsModuleContract(config): ReferralsModuleContract; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L14) + +#### Parameters + +##### config + +###### address + +`` `0x${string}` `` + +###### rpcUrl + +`string` + +#### Returns + +`ReferralsModuleContract` + +#### Overrides + +[`Contract`](Contract.md).[`constructor`](Contract.md#constructor) + +## Properties + +### address + +```ts +readonly address: `0x${string}`; +``` + +Defined in: [packages/core/src/contracts/contract.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L9) + +#### Inherited from + +[`Contract`](Contract.md).[`address`](Contract.md#address) + +*** + +### abi + +```ts +readonly abi: readonly [{ +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}, { +}]; +``` + +Defined in: [packages/core/src/contracts/contract.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L10) + +#### Inherited from + +[`Contract`](Contract.md).[`abi`](Contract.md#abi) + +*** + +### rpcUrl + +```ts +protected rpcUrl: string; +``` + +Defined in: [packages/core/src/contracts/contract.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L11) + +#### Inherited from + +[`Contract`](Contract.md).[`rpcUrl`](Contract.md#rpcurl) + +## Methods + +### read() + +```ts +read( + functionName, + args?, +options?): Promise; +``` + +Defined in: [packages/core/src/contracts/contract.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L29) + +Read from contract (view/pure functions) using direct JSON-RPC call + +#### Parameters + +##### functionName + +`string` + +The contract function to call + +##### args? + +readonly `unknown`[] + +Function arguments + +##### options? + +Optional call options + +###### from? + +`` `0x${string}` `` + +#### Returns + +`Promise`\<`unknown`\> + +#### Inherited from + +[`Contract`](Contract.md).[`read`](Contract.md#read) + +*** + +### encodeWrite() + +```ts +encodeWrite(functionName, args?): `0x${string}`; +``` + +Defined in: [packages/core/src/contracts/contract.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/contract.ts#L81) + +Encode transaction data for write functions + +#### Parameters + +##### functionName + +`string` + +##### args? + +readonly `unknown`[] + +#### Returns + +`` `0x${string}` `` + +#### Inherited from + +[`Contract`](Contract.md).[`encodeWrite`](Contract.md#encodewrite) + +*** + +### createAccount() + +```ts +createAccount(signer): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L30) + +Pre-deploys a Safe for an origin inviter's offchain signer +Only callable by the Invitation Module Generic Call Proxy + +#### Parameters + +##### signer + +`` `0x${string}` `` + +The public address derived from the origin inviter's offchain secret key + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### createAccounts() + +```ts +createAccounts(signers): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L44) + +Batch pre-deploys Safes for multiple signers +Only callable by the Invitation Module Generic Call Proxy + +#### Parameters + +##### signers + +`` `0x${string}` ``[] + +The list of public addresses derived from origin inviters' offchain secrets + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### computeAddress() + +```ts +computeAddress(signer): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:57](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L57) + +Predicts the pre-made Safe address for a given signer without deploying it + +#### Parameters + +##### signer + +`` `0x${string}` `` + +The offchain public address chosen by the origin inviter + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The predicted Safe address + +*** + +### claimAccount() + +```ts +claimAccount( + x, + y, + verifier, + signature): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:72](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L72) + +Claims the pre-made Safe by proving knowledge of the offchain secret +and configuring the device WebAuthn passkey + +#### Parameters + +##### x + +`bigint` + +The X coordinate of the WebAuthn public key + +##### y + +`bigint` + +The Y coordinate of the WebAuthn public key + +##### verifier + +`` `0x${string}` `` + +The WebAuthn verifier/authenticator contract address + +##### signature + +`` `0x${string}` `` + +The 65-byte ECDSA signature over the EIP-712 passkey digest + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### claimAccountWithMetadata() + +```ts +claimAccountWithMetadata( + x, + y, + verifier, + signature, + metadataDigest): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:89](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L89) + +Claims the pre-made Safe and sets Name Registry metadata in a single transaction + +#### Parameters + +##### x + +`bigint` + +The X coordinate of the passkey public key + +##### y + +`bigint` + +The Y coordinate of the passkey public key + +##### verifier + +`` `0x${string}` `` + +The verifier/authenticator contract address + +##### signature + +`` `0x${string}` `` + +The 65-byte ECDSA signature over the EIP-712 passkey digest + +##### metadataDigest + +`` `0x${string}` `` + +The metadata digest to set in the Name Registry + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### claimAccountWithAffiliateGroup() + +```ts +claimAccountWithAffiliateGroup( + x, + y, + verifier, + signature, + affiliateGroup): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:112](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L112) + +Claims the pre-made Safe and sets the affiliate group in a single transaction + +#### Parameters + +##### x + +`bigint` + +The X coordinate of the passkey public key + +##### y + +`bigint` + +The Y coordinate of the passkey public key + +##### verifier + +`` `0x${string}` `` + +The verifier/authenticator contract address + +##### signature + +`` `0x${string}` `` + +The 65-byte ECDSA signature over the EIP-712 passkey digest + +##### affiliateGroup + +`` `0x${string}` `` + +The affiliate group address to register + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### claimAccountWithMetadataAndAffiliateGroup() + +```ts +claimAccountWithMetadataAndAffiliateGroup( + x, + y, + verifier, + signature, + metadataDigest, + affiliateGroup): TransactionRequest; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:136](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L136) + +Claims the pre-made Safe, sets Name Registry metadata and affiliate group + +#### Parameters + +##### x + +`bigint` + +The X coordinate of the passkey public key + +##### y + +`bigint` + +The Y coordinate of the passkey public key + +##### verifier + +`` `0x${string}` `` + +The verifier/authenticator contract address + +##### signature + +`` `0x${string}` `` + +The 65-byte ECDSA signature over the EIP-712 passkey digest + +##### metadataDigest + +`` `0x${string}` `` + +The metadata digest to set in the Name Registry + +##### affiliateGroup + +`` `0x${string}` `` + +The affiliate group address to register + +#### Returns + +`TransactionRequest` + +Transaction request + +*** + +### accounts() + +```ts +accounts(signer): Promise<{ + account: `0x${string}`; + claimed: boolean; +}>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:158](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L158) + +Get the account record for a given signer + +#### Parameters + +##### signer + +`` `0x${string}` `` + +The offchain public address + +#### Returns + +`Promise`\<\{ + `account`: `` `0x${string}` ``; + `claimed`: `boolean`; +\}\> + +Object with account address and claimed status + +*** + +### domainSeparator() + +```ts +domainSeparator(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:167](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L167) + +Get the EIP-712 domain separator + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The domain separator + +*** + +### welcomeBonus() + +```ts +welcomeBonus(): Promise; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:175](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L175) + +Get the welcome bonus amount (target CRC balance after claim) + +#### Returns + +`Promise`\<`bigint`\> + +The welcome bonus amount + +*** + +### hub() + +```ts +hub(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:183](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L183) + +Get the Hub contract address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Hub address + +*** + +### invitationModule() + +```ts +invitationModule(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:191](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L191) + +Get the Invitation Module address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Invitation Module address + +*** + +### genericCallProxy() + +```ts +genericCallProxy(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:199](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L199) + +Get the Generic Call Proxy address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Generic Call Proxy address + +*** + +### nameRegistry() + +```ts +nameRegistry(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:207](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L207) + +Get the Name Registry address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Name Registry address + +*** + +### affiliateGroupRegistry() + +```ts +affiliateGroupRegistry(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:215](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L215) + +Get the Affiliate Group Registry address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Affiliate Group Registry address + +*** + +### safeProxyFactory() + +```ts +safeProxyFactory(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:223](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L223) + +Get the Safe Proxy Factory address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Safe Proxy Factory address + +*** + +### safeSingleton() + +```ts +safeSingleton(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:231](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L231) + +Get the Safe Singleton address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Safe Singleton address + +*** + +### safe4337Module() + +```ts +safe4337Module(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:239](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L239) + +Get the Safe 4337 Module address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Safe 4337 Module address + +*** + +### safeModuleSetup() + +```ts +safeModuleSetup(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:247](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L247) + +Get the Safe Module Setup address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Safe Module Setup address + +*** + +### safeWebAuthnSharedSigner() + +```ts +safeWebAuthnSharedSigner(): Promise<`0x${string}`>; +``` + +Defined in: [packages/core/src/contracts/referralsModule.ts:255](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/contracts/referralsModule.ts#L255) + +Get the Safe WebAuthn Shared Signer address + +#### Returns + +`Promise`\<`` `0x${string}` ``\> + +The Safe WebAuthn Shared Signer address diff --git a/docs/core/src/type-aliases/CoreErrorSource.md b/docs/core/src/type-aliases/CoreErrorSource.md index 7e4108b..3925c99 100644 --- a/docs/core/src/type-aliases/CoreErrorSource.md +++ b/docs/core/src/type-aliases/CoreErrorSource.md @@ -10,6 +10,6 @@ type CoreErrorSource = "CORE" | "CONTRACT" | "TRANSACTION" | "GAS_ESTIMATION" | "NETWORK"; ``` -Defined in: [packages/core/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/errors.ts#L10) +Defined in: [packages/core/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/errors.ts#L10) Core-specific error sources diff --git a/docs/core/src/variables/circlesConfig.md b/docs/core/src/variables/circlesConfig.md index 1b5a8f0..b422c24 100644 --- a/docs/core/src/variables/circlesConfig.md +++ b/docs/core/src/variables/circlesConfig.md @@ -10,7 +10,7 @@ const circlesConfig: object; ``` -Defined in: [packages/core/src/config.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/core/src/config.ts#L9) +Defined in: [packages/core/src/config.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/core/src/config.ts#L9) Default Circles configurations by chain ID diff --git a/docs/modules.md b/docs/modules.md index f84e8d7..985bec1 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -11,6 +11,7 @@ - [core/src](core/src/README.md) - [pathfinder/src](pathfinder/src/README.md) - [profiles/src](profiles/src/README.md) +- [referrals/src](referrals/src/README.md) - [rpc/src](rpc/src/README.md) - [runner/src](runner/src/README.md) - [transfers/src](transfers/src/README.md) diff --git a/docs/pathfinder/src/functions/assertNoNettedFlowMismatch.md b/docs/pathfinder/src/functions/assertNoNettedFlowMismatch.md index 79a34fb..8fa3457 100644 --- a/docs/pathfinder/src/functions/assertNoNettedFlowMismatch.md +++ b/docs/pathfinder/src/functions/assertNoNettedFlowMismatch.md @@ -13,7 +13,7 @@ function assertNoNettedFlowMismatch( overrideSink?): void; ``` -Defined in: [packages/pathfinder/src/path.ts:155](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L155) +Defined in: [packages/pathfinder/src/path.ts:155](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L155) ## Parameters diff --git a/docs/pathfinder/src/functions/computeNettedFlow.md b/docs/pathfinder/src/functions/computeNettedFlow.md index a071b8a..594cc30 100644 --- a/docs/pathfinder/src/functions/computeNettedFlow.md +++ b/docs/pathfinder/src/functions/computeNettedFlow.md @@ -10,7 +10,7 @@ function computeNettedFlow(path): Map; ``` -Defined in: [packages/pathfinder/src/path.ts:212](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L212) +Defined in: [packages/pathfinder/src/path.ts:212](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L212) ## Parameters diff --git a/docs/pathfinder/src/functions/createFlowMatrix.md b/docs/pathfinder/src/functions/createFlowMatrix.md index bf56502..044df39 100644 --- a/docs/pathfinder/src/functions/createFlowMatrix.md +++ b/docs/pathfinder/src/functions/createFlowMatrix.md @@ -14,7 +14,7 @@ function createFlowMatrix( transfers): FlowMatrix; ``` -Defined in: [packages/pathfinder/src/flowMatrix.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/flowMatrix.ts#L7) +Defined in: [packages/pathfinder/src/flowMatrix.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/flowMatrix.ts#L7) Create an ABI‑ready FlowMatrix object from a list of TransferSteps. diff --git a/docs/pathfinder/src/functions/getExpectedUnwrappedTokenTotals.md b/docs/pathfinder/src/functions/getExpectedUnwrappedTokenTotals.md index 8876fa6..efbe36f 100644 --- a/docs/pathfinder/src/functions/getExpectedUnwrappedTokenTotals.md +++ b/docs/pathfinder/src/functions/getExpectedUnwrappedTokenTotals.md @@ -10,7 +10,7 @@ function getExpectedUnwrappedTokenTotals(wrappedTotals, tokenInfoMap): Record; ``` -Defined in: [packages/pathfinder/src/path.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L56) +Defined in: [packages/pathfinder/src/path.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L56) ## Parameters diff --git a/docs/pathfinder/src/functions/getTokenInfoMapFromPath.md b/docs/pathfinder/src/functions/getTokenInfoMapFromPath.md index 6210379..3655317 100644 --- a/docs/pathfinder/src/functions/getTokenInfoMapFromPath.md +++ b/docs/pathfinder/src/functions/getTokenInfoMapFromPath.md @@ -13,7 +13,7 @@ function getTokenInfoMapFromPath( transferPath): Promise>; ``` -Defined in: [packages/pathfinder/src/path.ts:5](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L5) +Defined in: [packages/pathfinder/src/path.ts:5](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L5) ## Parameters diff --git a/docs/pathfinder/src/functions/getWrappedTokensFromPath.md b/docs/pathfinder/src/functions/getWrappedTokensFromPath.md index 8a8cf89..355ae3c 100644 --- a/docs/pathfinder/src/functions/getWrappedTokensFromPath.md +++ b/docs/pathfinder/src/functions/getWrappedTokensFromPath.md @@ -10,7 +10,7 @@ function getWrappedTokensFromPath(transferPath, tokenInfoMap): Record; ``` -Defined in: [packages/pathfinder/src/path.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L35) +Defined in: [packages/pathfinder/src/path.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L35) ## Parameters diff --git a/docs/pathfinder/src/functions/packCoordinates.md b/docs/pathfinder/src/functions/packCoordinates.md index c0dc00d..634e8a6 100644 --- a/docs/pathfinder/src/functions/packCoordinates.md +++ b/docs/pathfinder/src/functions/packCoordinates.md @@ -10,7 +10,7 @@ function packCoordinates(coords): string; ``` -Defined in: [packages/pathfinder/src/packing.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/packing.ts#L7) +Defined in: [packages/pathfinder/src/packing.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/packing.ts#L7) Pack a uint16 array into a hex string (big‑endian, no padding). diff --git a/docs/pathfinder/src/functions/replaceWrappedTokens.md b/docs/pathfinder/src/functions/replaceWrappedTokens.md index c45e81c..680040e 100644 --- a/docs/pathfinder/src/functions/replaceWrappedTokens.md +++ b/docs/pathfinder/src/functions/replaceWrappedTokens.md @@ -10,7 +10,7 @@ function replaceWrappedTokens(path, unwrapped): PathfindingResult; ``` -Defined in: [packages/pathfinder/src/path.ts:102](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L102) +Defined in: [packages/pathfinder/src/path.ts:102](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L102) ## Parameters diff --git a/docs/pathfinder/src/functions/replaceWrappedTokensWithAvatars.md b/docs/pathfinder/src/functions/replaceWrappedTokensWithAvatars.md index b8bdea5..b1bca99 100644 --- a/docs/pathfinder/src/functions/replaceWrappedTokensWithAvatars.md +++ b/docs/pathfinder/src/functions/replaceWrappedTokensWithAvatars.md @@ -10,7 +10,7 @@ function replaceWrappedTokensWithAvatars(path, tokenInfoMap): PathfindingResult; ``` -Defined in: [packages/pathfinder/src/path.ts:82](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L82) +Defined in: [packages/pathfinder/src/path.ts:82](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L82) Replace wrapped token addresses with avatar addresses in the path This is used after unwrapping to reflect the actual tokens being transferred diff --git a/docs/pathfinder/src/functions/shrinkPathValues.md b/docs/pathfinder/src/functions/shrinkPathValues.md index 63f2800..09b8547 100644 --- a/docs/pathfinder/src/functions/shrinkPathValues.md +++ b/docs/pathfinder/src/functions/shrinkPathValues.md @@ -13,7 +13,7 @@ function shrinkPathValues( retainBps): PathfindingResult; ``` -Defined in: [packages/pathfinder/src/path.ts:126](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/path.ts#L126) +Defined in: [packages/pathfinder/src/path.ts:126](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/path.ts#L126) ## Parameters diff --git a/docs/pathfinder/src/functions/transformToFlowVertices.md b/docs/pathfinder/src/functions/transformToFlowVertices.md index ec83064..e8fc142 100644 --- a/docs/pathfinder/src/functions/transformToFlowVertices.md +++ b/docs/pathfinder/src/functions/transformToFlowVertices.md @@ -13,7 +13,7 @@ function transformToFlowVertices( to): object; ``` -Defined in: [packages/pathfinder/src/packing.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/pathfinder/src/packing.ts#L22) +Defined in: [packages/pathfinder/src/packing.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/pathfinder/src/packing.ts#L22) Build a sorted vertex list plus index lookup for quick coordinate mapping. diff --git a/docs/profiles/src/classes/Profiles.md b/docs/profiles/src/classes/Profiles.md index 3682176..4d8e928 100644 --- a/docs/profiles/src/classes/Profiles.md +++ b/docs/profiles/src/classes/Profiles.md @@ -6,7 +6,7 @@ # Class: Profiles -Defined in: [packages/profiles/src/index.ts:5](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/profiles/src/index.ts#L5) +Defined in: [packages/profiles/src/index.ts:5](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/profiles/src/index.ts#L5) ## Constructors @@ -16,7 +16,7 @@ Defined in: [packages/profiles/src/index.ts:5](https://github.com/aboutcircles/s new Profiles(profileServiceUrl): Profiles; ``` -Defined in: [packages/profiles/src/index.ts:6](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/profiles/src/index.ts#L6) +Defined in: [packages/profiles/src/index.ts:6](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/profiles/src/index.ts#L6) #### Parameters @@ -36,7 +36,7 @@ Defined in: [packages/profiles/src/index.ts:6](https://github.com/aboutcircles/s create(profile): Promise; ``` -Defined in: [packages/profiles/src/index.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/profiles/src/index.ts#L19) +Defined in: [packages/profiles/src/index.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/profiles/src/index.ts#L19) Creates and pins a new profile, returning its CID. @@ -62,7 +62,7 @@ The CID of the pinned profile. get(cid): Promise; ``` -Defined in: [packages/profiles/src/index.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/profiles/src/index.ts#L41) +Defined in: [packages/profiles/src/index.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/profiles/src/index.ts#L41) Retrieves a profile by its CID. diff --git a/docs/referrals/src/README.md b/docs/referrals/src/README.md new file mode 100644 index 0000000..50f0761 --- /dev/null +++ b/docs/referrals/src/README.md @@ -0,0 +1,22 @@ +[**Circles SDK**](../../README.md) + +*** + +[Circles SDK](../../modules.md) / referrals/src + +# referrals/src + +## Classes + +- [Referrals](classes/Referrals.md) + +## Interfaces + +- [ReferralInfo](interfaces/ReferralInfo.md) +- [Referral](interfaces/Referral.md) +- [ReferralList](interfaces/ReferralList.md) +- [ApiError](interfaces/ApiError.md) + +## Type Aliases + +- [ReferralStatus](type-aliases/ReferralStatus.md) diff --git a/docs/referrals/src/classes/Referrals.md b/docs/referrals/src/classes/Referrals.md new file mode 100644 index 0000000..8f490ed --- /dev/null +++ b/docs/referrals/src/classes/Referrals.md @@ -0,0 +1,141 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [referrals/src](../README.md) / Referrals + +# Class: Referrals + +Defined in: [packages/referrals/src/referrals.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/referrals.ts#L11) + +Referrals service client for storing and retrieving referral links + +The referrals backend enables Circles SDK users to invite others via referral links. +- Store: Save a referral private key with on-chain validation +- Retrieve: Get referral info by private key (public) +- List: Get all referrals created by authenticated user + +## Constructors + +### Constructor + +```ts +new Referrals(baseUrl, getToken?): Referrals; +``` + +Defined in: [packages/referrals/src/referrals.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/referrals.ts#L18) + +Create a new Referrals client + +#### Parameters + +##### baseUrl + +`string` + +The referrals service base URL (e.g., "https://referrals.circles.example") + +##### getToken? + +() => `Promise`\<`string`\> + +Optional function to get auth token for authenticated endpoints + +#### Returns + +`Referrals` + +## Methods + +### store() + +```ts +store(privateKey, inviter): Promise; +``` + +Defined in: [packages/referrals/src/referrals.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/referrals.ts#L52) + +Store a referral private key + +The private key is validated on-chain via ReferralsModule.accounts() to ensure +the account exists and has not been claimed. The inviter address is self-declared +for dashboard visibility only - the on-chain indexer captures the true inviter. + +#### Parameters + +##### privateKey + +`string` + +The referral private key (0x-prefixed, 64 hex chars) + +##### inviter + +`string` + +Self-declared inviter address for dashboard visibility + +#### Returns + +`Promise`\<`void`\> + +#### Throws + +Error if validation fails or key already exists + +*** + +### retrieve() + +```ts +retrieve(privateKey): Promise; +``` + +Defined in: [packages/referrals/src/referrals.ts:75](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/referrals.ts#L75) + +Retrieve referral info by private key + +This is a public endpoint - no authentication required. +Used by invitees to look up who invited them. + +#### Parameters + +##### privateKey + +`string` + +The referral private key + +#### Returns + +`Promise`\<[`ReferralInfo`](../interfaces/ReferralInfo.md)\> + +Referral info including inviter and status + +#### Throws + +Error if referral not found or expired + +*** + +### listMine() + +```ts +listMine(): Promise; +``` + +Defined in: [packages/referrals/src/referrals.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/referrals.ts#L96) + +List all referrals created by the authenticated user + +Requires authentication - the user's address is extracted from the JWT token. + +#### Returns + +`Promise`\<[`ReferralList`](../interfaces/ReferralList.md)\> + +List of referrals with their status and metadata + +#### Throws + +Error if not authenticated or request fails diff --git a/docs/referrals/src/interfaces/ApiError.md b/docs/referrals/src/interfaces/ApiError.md new file mode 100644 index 0000000..1e78998 --- /dev/null +++ b/docs/referrals/src/interfaces/ApiError.md @@ -0,0 +1,21 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [referrals/src](../README.md) / ApiError + +# Interface: ApiError + +Defined in: [packages/referrals/src/types.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L51) + +Error response from API + +## Properties + +### error + +```ts +error: string; +``` + +Defined in: [packages/referrals/src/types.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L52) diff --git a/docs/referrals/src/interfaces/Referral.md b/docs/referrals/src/interfaces/Referral.md new file mode 100644 index 0000000..878257f --- /dev/null +++ b/docs/referrals/src/interfaces/Referral.md @@ -0,0 +1,95 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [referrals/src](../README.md) / Referral + +# Interface: Referral + +Defined in: [packages/referrals/src/types.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L21) + +Full referral record returned from my-referrals endpoint + +## Properties + +### id + +```ts +id: string; +``` + +Defined in: [packages/referrals/src/types.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L23) + +Unique identifier + +*** + +### privateKey + +```ts +privateKey: string; +``` + +Defined in: [packages/referrals/src/types.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L25) + +The referral private key + +*** + +### status + +```ts +status: ReferralStatus; +``` + +Defined in: [packages/referrals/src/types.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L27) + +Current status + +*** + +### accountAddress? + +```ts +optional accountAddress: string; +``` + +Defined in: [packages/referrals/src/types.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L29) + +The Safe account address + +*** + +### createdAt + +```ts +createdAt: string; +``` + +Defined in: [packages/referrals/src/types.ts:31](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L31) + +When the referral was created + +*** + +### confirmedAt + +```ts +confirmedAt: string | null; +``` + +Defined in: [packages/referrals/src/types.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L33) + +When the account was confirmed on-chain + +*** + +### claimedAt + +```ts +claimedAt: string | null; +``` + +Defined in: [packages/referrals/src/types.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L35) + +When the account was claimed diff --git a/docs/referrals/src/interfaces/ReferralInfo.md b/docs/referrals/src/interfaces/ReferralInfo.md new file mode 100644 index 0000000..7ef0433 --- /dev/null +++ b/docs/referrals/src/interfaces/ReferralInfo.md @@ -0,0 +1,47 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [referrals/src](../README.md) / ReferralInfo + +# Interface: ReferralInfo + +Defined in: [packages/referrals/src/types.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L9) + +Referral info returned from retrieve endpoint + +## Properties + +### inviter + +```ts +inviter: string; +``` + +Defined in: [packages/referrals/src/types.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L11) + +The inviter's Ethereum address + +*** + +### status + +```ts +status: ReferralStatus; +``` + +Defined in: [packages/referrals/src/types.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L13) + +Current status of the referral + +*** + +### accountAddress? + +```ts +optional accountAddress: string; +``` + +Defined in: [packages/referrals/src/types.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L15) + +The Safe account address (if available) diff --git a/docs/referrals/src/interfaces/ReferralList.md b/docs/referrals/src/interfaces/ReferralList.md new file mode 100644 index 0000000..577e64c --- /dev/null +++ b/docs/referrals/src/interfaces/ReferralList.md @@ -0,0 +1,35 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [referrals/src](../README.md) / ReferralList + +# Interface: ReferralList + +Defined in: [packages/referrals/src/types.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L41) + +Response from my-referrals endpoint + +## Properties + +### referrals + +```ts +referrals: Referral[]; +``` + +Defined in: [packages/referrals/src/types.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L43) + +List of referrals + +*** + +### count + +```ts +count: number; +``` + +Defined in: [packages/referrals/src/types.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L45) + +Total count diff --git a/docs/referrals/src/type-aliases/ReferralStatus.md b/docs/referrals/src/type-aliases/ReferralStatus.md new file mode 100644 index 0000000..d12fbc8 --- /dev/null +++ b/docs/referrals/src/type-aliases/ReferralStatus.md @@ -0,0 +1,15 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [referrals/src](../README.md) / ReferralStatus + +# Type Alias: ReferralStatus + +```ts +type ReferralStatus = "pending" | "confirmed" | "claimed" | "expired"; +``` + +Defined in: [packages/referrals/src/types.ts:4](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/referrals/src/types.ts#L4) + +Referral status lifecycle diff --git a/docs/rpc/src/classes/AvatarMethods.md b/docs/rpc/src/classes/AvatarMethods.md index 947edf5..8bcd4c8 100644 --- a/docs/rpc/src/classes/AvatarMethods.md +++ b/docs/rpc/src/classes/AvatarMethods.md @@ -6,7 +6,7 @@ # Class: AvatarMethods -Defined in: [packages/rpc/src/methods/avatar.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/avatar.ts#L8) +Defined in: [packages/rpc/src/methods/avatar.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/avatar.ts#L8) Avatar and network RPC methods @@ -18,7 +18,7 @@ Avatar and network RPC methods new AvatarMethods(client): AvatarMethods; ``` -Defined in: [packages/rpc/src/methods/avatar.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/avatar.ts#L9) +Defined in: [packages/rpc/src/methods/avatar.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/avatar.ts#L9) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/avatar.ts:9](https://github.com/aboutcircl getAvatarInfo(address): Promise; ``` -Defined in: [packages/rpc/src/methods/avatar.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/avatar.ts#L23) +Defined in: [packages/rpc/src/methods/avatar.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/avatar.ts#L23) Get information about a specific avatar @@ -71,7 +71,7 @@ console.log(info); getAvatarInfoBatch(addresses): Promise; ``` -Defined in: [packages/rpc/src/methods/avatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/avatar.ts#L42) +Defined in: [packages/rpc/src/methods/avatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/avatar.ts#L42) Get information about multiple avatars in batch @@ -106,7 +106,7 @@ const infos = await rpc.avatar.getAvatarInfoBatch([ getNetworkSnapshot(): Promise; ``` -Defined in: [packages/rpc/src/methods/avatar.ts:68](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/avatar.ts#L68) +Defined in: [packages/rpc/src/methods/avatar.ts:68](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/avatar.ts#L68) Download a full snapshot of the Circles network state (current trust relations and balances) diff --git a/docs/rpc/src/classes/BalanceMethods.md b/docs/rpc/src/classes/BalanceMethods.md index e064123..dc516ac 100644 --- a/docs/rpc/src/classes/BalanceMethods.md +++ b/docs/rpc/src/classes/BalanceMethods.md @@ -6,7 +6,7 @@ # Class: BalanceMethods -Defined in: [packages/rpc/src/methods/balance.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/balance.ts#L9) +Defined in: [packages/rpc/src/methods/balance.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/balance.ts#L9) Balance query RPC methods @@ -18,7 +18,7 @@ Balance query RPC methods new BalanceMethods(client): BalanceMethods; ``` -Defined in: [packages/rpc/src/methods/balance.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/balance.ts#L10) +Defined in: [packages/rpc/src/methods/balance.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/balance.ts#L10) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/balance.ts:10](https://github.com/aboutcir getTotalBalance(address, asTimeCircles): Promise; ``` -Defined in: [packages/rpc/src/methods/balance.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/balance.ts#L25) +Defined in: [packages/rpc/src/methods/balance.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/balance.ts#L25) Get the total v2 Circles balance of an account @@ -77,7 +77,7 @@ console.log(balance); // 1000000000000000000n (1 Circle in attoCircles) getTokenBalances(address): Promise; ``` -Defined in: [packages/rpc/src/methods/balance.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/balance.ts#L45) +Defined in: [packages/rpc/src/methods/balance.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/balance.ts#L45) Query the balance breakdown of a specific avatar address diff --git a/docs/rpc/src/classes/CirclesRpc.md b/docs/rpc/src/classes/CirclesRpc.md index 2c56dc3..6aaa67d 100644 --- a/docs/rpc/src/classes/CirclesRpc.md +++ b/docs/rpc/src/classes/CirclesRpc.md @@ -6,7 +6,7 @@ # Class: CirclesRpc -Defined in: [packages/rpc/src/rpc.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L46) +Defined in: [packages/rpc/src/rpc.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L46) Main RPC class for Circles protocol RPC interactions @@ -47,7 +47,7 @@ const profile = await rpc.profile.getProfileByAddress('0xc3a1428c04c426cdf513c6f new CirclesRpc(rpcUrl): CirclesRpc; ``` -Defined in: [packages/rpc/src/rpc.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L64) +Defined in: [packages/rpc/src/rpc.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L64) Create a new CirclesRpc instance @@ -71,7 +71,7 @@ RPC URL to use (defaults to https://rpc.circlesubi.network/) readonly client: RpcClient; ``` -Defined in: [packages/rpc/src/rpc.ts:47](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L47) +Defined in: [packages/rpc/src/rpc.ts:47](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L47) *** @@ -81,7 +81,7 @@ Defined in: [packages/rpc/src/rpc.ts:47](https://github.com/aboutcircles/sdk-v2/ readonly pathfinder: PathfinderMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L48) +Defined in: [packages/rpc/src/rpc.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L48) *** @@ -91,7 +91,7 @@ Defined in: [packages/rpc/src/rpc.ts:48](https://github.com/aboutcircles/sdk-v2/ readonly query: QueryMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L49) +Defined in: [packages/rpc/src/rpc.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L49) *** @@ -101,7 +101,7 @@ Defined in: [packages/rpc/src/rpc.ts:49](https://github.com/aboutcircles/sdk-v2/ readonly trust: TrustMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L50) +Defined in: [packages/rpc/src/rpc.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L50) *** @@ -111,7 +111,7 @@ Defined in: [packages/rpc/src/rpc.ts:50](https://github.com/aboutcircles/sdk-v2/ readonly balance: BalanceMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L51) +Defined in: [packages/rpc/src/rpc.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L51) *** @@ -121,7 +121,7 @@ Defined in: [packages/rpc/src/rpc.ts:51](https://github.com/aboutcircles/sdk-v2/ readonly avatar: AvatarMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L52) +Defined in: [packages/rpc/src/rpc.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L52) *** @@ -131,7 +131,7 @@ Defined in: [packages/rpc/src/rpc.ts:52](https://github.com/aboutcircles/sdk-v2/ readonly profile: ProfileMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L53) +Defined in: [packages/rpc/src/rpc.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L53) *** @@ -141,7 +141,7 @@ Defined in: [packages/rpc/src/rpc.ts:53](https://github.com/aboutcircles/sdk-v2/ readonly token: TokenMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L54) +Defined in: [packages/rpc/src/rpc.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L54) *** @@ -151,7 +151,7 @@ Defined in: [packages/rpc/src/rpc.ts:54](https://github.com/aboutcircles/sdk-v2/ readonly invitation: InvitationMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:55](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L55) +Defined in: [packages/rpc/src/rpc.ts:55](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L55) *** @@ -161,7 +161,7 @@ Defined in: [packages/rpc/src/rpc.ts:55](https://github.com/aboutcircles/sdk-v2/ readonly transaction: TransactionMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L56) +Defined in: [packages/rpc/src/rpc.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L56) *** @@ -171,7 +171,7 @@ Defined in: [packages/rpc/src/rpc.ts:56](https://github.com/aboutcircles/sdk-v2/ readonly group: GroupMethods; ``` -Defined in: [packages/rpc/src/rpc.ts:57](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L57) +Defined in: [packages/rpc/src/rpc.ts:57](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L57) ## Methods @@ -181,7 +181,7 @@ Defined in: [packages/rpc/src/rpc.ts:57](https://github.com/aboutcircles/sdk-v2/ setRpcUrl(rpcUrl): void; ``` -Defined in: [packages/rpc/src/rpc.ts:82](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L82) +Defined in: [packages/rpc/src/rpc.ts:82](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L82) Update the RPC URL @@ -203,7 +203,7 @@ Update the RPC URL getRpcUrl(): string; ``` -Defined in: [packages/rpc/src/rpc.ts:89](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/rpc.ts#L89) +Defined in: [packages/rpc/src/rpc.ts:89](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/rpc.ts#L89) Get the current RPC URL diff --git a/docs/rpc/src/classes/GroupMethods.md b/docs/rpc/src/classes/GroupMethods.md index 5b7c009..8e3338b 100644 --- a/docs/rpc/src/classes/GroupMethods.md +++ b/docs/rpc/src/classes/GroupMethods.md @@ -6,7 +6,7 @@ # Class: GroupMethods -Defined in: [packages/rpc/src/methods/group.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L10) +Defined in: [packages/rpc/src/methods/group.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L10) Group query RPC methods @@ -18,7 +18,7 @@ Group query RPC methods new GroupMethods(client): GroupMethods; ``` -Defined in: [packages/rpc/src/methods/group.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L11) +Defined in: [packages/rpc/src/methods/group.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L11) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/group.ts:11](https://github.com/aboutcircl findGroups(limit, params?): Promise; ``` -Defined in: [packages/rpc/src/methods/group.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L44) +Defined in: [packages/rpc/src/methods/group.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L44) Find groups with optional filters @@ -98,7 +98,7 @@ getGroupMemberships( sortOrder): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/group.ts:89](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L89) +Defined in: [packages/rpc/src/methods/group.ts:89](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L89) Get group memberships for an avatar using cursor-based pagination @@ -147,7 +147,7 @@ console.log(query.currentPage.results); getGroupHolders(groupAddress, limit): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/group.ts:154](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L154) +Defined in: [packages/rpc/src/methods/group.ts:154](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L154) Get holders of a group token using cursor-based pagination @@ -204,7 +204,7 @@ getGroupMembers( sortOrder): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/group.ts:222](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L222) +Defined in: [packages/rpc/src/methods/group.ts:222](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L222) Get members of a group using cursor-based pagination @@ -264,7 +264,7 @@ getGroups( sortOrder?): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/group.ts:284](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/group.ts#L284) +Defined in: [packages/rpc/src/methods/group.ts:284](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/group.ts#L284) Get groups using cursor-based pagination diff --git a/docs/rpc/src/classes/InvitationMethods.md b/docs/rpc/src/classes/InvitationMethods.md index 2978708..98e957d 100644 --- a/docs/rpc/src/classes/InvitationMethods.md +++ b/docs/rpc/src/classes/InvitationMethods.md @@ -6,7 +6,7 @@ # Class: InvitationMethods -Defined in: [packages/rpc/src/methods/invitation.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/invitation.ts#L12) +Defined in: [packages/rpc/src/methods/invitation.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/invitation.ts#L12) Invitation RPC methods @@ -18,7 +18,7 @@ Invitation RPC methods new InvitationMethods(client): InvitationMethods; ``` -Defined in: [packages/rpc/src/methods/invitation.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/invitation.ts#L13) +Defined in: [packages/rpc/src/methods/invitation.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/invitation.ts#L13) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/invitation.ts:13](https://github.com/about getInvitedBy(address): Promise<`0x${string}` | undefined>; ``` -Defined in: [packages/rpc/src/methods/invitation.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/invitation.ts#L38) +Defined in: [packages/rpc/src/methods/invitation.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/invitation.ts#L38) Get the avatar that invited a specific avatar @@ -71,7 +71,7 @@ console.log(inviter); // '0x...' getInvitations(address): Promise; ``` -Defined in: [packages/rpc/src/methods/invitation.ts:83](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/invitation.ts#L83) +Defined in: [packages/rpc/src/methods/invitation.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/invitation.ts#L83) Get the list of avatars who have invited this avatar Checks v2 trust relations and validates that inviters have enough balance @@ -105,7 +105,7 @@ console.log(invitations); // Array of AvatarInfo getInvitationsFrom(address, accepted): Promise<`0x${string}`[]>; ``` -Defined in: [packages/rpc/src/methods/invitation.ts:190](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/invitation.ts#L190) +Defined in: [packages/rpc/src/methods/invitation.ts:190](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/invitation.ts#L190) Get the list of accounts that were invited by a specific avatar diff --git a/docs/rpc/src/classes/Observable.md b/docs/rpc/src/classes/Observable.md index 3c5440b..bf8b15c 100644 --- a/docs/rpc/src/classes/Observable.md +++ b/docs/rpc/src/classes/Observable.md @@ -6,7 +6,7 @@ # Class: Observable\ -Defined in: [packages/rpc/src/events/observable.ts:5](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/observable.ts#L5) +Defined in: [packages/rpc/src/events/observable.ts:5](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/observable.ts#L5) Observable class for event streaming Provides a simple publish-subscribe pattern for Circles events @@ -25,7 +25,7 @@ Provides a simple publish-subscribe pattern for Circles events protected new Observable(): Observable; ``` -Defined in: [packages/rpc/src/events/observable.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/observable.ts#L23) +Defined in: [packages/rpc/src/events/observable.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/observable.ts#L23) #### Returns @@ -39,7 +39,7 @@ Defined in: [packages/rpc/src/events/observable.ts:23](https://github.com/aboutc subscribe(subscriber): () => void; ``` -Defined in: [packages/rpc/src/events/observable.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/observable.ts#L13) +Defined in: [packages/rpc/src/events/observable.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/observable.ts#L13) Subscribe to events @@ -71,7 +71,7 @@ Unsubscribe function to stop receiving events protected emit(value): void; ``` -Defined in: [packages/rpc/src/events/observable.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/observable.ts#L27) +Defined in: [packages/rpc/src/events/observable.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/observable.ts#L27) #### Parameters @@ -91,7 +91,7 @@ Defined in: [packages/rpc/src/events/observable.ts:27](https://github.com/aboutc static create(): object; ``` -Defined in: [packages/rpc/src/events/observable.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/observable.ts#L34) +Defined in: [packages/rpc/src/events/observable.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/observable.ts#L34) Create a new Observable with an emitter diff --git a/docs/rpc/src/classes/PagedQuery.md b/docs/rpc/src/classes/PagedQuery.md index ce476e8..53806ad 100644 --- a/docs/rpc/src/classes/PagedQuery.md +++ b/docs/rpc/src/classes/PagedQuery.md @@ -6,7 +6,7 @@ # Class: PagedQuery\ -Defined in: [packages/rpc/src/pagedQuery.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/pagedQuery.ts#L50) +Defined in: [packages/rpc/src/pagedQuery.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/pagedQuery.ts#L50) A class for querying Circles RPC nodes with cursor-based pagination. Supports both event-based pagination (default) and custom cursor pagination (for view tables). @@ -55,7 +55,7 @@ new PagedQuery( rowTransformer?): PagedQuery; ``` -Defined in: [packages/rpc/src/pagedQuery.ts:67](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/pagedQuery.ts#L67) +Defined in: [packages/rpc/src/pagedQuery.ts:67](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/pagedQuery.ts#L67) #### Parameters @@ -87,7 +87,7 @@ get currentPage(): | undefined; ``` -Defined in: [packages/rpc/src/pagedQuery.ts:61](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/pagedQuery.ts#L61) +Defined in: [packages/rpc/src/pagedQuery.ts:61](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/pagedQuery.ts#L61) ##### Returns @@ -102,7 +102,7 @@ Defined in: [packages/rpc/src/pagedQuery.ts:61](https://github.com/aboutcircles/ queryNextPage(): Promise; ``` -Defined in: [packages/rpc/src/pagedQuery.ts:271](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/pagedQuery.ts#L271) +Defined in: [packages/rpc/src/pagedQuery.ts:271](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/pagedQuery.ts#L271) Queries the next page of results. @@ -120,7 +120,7 @@ True if results were found, false otherwise reset(): void; ``` -Defined in: [packages/rpc/src/pagedQuery.ts:304](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/pagedQuery.ts#L304) +Defined in: [packages/rpc/src/pagedQuery.ts:304](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/pagedQuery.ts#L304) Resets the query to start from the beginning diff --git a/docs/rpc/src/classes/PathfinderMethods.md b/docs/rpc/src/classes/PathfinderMethods.md index 0e2b615..2c64cfa 100644 --- a/docs/rpc/src/classes/PathfinderMethods.md +++ b/docs/rpc/src/classes/PathfinderMethods.md @@ -6,7 +6,7 @@ # Class: PathfinderMethods -Defined in: [packages/rpc/src/methods/pathfinder.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/pathfinder.ts#L8) +Defined in: [packages/rpc/src/methods/pathfinder.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/pathfinder.ts#L8) Circles V1 and V2 balance and pathfinding methods @@ -18,7 +18,7 @@ Circles V1 and V2 balance and pathfinding methods new PathfinderMethods(client): PathfinderMethods; ``` -Defined in: [packages/rpc/src/methods/pathfinder.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/pathfinder.ts#L9) +Defined in: [packages/rpc/src/methods/pathfinder.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/pathfinder.ts#L9) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/pathfinder.ts:9](https://github.com/aboutc findPath(params): Promise; ``` -Defined in: [packages/rpc/src/methods/pathfinder.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/pathfinder.ts#L26) +Defined in: [packages/rpc/src/methods/pathfinder.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/pathfinder.ts#L26) Calculate a path between two addresses with a target flow @@ -74,7 +74,7 @@ const path = await rpc.pathfinder.findPath({ findMaxFlow(params): Promise; ``` -Defined in: [packages/rpc/src/methods/pathfinder.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/pathfinder.ts#L52) +Defined in: [packages/rpc/src/methods/pathfinder.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/pathfinder.ts#L52) Find the maximum flow between two addresses diff --git a/docs/rpc/src/classes/ProfileMethods.md b/docs/rpc/src/classes/ProfileMethods.md index a449118..76f7f89 100644 --- a/docs/rpc/src/classes/ProfileMethods.md +++ b/docs/rpc/src/classes/ProfileMethods.md @@ -6,7 +6,7 @@ # Class: ProfileMethods -Defined in: [packages/rpc/src/methods/profile.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L9) +Defined in: [packages/rpc/src/methods/profile.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L9) Profile RPC methods @@ -18,7 +18,7 @@ Profile RPC methods new ProfileMethods(client): ProfileMethods; ``` -Defined in: [packages/rpc/src/methods/profile.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L10) +Defined in: [packages/rpc/src/methods/profile.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L10) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/profile.ts:10](https://github.com/aboutcir getProfileByCid(cid): Promise; ``` -Defined in: [packages/rpc/src/methods/profile.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L24) +Defined in: [packages/rpc/src/methods/profile.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L24) Get a profile by its CID @@ -71,7 +71,7 @@ console.log(profile); getProfileByCidBatch(cids): Promise<(Profile | null)[]>; ``` -Defined in: [packages/rpc/src/methods/profile.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L43) +Defined in: [packages/rpc/src/methods/profile.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L43) Get many profiles by CID in batch @@ -107,7 +107,7 @@ const profiles = await rpc.profile.getProfileByCidBatch([ getProfileByAddress(address): Promise; ``` -Defined in: [packages/rpc/src/methods/profile.ts:62](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L62) +Defined in: [packages/rpc/src/methods/profile.ts:62](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L62) Query the profile for an avatar address @@ -140,7 +140,7 @@ console.log(profile); getProfileByAddressBatch(addresses): Promise<(Profile | null)[]>; ``` -Defined in: [packages/rpc/src/methods/profile.ts:83](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L83) +Defined in: [packages/rpc/src/methods/profile.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L83) Query profiles by address in batch @@ -180,7 +180,7 @@ searchProfiles( avatarTypes?): Promise; ``` -Defined in: [packages/rpc/src/methods/profile.ts:108](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L108) +Defined in: [packages/rpc/src/methods/profile.ts:108](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L108) Search profiles by name, description or address @@ -238,7 +238,7 @@ searchByAddressOrName( avatarTypes?): Promise; ``` -Defined in: [packages/rpc/src/methods/profile.ts:145](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/profile.ts#L145) +Defined in: [packages/rpc/src/methods/profile.ts:145](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/profile.ts#L145) Search profiles by address or username If the query is a valid address, it will search by address first, diff --git a/docs/rpc/src/classes/QueryMethods.md b/docs/rpc/src/classes/QueryMethods.md index 8b98ca8..606d980 100644 --- a/docs/rpc/src/classes/QueryMethods.md +++ b/docs/rpc/src/classes/QueryMethods.md @@ -6,7 +6,7 @@ # Class: QueryMethods -Defined in: [packages/rpc/src/methods/query.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/query.ts#L8) +Defined in: [packages/rpc/src/methods/query.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/query.ts#L8) Query and table RPC methods @@ -18,7 +18,7 @@ Query and table RPC methods new QueryMethods(client): QueryMethods; ``` -Defined in: [packages/rpc/src/methods/query.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/query.ts#L9) +Defined in: [packages/rpc/src/methods/query.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/query.ts#L9) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/query.ts:9](https://github.com/aboutcircle query(params): Promise; ``` -Defined in: [packages/rpc/src/methods/query.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/query.ts#L45) +Defined in: [packages/rpc/src/methods/query.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/query.ts#L45) Query tables with filters @@ -99,7 +99,7 @@ const results = await rpc.query.query({ tables(): Promise; ``` -Defined in: [packages/rpc/src/methods/query.ts:61](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/query.ts#L61) +Defined in: [packages/rpc/src/methods/query.ts:61](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/query.ts#L61) Return all available namespaces and tables which can be queried @@ -129,7 +129,7 @@ events( includeTransactionData): Promise; ``` -Defined in: [packages/rpc/src/methods/query.ts:86](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/query.ts#L86) +Defined in: [packages/rpc/src/methods/query.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/query.ts#L86) Query events of specific types within a block range diff --git a/docs/rpc/src/classes/RpcClient.md b/docs/rpc/src/classes/RpcClient.md index b0c0fb8..1ef2bb1 100644 --- a/docs/rpc/src/classes/RpcClient.md +++ b/docs/rpc/src/classes/RpcClient.md @@ -6,7 +6,7 @@ # Class: RpcClient -Defined in: [packages/rpc/src/client.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/client.ts#L10) +Defined in: [packages/rpc/src/client.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/client.ts#L10) Base RPC client for making JSON-RPC calls to Circles RPC endpoints Supports both HTTP requests and WebSocket subscriptions @@ -19,7 +19,7 @@ Supports both HTTP requests and WebSocket subscriptions new RpcClient(rpcUrl): RpcClient; ``` -Defined in: [packages/rpc/src/client.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/client.ts#L27) +Defined in: [packages/rpc/src/client.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/client.ts#L27) #### Parameters @@ -39,7 +39,7 @@ Defined in: [packages/rpc/src/client.ts:27](https://github.com/aboutcircles/sdk- call(method, params): Promise; ``` -Defined in: [packages/rpc/src/client.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/client.ts#L34) +Defined in: [packages/rpc/src/client.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/client.ts#L34) Make a JSON-RPC call @@ -75,7 +75,7 @@ Make a JSON-RPC call setRpcUrl(rpcUrl): void; ``` -Defined in: [packages/rpc/src/client.ts:85](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/client.ts#L85) +Defined in: [packages/rpc/src/client.ts:85](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/client.ts#L85) Update the RPC URL @@ -97,7 +97,7 @@ Update the RPC URL getRpcUrl(): string; ``` -Defined in: [packages/rpc/src/client.ts:92](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/client.ts#L92) +Defined in: [packages/rpc/src/client.ts:92](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/client.ts#L92) Get the current RPC URL @@ -113,7 +113,7 @@ Get the current RPC URL subscribe(address?): Promise>; ``` -Defined in: [packages/rpc/src/client.ts:217](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/client.ts#L217) +Defined in: [packages/rpc/src/client.ts:217](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/client.ts#L217) Subscribe to Circles events via WebSocket diff --git a/docs/rpc/src/classes/RpcError.md b/docs/rpc/src/classes/RpcError.md index 1fcfac7..b60fe85 100644 --- a/docs/rpc/src/classes/RpcError.md +++ b/docs/rpc/src/classes/RpcError.md @@ -6,7 +6,7 @@ # Class: RpcError -Defined in: [packages/rpc/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L20) +Defined in: [packages/rpc/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L20) RPC-related errors @@ -22,7 +22,7 @@ RPC-related errors new RpcError(message, options?): RpcError; ``` -Defined in: [packages/rpc/src/errors.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L21) +Defined in: [packages/rpc/src/errors.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L21) #### Parameters @@ -66,7 +66,7 @@ CirclesError.constructor static connectionFailed(url, cause?): RpcError; ``` -Defined in: [packages/rpc/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L36) +Defined in: [packages/rpc/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L36) Create error for connection failures @@ -92,7 +92,7 @@ Create error for connection failures static timeout(method, timeout): RpcError; ``` -Defined in: [packages/rpc/src/errors.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L48) +Defined in: [packages/rpc/src/errors.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L48) Create error for timeout @@ -118,7 +118,7 @@ Create error for timeout static invalidResponse(method, response): RpcError; ``` -Defined in: [packages/rpc/src/errors.ts:59](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L59) +Defined in: [packages/rpc/src/errors.ts:59](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L59) Create error for invalid response @@ -144,7 +144,7 @@ Create error for invalid response static fromJsonRpcError(error): RpcError; ``` -Defined in: [packages/rpc/src/errors.ts:70](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L70) +Defined in: [packages/rpc/src/errors.ts:70](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L70) Create error from JSON-RPC error response @@ -176,7 +176,7 @@ Create error from JSON-RPC error response static websocketError(message, cause?): RpcError; ``` -Defined in: [packages/rpc/src/errors.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L81) +Defined in: [packages/rpc/src/errors.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L81) Create error for WebSocket failures diff --git a/docs/rpc/src/classes/TokenMethods.md b/docs/rpc/src/classes/TokenMethods.md index 022b922..5a60a1c 100644 --- a/docs/rpc/src/classes/TokenMethods.md +++ b/docs/rpc/src/classes/TokenMethods.md @@ -6,7 +6,7 @@ # Class: TokenMethods -Defined in: [packages/rpc/src/methods/token.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/token.ts#L9) +Defined in: [packages/rpc/src/methods/token.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/token.ts#L9) Token information RPC methods @@ -18,7 +18,7 @@ Token information RPC methods new TokenMethods(client): TokenMethods; ``` -Defined in: [packages/rpc/src/methods/token.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/token.ts#L10) +Defined in: [packages/rpc/src/methods/token.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/token.ts#L10) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/token.ts:10](https://github.com/aboutcircl getTokenInfo(address): Promise; ``` -Defined in: [packages/rpc/src/methods/token.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/token.ts#L24) +Defined in: [packages/rpc/src/methods/token.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/token.ts#L24) Get token information for a specific token address @@ -71,7 +71,7 @@ console.log(tokenInfo); getTokenInfoBatch(addresses): Promise; ``` -Defined in: [packages/rpc/src/methods/token.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/token.ts#L43) +Defined in: [packages/rpc/src/methods/token.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/token.ts#L43) Get token information for multiple token addresses in batch @@ -109,7 +109,7 @@ getTokenHolders( sortOrder): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/token.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/token.ts#L79) +Defined in: [packages/rpc/src/methods/token.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/token.ts#L79) Get token holders for a specific token address with pagination diff --git a/docs/rpc/src/classes/TransactionMethods.md b/docs/rpc/src/classes/TransactionMethods.md index d9dd30e..3b55a1a 100644 --- a/docs/rpc/src/classes/TransactionMethods.md +++ b/docs/rpc/src/classes/TransactionMethods.md @@ -6,7 +6,7 @@ # Class: TransactionMethods -Defined in: [packages/rpc/src/methods/transaction.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/transaction.ts#L42) +Defined in: [packages/rpc/src/methods/transaction.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/transaction.ts#L42) Transaction history RPC methods @@ -18,7 +18,7 @@ Transaction history RPC methods new TransactionMethods(client): TransactionMethods; ``` -Defined in: [packages/rpc/src/methods/transaction.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/transaction.ts#L43) +Defined in: [packages/rpc/src/methods/transaction.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/transaction.ts#L43) #### Parameters @@ -41,7 +41,7 @@ getTransactionHistory( sortOrder): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/transaction.ts:73](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/transaction.ts#L73) +Defined in: [packages/rpc/src/methods/transaction.ts:73](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/transaction.ts#L73) Get transaction history for an address using cursor-based pagination diff --git a/docs/rpc/src/classes/TrustMethods.md b/docs/rpc/src/classes/TrustMethods.md index 4b2d6e5..6e9ddce 100644 --- a/docs/rpc/src/classes/TrustMethods.md +++ b/docs/rpc/src/classes/TrustMethods.md @@ -6,7 +6,7 @@ # Class: TrustMethods -Defined in: [packages/rpc/src/methods/trust.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L9) +Defined in: [packages/rpc/src/methods/trust.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L9) Trust relation RPC methods @@ -18,7 +18,7 @@ Trust relation RPC methods new TrustMethods(client): TrustMethods; ``` -Defined in: [packages/rpc/src/methods/trust.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L10) +Defined in: [packages/rpc/src/methods/trust.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L10) #### Parameters @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/methods/trust.ts:10](https://github.com/aboutcircl getCommonTrust(address1, address2): Promise<`0x${string}`[]>; ``` -Defined in: [packages/rpc/src/methods/trust.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L40) +Defined in: [packages/rpc/src/methods/trust.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L40) Query the common trust relations of two addresses (only common outgoing trust relations are considered) @@ -83,7 +83,7 @@ getTrustRelations( sortOrder): PagedQuery; ``` -Defined in: [packages/rpc/src/methods/trust.ts:69](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L69) +Defined in: [packages/rpc/src/methods/trust.ts:69](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L69) Get trust relations for an address using cursor-based pagination @@ -135,7 +135,7 @@ query.currentPage.results.forEach(relation => { getAggregatedTrustRelations(avatar): Promise; ``` -Defined in: [packages/rpc/src/methods/trust.ts:153](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L153) +Defined in: [packages/rpc/src/methods/trust.ts:153](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L153) Get aggregated trust relations for an address Groups trust relations by counterpart and determines relationship type @@ -176,7 +176,7 @@ const aggregated = await rpc.trust.getAggregatedTrustRelations( getTrustedBy(avatar): Promise; ``` -Defined in: [packages/rpc/src/methods/trust.ts:221](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L221) +Defined in: [packages/rpc/src/methods/trust.ts:221](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L221) Get addresses that trust the given avatar (incoming trust) @@ -210,7 +210,7 @@ const trustedBy = await rpc.trust.getTrustedBy( getTrusts(avatar): Promise; ``` -Defined in: [packages/rpc/src/methods/trust.ts:241](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L241) +Defined in: [packages/rpc/src/methods/trust.ts:241](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L241) Get addresses that the given avatar trusts (outgoing trust) @@ -244,7 +244,7 @@ const trusts = await rpc.trust.getTrusts( getMutualTrusts(avatar): Promise; ``` -Defined in: [packages/rpc/src/methods/trust.ts:261](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/methods/trust.ts#L261) +Defined in: [packages/rpc/src/methods/trust.ts:261](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/methods/trust.ts#L261) Get mutual trust relations for the given avatar diff --git a/docs/rpc/src/functions/isCirclesEvent.md b/docs/rpc/src/functions/isCirclesEvent.md index 652d184..cb1f26b 100644 --- a/docs/rpc/src/functions/isCirclesEvent.md +++ b/docs/rpc/src/functions/isCirclesEvent.md @@ -10,7 +10,7 @@ function isCirclesEvent(obj): obj is CirclesEvent; ``` -Defined in: [packages/rpc/src/events/types.ts:6](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/types.ts#L6) +Defined in: [packages/rpc/src/events/types.ts:6](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/types.ts#L6) Type guard to check if an object is a CirclesEvent diff --git a/docs/rpc/src/functions/normalizeAddress.md b/docs/rpc/src/functions/normalizeAddress.md index cec0d33..9cd0bb4 100644 --- a/docs/rpc/src/functions/normalizeAddress.md +++ b/docs/rpc/src/functions/normalizeAddress.md @@ -10,7 +10,7 @@ function normalizeAddress(address): `0x${string}`; ``` -Defined in: [packages/rpc/src/utils.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/utils.ts#L7) +Defined in: [packages/rpc/src/utils.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/utils.ts#L7) Normalize an address to lowercase (required by the indexer) diff --git a/docs/rpc/src/functions/normalizeAddresses.md b/docs/rpc/src/functions/normalizeAddresses.md index ad52d43..e19cc62 100644 --- a/docs/rpc/src/functions/normalizeAddresses.md +++ b/docs/rpc/src/functions/normalizeAddresses.md @@ -10,7 +10,7 @@ function normalizeAddresses(addresses): `0x${string}`[]; ``` -Defined in: [packages/rpc/src/utils.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/utils.ts#L14) +Defined in: [packages/rpc/src/utils.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/utils.ts#L14) Normalize an array of addresses to lowercase diff --git a/docs/rpc/src/functions/parseRpcEvent.md b/docs/rpc/src/functions/parseRpcEvent.md index 96ebc8b..a65e88e 100644 --- a/docs/rpc/src/functions/parseRpcEvent.md +++ b/docs/rpc/src/functions/parseRpcEvent.md @@ -10,7 +10,7 @@ function parseRpcEvent(rpcEvent): CirclesEvent; ``` -Defined in: [packages/rpc/src/events/parser.ts:84](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/parser.ts#L84) +Defined in: [packages/rpc/src/events/parser.ts:84](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/parser.ts#L84) Parse a single RPC subscription event into a CirclesEvent diff --git a/docs/rpc/src/functions/parseRpcSubscriptionMessage.md b/docs/rpc/src/functions/parseRpcSubscriptionMessage.md index 96a6c0b..8b4ec00 100644 --- a/docs/rpc/src/functions/parseRpcSubscriptionMessage.md +++ b/docs/rpc/src/functions/parseRpcSubscriptionMessage.md @@ -10,7 +10,7 @@ function parseRpcSubscriptionMessage(message): CirclesEvent[]; ``` -Defined in: [packages/rpc/src/events/parser.ts:113](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/events/parser.ts#L113) +Defined in: [packages/rpc/src/events/parser.ts:113](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/events/parser.ts#L113) Parse an array of RPC subscription events diff --git a/docs/rpc/src/functions/parseStringsToBigInt.md b/docs/rpc/src/functions/parseStringsToBigInt.md index ef5c817..c5e03fe 100644 --- a/docs/rpc/src/functions/parseStringsToBigInt.md +++ b/docs/rpc/src/functions/parseStringsToBigInt.md @@ -10,7 +10,7 @@ function parseStringsToBigInt(obj): T; ``` -Defined in: [packages/rpc/src/utils.ts:96](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/utils.ts#L96) +Defined in: [packages/rpc/src/utils.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/utils.ts#L100) Convert string numeric values to bigint in an object diff --git a/docs/rpc/src/interfaces/CursorColumn.md b/docs/rpc/src/interfaces/CursorColumn.md index 3850c2b..83f87c4 100644 --- a/docs/rpc/src/interfaces/CursorColumn.md +++ b/docs/rpc/src/interfaces/CursorColumn.md @@ -6,7 +6,7 @@ # Interface: CursorColumn -Defined in: [packages/rpc/src/types.ts:70](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L70) +Defined in: [packages/rpc/src/types.ts:70](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L70) Configuration for a cursor column in pagination @@ -18,7 +18,7 @@ Configuration for a cursor column in pagination name: string; ``` -Defined in: [packages/rpc/src/types.ts:71](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L71) +Defined in: [packages/rpc/src/types.ts:71](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L71) *** @@ -28,7 +28,7 @@ Defined in: [packages/rpc/src/types.ts:71](https://github.com/aboutcircles/sdk-v sortOrder: "ASC" | "DESC"; ``` -Defined in: [packages/rpc/src/types.ts:72](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L72) +Defined in: [packages/rpc/src/types.ts:72](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L72) *** @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/types.ts:72](https://github.com/aboutcircles/sdk-v optional toValue: (value) => string | number | boolean; ``` -Defined in: [packages/rpc/src/types.ts:73](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L73) +Defined in: [packages/rpc/src/types.ts:73](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L73) #### Parameters diff --git a/docs/rpc/src/interfaces/FlexiblePagedResult.md b/docs/rpc/src/interfaces/FlexiblePagedResult.md index 7aa29ca..0802c0e 100644 --- a/docs/rpc/src/interfaces/FlexiblePagedResult.md +++ b/docs/rpc/src/interfaces/FlexiblePagedResult.md @@ -6,7 +6,7 @@ # Interface: FlexiblePagedResult\ -Defined in: [packages/rpc/src/types.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L79) +Defined in: [packages/rpc/src/types.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L79) Flexible paged result that works with both event-based and custom cursors @@ -24,7 +24,7 @@ Flexible paged result that works with both event-based and custom cursors limit: number; ``` -Defined in: [packages/rpc/src/types.ts:80](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L80) +Defined in: [packages/rpc/src/types.ts:80](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L80) *** @@ -34,7 +34,7 @@ Defined in: [packages/rpc/src/types.ts:80](https://github.com/aboutcircles/sdk-v size: number; ``` -Defined in: [packages/rpc/src/types.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L81) +Defined in: [packages/rpc/src/types.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L81) *** @@ -44,7 +44,7 @@ Defined in: [packages/rpc/src/types.ts:81](https://github.com/aboutcircles/sdk-v optional firstCursor: Record; ``` -Defined in: [packages/rpc/src/types.ts:82](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L82) +Defined in: [packages/rpc/src/types.ts:82](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L82) *** @@ -54,7 +54,7 @@ Defined in: [packages/rpc/src/types.ts:82](https://github.com/aboutcircles/sdk-v optional lastCursor: Record; ``` -Defined in: [packages/rpc/src/types.ts:83](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L83) +Defined in: [packages/rpc/src/types.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L83) *** @@ -64,7 +64,7 @@ Defined in: [packages/rpc/src/types.ts:83](https://github.com/aboutcircles/sdk-v sortOrder: "ASC" | "DESC"; ``` -Defined in: [packages/rpc/src/types.ts:84](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L84) +Defined in: [packages/rpc/src/types.ts:84](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L84) *** @@ -74,7 +74,7 @@ Defined in: [packages/rpc/src/types.ts:84](https://github.com/aboutcircles/sdk-v hasMore: boolean; ``` -Defined in: [packages/rpc/src/types.ts:85](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L85) +Defined in: [packages/rpc/src/types.ts:85](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L85) *** @@ -84,4 +84,4 @@ Defined in: [packages/rpc/src/types.ts:85](https://github.com/aboutcircles/sdk-v results: TRow[]; ``` -Defined in: [packages/rpc/src/types.ts:86](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L86) +Defined in: [packages/rpc/src/types.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L86) diff --git a/docs/rpc/src/interfaces/GroupTokenHolderRow.md b/docs/rpc/src/interfaces/GroupTokenHolderRow.md index 7e45efb..83631b4 100644 --- a/docs/rpc/src/interfaces/GroupTokenHolderRow.md +++ b/docs/rpc/src/interfaces/GroupTokenHolderRow.md @@ -6,7 +6,7 @@ # Interface: GroupTokenHolderRow -Defined in: [packages/rpc/src/types.ts:59](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L59) +Defined in: [packages/rpc/src/types.ts:59](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L59) Row type for GroupTokenHoldersBalance view table @@ -18,7 +18,7 @@ Row type for GroupTokenHoldersBalance view table group: `0x${string}`; ``` -Defined in: [packages/rpc/src/types.ts:60](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L60) +Defined in: [packages/rpc/src/types.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L60) *** @@ -28,7 +28,7 @@ Defined in: [packages/rpc/src/types.ts:60](https://github.com/aboutcircles/sdk-v holder: `0x${string}`; ``` -Defined in: [packages/rpc/src/types.ts:61](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L61) +Defined in: [packages/rpc/src/types.ts:61](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L61) *** @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/types.ts:61](https://github.com/aboutcircles/sdk-v totalBalance: bigint; ``` -Defined in: [packages/rpc/src/types.ts:62](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L62) +Defined in: [packages/rpc/src/types.ts:62](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L62) *** @@ -48,7 +48,7 @@ Defined in: [packages/rpc/src/types.ts:62](https://github.com/aboutcircles/sdk-v demurragedTotalBalance: bigint; ``` -Defined in: [packages/rpc/src/types.ts:63](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L63) +Defined in: [packages/rpc/src/types.ts:63](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L63) *** @@ -58,4 +58,4 @@ Defined in: [packages/rpc/src/types.ts:63](https://github.com/aboutcircles/sdk-v fractionOwnership: number; ``` -Defined in: [packages/rpc/src/types.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L64) +Defined in: [packages/rpc/src/types.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L64) diff --git a/docs/rpc/src/interfaces/SearchResultProfile.md b/docs/rpc/src/interfaces/SearchResultProfile.md index afd7d13..7cc0c84 100644 --- a/docs/rpc/src/interfaces/SearchResultProfile.md +++ b/docs/rpc/src/interfaces/SearchResultProfile.md @@ -6,7 +6,7 @@ # Interface: SearchResultProfile -Defined in: [packages/rpc/src/types.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L41) +Defined in: [packages/rpc/src/types.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L41) Search result profile with additional metadata @@ -18,7 +18,7 @@ Search result profile with additional metadata address: `0x${string}`; ``` -Defined in: [packages/rpc/src/types.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L42) +Defined in: [packages/rpc/src/types.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L42) *** @@ -28,7 +28,7 @@ Defined in: [packages/rpc/src/types.ts:42](https://github.com/aboutcircles/sdk-v name: string; ``` -Defined in: [packages/rpc/src/types.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L43) +Defined in: [packages/rpc/src/types.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L43) *** @@ -38,7 +38,7 @@ Defined in: [packages/rpc/src/types.ts:43](https://github.com/aboutcircles/sdk-v optional description: string; ``` -Defined in: [packages/rpc/src/types.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L44) +Defined in: [packages/rpc/src/types.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L44) *** @@ -48,7 +48,7 @@ Defined in: [packages/rpc/src/types.ts:44](https://github.com/aboutcircles/sdk-v optional previewImageUrl: string; ``` -Defined in: [packages/rpc/src/types.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L45) +Defined in: [packages/rpc/src/types.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L45) *** @@ -58,7 +58,7 @@ Defined in: [packages/rpc/src/types.ts:45](https://github.com/aboutcircles/sdk-v optional imageUrl: string; ``` -Defined in: [packages/rpc/src/types.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L46) +Defined in: [packages/rpc/src/types.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L46) *** @@ -68,7 +68,7 @@ Defined in: [packages/rpc/src/types.ts:46](https://github.com/aboutcircles/sdk-v optional location: string; ``` -Defined in: [packages/rpc/src/types.ts:47](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L47) +Defined in: [packages/rpc/src/types.ts:47](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L47) *** @@ -78,7 +78,7 @@ Defined in: [packages/rpc/src/types.ts:47](https://github.com/aboutcircles/sdk-v optional geoLocation: [number, number]; ``` -Defined in: [packages/rpc/src/types.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L48) +Defined in: [packages/rpc/src/types.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L48) *** @@ -88,7 +88,7 @@ Defined in: [packages/rpc/src/types.ts:48](https://github.com/aboutcircles/sdk-v optional extensions: Record; ``` -Defined in: [packages/rpc/src/types.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L49) +Defined in: [packages/rpc/src/types.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L49) *** @@ -98,7 +98,7 @@ Defined in: [packages/rpc/src/types.ts:49](https://github.com/aboutcircles/sdk-v optional avatarType: string; ``` -Defined in: [packages/rpc/src/types.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L50) +Defined in: [packages/rpc/src/types.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L50) *** @@ -108,7 +108,7 @@ Defined in: [packages/rpc/src/types.ts:50](https://github.com/aboutcircles/sdk-v optional CID: string; ``` -Defined in: [packages/rpc/src/types.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L51) +Defined in: [packages/rpc/src/types.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L51) *** @@ -118,7 +118,7 @@ Defined in: [packages/rpc/src/types.ts:51](https://github.com/aboutcircles/sdk-v optional lastUpdatedAt: number; ``` -Defined in: [packages/rpc/src/types.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L52) +Defined in: [packages/rpc/src/types.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L52) *** @@ -128,4 +128,4 @@ Defined in: [packages/rpc/src/types.ts:52](https://github.com/aboutcircles/sdk-v optional registeredName: string | null; ``` -Defined in: [packages/rpc/src/types.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L53) +Defined in: [packages/rpc/src/types.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L53) diff --git a/docs/rpc/src/interfaces/TransactionHistoryRow.md b/docs/rpc/src/interfaces/TransactionHistoryRow.md index d0ce32b..438da1e 100644 --- a/docs/rpc/src/interfaces/TransactionHistoryRow.md +++ b/docs/rpc/src/interfaces/TransactionHistoryRow.md @@ -6,7 +6,7 @@ # Interface: TransactionHistoryRow -Defined in: [packages/rpc/src/types.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L12) +Defined in: [packages/rpc/src/types.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L12) Transaction history row (base data from RPC) Might include conversions between different circle representations @@ -19,7 +19,7 @@ Might include conversions between different circle representations blockNumber: number; ``` -Defined in: [packages/rpc/src/types.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L13) +Defined in: [packages/rpc/src/types.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L13) *** @@ -29,7 +29,7 @@ Defined in: [packages/rpc/src/types.ts:13](https://github.com/aboutcircles/sdk-v timestamp: number; ``` -Defined in: [packages/rpc/src/types.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L14) +Defined in: [packages/rpc/src/types.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L14) *** @@ -39,7 +39,7 @@ Defined in: [packages/rpc/src/types.ts:14](https://github.com/aboutcircles/sdk-v transactionIndex: number; ``` -Defined in: [packages/rpc/src/types.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L15) +Defined in: [packages/rpc/src/types.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L15) *** @@ -49,7 +49,7 @@ Defined in: [packages/rpc/src/types.ts:15](https://github.com/aboutcircles/sdk-v logIndex: number; ``` -Defined in: [packages/rpc/src/types.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L16) +Defined in: [packages/rpc/src/types.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L16) *** @@ -59,7 +59,7 @@ Defined in: [packages/rpc/src/types.ts:16](https://github.com/aboutcircles/sdk-v transactionHash: string; ``` -Defined in: [packages/rpc/src/types.ts:17](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L17) +Defined in: [packages/rpc/src/types.ts:17](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L17) *** @@ -69,7 +69,7 @@ Defined in: [packages/rpc/src/types.ts:17](https://github.com/aboutcircles/sdk-v version: number; ``` -Defined in: [packages/rpc/src/types.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L18) +Defined in: [packages/rpc/src/types.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L18) *** @@ -79,7 +79,7 @@ Defined in: [packages/rpc/src/types.ts:18](https://github.com/aboutcircles/sdk-v from: `0x${string}`; ``` -Defined in: [packages/rpc/src/types.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L19) +Defined in: [packages/rpc/src/types.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L19) *** @@ -89,7 +89,7 @@ Defined in: [packages/rpc/src/types.ts:19](https://github.com/aboutcircles/sdk-v to: `0x${string}`; ``` -Defined in: [packages/rpc/src/types.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L20) +Defined in: [packages/rpc/src/types.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L20) *** @@ -99,7 +99,7 @@ Defined in: [packages/rpc/src/types.ts:20](https://github.com/aboutcircles/sdk-v id: string; ``` -Defined in: [packages/rpc/src/types.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L21) +Defined in: [packages/rpc/src/types.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L21) *** @@ -109,7 +109,7 @@ Defined in: [packages/rpc/src/types.ts:21](https://github.com/aboutcircles/sdk-v tokenAddress: `0x${string}`; ``` -Defined in: [packages/rpc/src/types.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L22) +Defined in: [packages/rpc/src/types.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L22) *** @@ -119,7 +119,7 @@ Defined in: [packages/rpc/src/types.ts:22](https://github.com/aboutcircles/sdk-v value: string; ``` -Defined in: [packages/rpc/src/types.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L23) +Defined in: [packages/rpc/src/types.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L23) *** @@ -129,7 +129,7 @@ Defined in: [packages/rpc/src/types.ts:23](https://github.com/aboutcircles/sdk-v optional circles: number; ``` -Defined in: [packages/rpc/src/types.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L25) +Defined in: [packages/rpc/src/types.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L25) Human-readable circle amount (demurraged) @@ -141,7 +141,7 @@ Human-readable circle amount (demurraged) optional attoCircles: bigint; ``` -Defined in: [packages/rpc/src/types.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L27) +Defined in: [packages/rpc/src/types.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L27) Atto-circles (demurraged, 18 decimals) @@ -153,7 +153,7 @@ Atto-circles (demurraged, 18 decimals) optional staticCircles: number; ``` -Defined in: [packages/rpc/src/types.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L29) +Defined in: [packages/rpc/src/types.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L29) Static circles (inflationary, human-readable) @@ -165,7 +165,7 @@ Static circles (inflationary, human-readable) optional staticAttoCircles: bigint; ``` -Defined in: [packages/rpc/src/types.ts:31](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L31) +Defined in: [packages/rpc/src/types.ts:31](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L31) Atto-static circles (inflationary, 18 decimals) @@ -177,7 +177,7 @@ Atto-static circles (inflationary, 18 decimals) optional crc: number; ``` -Defined in: [packages/rpc/src/types.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L33) +Defined in: [packages/rpc/src/types.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L33) Time Circles (CRC) human-readable @@ -189,6 +189,6 @@ Time Circles (CRC) human-readable optional attoCrc: bigint; ``` -Defined in: [packages/rpc/src/types.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/types.ts#L35) +Defined in: [packages/rpc/src/types.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/types.ts#L35) Atto-CRC (18 decimals) diff --git a/docs/rpc/src/type-aliases/RpcErrorSource.md b/docs/rpc/src/type-aliases/RpcErrorSource.md index f275f35..e7c004b 100644 --- a/docs/rpc/src/type-aliases/RpcErrorSource.md +++ b/docs/rpc/src/type-aliases/RpcErrorSource.md @@ -15,6 +15,6 @@ type RpcErrorSource = | "RPC_WEBSOCKET"; ``` -Defined in: [packages/rpc/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/rpc/src/errors.ts#L10) +Defined in: [packages/rpc/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/rpc/src/errors.ts#L10) RPC-specific error sources diff --git a/docs/runner/src/classes/RunnerError.md b/docs/runner/src/classes/RunnerError.md index 0d0e66a..b1ff673 100644 --- a/docs/runner/src/classes/RunnerError.md +++ b/docs/runner/src/classes/RunnerError.md @@ -6,7 +6,7 @@ # Class: RunnerError -Defined in: [packages/runner/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L20) +Defined in: [packages/runner/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L20) Runner and transaction execution errors @@ -22,7 +22,7 @@ Runner and transaction execution errors new RunnerError(message, options?): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L21) +Defined in: [packages/runner/src/errors.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L21) #### Parameters @@ -66,7 +66,7 @@ CirclesError.constructor static initializationFailed(runnerType, cause?): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L36) +Defined in: [packages/runner/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L36) Create error for initialization failures @@ -92,7 +92,7 @@ Create error for initialization failures static executionFailed(reason, cause?): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L48) +Defined in: [packages/runner/src/errors.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L48) Create error for transaction execution failures @@ -118,7 +118,7 @@ Create error for transaction execution failures static walletError(message, cause?): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:60](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L60) +Defined in: [packages/runner/src/errors.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L60) Create error for wallet-related issues @@ -147,7 +147,7 @@ static safeError( cause?): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:71](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L71) +Defined in: [packages/runner/src/errors.ts:71](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L71) Create error for Safe-specific issues @@ -177,7 +177,7 @@ Create error for Safe-specific issues static missingSigner(): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:83](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L83) +Defined in: [packages/runner/src/errors.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L83) Create error for missing signer @@ -193,7 +193,7 @@ Create error for missing signer static timeout(txHash, timeout): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:93](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L93) +Defined in: [packages/runner/src/errors.ts:93](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L93) Create error for transaction timeout @@ -223,7 +223,7 @@ static transactionReverted( cause?): RunnerError; ``` -Defined in: [packages/runner/src/errors.ts:104](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L104) +Defined in: [packages/runner/src/errors.ts:104](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L104) Create error for reverted transactions diff --git a/docs/runner/src/classes/SafeBatchRun.md b/docs/runner/src/classes/SafeBatchRun.md index 54ef49e..17ea93a 100644 --- a/docs/runner/src/classes/SafeBatchRun.md +++ b/docs/runner/src/classes/SafeBatchRun.md @@ -6,7 +6,7 @@ # Class: SafeBatchRun -Defined in: [packages/runner/src/safe-runner.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L19) +Defined in: [packages/runner/src/safe-runner.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L19) Batch transaction runner for Safe Allows multiple transactions to be batched and executed together @@ -23,7 +23,7 @@ Allows multiple transactions to be batched and executed together new SafeBatchRun(safe, publicClient): SafeBatchRun; ``` -Defined in: [packages/runner/src/safe-runner.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L22) +Defined in: [packages/runner/src/safe-runner.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L22) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/runner/src/safe-runner.ts:22](https://github.com/aboutcirc addTransaction(tx): void; ``` -Defined in: [packages/runner/src/safe-runner.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L30) +Defined in: [packages/runner/src/safe-runner.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L30) Add a transaction to the batch @@ -73,7 +73,7 @@ BatchRun.addTransaction getSafeTransaction(): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L37) +Defined in: [packages/runner/src/safe-runner.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L37) Get the Safe transaction data for all batched transactions @@ -89,7 +89,7 @@ Get the Safe transaction data for all batched transactions run(): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L56) +Defined in: [packages/runner/src/safe-runner.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L56) Execute all batched transactions and wait for confirmation diff --git a/docs/runner/src/classes/SafeBrowserBatchRun.md b/docs/runner/src/classes/SafeBrowserBatchRun.md index 0a8b25b..668ba4d 100644 --- a/docs/runner/src/classes/SafeBrowserBatchRun.md +++ b/docs/runner/src/classes/SafeBrowserBatchRun.md @@ -6,7 +6,7 @@ # Class: SafeBrowserBatchRun -Defined in: [packages/runner/src/safe-browser-runner.ts:257](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L257) +Defined in: [packages/runner/src/safe-browser-runner.ts:257](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L257) Batch transaction runner for Safe browser operations Allows multiple transactions to be batched and executed together @@ -23,7 +23,7 @@ Allows multiple transactions to be batched and executed together new SafeBrowserBatchRun(safe, publicClient): SafeBrowserBatchRun; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:260](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L260) +Defined in: [packages/runner/src/safe-browser-runner.ts:260](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L260) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/runner/src/safe-browser-runner.ts:260](https://github.com/ addTransaction(tx): void; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:268](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L268) +Defined in: [packages/runner/src/safe-browser-runner.ts:268](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L268) Add a transaction to the batch @@ -73,7 +73,7 @@ BatchRun.addTransaction getSafeTransaction(): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:275](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L275) +Defined in: [packages/runner/src/safe-browser-runner.ts:275](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L275) Get the Safe transaction data for all batched transactions @@ -89,7 +89,7 @@ Get the Safe transaction data for all batched transactions run(): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:296](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L296) +Defined in: [packages/runner/src/safe-browser-runner.ts:296](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L296) Execute all batched transactions and wait for confirmation The user will be prompted to sign the transaction through their Web3 wallet diff --git a/docs/runner/src/classes/SafeBrowserRunner.md b/docs/runner/src/classes/SafeBrowserRunner.md index ba57512..026e692 100644 --- a/docs/runner/src/classes/SafeBrowserRunner.md +++ b/docs/runner/src/classes/SafeBrowserRunner.md @@ -6,7 +6,7 @@ # Class: SafeBrowserRunner -Defined in: [packages/runner/src/safe-browser-runner.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L23) +Defined in: [packages/runner/src/safe-browser-runner.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L23) Safe browser contract runner implementation using Safe Protocol Kit Executes transactions through a Safe multisig wallet using the browser's Web3 provider @@ -29,7 +29,7 @@ new SafeBrowserRunner( safeAddress?): SafeBrowserRunner; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:57](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L57) +Defined in: [packages/runner/src/safe-browser-runner.ts:57](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L57) Creates a new SafeBrowserRunner @@ -82,7 +82,7 @@ await runner.init(); optional address: string; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L24) +Defined in: [packages/runner/src/safe-browser-runner.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L24) The address of the account (if available) @@ -100,7 +100,7 @@ ContractRunner.address publicClient: object; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L25) +Defined in: [packages/runner/src/safe-browser-runner.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L25) The public client for reading blockchain state @@ -122,7 +122,7 @@ static create( chain): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:88](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L88) +Defined in: [packages/runner/src/safe-browser-runner.ts:88](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L88) Create and initialize a SafeBrowserRunner in one step @@ -178,7 +178,7 @@ const runner = await SafeBrowserRunner.create( init(safeAddress?): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:109](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L109) +Defined in: [packages/runner/src/safe-browser-runner.ts:109](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L109) Initialize the runner with a Safe address @@ -212,7 +212,7 @@ ContractRunner.init estimateGas(tx): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:145](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L145) +Defined in: [packages/runner/src/safe-browser-runner.ts:145](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L145) Estimate gas for a transaction @@ -240,7 +240,7 @@ ContractRunner.estimateGas call(tx): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:161](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L161) +Defined in: [packages/runner/src/safe-browser-runner.ts:161](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L161) Call a contract (read-only operation) @@ -268,7 +268,7 @@ ContractRunner.call resolveName(name): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:179](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L179) +Defined in: [packages/runner/src/safe-browser-runner.ts:179](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L179) Resolve an ENS name to an address @@ -296,7 +296,7 @@ ContractRunner.resolveName sendTransaction(txs): Promise; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:199](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L199) +Defined in: [packages/runner/src/safe-browser-runner.ts:199](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L199) Send one or more transactions through the Safe and wait for confirmation All transactions are batched and executed atomically @@ -331,7 +331,7 @@ ContractRunner.sendTransaction sendBatchTransaction(): SafeBrowserBatchRun; ``` -Defined in: [packages/runner/src/safe-browser-runner.ts:247](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-browser-runner.ts#L247) +Defined in: [packages/runner/src/safe-browser-runner.ts:247](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-browser-runner.ts#L247) Create a batch transaction runner diff --git a/docs/runner/src/classes/SafeContractRunner.md b/docs/runner/src/classes/SafeContractRunner.md index dde47b6..bb11bd6 100644 --- a/docs/runner/src/classes/SafeContractRunner.md +++ b/docs/runner/src/classes/SafeContractRunner.md @@ -6,7 +6,7 @@ # Class: SafeContractRunner -Defined in: [packages/runner/src/safe-runner.ts:88](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L88) +Defined in: [packages/runner/src/safe-runner.ts:88](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L88) Safe contract runner implementation using Safe Protocol Kit Executes transactions through a Safe multisig wallet @@ -27,7 +27,7 @@ new SafeContractRunner( safeAddress?): SafeContractRunner; ``` -Defined in: [packages/runner/src/safe-runner.ts:105](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L105) +Defined in: [packages/runner/src/safe-runner.ts:105](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L105) Creates a new SafeContractRunner @@ -67,7 +67,7 @@ The address of the Safe wallet (optional, can be set in init) optional address: string; ``` -Defined in: [packages/runner/src/safe-runner.ts:89](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L89) +Defined in: [packages/runner/src/safe-runner.ts:89](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L89) The address of the account (if available) @@ -85,7 +85,7 @@ ContractRunner.address publicClient: object; ``` -Defined in: [packages/runner/src/safe-runner.ts:90](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L90) +Defined in: [packages/runner/src/safe-runner.ts:90](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L90) The public client for reading blockchain state @@ -107,7 +107,7 @@ static create( chain): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:138](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L138) +Defined in: [packages/runner/src/safe-runner.ts:138](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L138) Create and initialize a SafeContractRunner in one step @@ -165,7 +165,7 @@ const runner = await SafeContractRunner.create( init(safeAddress?): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:158](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L158) +Defined in: [packages/runner/src/safe-runner.ts:158](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L158) Initialize the runner with a Safe address @@ -195,7 +195,7 @@ ContractRunner.init estimateGas(tx): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:190](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L190) +Defined in: [packages/runner/src/safe-runner.ts:190](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L190) Estimate gas for a transaction @@ -223,7 +223,7 @@ ContractRunner.estimateGas call(tx): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:206](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L206) +Defined in: [packages/runner/src/safe-runner.ts:206](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L206) Call a contract (read-only operation) @@ -251,7 +251,7 @@ ContractRunner.call resolveName(name): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:224](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L224) +Defined in: [packages/runner/src/safe-runner.ts:224](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L224) Resolve an ENS name to an address @@ -279,7 +279,7 @@ ContractRunner.resolveName sendTransaction(txs): Promise; ``` -Defined in: [packages/runner/src/safe-runner.ts:242](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L242) +Defined in: [packages/runner/src/safe-runner.ts:242](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L242) Send one or more transactions through the Safe and wait for confirmation All transactions are batched and executed atomically @@ -312,7 +312,7 @@ ContractRunner.sendTransaction sendBatchTransaction(): SafeBatchRun; ``` -Defined in: [packages/runner/src/safe-runner.ts:290](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/safe-runner.ts#L290) +Defined in: [packages/runner/src/safe-runner.ts:290](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/safe-runner.ts#L290) Create a batch transaction runner diff --git a/docs/runner/src/type-aliases/RunnerErrorSource.md b/docs/runner/src/type-aliases/RunnerErrorSource.md index 1d2d0cf..45dbebd 100644 --- a/docs/runner/src/type-aliases/RunnerErrorSource.md +++ b/docs/runner/src/type-aliases/RunnerErrorSource.md @@ -15,6 +15,6 @@ type RunnerErrorSource = | "SAFE"; ``` -Defined in: [packages/runner/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/runner/src/errors.ts#L10) +Defined in: [packages/runner/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/runner/src/errors.ts#L10) Runner-specific error sources diff --git a/docs/sdk/src/classes/BaseGroupAvatar.md b/docs/sdk/src/classes/BaseGroupAvatar.md index 999505b..760665d 100644 --- a/docs/sdk/src/classes/BaseGroupAvatar.md +++ b/docs/sdk/src/classes/BaseGroupAvatar.md @@ -6,7 +6,7 @@ # Class: BaseGroupAvatar -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L22) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L22) BaseGroupAvatar class implementation Provides a simplified wrapper around Circles protocol for base group avatars @@ -30,7 +30,7 @@ new BaseGroupAvatar( avatarInfo?): BaseGroupAvatar; ``` -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L25) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L25) #### Parameters @@ -68,7 +68,7 @@ CommonAvatar.constructor readonly balances: object; ``` -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L44) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L44) #### getTotal() @@ -116,7 +116,7 @@ CommonAvatar.balances readonly trust: object; ``` -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:68](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L68) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:68](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L68) #### add() @@ -251,7 +251,7 @@ CommonAvatar.trust readonly profile: object; ``` -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:151](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L151) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:151](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L151) #### get() @@ -325,7 +325,7 @@ CommonAvatar.profile readonly properties: object; ``` -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:214](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L214) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:214](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L214) #### owner() @@ -395,7 +395,7 @@ Get all membership conditions readonly setProperties: object; ``` -Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:256](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/BaseGroupAvatar.ts#L256) +Defined in: [packages/sdk/src/avatars/BaseGroupAvatar.ts:256](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/BaseGroupAvatar.ts#L256) #### owner() @@ -481,7 +481,7 @@ Enable or disable a membership condition readonly address: `0x${string}`; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L42) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L42) #### Inherited from @@ -497,7 +497,7 @@ CommonAvatar.address readonly avatarInfo: AvatarRow | undefined; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L43) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L43) #### Inherited from @@ -513,7 +513,7 @@ CommonAvatar.avatarInfo readonly core: Core; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L44) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L44) #### Inherited from @@ -529,7 +529,7 @@ CommonAvatar.core readonly optional contractRunner: ContractRunner; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L45) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L45) #### Inherited from @@ -545,7 +545,7 @@ CommonAvatar.contractRunner events: Observable; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L46) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L46) #### Inherited from @@ -561,7 +561,7 @@ CommonAvatar.events protected readonly runner: ContractRunner; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L48) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L48) #### Inherited from @@ -577,7 +577,7 @@ CommonAvatar.runner protected readonly profiles: Profiles; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L49) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L49) #### Inherited from @@ -593,7 +593,7 @@ CommonAvatar.profiles protected readonly rpc: CirclesRpc; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L50) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L50) #### Inherited from @@ -609,7 +609,7 @@ CommonAvatar.rpc protected readonly transferBuilder: TransferBuilder; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L51) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L51) #### Inherited from @@ -625,7 +625,7 @@ CommonAvatar.transferBuilder protected optional _cachedProfile: Profile; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L52) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L52) #### Inherited from @@ -641,7 +641,7 @@ CommonAvatar._cachedProfile protected optional _cachedProfileCid: string; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L53) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L53) #### Inherited from @@ -657,7 +657,7 @@ CommonAvatar._cachedProfileCid protected optional _eventSubscription: () => void; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L54) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L54) #### Returns @@ -677,7 +677,7 @@ CommonAvatar._eventSubscription readonly history: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:405](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L405) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:407](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L407) #### getTransactions() @@ -739,7 +739,7 @@ CommonAvatar.history readonly transfer: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:439](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L439) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:441](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L441) #### direct() @@ -926,7 +926,7 @@ CommonAvatar.transfer readonly wrap: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:599](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L599) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:601](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L601) #### asDemurraged() @@ -1080,10 +1080,11 @@ CommonAvatar.wrap subscribeToEvents(): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:709](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L709) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:712](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L712) Subscribe to Circles events for this avatar Events are filtered to only include events related to this avatar's address +This method is idempotent - calling it multiple times will not create duplicate subscriptions #### Returns @@ -1120,7 +1121,7 @@ CommonAvatar.subscribeToEvents unsubscribeFromEvents(): void; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:719](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L719) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:738](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L738) Unsubscribe from events Cleans up the WebSocket connection and event listeners @@ -1147,7 +1148,7 @@ protected _transferErc1155( txData?): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:734](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L734) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:753](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L753) Transfer ERC1155 tokens using safeTransferFrom @@ -1190,7 +1191,7 @@ protected _transferErc20( tokenAddress): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:763](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L763) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:782](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L782) Transfer ERC20 tokens using the standard transfer function diff --git a/docs/sdk/src/classes/HumanAvatar.md b/docs/sdk/src/classes/HumanAvatar.md index 2fb6951..9f7875f 100644 --- a/docs/sdk/src/classes/HumanAvatar.md +++ b/docs/sdk/src/classes/HumanAvatar.md @@ -6,7 +6,7 @@ # Class: HumanAvatar -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L25) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L27) HumanAvatar class implementation Provides a simplified, user-friendly wrapper around Circles protocol for human avatars @@ -30,7 +30,7 @@ new HumanAvatar( avatarInfo?): HumanAvatar; ``` -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L26) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L28) #### Parameters @@ -68,7 +68,7 @@ CommonAvatar.constructor readonly address: `0x${string}`; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L42) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L42) #### Inherited from @@ -84,7 +84,7 @@ CommonAvatar.address readonly avatarInfo: AvatarRow | undefined; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L43) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L43) #### Inherited from @@ -100,7 +100,7 @@ CommonAvatar.avatarInfo readonly core: Core; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L44) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L44) #### Inherited from @@ -116,7 +116,7 @@ CommonAvatar.core readonly optional contractRunner: ContractRunner; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L45) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L45) #### Inherited from @@ -132,7 +132,7 @@ CommonAvatar.contractRunner events: Observable; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L46) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L46) #### Inherited from @@ -148,7 +148,7 @@ CommonAvatar.events protected readonly runner: ContractRunner; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L48) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L48) #### Inherited from @@ -164,7 +164,7 @@ CommonAvatar.runner protected readonly profiles: Profiles; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L49) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L49) #### Inherited from @@ -180,7 +180,7 @@ CommonAvatar.profiles protected readonly rpc: CirclesRpc; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L50) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L50) #### Inherited from @@ -196,7 +196,7 @@ CommonAvatar.rpc protected readonly transferBuilder: TransferBuilder; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L51) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L51) #### Inherited from @@ -212,7 +212,7 @@ CommonAvatar.transferBuilder protected optional _cachedProfile: Profile; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L52) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L52) #### Inherited from @@ -228,7 +228,7 @@ CommonAvatar._cachedProfile protected optional _cachedProfileCid: string; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L53) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L53) #### Inherited from @@ -244,7 +244,7 @@ CommonAvatar._cachedProfileCid protected optional _eventSubscription: () => void; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L54) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L54) #### Returns @@ -264,7 +264,7 @@ CommonAvatar._eventSubscription readonly trust: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L128) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:130](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L130) #### add() @@ -435,7 +435,7 @@ CommonAvatar.trust readonly profile: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:267](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L267) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:269](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L269) #### get() @@ -579,7 +579,7 @@ CommonAvatar.profile readonly history: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:405](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L405) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:407](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L407) #### getTransactions() @@ -641,7 +641,7 @@ CommonAvatar.history readonly transfer: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:439](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L439) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:441](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L441) #### direct() @@ -828,7 +828,7 @@ CommonAvatar.transfer readonly wrap: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:599](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L599) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:601](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L601) #### asDemurraged() @@ -982,7 +982,7 @@ CommonAvatar.wrap readonly balances: object; ``` -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L39) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L41) #### getTotal() @@ -1095,7 +1095,7 @@ CommonAvatar.balances readonly invite: object; ``` -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:133](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L133) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:135](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L135) #### send() @@ -1316,6 +1316,65 @@ const { escrowedAmount, days_ } = await avatar.invite.getEscrowedAmount( ); ``` +#### generateInvites() + +```ts +generateInvites: (numberOfInvites) => Promise<{ + secrets: `0x${string}`[]; + signers: `0x${string}`[]; + transactionReceipt: TransactionReceipt; +}>; +``` + +Generate new invitations and return associated secrets and signer addresses + +This function: +1. Calls invitationFarm.claimInvites() to get invitation IDs via eth_call +2. Generates random secrets for each invitation +3. Derives signer addresses from the secrets using ECDSA +4. Batches the claimInvites write call with safeBatchTransferFrom to transfer + invitation tokens (96 CRC each) to the invitation module +5. Returns the list of secrets and corresponding signers + +The data field in the batch transfer contains the count of generated secrets, +which the contract uses to validate the transfer. + +##### Parameters + +###### numberOfInvites + +`bigint` + +The number of invitations to generate + +##### Returns + +`Promise`\<\{ + `secrets`: `` `0x${string}` ``[]; + `signers`: `` `0x${string}` ``[]; + `transactionReceipt`: `TransactionReceipt`; +\}\> + +Promise containing arrays of secrets and signers for each generated invitation + +##### Throws + +If the transaction fails or invitations cannot be claimed + +##### Example + +```typescript +// Generate 5 invitations +const result = await avatar.invite.generateInvites(5n); + +console.log('Generated invitations:'); +result.secrets.forEach((secret, index) => { + console.log(`Invitation ${index + 1}:`); + console.log(` Secret: ${secret}`); + console.log(` Signer: ${result.signers[index]}`); +}); +``` + *** ### personalToken @@ -1324,7 +1383,7 @@ const { escrowedAmount, days_ } = await avatar.invite.getEscrowedAmount( readonly personalToken: object; ``` -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:307](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L307) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:440](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L440) #### getMintableAmount() @@ -1416,7 +1475,7 @@ console.log('Stopped minting, tx hash:', receipt.hash); readonly groupToken: object; ``` -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:387](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L387) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:520](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L520) #### mint() @@ -1670,7 +1729,7 @@ Array of membership condition addresses readonly group: object; ``` -Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:651](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/HumanAvatar.ts#L651) +Defined in: [packages/sdk/src/avatars/HumanAvatar.ts:784](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/HumanAvatar.ts#L784) #### properties @@ -1906,10 +1965,11 @@ groups.forEach(group => { subscribeToEvents(): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:709](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L709) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:712](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L712) Subscribe to Circles events for this avatar Events are filtered to only include events related to this avatar's address +This method is idempotent - calling it multiple times will not create duplicate subscriptions #### Returns @@ -1946,7 +2006,7 @@ CommonAvatar.subscribeToEvents unsubscribeFromEvents(): void; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:719](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L719) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:738](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L738) Unsubscribe from events Cleans up the WebSocket connection and event listeners @@ -1973,7 +2033,7 @@ protected _transferErc1155( txData?): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:734](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L734) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:753](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L753) Transfer ERC1155 tokens using safeTransferFrom @@ -2016,7 +2076,7 @@ protected _transferErc20( tokenAddress): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:763](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L763) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:782](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L782) Transfer ERC20 tokens using the standard transfer function diff --git a/docs/sdk/src/classes/OrganisationAvatar.md b/docs/sdk/src/classes/OrganisationAvatar.md index 71fafd1..3391c67 100644 --- a/docs/sdk/src/classes/OrganisationAvatar.md +++ b/docs/sdk/src/classes/OrganisationAvatar.md @@ -6,7 +6,7 @@ # Class: OrganisationAvatar -Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/OrganisationAvatar.ts#L23) +Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/OrganisationAvatar.ts#L23) OrganisationAvatar class implementation Provides a simplified, user-friendly wrapper around Circles protocol for organisation avatars @@ -31,7 +31,7 @@ new OrganisationAvatar( avatarInfo?): OrganisationAvatar; ``` -Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/OrganisationAvatar.ts#L24) +Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/OrganisationAvatar.ts#L24) #### Parameters @@ -69,7 +69,7 @@ CommonAvatar.constructor readonly address: `0x${string}`; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L42) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L42) #### Inherited from @@ -85,7 +85,7 @@ CommonAvatar.address readonly avatarInfo: AvatarRow | undefined; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L43) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L43) #### Inherited from @@ -101,7 +101,7 @@ CommonAvatar.avatarInfo readonly core: Core; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L44) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L44) #### Inherited from @@ -117,7 +117,7 @@ CommonAvatar.core readonly optional contractRunner: ContractRunner; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:45](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L45) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:45](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L45) #### Inherited from @@ -133,7 +133,7 @@ CommonAvatar.contractRunner events: Observable; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L46) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L46) #### Inherited from @@ -149,7 +149,7 @@ CommonAvatar.events protected readonly runner: ContractRunner; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L48) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L48) #### Inherited from @@ -165,7 +165,7 @@ CommonAvatar.runner protected readonly profiles: Profiles; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L49) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L49) #### Inherited from @@ -181,7 +181,7 @@ CommonAvatar.profiles protected readonly rpc: CirclesRpc; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L50) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L50) #### Inherited from @@ -197,7 +197,7 @@ CommonAvatar.rpc protected readonly transferBuilder: TransferBuilder; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L51) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L51) #### Inherited from @@ -213,7 +213,7 @@ CommonAvatar.transferBuilder protected optional _cachedProfile: Profile; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L52) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L52) #### Inherited from @@ -229,7 +229,7 @@ CommonAvatar._cachedProfile protected optional _cachedProfileCid: string; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L53) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L53) #### Inherited from @@ -245,7 +245,7 @@ CommonAvatar._cachedProfileCid protected optional _eventSubscription: () => void; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L54) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L54) #### Returns @@ -265,7 +265,7 @@ CommonAvatar._eventSubscription readonly trust: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L128) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:130](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L130) #### add() @@ -436,7 +436,7 @@ CommonAvatar.trust readonly profile: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:267](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L267) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:269](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L269) #### get() @@ -580,7 +580,7 @@ CommonAvatar.profile readonly history: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:405](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L405) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:407](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L407) #### getTransactions() @@ -642,7 +642,7 @@ CommonAvatar.history readonly transfer: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:439](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L439) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:441](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L441) #### direct() @@ -829,7 +829,7 @@ CommonAvatar.transfer readonly wrap: object; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:599](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L599) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:601](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L601) #### asDemurraged() @@ -983,7 +983,7 @@ CommonAvatar.wrap readonly balances: object; ``` -Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/OrganisationAvatar.ts#L37) +Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/OrganisationAvatar.ts#L37) #### getTotal() @@ -1096,7 +1096,7 @@ CommonAvatar.balances readonly groupToken: object; ``` -Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:127](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/OrganisationAvatar.ts#L127) +Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:127](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/OrganisationAvatar.ts#L127) #### mint() @@ -1353,7 +1353,7 @@ Array of membership condition addresses readonly group: object; ``` -Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:391](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/OrganisationAvatar.ts#L391) +Defined in: [packages/sdk/src/avatars/OrganisationAvatar.ts:391](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/OrganisationAvatar.ts#L391) #### properties @@ -1501,10 +1501,11 @@ Array of membership condition addresses subscribeToEvents(): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:709](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L709) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:712](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L712) Subscribe to Circles events for this avatar Events are filtered to only include events related to this avatar's address +This method is idempotent - calling it multiple times will not create duplicate subscriptions #### Returns @@ -1541,7 +1542,7 @@ CommonAvatar.subscribeToEvents unsubscribeFromEvents(): void; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:719](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L719) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:738](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L738) Unsubscribe from events Cleans up the WebSocket connection and event listeners @@ -1568,7 +1569,7 @@ protected _transferErc1155( txData?): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:734](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L734) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:753](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L753) Transfer ERC1155 tokens using safeTransferFrom @@ -1611,7 +1612,7 @@ protected _transferErc20( tokenAddress): Promise; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:763](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L763) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:782](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L782) Transfer ERC20 tokens using the standard transfer function diff --git a/docs/sdk/src/classes/Sdk.md b/docs/sdk/src/classes/Sdk.md index b4a733a..c5e23db 100644 --- a/docs/sdk/src/classes/Sdk.md +++ b/docs/sdk/src/classes/Sdk.md @@ -6,7 +6,7 @@ # Class: Sdk -Defined in: [packages/sdk/src/Sdk.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L50) +Defined in: [packages/sdk/src/Sdk.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L51) Simplified Circles SDK Provides a user-friendly API for non-crypto users with low entrance barrier @@ -40,7 +40,7 @@ await avatar.personalToken.mint(); new Sdk(config, contractRunner?): Sdk; ``` -Defined in: [packages/sdk/src/Sdk.ts:77](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L77) +Defined in: [packages/sdk/src/Sdk.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L79) Create a new Sdk instance @@ -74,7 +74,7 @@ Error if contractRunner is provided but doesn't support sendTransaction or has n readonly circlesConfig: CirclesConfig; ``` -Defined in: [packages/sdk/src/Sdk.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L51) +Defined in: [packages/sdk/src/Sdk.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L52) *** @@ -84,7 +84,7 @@ Defined in: [packages/sdk/src/Sdk.ts:51](https://github.com/aboutcircles/sdk-v2/ readonly optional contractRunner: ContractRunner; ``` -Defined in: [packages/sdk/src/Sdk.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L52) +Defined in: [packages/sdk/src/Sdk.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L53) *** @@ -94,7 +94,7 @@ Defined in: [packages/sdk/src/Sdk.ts:52](https://github.com/aboutcircles/sdk-v2/ readonly optional senderAddress: `0x${string}`; ``` -Defined in: [packages/sdk/src/Sdk.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L53) +Defined in: [packages/sdk/src/Sdk.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L54) *** @@ -104,7 +104,7 @@ Defined in: [packages/sdk/src/Sdk.ts:53](https://github.com/aboutcircles/sdk-v2/ readonly core: Core; ``` -Defined in: [packages/sdk/src/Sdk.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L54) +Defined in: [packages/sdk/src/Sdk.ts:55](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L55) *** @@ -114,7 +114,7 @@ Defined in: [packages/sdk/src/Sdk.ts:54](https://github.com/aboutcircles/sdk-v2/ readonly rpc: CirclesRpc; ``` -Defined in: [packages/sdk/src/Sdk.ts:55](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L55) +Defined in: [packages/sdk/src/Sdk.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L56) *** @@ -124,7 +124,7 @@ Defined in: [packages/sdk/src/Sdk.ts:55](https://github.com/aboutcircles/sdk-v2/ readonly data: CirclesData; ``` -Defined in: [packages/sdk/src/Sdk.ts:58](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L58) +Defined in: [packages/sdk/src/Sdk.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L60) *** @@ -134,7 +134,7 @@ Defined in: [packages/sdk/src/Sdk.ts:58](https://github.com/aboutcircles/sdk-v2/ readonly register: object; ``` -Defined in: [packages/sdk/src/Sdk.ts:129](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L129) +Defined in: [packages/sdk/src/Sdk.ts:149](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L149) Registration methods for creating new Circles identities @@ -304,7 +304,7 @@ const groupAvatar = await sdk.register.asGroup( readonly profiles: object; ``` -Defined in: [packages/sdk/src/Sdk.ts:426](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L426) +Defined in: [packages/sdk/src/Sdk.ts:446](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L446) Profile management methods @@ -354,13 +354,111 @@ Profile data or undefined if not found *** +### referrals + +```ts +readonly referrals: object; +``` + +Defined in: [packages/sdk/src/Sdk.ts:472](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L472) + +Referral/invitation management methods + +The referrals backend enables users to invite others via referral links. +Requires referralsServiceUrl to be configured in CirclesConfig. + +#### store() + +```ts +store: (privateKey, inviter) => Promise; +``` + +Store a referral private key + +The private key is validated on-chain via ReferralsModule.accounts() to ensure +the account exists and has not been claimed. The inviter address is self-declared +for dashboard visibility only. + +##### Parameters + +###### privateKey + +`string` + +The referral private key (0x-prefixed, 64 hex chars) + +###### inviter + +`` `0x${string}` `` + +Self-declared inviter address for dashboard visibility + +##### Returns + +`Promise`\<`void`\> + +##### Throws + +Error if referrals service not configured or validation fails + +#### retrieve() + +```ts +retrieve: (privateKey) => Promise; +``` + +Retrieve referral info by private key + +This is a public endpoint - no authentication required. +Used by invitees to look up who invited them. + +##### Parameters + +###### privateKey + +`string` + +The referral private key + +##### Returns + +`Promise`\<`ReferralInfo`\> + +Referral info including inviter and status + +##### Throws + +Error if referrals service not configured or referral not found + +#### listMine() + +```ts +listMine: () => Promise; +``` + +List all referrals created by the authenticated user + +Requires authentication - must configure a token provider. + +##### Returns + +`Promise`\<`ReferralList`\> + +List of referrals with their status and metadata + +##### Throws + +Error if referrals service not configured or not authenticated + +*** + ### tokens ```ts readonly tokens: object; ``` -Defined in: [packages/sdk/src/Sdk.ts:449](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L449) +Defined in: [packages/sdk/src/Sdk.ts:527](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L527) Token utilities @@ -464,7 +562,7 @@ while (await holdersQuery.queryNextPage()) { readonly groups: object; ``` -Defined in: [packages/sdk/src/Sdk.ts:500](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L500) +Defined in: [packages/sdk/src/Sdk.ts:578](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L578) Group utilities @@ -639,13 +737,13 @@ while (await query.queryNextPage()) { ### getAvatar() ```ts -getAvatar(avatarAddress): Promise< +getAvatar(avatarAddress, autoSubscribeEvents): Promise< | HumanAvatar | OrganisationAvatar | BaseGroupAvatar>; ``` -Defined in: [packages/sdk/src/Sdk.ts:104](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/Sdk.ts#L104) +Defined in: [packages/sdk/src/Sdk.ts:115](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/Sdk.ts#L115) Get an avatar by address Automatically detects the avatar type and returns the appropriate avatar instance @@ -656,6 +754,15 @@ Automatically detects the avatar type and returns the appropriate avatar instanc `` `0x${string}` `` +The address of the avatar to fetch + +##### autoSubscribeEvents + +`boolean` = `false` + +Whether to automatically subscribe to events for this avatar (default: false) + If true, waits for event subscription to complete before returning + #### Returns `Promise`\< diff --git a/docs/sdk/src/classes/SdkError.md b/docs/sdk/src/classes/SdkError.md index 84fb5f4..4044f95 100644 --- a/docs/sdk/src/classes/SdkError.md +++ b/docs/sdk/src/classes/SdkError.md @@ -6,7 +6,7 @@ # Class: SdkError -Defined in: [packages/sdk/src/errors.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L19) +Defined in: [packages/sdk/src/errors.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L19) SDK-related errors @@ -22,7 +22,7 @@ SDK-related errors new SdkError(message, options?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L20) +Defined in: [packages/sdk/src/errors.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L20) #### Parameters @@ -66,7 +66,7 @@ CirclesError.constructor static notInitialized(component): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L35) +Defined in: [packages/sdk/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L35) Create error for uninitialized components @@ -88,7 +88,7 @@ Create error for uninitialized components static unsupportedOperation(operation, reason?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:46](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L46) +Defined in: [packages/sdk/src/errors.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L46) Create error for unsupported operations @@ -114,7 +114,7 @@ Create error for unsupported operations static configError(message, context?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:60](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L60) +Defined in: [packages/sdk/src/errors.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L60) Create error for configuration issues @@ -143,7 +143,7 @@ static operationFailed( cause?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:71](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L71) +Defined in: [packages/sdk/src/errors.ts:71](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L71) Create error for failed operations @@ -173,7 +173,7 @@ Create error for failed operations static missingContractRunner(operation?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:83](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L83) +Defined in: [packages/sdk/src/errors.ts:83](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L83) Create error for missing contract runner @@ -195,7 +195,7 @@ Create error for missing contract runner static avatarNotFound(address): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:99](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L99) +Defined in: [packages/sdk/src/errors.ts:99](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L99) Create error for avatar not found @@ -217,7 +217,7 @@ Create error for avatar not found static invalidProfile(reason, context?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:110](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L110) +Defined in: [packages/sdk/src/errors.ts:110](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L110) Create error for invalid profile @@ -246,7 +246,7 @@ static profileOperationFailed( cause?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:121](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L121) +Defined in: [packages/sdk/src/errors.ts:121](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L121) Create error for profile operation failures @@ -279,7 +279,7 @@ static insufficientBalance( token?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:133](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L133) +Defined in: [packages/sdk/src/errors.ts:133](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L133) Create error for insufficient balance @@ -309,7 +309,7 @@ Create error for insufficient balance static transactionDataExtractionFailed(dataType, reason?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:149](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L149) +Defined in: [packages/sdk/src/errors.ts:149](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L149) Create error for transaction extraction failures @@ -338,7 +338,7 @@ static registrationFailed( cause?): SdkError; ``` -Defined in: [packages/sdk/src/errors.ts:165](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L165) +Defined in: [packages/sdk/src/errors.ts:165](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L165) Create error for registration failures diff --git a/docs/sdk/src/interfaces/CirclesData.md b/docs/sdk/src/interfaces/CirclesData.md index 8c919a7..3a9606e 100644 --- a/docs/sdk/src/interfaces/CirclesData.md +++ b/docs/sdk/src/interfaces/CirclesData.md @@ -6,7 +6,7 @@ # Interface: CirclesData -Defined in: [packages/sdk/src/types.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/types.ts#L13) +Defined in: [packages/sdk/src/types.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/types.ts#L13) Circles data access layer Provides read access to Circles protocol data @@ -19,7 +19,7 @@ Provides read access to Circles protocol data getAvatar(address): Promise; ``` -Defined in: [packages/sdk/src/types.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/types.ts#L14) +Defined in: [packages/sdk/src/types.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/types.ts#L14) #### Parameters @@ -39,7 +39,7 @@ Defined in: [packages/sdk/src/types.ts:14](https://github.com/aboutcircles/sdk-v getTrustRelations(address): Promise; ``` -Defined in: [packages/sdk/src/types.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/types.ts#L15) +Defined in: [packages/sdk/src/types.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/types.ts#L15) #### Parameters @@ -59,7 +59,7 @@ Defined in: [packages/sdk/src/types.ts:15](https://github.com/aboutcircles/sdk-v getBalances(address): Promise; ``` -Defined in: [packages/sdk/src/types.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/types.ts#L16) +Defined in: [packages/sdk/src/types.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/types.ts#L16) #### Parameters diff --git a/docs/sdk/src/type-aliases/Avatar.md b/docs/sdk/src/type-aliases/Avatar.md index e2353ac..2285177 100644 --- a/docs/sdk/src/type-aliases/Avatar.md +++ b/docs/sdk/src/type-aliases/Avatar.md @@ -13,4 +13,4 @@ type Avatar = | OrganisationAvatar; ``` -Defined in: [packages/sdk/src/index.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/index.ts#L11) +Defined in: [packages/sdk/src/index.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/index.ts#L11) diff --git a/docs/sdk/src/type-aliases/PathfindingOptions.md b/docs/sdk/src/type-aliases/PathfindingOptions.md index ef1dff1..87d3318 100644 --- a/docs/sdk/src/type-aliases/PathfindingOptions.md +++ b/docs/sdk/src/type-aliases/PathfindingOptions.md @@ -10,6 +10,6 @@ type PathfindingOptions = Omit; ``` -Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/avatars/CommonAvatar.ts#L28) +Defined in: [packages/sdk/src/avatars/CommonAvatar.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/avatars/CommonAvatar.ts#L28) Advanced pathfinding options (reuses FindPathParams optional fields) diff --git a/docs/sdk/src/type-aliases/SdkErrorSource.md b/docs/sdk/src/type-aliases/SdkErrorSource.md index 14f9a4f..3ea407a 100644 --- a/docs/sdk/src/type-aliases/SdkErrorSource.md +++ b/docs/sdk/src/type-aliases/SdkErrorSource.md @@ -10,6 +10,6 @@ type SdkErrorSource = "SDK" | "SDK_INITIALIZATION" | "SDK_CONFIG" | "SDK_OPERATION"; ``` -Defined in: [packages/sdk/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/sdk/src/errors.ts#L10) +Defined in: [packages/sdk/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/sdk/src/errors.ts#L10) SDK-specific error sources diff --git a/docs/transfers/src/classes/TransferBuilder.md b/docs/transfers/src/classes/TransferBuilder.md index 7473a0d..a62035c 100644 --- a/docs/transfers/src/classes/TransferBuilder.md +++ b/docs/transfers/src/classes/TransferBuilder.md @@ -6,7 +6,7 @@ # Class: TransferBuilder -Defined in: [packages/transfers/src/TransferBuilder.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/TransferBuilder.ts#L18) +Defined in: [packages/transfers/src/TransferBuilder.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/TransferBuilder.ts#L18) TransferBuilder constructs transfer transactions without executing them Handles pathfinding, wrapped token unwrapping/wrapping, and flow matrix construction @@ -19,7 +19,7 @@ Handles pathfinding, wrapped token unwrapping/wrapping, and flow matrix construc new TransferBuilder(core): TransferBuilder; ``` -Defined in: [packages/transfers/src/TransferBuilder.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/TransferBuilder.ts#L22) +Defined in: [packages/transfers/src/TransferBuilder.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/TransferBuilder.ts#L22) #### Parameters @@ -43,7 +43,7 @@ constructAdvancedTransfer( options?): Promise; ``` -Defined in: [packages/transfers/src/TransferBuilder.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/TransferBuilder.ts#L37) +Defined in: [packages/transfers/src/TransferBuilder.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/TransferBuilder.ts#L37) Construct an advanced transfer transaction Returns the list of transactions to execute without executing them @@ -88,7 +88,7 @@ Array of transactions to execute in order constructReplenish(avatarAddress, options?): Promise; ``` -Defined in: [packages/transfers/src/TransferBuilder.ts:227](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/TransferBuilder.ts#L227) +Defined in: [packages/transfers/src/TransferBuilder.ts:227](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/TransferBuilder.ts#L227) Construct a replenish transaction to convert wrapped/other tokens into unwrapped personal CRC This uses pathfinder to find the best way to convert available tokens (including wrapped tokens) diff --git a/docs/transfers/src/classes/TransferError.md b/docs/transfers/src/classes/TransferError.md index f5e770b..9b1a9f8 100644 --- a/docs/transfers/src/classes/TransferError.md +++ b/docs/transfers/src/classes/TransferError.md @@ -6,7 +6,7 @@ # Class: TransferError -Defined in: [packages/transfers/src/errors.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L12) +Defined in: [packages/transfers/src/errors.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L12) Base error for transfers package @@ -22,7 +22,7 @@ Base error for transfers package new TransferError(message, options?): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L13) +Defined in: [packages/transfers/src/errors.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L13) #### Parameters @@ -69,7 +69,7 @@ static noPathFound( reason?): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L28) +Defined in: [packages/transfers/src/errors.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L28) Error when no valid transfer path is found @@ -103,7 +103,7 @@ static insufficientBalance( to): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L42) +Defined in: [packages/transfers/src/errors.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L42) Error when balance is insufficient for the requested transfer @@ -137,7 +137,7 @@ Error when balance is insufficient for the requested transfer static wrappedTokensRequired(): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:66](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L66) +Defined in: [packages/transfers/src/errors.ts:66](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L66) Error when wrapped tokens are needed but not enabled @@ -153,7 +153,7 @@ Error when wrapped tokens are needed but not enabled static unregisteredAvatars(addresses): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L79) +Defined in: [packages/transfers/src/errors.ts:79](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L79) Error when flow matrix contains unregistered avatars @@ -175,7 +175,7 @@ Error when flow matrix contains unregistered avatars static flowMatrixMismatch(terminalSum, expected): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:96](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L96) +Defined in: [packages/transfers/src/errors.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L96) Error when flow matrix terminal sum doesn't match expected amount @@ -201,7 +201,7 @@ Error when flow matrix terminal sum doesn't match expected amount static emptyPath(from, to): TransferError; ``` -Defined in: [packages/transfers/src/errors.ts:113](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L113) +Defined in: [packages/transfers/src/errors.ts:113](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L113) Error when transfer path is empty diff --git a/docs/transfers/src/type-aliases/TransfersErrorSource.md b/docs/transfers/src/type-aliases/TransfersErrorSource.md index e28707c..7ef93db 100644 --- a/docs/transfers/src/type-aliases/TransfersErrorSource.md +++ b/docs/transfers/src/type-aliases/TransfersErrorSource.md @@ -10,6 +10,6 @@ type TransfersErrorSource = "TRANSFERS" | "PATHFINDING" | "FLOW_MATRIX" | "VALIDATION"; ``` -Defined in: [packages/transfers/src/errors.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/transfers/src/errors.ts#L7) +Defined in: [packages/transfers/src/errors.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/transfers/src/errors.ts#L7) Transfers package error source diff --git a/docs/types/src/README.md b/docs/types/src/README.md index 7788f8c..f4ce91c 100644 --- a/docs/types/src/README.md +++ b/docs/types/src/README.md @@ -27,6 +27,7 @@ - [GroupQueryParams](interfaces/GroupQueryParams.md) - [NetworkSnapshot](interfaces/NetworkSnapshot.md) - [SimulatedBalance](interfaces/SimulatedBalance.md) +- [SimulatedTrust](interfaces/SimulatedTrust.md) - [FindPathParams](interfaces/FindPathParams.md) - [TransferStep](interfaces/TransferStep.md) - [PathfindingResult](interfaces/PathfindingResult.md) diff --git a/docs/types/src/enumerations/CirclesType.md b/docs/types/src/enumerations/CirclesType.md index e7acf64..05dff40 100644 --- a/docs/types/src/enumerations/CirclesType.md +++ b/docs/types/src/enumerations/CirclesType.md @@ -6,7 +6,7 @@ # Enumeration: CirclesType -Defined in: [packages/types/src/wrapper.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L9) +Defined in: [packages/types/src/wrapper.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L9) CirclesType enum Represents the type of Circles ERC20 wrapper @@ -19,7 +19,7 @@ Represents the type of Circles ERC20 wrapper Demurrage: 0; ``` -Defined in: [packages/types/src/wrapper.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L10) +Defined in: [packages/types/src/wrapper.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L10) *** @@ -29,4 +29,4 @@ Defined in: [packages/types/src/wrapper.ts:10](https://github.com/aboutcircles/s Inflation: 1; ``` -Defined in: [packages/types/src/wrapper.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L11) +Defined in: [packages/types/src/wrapper.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L11) diff --git a/docs/types/src/enumerations/GroupType.md b/docs/types/src/enumerations/GroupType.md index 1254ea1..b5dc573 100644 --- a/docs/types/src/enumerations/GroupType.md +++ b/docs/types/src/enumerations/GroupType.md @@ -6,7 +6,7 @@ # Enumeration: GroupType -Defined in: [packages/types/src/sdk.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L48) +Defined in: [packages/types/src/sdk.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L48) Group type enumeration @@ -18,7 +18,7 @@ Group type enumeration Standard: "Standard"; ``` -Defined in: [packages/types/src/sdk.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L49) +Defined in: [packages/types/src/sdk.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L49) *** @@ -28,4 +28,4 @@ Defined in: [packages/types/src/sdk.ts:49](https://github.com/aboutcircles/sdk-v Custom: "Custom"; ``` -Defined in: [packages/types/src/sdk.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L50) +Defined in: [packages/types/src/sdk.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L50) diff --git a/docs/types/src/interfaces/AdvancedTransferOptions.md b/docs/types/src/interfaces/AdvancedTransferOptions.md index 2772100..5e83ccc 100644 --- a/docs/types/src/interfaces/AdvancedTransferOptions.md +++ b/docs/types/src/interfaces/AdvancedTransferOptions.md @@ -6,7 +6,7 @@ # Interface: AdvancedTransferOptions -Defined in: [packages/types/src/pathfinding.ts:87](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L87) +Defined in: [packages/types/src/pathfinding.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L96) Advanced transfer options Extends FindPathParams to add transfer-specific options @@ -23,7 +23,7 @@ Extends FindPathParams to add transfer-specific options optional useWrappedBalances: boolean; ``` -Defined in: [packages/types/src/pathfinding.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L25) +Defined in: [packages/types/src/pathfinding.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L33) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [packages/types/src/pathfinding.ts:25](https://github.com/aboutcircl optional fromTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L26) +Defined in: [packages/types/src/pathfinding.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L34) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [packages/types/src/pathfinding.ts:26](https://github.com/aboutcircl optional toTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L27) +Defined in: [packages/types/src/pathfinding.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L35) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [packages/types/src/pathfinding.ts:27](https://github.com/aboutcircl optional excludeFromTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L28) +Defined in: [packages/types/src/pathfinding.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L36) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [packages/types/src/pathfinding.ts:28](https://github.com/aboutcircl optional excludeToTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L29) +Defined in: [packages/types/src/pathfinding.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L37) #### Inherited from @@ -93,7 +93,7 @@ Defined in: [packages/types/src/pathfinding.ts:29](https://github.com/aboutcircl optional simulatedBalances: SimulatedBalance[]; ``` -Defined in: [packages/types/src/pathfinding.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L30) +Defined in: [packages/types/src/pathfinding.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L38) #### Inherited from @@ -101,13 +101,27 @@ Defined in: [packages/types/src/pathfinding.ts:30](https://github.com/aboutcircl *** +### simulatedTrusts? + +```ts +optional simulatedTrusts: SimulatedTrust[]; +``` + +Defined in: [packages/types/src/pathfinding.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L39) + +#### Inherited from + +[`FindPathParams`](FindPathParams.md).[`simulatedTrusts`](FindPathParams.md#simulatedtrusts) + +*** + ### maxTransfers? ```ts optional maxTransfers: number; ``` -Defined in: [packages/types/src/pathfinding.ts:31](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L31) +Defined in: [packages/types/src/pathfinding.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L40) #### Inherited from @@ -121,6 +135,6 @@ Defined in: [packages/types/src/pathfinding.ts:31](https://github.com/aboutcircl optional txData: Uint8Array; ``` -Defined in: [packages/types/src/pathfinding.ts:91](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L91) +Defined in: [packages/types/src/pathfinding.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L100) Custom data to attach to the transfer (optional) diff --git a/docs/types/src/interfaces/AggregatedTrustRelation.md b/docs/types/src/interfaces/AggregatedTrustRelation.md index cd647c4..be617e9 100644 --- a/docs/types/src/interfaces/AggregatedTrustRelation.md +++ b/docs/types/src/interfaces/AggregatedTrustRelation.md @@ -6,7 +6,7 @@ # Interface: AggregatedTrustRelation -Defined in: [packages/types/src/trust.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L23) +Defined in: [packages/types/src/trust.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L23) ## Properties @@ -16,7 +16,7 @@ Defined in: [packages/types/src/trust.ts:23](https://github.com/aboutcircles/sdk subjectAvatar: `0x${string}`; ``` -Defined in: [packages/types/src/trust.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L24) +Defined in: [packages/types/src/trust.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L24) *** @@ -26,7 +26,7 @@ Defined in: [packages/types/src/trust.ts:24](https://github.com/aboutcircles/sdk relation: TrustRelationType; ``` -Defined in: [packages/types/src/trust.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L25) +Defined in: [packages/types/src/trust.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L25) *** @@ -36,7 +36,7 @@ Defined in: [packages/types/src/trust.ts:25](https://github.com/aboutcircles/sdk objectAvatar: `0x${string}`; ``` -Defined in: [packages/types/src/trust.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L26) +Defined in: [packages/types/src/trust.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L26) *** @@ -46,4 +46,4 @@ Defined in: [packages/types/src/trust.ts:26](https://github.com/aboutcircles/sdk timestamp: number; ``` -Defined in: [packages/types/src/trust.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L27) +Defined in: [packages/types/src/trust.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L27) diff --git a/docs/types/src/interfaces/AvatarInfo.md b/docs/types/src/interfaces/AvatarInfo.md index 7549ffd..0614a4d 100644 --- a/docs/types/src/interfaces/AvatarInfo.md +++ b/docs/types/src/interfaces/AvatarInfo.md @@ -6,7 +6,7 @@ # Interface: AvatarInfo -Defined in: [packages/types/src/avatar.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L11) +Defined in: [packages/types/src/avatar.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L11) Avatar information Contains basic information about a Circles avatar. @@ -19,7 +19,7 @@ Contains basic information about a Circles avatar. blockNumber: number; ``` -Defined in: [packages/types/src/avatar.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L15) +Defined in: [packages/types/src/avatar.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L15) The block number of the event @@ -31,7 +31,7 @@ The block number of the event optional timestamp: number; ``` -Defined in: [packages/types/src/avatar.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L20) +Defined in: [packages/types/src/avatar.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L20) The timestamp of the last change to the avatar Note: May be undefined for some avatars @@ -44,7 +44,7 @@ Note: May be undefined for some avatars transactionIndex: number; ``` -Defined in: [packages/types/src/avatar.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L24) +Defined in: [packages/types/src/avatar.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L24) The transaction index @@ -56,7 +56,7 @@ The transaction index logIndex: number; ``` -Defined in: [packages/types/src/avatar.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L28) +Defined in: [packages/types/src/avatar.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L28) The log index @@ -68,7 +68,7 @@ The log index transactionHash: string; ``` -Defined in: [packages/types/src/avatar.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L32) +Defined in: [packages/types/src/avatar.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L32) The hash of the transaction that last changed the avatar @@ -80,7 +80,7 @@ The hash of the transaction that last changed the avatar version: number; ``` -Defined in: [packages/types/src/avatar.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L37) +Defined in: [packages/types/src/avatar.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L37) If the avatar is currently active in version 1 or 2 Note: An avatar that's active in v2 can still have a v1 token. See `hasV1` and `v1Token`. @@ -98,7 +98,7 @@ type: | "CrcV1_OrganizationSignup"; ``` -Defined in: [packages/types/src/avatar.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L41) +Defined in: [packages/types/src/avatar.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L41) The type of the avatar @@ -110,7 +110,7 @@ The type of the avatar avatar: `0x${string}`; ``` -Defined in: [packages/types/src/avatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L50) +Defined in: [packages/types/src/avatar.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L50) The address of the avatar @@ -122,7 +122,7 @@ The address of the avatar optional tokenId: string; ``` -Defined in: [packages/types/src/avatar.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L56) +Defined in: [packages/types/src/avatar.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L56) The personal or group token address (v1) or tokenId (v2) Note: v1 tokens are erc20 and have a token address. v2 tokens are erc1155 and have a tokenId. @@ -136,7 +136,7 @@ Note: v1 tokens are erc20 and have a token address. v2 tokens are erc1155 and ha hasV1: boolean; ``` -Defined in: [packages/types/src/avatar.ts:60](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L60) +Defined in: [packages/types/src/avatar.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L60) If the avatar is signed up at v1 @@ -148,7 +148,7 @@ If the avatar is signed up at v1 optional v1Token: `0x${string}`; ``` -Defined in: [packages/types/src/avatar.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L64) +Defined in: [packages/types/src/avatar.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L64) If the avatar has a v1 token, this is the token address @@ -160,7 +160,7 @@ If the avatar has a v1 token, this is the token address optional cidV0Digest: string; ``` -Defined in: [packages/types/src/avatar.ts:68](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L68) +Defined in: [packages/types/src/avatar.ts:68](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L68) The bytes of the avatar's metadata cidv0 @@ -172,7 +172,7 @@ The bytes of the avatar's metadata cidv0 optional cidV0: string; ``` -Defined in: [packages/types/src/avatar.ts:72](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L72) +Defined in: [packages/types/src/avatar.ts:72](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L72) The CIDv0 of the avatar's metadata (profile) @@ -184,7 +184,7 @@ The CIDv0 of the avatar's metadata (profile) optional v1Stopped: boolean; ``` -Defined in: [packages/types/src/avatar.ts:77](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L77) +Defined in: [packages/types/src/avatar.ts:77](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L77) If the avatar is stopped in v1 Note: This is only set during Avatar initialization. @@ -197,7 +197,7 @@ Note: This is only set during Avatar initialization. isHuman: boolean; ``` -Defined in: [packages/types/src/avatar.ts:81](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L81) +Defined in: [packages/types/src/avatar.ts:81](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L81) Indicates whether the entity is a human @@ -209,7 +209,7 @@ Indicates whether the entity is a human optional name: string; ``` -Defined in: [packages/types/src/avatar.ts:85](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L85) +Defined in: [packages/types/src/avatar.ts:85](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L85) Groups have a name @@ -221,6 +221,6 @@ Groups have a name optional symbol: string; ``` -Defined in: [packages/types/src/avatar.ts:89](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L89) +Defined in: [packages/types/src/avatar.ts:89](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L89) Groups have a symbol diff --git a/docs/types/src/interfaces/AvatarRow.md b/docs/types/src/interfaces/AvatarRow.md index 5698648..f14e250 100644 --- a/docs/types/src/interfaces/AvatarRow.md +++ b/docs/types/src/interfaces/AvatarRow.md @@ -6,7 +6,7 @@ # Interface: AvatarRow -Defined in: [packages/types/src/sdk.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L10) +Defined in: [packages/types/src/sdk.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L10) Avatar row data from RPC @@ -18,7 +18,7 @@ Avatar row data from RPC address: `0x${string}`; ``` -Defined in: [packages/types/src/sdk.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L11) +Defined in: [packages/types/src/sdk.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L11) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/sdk.ts:11](https://github.com/aboutcircles/sdk-v version: number; ``` -Defined in: [packages/types/src/sdk.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L12) +Defined in: [packages/types/src/sdk.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L12) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/sdk.ts:12](https://github.com/aboutcircles/sdk-v type: string; ``` -Defined in: [packages/types/src/sdk.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L13) +Defined in: [packages/types/src/sdk.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L13) *** @@ -48,4 +48,4 @@ Defined in: [packages/types/src/sdk.ts:13](https://github.com/aboutcircles/sdk-v optional cidV0: string; ``` -Defined in: [packages/types/src/sdk.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L14) +Defined in: [packages/types/src/sdk.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L14) diff --git a/docs/types/src/interfaces/BatchRun.md b/docs/types/src/interfaces/BatchRun.md index ee9bfd8..25b4b46 100644 --- a/docs/types/src/interfaces/BatchRun.md +++ b/docs/types/src/interfaces/BatchRun.md @@ -6,7 +6,7 @@ # Interface: BatchRun -Defined in: [packages/types/src/runner.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L12) +Defined in: [packages/types/src/runner.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L12) Batch transaction runner interface Allows multiple transactions to be batched and executed atomically @@ -19,7 +19,7 @@ Allows multiple transactions to be batched and executed atomically addTransaction(tx): void; ``` -Defined in: [packages/types/src/runner.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L16) +Defined in: [packages/types/src/runner.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L16) Add a transaction to the batch @@ -41,7 +41,7 @@ Add a transaction to the batch run(): Promise; ``` -Defined in: [packages/types/src/runner.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L22) +Defined in: [packages/types/src/runner.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L22) Execute all batched transactions diff --git a/docs/types/src/interfaces/CallResult.md b/docs/types/src/interfaces/CallResult.md index 6ca3144..4259c6a 100644 --- a/docs/types/src/interfaces/CallResult.md +++ b/docs/types/src/interfaces/CallResult.md @@ -6,7 +6,7 @@ # Interface: CallResult\ -Defined in: [packages/types/src/base.ts:47](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L47) +Defined in: [packages/types/src/base.ts:47](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L47) Call result @@ -24,7 +24,7 @@ Call result success: boolean; ``` -Defined in: [packages/types/src/base.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L48) +Defined in: [packages/types/src/base.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L48) *** @@ -34,7 +34,7 @@ Defined in: [packages/types/src/base.ts:48](https://github.com/aboutcircles/sdk- optional data: T; ``` -Defined in: [packages/types/src/base.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L49) +Defined in: [packages/types/src/base.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L49) *** @@ -44,4 +44,4 @@ Defined in: [packages/types/src/base.ts:49](https://github.com/aboutcircles/sdk- optional error: Error; ``` -Defined in: [packages/types/src/base.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L50) +Defined in: [packages/types/src/base.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L50) diff --git a/docs/types/src/interfaces/CirclesConfig.md b/docs/types/src/interfaces/CirclesConfig.md index 0b3f6df..71c7595 100644 --- a/docs/types/src/interfaces/CirclesConfig.md +++ b/docs/types/src/interfaces/CirclesConfig.md @@ -6,7 +6,7 @@ # Interface: CirclesConfig -Defined in: [packages/types/src/config.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L10) +Defined in: [packages/types/src/config.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L10) Circles protocol configuration for a specific chain @@ -18,7 +18,7 @@ Circles protocol configuration for a specific chain circlesRpcUrl: string; ``` -Defined in: [packages/types/src/config.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L12) +Defined in: [packages/types/src/config.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L12) RPC URL for Circles-specific endpoints @@ -30,7 +30,7 @@ RPC URL for Circles-specific endpoints pathfinderUrl: string; ``` -Defined in: [packages/types/src/config.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L14) +Defined in: [packages/types/src/config.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L14) Pathfinder service URL for computing transfer paths @@ -42,19 +42,31 @@ Pathfinder service URL for computing transfer paths profileServiceUrl: string; ``` -Defined in: [packages/types/src/config.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L16) +Defined in: [packages/types/src/config.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L16) Profile service URL for user profiles and metadata *** +### referralsServiceUrl? + +```ts +optional referralsServiceUrl: string; +``` + +Defined in: [packages/types/src/config.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L18) + +Referrals service URL for referral/invitation links (optional) + +*** + ### v1HubAddress ```ts v1HubAddress: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L18) +Defined in: [packages/types/src/config.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L20) Circles V1 Hub contract address @@ -66,7 +78,7 @@ Circles V1 Hub contract address v2HubAddress: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L20) +Defined in: [packages/types/src/config.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L22) Circles V2 Hub contract address @@ -78,7 +90,7 @@ Circles V2 Hub contract address nameRegistryAddress: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L22) +Defined in: [packages/types/src/config.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L24) Name Registry contract address @@ -90,7 +102,7 @@ Name Registry contract address baseGroupMintPolicy: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L24) +Defined in: [packages/types/src/config.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L26) Base Group Mint Policy contract address @@ -102,7 +114,7 @@ Base Group Mint Policy contract address standardTreasury: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L26) +Defined in: [packages/types/src/config.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L28) Standard Treasury contract address @@ -114,7 +126,7 @@ Standard Treasury contract address coreMembersGroupDeployer: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L28) +Defined in: [packages/types/src/config.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L30) Core Members Group Deployer contract address @@ -126,7 +138,7 @@ Core Members Group Deployer contract address baseGroupFactoryAddress: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L30) +Defined in: [packages/types/src/config.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L32) Base Group Factory contract address @@ -138,7 +150,7 @@ Base Group Factory contract address liftERC20Address: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L32) +Defined in: [packages/types/src/config.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L34) Lift ERC20 contract address @@ -150,6 +162,30 @@ Lift ERC20 contract address invitationEscrowAddress: `0x${string}`; ``` -Defined in: [packages/types/src/config.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/config.ts#L34) +Defined in: [packages/types/src/config.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L36) Invitation Escrow contract address + +*** + +### invitationFarmAddress + +```ts +invitationFarmAddress: `0x${string}`; +``` + +Defined in: [packages/types/src/config.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L38) + +Invitation Farm contract address + +*** + +### referralsModuleAddress + +```ts +referralsModuleAddress: `0x${string}`; +``` + +Defined in: [packages/types/src/config.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/config.ts#L40) + +Referrals Module contract address diff --git a/docs/types/src/interfaces/CirclesQuery.md b/docs/types/src/interfaces/CirclesQuery.md index ccd6aad..5b060d8 100644 --- a/docs/types/src/interfaces/CirclesQuery.md +++ b/docs/types/src/interfaces/CirclesQuery.md @@ -6,7 +6,7 @@ # Interface: CirclesQuery\ -Defined in: [packages/types/src/sdk.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L39) +Defined in: [packages/types/src/sdk.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L39) Circles query result with pagination @@ -24,7 +24,7 @@ Circles query result with pagination rows: T[]; ``` -Defined in: [packages/types/src/sdk.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L40) +Defined in: [packages/types/src/sdk.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L40) *** @@ -34,7 +34,7 @@ Defined in: [packages/types/src/sdk.ts:40](https://github.com/aboutcircles/sdk-v hasMore: boolean; ``` -Defined in: [packages/types/src/sdk.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L41) +Defined in: [packages/types/src/sdk.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L41) ## Methods @@ -44,7 +44,7 @@ Defined in: [packages/types/src/sdk.ts:41](https://github.com/aboutcircles/sdk-v nextPage(): Promise>; ``` -Defined in: [packages/types/src/sdk.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L42) +Defined in: [packages/types/src/sdk.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L42) #### Returns diff --git a/docs/types/src/interfaces/CirclesQueryResponse.md b/docs/types/src/interfaces/CirclesQueryResponse.md index 91c8e84..feb42e1 100644 --- a/docs/types/src/interfaces/CirclesQueryResponse.md +++ b/docs/types/src/interfaces/CirclesQueryResponse.md @@ -6,7 +6,7 @@ # Interface: CirclesQueryResponse -Defined in: [packages/types/src/rpc.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L33) +Defined in: [packages/types/src/rpc.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L33) Circles query response format Used for circles_query RPC method results @@ -19,7 +19,7 @@ Used for circles_query RPC method results columns: string[]; ``` -Defined in: [packages/types/src/rpc.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L34) +Defined in: [packages/types/src/rpc.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L34) *** @@ -29,4 +29,4 @@ Defined in: [packages/types/src/rpc.ts:34](https://github.com/aboutcircles/sdk-v rows: any[][]; ``` -Defined in: [packages/types/src/rpc.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L35) +Defined in: [packages/types/src/rpc.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L35) diff --git a/docs/types/src/interfaces/Conjunction.md b/docs/types/src/interfaces/Conjunction.md index 1498888..ff4b8a7 100644 --- a/docs/types/src/interfaces/Conjunction.md +++ b/docs/types/src/interfaces/Conjunction.md @@ -6,7 +6,7 @@ # Interface: Conjunction -Defined in: [packages/types/src/query.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L35) +Defined in: [packages/types/src/query.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L35) Conjunction for combining multiple predicates @@ -18,7 +18,7 @@ Conjunction for combining multiple predicates Type: "Conjunction"; ``` -Defined in: [packages/types/src/query.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L36) +Defined in: [packages/types/src/query.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L36) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/query.ts:36](https://github.com/aboutcircles/sdk ConjunctionType: ConjunctionType; ``` -Defined in: [packages/types/src/query.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L37) +Defined in: [packages/types/src/query.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L37) *** @@ -38,4 +38,4 @@ Defined in: [packages/types/src/query.ts:37](https://github.com/aboutcircles/sdk Predicates: (FilterPredicate | Conjunction)[]; ``` -Defined in: [packages/types/src/query.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L38) +Defined in: [packages/types/src/query.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L38) diff --git a/docs/types/src/interfaces/ContractConfig.md b/docs/types/src/interfaces/ContractConfig.md index a418b93..7fbb33b 100644 --- a/docs/types/src/interfaces/ContractConfig.md +++ b/docs/types/src/interfaces/ContractConfig.md @@ -6,7 +6,7 @@ # Interface: ContractConfig\ -Defined in: [packages/types/src/base.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L25) +Defined in: [packages/types/src/base.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L25) Generic contract configuration @@ -24,7 +24,7 @@ Generic contract configuration address: `0x${string}`; ``` -Defined in: [packages/types/src/base.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L26) +Defined in: [packages/types/src/base.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L26) *** @@ -34,4 +34,4 @@ Defined in: [packages/types/src/base.ts:26](https://github.com/aboutcircles/sdk- abi: TAbi; ``` -Defined in: [packages/types/src/base.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L27) +Defined in: [packages/types/src/base.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L27) diff --git a/docs/types/src/interfaces/ContractRunner.md b/docs/types/src/interfaces/ContractRunner.md index 40a9d64..472d5a9 100644 --- a/docs/types/src/interfaces/ContractRunner.md +++ b/docs/types/src/interfaces/ContractRunner.md @@ -6,7 +6,7 @@ # Interface: ContractRunner -Defined in: [packages/types/src/runner.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L29) +Defined in: [packages/types/src/runner.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L29) Contract runner interface for executing blockchain operations This is the base interface that all contract runners must implement @@ -19,7 +19,7 @@ This is the base interface that all contract runners must implement optional address: `0x${string}`; ``` -Defined in: [packages/types/src/runner.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L33) +Defined in: [packages/types/src/runner.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L33) The address of the account (if available) @@ -31,7 +31,7 @@ The address of the account (if available) publicClient: any; ``` -Defined in: [packages/types/src/runner.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L38) +Defined in: [packages/types/src/runner.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L38) The public client for reading blockchain state @@ -43,7 +43,7 @@ The public client for reading blockchain state init(): Promise; ``` -Defined in: [packages/types/src/runner.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L43) +Defined in: [packages/types/src/runner.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L43) Initialize the runner @@ -59,7 +59,7 @@ Initialize the runner optional estimateGas(tx): Promise; ``` -Defined in: [packages/types/src/runner.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L48) +Defined in: [packages/types/src/runner.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L48) Estimate gas for a transaction @@ -81,7 +81,7 @@ Estimate gas for a transaction optional call(tx): Promise; ``` -Defined in: [packages/types/src/runner.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L53) +Defined in: [packages/types/src/runner.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L53) Call a contract (read-only) @@ -103,7 +103,7 @@ Call a contract (read-only) optional resolveName(name): Promise; ``` -Defined in: [packages/types/src/runner.ts:58](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L58) +Defined in: [packages/types/src/runner.ts:58](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L58) Resolve an ENS name to an address @@ -125,7 +125,7 @@ Resolve an ENS name to an address optional sendTransaction(txs): Promise; ``` -Defined in: [packages/types/src/runner.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L64) +Defined in: [packages/types/src/runner.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L64) Send one or more transactions - Safe: batches all transactions atomically and returns single TransactionReceipt @@ -148,7 +148,7 @@ Send one or more transactions optional sendBatchTransaction(): BatchRun; ``` -Defined in: [packages/types/src/runner.ts:75](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/runner.ts#L75) +Defined in: [packages/types/src/runner.ts:75](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/runner.ts#L75) Create a batch transaction runner (if supported) This allows multiple transactions to be executed atomically in a single on-chain transaction diff --git a/docs/types/src/interfaces/Cursor.md b/docs/types/src/interfaces/Cursor.md index 809438c..ae8d5c7 100644 --- a/docs/types/src/interfaces/Cursor.md +++ b/docs/types/src/interfaces/Cursor.md @@ -6,7 +6,7 @@ # Interface: Cursor -Defined in: [packages/types/src/query.ts:103](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L103) +Defined in: [packages/types/src/query.ts:103](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L103) A cursor is a sortable unique identifier for a specific log entry. Used to paginate through query results efficiently. @@ -23,7 +23,7 @@ Used to paginate through query results efficiently. blockNumber: number; ``` -Defined in: [packages/types/src/query.ts:92](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L92) +Defined in: [packages/types/src/query.ts:92](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L92) #### Inherited from @@ -37,7 +37,7 @@ Defined in: [packages/types/src/query.ts:92](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/query.ts:93](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L93) +Defined in: [packages/types/src/query.ts:93](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L93) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [packages/types/src/query.ts:93](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/query.ts:94](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L94) +Defined in: [packages/types/src/query.ts:94](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L94) #### Inherited from @@ -65,7 +65,7 @@ Defined in: [packages/types/src/query.ts:94](https://github.com/aboutcircles/sdk optional batchIndex: number; ``` -Defined in: [packages/types/src/query.ts:95](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L95) +Defined in: [packages/types/src/query.ts:95](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L95) #### Inherited from @@ -79,7 +79,7 @@ Defined in: [packages/types/src/query.ts:95](https://github.com/aboutcircles/sdk optional timestamp: number; ``` -Defined in: [packages/types/src/query.ts:96](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L96) +Defined in: [packages/types/src/query.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L96) #### Inherited from diff --git a/docs/types/src/interfaces/DecodedContractError.md b/docs/types/src/interfaces/DecodedContractError.md index 7815d0a..189f967 100644 --- a/docs/types/src/interfaces/DecodedContractError.md +++ b/docs/types/src/interfaces/DecodedContractError.md @@ -6,7 +6,7 @@ # Interface: DecodedContractError -Defined in: [packages/types/src/errors.ts:5](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/errors.ts#L5) +Defined in: [packages/types/src/errors.ts:5](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/errors.ts#L5) Decoded contract error information Contains parsed error data from failed contract transactions @@ -19,7 +19,7 @@ Contains parsed error data from failed contract transactions errorName: string; ``` -Defined in: [packages/types/src/errors.ts:6](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/errors.ts#L6) +Defined in: [packages/types/src/errors.ts:6](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/errors.ts#L6) *** @@ -29,7 +29,7 @@ Defined in: [packages/types/src/errors.ts:6](https://github.com/aboutcircles/sdk optional args: any[]; ``` -Defined in: [packages/types/src/errors.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/errors.ts#L7) +Defined in: [packages/types/src/errors.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/errors.ts#L7) *** @@ -39,7 +39,7 @@ Defined in: [packages/types/src/errors.ts:7](https://github.com/aboutcircles/sdk selector: string; ``` -Defined in: [packages/types/src/errors.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/errors.ts#L8) +Defined in: [packages/types/src/errors.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/errors.ts#L8) *** @@ -49,7 +49,7 @@ Defined in: [packages/types/src/errors.ts:8](https://github.com/aboutcircles/sdk rawData: string; ``` -Defined in: [packages/types/src/errors.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/errors.ts#L9) +Defined in: [packages/types/src/errors.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/errors.ts#L9) *** @@ -59,4 +59,4 @@ Defined in: [packages/types/src/errors.ts:9](https://github.com/aboutcircles/sdk formattedMessage: string; ``` -Defined in: [packages/types/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/errors.ts#L10) +Defined in: [packages/types/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/errors.ts#L10) diff --git a/docs/types/src/interfaces/EscrowedAmountAndDays.md b/docs/types/src/interfaces/EscrowedAmountAndDays.md index bad68d8..a2eaa0c 100644 --- a/docs/types/src/interfaces/EscrowedAmountAndDays.md +++ b/docs/types/src/interfaces/EscrowedAmountAndDays.md @@ -6,7 +6,7 @@ # Interface: EscrowedAmountAndDays -Defined in: [packages/types/src/contracts.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/contracts.ts#L10) +Defined in: [packages/types/src/contracts.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/contracts.ts#L10) Escrowed Amount and Days Result Returned by InvitationEscrow.getEscrowedAmountAndDays() @@ -19,7 +19,7 @@ Returned by InvitationEscrow.getEscrowedAmountAndDays() escrowedAmount: bigint; ``` -Defined in: [packages/types/src/contracts.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/contracts.ts#L11) +Defined in: [packages/types/src/contracts.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/contracts.ts#L11) *** @@ -29,4 +29,4 @@ Defined in: [packages/types/src/contracts.ts:11](https://github.com/aboutcircles days_: bigint; ``` -Defined in: [packages/types/src/contracts.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/contracts.ts#L12) +Defined in: [packages/types/src/contracts.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/contracts.ts#L12) diff --git a/docs/types/src/interfaces/EventRow.md b/docs/types/src/interfaces/EventRow.md index f158304..8af0e94 100644 --- a/docs/types/src/interfaces/EventRow.md +++ b/docs/types/src/interfaces/EventRow.md @@ -6,7 +6,7 @@ # Interface: EventRow -Defined in: [packages/types/src/query.ts:91](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L91) +Defined in: [packages/types/src/query.ts:91](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L91) Defines the minimum columns any event row must have for cursor-based pagination. These values are important for determining cursor position in result sets. @@ -23,7 +23,7 @@ These values are important for determining cursor position in result sets. blockNumber: number; ``` -Defined in: [packages/types/src/query.ts:92](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L92) +Defined in: [packages/types/src/query.ts:92](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L92) *** @@ -33,7 +33,7 @@ Defined in: [packages/types/src/query.ts:92](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/query.ts:93](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L93) +Defined in: [packages/types/src/query.ts:93](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L93) *** @@ -43,7 +43,7 @@ Defined in: [packages/types/src/query.ts:93](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/query.ts:94](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L94) +Defined in: [packages/types/src/query.ts:94](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L94) *** @@ -53,7 +53,7 @@ Defined in: [packages/types/src/query.ts:94](https://github.com/aboutcircles/sdk optional batchIndex: number; ``` -Defined in: [packages/types/src/query.ts:95](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L95) +Defined in: [packages/types/src/query.ts:95](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L95) *** @@ -63,4 +63,4 @@ Defined in: [packages/types/src/query.ts:95](https://github.com/aboutcircles/sdk optional timestamp: number; ``` -Defined in: [packages/types/src/query.ts:96](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L96) +Defined in: [packages/types/src/query.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L96) diff --git a/docs/types/src/interfaces/FilterPredicate.md b/docs/types/src/interfaces/FilterPredicate.md index 6dbdff5..7c630d5 100644 --- a/docs/types/src/interfaces/FilterPredicate.md +++ b/docs/types/src/interfaces/FilterPredicate.md @@ -6,7 +6,7 @@ # Interface: FilterPredicate -Defined in: [packages/types/src/query.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L25) +Defined in: [packages/types/src/query.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L25) Filter predicate for querying @@ -18,7 +18,7 @@ Filter predicate for querying Type: "FilterPredicate"; ``` -Defined in: [packages/types/src/query.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L26) +Defined in: [packages/types/src/query.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L26) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/query.ts:26](https://github.com/aboutcircles/sdk FilterType: FilterType; ``` -Defined in: [packages/types/src/query.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L27) +Defined in: [packages/types/src/query.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L27) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/query.ts:27](https://github.com/aboutcircles/sdk Column: string; ``` -Defined in: [packages/types/src/query.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L28) +Defined in: [packages/types/src/query.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L28) *** @@ -48,4 +48,4 @@ Defined in: [packages/types/src/query.ts:28](https://github.com/aboutcircles/sdk Value: string | number | boolean; ``` -Defined in: [packages/types/src/query.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L29) +Defined in: [packages/types/src/query.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L29) diff --git a/docs/types/src/interfaces/FindPathParams.md b/docs/types/src/interfaces/FindPathParams.md index d4a503a..46f5a3a 100644 --- a/docs/types/src/interfaces/FindPathParams.md +++ b/docs/types/src/interfaces/FindPathParams.md @@ -6,7 +6,7 @@ # Interface: FindPathParams -Defined in: [packages/types/src/pathfinding.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L21) +Defined in: [packages/types/src/pathfinding.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L29) Path finding parameters for circlesV2_findPath @@ -18,7 +18,7 @@ Path finding parameters for circlesV2_findPath from: `0x${string}`; ``` -Defined in: [packages/types/src/pathfinding.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L22) +Defined in: [packages/types/src/pathfinding.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L30) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/pathfinding.ts:22](https://github.com/aboutcircl to: `0x${string}`; ``` -Defined in: [packages/types/src/pathfinding.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L23) +Defined in: [packages/types/src/pathfinding.ts:31](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L31) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/pathfinding.ts:23](https://github.com/aboutcircl targetFlow: bigint; ``` -Defined in: [packages/types/src/pathfinding.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L24) +Defined in: [packages/types/src/pathfinding.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L32) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/pathfinding.ts:24](https://github.com/aboutcircl optional useWrappedBalances: boolean; ``` -Defined in: [packages/types/src/pathfinding.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L25) +Defined in: [packages/types/src/pathfinding.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L33) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/pathfinding.ts:25](https://github.com/aboutcircl optional fromTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L26) +Defined in: [packages/types/src/pathfinding.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L34) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/pathfinding.ts:26](https://github.com/aboutcircl optional toTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L27) +Defined in: [packages/types/src/pathfinding.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L35) *** @@ -78,7 +78,7 @@ Defined in: [packages/types/src/pathfinding.ts:27](https://github.com/aboutcircl optional excludeFromTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L28) +Defined in: [packages/types/src/pathfinding.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L36) *** @@ -88,7 +88,7 @@ Defined in: [packages/types/src/pathfinding.ts:28](https://github.com/aboutcircl optional excludeToTokens: `0x${string}`[]; ``` -Defined in: [packages/types/src/pathfinding.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L29) +Defined in: [packages/types/src/pathfinding.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L37) *** @@ -98,7 +98,17 @@ Defined in: [packages/types/src/pathfinding.ts:29](https://github.com/aboutcircl optional simulatedBalances: SimulatedBalance[]; ``` -Defined in: [packages/types/src/pathfinding.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L30) +Defined in: [packages/types/src/pathfinding.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L38) + +*** + +### simulatedTrusts? + +```ts +optional simulatedTrusts: SimulatedTrust[]; +``` + +Defined in: [packages/types/src/pathfinding.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L39) *** @@ -108,4 +118,4 @@ Defined in: [packages/types/src/pathfinding.ts:30](https://github.com/aboutcircl optional maxTransfers: number; ``` -Defined in: [packages/types/src/pathfinding.ts:31](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L31) +Defined in: [packages/types/src/pathfinding.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L40) diff --git a/docs/types/src/interfaces/FlowEdgeStruct.md b/docs/types/src/interfaces/FlowEdgeStruct.md index a320904..5ad773f 100644 --- a/docs/types/src/interfaces/FlowEdgeStruct.md +++ b/docs/types/src/interfaces/FlowEdgeStruct.md @@ -6,7 +6,7 @@ # Interface: FlowEdgeStruct -Defined in: [packages/types/src/pathfinding.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L56) +Defined in: [packages/types/src/pathfinding.ts:65](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L65) Flow edge structure for operateFlowMatrix Corresponds to TypeDefinitions.FlowEdge in the Hub V2 contract @@ -19,7 +19,7 @@ Corresponds to TypeDefinitions.FlowEdge in the Hub V2 contract streamSinkId: number; ``` -Defined in: [packages/types/src/pathfinding.ts:57](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L57) +Defined in: [packages/types/src/pathfinding.ts:66](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L66) *** @@ -29,4 +29,4 @@ Defined in: [packages/types/src/pathfinding.ts:57](https://github.com/aboutcircl amount: bigint; ``` -Defined in: [packages/types/src/pathfinding.ts:58](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L58) +Defined in: [packages/types/src/pathfinding.ts:67](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L67) diff --git a/docs/types/src/interfaces/FlowMatrix.md b/docs/types/src/interfaces/FlowMatrix.md index 3cc5d09..0e5a92d 100644 --- a/docs/types/src/interfaces/FlowMatrix.md +++ b/docs/types/src/interfaces/FlowMatrix.md @@ -6,7 +6,7 @@ # Interface: FlowMatrix -Defined in: [packages/types/src/pathfinding.ts:75](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L75) +Defined in: [packages/types/src/pathfinding.ts:84](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L84) Flow matrix for ABI encoding Used with the operateFlowMatrix function in Hub V2 @@ -19,7 +19,7 @@ Used with the operateFlowMatrix function in Hub V2 flowVertices: string[]; ``` -Defined in: [packages/types/src/pathfinding.ts:76](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L76) +Defined in: [packages/types/src/pathfinding.ts:85](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L85) *** @@ -29,7 +29,7 @@ Defined in: [packages/types/src/pathfinding.ts:76](https://github.com/aboutcircl flowEdges: FlowEdgeStruct[]; ``` -Defined in: [packages/types/src/pathfinding.ts:77](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L77) +Defined in: [packages/types/src/pathfinding.ts:86](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L86) *** @@ -39,7 +39,7 @@ Defined in: [packages/types/src/pathfinding.ts:77](https://github.com/aboutcircl streams: StreamStruct[]; ``` -Defined in: [packages/types/src/pathfinding.ts:78](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L78) +Defined in: [packages/types/src/pathfinding.ts:87](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L87) *** @@ -49,7 +49,7 @@ Defined in: [packages/types/src/pathfinding.ts:78](https://github.com/aboutcircl packedCoordinates: string; ``` -Defined in: [packages/types/src/pathfinding.ts:79](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L79) +Defined in: [packages/types/src/pathfinding.ts:88](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L88) *** @@ -59,4 +59,4 @@ Defined in: [packages/types/src/pathfinding.ts:79](https://github.com/aboutcircl sourceCoordinate: number; ``` -Defined in: [packages/types/src/pathfinding.ts:80](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L80) +Defined in: [packages/types/src/pathfinding.ts:89](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L89) diff --git a/docs/types/src/interfaces/GroupMembershipRow.md b/docs/types/src/interfaces/GroupMembershipRow.md index 1583e8f..1596358 100644 --- a/docs/types/src/interfaces/GroupMembershipRow.md +++ b/docs/types/src/interfaces/GroupMembershipRow.md @@ -6,7 +6,7 @@ # Interface: GroupMembershipRow -Defined in: [packages/types/src/group.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L35) +Defined in: [packages/types/src/group.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L35) Group membership row @@ -18,7 +18,7 @@ Group membership row blockNumber: number; ``` -Defined in: [packages/types/src/group.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L36) +Defined in: [packages/types/src/group.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L36) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/group.ts:36](https://github.com/aboutcircles/sdk timestamp: number; ``` -Defined in: [packages/types/src/group.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L37) +Defined in: [packages/types/src/group.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L37) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/group.ts:37](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/group.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L38) +Defined in: [packages/types/src/group.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L38) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/group.ts:38](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/group.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L39) +Defined in: [packages/types/src/group.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L39) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/group.ts:39](https://github.com/aboutcircles/sdk transactionHash: string; ``` -Defined in: [packages/types/src/group.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L40) +Defined in: [packages/types/src/group.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L40) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/group.ts:40](https://github.com/aboutcircles/sdk group: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L41) +Defined in: [packages/types/src/group.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L41) *** @@ -78,7 +78,7 @@ Defined in: [packages/types/src/group.ts:41](https://github.com/aboutcircles/sdk member: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L42) +Defined in: [packages/types/src/group.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L42) *** @@ -88,4 +88,4 @@ Defined in: [packages/types/src/group.ts:42](https://github.com/aboutcircles/sdk expiryTime: number; ``` -Defined in: [packages/types/src/group.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L43) +Defined in: [packages/types/src/group.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L43) diff --git a/docs/types/src/interfaces/GroupProfile.md b/docs/types/src/interfaces/GroupProfile.md index 9616400..d7984cb 100644 --- a/docs/types/src/interfaces/GroupProfile.md +++ b/docs/types/src/interfaces/GroupProfile.md @@ -6,7 +6,7 @@ # Interface: GroupProfile -Defined in: [packages/types/src/avatar.ts:108](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L108) +Defined in: [packages/types/src/avatar.ts:108](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L108) Group profile with additional symbol field @@ -22,7 +22,7 @@ Group profile with additional symbol field name: string; ``` -Defined in: [packages/types/src/avatar.ts:96](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L96) +Defined in: [packages/types/src/avatar.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L96) #### Inherited from @@ -36,7 +36,7 @@ Defined in: [packages/types/src/avatar.ts:96](https://github.com/aboutcircles/sd optional description: string; ``` -Defined in: [packages/types/src/avatar.ts:97](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L97) +Defined in: [packages/types/src/avatar.ts:97](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L97) #### Inherited from @@ -50,7 +50,7 @@ Defined in: [packages/types/src/avatar.ts:97](https://github.com/aboutcircles/sd optional previewImageUrl: string; ``` -Defined in: [packages/types/src/avatar.ts:98](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L98) +Defined in: [packages/types/src/avatar.ts:98](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L98) #### Inherited from @@ -64,7 +64,7 @@ Defined in: [packages/types/src/avatar.ts:98](https://github.com/aboutcircles/sd optional imageUrl: string; ``` -Defined in: [packages/types/src/avatar.ts:99](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L99) +Defined in: [packages/types/src/avatar.ts:99](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L99) #### Inherited from @@ -78,7 +78,7 @@ Defined in: [packages/types/src/avatar.ts:99](https://github.com/aboutcircles/sd optional location: string; ``` -Defined in: [packages/types/src/avatar.ts:100](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L100) +Defined in: [packages/types/src/avatar.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L100) #### Inherited from @@ -92,7 +92,7 @@ Defined in: [packages/types/src/avatar.ts:100](https://github.com/aboutcircles/s optional geoLocation: [number, number]; ``` -Defined in: [packages/types/src/avatar.ts:101](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L101) +Defined in: [packages/types/src/avatar.ts:101](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L101) #### Inherited from @@ -106,7 +106,7 @@ Defined in: [packages/types/src/avatar.ts:101](https://github.com/aboutcircles/s optional extensions: Record; ``` -Defined in: [packages/types/src/avatar.ts:102](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L102) +Defined in: [packages/types/src/avatar.ts:102](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L102) #### Inherited from @@ -120,4 +120,4 @@ Defined in: [packages/types/src/avatar.ts:102](https://github.com/aboutcircles/s symbol: string; ``` -Defined in: [packages/types/src/avatar.ts:109](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L109) +Defined in: [packages/types/src/avatar.ts:109](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L109) diff --git a/docs/types/src/interfaces/GroupQueryParams.md b/docs/types/src/interfaces/GroupQueryParams.md index 320735b..c0b19af 100644 --- a/docs/types/src/interfaces/GroupQueryParams.md +++ b/docs/types/src/interfaces/GroupQueryParams.md @@ -6,7 +6,7 @@ # Interface: GroupQueryParams -Defined in: [packages/types/src/group.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L49) +Defined in: [packages/types/src/group.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L49) Group query parameters @@ -18,7 +18,7 @@ Group query parameters optional nameStartsWith: string; ``` -Defined in: [packages/types/src/group.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L50) +Defined in: [packages/types/src/group.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L50) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/group.ts:50](https://github.com/aboutcircles/sdk optional symbolStartsWith: string; ``` -Defined in: [packages/types/src/group.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L51) +Defined in: [packages/types/src/group.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L51) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/group.ts:51](https://github.com/aboutcircles/sdk optional groupAddressIn: `0x${string}`[]; ``` -Defined in: [packages/types/src/group.ts:52](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L52) +Defined in: [packages/types/src/group.ts:52](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L52) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/group.ts:52](https://github.com/aboutcircles/sdk optional groupTypeIn: string[]; ``` -Defined in: [packages/types/src/group.ts:53](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L53) +Defined in: [packages/types/src/group.ts:53](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L53) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/group.ts:53](https://github.com/aboutcircles/sdk optional ownerIn: `0x${string}`[]; ``` -Defined in: [packages/types/src/group.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L54) +Defined in: [packages/types/src/group.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L54) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/group.ts:54](https://github.com/aboutcircles/sdk optional mintHandlerEquals: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:55](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L55) +Defined in: [packages/types/src/group.ts:55](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L55) *** @@ -78,4 +78,4 @@ Defined in: [packages/types/src/group.ts:55](https://github.com/aboutcircles/sdk optional treasuryEquals: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L56) +Defined in: [packages/types/src/group.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L56) diff --git a/docs/types/src/interfaces/GroupRow.md b/docs/types/src/interfaces/GroupRow.md index beb6fe4..d5a26c8 100644 --- a/docs/types/src/interfaces/GroupRow.md +++ b/docs/types/src/interfaces/GroupRow.md @@ -6,7 +6,7 @@ # Interface: GroupRow -Defined in: [packages/types/src/group.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L10) +Defined in: [packages/types/src/group.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L10) Group row information @@ -18,7 +18,7 @@ Group row information blockNumber: number; ``` -Defined in: [packages/types/src/group.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L11) +Defined in: [packages/types/src/group.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L11) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/group.ts:11](https://github.com/aboutcircles/sdk timestamp: number; ``` -Defined in: [packages/types/src/group.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L12) +Defined in: [packages/types/src/group.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L12) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/group.ts:12](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/group.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L13) +Defined in: [packages/types/src/group.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L13) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/group.ts:13](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/group.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L14) +Defined in: [packages/types/src/group.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L14) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/group.ts:14](https://github.com/aboutcircles/sdk transactionHash: string; ``` -Defined in: [packages/types/src/group.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L15) +Defined in: [packages/types/src/group.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L15) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/group.ts:15](https://github.com/aboutcircles/sdk group: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L16) +Defined in: [packages/types/src/group.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L16) *** @@ -78,7 +78,7 @@ Defined in: [packages/types/src/group.ts:16](https://github.com/aboutcircles/sdk type: string; ``` -Defined in: [packages/types/src/group.ts:17](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L17) +Defined in: [packages/types/src/group.ts:17](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L17) *** @@ -88,7 +88,7 @@ Defined in: [packages/types/src/group.ts:17](https://github.com/aboutcircles/sdk owner: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L18) +Defined in: [packages/types/src/group.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L18) *** @@ -98,7 +98,7 @@ Defined in: [packages/types/src/group.ts:18](https://github.com/aboutcircles/sdk optional mintPolicy: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L19) +Defined in: [packages/types/src/group.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L19) *** @@ -108,7 +108,7 @@ Defined in: [packages/types/src/group.ts:19](https://github.com/aboutcircles/sdk optional mintHandler: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L20) +Defined in: [packages/types/src/group.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L20) *** @@ -118,7 +118,7 @@ Defined in: [packages/types/src/group.ts:20](https://github.com/aboutcircles/sdk optional treasury: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L21) +Defined in: [packages/types/src/group.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L21) *** @@ -128,7 +128,7 @@ Defined in: [packages/types/src/group.ts:21](https://github.com/aboutcircles/sdk optional service: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L22) +Defined in: [packages/types/src/group.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L22) *** @@ -138,7 +138,7 @@ Defined in: [packages/types/src/group.ts:22](https://github.com/aboutcircles/sdk optional feeCollection: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L23) +Defined in: [packages/types/src/group.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L23) *** @@ -148,7 +148,7 @@ Defined in: [packages/types/src/group.ts:23](https://github.com/aboutcircles/sdk optional memberCount: number; ``` -Defined in: [packages/types/src/group.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L24) +Defined in: [packages/types/src/group.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L24) *** @@ -158,7 +158,7 @@ Defined in: [packages/types/src/group.ts:24](https://github.com/aboutcircles/sdk optional name: string; ``` -Defined in: [packages/types/src/group.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L25) +Defined in: [packages/types/src/group.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L25) *** @@ -168,7 +168,7 @@ Defined in: [packages/types/src/group.ts:25](https://github.com/aboutcircles/sdk optional symbol: string; ``` -Defined in: [packages/types/src/group.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L26) +Defined in: [packages/types/src/group.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L26) *** @@ -178,7 +178,7 @@ Defined in: [packages/types/src/group.ts:26](https://github.com/aboutcircles/sdk optional cidV0Digest: string; ``` -Defined in: [packages/types/src/group.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L27) +Defined in: [packages/types/src/group.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L27) *** @@ -188,7 +188,7 @@ Defined in: [packages/types/src/group.ts:27](https://github.com/aboutcircles/sdk optional erc20WrapperDemurraged: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L28) +Defined in: [packages/types/src/group.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L28) *** @@ -198,4 +198,4 @@ Defined in: [packages/types/src/group.ts:28](https://github.com/aboutcircles/sdk optional erc20WrapperStatic: `0x${string}`; ``` -Defined in: [packages/types/src/group.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/group.ts#L29) +Defined in: [packages/types/src/group.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/group.ts#L29) diff --git a/docs/types/src/interfaces/JsonRpcRequest.md b/docs/types/src/interfaces/JsonRpcRequest.md index 4881677..9f1ad1f 100644 --- a/docs/types/src/interfaces/JsonRpcRequest.md +++ b/docs/types/src/interfaces/JsonRpcRequest.md @@ -6,7 +6,7 @@ # Interface: JsonRpcRequest\ -Defined in: [packages/types/src/rpc.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L8) +Defined in: [packages/types/src/rpc.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L8) JSON-RPC request structure @@ -24,7 +24,7 @@ JSON-RPC request structure jsonrpc: "2.0"; ``` -Defined in: [packages/types/src/rpc.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L9) +Defined in: [packages/types/src/rpc.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L9) *** @@ -34,7 +34,7 @@ Defined in: [packages/types/src/rpc.ts:9](https://github.com/aboutcircles/sdk-v2 id: string | number; ``` -Defined in: [packages/types/src/rpc.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L10) +Defined in: [packages/types/src/rpc.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L10) *** @@ -44,7 +44,7 @@ Defined in: [packages/types/src/rpc.ts:10](https://github.com/aboutcircles/sdk-v method: string; ``` -Defined in: [packages/types/src/rpc.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L11) +Defined in: [packages/types/src/rpc.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L11) *** @@ -54,4 +54,4 @@ Defined in: [packages/types/src/rpc.ts:11](https://github.com/aboutcircles/sdk-v params: TParams; ``` -Defined in: [packages/types/src/rpc.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L12) +Defined in: [packages/types/src/rpc.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L12) diff --git a/docs/types/src/interfaces/JsonRpcResponse.md b/docs/types/src/interfaces/JsonRpcResponse.md index 9335474..96c0773 100644 --- a/docs/types/src/interfaces/JsonRpcResponse.md +++ b/docs/types/src/interfaces/JsonRpcResponse.md @@ -6,7 +6,7 @@ # Interface: JsonRpcResponse\ -Defined in: [packages/types/src/rpc.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L18) +Defined in: [packages/types/src/rpc.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L18) JSON-RPC response structure @@ -24,7 +24,7 @@ JSON-RPC response structure jsonrpc: "2.0"; ``` -Defined in: [packages/types/src/rpc.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L19) +Defined in: [packages/types/src/rpc.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L19) *** @@ -34,7 +34,7 @@ Defined in: [packages/types/src/rpc.ts:19](https://github.com/aboutcircles/sdk-v id: string | number; ``` -Defined in: [packages/types/src/rpc.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L20) +Defined in: [packages/types/src/rpc.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L20) *** @@ -44,7 +44,7 @@ Defined in: [packages/types/src/rpc.ts:20](https://github.com/aboutcircles/sdk-v optional result: TResult; ``` -Defined in: [packages/types/src/rpc.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L21) +Defined in: [packages/types/src/rpc.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L21) *** @@ -54,7 +54,7 @@ Defined in: [packages/types/src/rpc.ts:21](https://github.com/aboutcircles/sdk-v optional error: object; ``` -Defined in: [packages/types/src/rpc.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L22) +Defined in: [packages/types/src/rpc.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L22) #### code diff --git a/docs/types/src/interfaces/NetworkSnapshot.md b/docs/types/src/interfaces/NetworkSnapshot.md index 5c7411b..1e62ece 100644 --- a/docs/types/src/interfaces/NetworkSnapshot.md +++ b/docs/types/src/interfaces/NetworkSnapshot.md @@ -6,7 +6,7 @@ # Interface: NetworkSnapshot -Defined in: [packages/types/src/network.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/network.ts#L26) +Defined in: [packages/types/src/network.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/network.ts#L26) Network snapshot structure @@ -18,7 +18,7 @@ Network snapshot structure trustRelations: TrustRelation[]; ``` -Defined in: [packages/types/src/network.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/network.ts#L27) +Defined in: [packages/types/src/network.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/network.ts#L27) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/network.ts:27](https://github.com/aboutcircles/s balances: TokenBalance[]; ``` -Defined in: [packages/types/src/network.ts:28](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/network.ts#L28) +Defined in: [packages/types/src/network.ts:28](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/network.ts#L28) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/network.ts:28](https://github.com/aboutcircles/s blockNumber: number; ``` -Defined in: [packages/types/src/network.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/network.ts#L29) +Defined in: [packages/types/src/network.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/network.ts#L29) *** @@ -48,4 +48,4 @@ Defined in: [packages/types/src/network.ts:29](https://github.com/aboutcircles/s timestamp: number; ``` -Defined in: [packages/types/src/network.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/network.ts#L30) +Defined in: [packages/types/src/network.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/network.ts#L30) diff --git a/docs/types/src/interfaces/OrderBy.md b/docs/types/src/interfaces/OrderBy.md index 4e3c003..86c5070 100644 --- a/docs/types/src/interfaces/OrderBy.md +++ b/docs/types/src/interfaces/OrderBy.md @@ -6,7 +6,7 @@ # Interface: OrderBy -Defined in: [packages/types/src/query.ts:54](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L54) +Defined in: [packages/types/src/query.ts:54](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L54) Order by clause @@ -18,7 +18,7 @@ Order by clause Column: string; ``` -Defined in: [packages/types/src/query.ts:55](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L55) +Defined in: [packages/types/src/query.ts:55](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L55) *** @@ -28,4 +28,4 @@ Defined in: [packages/types/src/query.ts:55](https://github.com/aboutcircles/sdk SortOrder: SortOrder; ``` -Defined in: [packages/types/src/query.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L56) +Defined in: [packages/types/src/query.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L56) diff --git a/docs/types/src/interfaces/PagedQueryParams.md b/docs/types/src/interfaces/PagedQueryParams.md index 38e164b..c7ea154 100644 --- a/docs/types/src/interfaces/PagedQueryParams.md +++ b/docs/types/src/interfaces/PagedQueryParams.md @@ -6,7 +6,7 @@ # Interface: PagedQueryParams -Defined in: [packages/types/src/query.ts:142](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L142) +Defined in: [packages/types/src/query.ts:142](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L142) Parameters for a paginated query @@ -18,7 +18,7 @@ Parameters for a paginated query namespace: string; ``` -Defined in: [packages/types/src/query.ts:146](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L146) +Defined in: [packages/types/src/query.ts:146](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L146) The namespace of the table to query @@ -30,7 +30,7 @@ The namespace of the table to query table: string; ``` -Defined in: [packages/types/src/query.ts:150](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L150) +Defined in: [packages/types/src/query.ts:150](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L150) The name of the table to query @@ -42,7 +42,7 @@ The name of the table to query sortOrder: SortOrder; ``` -Defined in: [packages/types/src/query.ts:154](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L154) +Defined in: [packages/types/src/query.ts:154](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L154) The order to sort the results @@ -54,7 +54,7 @@ The order to sort the results columns: string[]; ``` -Defined in: [packages/types/src/query.ts:158](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L158) +Defined in: [packages/types/src/query.ts:158](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L158) The columns to return in the results @@ -66,7 +66,7 @@ The columns to return in the results optional filter: Filter[]; ``` -Defined in: [packages/types/src/query.ts:162](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L162) +Defined in: [packages/types/src/query.ts:162](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L162) The filters to apply to the query @@ -78,6 +78,6 @@ The filters to apply to the query limit: number; ``` -Defined in: [packages/types/src/query.ts:166](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L166) +Defined in: [packages/types/src/query.ts:166](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L166) The number of results to return per page diff --git a/docs/types/src/interfaces/PagedResult.md b/docs/types/src/interfaces/PagedResult.md index 70e5e92..9ff1423 100644 --- a/docs/types/src/interfaces/PagedResult.md +++ b/docs/types/src/interfaces/PagedResult.md @@ -6,7 +6,7 @@ # Interface: PagedResult\ -Defined in: [packages/types/src/query.ts:108](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L108) +Defined in: [packages/types/src/query.ts:108](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L108) Result of a paginated query @@ -24,7 +24,7 @@ Result of a paginated query limit: number; ``` -Defined in: [packages/types/src/query.ts:112](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L112) +Defined in: [packages/types/src/query.ts:112](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L112) The number of results that were requested @@ -36,7 +36,7 @@ The number of results that were requested size: number; ``` -Defined in: [packages/types/src/query.ts:116](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L116) +Defined in: [packages/types/src/query.ts:116](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L116) The number of results that were returned @@ -48,7 +48,7 @@ The number of results that were returned optional firstCursor: Cursor; ``` -Defined in: [packages/types/src/query.ts:120](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L120) +Defined in: [packages/types/src/query.ts:120](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L120) If the query returned results, this will be the cursor for the first result @@ -60,7 +60,7 @@ If the query returned results, this will be the cursor for the first result optional lastCursor: Cursor; ``` -Defined in: [packages/types/src/query.ts:124](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L124) +Defined in: [packages/types/src/query.ts:124](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L124) If the query returned results, this will be the cursor for the last result @@ -72,7 +72,7 @@ If the query returned results, this will be the cursor for the last result sortOrder: SortOrder; ``` -Defined in: [packages/types/src/query.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L128) +Defined in: [packages/types/src/query.ts:128](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L128) The sort order of the results @@ -84,7 +84,7 @@ The sort order of the results hasMore: boolean; ``` -Defined in: [packages/types/src/query.ts:132](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L132) +Defined in: [packages/types/src/query.ts:132](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L132) Whether there are more results available @@ -96,6 +96,6 @@ Whether there are more results available results: TRow[]; ``` -Defined in: [packages/types/src/query.ts:136](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L136) +Defined in: [packages/types/src/query.ts:136](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L136) The results of the query diff --git a/docs/types/src/interfaces/PathfindingResult.md b/docs/types/src/interfaces/PathfindingResult.md index 80d191a..c7867fb 100644 --- a/docs/types/src/interfaces/PathfindingResult.md +++ b/docs/types/src/interfaces/PathfindingResult.md @@ -6,7 +6,7 @@ # Interface: PathfindingResult -Defined in: [packages/types/src/pathfinding.ts:47](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L47) +Defined in: [packages/types/src/pathfinding.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L56) Result of pathfinding computation @@ -18,7 +18,7 @@ Result of pathfinding computation maxFlow: bigint; ``` -Defined in: [packages/types/src/pathfinding.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L48) +Defined in: [packages/types/src/pathfinding.ts:57](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L57) *** @@ -28,4 +28,4 @@ Defined in: [packages/types/src/pathfinding.ts:48](https://github.com/aboutcircl transfers: TransferStep[]; ``` -Defined in: [packages/types/src/pathfinding.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L49) +Defined in: [packages/types/src/pathfinding.ts:58](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L58) diff --git a/docs/types/src/interfaces/Profile.md b/docs/types/src/interfaces/Profile.md index 6c29178..7d563ce 100644 --- a/docs/types/src/interfaces/Profile.md +++ b/docs/types/src/interfaces/Profile.md @@ -6,7 +6,7 @@ # Interface: Profile -Defined in: [packages/types/src/avatar.ts:95](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L95) +Defined in: [packages/types/src/avatar.ts:95](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L95) Profile information @@ -22,7 +22,7 @@ Profile information name: string; ``` -Defined in: [packages/types/src/avatar.ts:96](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L96) +Defined in: [packages/types/src/avatar.ts:96](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L96) *** @@ -32,7 +32,7 @@ Defined in: [packages/types/src/avatar.ts:96](https://github.com/aboutcircles/sd optional description: string; ``` -Defined in: [packages/types/src/avatar.ts:97](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L97) +Defined in: [packages/types/src/avatar.ts:97](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L97) *** @@ -42,7 +42,7 @@ Defined in: [packages/types/src/avatar.ts:97](https://github.com/aboutcircles/sd optional previewImageUrl: string; ``` -Defined in: [packages/types/src/avatar.ts:98](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L98) +Defined in: [packages/types/src/avatar.ts:98](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L98) *** @@ -52,7 +52,7 @@ Defined in: [packages/types/src/avatar.ts:98](https://github.com/aboutcircles/sd optional imageUrl: string; ``` -Defined in: [packages/types/src/avatar.ts:99](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L99) +Defined in: [packages/types/src/avatar.ts:99](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L99) *** @@ -62,7 +62,7 @@ Defined in: [packages/types/src/avatar.ts:99](https://github.com/aboutcircles/sd optional location: string; ``` -Defined in: [packages/types/src/avatar.ts:100](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L100) +Defined in: [packages/types/src/avatar.ts:100](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L100) *** @@ -72,7 +72,7 @@ Defined in: [packages/types/src/avatar.ts:100](https://github.com/aboutcircles/s optional geoLocation: [number, number]; ``` -Defined in: [packages/types/src/avatar.ts:101](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L101) +Defined in: [packages/types/src/avatar.ts:101](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L101) *** @@ -82,4 +82,4 @@ Defined in: [packages/types/src/avatar.ts:101](https://github.com/aboutcircles/s optional extensions: Record; ``` -Defined in: [packages/types/src/avatar.ts:102](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/avatar.ts#L102) +Defined in: [packages/types/src/avatar.ts:102](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/avatar.ts#L102) diff --git a/docs/types/src/interfaces/QueryParams.md b/docs/types/src/interfaces/QueryParams.md index 0b2ad8b..e006c71 100644 --- a/docs/types/src/interfaces/QueryParams.md +++ b/docs/types/src/interfaces/QueryParams.md @@ -6,7 +6,7 @@ # Interface: QueryParams -Defined in: [packages/types/src/query.ts:62](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L62) +Defined in: [packages/types/src/query.ts:62](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L62) Query parameters for circles_query @@ -18,7 +18,7 @@ Query parameters for circles_query Namespace: string; ``` -Defined in: [packages/types/src/query.ts:63](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L63) +Defined in: [packages/types/src/query.ts:63](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L63) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/query.ts:63](https://github.com/aboutcircles/sdk Table: string; ``` -Defined in: [packages/types/src/query.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L64) +Defined in: [packages/types/src/query.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L64) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/query.ts:64](https://github.com/aboutcircles/sdk Columns: string[]; ``` -Defined in: [packages/types/src/query.ts:65](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L65) +Defined in: [packages/types/src/query.ts:65](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L65) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/query.ts:65](https://github.com/aboutcircles/sdk Filter: Filter[]; ``` -Defined in: [packages/types/src/query.ts:66](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L66) +Defined in: [packages/types/src/query.ts:66](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L66) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/query.ts:66](https://github.com/aboutcircles/sdk Order: OrderBy[]; ``` -Defined in: [packages/types/src/query.ts:67](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L67) +Defined in: [packages/types/src/query.ts:67](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L67) *** @@ -68,4 +68,4 @@ Defined in: [packages/types/src/query.ts:67](https://github.com/aboutcircles/sdk optional Limit: number; ``` -Defined in: [packages/types/src/query.ts:68](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L68) +Defined in: [packages/types/src/query.ts:68](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L68) diff --git a/docs/types/src/interfaces/QueryResponse.md b/docs/types/src/interfaces/QueryResponse.md index 92174dc..151d45a 100644 --- a/docs/types/src/interfaces/QueryResponse.md +++ b/docs/types/src/interfaces/QueryResponse.md @@ -6,7 +6,7 @@ # Interface: QueryResponse\ -Defined in: [packages/types/src/rpc.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L42) +Defined in: [packages/types/src/rpc.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L42) Generic query response wrapper Used for internal query transformations and type-safe responses @@ -25,7 +25,7 @@ Used for internal query transformations and type-safe responses result: T; ``` -Defined in: [packages/types/src/rpc.ts:43](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L43) +Defined in: [packages/types/src/rpc.ts:43](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L43) *** @@ -35,4 +35,4 @@ Defined in: [packages/types/src/rpc.ts:43](https://github.com/aboutcircles/sdk-v optional error: unknown; ``` -Defined in: [packages/types/src/rpc.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/rpc.ts#L44) +Defined in: [packages/types/src/rpc.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/rpc.ts#L44) diff --git a/docs/types/src/interfaces/SimulatedBalance.md b/docs/types/src/interfaces/SimulatedBalance.md index fbf5be1..e3868b4 100644 --- a/docs/types/src/interfaces/SimulatedBalance.md +++ b/docs/types/src/interfaces/SimulatedBalance.md @@ -6,7 +6,7 @@ # Interface: SimulatedBalance -Defined in: [packages/types/src/pathfinding.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L10) +Defined in: [packages/types/src/pathfinding.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L10) Simulated balance for path finding @@ -18,7 +18,7 @@ Simulated balance for path finding holder: `0x${string}`; ``` -Defined in: [packages/types/src/pathfinding.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L11) +Defined in: [packages/types/src/pathfinding.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L11) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/pathfinding.ts:11](https://github.com/aboutcircl token: `0x${string}`; ``` -Defined in: [packages/types/src/pathfinding.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L12) +Defined in: [packages/types/src/pathfinding.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L12) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/pathfinding.ts:12](https://github.com/aboutcircl amount: bigint; ``` -Defined in: [packages/types/src/pathfinding.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L13) +Defined in: [packages/types/src/pathfinding.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L13) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/pathfinding.ts:13](https://github.com/aboutcircl isWrapped: boolean; ``` -Defined in: [packages/types/src/pathfinding.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L14) +Defined in: [packages/types/src/pathfinding.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L14) *** @@ -58,4 +58,4 @@ Defined in: [packages/types/src/pathfinding.ts:14](https://github.com/aboutcircl isStatic: boolean; ``` -Defined in: [packages/types/src/pathfinding.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L15) +Defined in: [packages/types/src/pathfinding.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L15) diff --git a/docs/types/src/interfaces/SimulatedTrust.md b/docs/types/src/interfaces/SimulatedTrust.md new file mode 100644 index 0000000..4918c8c --- /dev/null +++ b/docs/types/src/interfaces/SimulatedTrust.md @@ -0,0 +1,31 @@ +[**Circles SDK**](../../../README.md) + +*** + +[Circles SDK](../../../modules.md) / [types/src](../README.md) / SimulatedTrust + +# Interface: SimulatedTrust + +Defined in: [packages/types/src/pathfinding.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L21) + +Simulated trust connection for path finding + +## Properties + +### truster + +```ts +truster: `0x${string}`; +``` + +Defined in: [packages/types/src/pathfinding.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L22) + +*** + +### trustee + +```ts +trustee: `0x${string}`; +``` + +Defined in: [packages/types/src/pathfinding.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L23) diff --git a/docs/types/src/interfaces/StreamStruct.md b/docs/types/src/interfaces/StreamStruct.md index 286cdf1..3dbd4dc 100644 --- a/docs/types/src/interfaces/StreamStruct.md +++ b/docs/types/src/interfaces/StreamStruct.md @@ -6,7 +6,7 @@ # Interface: StreamStruct -Defined in: [packages/types/src/pathfinding.ts:65](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L65) +Defined in: [packages/types/src/pathfinding.ts:74](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L74) Stream structure for operateFlowMatrix Corresponds to TypeDefinitions.Stream in the Hub V2 contract @@ -19,7 +19,7 @@ Corresponds to TypeDefinitions.Stream in the Hub V2 contract sourceCoordinate: number; ``` -Defined in: [packages/types/src/pathfinding.ts:66](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L66) +Defined in: [packages/types/src/pathfinding.ts:75](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L75) *** @@ -29,7 +29,7 @@ Defined in: [packages/types/src/pathfinding.ts:66](https://github.com/aboutcircl flowEdgeIds: number[]; ``` -Defined in: [packages/types/src/pathfinding.ts:67](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L67) +Defined in: [packages/types/src/pathfinding.ts:76](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L76) *** @@ -39,4 +39,4 @@ Defined in: [packages/types/src/pathfinding.ts:67](https://github.com/aboutcircl data: `0x${string}` | Uint8Array; ``` -Defined in: [packages/types/src/pathfinding.ts:68](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L68) +Defined in: [packages/types/src/pathfinding.ts:77](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L77) diff --git a/docs/types/src/interfaces/TableInfo.md b/docs/types/src/interfaces/TableInfo.md index 07267f1..ba5ebaf 100644 --- a/docs/types/src/interfaces/TableInfo.md +++ b/docs/types/src/interfaces/TableInfo.md @@ -6,7 +6,7 @@ # Interface: TableInfo -Defined in: [packages/types/src/query.ts:74](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L74) +Defined in: [packages/types/src/query.ts:74](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L74) Table information from circles_tables @@ -18,7 +18,7 @@ Table information from circles_tables Namespace: string; ``` -Defined in: [packages/types/src/query.ts:75](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L75) +Defined in: [packages/types/src/query.ts:75](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L75) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/query.ts:75](https://github.com/aboutcircles/sdk Table: string; ``` -Defined in: [packages/types/src/query.ts:76](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L76) +Defined in: [packages/types/src/query.ts:76](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L76) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/query.ts:76](https://github.com/aboutcircles/sdk Columns: object[]; ``` -Defined in: [packages/types/src/query.ts:77](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L77) +Defined in: [packages/types/src/query.ts:77](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L77) #### Name diff --git a/docs/types/src/interfaces/TokenBalance.md b/docs/types/src/interfaces/TokenBalance.md index 8e25026..9b86f3d 100644 --- a/docs/types/src/interfaces/TokenBalance.md +++ b/docs/types/src/interfaces/TokenBalance.md @@ -6,7 +6,7 @@ # Interface: TokenBalance -Defined in: [packages/types/src/token.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L10) +Defined in: [packages/types/src/token.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L10) Token balance information @@ -18,7 +18,7 @@ Token balance information tokenAddress: `0x${string}`; ``` -Defined in: [packages/types/src/token.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L11) +Defined in: [packages/types/src/token.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L11) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/token.ts:11](https://github.com/aboutcircles/sdk tokenId: bigint; ``` -Defined in: [packages/types/src/token.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L12) +Defined in: [packages/types/src/token.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L12) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/token.ts:12](https://github.com/aboutcircles/sdk tokenOwner: `0x${string}`; ``` -Defined in: [packages/types/src/token.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L13) +Defined in: [packages/types/src/token.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L13) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/token.ts:13](https://github.com/aboutcircles/sdk tokenType: string; ``` -Defined in: [packages/types/src/token.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L14) +Defined in: [packages/types/src/token.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L14) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/token.ts:14](https://github.com/aboutcircles/sdk version: number; ``` -Defined in: [packages/types/src/token.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L15) +Defined in: [packages/types/src/token.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L15) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/token.ts:15](https://github.com/aboutcircles/sdk attoCircles: bigint; ``` -Defined in: [packages/types/src/token.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L16) +Defined in: [packages/types/src/token.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L16) *** @@ -78,7 +78,7 @@ Defined in: [packages/types/src/token.ts:16](https://github.com/aboutcircles/sdk circles: number; ``` -Defined in: [packages/types/src/token.ts:17](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L17) +Defined in: [packages/types/src/token.ts:17](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L17) *** @@ -88,7 +88,7 @@ Defined in: [packages/types/src/token.ts:17](https://github.com/aboutcircles/sdk staticAttoCircles: bigint; ``` -Defined in: [packages/types/src/token.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L18) +Defined in: [packages/types/src/token.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L18) *** @@ -98,7 +98,7 @@ Defined in: [packages/types/src/token.ts:18](https://github.com/aboutcircles/sdk staticCircles: number; ``` -Defined in: [packages/types/src/token.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L19) +Defined in: [packages/types/src/token.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L19) *** @@ -108,7 +108,7 @@ Defined in: [packages/types/src/token.ts:19](https://github.com/aboutcircles/sdk attoCrc: bigint; ``` -Defined in: [packages/types/src/token.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L20) +Defined in: [packages/types/src/token.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L20) *** @@ -118,7 +118,7 @@ Defined in: [packages/types/src/token.ts:20](https://github.com/aboutcircles/sdk crc: number; ``` -Defined in: [packages/types/src/token.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L21) +Defined in: [packages/types/src/token.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L21) *** @@ -128,7 +128,7 @@ Defined in: [packages/types/src/token.ts:21](https://github.com/aboutcircles/sdk isErc20: boolean; ``` -Defined in: [packages/types/src/token.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L22) +Defined in: [packages/types/src/token.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L22) *** @@ -138,7 +138,7 @@ Defined in: [packages/types/src/token.ts:22](https://github.com/aboutcircles/sdk isErc1155: boolean; ``` -Defined in: [packages/types/src/token.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L23) +Defined in: [packages/types/src/token.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L23) *** @@ -148,7 +148,7 @@ Defined in: [packages/types/src/token.ts:23](https://github.com/aboutcircles/sdk isWrapped: boolean; ``` -Defined in: [packages/types/src/token.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L24) +Defined in: [packages/types/src/token.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L24) *** @@ -158,7 +158,7 @@ Defined in: [packages/types/src/token.ts:24](https://github.com/aboutcircles/sdk isInflationary: boolean; ``` -Defined in: [packages/types/src/token.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L25) +Defined in: [packages/types/src/token.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L25) *** @@ -168,4 +168,4 @@ Defined in: [packages/types/src/token.ts:25](https://github.com/aboutcircles/sdk isGroup: boolean; ``` -Defined in: [packages/types/src/token.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L26) +Defined in: [packages/types/src/token.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L26) diff --git a/docs/types/src/interfaces/TokenBalanceRow.md b/docs/types/src/interfaces/TokenBalanceRow.md index d08cfd2..1252366 100644 --- a/docs/types/src/interfaces/TokenBalanceRow.md +++ b/docs/types/src/interfaces/TokenBalanceRow.md @@ -6,7 +6,7 @@ # Interface: TokenBalanceRow -Defined in: [packages/types/src/sdk.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L21) +Defined in: [packages/types/src/sdk.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L21) Token balance row from RPC @@ -18,7 +18,7 @@ Token balance row from RPC tokenAddress: `0x${string}`; ``` -Defined in: [packages/types/src/sdk.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L22) +Defined in: [packages/types/src/sdk.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L22) *** @@ -28,4 +28,4 @@ Defined in: [packages/types/src/sdk.ts:22](https://github.com/aboutcircles/sdk-v balance: bigint; ``` -Defined in: [packages/types/src/sdk.ts:23](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L23) +Defined in: [packages/types/src/sdk.ts:23](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L23) diff --git a/docs/types/src/interfaces/TokenHolder.md b/docs/types/src/interfaces/TokenHolder.md index bbf9a5d..f12a27d 100644 --- a/docs/types/src/interfaces/TokenHolder.md +++ b/docs/types/src/interfaces/TokenHolder.md @@ -6,7 +6,7 @@ # Interface: TokenHolder -Defined in: [packages/types/src/token.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L48) +Defined in: [packages/types/src/token.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L48) Token holder information from V_CrcV2_BalancesByAccountAndToken @@ -18,7 +18,7 @@ Token holder information from V_CrcV2_BalancesByAccountAndToken account: `0x${string}`; ``` -Defined in: [packages/types/src/token.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L49) +Defined in: [packages/types/src/token.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L49) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/token.ts:49](https://github.com/aboutcircles/sdk tokenAddress: `0x${string}`; ``` -Defined in: [packages/types/src/token.ts:50](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L50) +Defined in: [packages/types/src/token.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L50) *** @@ -38,4 +38,4 @@ Defined in: [packages/types/src/token.ts:50](https://github.com/aboutcircles/sdk demurragedTotalBalance: string; ``` -Defined in: [packages/types/src/token.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L51) +Defined in: [packages/types/src/token.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L51) diff --git a/docs/types/src/interfaces/TokenInfo.md b/docs/types/src/interfaces/TokenInfo.md index 83714a5..7b8c478 100644 --- a/docs/types/src/interfaces/TokenInfo.md +++ b/docs/types/src/interfaces/TokenInfo.md @@ -6,7 +6,7 @@ # Interface: TokenInfo -Defined in: [packages/types/src/token.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L32) +Defined in: [packages/types/src/token.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L32) Token information @@ -18,7 +18,7 @@ Token information blockNumber: number; ``` -Defined in: [packages/types/src/token.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L33) +Defined in: [packages/types/src/token.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L33) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/token.ts:33](https://github.com/aboutcircles/sdk timestamp: number; ``` -Defined in: [packages/types/src/token.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L34) +Defined in: [packages/types/src/token.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L34) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/token.ts:34](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/token.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L35) +Defined in: [packages/types/src/token.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L35) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/token.ts:35](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/token.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L36) +Defined in: [packages/types/src/token.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L36) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/token.ts:36](https://github.com/aboutcircles/sdk transactionHash: string; ``` -Defined in: [packages/types/src/token.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L37) +Defined in: [packages/types/src/token.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L37) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/token.ts:37](https://github.com/aboutcircles/sdk version: number; ``` -Defined in: [packages/types/src/token.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L38) +Defined in: [packages/types/src/token.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L38) *** @@ -78,7 +78,7 @@ Defined in: [packages/types/src/token.ts:38](https://github.com/aboutcircles/sdk optional type: string; ``` -Defined in: [packages/types/src/token.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L39) +Defined in: [packages/types/src/token.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L39) *** @@ -88,7 +88,7 @@ Defined in: [packages/types/src/token.ts:39](https://github.com/aboutcircles/sdk tokenType: string; ``` -Defined in: [packages/types/src/token.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L40) +Defined in: [packages/types/src/token.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L40) *** @@ -98,7 +98,7 @@ Defined in: [packages/types/src/token.ts:40](https://github.com/aboutcircles/sdk token: `0x${string}`; ``` -Defined in: [packages/types/src/token.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L41) +Defined in: [packages/types/src/token.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L41) *** @@ -108,4 +108,4 @@ Defined in: [packages/types/src/token.ts:41](https://github.com/aboutcircles/sdk tokenOwner: `0x${string}`; ``` -Defined in: [packages/types/src/token.ts:42](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/token.ts#L42) +Defined in: [packages/types/src/token.ts:42](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/token.ts#L42) diff --git a/docs/types/src/interfaces/TransactionRequest.md b/docs/types/src/interfaces/TransactionRequest.md index eadf429..0edd70e 100644 --- a/docs/types/src/interfaces/TransactionRequest.md +++ b/docs/types/src/interfaces/TransactionRequest.md @@ -6,7 +6,7 @@ # Interface: TransactionRequest -Defined in: [packages/types/src/base.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L34) +Defined in: [packages/types/src/base.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L34) Transaction request object Contains all data needed to send a transaction @@ -19,7 +19,7 @@ Contains all data needed to send a transaction optional from: `0x${string}`; ``` -Defined in: [packages/types/src/base.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L35) +Defined in: [packages/types/src/base.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L35) *** @@ -29,7 +29,7 @@ Defined in: [packages/types/src/base.ts:35](https://github.com/aboutcircles/sdk- to: `0x${string}`; ``` -Defined in: [packages/types/src/base.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L36) +Defined in: [packages/types/src/base.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L36) *** @@ -39,7 +39,7 @@ Defined in: [packages/types/src/base.ts:36](https://github.com/aboutcircles/sdk- data: `0x${string}`; ``` -Defined in: [packages/types/src/base.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L37) +Defined in: [packages/types/src/base.ts:37](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L37) *** @@ -49,7 +49,7 @@ Defined in: [packages/types/src/base.ts:37](https://github.com/aboutcircles/sdk- optional value: bigint; ``` -Defined in: [packages/types/src/base.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L38) +Defined in: [packages/types/src/base.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L38) *** @@ -59,7 +59,7 @@ Defined in: [packages/types/src/base.ts:38](https://github.com/aboutcircles/sdk- optional gas: bigint; ``` -Defined in: [packages/types/src/base.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L39) +Defined in: [packages/types/src/base.ts:39](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L39) *** @@ -69,7 +69,7 @@ Defined in: [packages/types/src/base.ts:39](https://github.com/aboutcircles/sdk- optional gasPrice: bigint; ``` -Defined in: [packages/types/src/base.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L40) +Defined in: [packages/types/src/base.ts:40](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L40) *** @@ -79,4 +79,4 @@ Defined in: [packages/types/src/base.ts:40](https://github.com/aboutcircles/sdk- optional nonce: number; ``` -Defined in: [packages/types/src/base.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L41) +Defined in: [packages/types/src/base.ts:41](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L41) diff --git a/docs/types/src/interfaces/TransferStep.md b/docs/types/src/interfaces/TransferStep.md index 8b9e52b..689cc18 100644 --- a/docs/types/src/interfaces/TransferStep.md +++ b/docs/types/src/interfaces/TransferStep.md @@ -6,7 +6,7 @@ # Interface: TransferStep -Defined in: [packages/types/src/pathfinding.ts:37](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L37) +Defined in: [packages/types/src/pathfinding.ts:46](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L46) A single transfer step in a pathfinding result @@ -18,7 +18,7 @@ A single transfer step in a pathfinding result from: `0x${string}`; ``` -Defined in: [packages/types/src/pathfinding.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L38) +Defined in: [packages/types/src/pathfinding.ts:47](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L47) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/pathfinding.ts:38](https://github.com/aboutcircl to: `0x${string}`; ``` -Defined in: [packages/types/src/pathfinding.ts:39](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L39) +Defined in: [packages/types/src/pathfinding.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L48) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/pathfinding.ts:39](https://github.com/aboutcircl tokenOwner: string; ``` -Defined in: [packages/types/src/pathfinding.ts:40](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L40) +Defined in: [packages/types/src/pathfinding.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L49) *** @@ -48,4 +48,4 @@ Defined in: [packages/types/src/pathfinding.ts:40](https://github.com/aboutcircl value: bigint; ``` -Defined in: [packages/types/src/pathfinding.ts:41](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/pathfinding.ts#L41) +Defined in: [packages/types/src/pathfinding.ts:50](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/pathfinding.ts#L50) diff --git a/docs/types/src/interfaces/TrustRelation.md b/docs/types/src/interfaces/TrustRelation.md index d05bd84..d7dd532 100644 --- a/docs/types/src/interfaces/TrustRelation.md +++ b/docs/types/src/interfaces/TrustRelation.md @@ -6,7 +6,7 @@ # Interface: TrustRelation -Defined in: [packages/types/src/trust.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L10) +Defined in: [packages/types/src/trust.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L10) Trust relation information @@ -18,7 +18,7 @@ Trust relation information blockNumber: number; ``` -Defined in: [packages/types/src/trust.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L11) +Defined in: [packages/types/src/trust.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L11) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/trust.ts:11](https://github.com/aboutcircles/sdk timestamp: number; ``` -Defined in: [packages/types/src/trust.ts:12](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L12) +Defined in: [packages/types/src/trust.ts:12](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L12) *** @@ -38,7 +38,7 @@ Defined in: [packages/types/src/trust.ts:12](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/trust.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L13) +Defined in: [packages/types/src/trust.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L13) *** @@ -48,7 +48,7 @@ Defined in: [packages/types/src/trust.ts:13](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/trust.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L14) +Defined in: [packages/types/src/trust.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L14) *** @@ -58,7 +58,7 @@ Defined in: [packages/types/src/trust.ts:14](https://github.com/aboutcircles/sdk transactionHash: `0x${string}`; ``` -Defined in: [packages/types/src/trust.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L15) +Defined in: [packages/types/src/trust.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L15) *** @@ -68,7 +68,7 @@ Defined in: [packages/types/src/trust.ts:15](https://github.com/aboutcircles/sdk truster: `0x${string}`; ``` -Defined in: [packages/types/src/trust.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L16) +Defined in: [packages/types/src/trust.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L16) *** @@ -78,7 +78,7 @@ Defined in: [packages/types/src/trust.ts:16](https://github.com/aboutcircles/sdk trustee: `0x${string}`; ``` -Defined in: [packages/types/src/trust.ts:17](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L17) +Defined in: [packages/types/src/trust.ts:17](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L17) *** @@ -88,4 +88,4 @@ Defined in: [packages/types/src/trust.ts:17](https://github.com/aboutcircles/sdk expiryTime: number; ``` -Defined in: [packages/types/src/trust.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L18) +Defined in: [packages/types/src/trust.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L18) diff --git a/docs/types/src/interfaces/TrustRelationRow.md b/docs/types/src/interfaces/TrustRelationRow.md index a570775..1f2e2d5 100644 --- a/docs/types/src/interfaces/TrustRelationRow.md +++ b/docs/types/src/interfaces/TrustRelationRow.md @@ -6,7 +6,7 @@ # Interface: TrustRelationRow -Defined in: [packages/types/src/sdk.ts:30](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L30) +Defined in: [packages/types/src/sdk.ts:30](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L30) Trust relation row from RPC @@ -18,7 +18,7 @@ Trust relation row from RPC truster: `0x${string}`; ``` -Defined in: [packages/types/src/sdk.ts:31](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L31) +Defined in: [packages/types/src/sdk.ts:31](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L31) *** @@ -28,7 +28,7 @@ Defined in: [packages/types/src/sdk.ts:31](https://github.com/aboutcircles/sdk-v trustee: `0x${string}`; ``` -Defined in: [packages/types/src/sdk.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L32) +Defined in: [packages/types/src/sdk.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L32) *** @@ -38,4 +38,4 @@ Defined in: [packages/types/src/sdk.ts:32](https://github.com/aboutcircles/sdk-v expiryTime: number; ``` -Defined in: [packages/types/src/sdk.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/sdk.ts#L33) +Defined in: [packages/types/src/sdk.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/sdk.ts#L33) diff --git a/docs/types/src/type-aliases/Address.md b/docs/types/src/type-aliases/Address.md index f69550c..93be799 100644 --- a/docs/types/src/type-aliases/Address.md +++ b/docs/types/src/type-aliases/Address.md @@ -10,6 +10,6 @@ type Address = ViemAddress; ``` -Defined in: [packages/types/src/base.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L10) +Defined in: [packages/types/src/base.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L10) Ethereum address type diff --git a/docs/types/src/type-aliases/CirclesBaseEvent.md b/docs/types/src/type-aliases/CirclesBaseEvent.md index 5e01430..9c6a397 100644 --- a/docs/types/src/type-aliases/CirclesBaseEvent.md +++ b/docs/types/src/type-aliases/CirclesBaseEvent.md @@ -10,7 +10,7 @@ type CirclesBaseEvent = object; ``` -Defined in: [packages/types/src/events.ts:5](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L5) +Defined in: [packages/types/src/events.ts:5](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L5) Events types @@ -22,7 +22,7 @@ Events types blockNumber: number; ``` -Defined in: [packages/types/src/events.ts:6](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L6) +Defined in: [packages/types/src/events.ts:6](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L6) *** @@ -32,7 +32,7 @@ Defined in: [packages/types/src/events.ts:6](https://github.com/aboutcircles/sdk optional timestamp: number; ``` -Defined in: [packages/types/src/events.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L7) +Defined in: [packages/types/src/events.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L7) *** @@ -42,7 +42,7 @@ Defined in: [packages/types/src/events.ts:7](https://github.com/aboutcircles/sdk transactionIndex: number; ``` -Defined in: [packages/types/src/events.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L8) +Defined in: [packages/types/src/events.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L8) *** @@ -52,7 +52,7 @@ Defined in: [packages/types/src/events.ts:8](https://github.com/aboutcircles/sdk logIndex: number; ``` -Defined in: [packages/types/src/events.ts:9](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L9) +Defined in: [packages/types/src/events.ts:9](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L9) *** @@ -62,4 +62,4 @@ Defined in: [packages/types/src/events.ts:9](https://github.com/aboutcircles/sdk optional transactionHash: string; ``` -Defined in: [packages/types/src/events.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L10) +Defined in: [packages/types/src/events.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L10) diff --git a/docs/types/src/type-aliases/CirclesEvent.md b/docs/types/src/type-aliases/CirclesEvent.md index fcb8db2..9ee3eaa 100644 --- a/docs/types/src/type-aliases/CirclesEvent.md +++ b/docs/types/src/type-aliases/CirclesEvent.md @@ -10,7 +10,7 @@ type CirclesEvent = CirclesBaseEvent & object; ``` -Defined in: [packages/types/src/events.ts:51](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L51) +Defined in: [packages/types/src/events.ts:51](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L51) ## Type Declaration diff --git a/docs/types/src/type-aliases/CirclesEventOfType.md b/docs/types/src/type-aliases/CirclesEventOfType.md index d08f6a8..858deb8 100644 --- a/docs/types/src/type-aliases/CirclesEventOfType.md +++ b/docs/types/src/type-aliases/CirclesEventOfType.md @@ -10,7 +10,7 @@ type CirclesEventOfType = CirclesEvent & object; ``` -Defined in: [packages/types/src/events.ts:56](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L56) +Defined in: [packages/types/src/events.ts:56](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L56) ## Type Declaration diff --git a/docs/types/src/type-aliases/CirclesEventType.md b/docs/types/src/type-aliases/CirclesEventType.md index b87e869..ba2d171 100644 --- a/docs/types/src/type-aliases/CirclesEventType.md +++ b/docs/types/src/type-aliases/CirclesEventType.md @@ -40,4 +40,4 @@ type CirclesEventType = | "Crc_UnknownEvent"; ``` -Defined in: [packages/types/src/events.ts:13](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L13) +Defined in: [packages/types/src/events.ts:13](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L13) diff --git a/docs/types/src/type-aliases/ConjunctionType.md b/docs/types/src/type-aliases/ConjunctionType.md index 8631902..105fb47 100644 --- a/docs/types/src/type-aliases/ConjunctionType.md +++ b/docs/types/src/type-aliases/ConjunctionType.md @@ -10,6 +10,6 @@ type ConjunctionType = "And" | "Or"; ``` -Defined in: [packages/types/src/query.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L20) +Defined in: [packages/types/src/query.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L20) Conjunction types for combining predicates diff --git a/docs/types/src/type-aliases/EventType.md b/docs/types/src/type-aliases/EventType.md index a01f26e..825e4e0 100644 --- a/docs/types/src/type-aliases/EventType.md +++ b/docs/types/src/type-aliases/EventType.md @@ -20,6 +20,6 @@ type EventType = | "CrcV2_TransferBatch"; ``` -Defined in: [packages/types/src/network.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/network.ts#L11) +Defined in: [packages/types/src/network.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/network.ts#L11) Event types diff --git a/docs/types/src/type-aliases/Filter.md b/docs/types/src/type-aliases/Filter.md index b5fa205..bc90635 100644 --- a/docs/types/src/type-aliases/Filter.md +++ b/docs/types/src/type-aliases/Filter.md @@ -12,6 +12,6 @@ type Filter = | Conjunction; ``` -Defined in: [packages/types/src/query.ts:44](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L44) +Defined in: [packages/types/src/query.ts:44](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L44) Filter type (either a predicate or conjunction) diff --git a/docs/types/src/type-aliases/FilterType.md b/docs/types/src/type-aliases/FilterType.md index 4b9704d..96d3f7b 100644 --- a/docs/types/src/type-aliases/FilterType.md +++ b/docs/types/src/type-aliases/FilterType.md @@ -17,6 +17,6 @@ type FilterType = | "Like"; ``` -Defined in: [packages/types/src/query.ts:8](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L8) +Defined in: [packages/types/src/query.ts:8](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L8) Filter types for query predicates diff --git a/docs/types/src/type-aliases/Hash.md b/docs/types/src/type-aliases/Hash.md index 5ef2d0e..e1c8a1d 100644 --- a/docs/types/src/type-aliases/Hash.md +++ b/docs/types/src/type-aliases/Hash.md @@ -10,6 +10,6 @@ type Hash = `0x${string}`; ``` -Defined in: [packages/types/src/base.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L20) +Defined in: [packages/types/src/base.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L20) Transaction or block hash type diff --git a/docs/types/src/type-aliases/Hex.md b/docs/types/src/type-aliases/Hex.md index 9fd65e3..717366b 100644 --- a/docs/types/src/type-aliases/Hex.md +++ b/docs/types/src/type-aliases/Hex.md @@ -10,6 +10,6 @@ type Hex = `0x${string}`; ``` -Defined in: [packages/types/src/base.ts:15](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/base.ts#L15) +Defined in: [packages/types/src/base.ts:15](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/base.ts#L15) Hexadecimal string type diff --git a/docs/types/src/type-aliases/RpcSubscriptionEvent.md b/docs/types/src/type-aliases/RpcSubscriptionEvent.md index 0b42aaf..f777524 100644 --- a/docs/types/src/type-aliases/RpcSubscriptionEvent.md +++ b/docs/types/src/type-aliases/RpcSubscriptionEvent.md @@ -10,7 +10,7 @@ type RpcSubscriptionEvent = object; ``` -Defined in: [packages/types/src/events.ts:60](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L60) +Defined in: [packages/types/src/events.ts:60](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L60) ## Properties @@ -20,7 +20,7 @@ Defined in: [packages/types/src/events.ts:60](https://github.com/aboutcircles/sd event: string; ``` -Defined in: [packages/types/src/events.ts:61](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L61) +Defined in: [packages/types/src/events.ts:61](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L61) *** @@ -30,4 +30,4 @@ Defined in: [packages/types/src/events.ts:61](https://github.com/aboutcircles/sd values: Record; ``` -Defined in: [packages/types/src/events.ts:62](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/events.ts#L62) +Defined in: [packages/types/src/events.ts:62](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/events.ts#L62) diff --git a/docs/types/src/type-aliases/SortOrder.md b/docs/types/src/type-aliases/SortOrder.md index 7f37774..fd38487 100644 --- a/docs/types/src/type-aliases/SortOrder.md +++ b/docs/types/src/type-aliases/SortOrder.md @@ -10,6 +10,6 @@ type SortOrder = "ASC" | "DESC"; ``` -Defined in: [packages/types/src/query.ts:49](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/query.ts#L49) +Defined in: [packages/types/src/query.ts:49](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/query.ts#L49) Order direction for query results diff --git a/docs/types/src/type-aliases/TrustRelationType.md b/docs/types/src/type-aliases/TrustRelationType.md index 1fb158a..f4c171b 100644 --- a/docs/types/src/type-aliases/TrustRelationType.md +++ b/docs/types/src/type-aliases/TrustRelationType.md @@ -10,4 +10,4 @@ type TrustRelationType = "trusts" | "trustedBy" | "mutuallyTrusts"; ``` -Defined in: [packages/types/src/trust.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/trust.ts#L21) +Defined in: [packages/types/src/trust.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/trust.ts#L21) diff --git a/docs/types/src/type-aliases/WrappedTokenInfo.md b/docs/types/src/type-aliases/WrappedTokenInfo.md index 65f01a7..302414e 100644 --- a/docs/types/src/type-aliases/WrappedTokenInfo.md +++ b/docs/types/src/type-aliases/WrappedTokenInfo.md @@ -10,7 +10,7 @@ type WrappedTokenInfo = object; ``` -Defined in: [packages/types/src/wrapper.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L18) +Defined in: [packages/types/src/wrapper.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L18) Information about a wrapped token found in a transfer path Maps wrapper address to [amount used in path, wrapper type] @@ -23,7 +23,7 @@ Maps wrapper address to [amount used in path, wrapper type] amount: bigint; ``` -Defined in: [packages/types/src/wrapper.ts:20](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L20) +Defined in: [packages/types/src/wrapper.ts:20](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L20) Amount of the wrapped token used in the path @@ -35,6 +35,6 @@ Amount of the wrapped token used in the path tokenType: string; ``` -Defined in: [packages/types/src/wrapper.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L22) +Defined in: [packages/types/src/wrapper.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L22) The type of wrapper (e.g., 'CrcV2_ERC20WrapperDeployed_Demurraged' or 'CrcV2_ERC20WrapperDeployed_Inflationary') diff --git a/docs/types/src/type-aliases/WrappedTokensRecord.md b/docs/types/src/type-aliases/WrappedTokensRecord.md index 21818f0..c06d8ce 100644 --- a/docs/types/src/type-aliases/WrappedTokensRecord.md +++ b/docs/types/src/type-aliases/WrappedTokensRecord.md @@ -10,7 +10,7 @@ type WrappedTokensRecord = Record; ``` -Defined in: [packages/types/src/wrapper.ts:29](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/types/src/wrapper.ts#L29) +Defined in: [packages/types/src/wrapper.ts:29](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/types/src/wrapper.ts#L29) Record of wrapped tokens found in a transfer path Maps wrapper address to wrapped token information diff --git a/docs/utils/src/classes/CirclesConverter.md b/docs/utils/src/classes/CirclesConverter.md index 681bb73..eca1a74 100644 --- a/docs/utils/src/classes/CirclesConverter.md +++ b/docs/utils/src/classes/CirclesConverter.md @@ -6,7 +6,7 @@ # Class: CirclesConverter -Defined in: [packages/utils/src/circlesConverter.ts:7](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L7) +Defined in: [packages/utils/src/circlesConverter.ts:7](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L7) Conversions between demurrage and inflationary units in V2 – bit‑identical with the Solidity reference implementation (ABDK Math 64.64). @@ -33,7 +33,7 @@ new CirclesConverter(): CirclesConverter; readonly static ONE_64: bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:11](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L11) +Defined in: [packages/utils/src/circlesConverter.ts:11](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L11) 1.0 in 64.64 representation @@ -45,7 +45,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:11](https://github.com/about readonly static GAMMA_64: bigint = 18_443_079_296_116_538_654n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:14](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L14) +Defined in: [packages/utils/src/circlesConverter.ts:14](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L14) GAMMA = (0.93)^(1/365.25) * 2^64 @@ -57,7 +57,7 @@ GAMMA = (0.93)^(1/365.25) * 2^64 readonly static BETA_64: bigint = 18_450_409_579_521_241_655n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:16](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L16) +Defined in: [packages/utils/src/circlesConverter.ts:16](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L16) BETA = 1 / GAMMA * 2^64 @@ -69,7 +69,7 @@ BETA = 1 / GAMMA * 2^64 readonly static SECONDS_PER_DAY: bigint = 86_400n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:18](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L18) +Defined in: [packages/utils/src/circlesConverter.ts:18](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L18) *** @@ -79,7 +79,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:18](https://github.com/about readonly static INFLATION_DAY_ZERO_UNIX: bigint = 1_602_720_000n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:19](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L19) +Defined in: [packages/utils/src/circlesConverter.ts:19](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L19) *** @@ -89,7 +89,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:19](https://github.com/about readonly static ATTO_FACTOR: bigint = 1_000_000_000_000_000_000n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:21](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L21) +Defined in: [packages/utils/src/circlesConverter.ts:21](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L21) *** @@ -99,7 +99,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:21](https://github.com/about readonly static FACTOR_1E12: bigint = 1_000_000_000_000n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:22](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L22) +Defined in: [packages/utils/src/circlesConverter.ts:22](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L22) *** @@ -109,7 +109,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:22](https://github.com/about readonly static V1_ACCURACY: bigint = 100_000_000n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:24](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L24) +Defined in: [packages/utils/src/circlesConverter.ts:24](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L24) *** @@ -119,7 +119,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:24](https://github.com/about readonly static V1_INFLATION_PCT_NUM: bigint = 107n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L25) +Defined in: [packages/utils/src/circlesConverter.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L25) *** @@ -129,7 +129,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:25](https://github.com/about readonly static V1_INFLATION_PCT_DEN: bigint = 100n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:26](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L26) +Defined in: [packages/utils/src/circlesConverter.ts:26](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L26) *** @@ -139,7 +139,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:26](https://github.com/about readonly static PERIOD_SEC: bigint = 31_556_952n; ``` -Defined in: [packages/utils/src/circlesConverter.ts:27](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L27) +Defined in: [packages/utils/src/circlesConverter.ts:27](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L27) ## Methods @@ -149,7 +149,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:27](https://github.com/about static attoCirclesToCircles(atto): number; ``` -Defined in: [packages/utils/src/circlesConverter.ts:105](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L105) +Defined in: [packages/utils/src/circlesConverter.ts:105](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L105) Atto‑circles (1e18) → UI circles as JS number (lossless until 2^53‑1). @@ -171,7 +171,7 @@ Atto‑circles (1e18) → UI circles as JS number (lossless until 2^53‑1). static circlesToAttoCircles(circles): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:121](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L121) +Defined in: [packages/utils/src/circlesConverter.ts:121](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L121) UI circles → atto‑circles (truncates to match Solidity’s rounding). @@ -193,7 +193,7 @@ UI circles → atto‑circles (truncates to match Solidity’s rounding). static inflationaryToDemurrage(inflationary, day): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:128](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L128) +Defined in: [packages/utils/src/circlesConverter.ts:128](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L128) Inflationary → demurraged for explicit day index. @@ -219,7 +219,7 @@ Inflationary → demurraged for explicit day index. static demurrageToInflationary(demurraged, day): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:133](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L133) +Defined in: [packages/utils/src/circlesConverter.ts:133](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L133) Demurraged → inflationary for explicit day index. @@ -245,7 +245,7 @@ Demurraged → inflationary for explicit day index. static dayFromTimestamp(unixSeconds): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:138](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L138) +Defined in: [packages/utils/src/circlesConverter.ts:138](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L138) UNIX timestamp (seconds) → Circles day index. @@ -267,7 +267,7 @@ UNIX timestamp (seconds) → Circles day index. static attoCirclesToAttoStaticCircles(demurraged, nowUnixSeconds): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:143](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L143) +Defined in: [packages/utils/src/circlesConverter.ts:143](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L143) Demurraged → static circles for “today”. @@ -293,7 +293,7 @@ Demurraged → static circles for “today”. static attoStaticCirclesToAttoCircles(staticCircles, nowUnixSeconds): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:151](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L151) +Defined in: [packages/utils/src/circlesConverter.ts:151](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L151) Static circles → demurraged circles for “today”. @@ -319,7 +319,7 @@ Static circles → demurraged circles for “today”. static inflationaryToDemurrageExact(inflationary, day): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:159](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L159) +Defined in: [packages/utils/src/circlesConverter.ts:159](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L159) Inflationary → demurraged (exact, reversible). @@ -345,7 +345,7 @@ Inflationary → demurraged (exact, reversible). static demurrageToInflationaryExact(demurraged, day): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:165](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L165) +Defined in: [packages/utils/src/circlesConverter.ts:165](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L165) Demurraged → inflationary (inverse of the above, exact). @@ -371,7 +371,7 @@ Demurraged → inflationary (inverse of the above, exact). static attoCirclesToAttoStaticCirclesExact(demurraged, nowUnixSeconds): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:171](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L171) +Defined in: [packages/utils/src/circlesConverter.ts:171](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L171) Demurraged atto-circles → static atto-circles “today” (loss-less). @@ -397,7 +397,7 @@ Demurraged atto-circles → static atto-circles “today” (loss-less). static attoStaticCirclesToAttoCirclesExact(staticCircles, nowUnixSeconds): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:180](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L180) +Defined in: [packages/utils/src/circlesConverter.ts:180](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L180) Static atto-circles → demurraged atto-circles “today” (loss-less). @@ -423,7 +423,7 @@ Static atto-circles → demurraged atto-circles “today” (loss-less). static truncateToInt64(wei): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:190](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L190) +Defined in: [packages/utils/src/circlesConverter.ts:190](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L190) #### Parameters @@ -443,7 +443,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:190](https://github.com/abou static blowUpToBigInt(sixDecimals): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:196](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L196) +Defined in: [packages/utils/src/circlesConverter.ts:196](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L196) #### Parameters @@ -463,7 +463,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:196](https://github.com/abou static truncateToSixDecimals(wei): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:200](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L200) +Defined in: [packages/utils/src/circlesConverter.ts:200](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L200) #### Parameters @@ -483,7 +483,7 @@ Defined in: [packages/utils/src/circlesConverter.ts:200](https://github.com/abou static attoCrcToAttoCircles(v1Amount, blockTimestampUtc): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:212](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L212) +Defined in: [packages/utils/src/circlesConverter.ts:212](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L212) CRC → demurraged Circles for a given timestamp. @@ -509,7 +509,7 @@ CRC → demurraged Circles for a given timestamp. static attoCirclesToAttoCrc(demurraged, blockTimestampUtc): bigint; ``` -Defined in: [packages/utils/src/circlesConverter.ts:222](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/circlesConverter.ts#L222) +Defined in: [packages/utils/src/circlesConverter.ts:222](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/circlesConverter.ts#L222) Demurraged Circles → CRC (inverse of the above). diff --git a/docs/utils/src/classes/CirclesError.md b/docs/utils/src/classes/CirclesError.md index fa6802d..4921474 100644 --- a/docs/utils/src/classes/CirclesError.md +++ b/docs/utils/src/classes/CirclesError.md @@ -6,7 +6,7 @@ # Class: CirclesError\ -Defined in: [packages/utils/src/errors.ts:31](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L31) +Defined in: [packages/utils/src/errors.ts:31](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L31) Base Circles SDK Error All SDK errors extend from this class @@ -38,7 +38,7 @@ new CirclesError( options?): CirclesError; ``` -Defined in: [packages/utils/src/errors.ts:38](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L38) +Defined in: [packages/utils/src/errors.ts:38](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L38) #### Parameters @@ -86,7 +86,7 @@ Error.constructor readonly name: string; ``` -Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L32) +Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L32) #### Overrides @@ -102,7 +102,7 @@ Error.name readonly optional code: string | number; ``` -Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L33) +Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L33) *** @@ -112,7 +112,7 @@ Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sd readonly source: TSource; ``` -Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L34) +Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L34) *** @@ -122,7 +122,7 @@ Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sd readonly optional cause: unknown; ``` -Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L35) +Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L35) The cause of the error. @@ -140,7 +140,7 @@ Error.cause readonly optional context: Record; ``` -Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L36) +Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L36) ## Methods @@ -150,7 +150,7 @@ Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sd toJSON(): object; ``` -Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L64) +Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L64) Convert error to JSON for logging/debugging @@ -208,7 +208,7 @@ stack: string | undefined; toString(): string; ``` -Defined in: [packages/utils/src/errors.ts:82](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L82) +Defined in: [packages/utils/src/errors.ts:82](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L82) Get formatted error message with context diff --git a/docs/utils/src/classes/ContractError.md b/docs/utils/src/classes/ContractError.md index a764c1f..be438de 100644 --- a/docs/utils/src/classes/ContractError.md +++ b/docs/utils/src/classes/ContractError.md @@ -6,7 +6,7 @@ # Class: ContractError -Defined in: [packages/utils/src/contractErrors.ts:190](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/contractErrors.ts#L190) +Defined in: [packages/utils/src/contractErrors.ts:190](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/contractErrors.ts#L190) Contract error class for Circles SDK Extends CirclesError with contract-specific error information @@ -23,7 +23,7 @@ Extends CirclesError with contract-specific error information new ContractError(message, options?): ContractError; ``` -Defined in: [packages/utils/src/contractErrors.ts:193](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/contractErrors.ts#L193) +Defined in: [packages/utils/src/contractErrors.ts:193](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/contractErrors.ts#L193) #### Parameters @@ -65,7 +65,7 @@ Defined in: [packages/utils/src/contractErrors.ts:193](https://github.com/aboutc readonly optional decodedError: DecodedContractError; ``` -Defined in: [packages/utils/src/contractErrors.ts:191](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/contractErrors.ts#L191) +Defined in: [packages/utils/src/contractErrors.ts:191](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/contractErrors.ts#L191) *** @@ -75,7 +75,7 @@ Defined in: [packages/utils/src/contractErrors.ts:191](https://github.com/aboutc readonly name: string; ``` -Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L32) +Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L32) #### Inherited from @@ -89,7 +89,7 @@ Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sd readonly optional code: string | number; ``` -Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L33) +Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L33) #### Inherited from @@ -103,7 +103,7 @@ Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sd readonly source: "CORE"; ``` -Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L34) +Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L34) #### Inherited from @@ -117,7 +117,7 @@ Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sd readonly optional cause: unknown; ``` -Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L35) +Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L35) The cause of the error. @@ -133,7 +133,7 @@ The cause of the error. readonly optional context: Record; ``` -Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L36) +Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L36) #### Inherited from @@ -150,7 +150,7 @@ static fromTransactionError( context?): ContractError; ``` -Defined in: [packages/utils/src/contractErrors.ts:209](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/contractErrors.ts#L209) +Defined in: [packages/utils/src/contractErrors.ts:209](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/contractErrors.ts#L209) Create a ContractError from a transaction error @@ -180,7 +180,7 @@ Create a ContractError from a transaction error toString(): string; ``` -Defined in: [packages/utils/src/contractErrors.ts:246](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/contractErrors.ts#L246) +Defined in: [packages/utils/src/contractErrors.ts:246](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/contractErrors.ts#L246) Get formatted error message with details @@ -200,7 +200,7 @@ Get formatted error message with details toJSON(): object; ``` -Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L64) +Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L64) Convert error to JSON for logging/debugging diff --git a/docs/utils/src/classes/EncodingError.md b/docs/utils/src/classes/EncodingError.md index d8fc652..3a782ac 100644 --- a/docs/utils/src/classes/EncodingError.md +++ b/docs/utils/src/classes/EncodingError.md @@ -6,7 +6,7 @@ # Class: EncodingError -Defined in: [packages/utils/src/errors.ts:160](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L160) +Defined in: [packages/utils/src/errors.ts:160](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L160) Encoding/Conversion errors for utils package @@ -22,7 +22,7 @@ Encoding/Conversion errors for utils package new EncodingError(message, options?): EncodingError; ``` -Defined in: [packages/utils/src/errors.ts:161](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L161) +Defined in: [packages/utils/src/errors.ts:161](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L161) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/utils/src/errors.ts:161](https://github.com/aboutcircles/s readonly name: string; ``` -Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L32) +Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L32) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sd readonly optional code: string | number; ``` -Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L33) +Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L33) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sd readonly source: UtilsErrorSource; ``` -Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L34) +Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L34) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sd readonly optional cause: unknown; ``` -Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L35) +Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L35) The cause of the error. @@ -118,7 +118,7 @@ The cause of the error. readonly optional context: Record; ``` -Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L36) +Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L36) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sd toJSON(): object; ``` -Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L64) +Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L64) Convert error to JSON for logging/debugging @@ -194,7 +194,7 @@ stack: string | undefined; toString(): string; ``` -Defined in: [packages/utils/src/errors.ts:82](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L82) +Defined in: [packages/utils/src/errors.ts:82](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L82) Get formatted error message with context @@ -214,7 +214,7 @@ Get formatted error message with context static abiEncoding(functionName, cause?): EncodingError; ``` -Defined in: [packages/utils/src/errors.ts:175](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L175) +Defined in: [packages/utils/src/errors.ts:175](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L175) Create error for ABI encoding failures @@ -240,7 +240,7 @@ Create error for ABI encoding failures static cidConversion(cid, cause?): EncodingError; ``` -Defined in: [packages/utils/src/errors.ts:186](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L186) +Defined in: [packages/utils/src/errors.ts:186](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L186) Create error for CID conversion failures diff --git a/docs/utils/src/classes/ValidationError.md b/docs/utils/src/classes/ValidationError.md index 3c380dc..5048e94 100644 --- a/docs/utils/src/classes/ValidationError.md +++ b/docs/utils/src/classes/ValidationError.md @@ -6,7 +6,7 @@ # Class: ValidationError -Defined in: [packages/utils/src/errors.ts:97](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L97) +Defined in: [packages/utils/src/errors.ts:97](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L97) Validation errors @@ -22,7 +22,7 @@ Validation errors new ValidationError(message, options?): ValidationError; ``` -Defined in: [packages/utils/src/errors.ts:98](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L98) +Defined in: [packages/utils/src/errors.ts:98](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L98) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/utils/src/errors.ts:98](https://github.com/aboutcircles/sd readonly name: string; ``` -Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L32) +Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L32) #### Inherited from @@ -74,7 +74,7 @@ Defined in: [packages/utils/src/errors.ts:32](https://github.com/aboutcircles/sd readonly optional code: string | number; ``` -Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L33) +Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L33) #### Inherited from @@ -88,7 +88,7 @@ Defined in: [packages/utils/src/errors.ts:33](https://github.com/aboutcircles/sd readonly source: UtilsErrorSource; ``` -Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L34) +Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L34) #### Inherited from @@ -102,7 +102,7 @@ Defined in: [packages/utils/src/errors.ts:34](https://github.com/aboutcircles/sd readonly optional cause: unknown; ``` -Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L35) +Defined in: [packages/utils/src/errors.ts:35](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L35) The cause of the error. @@ -118,7 +118,7 @@ The cause of the error. readonly optional context: Record; ``` -Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L36) +Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L36) #### Inherited from @@ -132,7 +132,7 @@ Defined in: [packages/utils/src/errors.ts:36](https://github.com/aboutcircles/sd toJSON(): object; ``` -Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L64) +Defined in: [packages/utils/src/errors.ts:64](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L64) Convert error to JSON for logging/debugging @@ -194,7 +194,7 @@ stack: string | undefined; toString(): string; ``` -Defined in: [packages/utils/src/errors.ts:82](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L82) +Defined in: [packages/utils/src/errors.ts:82](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L82) Get formatted error message with context @@ -214,7 +214,7 @@ Get formatted error message with context static invalidAddress(address): ValidationError; ``` -Defined in: [packages/utils/src/errors.ts:113](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L113) +Defined in: [packages/utils/src/errors.ts:113](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L113) Create error for invalid address @@ -236,7 +236,7 @@ Create error for invalid address static invalidAmount(amount, reason?): ValidationError; ``` -Defined in: [packages/utils/src/errors.ts:123](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L123) +Defined in: [packages/utils/src/errors.ts:123](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L123) Create error for invalid amount @@ -262,7 +262,7 @@ Create error for invalid amount static missingParameter(paramName): ValidationError; ``` -Defined in: [packages/utils/src/errors.ts:136](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L136) +Defined in: [packages/utils/src/errors.ts:136](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L136) Create error for missing parameter @@ -287,7 +287,7 @@ static invalidParameter( reason?): ValidationError; ``` -Defined in: [packages/utils/src/errors.ts:146](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L146) +Defined in: [packages/utils/src/errors.ts:146](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L146) Create error for invalid parameter diff --git a/docs/utils/src/functions/bytesToHex.md b/docs/utils/src/functions/bytesToHex.md index fc5eced..7a480e0 100644 --- a/docs/utils/src/functions/bytesToHex.md +++ b/docs/utils/src/functions/bytesToHex.md @@ -10,7 +10,7 @@ function bytesToHex(bytes): string; ``` -Defined in: [packages/utils/src/bytes.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/bytes.ts#L10) +Defined in: [packages/utils/src/bytes.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/bytes.ts#L10) Convert a Uint8Array to a hex string with 0x prefix diff --git a/docs/utils/src/functions/checksumAddress.md b/docs/utils/src/functions/checksumAddress.md index fcdb5a7..bea942b 100644 --- a/docs/utils/src/functions/checksumAddress.md +++ b/docs/utils/src/functions/checksumAddress.md @@ -10,7 +10,7 @@ function checksumAddress(address): string; ``` -Defined in: [packages/utils/src/abi.ts:48](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/abi.ts#L48) +Defined in: [packages/utils/src/abi.ts:48](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/abi.ts#L48) Convert an Ethereum address to EIP-55 checksummed format diff --git a/docs/utils/src/functions/cidV0ToHex.md b/docs/utils/src/functions/cidV0ToHex.md index a2f5496..f313010 100644 --- a/docs/utils/src/functions/cidV0ToHex.md +++ b/docs/utils/src/functions/cidV0ToHex.md @@ -10,7 +10,7 @@ function cidV0ToHex(cidV0): `0x${string}`; ``` -Defined in: [packages/utils/src/cid.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/cid.ts#L25) +Defined in: [packages/utils/src/cid.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/cid.ts#L25) Convert a CIDv0 string to a bytes32 hex string for on-chain storage diff --git a/docs/utils/src/functions/cidV0ToUint8Array.md b/docs/utils/src/functions/cidV0ToUint8Array.md index 9440477..6b139c6 100644 --- a/docs/utils/src/functions/cidV0ToUint8Array.md +++ b/docs/utils/src/functions/cidV0ToUint8Array.md @@ -10,7 +10,7 @@ function cidV0ToUint8Array(cidV0): Uint8Array; ``` -Defined in: [packages/utils/src/cid.ts:61](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/cid.ts#L61) +Defined in: [packages/utils/src/cid.ts:61](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/cid.ts#L61) Convert a CIDv0 string to a Uint8Array of the hash digest diff --git a/docs/utils/src/functions/decodeErrorResult.md b/docs/utils/src/functions/decodeErrorResult.md index 0daece6..15b0074 100644 --- a/docs/utils/src/functions/decodeErrorResult.md +++ b/docs/utils/src/functions/decodeErrorResult.md @@ -15,7 +15,7 @@ function decodeErrorResult(config): | null; ``` -Defined in: [packages/utils/src/abi.ts:568](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/abi.ts#L568) +Defined in: [packages/utils/src/abi.ts:568](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/abi.ts#L568) Decode error data from a contract revert diff --git a/docs/utils/src/functions/decodeFunctionResult.md b/docs/utils/src/functions/decodeFunctionResult.md index 81a1875..020099e 100644 --- a/docs/utils/src/functions/decodeFunctionResult.md +++ b/docs/utils/src/functions/decodeFunctionResult.md @@ -10,7 +10,7 @@ function decodeFunctionResult(config): unknown; ``` -Defined in: [packages/utils/src/abi.ts:498](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/abi.ts#L498) +Defined in: [packages/utils/src/abi.ts:498](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/abi.ts#L498) ## Parameters diff --git a/docs/utils/src/functions/encodeFunctionData.md b/docs/utils/src/functions/encodeFunctionData.md index aee6235..52ebf9a 100644 --- a/docs/utils/src/functions/encodeFunctionData.md +++ b/docs/utils/src/functions/encodeFunctionData.md @@ -10,7 +10,7 @@ function encodeFunctionData(config): `0x${string}`; ``` -Defined in: [packages/utils/src/abi.ts:429](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/abi.ts#L429) +Defined in: [packages/utils/src/abi.ts:429](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/abi.ts#L429) ## Parameters diff --git a/docs/utils/src/functions/getErrorMessage.md b/docs/utils/src/functions/getErrorMessage.md index 94015c2..73df7f4 100644 --- a/docs/utils/src/functions/getErrorMessage.md +++ b/docs/utils/src/functions/getErrorMessage.md @@ -10,7 +10,7 @@ function getErrorMessage(error): string; ``` -Defined in: [packages/utils/src/errors.ts:234](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L234) +Defined in: [packages/utils/src/errors.ts:234](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L234) Helper to extract error message safely diff --git a/docs/utils/src/functions/isCirclesError.md b/docs/utils/src/functions/isCirclesError.md index fc9bee9..76186ae 100644 --- a/docs/utils/src/functions/isCirclesError.md +++ b/docs/utils/src/functions/isCirclesError.md @@ -10,7 +10,7 @@ function isCirclesError(error): error is CirclesError; ``` -Defined in: [packages/utils/src/errors.ts:227](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L227) +Defined in: [packages/utils/src/errors.ts:227](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L227) Type guard to check if error is a CirclesError diff --git a/docs/utils/src/functions/parseContractError.md b/docs/utils/src/functions/parseContractError.md index 3995450..da7141a 100644 --- a/docs/utils/src/functions/parseContractError.md +++ b/docs/utils/src/functions/parseContractError.md @@ -12,7 +12,7 @@ function parseContractError(error, abi): | null; ``` -Defined in: [packages/utils/src/contractErrors.ts:153](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/contractErrors.ts#L153) +Defined in: [packages/utils/src/contractErrors.ts:153](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/contractErrors.ts#L153) Parse contract error from a transaction error diff --git a/docs/utils/src/functions/uint256ToAddress.md b/docs/utils/src/functions/uint256ToAddress.md index 4099701..ecbe724 100644 --- a/docs/utils/src/functions/uint256ToAddress.md +++ b/docs/utils/src/functions/uint256ToAddress.md @@ -10,7 +10,7 @@ function uint256ToAddress(uint256): `0x${string}`; ``` -Defined in: [packages/utils/src/address.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/address.ts#L10) +Defined in: [packages/utils/src/address.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/address.ts#L10) Converts a uint256 value to an Ethereum address Takes the last 20 bytes of the uint256 diff --git a/docs/utils/src/functions/wrapError.md b/docs/utils/src/functions/wrapError.md index 459711d..6015b79 100644 --- a/docs/utils/src/functions/wrapError.md +++ b/docs/utils/src/functions/wrapError.md @@ -10,7 +10,7 @@ function wrapError(error, source): CirclesError; ``` -Defined in: [packages/utils/src/errors.ts:198](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L198) +Defined in: [packages/utils/src/errors.ts:198](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L198) Helper to wrap unknown errors into CirclesError diff --git a/docs/utils/src/type-aliases/BaseErrorSource.md b/docs/utils/src/type-aliases/BaseErrorSource.md index 3a5abfd..5ecefc5 100644 --- a/docs/utils/src/type-aliases/BaseErrorSource.md +++ b/docs/utils/src/type-aliases/BaseErrorSource.md @@ -20,7 +20,7 @@ type BaseErrorSource = | "UNKNOWN"; ``` -Defined in: [packages/utils/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L10) +Defined in: [packages/utils/src/errors.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L10) Base error source type Each package exports its own specific ErrorSource diff --git a/docs/utils/src/type-aliases/UtilsErrorSource.md b/docs/utils/src/type-aliases/UtilsErrorSource.md index b9470a1..c88e111 100644 --- a/docs/utils/src/type-aliases/UtilsErrorSource.md +++ b/docs/utils/src/type-aliases/UtilsErrorSource.md @@ -10,6 +10,6 @@ type UtilsErrorSource = "UTILS" | "VALIDATION" | "CONVERSION" | "ENCODING"; ``` -Defined in: [packages/utils/src/errors.ts:25](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/errors.ts#L25) +Defined in: [packages/utils/src/errors.ts:25](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/errors.ts#L25) Utils package error source diff --git a/docs/utils/src/variables/ZERO_ADDRESS.md b/docs/utils/src/variables/ZERO_ADDRESS.md index 2a9dea6..3dcb4e7 100644 --- a/docs/utils/src/variables/ZERO_ADDRESS.md +++ b/docs/utils/src/variables/ZERO_ADDRESS.md @@ -10,6 +10,6 @@ const ZERO_ADDRESS: Address = '0x0000000000000000000000000000000000000000'; ``` -Defined in: [packages/utils/src/constants.ts:10](https://github.com/aboutcircles/sdk-v2/blob/aed3c8bf419f1e90d91722752d3f29c8257367c2/packages/utils/src/constants.ts#L10) +Defined in: [packages/utils/src/constants.ts:10](https://github.com/aboutcircles/sdk-v2/blob/d93c5485243505702cd4737e16431eb294109cdb/packages/utils/src/constants.ts#L10) The zero address (0x0000000000000000000000000000000000000000) diff --git a/typedoc.json b/typedoc.json index 6e0714e..6b0411e 100644 --- a/typedoc.json +++ b/typedoc.json @@ -7,6 +7,7 @@ "packages/runner/src/index.ts", "packages/utils/src/index.ts", "packages/profiles/src/index.ts", + "packages/referrals/src/index.ts", "packages/pathfinder/src/index.ts", "packages/transfers/src/index.ts", "packages/abis/src/index.ts"