@arcanetech/privacy-sdk-stellar 0.2.3 → 0.4.1

package/dist/node.d.ts

@@ -3,8 +3,7 @@ import { OperationKind, DepositIntent, TransferIntent, WithdrawIntent, createRej
 export { isPreparedOperation } from '@arcanetech/privacy-sdk-core';
 import * as _arcanetech_privacy_sdk_core_state from '@arcanetech/privacy-sdk-core/state';
 import { StateBridgeAdapter } from '@arcanetech/privacy-sdk-core/state';
-import { OnboardingPayload } from 'contract';
-import { AuditPublicKey } from '@auditable/privacy-pool-zk-sdk';
+import { ZkCircuitLayoutFields, BundledZkCircuit, AuditPublicKey } from '@arcanetech/stellar-privacy-pool-zk-sdk';
 
 type StellarPrivateRecordStatus = 'pending' | 'finalized' | 'spent';
 interface StellarPrivateCoinNote {
@@ -78,35 +77,6 @@ interface StellarLeafEphemeral {
     yHex: string;
     cachedAt?: string;
 }
-interface StellarPendingClaim {
-    id: string;
-    owner: StellarAddress;
-    asset: StellarAssetId;
-    amount: bigint;
-    createdAt: string;
-    poolTxId?: string;
-    commitmentHex?: string;
-    nullifierHex?: string;
-    futureNullifierHashHex?: string;
-    assetHiHex?: string;
-    assetLoHex?: string;
-    nullifierFieldHex?: string;
-    secretHex?: string;
-    tempPublicKeyXHex?: string;
-    tempPublicKeyYHex?: string;
-    encryptedRecoveryBase64?: string;
-    createdAtLedger?: number;
-}
-interface StellarPendingClaimsPagination {
-    total: number;
-    page: number;
-    pageSize: number;
-    hasMore: boolean;
-}
-interface StellarPendingClaimsState {
-    items: StellarPendingClaim[];
-    pagination?: StellarPendingClaimsPagination;
-}
 interface StellarIncomingDelivery {
     id: number;
     privateAddress: string;
@@ -161,26 +131,15 @@ interface StellarAvailablePrivateRecordsFilter {
     privateAddress?: string;
     asset?: StellarAssetId;
 }
-interface StellarPendingClaimsFilter {
-    owner?: StellarAddress;
-    asset?: StellarAssetId;
-}
 interface StellarIncomingDeliveriesFilter {
     privateAddress: string;
     asset?: StellarAssetId;
     includeProcessed?: boolean;
 }
 
-type KytApplicationIdHints = [string, string, string, string];
+type KytApplicationIdHints = string[];
 
-type StellarPendingClaimSource = {
-    kind: 'pendingClaim';
-    claimId: string;
-} | {
-    kind: 'pendingClaim';
-    claim: StellarPendingClaim;
-};
-type StellarTransferFromAddress = StellarAddress | StellarPendingClaimSource;
+type StellarTransferFromAddress = StellarAddress;
 
 interface PoolMerkleStatePort {
     get(poolContract: string): Promise<StellarPoolMerkleState | undefined>;
@@ -202,33 +161,59 @@ type StellarSignTransaction = (input: {
     signedTxXdr: string;
 }>;
 
+type StellarBundledZkCircuitDefinition = ZkCircuitLayoutFields & {
+    circuit: BundledZkCircuit;
+};
+type StellarCustomZkCircuitDefinition = ZkCircuitLayoutFields & {
+    zkeyUrl: string;
+    circuitGraphUrl: string;
+    r1csUrl: string;
+    provingKeyUrl: string;
+};
+type StellarZkCircuitDefinition = StellarBundledZkCircuitDefinition | StellarCustomZkCircuitDefinition;
+
 interface TransferTemporaryRecipientKey {
     temporaryScalarHex: string;
     temporaryPrivateAddressStpl1: string;
 }
-interface TransferOnboardingRecipientNoteInput {
-    tokenAddress: string;
-    nullifier: string;
-    secret: string;
-    value: string;
+interface TransferEscrowSend {
+    nonceDecimal: string;
+    recipientHi: string;
+    recipientLo: string;
+    recipientStellarAddress: string;
 }
 interface TransferRecipientExecutionContext {
     recipientPrivateAddressStpl1: string;
     recipientStellarAddress?: string;
+    escrowSend?: TransferEscrowSend;
     temporaryRecipientKey?: TransferTemporaryRecipientKey;
 }
-interface BuildTransferOnboardingAtExecuteInput {
-    ownerStellarAddress: string;
-    temporaryRecipientKey: TransferTemporaryRecipientKey;
-    recipientNote: TransferOnboardingRecipientNoteInput;
-}
 interface StellarKytEnvironment {
     apiBaseUrl: string;
     kytPassageRegistryContract: string;
     registerPassageOnChain?: boolean;
+    inspectAuthorization?: string;
 }
 interface StellarTransactEnvironment {
     network: StellarNetworkConfig;
+    /**
+     * Nonce (persistent storage key) of the pool's `ZkConfig` entry this
+     * environment's proofs/circuit shape target. Defaults to `2n` (Commitment
+     * V2, 95 public signals) when omitted. Nonce `0` is the retired 93-signal
+     * layout and must be passed explicitly.
+     */
+    zkConfigNonce?: bigint;
+    /**
+     * Optional nonce-keyed circuit map. Defaults to the SDK bundled 2×2 (nonce 2)
+     * and 6×6 (nonce 6) schemes. URL fields are only for a custom/dev circuit.
+     */
+    zkCircuits?: Record<string, StellarZkCircuitDefinition>;
+    /**
+     * Directory or HTTP prefix for graph / r1cs / proving-key files.
+     * Defaults to the GitHub release for `@arcanetech/stellar-privacy-pool-zk-sdk`.
+     * Staging and local stands override this to serve files from disk.
+     */
+    zkArtifactBaseUrl?: string;
     auditPublicKey?: AuditPublicKey;
     kyt: StellarKytEnvironment;
     signTransaction?: StellarSignTransaction;
@@ -244,7 +229,6 @@ interface StellarTransactEnvironment {
         recipientStellarAddress: string;
         walletPublicKey: string;
     }) => Promise<TransferRecipientExecutionContext>;
-    buildTransferOnboardingAtExecute?: (input: BuildTransferOnboardingAtExecuteInput) => Promise<OnboardingPayload>;
     resolveWalletPublicKey?: () => Promise<string>;
     poolMerkleState?: PoolMerkleStatePort;
     leafEphemeral?: LeafEphemeralStatePort;
@@ -271,16 +255,25 @@ interface StellarSubmissionPayload {
 interface StellarTransactArtifacts {
     proofHex?: string;
     publicHex?: string;
+    ciphertextHex?: string;
+    outputNoteEphemeralScalars?: string[];
     applicationIdsPlaintext?: KytApplicationIdHints;
     tokenAddress?: string;
     depositScalarHex?: string;
     precommitementHex?: string;
     commitmentHex?: string;
     walletPublicKey?: string;
-    onboarding?: OnboardingPayload;
+    escrowRecipient?: string;
+    escrowAuthorization?: string;
+    escrowSend?: boolean;
+    escrowSpendScalarHex?: string;
+    escrowClaimantLimbs?: {
+        recipientHi: string;
+        recipientLo: string;
+        nonceDecimal?: string;
+    };
     executeFinalizeRequired?: boolean;
-    pendingClaim?: StellarPendingClaim;
-    spendSource?: 'privateAddress' | 'pendingClaim';
+    spendSource?: 'privateAddress' | 'escrow';
 }
 interface StellarOperationReceipt {
     operationId: string;
@@ -296,8 +289,6 @@ interface StellarNetworkConfig {
 }
 interface StellarBrowserAssets {
     sdkWasm: ArrayBuffer;
-    circuitWasm: ArrayBuffer;
-    provingKey: ArrayBuffer;
 }
 interface StellarWalletAdapter {
     getAddress(): Promise<StellarAddress>;
@@ -386,22 +377,6 @@ declare function composeStellarStateService(adapter: StateBridgeAdapter): {
     getIncomingDeliveries: (filter: StellarIncomingDeliveriesFilter) => Promise<StellarIncomingDelivery[]>;
     upsertIncomingDeliveries: (deliveries: StellarIncomingDelivery[]) => Promise<void>;
     markDeliveryProcessed(id: number): Promise<void>;
-    getPendingClaims: (filter?: StellarPendingClaimsFilter) => Promise<StellarPendingClaimsState>;
-    getPendingClaimsCount(owner: StellarAddress): Promise<number | undefined>;
-    appendPendingClaims: (claims: StellarPendingClaim[], paginationInfo: StellarPendingClaimsPagination) => Promise<void>;
-    replacePendingClaimsPage: (input: {
-        owner: StellarAddress;
-        claims: StellarPendingClaim[];
-        paginationInfo: StellarPendingClaimsPagination;
-        count?: number;
-    }) => Promise<void>;
-    upsertPendingClaims: (claims: StellarPendingClaim[]) => Promise<void>;
-    removePendingClaims: (ids: string[]) => Promise<void>;
-    clearPendingClaims: (input?: {
-        owner?: StellarAddress;
-        asset?: StellarAssetId;
-    }) => Promise<void>;
-    setPendingClaimsCount: (owner: StellarAddress, count: number) => Promise<void>;
     getLeafEphemeral(input: {
         poolContract: string;
         leafIndex: number;
@@ -498,22 +473,6 @@ declare function composeStellarPrivacyClient(config: ResolvedStellarPrivacyClien
         getIncomingDeliveries: (filter: StellarIncomingDeliveriesFilter) => Promise<StellarIncomingDelivery[]>;
         upsertIncomingDeliveries: (deliveries: StellarIncomingDelivery[]) => Promise<void>;
         markDeliveryProcessed(id: number): Promise<void>;
-        getPendingClaims: (filter?: StellarPendingClaimsFilter) => Promise<StellarPendingClaimsState>;
-        getPendingClaimsCount(owner: StellarAddress): Promise<number | undefined>;
-        appendPendingClaims: (claims: StellarPendingClaim[], paginationInfo: StellarPendingClaimsPagination) => Promise<void>;
-        replacePendingClaimsPage: (input: {
-            owner: StellarAddress;
-            claims: StellarPendingClaim[];
-            paginationInfo: StellarPendingClaimsPagination;
-            count?: number;
-        }) => Promise<void>;
-        upsertPendingClaims: (claims: StellarPendingClaim[]) => Promise<void>;
-        removePendingClaims: (ids: string[]) => Promise<void>;
-        clearPendingClaims: (input?: {
-            owner?: StellarAddress;
-            asset?: StellarAssetId;
-        }) => Promise<void>;
-        setPendingClaimsCount: (owner: StellarAddress, count: number) => Promise<void>;
         getLeafEphemeral(input: {
             poolContract: string;
             leafIndex: number;
@@ -585,6 +544,7 @@ declare function composeStellarPrivacyClient(config: ResolvedStellarPrivacyClien
             poolContractId?: string;
             nullifier: string;
             walletPublicKey: string;
+            privKeyScalarHex: string;
         }) => Promise<{
             spent: boolean;
             nullifierHashHex: string;
@@ -630,18 +590,6 @@ declare function composeStellarPrivacyClient(config: ResolvedStellarPrivacyClien
 };
 type ComposedStellarPrivacyClient = ReturnType<typeof composeStellarPrivacyClient>;
 
-interface LoadPendingClaimsFromBackendInput {
-    backendBaseUrl: string;
-    ownerAddress: StellarAddress;
-    asset?: StellarAssetId;
-    page?: number;
-    pageSize?: number;
-}
-interface LoadPendingClaimsCountFromBackendInput {
-    backendBaseUrl: string;
-    ownerAddress: StellarAddress;
-}
-
 declare function createStateDelegates(state: StellarStateService): {
     getPrivateRecords: () => Promise<StellarPrivateRecord[]>;
     getAvailablePrivateRecords: (filter: Parameters<StellarStateService["getAvailablePrivateRecords"]>[0]) => Promise<StellarPrivateRecord[]>;
@@ -658,16 +606,6 @@ declare function createStateDelegates(state: StellarStateService): {
     markDeliveryProcessed: (id: Parameters<StellarStateService["markDeliveryProcessed"]>[0]) => Promise<void>;
     getDeliverySyncState: (input: Parameters<StellarStateService["getDeliverySyncState"]>[0]) => Promise<StellarDeliverySyncState | undefined>;
     setDeliverySyncState: (syncState: Parameters<StellarStateService["setDeliverySyncState"]>[0]) => Promise<void>;
-    appendPendingClaims: (claims: Parameters<StellarStateService["appendPendingClaims"]>[0], paginationInfo: Parameters<StellarStateService["appendPendingClaims"]>[1]) => Promise<void>;
-    loadPendingClaimsFromBackend: (input: LoadPendingClaimsFromBackendInput) => Promise<void>;
-    loadPendingClaimsCountFromBackend: (input: LoadPendingClaimsCountFromBackendInput) => Promise<void>;
-    replacePendingClaimsPage: (input: Parameters<StellarStateService["replacePendingClaimsPage"]>[0]) => Promise<void>;
-    upsertPendingClaims: (claims: Parameters<StellarStateService["upsertPendingClaims"]>[0]) => Promise<void>;
-    removePendingClaims: (ids: Parameters<StellarStateService["removePendingClaims"]>[0]) => Promise<void>;
-    clearPendingClaims: (input?: Parameters<StellarStateService["clearPendingClaims"]>[0]) => Promise<void>;
-    getPendingClaims: (filter?: Parameters<StellarStateService["getPendingClaims"]>[0]) => Promise<StellarPendingClaimsState>;
-    getPendingClaimsCount: (owner: Parameters<StellarStateService["getPendingClaimsCount"]>[0]) => Promise<number | undefined>;
-    setPendingClaimsCount: (owner: Parameters<StellarStateService["setPendingClaimsCount"]>[0], count: Parameters<StellarStateService["setPendingClaimsCount"]>[1]) => Promise<void>;
     getPoolMerkleState: (poolContract: Parameters<StellarStateService["getPoolMerkleState"]>[0]) => Promise<StellarPoolMerkleState | undefined>;
     setPoolMerkleState: (poolState: Parameters<StellarStateService["setPoolMerkleState"]>[0]) => Promise<void>;
     appendPoolCommitments: (input: Parameters<StellarStateService["appendPoolCommitments"]>[0]) => Promise<void>;
@@ -723,11 +661,10 @@ declare function createStellarPrivacyClientFromResolvedConfig(config: ResolvedSt
 
 interface StellarNodeAssets {
     sdkWasmPath: string;
-    circuitWasmPath: string;
-    provingKeyPath: string;
 }
 interface StellarNodePrivacyClientConfig extends StellarPrivacyClientConfigBase {
     assets: StellarNodeAssets;
+    transactEnvironment?: StellarTransactEnvironment;
 }
 
 type CreateStellarPrivacyClientResult = StellarPrivacyClient | ReturnType<typeof createRejectedOperation>;