@0xbow/privacy-pools-core-sdk 0.0.0-c084059

package/dist/types/core/sdk.d.ts

@@ -0,0 +1,44 @@
+import { CircuitsInterface } from "../interfaces/circuits.interface.js";
+import { Commitment, CommitmentProof } from "../types/commitment.js";
+import { WithdrawalProof, WithdrawalProofInput } from "../types/withdrawal.js";
+import { ContractInteractionsService } from "./contracts.service.js";
+import { Hex, Address, Chain } from "viem";
+/**
+ * Main SDK class providing access to all privacy pool functionality.
+ * Uses Poseidon hash for all commitment operations.
+ */
+export declare class PrivacyPoolSDK {
+    private readonly commitmentService;
+    private readonly withdrawalService;
+    constructor(circuits: CircuitsInterface);
+    createContractInstance(rpcUrl: string, chain: Chain, entrypointAddress: Address, privateKey: Hex): ContractInteractionsService;
+    /**
+     * Generates a commitment proof.
+     *
+     * @param value - Value to commit
+     * @param label - Label for the commitment
+     * @param nullifier - Nullifier for the commitment
+     * @param secret - Secret for the commitment
+     */
+    proveCommitment(value: bigint, label: bigint, nullifier: bigint, secret: bigint): Promise<CommitmentProof>;
+    /**
+     * Verifies a commitment proof.
+     *
+     * @param proof - The proof to verify
+     */
+    verifyCommitment(proof: CommitmentProof): Promise<boolean>;
+    /**
+     * Generates a withdrawal proof.
+     *
+     * @param commitment - Commitment to withdraw
+     * @param input - Input parameters for the withdrawal
+     * @param withdrawal - Withdrawal details
+     */
+    proveWithdrawal(commitment: Commitment, input: WithdrawalProofInput): Promise<WithdrawalProof>;
+    /**
+     * Verifies a withdrawal proof.
+     *
+     * @param withdrawalProof - The withdrawal payload to verify
+     */
+    verifyWithdrawal(withdrawalProof: WithdrawalProof): Promise<boolean>;
+}

package/dist/types/core/withdrawal.service.d.ts

@@ -0,0 +1,32 @@
+import { CircuitsInterface } from "../interfaces/circuits.interface.js";
+import { Commitment } from "../types/commitment.js";
+import { WithdrawalProof, WithdrawalProofInput } from "../types/withdrawal.js";
+/**
+ * Service responsible for handling withdrawal-related operations.
+ */
+export declare class WithdrawalService {
+    private readonly circuits;
+    constructor(circuits: CircuitsInterface);
+    /**
+     * Generates a withdrawal proof.
+     *
+     * @param commitment - Commitment to withdraw
+     * @param input - Input parameters for the withdrawal
+     * @param withdrawal - Withdrawal details
+     * @returns Promise resolving to withdrawal payload
+     * @throws {ProofError} If proof generation fails
+     */
+    proveWithdrawal(commitment: Commitment, input: WithdrawalProofInput): Promise<WithdrawalProof>;
+    /**
+     * Verifies a withdrawal proof.
+     *
+     * @param withdrawalPayload - The withdrawal payload to verify
+     * @returns Promise resolving to boolean indicating proof validity
+     * @throws {ProofError} If verification fails
+     */
+    verifyWithdrawal(withdrawalPayload: WithdrawalProof): Promise<boolean>;
+    /**
+     * Prepares input signals for the withdrawal circuit.
+     */
+    private prepareInputSignals;
+}

package/dist/types/crypto.d.ts

@@ -0,0 +1,45 @@
+import { LeanIMTMerkleProof } from "@zk-kit/lean-imt";
+import { Commitment, Hash, Secret, Withdrawal } from "./types/index.js";
+import { Hex } from "viem";
+/**
+ * Generates random nullifier and secret.
+ *
+ * @returns {{ nullifier: Secret, secret: Secret }} Randomly generated secrets.
+ */
+export declare function generateSecrets(): {
+    nullifier: Secret;
+    secret: Secret;
+};
+/**
+ * Computes a Poseidon hash for the given nullifier and secret.
+ *
+ * @param {Secret} nullifier - The nullifier to hash.
+ * @param {Secret} secret - The secret to hash.
+ * @returns {Hash} The Poseidon hash.
+ */
+export declare function hashPrecommitment(nullifier: Secret, secret: Secret): Hash;
+/**
+ * Generates a commitment using the given parameters.
+ *
+ * @param {bigint} value - The value associated with the commitment.
+ * @param {bigint} label - The label used for the commitment.
+ * @param {Secret} nullifier - The nullifier used in the precommitment.
+ * @param {Secret} secret - The secret used in the precommitment.
+ * @returns {Commitment} The generated commitment object.
+ */
+export declare function getCommitment(value: bigint, label: bigint, nullifier: Secret, secret: Secret): Commitment;
+/**
+ * Generates a Merkle inclusion proof for a given leaf in a set of leaves.
+ *
+ * @param {bigint[]} leaves - Array of leaves for the Lean Incremental Merkle tree.
+ * @param {bigint} leaf - The specific leaf to generate the inclusion proof for.
+ * @returns {LeanIMTMerkleProof<bigint>} A lean incremental Merkle tree inclusion proof.
+ * @throws {Error} If the leaf is not found in the leaves array.
+ */
+export declare function generateMerkleProof(leaves: bigint[], leaf: bigint): LeanIMTMerkleProof<bigint>;
+export declare function bigintToHash(value: bigint): Hash;
+export declare function bigintToHex(num: bigint | string | undefined): Hex;
+/**
+ * Calculates the context hash for a withdrawal.
+ */
+export declare function calculateContext(withdrawal: Withdrawal, scope: Hash): string;

