@andrewkimjoseph/celina-sdk 0.2.12 → 0.4.0

package/build/services/gooddollar.service.js

@@ -1,6 +1,15 @@
+/**
+ * GoodDollar IdentityV4 whitelist and reverification reads on Celo mainnet.
+ */
+import { concat, encodeFunctionData, formatUnits } from "viem";
 import { goodDollarIdentityAbi } from "../abis/gooddollar-identity.js";
-import { GOODDOLLAR_IDENTITY_ADDRESS } from "../config/gooddollar.js";
+import { ubiSchemeAbi } from "../abis/ubi-scheme.js";
+import { GOODDOLLAR_IDENTITY_ADDRESS, GOODDOLLAR_UBI_SCHEME_ADDRESS, } from "../config/gooddollar.js";
+import { CELINA_DATA_SUFFIX } from "../config/celina-tag.js";
+import { serializePreparedFlow, } from "../types/prepared.js";
 import { formatUnixDate } from "../utils/format-date.js";
+const G_DOLLAR_DECIMALS = 18;
+const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
 const STATUS_LABELS = {
     0: "none",
     1: "whitelisted",
@@ -12,12 +21,18 @@ const LEGACY_AUTH_CUTOFF = 1772697574;
 function statusLabel(status) {
     return STATUS_LABELS[status] ?? "unknown";
 }
+function taggedCalldata(data) {
+    return concat([data, CELINA_DATA_SUFFIX]);
+}
 /** GoodDollar IdentityV4 whitelist status and reverification progress. */
 export class GoodDollarService {
     clientFactory;
     constructor(clientFactory) {
         this.clientFactory = clientFactory;
     }
+    getPublicClient() {
+        return this.clientFactory.getClients().public;
+    }
     /**
      * GoodDollar IdentityV4 whitelist status and reverification progress for a wallet.
      * @param address - Wallet to check against IdentityV4
@@ -84,6 +99,154 @@ export class GoodDollarService {
             },
         };
     }
+    /**
+     * Daily UBI claim eligibility for a wallet against UBISchemeV2 on Celo.
+     * Resolves connected wallets via Identity `getWhitelistedRoot`.
+     */
+    async getUbiClaimEligibility(address) {
+        const client = this.getPublicClient();
+        const ubiContract = GOODDOLLAR_UBI_SCHEME_ADDRESS;
+        const identityContract = GOODDOLLAR_IDENTITY_ADDRESS;
+        const [whitelistedRoot, claimableAmount, schemePaused, periodStart, estimatedDailyUbi, dailyUbi, whitelistingInfo,] = await Promise.all([
+            client.readContract({
+                address: identityContract,
+                abi: goodDollarIdentityAbi,
+                functionName: "getWhitelistedRoot",
+                args: [address],
+            }),
+            client.readContract({
+                address: ubiContract,
+                abi: ubiSchemeAbi,
+                functionName: "checkEntitlement",
+                args: [address],
+            }),
+            client.readContract({
+                address: ubiContract,
+                abi: ubiSchemeAbi,
+                functionName: "paused",
+            }),
+            client.readContract({
+                address: ubiContract,
+                abi: ubiSchemeAbi,
+                functionName: "periodStart",
+            }),
+            client.readContract({
+                address: ubiContract,
+                abi: ubiSchemeAbi,
+                functionName: "estimateNextDailyUBI",
+            }),
+            client.readContract({
+                address: ubiContract,
+                abi: ubiSchemeAbi,
+                functionName: "dailyUbi",
+            }),
+            this.getWhitelistingInfo(address),
+        ]);
+        const root = whitelistedRoot;
+        const claimable = claimableAmount;
+        const nowSec = BigInt(Math.floor(Date.now() / 1000));
+        const schemeStarted = nowSec >= periodStart;
+        let alreadyClaimedToday = false;
+        if (root !== ZERO_ADDRESS) {
+            alreadyClaimedToday = await client.readContract({
+                address: ubiContract,
+                abi: ubiSchemeAbi,
+                functionName: "hasClaimed",
+                args: [root],
+            });
+        }
+        const reasons = [];
+        if (root === ZERO_ADDRESS) {
+            reasons.push("not whitelisted");
+        }
+        if (!whitelistingInfo.isCurrentlyWhitelisted) {
+            if (whitelistingInfo.reverification?.isReverificationOverdue) {
+                reasons.push("reverification overdue");
+            }
+            else if (root !== ZERO_ADDRESS) {
+                reasons.push("identity not currently whitelisted");
+            }
+        }
+        if (schemePaused) {
+            reasons.push("scheme paused");
+        }
+        if (!schemeStarted) {
+            reasons.push("scheme not started");
+        }
+        if (alreadyClaimedToday) {
+            reasons.push("already claimed today");
+        }
+        if (claimable === 0n && !alreadyClaimedToday && root !== ZERO_ADDRESS) {
+            reasons.push("no entitlement available");
+        }
+        const isEligibleToClaim = root !== ZERO_ADDRESS &&
+            !schemePaused &&
+            schemeStarted &&
+            whitelistingInfo.isCurrentlyWhitelisted &&
+            claimable > 0n;
+        return {
+            address,
+            contract: ubiContract,
+            whitelistedRoot: root === ZERO_ADDRESS ? null : root,
+            isConnectedWallet: root !== ZERO_ADDRESS &&
+                root.toLowerCase() !== address.toLowerCase(),
+            isEligibleToClaim,
+            claimableAmount: claimable.toString(),
+            claimableAmountFormatted: claimable > 0n ? `${formatUnits(claimable, G_DOLLAR_DECIMALS)} G$` : "0 G$",
+            alreadyClaimedToday,
+            schemePaused,
+            schemeStarted,
+            estimatedDailyUbi: estimatedDailyUbi.toString(),
+            estimatedDailyUbiFormatted: `${formatUnits(estimatedDailyUbi, G_DOLLAR_DECIMALS)} G$`,
+            currentDailyUbi: dailyUbi.toString(),
+            currentDailyUbiFormatted: `${formatUnits(dailyUbi, G_DOLLAR_DECIMALS)} G$`,
+            reasons: isEligibleToClaim ? [] : reasons,
+            identity: {
+                isCurrentlyWhitelisted: whitelistingInfo.isCurrentlyWhitelisted,
+                statusLabel: whitelistingInfo.statusLabel,
+                reverification: whitelistingInfo.reverification,
+            },
+        };
+    }
+    /**
+     * Build an unsigned UBISchemeV2 `claim()` transaction for daily G$ UBI.
+     * Validates whitelist, entitlement, and simulates gas before returning steps.
+     */
+    async prepareClaimUbi(from) {
+        const eligibility = await this.getUbiClaimEligibility(from);
+        if (!eligibility.isEligibleToClaim) {
+            const detail = eligibility.reasons.length > 0
+                ? eligibility.reasons.join("; ")
+                : "not eligible to claim";
+            throw new Error(`Cannot claim GoodDollar UBI: ${detail}.`);
+        }
+        const publicClient = this.getPublicClient();
+        const claimData = taggedCalldata(encodeFunctionData({
+            abi: ubiSchemeAbi,
+            functionName: "claim",
+        }));
+        await publicClient.estimateContractGas({
+            account: from,
+            address: GOODDOLLAR_UBI_SCHEME_ADDRESS,
+            abi: ubiSchemeAbi,
+            functionName: "claim",
+        });
+        const flow = {
+            network: "mainnet",
+            from,
+            summary: `Claim daily GoodDollar UBI (${eligibility.claimableAmountFormatted})`,
+            steps: [
+                {
+                    kind: "contract",
+                    to: GOODDOLLAR_UBI_SCHEME_ADDRESS,
+                    data: claimData,
+                    value: "0",
+                    description: "Claim daily GoodDollar UBI",
+                },
+            ],
+        };
+        return serializePreparedFlow(flow);
+    }
     effectiveAuthCount(dateAuthenticated, authCount, optionsLength) {
         if (dateAuthenticated < LEGACY_AUTH_CUTOFF) {
             return optionsLength - 1;

package/build/services/gooddollar.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"gooddollar.service.js","sourceRoot":"","sources":["../../src/services/gooddollar.service.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,MAAM,aAAa,GAA2B;IAC5C,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,aAAa;IAChB,CAAC,EAAE,cAAc;IACjB,GAAG,EAAE,aAAa;CACnB,CAAC;AAEF,qFAAqF;AACrF,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAEtC,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;AAC5C,CAAC;AAED,0EAA0E;AAC1E,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,aAAgC;QAAhC,kBAAa,GAAb,aAAa,CAAmB;IAAG,CAAC;IAEjE;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAsB;QAC9C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;QAC3D,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAE7C,MAAM,CACJ,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,mBAAmB,EACpB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpB,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,eAAe;gBAC7B,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,sBAAsB;aACrC,CAAC;YACF,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,QAAQ,CAAC;SAChD,CAAC,CAAC;QAEH,MAAM,CACJ,iBAAiB,EACjB,SAAS,EACT,GAAG,EACH,oBAAoB,EACpB,MAAM,EACN,SAAS,EACV,GAAG,cAAc,CAAC;QAEnB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,oBAAoB,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACvD,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QAEvC,IAAI,+BAA+B,GAAkB,IAAI,CAAC;QAC1D,IAAI,SAAS,KAAK,CAAC,IAAI,oBAAoB,GAAG,CAAC,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClF,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAChD,oBAAoB,EACpB,YAAY,EACZ,mBAAmB,CAAC,MAAM,CAC3B,CAAC;YACF,+BAA+B;gBAC7B,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC;QACpD,CAAC;QAED,MAAM,mBAAmB,GAAG,SAAS,KAAK,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC;QAEhE,MAAM,cAAc,GAClB,SAAS,KAAK,CAAC,IAAI,oBAAoB,GAAG,CAAC,IAAI,+BAA+B,KAAK,IAAI;YACrF,CAAC,CAAC,IAAI,CAAC,2BAA2B,CAC9B,oBAAoB,EACpB,+BAA+B,EAC/B,MAAM,CAAC,2BAA2B,CAAC,CACpC;YACH,CAAC,CAAC,IAAI,CAAC;QAEX,OAAO;YACL,OAAO;YACP,QAAQ;YACR,sBAAsB;YACtB,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC;YACnC,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI;YACxE,mBAAmB,EACjB,oBAAoB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI;YACxE,iBAAiB,EAAE;gBACjB,aAAa,EACX,8DAA8D;gBAChE,mBAAmB,EACjB,wGAAwG;aAC3G;YACD,cAAc;YACd,QAAQ,EAAE;gBACR,iBAAiB,EAAE,oBAAoB;gBACvC,SAAS,EAAE,YAAY;gBACvB,GAAG;gBACH,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,CAAC;gBAClD,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,YAAY;aACxB;SACF,CAAC;IACJ,CAAC;IAEO,kBAAkB,CACxB,iBAAyB,EACzB,SAAiB,EACjB,aAAqB;QAErB,IAAI,iBAAiB,GAAG,kBAAkB,EAAE,CAAC;YAC3C,OAAO,aAAa,GAAG,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,SAAS,IAAI,aAAa,EAAE,CAAC;YAC/B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,MAA6D,EAC7D,QAA4C;QAE5C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;oBACtC,OAAO,EAAE,QAAQ;oBACjB,GAAG,EAAE,qBAAqB;oBAC1B,YAAY,EAAE,qBAAqB;oBACnC,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;iBACtB,CAAC,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM;YACR,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,2BAA2B,CACjC,iBAAyB,EACzB,+BAAuC,EACvC,2BAAmC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,2BAA2B,GAAG,IAAI,CAAC,KAAK,CAC5C,CAAC,MAAM,GAAG,iBAAiB,CAAC,GAAG,KAAK,CACrC,CAAC;QACF,MAAM,+BAA+B,GACnC,+BAA+B,GAAG,2BAA2B,CAAC;QAChE,MAAM,+BAA+B,GACnC,iBAAiB,GAAG,+BAA+B,GAAG,KAAK,CAAC;QAC9D,MAAM,uBAAuB,GAAG,+BAA+B,GAAG,CAAC,CAAC;QACpE,MAAM,6BAA6B,GAAG,IAAI,CAAC,GAAG,CAC5C,GAAG,EACH,IAAI,CAAC,GAAG,CACN,CAAC,EACD,IAAI,CAAC,KAAK,CACR,CAAC,2BAA2B,GAAG,+BAA+B,CAAC;YAC7D,GAAG,CACN,CACF,CACF,CAAC;QAEF,OAAO;YACL,2BAA2B;YAC3B,+BAA+B;YAC/B,2BAA2B;YAC3B,+BAA+B;YAC/B,wBAAwB,EAAE,cAAc,CAAC,+BAA+B,CAAC;YACzE,6BAA6B;YAC7B,uBAAuB;SACxB,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"gooddollar.service.js","sourceRoot":"","sources":["../../src/services/gooddollar.service.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,WAAW,EAAY,MAAM,MAAM,CAAC;AAEzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EACL,2BAA2B,EAC3B,6BAA6B,GAC9B,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAEL,qBAAqB,GAEtB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAEzD,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAC7B,MAAM,YAAY,GAAG,4CAAqD,CAAC;AAE3E,MAAM,aAAa,GAA2B;IAC5C,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,aAAa;IAChB,CAAC,EAAE,cAAc;IACjB,GAAG,EAAE,aAAa;CACnB,CAAC;AAEF,qFAAqF;AACrF,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAEtC,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;AAC5C,CAAC;AAED,SAAS,cAAc,CAAC,IAAS;IAC/B,OAAO,MAAM,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,0EAA0E;AAC1E,MAAM,OAAO,iBAAiB;IACC;IAA7B,YAA6B,aAAgC;QAAhC,kBAAa,GAAb,aAAa,CAAmB;IAAG,CAAC;IAEzD,eAAe;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC,MAAM,CAAC;IAChD,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAsB;QAC9C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,CAAC;QAC3D,MAAM,QAAQ,GAAG,2BAA2B,CAAC;QAE7C,MAAM,CACJ,cAAc,EACd,sBAAsB,EACtB,2BAA2B,EAC3B,mBAAmB,EACpB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpB,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,eAAe;gBAC7B,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,sBAAsB;aACrC,CAAC;YACF,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,QAAQ,CAAC;SAChD,CAAC,CAAC;QAEH,MAAM,CACJ,iBAAiB,EACjB,SAAS,EACT,GAAG,EACH,oBAAoB,EACpB,MAAM,EACN,SAAS,EACV,GAAG,cAAc,CAAC;QAEnB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;QACjC,MAAM,oBAAoB,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;QACvD,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QAEvC,IAAI,+BAA+B,GAAkB,IAAI,CAAC;QAC1D,IAAI,SAAS,KAAK,CAAC,IAAI,oBAAoB,GAAG,CAAC,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClF,MAAM,kBAAkB,GAAG,IAAI,CAAC,kBAAkB,CAChD,oBAAoB,EACpB,YAAY,EACZ,mBAAmB,CAAC,MAAM,CAC3B,CAAC;YACF,+BAA+B;gBAC7B,mBAAmB,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC;QACpD,CAAC;QAED,MAAM,mBAAmB,GAAG,SAAS,KAAK,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC;QAEhE,MAAM,cAAc,GAClB,SAAS,KAAK,CAAC,IAAI,oBAAoB,GAAG,CAAC,IAAI,+BAA+B,KAAK,IAAI;YACrF,CAAC,CAAC,IAAI,CAAC,2BAA2B,CAC9B,oBAAoB,EACpB,+BAA+B,EAC/B,MAAM,CAAC,2BAA2B,CAAC,CACpC;YACH,CAAC,CAAC,IAAI,CAAC;QAEX,OAAO;YACL,OAAO;YACP,QAAQ;YACR,sBAAsB;YACtB,MAAM,EAAE,SAAS;YACjB,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC;YACnC,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI;YACxE,mBAAmB,EACjB,oBAAoB,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,IAAI;YACxE,iBAAiB,EAAE;gBACjB,aAAa,EACX,8DAA8D;gBAChE,mBAAmB,EACjB,wGAAwG;aAC3G;YACD,cAAc;YACd,QAAQ,EAAE;gBACR,iBAAiB,EAAE,oBAAoB;gBACvC,SAAS,EAAE,YAAY;gBACvB,GAAG;gBACH,oBAAoB,EAAE,MAAM,CAAC,oBAAoB,CAAC;gBAClD,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,YAAY;aACxB;SACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,OAAsB;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACtC,MAAM,WAAW,GAAG,6BAA6B,CAAC;QAClD,MAAM,gBAAgB,GAAG,2BAA2B,CAAC;QAErD,MAAM,CACJ,eAAe,EACf,eAAe,EACf,YAAY,EACZ,WAAW,EACX,iBAAiB,EACjB,QAAQ,EACR,gBAAgB,EACjB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACpB,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,gBAAgB;gBACzB,GAAG,EAAE,qBAAqB;gBAC1B,YAAY,EAAE,oBAAoB;gBAClC,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,YAAY;gBACjB,YAAY,EAAE,kBAAkB;gBAChC,IAAI,EAAE,CAAC,OAAO,CAAC;aAChB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,YAAY;gBACjB,YAAY,EAAE,QAAQ;aACvB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,YAAY;gBACjB,YAAY,EAAE,aAAa;aAC5B,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,YAAY;gBACjB,YAAY,EAAE,sBAAsB;aACrC,CAAC;YACF,MAAM,CAAC,YAAY,CAAC;gBAClB,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,YAAY;gBACjB,YAAY,EAAE,UAAU;aACzB,CAAC;YACF,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC;SAClC,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,eAAgC,CAAC;QAC9C,MAAM,SAAS,GAAG,eAAyB,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,MAAM,IAAK,WAAsB,CAAC;QAExD,IAAI,mBAAmB,GAAG,KAAK,CAAC;QAChC,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YAC1B,mBAAmB,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;gBAC9C,OAAO,EAAE,WAAW;gBACpB,GAAG,EAAE,YAAY;gBACjB,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,CAAC,IAAI,CAAC;aACb,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,CAAC;YAC7C,IAAI,gBAAgB,CAAC,cAAc,EAAE,uBAAuB,EAAE,CAAC;gBAC7D,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YACzC,CAAC;iBAAM,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;gBACjC,OAAO,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YACjB,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAChC,CAAC;QACD,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,mBAAmB,EAAE,CAAC;YACxB,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,SAAS,KAAK,EAAE,IAAI,CAAC,mBAAmB,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YACtE,OAAO,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,iBAAiB,GACrB,IAAI,KAAK,YAAY;YACrB,CAAC,YAAY;YACb,aAAa;YACb,gBAAgB,CAAC,sBAAsB;YACvC,SAAS,GAAG,EAAE,CAAC;QAEjB,OAAO;YACL,OAAO;YACP,QAAQ,EAAE,WAAW;YACrB,eAAe,EAAE,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;YACpD,iBAAiB,EACf,IAAI,KAAK,YAAY;gBACrB,IAAI,CAAC,WAAW,EAAE,KAAK,OAAO,CAAC,WAAW,EAAE;YAC9C,iBAAiB;YACjB,eAAe,EAAE,SAAS,CAAC,QAAQ,EAAE;YACrC,wBAAwB,EACtB,SAAS,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM;YAC7E,mBAAmB;YACnB,YAAY;YACZ,aAAa;YACb,iBAAiB,EAAG,iBAA4B,CAAC,QAAQ,EAAE;YAC3D,0BAA0B,EAAE,GAAG,WAAW,CAAC,iBAA2B,EAAE,iBAAiB,CAAC,KAAK;YAC/F,eAAe,EAAG,QAAmB,CAAC,QAAQ,EAAE;YAChD,wBAAwB,EAAE,GAAG,WAAW,CAAC,QAAkB,EAAE,iBAAiB,CAAC,KAAK;YACpF,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO;YACzC,QAAQ,EAAE;gBACR,sBAAsB,EAAE,gBAAgB,CAAC,sBAAsB;gBAC/D,WAAW,EAAE,gBAAgB,CAAC,WAAW;gBACzC,cAAc,EAAE,gBAAgB,CAAC,cAAc;aAChD;SACF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,eAAe,CAAC,IAAmB;QACvC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC5D,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;YACnC,MAAM,MAAM,GACV,WAAW,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;gBAC5B,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;gBAChC,CAAC,CAAC,uBAAuB,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,gCAAgC,MAAM,GAAG,CAAC,CAAC;QAC7D,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,cAAc,CAC9B,kBAAkB,CAAC;YACjB,GAAG,EAAE,YAAY;YACjB,YAAY,EAAE,OAAO;SACtB,CAAC,CACH,CAAC;QAEF,MAAM,YAAY,CAAC,mBAAmB,CAAC;YACrC,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,6BAA6B;YACtC,GAAG,EAAE,YAAY;YACjB,YAAY,EAAE,OAAO;SACtB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAiB;YACzB,OAAO,EAAE,SAAS;YAClB,IAAI;YACJ,OAAO,EAAE,+BAA+B,WAAW,CAAC,wBAAwB,GAAG;YAC/E,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,UAAU;oBAChB,EAAE,EAAE,6BAA6B;oBACjC,IAAI,EAAE,SAAS;oBACf,KAAK,EAAE,GAAG;oBACV,WAAW,EAAE,4BAA4B;iBAC1C;aACF;SACF,CAAC;QAEF,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAEO,kBAAkB,CACxB,iBAAyB,EACzB,SAAiB,EACjB,aAAqB;QAErB,IAAI,iBAAiB,GAAG,kBAAkB,EAAE,CAAC;YAC3C,OAAO,aAAa,GAAG,CAAC,CAAC;QAC3B,CAAC;QACD,IAAI,SAAS,IAAI,aAAa,EAAE,CAAC;YAC/B,OAAO,CAAC,CAAC;QACX,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,MAA6D,EAC7D,QAA4C;QAE5C,MAAM,OAAO,GAAa,EAAE,CAAC;QAC7B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;oBACtC,OAAO,EAAE,QAAQ;oBACjB,GAAG,EAAE,qBAAqB;oBAC1B,YAAY,EAAE,qBAAqB;oBACnC,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;iBACtB,CAAC,CAAC;gBACH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC9B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM;YACR,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,2BAA2B,CACjC,iBAAyB,EACzB,+BAAuC,EACvC,2BAAmC;QAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC7C,MAAM,2BAA2B,GAAG,IAAI,CAAC,KAAK,CAC5C,CAAC,MAAM,GAAG,iBAAiB,CAAC,GAAG,KAAK,CACrC,CAAC;QACF,MAAM,+BAA+B,GACnC,+BAA+B,GAAG,2BAA2B,CAAC;QAChE,MAAM,+BAA+B,GACnC,iBAAiB,GAAG,+BAA+B,GAAG,KAAK,CAAC;QAC9D,MAAM,uBAAuB,GAAG,+BAA+B,GAAG,CAAC,CAAC;QACpE,MAAM,6BAA6B,GAAG,IAAI,CAAC,GAAG,CAC5C,GAAG,EACH,IAAI,CAAC,GAAG,CACN,CAAC,EACD,IAAI,CAAC,KAAK,CACR,CAAC,2BAA2B,GAAG,+BAA+B,CAAC;YAC7D,GAAG,CACN,CACF,CACF,CAAC;QAEF,OAAO;YACL,2BAA2B;YAC3B,+BAA+B;YAC/B,2BAA2B;YAC3B,+BAA+B;YAC/B,wBAAwB,EAAE,cAAc,CAAC,+BAA+B,CAAC;YACzE,6BAA6B;YAC7B,uBAAuB;SACxB,CAAC;IACJ,CAAC;CACF"}

package/build/services/self-session-store.d.ts

@@ -0,0 +1,19 @@
+import type { SelfDeregistrationSession, SelfRefreshSession, SelfRegistrationSession } from "../clients/self-api.js";
+export type SelfSessionKind = "registration" | "refresh" | "deregistration";
+export type StoredSelfSession = {
+    kind: "registration";
+    session: SelfRegistrationSession;
+    createdAt: number;
+} | {
+    kind: "refresh";
+    session: SelfRefreshSession;
+    createdAt: number;
+} | {
+    kind: "deregistration";
+    session: SelfDeregistrationSession;
+    createdAt: number;
+};
+export declare function storeSelfSession(sessionToken: string, entry: StoredSelfSession): void;
+export declare function getSelfSession(sessionToken: string): StoredSelfSession | undefined;
+export declare function deleteSelfSession(sessionToken: string): void;
+export declare function clearSelfSessionsForTests(): void;

package/build/services/self-session-store.js

@@ -0,0 +1,28 @@
+import { SELF_MAX_SESSIONS, SELF_SESSION_TTL_MS } from "../config/self.js";
+const sessions = new Map();
+function pruneExpiredSessions() {
+    const now = Date.now();
+    for (const [key, entry] of sessions) {
+        if (now - entry.createdAt > SELF_SESSION_TTL_MS) {
+            sessions.delete(key);
+        }
+    }
+}
+export function storeSelfSession(sessionToken, entry) {
+    pruneExpiredSessions();
+    if (sessions.size >= SELF_MAX_SESSIONS) {
+        throw new Error("Too many active Self sessions. Wait for existing sessions to expire (10 minutes) or restart the server.");
+    }
+    sessions.set(sessionToken, entry);
+}
+export function getSelfSession(sessionToken) {
+    pruneExpiredSessions();
+    return sessions.get(sessionToken);
+}
+export function deleteSelfSession(sessionToken) {
+    sessions.delete(sessionToken);
+}
+export function clearSelfSessionsForTests() {
+    sessions.clear();
+}
+//# sourceMappingURL=self-session-store.js.map

package/build/services/self-session-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-session-store.js","sourceRoot":"","sources":["../../src/services/self-session-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AA0B3E,MAAM,QAAQ,GAAG,IAAI,GAAG,EAA6B,CAAC;AAEtD,SAAS,oBAAoB;IAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,QAAQ,EAAE,CAAC;QACpC,IAAI,GAAG,GAAG,KAAK,CAAC,SAAS,GAAG,mBAAmB,EAAE,CAAC;YAChD,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,YAAoB,EACpB,KAAwB;IAExB,oBAAoB,EAAE,CAAC;IAEvB,IAAI,QAAQ,CAAC,IAAI,IAAI,iBAAiB,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CACb,yGAAyG,CAC1G,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,YAAoB;IACjD,oBAAoB,EAAE,CAAC;IACvB,OAAO,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,YAAoB;IACpD,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,yBAAyB;IACvC,QAAQ,CAAC,KAAK,EAAE,CAAC;AACnB,CAAC"}

package/build/services/self.service.d.ts

@@ -0,0 +1,241 @@
+import { type Hex } from "viem";
+import type { SelfRegistrationMode } from "../config/self.js";
+import type { SdkConfig } from "../config/sdk-config.js";
+import type { CeloClientFactory } from "../clients/celo-client.js";
+export interface VerifySelfAgentParams {
+    agentAddress: `0x${string}`;
+    requireAge?: 0 | 18 | 21;
+    requireOfac?: boolean;
+    requireSelfProvider?: boolean;
+}
+export interface VerifySelfRequestParams {
+    agentSignature: Hex;
+    agentTimestamp: string;
+    method: string;
+    path: string;
+    body?: string;
+    keytype?: string;
+    agentKey?: Hex;
+}
+export interface RegisterSelfAgentParams {
+    mode?: SelfRegistrationMode;
+    minimumAge?: 0 | 18 | 21;
+    ofac?: boolean;
+    humanAddress?: `0x${string}`;
+    agentName?: string;
+    agentDescription?: string;
+}
+export declare class SelfService {
+    private readonly clientFactory;
+    private readonly config;
+    constructor(clientFactory: CeloClientFactory, config: Pick<SdkConfig, "selfAgentPrivateKey" | "selfApiBase">);
+    private get apiBase();
+    private resolveAgentPrivateKey;
+    private registryClient;
+    private assertProofRefreshEligible;
+    verifyAgent(params: VerifySelfAgentParams): Promise<{
+        verified: boolean;
+        agent_address: `0x${string}`;
+        reason: string;
+        network: "mainnet";
+    } | {
+        verification_strength: string;
+        network: "mainnet";
+        sibling_agent_ids: number[];
+        proof_expires_at: string | null;
+        days_until_expiry: number;
+        is_expiring_soon: boolean;
+        verified: boolean;
+        agent_address: `0x${string}`;
+        agent_id: number;
+        reason: string;
+        credentials: {
+            nationality: string | undefined;
+            older_than: number;
+            ofac_clear: boolean;
+        };
+    } | {
+        verification_strength: string;
+        registered_at: number;
+        agent_count: number;
+        is_proof_fresh: boolean;
+        network: "mainnet";
+        sibling_agent_ids: number[];
+        proof_expires_at: string | null;
+        days_until_expiry: number;
+        is_expiring_soon: boolean;
+        verified: boolean;
+        agent_address: `0x${string}`;
+        agent_id: number;
+        credentials: {
+            nationality: string | undefined;
+            older_than: number;
+            ofac_clear: boolean;
+        };
+        reason?: undefined;
+    }>;
+    lookupAgent(agentId: number): Promise<{
+        is_expired: boolean;
+        network: "mainnet";
+        proof_expires_at: string | null;
+        days_until_expiry: number;
+        is_expiring_soon: boolean;
+        credentialsSummary: string;
+    }>;
+    verifyRequest(params: VerifySelfRequestParams): Promise<{
+        valid: boolean;
+        reason: string;
+        agent_address?: undefined;
+        agent_id?: undefined;
+        agent_count?: undefined;
+        nullifier?: undefined;
+        credentials?: undefined;
+        note?: undefined;
+    } | {
+        valid: boolean;
+        agent_address: `0x${string}`;
+        reason: string;
+        agent_id?: undefined;
+        agent_count?: undefined;
+        nullifier?: undefined;
+        credentials?: undefined;
+        note?: undefined;
+    } | {
+        valid: boolean;
+        agent_address: `0x${string}`;
+        agent_id: number;
+        reason: string;
+        agent_count?: undefined;
+        nullifier?: undefined;
+        credentials?: undefined;
+        note?: undefined;
+    } | {
+        valid: boolean;
+        agent_address: `0x${string}`;
+        agent_id: number;
+        agent_count: number;
+        nullifier: number;
+        credentials: {
+            nationality: string | undefined;
+            older_than: number;
+            ofac_clear: boolean;
+        };
+        note: string;
+        reason?: undefined;
+    }>;
+    private getAgentInfoFromKey;
+    getIdentity(): Promise<{
+        expiry_warning?: string | undefined;
+        is_expired: boolean;
+        sibling_agent_ids: number[];
+        network: "mainnet";
+        proof_expires_at: string | null;
+        days_until_expiry: number;
+        is_expiring_soon: boolean;
+        registered: true;
+        address: `0x${string}`;
+        agentKey: `0x${string}`;
+        agentId: number;
+        isVerified: boolean;
+        nullifier: number;
+        agentCount: number;
+        verificationStrength: string;
+        credentials_summary: string;
+    } | {
+        message: string;
+        registered: false;
+        address: `0x${string}`;
+        network: "mainnet";
+    }>;
+    registerAgent(params?: RegisterSelfAgentParams): Promise<{
+        session_id: string;
+        qr_code_url: string;
+        qr_url: string;
+        deep_link: string;
+        expires_at: string;
+        instructions: string;
+    }>;
+    checkRegistration(sessionId: string): Promise<{
+        status: "deregistered";
+        message: string;
+        proof_expires_at?: undefined;
+        agent_id?: undefined;
+        agent_address?: undefined;
+        private_key_hex?: undefined;
+        tx_hash?: undefined;
+    } | {
+        status: "refreshed";
+        proof_expires_at: string;
+        message: string;
+        agent_id?: undefined;
+        agent_address?: undefined;
+        private_key_hex?: undefined;
+        tx_hash?: undefined;
+    } | {
+        status: "verified";
+        agent_id: number;
+        agent_address: string;
+        private_key_hex: string;
+        tx_hash: string | undefined;
+        message: string;
+        proof_expires_at?: undefined;
+    } | {
+        status: "pending";
+        message: string;
+        proof_expires_at?: undefined;
+        agent_id?: undefined;
+        agent_address?: undefined;
+        private_key_hex?: undefined;
+        tx_hash?: undefined;
+    } | {
+        status: "expired";
+        message: string;
+        proof_expires_at?: undefined;
+        agent_id?: undefined;
+        agent_address?: undefined;
+        private_key_hex?: undefined;
+        tx_hash?: undefined;
+    }>;
+    refreshProof(params?: {
+        agentId?: number;
+    }): Promise<{
+        session_id: string;
+        qr_code_url: string;
+        qr_url: string;
+        deep_link: string;
+        expires_at: string;
+        instructions: string;
+    }>;
+    deregisterAgent(): Promise<{
+        session_id: string;
+        qr_code_url: string;
+        qr_url: string;
+        deep_link: string;
+        expires_at: string;
+        instructions: string;
+    }>;
+    signRequest(params: {
+        method: string;
+        url: string;
+        body?: string;
+    }): Promise<{
+        headers: {
+            "x-self-agent-address": `0x${string}`;
+            "x-self-agent-signature": `0x${string}`;
+            "x-self-agent-timestamp": string;
+        };
+        instructions: string;
+    }>;
+    authenticatedFetch(params: {
+        method: string;
+        url: string;
+        body?: string;
+        contentType?: string;
+    }): Promise<{
+        status: number;
+        body: string;
+        truncated: boolean;
+    }>;
+    /** Reserved for future on-chain Self writes (e.g. metadata updates). */
+    protected taggedCalldata(data: Hex): Hex;
+}