@andrewkimjoseph/celina 0.2.18 → 0.3.0

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

@@ -0,0 +1,250 @@
+import { type Hex } from "viem";
+import type { SelfRegistrationMode } from "../config/self.js";
+import type { CeloClientFactory } from "../clients/celo-client.js";
+export interface SelfAgentKeyParams {
+    encryptedSelfAgentPrivateKey?: string;
+}
+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 envSelfAgentPrivateKey?;
+    constructor(clientFactory: CeloClientFactory, envSelfAgentPrivateKey?: `0x${string}` | undefined);
+    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(params?: SelfAgentKeyParams): 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;
+        agent_address: string;
+        qr_url: string;
+        deep_link: string;
+        expires_at: string;
+        instructions: string;
+        next_step: 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: SelfAgentKeyParams & {
+        agentId?: number;
+    }): Promise<{
+        next_step: string;
+        is_expired: boolean;
+        is_proof_fresh: false;
+        proof_expires_at: string | null;
+        days_until_expiry: number;
+        is_expiring_soon: boolean;
+        session_id: string;
+        agent_id: number;
+        qr_url: string;
+        deep_link: string;
+        expires_at: string;
+        instructions: string;
+    }>;
+    deregisterAgent(params?: SelfAgentKeyParams): Promise<{
+        session_id: string;
+        qr_url: string;
+        deep_link: string;
+        expires_at: string;
+        instructions: string;
+        warning: string;
+        next_step: string;
+    }>;
+    signRequest(params: SelfAgentKeyParams & {
+        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: SelfAgentKeyParams & {
+        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;
+}