package/dist/types/dirname.helper.d.ts

@@ -0,0 +1,2 @@
+declare const _default: string;
+export default _default;

package/dist/types/errors/base.error.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Unified error codes for the SDK.
+ */
+export declare enum ErrorCode {
+    UNKNOWN = "UNKNOWN",
+    INVALID_INPUT = "INVALID_INPUT",
+    OPERATION_FAILED = "OPERATION_FAILED",
+    NETWORK_ERROR = "NETWORK_ERROR",
+    PROOF_GENERATION_FAILED = "PROOF_GENERATION_FAILED",
+    PROOF_VERIFICATION_FAILED = "PROOF_VERIFICATION_FAILED",
+    INVALID_PROOF = "INVALID_PROOF",
+    INVALID_PUBLIC_SIGNALS = "INVALID_PUBLIC_SIGNALS",
+    CIRCUIT_ERROR = "CIRCUIT_ERROR",
+    CONTRACT_ERROR = "CONTRACT_ERROR",
+    CRYPTO_ERROR = "CRYPTO_ERROR",
+    MERKLE_ERROR = "MERKLE_ERROR"
+}
+/**
+ * Base error class for the SDK.
+ * All other error classes should extend this.
+ */
+export declare class SDKError extends Error {
+    readonly code: ErrorCode;
+    readonly details?: Record<string, unknown> | undefined;
+    constructor(message: string, code?: ErrorCode, details?: Record<string, unknown> | undefined);
+    /**
+     * Creates a JSON representation of the error.
+     */
+    toJSON(): Record<string, unknown>;
+}
+/**
+ * Specialized error class for proof-related operations.
+ */
+export declare class ProofError extends SDKError {
+    constructor(message: string, code?: ErrorCode, details?: Record<string, unknown>);
+    /**
+     * Creates an error for proof generation failures.
+     */
+    static generationFailed(details?: Record<string, unknown>): ProofError;
+    /**
+     * Creates an error for proof verification failures.
+     */
+    static verificationFailed(details?: Record<string, unknown>): ProofError;
+    /**
+     * Creates an error for invalid proof format.
+     */
+    static invalidProof(details?: Record<string, unknown>): ProofError;
+}
+export declare class ContractError extends SDKError {
+    constructor(message: string, code?: ErrorCode, details?: Record<string, unknown>);
+    static scopeNotFound(scope: bigint): ContractError;
+}

package/dist/types/exceptions/circuitInitialization.exception.d.ts

@@ -0,0 +1,3 @@
+export declare class CircuitInitialization extends Error {
+    constructor(message: string);
+}

package/dist/types/exceptions/fetchArtifacts.exception.d.ts

@@ -0,0 +1,3 @@
+export declare class FetchArtifact extends Error {
+    constructor(artifact: URL);
+}

package/dist/types/exceptions/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./invalidRpcUrl.exception.js";
+export * from "./fetchArtifacts.exception.js";
+export * from "./circuitInitialization.exception.js";
+export * from "./privacyPool.exception.js";

package/dist/types/exceptions/invalidRpcUrl.exception.d.ts

@@ -0,0 +1,3 @@
+export declare class InvalidRpcUrl extends Error {
+    constructor(url: string);
+}

package/dist/types/exceptions/privacyPool.exception.d.ts

@@ -0,0 +1,13 @@
+export declare enum ErrorCode {
+    INVALID_COMMITMENT = "INVALID_COMMITMENT",
+    INVALID_MERKLE_PROOF = "INVALID_MERKLE_PROOF",
+    INVALID_NULLIFIER = "INVALID_NULLIFIER",
+    INVALID_SECRET = "INVALID_SECRET",
+    INVALID_VALUE = "INVALID_VALUE",
+    INVALID_LABEL = "INVALID_LABEL",
+    MERKLE_ERROR = "MERKLE_ERROR"
+}
+export declare class PrivacyPoolError extends Error {
+    code: ErrorCode;
+    constructor(code: ErrorCode, message: string);
+}

package/dist/types/external.d.ts

@@ -0,0 +1,7 @@
+export type { IBlockchainProvider } from "./internal.js";
+export { InvalidRpcUrl } from "./internal.js";
+export { BlockchainProvider } from "./internal.js";
+export { Circuits } from "./circuits/index.js";
+export { ContractInteractionsService } from "./core/contracts.service.js";
+export type { LeanIMTMerkleProof } from "@zk-kit/lean-imt";
+export type { Address } from "viem";

package/dist/types/filename.helper.d.ts

@@ -0,0 +1,2 @@
+declare const __filename: string;
+export default __filename;