@arcanetech/privacy-sdk-stellar 0.5.2 → 0.6.1

package/dist/testing/index.d.ts

@@ -74,6 +74,7 @@ interface StellarTransactArtifacts {
     };
     executeFinalizeRequired?: boolean;
     spendSource?: 'privateAddress' | 'escrow';
+    zkConfigNonce?: bigint;
 }
 interface StellarOperationReceipt {
     operationId: string;

package/dist/transact/index.d.ts

@@ -29,6 +29,11 @@ interface StellarPrivateCoinNote {
     asset_lo: string;
     application_id?: string;
 }
+interface StellarLeanImtNode {
+    level: number;
+    index: number;
+    value: string;
+}
 interface StellarPoolMerkleState {
     poolContract: string;
     commitments: string[];
@@ -36,6 +41,7 @@ interface StellarPoolMerkleState {
     merkleRootHex: string;
     updatedAt: number;
     syncedLedger?: number;
+    nodes?: StellarLeanImtNode[];
 }
 interface StellarLeafEphemeral {
     poolContract: string;
@@ -100,6 +106,12 @@ interface LeafEphemeralStatePort {
     }): Promise<StellarLeafEphemeral | undefined>;
     set(ephemeral: StellarLeafEphemeral): Promise<void>;
 }
+interface CachedPoolMerkleView {
+    commitments: string[];
+    updatedAt: number;
+    merkleRootHex?: string;
+    nodes?: StellarLeanImtNode[];
+}
 
 type StellarSignTransaction = (input: {
     xdr: string;
@@ -232,6 +244,7 @@ interface StellarTransactArtifacts {
     };
     executeFinalizeRequired?: boolean;
     spendSource?: 'privateAddress' | 'escrow';
+    zkConfigNonce?: bigint;
 }
 interface StellarNetworkConfig {
     id: string;
@@ -245,6 +258,17 @@ interface StellarBrowserAssets {
     sdkWasm: ArrayBuffer;
 }
 
+type FeeOutputSpec = {
+    requiredFee: bigint;
+    feeCollectorPrivateAddress: string;
+};
+
+type FeeOutputKindInput = {
+    kind: OperationKind;
+    spendSource?: StellarTransactArtifacts['spendSource'];
+    escrowSend?: boolean;
+};
+
 declare class PrivacyPoolService {
     private readonly assets?;
     private readonly applicationId?;
@@ -252,11 +276,12 @@ declare class PrivacyPoolService {
     private readonly zkCircuits?;
     private readonly zkConfigNonce?;
     private readonly zkArtifactBaseUrl?;
-    private sdk;
-    private initPromise;
+    private readonly sdks;
+    private readonly initPromises;
     constructor(assets?: StellarBrowserAssets | undefined, applicationId?: string | undefined, auditPublicKey?: [string, string] | undefined, zkCircuits?: Record<string, StellarZkCircuitDefinition> | undefined, zkConfigNonce?: bigint | undefined, zkArtifactBaseUrl?: string | undefined);
-    private ensureInit;
-    getInitializedSdk(): Promise<PrivacyPoolSDK>;
+    getInitializedSdk(nonce?: bigint): Promise<PrivacyPoolSDK>;
+    feeBearingZkConfigNonce(input: FeeOutputKindInput): bigint;
+    private initializeSdk;
     getAuditPublicKey(): [string, string] | undefined;
     getApplicationId(): string;
     generatePrivateAddressFromStellarSignature(signature: string, domain: SpendScalarDomain): Promise<string>;
@@ -280,6 +305,8 @@ declare class PrivacyPoolService {
         depositScalarHex: string;
         merkleRootBytes: Buffer$1;
         tokenAddress: string;
+        publicDepositStroops?: bigint;
+        feeOutput?: FeeOutputSpec;
     }): Promise<ProofResult>;
     calculateNullifierHash(nullifier: string, privKeyScalar: string): Promise<string>;
     prepareWithdrawTransactProof(parameters: {
@@ -291,6 +318,7 @@ declare class PrivacyPoolService {
         withdrawAmountStroops: bigint;
         changePrivateAddressStpl1: string | undefined;
         tokenAddress: string;
+        feeOutput?: FeeOutputSpec;
     }): Promise<ProofWithChange>;
     prepareWithdrawTransactProofDual(parameters: {
         coinA: CoinData;
@@ -303,6 +331,7 @@ declare class PrivacyPoolService {
         withdrawAmountStroops: bigint;
         changePrivateAddressStpl1: string | undefined;
         tokenAddress: string;
+        feeOutput?: FeeOutputSpec;
     }): Promise<ProofWithChange>;
 }
 
@@ -435,7 +464,9 @@ declare function loadDefaultStellarBrowserAssets(options?: {
 
 declare const STANDARD_ZK_CONFIG_NONCE = 0n;
 declare const COMMITMENT_V2_ZK_NONCE = 2n;
+declare const BINDING_ZK_NONCE = 3n;
 declare const SIX_BY_SIX_ZK_NONCE = 6n;
+declare const SIX_BY_SIX_BINDING_ZK_NONCE = 7n;
 declare const DEFAULT_ZK_CONFIG_NONCE = 3n;
 declare function resolveZkConfigNonce(transactEnvironment: StellarTransactEnvironment): bigint;
 
@@ -483,6 +514,7 @@ interface SubmitSorobanConfidentialTransferInput {
     ciphertextHex?: string;
     outputNoteEphemeralScalars?: string[];
     applicationIdsPlaintext?: KytApplicationIdHints;
+    zkConfigNonce?: bigint;
     networkPassphrase: string;
     sorobanRpcUrl: string;
     transactEnvironment: StellarTransactEnvironment;
@@ -512,6 +544,7 @@ type PrepareConfidentialTransferProofDualParameters = {
     tokenAddress: string;
     escrowSend?: TransferEscrowSend;
     escrowClaimantLimbs?: TransferEscrowClaimantLimbs;
+    feeOutput?: FeeOutputSpec;
 };
 type PrepareConfidentialTransferProofDualResult = {
     proof_hex: string;
@@ -535,6 +568,7 @@ type PrepareConfidentialTransferProofParameters = {
     tokenAddress: string;
     escrowSend?: TransferEscrowSend;
     escrowClaimantLimbs?: TransferEscrowClaimantLimbs;
+    feeOutput?: FeeOutputSpec;
 };
 type PrepareConfidentialTransferProofResult = {
     proof_hex: string;
@@ -552,7 +586,16 @@ interface FetchContractMerkleResult {
     commitments: string[];
     merkleRootHex: string;
     updatedAt: number;
+    nodes?: StellarLeanImtNode[];
 }
+declare function persistFetchedMerkleState(input: {
+    poolContractId: string;
+    commitments: string[];
+    merkleRootHex: string;
+    cachedState: CachedPoolMerkleView | undefined;
+    poolMerkleState?: PoolMerkleStatePort;
+}): Promise<FetchContractMerkleResult>;
+
 /**
  * Loads pool Merkle leaves without `get_commitments()`. That helper walks the
  * whole tree in one simulate and exceeds the Soroban host budget on a live
@@ -564,7 +607,7 @@ declare function fetchAndMergeMerkleState(parameters: {
     walletPublicKey: string;
     transactEnvironment: StellarTransactEnvironment;
     poolMerkleState?: PoolMerkleStatePort;
-}): Promise<FetchContractMerkleResult>;
+}): Promise<Awaited<ReturnType<typeof persistFetchedMerkleState>>>;
 declare function readLeafEphemeralHex(parameters: {
     poolContractId: string;
     walletPublicKey: string;
@@ -593,6 +636,7 @@ interface RequestKytPassageForPoolInteractionInput {
     outputNoteEphemeralScalars?: string[];
     decryptedAuditSlots?: DecryptedKytAuditSlot[];
     applicationIdsPlaintext?: KytApplicationIdHints;
+    zkConfigNonce?: bigint;
     networkPassphrase: string;
     sorobanRpcUrl: string;
     transactEnvironment: StellarTransactEnvironment;
@@ -710,4 +754,4 @@ declare function isEscrowPreparedOperation(prepared: StellarPreparedOperation):
 declare function evaluateRequiredSubmissionMethod(prepared: StellarPreparedOperation, zkConfigNonce?: bigint): RequiredSubmissionMethodResult;
 declare function requiredSubmissionMethod(prepared: StellarPreparedOperation, zkConfigNonce?: bigint): SubmissionMethod;
 
-export { type AlignedDepositSlot, type BlindedRecipientTagChallengeFields, COMMITMENT_V2_ZK_NONCE, DEFAULT_STELLAR_ZK_CIRCUITS, DEFAULT_ZK_CONFIG_NONCE, ESCROW_SUBMISSION_REFUSAL, type EscrowOutputNoteCiphertextEvent, type EscrowSubmissionRefusal, EscrowSubmissionRefusedError, type KytApplicationIdHints, KytInspectError, type LoadBrowserAssetsInput, MIN_CONFIDENTIAL_TRANSFER_STROOPS, type PrepareRelayTransactPackageFromPreparedInput, type PrepareRelayTransactPackageInput, PrivacyPoolService, type ProofResult, type ProofWithChange, RELAY_SIGNAL_INDEX_ESCROW_RECIPIENT_HI, RELAY_SIGNAL_INDEX_ESCROW_RECIPIENT_LO, RELAY_SIGNAL_INDEX_NULLIFIER_0, RELAY_SIGNAL_INDEX_NULLIFIER_1, RELAY_SIGNAL_INDEX_PUBLIC_DEPOSIT, RELAY_SIGNAL_INDEX_PUBLIC_DEPOSIT_ASSET_HI, RELAY_SIGNAL_INDEX_PUBLIC_DEPOSIT_ASSET_LO, RELAY_SIGNAL_INDEX_PUBLIC_WITHDRAWAL, RELAY_SIGNAL_INDEX_PUBLIC_WITHDRAWAL_ASSET_HI, RELAY_SIGNAL_INDEX_PUBLIC_WITHDRAWAL_ASSET_LO, RELAY_SIGNAL_INDEX_STATE_ROOT, RELAY_SIGNAL_INDEX_WITHDRAW_ADDRESS_HI, RELAY_SIGNAL_INDEX_WITHDRAW_ADDRESS_LO, RELAY_TRANSACT_FIELD_BYTES, RELAY_TRANSACT_PACKAGE_VERSION_V1, RELAY_TRANSACT_SIGNAL_PREFIX_BYTES, RELAY_TRANSACT_SUPPORTED_SIGNAL_COUNT, type ReconstructedEscrowNote, type RelayKeyVersionHints, type RelayTransactPackageV1, type RelayTransactPackageVersion, type RelayTransactPublicLegContext, type RelayTransactSupportedProfile, type RequestKytPassageForPoolInteractionInput, type RequiredSubmissionMethodResult, SIX_BY_SIX_ZK_NONCE, STANDARD_ZK_CONFIG_NONCE, SUBMISSION_METHOD, type StellarBundledZkCircuitDefinition, type StellarCustomZkCircuitDefinition, type StellarKytEnvironment, type StellarTransactEnvironment, type StellarZkCircuitDefinition, type SubmissionMethod, type TransferEscrowClaimantLimbs, type TransferEscrowSend, type TransferRecipientExecutionContext, type TransferTemporaryRecipientKey, ZERO_STROOPS, assertEscrowSweepClaimant, assetLegToTokenAddress, attachEscrowAuthorization, attachPoolStatePorts, buildBlindedRecipientTagChallengeMessage, buildPoolTransactionAuditParameters, buildPrivateAddressSignMessage, configurePrivacyPoolService, createPrivacyPoolService, decodePrivateAddress, deriveEscrowRecipientFromStellarAddress, encodePrivateAddress, encodePrivateAddressFromHexCoordinates, evaluateRequiredSubmissionMethod, fetchAndMergeMerkleState, fetchEscrowOutputNoteEvents, finalizeSpendOperationAtExecute, frDecimalToPaddedBytes32, generateRandomDepositScalarHex, generateTemporaryRecipientPrivateAddress, getPrivacyPoolService, isEscrowPreparedOperation, loadDefaultStellarBrowserAssets, loadStellarBrowserAssets, optionalZkArtifactBaseUrl, parseAuditPublicKeyFromEnvHex, parseKytReasonCode, prepareConfidentialTransferProof, prepareConfidentialTransferProofDual, prepareEscrowSweepOperation, prepareRelayTransactPackage, prepareRelayTransactPackageFromPrepared, privateAddressSdk, readLeafEphemeralHex, readRelayTransactSupportedProfile, recipientPublicKeysDecimalFromPrivateAddress, reconstructEscrowNote, requestKytPassageForPoolInteraction, requiredSubmissionMethod, resolvePoolApplicationId, resolveZkConfigNonce, runTtlPreflight, submitSorobanConfidentialTransfer, submitSorobanDeposit, tokenAddressToAssetLeg, unsignedEscrowAuthorizationForSweep };
+export { type AlignedDepositSlot, BINDING_ZK_NONCE, type BlindedRecipientTagChallengeFields, COMMITMENT_V2_ZK_NONCE, DEFAULT_STELLAR_ZK_CIRCUITS, DEFAULT_ZK_CONFIG_NONCE, ESCROW_SUBMISSION_REFUSAL, type EscrowOutputNoteCiphertextEvent, type EscrowSubmissionRefusal, EscrowSubmissionRefusedError, type KytApplicationIdHints, KytInspectError, type LoadBrowserAssetsInput, MIN_CONFIDENTIAL_TRANSFER_STROOPS, type PrepareRelayTransactPackageFromPreparedInput, type PrepareRelayTransactPackageInput, PrivacyPoolService, type ProofResult, type ProofWithChange, RELAY_SIGNAL_INDEX_ESCROW_RECIPIENT_HI, RELAY_SIGNAL_INDEX_ESCROW_RECIPIENT_LO, RELAY_SIGNAL_INDEX_NULLIFIER_0, RELAY_SIGNAL_INDEX_NULLIFIER_1, RELAY_SIGNAL_INDEX_PUBLIC_DEPOSIT, RELAY_SIGNAL_INDEX_PUBLIC_DEPOSIT_ASSET_HI, RELAY_SIGNAL_INDEX_PUBLIC_DEPOSIT_ASSET_LO, RELAY_SIGNAL_INDEX_PUBLIC_WITHDRAWAL, RELAY_SIGNAL_INDEX_PUBLIC_WITHDRAWAL_ASSET_HI, RELAY_SIGNAL_INDEX_PUBLIC_WITHDRAWAL_ASSET_LO, RELAY_SIGNAL_INDEX_STATE_ROOT, RELAY_SIGNAL_INDEX_WITHDRAW_ADDRESS_HI, RELAY_SIGNAL_INDEX_WITHDRAW_ADDRESS_LO, RELAY_TRANSACT_FIELD_BYTES, RELAY_TRANSACT_PACKAGE_VERSION_V1, RELAY_TRANSACT_SIGNAL_PREFIX_BYTES, RELAY_TRANSACT_SUPPORTED_SIGNAL_COUNT, type ReconstructedEscrowNote, type RelayKeyVersionHints, type RelayTransactPackageV1, type RelayTransactPackageVersion, type RelayTransactPublicLegContext, type RelayTransactSupportedProfile, type RequestKytPassageForPoolInteractionInput, type RequiredSubmissionMethodResult, SIX_BY_SIX_BINDING_ZK_NONCE, SIX_BY_SIX_ZK_NONCE, STANDARD_ZK_CONFIG_NONCE, SUBMISSION_METHOD, type StellarBundledZkCircuitDefinition, type StellarCustomZkCircuitDefinition, type StellarKytEnvironment, type StellarTransactEnvironment, type StellarZkCircuitDefinition, type SubmissionMethod, type TransferEscrowClaimantLimbs, type TransferEscrowSend, type TransferRecipientExecutionContext, type TransferTemporaryRecipientKey, ZERO_STROOPS, assertEscrowSweepClaimant, assetLegToTokenAddress, attachEscrowAuthorization, attachPoolStatePorts, buildBlindedRecipientTagChallengeMessage, buildPoolTransactionAuditParameters, buildPrivateAddressSignMessage, configurePrivacyPoolService, createPrivacyPoolService, decodePrivateAddress, deriveEscrowRecipientFromStellarAddress, encodePrivateAddress, encodePrivateAddressFromHexCoordinates, evaluateRequiredSubmissionMethod, fetchAndMergeMerkleState, fetchEscrowOutputNoteEvents, finalizeSpendOperationAtExecute, frDecimalToPaddedBytes32, generateRandomDepositScalarHex, generateTemporaryRecipientPrivateAddress, getPrivacyPoolService, isEscrowPreparedOperation, loadDefaultStellarBrowserAssets, loadStellarBrowserAssets, optionalZkArtifactBaseUrl, parseAuditPublicKeyFromEnvHex, parseKytReasonCode, prepareConfidentialTransferProof, prepareConfidentialTransferProofDual, prepareEscrowSweepOperation, prepareRelayTransactPackage, prepareRelayTransactPackageFromPrepared, privateAddressSdk, readLeafEphemeralHex, readRelayTransactSupportedProfile, recipientPublicKeysDecimalFromPrivateAddress, reconstructEscrowNote, requestKytPassageForPoolInteraction, requiredSubmissionMethod, resolvePoolApplicationId, resolveZkConfigNonce, runTtlPreflight, submitSorobanConfidentialTransfer, submitSorobanDeposit, tokenAddressToAssetLeg, unsignedEscrowAuthorizationForSweep };