@andrewkimjoseph/celina-sdk 0.9.8 → 0.9.9

package/build/src/services/gooddollar.service.d.ts

@@ -0,0 +1,183 @@
+import type { CeloClientFactory } from "../clients/celo-client.js";
+import { type SerializedPreparedFlow } from "../types/prepared.js";
+export type GoodDollarReserveAmountSide = "in" | "out";
+/** Optional parameters for GoodDollar reserve swap prepares. */
+export interface GoodDollarReserveSwapParams {
+    /** Max slippage tolerance in percent (default `0.5`). */
+    slippageTolerance?: number;
+    /** Address receiving output tokens (default: `from`). */
+    recipient?: `0x${string}`;
+    /**
+     * `in` (default): `amount` is token_in spend. `out`: `amount` is desired token_out;
+     * SDK resolves required token_in via MentoBroker `getAmountIn`.
+     */
+    amountSide?: GoodDollarReserveAmountSide;
+}
+export interface GoodDollarReserveQuoteOptions {
+    /** @deprecated Ignored; balance checks run on prepare/estimate only. */
+    from?: `0x${string}`;
+    amountSide?: GoodDollarReserveAmountSide;
+}
+/** GoodDollar IdentityV4 whitelist, reverification, daily UBI claim, and reserve swap preparation. */
+export declare class GoodDollarService {
+    private readonly clientFactory;
+    private readonly tokenService;
+    constructor(clientFactory: CeloClientFactory);
+    private getPublicClient;
+    private resolveWhitelistedRoot;
+    private fetchWhitelistingData;
+    /**
+     * How a wallet links to GoodDollar IdentityV4 (root vs connected account).
+     * @param address - Wallet to inspect
+     */
+    getIdentityLink(address: `0x${string}`): Promise<{
+        address: `0x${string}`;
+        contract: "0xC361A6E67822a0EDc17D899227dd9FC50BD62F42";
+        whitelistedRoot: `0x${string}` | null;
+        isConnectedWallet: boolean;
+        isWhitelistedRoot: boolean;
+        connectedTo: `0x${string}` | null;
+        checkedAddress: `0x${string}`;
+        isWhitelisted: boolean;
+    }>;
+    /**
+     * GoodDollar IdentityV4 whitelist status and reverification progress for a wallet.
+     * Resolves connected wallets via Identity `getWhitelistedRoot`.
+     * @param address - Wallet to check against IdentityV4
+     * @returns On-chain status, whitelist dates, field descriptions, and reverification timeline
+     */
+    getWhitelistingInfo(address: `0x${string}`): Promise<{
+        contract: "0xC361A6E67822a0EDc17D899227dd9FC50BD62F42";
+        isWhitelisted: boolean;
+        status: number;
+        statusLabel: string;
+        whitelistedOn: string | null;
+        lastAuthenticatedOn: string | null;
+        fieldDescriptions: {
+            whitelistedOn: string;
+            lastAuthenticatedOn: string;
+        };
+        reverification: {
+            daysSinceLastAuthentication: number;
+            currentReverificationPeriodDays: number;
+            maxReverificationPeriodDays: number;
+            daysUntilReverificationRequired: number;
+            reverificationRequiredOn: string;
+            reverificationProgressPercent: number;
+            isReverificationOverdue: boolean;
+        } | null;
+        identity: {
+            dateAuthenticated: number;
+            dateAdded: number;
+            did: string;
+            whitelistedOnChainId: number;
+            status: number;
+            authCount: number;
+        };
+        address: `0x${string}`;
+        whitelistedRoot: `0x${string}` | null;
+        isConnectedWallet: boolean;
+        checkedAddress: `0x${string}`;
+    }>;
+    /**
+     * Daily UBI claim eligibility for a wallet against UBISchemeV2 on Celo.
+     * Resolves connected wallets via Identity `getWhitelistedRoot`.
+     */
+    getUbiClaimEligibility(address: `0x${string}`): Promise<{
+        address: `0x${string}`;
+        contract: "0x43d72Ff17701B2DA814620735C39C620Ce0ea4A1";
+        whitelistedRoot: `0x${string}` | null;
+        isConnectedWallet: boolean;
+        isEligibleToClaim: boolean;
+        claimableAmount: string;
+        claimableAmountFormatted: string;
+        alreadyClaimedToday: boolean;
+        inClaimCooldown: boolean;
+        lastClaimedAt: string | null;
+        nextClaimAvailableAt: string;
+        secondsUntilNextClaim: string;
+        nextClaimAvailableIn: string;
+        ubiPeriodDay: string;
+        schemePaused: boolean;
+        schemeStarted: boolean;
+        estimatedDailyUbi: string;
+        estimatedDailyUbiFormatted: string;
+        currentDailyUbi: string;
+        currentDailyUbiFormatted: string;
+        reasons: string[];
+        identity: {
+            checkedAddress: `0x${string}`;
+            isWhitelisted: boolean;
+            statusLabel: string;
+            reverification: {
+                daysSinceLastAuthentication: number;
+                currentReverificationPeriodDays: number;
+                maxReverificationPeriodDays: number;
+                daysUntilReverificationRequired: number;
+                reverificationRequiredOn: string;
+                reverificationProgressPercent: number;
+                isReverificationOverdue: boolean;
+            } | null;
+        };
+    }>;
+    /**
+     * Build an unsigned UBISchemeV2 `claim()` transaction for daily G$ UBI.
+     * Validates whitelist, entitlement, and simulates gas before returning steps.
+     */
+    prepareClaimUbi(from: `0x${string}`): Promise<SerializedPreparedFlow>;
+    private resolveReservePair;
+    private reserveOptions;
+    private baseReserveQuoteFields;
+    private resolveReserveAmount;
+    /**
+     * Expected GoodDollar reserve output for G$ ↔ USDm — no wallet required.
+     * Balance checks run on prepare/estimate only.
+     */
+    getReserveQuote(tokenIn: string, tokenOut: string, amount: string, options?: GoodDollarReserveQuoteOptions): Promise<{
+        protocol: "gooddollar_reserve";
+        network: "mainnet";
+        tokenIn: string;
+        tokenOut: string;
+        amountIn: string;
+        expectedOut: string;
+        amountSide: GoodDollarReserveAmountSide;
+        routeHops: number;
+        broker: "0x88de45906D4F5a57315c133620cfa484cB297541";
+        exchangeProvider: "0x2fFBB49055d487DdBBb0C052Cd7c2a02A7971e41";
+        exchangeId: "0xba77f5c7bb3317643c6d81d1ef3f9913561741d92095f88efa402faf2cbe9124";
+    }>;
+    private buildReserveSwap;
+    private buildReserveApprovalData;
+    private estimateReserveSwapGas;
+    /**
+     * Simulate gas for a GoodDollar reserve swap from `from`, including approval if needed.
+     */
+    estimateReserveSwap(from: `0x${string}`, tokenIn: string, tokenOut: string, amount: string, params?: GoodDollarReserveSwapParams): Promise<{
+        from: `0x${string}`;
+        recipient: `0x${string}`;
+        amountOutMin: string;
+        approvalNeeded: boolean;
+        approvalGas: string | undefined;
+        swapGas: string;
+        totalGas: string;
+        slippageTolerance: number;
+        protocol: "gooddollar_reserve";
+        network: "mainnet";
+        tokenIn: string;
+        tokenOut: string;
+        amountIn: string;
+        expectedOut: string;
+        amountSide: GoodDollarReserveAmountSide;
+        routeHops: number;
+        broker: "0x88de45906D4F5a57315c133620cfa484cB297541";
+        exchangeProvider: "0x2fFBB49055d487DdBBb0C052Cd7c2a02A7971e41";
+        exchangeId: "0xba77f5c7bb3317643c6d81d1ef3f9913561741d92095f88efa402faf2cbe9124";
+    }>;
+    /**
+     * Build unsigned GoodDollar reserve swap steps (approve + swapIn when needed).
+     */
+    prepareReserveSwap(from: `0x${string}`, tokenIn: string, tokenOut: string, amount: string, params?: GoodDollarReserveSwapParams): Promise<SerializedPreparedFlow>;
+    private effectiveAuthCount;
+    private fetchReverifyDaysOptions;
+    private buildReverificationProgress;
+}