@obscura-fhe/sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,488 @@
+import * as viem from 'viem';
+import { Address, PublicClient, Hex } from 'viem';
+
+/** Arbitrum Sepolia deployment snapshot — sync from contracts-hardhat/deployments/arb-sepolia.json */
+interface ObscuraAddresses {
+    ocUSDC_Pay: Address;
+    ObscuraPay: Address;
+    ObscuraPayStreamV3: Address;
+    ObscuraConfidentialEscrow: Address;
+    ObscuraInvoice: Address;
+    ObscuraStealthRegistry: Address;
+    ObscuraVote: Address;
+    ObscuraTreasury: Address;
+    ObscuraRewards: Address;
+    ObscuraCreditFactory: Address;
+    ObscuraCreditOracle: Address;
+    ObscuraCreditIRM: Address;
+    ObscuraCreditAuction: Address;
+    ObscuraCreditScoreV2: Address;
+    CreditCanonicalPayOcUSDCMarket: Address;
+    v2_ConservativeVault: Address;
+    v2_BalancedVault: Address;
+    ObscuraGovernor: Address;
+    ObscuraTimelock: Address;
+}
+declare const ARBITRUM_SEPOLIA_CHAIN_ID = 421614;
+declare const DEFAULT_RPC_URL = "https://sepolia-rollup.arbitrum.io/rpc";
+declare const DEFAULT_API_URL = "https://obscura-api-n62v.onrender.com";
+declare const DEFAULT_SUPABASE_URL = "https://quoovjkjwgtdqwdofubh.supabase.co";
+declare const DEFAULT_ADDRESSES: ObscuraAddresses;
+
+type ReputationTier = "new" | "active" | "steady" | "reliable";
+type ReputationSourceApp = "all" | "pay" | "credit" | "vote";
+interface ReputationSignalSummary {
+    label: string;
+    count: number;
+    cappedWeight: number;
+    latestAt: string | null;
+}
+interface ReputationSummary {
+    wallet: Address;
+    sourceApp: ReputationSourceApp;
+    totalCappedWeight: number;
+    tier: ReputationTier;
+    signals: Record<string, ReputationSignalSummary>;
+    sources?: Record<string, number>;
+    updatedAt: string | null;
+}
+interface NotificationPrefs {
+    wallet: Address;
+    push_enabled: boolean;
+    email_enabled: boolean;
+    email?: string;
+    events: string[];
+}
+interface PushSubscriptionJSON {
+    endpoint: string;
+    expirationTime?: number | null;
+    keys: {
+        p256dh: string;
+        auth: string;
+    };
+}
+type ActivityEventType = "all" | "sent" | "received" | "stream" | "invoice" | "escrow" | "stealth" | "credit" | "vote";
+interface ActivityItem {
+    id: number;
+    chain_id: number;
+    block_number: string;
+    tx_hash: string;
+    log_index: number;
+    contract_address: string;
+    event_name: string;
+    wallet: string;
+    participants: string[];
+    args: Record<string, unknown>;
+    created_at: string;
+}
+interface ActivityListOptions {
+    filter?: ActivityEventType;
+    page?: number;
+    pageSize?: number;
+}
+interface ActivityListResult {
+    items: ActivityItem[];
+    page: number;
+    pageSize: number;
+    hasMore: boolean;
+}
+/** FHE encrypted uint64 input tuple for contract calls */
+interface InEuint64 {
+    ctHash: bigint;
+    securityZone: number;
+    utype: number;
+    signature: `0x${string}`;
+}
+interface ContractCall {
+    address: Address;
+    abi: readonly unknown[];
+    functionName: string;
+    args: readonly unknown[];
+    chainId: number;
+}
+interface ProposalState {
+    id: bigint;
+    creator: Address;
+    title: string;
+    description: string;
+    options: string[];
+    startTime: bigint;
+    endTime: bigint;
+    finalized: boolean;
+    winningOption: bigint;
+}
+interface ObscuraSDKConfig {
+    chainId?: number;
+    rpcUrl?: string;
+    apiUrl?: string;
+    supabaseUrl?: string;
+    supabaseAnonKey?: string;
+    addresses?: Partial<ObscuraAddresses>;
+    publicClient?: viem.PublicClient;
+    walletClient?: viem.WalletClient;
+    fhe?: FheProvider;
+}
+
+interface FheEncryptOptions {
+    contractAddress: Address;
+    onStep?: (step: string) => void;
+}
+/** Injectable FHE adapter — host supplies @cofhe/sdk or custom implementation */
+interface FheProvider {
+    encryptUint64(value: bigint, options: FheEncryptOptions): Promise<InEuint64>;
+    decryptCtHash?(ctHash: bigint, contractAddress: Address): Promise<bigint>;
+}
+declare class FheRequiredError extends Error {
+    constructor(operation: string);
+}
+
+declare const ACTIVITY_EVENT_FILTERS: Record<ActivityEventType, readonly string[]>;
+type ActivityEventFilterMap = typeof ACTIVITY_EVENT_FILTERS;
+
+declare class ActivityModule {
+    private readonly client;
+    constructor(supabaseUrl: string | undefined, supabaseAnonKey: string | undefined);
+    getEventFilters(): ActivityEventFilterMap;
+    listForWallet(wallet: Address, options?: ActivityListOptions): Promise<ActivityListResult>;
+}
+
+interface CreditModuleDeps {
+    chainId: number;
+    addresses: ObscuraAddresses;
+    fhe?: FheProvider;
+}
+declare class CreditModule {
+    private readonly deps;
+    constructor(deps: CreditModuleDeps);
+    getMarketAddress(override?: Address): Address;
+    buildSupplyCollateral(amount: bigint, encryptedAmount?: InEuint64, marketAddress?: Address): Promise<ContractCall>;
+    buildBorrow(amount: bigint, encryptedAmount?: InEuint64, marketAddress?: Address): Promise<ContractCall>;
+    buildRepay(amount: bigint, encryptedAmount?: InEuint64, marketAddress?: Address): Promise<ContractCall>;
+}
+
+declare class HttpClient {
+    private readonly baseUrl;
+    constructor(baseUrl: string);
+    get url(): string;
+    get<T>(path: string, init?: RequestInit): Promise<T>;
+    post<T>(path: string, body: unknown, init?: RequestInit): Promise<T>;
+    delete<T>(path: string, body?: unknown, init?: RequestInit): Promise<T>;
+}
+declare class HttpError extends Error {
+    readonly status: number;
+    constructor(status: number, message: string);
+}
+
+declare class NotificationsModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    getVapidPublicKey(): Promise<string>;
+    getPrefs(wallet: Address): Promise<NotificationPrefs | null>;
+    savePrefs(prefs: NotificationPrefs): Promise<void>;
+    subscribe(wallet: Address, subscription: PushSubscriptionJSON): Promise<void>;
+    unsubscribe(wallet: Address): Promise<void>;
+}
+
+interface PayModuleDeps {
+    chainId: number;
+    addresses: ObscuraAddresses;
+    publicClient: PublicClient;
+    fhe?: FheProvider;
+}
+declare class PayModule {
+    private readonly deps;
+    constructor(deps: PayModuleDeps);
+    get ocUsdcAddress(): Address;
+    /** Returns encrypted balance ctHash (uint256) for account */
+    getShieldedBalance(account: Address): Promise<bigint>;
+    buildShield(amount: bigint, encryptedAmount?: InEuint64): Promise<ContractCall>;
+    buildUnshield(to: Address, amount: bigint, encryptedAmount?: InEuint64): Promise<ContractCall>;
+    buildTransfer(to: Address, amount: bigint, encryptedAmount?: InEuint64): Promise<ContractCall>;
+}
+
+declare class ReputationModule {
+    private readonly http;
+    constructor(http: HttpClient);
+    getSummary(wallet: Address): Promise<ReputationSummary>;
+}
+
+interface VoteModuleDeps {
+    chainId: number;
+    addresses: ObscuraAddresses;
+    publicClient: PublicClient;
+    fhe?: FheProvider;
+}
+declare class VoteModule {
+    private readonly deps;
+    constructor(deps: VoteModuleDeps);
+    get voteAddress(): Address;
+    getProposalCount(): Promise<bigint>;
+    getProposal(id: bigint): Promise<ProposalState>;
+    buildCastVote(proposalId: bigint, optionIndex: number, encryptedOption?: InEuint64): Promise<ContractCall>;
+    buildDelegate(delegatee: Address): ContractCall;
+}
+
+declare class ObscuraSDK {
+    readonly chainId: number;
+    readonly addresses: ObscuraAddresses;
+    readonly publicClient: PublicClient;
+    readonly fhe?: FheProvider;
+    readonly pay: PayModule;
+    readonly credit: CreditModule;
+    readonly vote: VoteModule;
+    readonly reputation: ReputationModule;
+    readonly activity: ActivityModule;
+    readonly notifications: NotificationsModule;
+    private readonly walletClient?;
+    private constructor();
+    static create(config?: ObscuraSDKConfig): ObscuraSDK;
+    encodeCall(call: ContractCall): Hex;
+    sendCall(call: ContractCall, account: Address): Promise<Hex>;
+}
+
+declare function createDefaultPublicClient(rpcUrl: string, chainId: number): PublicClient;
+declare function encodeCall(call: ContractCall): Hex;
+
+/** Serialize InEuint64 for viem contract args (bigint ctHash) */
+declare function toContractInEuint64(input: InEuint64): {
+    ctHash: bigint;
+    securityZone: number;
+    utype: number;
+    signature: `0x${string}`;
+};
+declare function normalizeWallet(wallet: string): Address | null;
+
+declare const OC_USDC_PAY_ABI: readonly [{
+    readonly name: "confidentialBalanceOf";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "shield";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint256";
+    }, {
+        readonly name: "encryptedAmount";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "unshield";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "encryptedAmount";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "confidentialTransfer";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "encryptedAmount";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}];
+declare const CREDIT_MARKET_ABI: readonly [{
+    readonly name: "supplyCollateral";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "encryptedAmount";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "borrow";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "encryptedAmount";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "repay";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "encryptedAmount";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}];
+declare const OBSCURA_VOTE_ABI: readonly [{
+    readonly name: "proposalCount";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "getProposal";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [{
+        readonly name: "proposalId";
+        readonly type: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "creator";
+        readonly type: "address";
+    }, {
+        readonly name: "title";
+        readonly type: "string";
+    }, {
+        readonly name: "description";
+        readonly type: "string";
+    }, {
+        readonly name: "options";
+        readonly type: "string[]";
+    }, {
+        readonly name: "startTime";
+        readonly type: "uint256";
+    }, {
+        readonly name: "endTime";
+        readonly type: "uint256";
+    }, {
+        readonly name: "finalized";
+        readonly type: "bool";
+    }, {
+        readonly name: "winningOption";
+        readonly type: "uint256";
+    }];
+}, {
+    readonly name: "castVote";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "proposalId";
+        readonly type: "uint256";
+    }, {
+        readonly name: "encryptedOption";
+        readonly type: "tuple";
+        readonly components: readonly [{
+            readonly name: "ctHash";
+            readonly type: "uint256";
+        }, {
+            readonly name: "securityZone";
+            readonly type: "uint8";
+        }, {
+            readonly name: "utype";
+            readonly type: "uint8";
+        }, {
+            readonly name: "signature";
+            readonly type: "bytes";
+        }];
+    }];
+    readonly outputs: readonly [];
+}, {
+    readonly name: "delegate";
+    readonly type: "function";
+    readonly stateMutability: "nonpayable";
+    readonly inputs: readonly [{
+        readonly name: "delegatee";
+        readonly type: "address";
+    }];
+    readonly outputs: readonly [];
+}];
+
+export { ACTIVITY_EVENT_FILTERS, ARBITRUM_SEPOLIA_CHAIN_ID, type ActivityEventFilterMap, type ActivityEventType, type ActivityItem, type ActivityListOptions, type ActivityListResult, ActivityModule, CREDIT_MARKET_ABI, type ContractCall, CreditModule, DEFAULT_ADDRESSES, DEFAULT_API_URL, DEFAULT_RPC_URL, DEFAULT_SUPABASE_URL, type FheEncryptOptions, type FheProvider, FheRequiredError, HttpError, type InEuint64, type NotificationPrefs, NotificationsModule, OBSCURA_VOTE_ABI, OC_USDC_PAY_ABI, type ObscuraAddresses, ObscuraSDK, type ObscuraSDKConfig, PayModule, type ProposalState, type PushSubscriptionJSON, ReputationModule, type ReputationSignalSummary, type ReputationSourceApp, type ReputationSummary, type ReputationTier, VoteModule, createDefaultPublicClient, encodeCall, normalizeWallet, toContractInEuint64 };