@fatsolutions/privacy-pools-core-starknet-sdk 0.0.5 → 0.0.7

package/README.md

@@ -0,0 +1,326 @@
+# Privacy Pool Starknet SDK
+
+A TypeScript SDK for interacting with Privacy Pool contracts on Starknet, featuring Garaga proof verification and comprehensive contract interaction capabilities.
+
+## Overview
+
+The Privacy Pool Starknet SDK extends the core Privacy Pool SDK with Starknet-specific functionality. It provides:
+
+- **Garaga Integration**: Converts zero-knowledge proofs to Garaga format for efficient verification on Starknet
+- **Contract Interactions**: Type-safe interfaces for all Privacy Pool operations (deposits, withdrawals, relays, ragequits)
+- **Event Fetching**: Comprehensive event parsing and data retrieval from Starknet networks
+- **Admin Operations**: Full support for pool management and configuration
+- **Error Handling**: Detailed error codes with human-readable contract error parsing
+
+## Installation
+
+```bash
+npm install @fatsolutions/privacy-pools-core-starknet-sdk
+```
+
+## Quick Start
+
+```typescript
+import { PrivacyPoolStarknetSDK, StarknetDataService, Mode } from '@fatsolutions/privacy-pools-core-starknet-sdk';
+import { Account, RpcProvider } from 'starknet';
+
+// Initialize the SDK
+const circuits = new YourCircuitsImplementation(); // Implement CircuitsInterface
+const sdk = new PrivacyPoolStarknetSDK(circuits);
+
+// Create contract service
+const account = new Account(provider, accountAddress, privateKey);
+const contractService = sdk.createSNContractInstance(entrypointAddress, account);
+
+// Deposit ETH
+const depositCall = await contractService.depositETH(
+  BigInt("1000000000000000000"), // 1 ETH in wei
+  precommitment,
+  { mode: Mode.EXECUTE }
+);
+
+// Generate withdrawal proof and execute
+const { withdrawalProof, calldata } = await sdk.proveWithdrawalSN(commitment, withdrawalInput);
+const withdrawResult = await contractService.withdraw(
+  withdrawal,
+  calldata,
+  scope,
+  { mode: Mode.EXECUTE }
+);
+```
+
+## Core Components
+
+### PrivacyPoolStarknetSDK
+
+The main SDK class that extends the core Privacy Pool SDK with Starknet-specific functionality.
+
+```typescript
+// Initialize SDK
+const sdk = new PrivacyPoolStarknetSDK(circuits);
+
+// Create contract service
+const contractService = sdk.createSNContractInstance(entrypointAddress, account);
+
+// Generate Starknet-optimized proofs
+const { withdrawalProof, calldata } = await sdk.proveWithdrawalSN(commitment, input);
+const { commitmentProof, calldata: commitCalldata } = await sdk.proveCommitmentSN(commitment);
+```
+
+### Contract Interactions Service
+
+The `SNContractInteractionsService` provides methods for all Privacy Pool operations with support for both simulation and execution modes.
+
+```typescript
+// Deposit operations
+await contractService.depositETH(amount, precommitment, { mode: Mode.EXECUTE });
+await contractService.depositERC20(tokenAddress, amount, precommitment, { mode: Mode.SIMULATE });
+
+// Withdrawal operations
+await contractService.withdraw(withdrawal, proof, scope, { mode: Mode.EXECUTE });
+await contractService.relay(withdrawal, proof, scope, { mode: Mode.EXECUTE });
+
+// Ragequit operation
+await contractService.ragequit(ragequitProof, poolAddress, { mode: Mode.EXECUTE });
+
+// Approve and deposit in one transaction
+await contractService.approveAndDeposit(
+  entrypointAddress,
+  tokenAddress,
+  amount,
+  precommitment,
+  { mode: Mode.EXECUTE }
+);
+```
+
+### Data Service
+
+The `StarknetDataService` fetches and parses events from Starknet networks.
+
+```typescript
+const provider = new RpcProvider({ nodeUrl: "https://starknet-mainnet.public.blastapi.io" });
+const dataService = new StarknetDataService(provider);
+
+// Fetch pool events
+const deposits = await dataService.getDeposits(poolInfo);
+const withdrawals = await dataService.getWithdrawals(poolInfo);
+const ragequits = await dataService.getRagequits(poolInfo);
+```
+
+### Admin Operations
+
+Administrative functions for pool management:
+
+```typescript
+// Register a new pool
+await contractService.admin.registerPool(
+  assetAddress,
+  poolAddress,
+  minimumDepositAmount,
+  vettingFeeBPS,
+  maxRelayFeeBPS,
+  { mode: Mode.EXECUTE }
+);
+
+// Update pool configuration
+await contractService.admin.updatePoolConfiguration(
+  assetAddress,
+  newMinimumDepositAmount,
+  newVettingFeeBPS,
+  newMaxRelayFeeBPS,
+  { mode: Mode.EXECUTE }
+);
+
+// Update merkle root
+await contractService.admin.updateRoot(newRoot, ipfsCID, { mode: Mode.EXECUTE });
+```
+
+## Execution Modes
+
+The SDK supports different execution modes for all operations:
+
+- **`Mode.EXECUTE`**: Execute the transaction on-chain
+- **`Mode.SIMULATE`**: Simulate the transaction without executing
+- **No mode specified**: Returns a `Call` object for manual execution
+
+```typescript
+// Execute immediately
+const result = await contractService.depositETH(amount, precommitment, { mode: Mode.EXECUTE });
+
+// Simulate first
+const simulation = await contractService.depositETH(amount, precommitment, { mode: Mode.SIMULATE });
+
+// Get call for manual execution
+const call = await contractService.depositETH(amount, precommitment);
+// Execute manually with account.execute([call])
+```
+
+## Error Handling
+
+The SDK provides comprehensive error handling with specific error types:
+
+```typescript
+import { 
+  StarknetSDKError, 
+  SNPoolError, 
+  SNContractError, 
+  SNFormatError,
+  parseContractError 
+} from '@fatsolutions/privacy-pools-core-starknet-sdk';
+
+try {
+  await contractService.depositETH(tooSmallAmount, precommitment, { mode: Mode.EXECUTE });
+} catch (error) {
+  if (error instanceof SNPoolError) {
+    console.log('Pool validation error:', error.message);
+  } else if (error instanceof SNContractError) {
+    console.log('Contract error:', error.message);
+    // Parse contract error for human-readable message
+    const readable = parseContractError(error.message);
+    if (readable) console.log('Readable error:', readable);
+  }
+}
+```
+
+## Types and Interfaces
+
+### Core Types
+
+```typescript
+// Withdrawal data structure
+interface Withdrawal {
+  processor: BigNumberish;
+  data: BigNumberish[];
+}
+
+// Relay data for withdrawal processing
+interface RelayData {
+  recipient: BigNumberish;
+  feeRecipient: BigNumberish;
+  relayFeeBPS: BigNumberish;
+}
+
+// Garaga proof structures
+interface Groth16Proof {
+  a: G1Point$1;
+  b: G2Point$1;
+  c: G1Point$1;
+  publicInputs: bigint[];
+}
+```
+
+### Utility Functions
+
+```typescript
+// Compute scope for a privacy pool
+const scope = computeScope(poolAddress, chainId, assetAddress);
+
+// Compute context for withdrawals
+const context = computeContext(withdrawal, scope);
+
+// Convert proof to Garaga calldata
+const calldata = await withdrawalProofToGaragaCalldata(withdrawalProof, vkeyRaw);
+```
+
+## Contract Error Codes
+
+The SDK automatically parses common contract errors:
+
+| Error Code | Description |
+|------------|-------------|
+| `0x496e76616c69642050726f6f66` | Invalid Proof |
+| `0x4e756c6c69666965722075736564` | Nullifier used |
+| `0x496e76616c696420416d6f756e74` | Invalid Amount |
+| `0x506f6f6c206e6f7420666f756e64` | Pool not found |
+| `0x56616c7565206c6573732074686174206d696e696d756d` | Value less than minimum |
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+npm test
+npm run test:cov  # With coverage
+```
+
+### Type Checking
+
+```bash
+npx tsc --noEmit
+```
+
+## Examples
+
+### Complete Deposit Flow
+
+```typescript
+import { PrivacyPoolStarknetSDK, Mode } from '@fatsolutions/privacy-pools-core-starknet-sdk';
+import { Account, RpcProvider } from 'starknet';
+
+async function depositExample() {
+  // Setup
+  const provider = new RpcProvider({ nodeUrl: "your-starknet-node" });
+  const account = new Account(provider, accountAddress, privateKey);
+  const sdk = new PrivacyPoolStarknetSDK(circuits);
+  const contractService = sdk.createSNContractInstance(entrypointAddress, account);
+
+  // Generate precommitment
+  const { precommitment } = generatePrecommitment(nullifier, secret);
+  
+  // Execute deposit
+  try {
+    const result = await contractService.depositETH(
+      BigInt("1000000000000000000"), // 1 ETH
+      precommitment,
+      { mode: Mode.EXECUTE }
+    );
+    console.log('Deposit successful:', result.transaction_hash);
+  } catch (error) {
+    console.error('Deposit failed:', error.message);
+  }
+}
+```
+
+### Complete Withdrawal Flow
+
+```typescript
+async function withdrawalExample() {
+  // Generate withdrawal proof
+  const { withdrawalProof, calldata } = await sdk.proveWithdrawalSN(commitment, {
+    nullifier: commitment.preimage.precommitment.nullifier,
+    secret: commitment.preimage.precommitment.secret,
+    recipient: recipientAddress,
+    relayerFee: BigInt(0)
+  });
+
+  // Prepare withdrawal data
+  const withdrawal: Withdrawal = {
+    processor: processorAddress,
+    data: [recipientAddress, BigInt(0)] // recipient, relayer fee
+  };
+
+  // Execute withdrawal
+  const result = await contractService.withdraw(
+    withdrawal,
+    calldata,
+    scope,
+    { mode: Mode.EXECUTE }
+  );
+  
+  console.log('Withdrawal successful:', result.transaction_hash);
+}
+```
+
+## License
+
+Apache-2.0
+
+## Support
+
+For questions and support, please open an issue on the GitHub repository.

package/dist/data.service.d.ts

@@ -1,5 +1,24 @@
-import { RpcProvider } from "starknet";
+import { RpcProvider, EmittedEvent } from "starknet";
 import { DepositEvent, WithdrawalEvent, RagequitEvent, PoolInfo } from "@0xbow/privacy-pools-core-sdk";
+interface StarknetDepositedEventData {
+    depositor: bigint;
+    commitment: bigint;
+    label: bigint;
+    value: bigint;
+    preCommitmentHash: bigint;
+}
+interface StarknetWithdrawnEventData {
+    procesoor: bigint;
+    newCommitmentHash: bigint;
+    withdrawnValue: bigint;
+    existingNullifierHash: bigint;
+}
+interface StarknetRageQuitEventData {
+    depositor: bigint;
+    commitment: bigint;
+    label: bigint;
+    value: bigint;
+}
 /**
  * Starknet implementation of DataService for privacy pool event fetching.
  *
@@ -41,4 +60,21 @@ export declare class StarknetDataService {
      * @throws {StarknetSDKError} If provider is not configured or network error occurs
      */
     getRagequits(pool: PoolInfo, fromBlock?: bigint): Promise<RagequitEvent[]>;
+    private static parseGenericEvents;
+    static parseDepositEvents(rawEvents: EmittedEvent[]): {
+        eventData: StarknetDepositedEventData;
+        blockNumber: import("starknet").BlockNumber | undefined;
+        transactionHash: string | undefined;
+    }[];
+    static parseWithdrawalEvents(rawEvents: EmittedEvent[]): {
+        eventData: StarknetWithdrawnEventData;
+        blockNumber: import("starknet").BlockNumber | undefined;
+        transactionHash: string | undefined;
+    }[];
+    static parseRagequitEvents(rawEvents: EmittedEvent[]): {
+        eventData: StarknetRageQuitEventData;
+        blockNumber: import("starknet").BlockNumber | undefined;
+        transactionHash: string | undefined;
+    }[];
 }
+export {};

package/dist/data.service.js

@@ -134,18 +134,7 @@ class StarknetDataService {
                 keys: [[RAGEQUIT_EVENT_SELECTOR]],
                 chunk_size: 1000,
             });
-            // Parse all events at once using starknet.js event parser
-            const abiEvents = starknet_1.events.getAbiEvents(PrivacyPool_abi_js_1.PrivacyPoolABI);
-            const abiStructs = {}; // Could extract from ABI if needed
-            const abiEnums = {}; // Could extract from ABI if needed
-            const parsedEvents = starknet_1.events.parseEvents(eventsResult.events, abiEvents, abiStructs, abiEnums);
-            return parsedEvents
-                .filter((parsedEvent) => parsedEvent[RAGEQUIT_EVENT_ABI_NAME] !== undefined)
-                .map((parsedEvent) => ({
-                eventData: parsedEvent[RAGEQUIT_EVENT_ABI_NAME],
-                blockNumber: parsedEvent.block_number,
-                transactionHash: parsedEvent.transaction_hash
-            }))
+            return StarknetDataService.parseRagequitEvents(eventsResult.events)
                 .map(({ eventData, blockNumber, transactionHash }) => ({
                 ragequitter: starknet_1.num.toHex(eventData.depositor),
                 commitment: eventData.commitment,
@@ -161,6 +150,26 @@ class StarknetDataService {
             throw new index_js_1.StarknetSDKError(`Failed to fetch ragequits: ${error instanceof Error ? error.message : "Unknown error"}`, index_js_1.SNBaseErrorCode.UNKNOWN);
         }
     }
+    static parseGenericEvents(rawEvents, abiEventName) {
+        const abiEvents = starknet_1.events.getAbiEvents(PrivacyPool_abi_js_1.PrivacyPoolABI);
+        const parsedEvents = starknet_1.events.parseEvents(rawEvents, abiEvents, {}, {});
+        return parsedEvents
+            .filter((parsedEvent) => parsedEvent[abiEventName] !== undefined)
+            .map((parsedEvent) => ({
+            eventData: parsedEvent[abiEventName],
+            blockNumber: parsedEvent.block_number,
+            transactionHash: parsedEvent.transaction_hash
+        }));
+    }
+    static parseDepositEvents(rawEvents) {
+        return StarknetDataService.parseGenericEvents(rawEvents, DEPOSIT_EVENT_ABI_NAME);
+    }
+    static parseWithdrawalEvents(rawEvents) {
+        return StarknetDataService.parseGenericEvents(rawEvents, WITHDRAWAL_EVENT_ABI_NAME);
+    }
+    static parseRagequitEvents(rawEvents) {
+        return StarknetDataService.parseGenericEvents(rawEvents, RAGEQUIT_EVENT_ABI_NAME);
+    }
 }
 exports.StarknetDataService = StarknetDataService;
 //# sourceMappingURL=data.service.js.map

package/dist/data.service.js.map

@@ -1 +1 @@
-{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../src/data.service.ts"],"names":[],"mappings":";;;AAAA,uCAAuF;AACvF,gDAAsE;AACtE,kEAA2D;AAS3D,kDAAkD;AAClD,MAAM,sBAAsB,GAAG,cAAG,CAAC,KAAK,CAAC,eAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAC3E,MAAM,yBAAyB,GAAG,cAAG,CAAC,KAAK,CAAC,eAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAC9E,MAAM,uBAAuB,GAAG,cAAG,CAAC,KAAK,CAAC,eAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;AAE3E,uCAAuC;AACvC,MAAM,sBAAsB,GAAG,6CAA6C,CAAC;AAC7E,MAAM,yBAAyB,GAAG,6CAA6C,CAAC;AAChF,MAAM,uBAAuB,GAAG,4CAA4C,CAAC;AAyB7E;;;;;;GAMG;AACH,MAAa,mBAAmB;IACb,QAAQ,CAAc;IAEvC;;;;OAIG;IACH,YAAY,QAAqB;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAc;QAC9B,IAAI,CAAC;YAEH,uCAAuC;YACvC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACjD,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;gBAC1D,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,CAAC,CAAC,sBAAsB,CAAC,CAAC,EAAE,mCAAmC;gBACrE,UAAU,EAAE,IAAI,EAAE,sBAAsB;aACzC,CAAC,CAAC;YAEH,0DAA0D;YAC1D,MAAM,SAAS,GAAG,iBAAM,CAAC,YAAY,CAAC,mCAAc,CAAC,CAAC;YACtD,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAC1D,MAAM,QAAQ,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAExD,MAAM,YAAY,GAAG,iBAAM,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE9F,OAAO,YAAY;iBAChB,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,SAAS,CAAC;iBAC1E,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;gBACrB,SAAS,EAAE,WAAW,CAAC,sBAAsB,CAA0C;gBACvF,WAAW,EAAE,WAAW,CAAC,YAAY;gBACrC,eAAe,EAAE,WAAW,CAAC,gBAAgB;aAC9C,CAAC,CAAC;iBACF,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrD,SAAS,EAAE,cAAG,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;gBACzC,UAAU,EAAE,SAAS,CAAC,UAAkB;gBACxC,KAAK,EAAE,SAAS,CAAC,KAAa;gBAC9B,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,aAAa,EAAE,SAAS,CAAC,iBAAyB;gBAClD,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;gBACrC,eAAe,EAAE,eAAe,IAAI,KAAK;aAC1C,CAAiB,CAAC,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,2BAAgB;gBAAE,MAAM,KAAK,CAAC;YACnD,MAAM,IAAI,2BAAgB,CACxB,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EACvF,0BAAe,CAAC,OAAO,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAClB,IAAc,EACd,YAAoB,IAAI,CAAC,eAAe;QAExC,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACjD,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE;gBAC/C,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC;gBACnC,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;YAEH,0DAA0D;YAC1D,MAAM,SAAS,GAAG,iBAAM,CAAC,YAAY,CAAC,mCAAc,CAAC,CAAC;YACtD,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAC1D,MAAM,QAAQ,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAExD,MAAM,YAAY,GAAG,iBAAM,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE9F,OAAO,YAAY;iBAChB,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,yBAAyB,CAAC,KAAK,SAAS,CAAC;iBAC7E,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;gBACrB,SAAS,EAAE,WAAW,CAAC,yBAAyB,CAA0C;gBAC1F,WAAW,EAAE,WAAW,CAAC,YAAY;gBACrC,eAAe,EAAE,WAAW,CAAC,gBAAgB;aAC9C,CAAC,CAAC;iBACF,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrD,SAAS,EAAE,SAAS,CAAC,cAAc;gBACnC,cAAc,EAAE,SAAS,CAAC,qBAA6B;gBACvD,aAAa,EAAE,SAAS,CAAC,iBAAyB;gBAClD,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;gBACrC,eAAe,EAAE,eAAe,IAAI,KAAK;aAC1C,CAAoB,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,2BAAgB;gBAAE,MAAM,KAAK,CAAC;YACnD,MAAM,IAAI,2BAAgB,CACxB,gCAAgC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EAC1F,0BAAe,CAAC,OAAO,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAChB,IAAc,EACd,YAAoB,IAAI,CAAC,eAAe;QAExC,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACjD,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE;gBAC/C,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,CAAC,CAAC,uBAAuB,CAAC,CAAC;gBACjC,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;YAEH,0DAA0D;YAC1D,MAAM,SAAS,GAAG,iBAAM,CAAC,YAAY,CAAC,mCAAc,CAAC,CAAC;YACtD,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAC1D,MAAM,QAAQ,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAExD,MAAM,YAAY,GAAG,iBAAM,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE9F,OAAO,YAAY;iBAChB,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,uBAAuB,CAAC,KAAK,SAAS,CAAC;iBAC3E,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;gBACrB,SAAS,EAAE,WAAW,CAAC,uBAAuB,CAAyC;gBACvF,WAAW,EAAE,WAAW,CAAC,YAAY;gBACrC,eAAe,EAAE,WAAW,CAAC,gBAAgB;aAC9C,CAAC,CAAC;iBACF,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrD,WAAW,EAAE,cAAG,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;gBAC3C,UAAU,EAAE,SAAS,CAAC,UAAkB;gBACxC,KAAK,EAAE,SAAS,CAAC,KAAa;gBAC9B,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;gBACrC,eAAe,EAAE,eAAe,IAAI,KAAK;aAC1C,CAAkB,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,2BAAgB;gBAAE,MAAM,KAAK,CAAC;YACnD,MAAM,IAAI,2BAAgB,CACxB,8BAA8B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EACxF,0BAAe,CAAC,OAAO,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;CAEF;AAtKD,kDAsKC"}
+{"version":3,"file":"data.service.js","sourceRoot":"","sources":["../src/data.service.ts"],"names":[],"mappings":";;;AAAA,uCAAqG;AACrG,gDAAsE;AACtE,kEAA2D;AAS3D,kDAAkD;AAClD,MAAM,sBAAsB,GAAG,cAAG,CAAC,KAAK,CAAC,eAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAC3E,MAAM,yBAAyB,GAAG,cAAG,CAAC,KAAK,CAAC,eAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC;AAC9E,MAAM,uBAAuB,GAAG,cAAG,CAAC,KAAK,CAAC,eAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;AAE3E,uCAAuC;AACvC,MAAM,sBAAsB,GAAG,6CAA6C,CAAC;AAC7E,MAAM,yBAAyB,GAAG,6CAA6C,CAAC;AAChF,MAAM,uBAAuB,GAAG,4CAA4C,CAAC;AA4B7E;;;;;;GAMG;AACH,MAAa,mBAAmB;IACb,QAAQ,CAAc;IAEvC;;;;OAIG;IACH,YAAY,QAAqB;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,IAAc;QAC9B,IAAI,CAAC;YAEH,uCAAuC;YACvC,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACjD,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;gBAC1D,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,CAAC,CAAC,sBAAsB,CAAC,CAAC,EAAE,mCAAmC;gBACrE,UAAU,EAAE,IAAI,EAAE,sBAAsB;aACzC,CAAC,CAAC;YAEH,0DAA0D;YAC1D,MAAM,SAAS,GAAG,iBAAM,CAAC,YAAY,CAAC,mCAAc,CAAC,CAAC;YACtD,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAC1D,MAAM,QAAQ,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAExD,MAAM,YAAY,GAAG,iBAAM,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE9F,OAAO,YAAY;iBAChB,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,sBAAsB,CAAC,KAAK,SAAS,CAAC;iBAC1E,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;gBACrB,SAAS,EAAE,WAAW,CAAC,sBAAsB,CAA0C;gBACvF,WAAW,EAAE,WAAW,CAAC,YAAY;gBACrC,eAAe,EAAE,WAAW,CAAC,gBAAgB;aAC9C,CAAC,CAAC;iBACF,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrD,SAAS,EAAE,cAAG,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;gBACzC,UAAU,EAAE,SAAS,CAAC,UAAkB;gBACxC,KAAK,EAAE,SAAS,CAAC,KAAa;gBAC9B,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,aAAa,EAAE,SAAS,CAAC,iBAAyB;gBAClD,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;gBACrC,eAAe,EAAE,eAAe,IAAI,KAAK;aAC1C,CAAiB,CAAC,CAAC;QACxB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,2BAAgB;gBAAE,MAAM,KAAK,CAAC;YACnD,MAAM,IAAI,2BAAgB,CACxB,6BAA6B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EACvF,0BAAe,CAAC,OAAO,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAClB,IAAc,EACd,YAAoB,IAAI,CAAC,eAAe;QAExC,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACjD,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE;gBAC/C,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,CAAC,CAAC,yBAAyB,CAAC,CAAC;gBACnC,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;YAEH,0DAA0D;YAC1D,MAAM,SAAS,GAAG,iBAAM,CAAC,YAAY,CAAC,mCAAc,CAAC,CAAC;YACtD,MAAM,UAAU,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAC1D,MAAM,QAAQ,GAAG,EAAE,CAAC,CAAC,mCAAmC;YAExD,MAAM,YAAY,GAAG,iBAAM,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;YAE9F,OAAO,YAAY;iBAChB,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,yBAAyB,CAAC,KAAK,SAAS,CAAC;iBAC7E,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;gBACrB,SAAS,EAAE,WAAW,CAAC,yBAAyB,CAA0C;gBAC1F,WAAW,EAAE,WAAW,CAAC,YAAY;gBACrC,eAAe,EAAE,WAAW,CAAC,gBAAgB;aAC9C,CAAC,CAAC;iBACF,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrD,SAAS,EAAE,SAAS,CAAC,cAAc;gBACnC,cAAc,EAAE,SAAS,CAAC,qBAA6B;gBACvD,aAAa,EAAE,SAAS,CAAC,iBAAyB;gBAClD,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;gBACrC,eAAe,EAAE,eAAe,IAAI,KAAK;aAC1C,CAAoB,CAAC,CAAC;QAC3B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,2BAAgB;gBAAE,MAAM,KAAK,CAAC;YACnD,MAAM,IAAI,2BAAgB,CACxB,gCAAgC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EAC1F,0BAAe,CAAC,OAAO,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAChB,IAAc,EACd,YAAoB,IAAI,CAAC,eAAe;QAExC,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACjD,UAAU,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,EAAE;gBAC/C,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,IAAI,EAAE,CAAC,CAAC,uBAAuB,CAAC,CAAC;gBACjC,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;YACH,OAAO,mBAAmB,CAAC,mBAAmB,CAAC,YAAY,CAAC,MAAM,CAAC;iBAChE,GAAG,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,EAAE,EAAE,CAAC,CAAC;gBACrD,WAAW,EAAE,cAAG,CAAC,KAAK,CAAC,SAAS,CAAC,SAAS,CAAC;gBAC3C,UAAU,EAAE,SAAS,CAAC,UAAkB;gBACxC,KAAK,EAAE,SAAS,CAAC,KAAa;gBAC9B,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC;gBACrC,eAAe,EAAE,eAAe,IAAI,KAAK;aAC1C,CAAkB,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,2BAAgB;gBAAE,MAAM,KAAK,CAAC;YACnD,MAAM,IAAI,2BAAgB,CACxB,8BAA8B,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,EACxF,0BAAe,CAAC,OAAO,CACxB,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAI,SAAyB,EAAE,YAA0B;QACxF,MAAM,SAAS,GAAG,iBAAM,CAAC,YAAY,CAAC,mCAAc,CAAC,CAAC;QACtD,MAAM,YAAY,GAAG,iBAAM,CAAC,WAAW,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,YAAY;aAChB,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,KAAK,SAAS,CAAC;aAChE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YACrB,SAAS,EAAE,WAAW,CAAC,YAAY,CAAiB;YACpD,WAAW,EAAE,WAAW,CAAC,YAAY;YACrC,eAAe,EAAE,WAAW,CAAC,gBAAgB;SAC9C,CAAC,CAAC,CAAC;IACR,CAAC;IAED,MAAM,CAAC,kBAAkB,CAAC,SAAyB;QACjD,OAAO,mBAAmB,CAAC,kBAAkB,CAA6B,SAAS,EAAE,sBAAsB,CAAC,CAAC;IAC/G,CAAC;IAED,MAAM,CAAC,qBAAqB,CAAC,SAAyB;QACpD,OAAO,mBAAmB,CAAC,kBAAkB,CAA6B,SAAS,EAAE,yBAAyB,CAAC,CAAC;IAClH,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,SAAyB;QAClD,OAAO,mBAAmB,CAAC,kBAAkB,CAA4B,SAAS,EAAE,uBAAuB,CAAC,CAAC;IAC/G,CAAC;CAEF;AAhLD,kDAgLC"}

package/dist/errors/contracts.errors.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Mapping of hexadecimal error codes to human-readable error messages.
+ *
+ * These error codes correspond to custom errors thrown by Privacy Pool smart contracts
+ * on Starknet. The hex codes are the encoded error messages that appear in transaction
+ * failure reasons.
+ *
+ * @constant
+ */
 export declare const CONTRACT_ERROR_CODES: {
     readonly "0x4173736574204d6973736d61746368": "Asset Missmatch";
     readonly "0x43616c6c6572206973206e6f7420456e747279706f696e74": "Caller is not Entrypoint";
@@ -24,4 +33,20 @@ export declare const CONTRACT_ERROR_CODES: {
     readonly "0x72656c617965722066656520544f2048494748": "relayer fee TO HIGH";
     readonly "0x56616c7565206c6573732074686174206d696e696d756d": "Value less that minimum";
 };
+/**
+ * Parses a contract error string to extract a human-readable error message.
+ *
+ * This function searches through the error string for known hexadecimal error codes
+ * and returns the corresponding human-readable description. This is useful for
+ * providing better error messages to users when transactions fail.
+ *
+ * @param errorString - The error string from a failed transaction
+ * @returns The human-readable error message if found, null otherwise
+ *
+ * @example
+ * ```typescript
+ * const error = "execution failed with error: 0x496e76616c69642050726f6f66";
+ * const readable = parseContractError(error); // Returns "Invalid Proof"
+ * ```
+ */
 export declare function parseContractError(errorString: string): string | null;

package/dist/errors/contracts.errors.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONTRACT_ERROR_CODES = void 0;
 exports.parseContractError = parseContractError;
+/**
+ * Mapping of hexadecimal error codes to human-readable error messages.
+ *
+ * These error codes correspond to custom errors thrown by Privacy Pool smart contracts
+ * on Starknet. The hex codes are the encoded error messages that appear in transaction
+ * failure reasons.
+ *
+ * @constant
+ */
 exports.CONTRACT_ERROR_CODES = {
     "0x4173736574204d6973736d61746368": "Asset Missmatch",
     "0x43616c6c6572206973206e6f7420456e747279706f696e74": "Caller is not Entrypoint",
@@ -28,6 +37,22 @@ exports.CONTRACT_ERROR_CODES = {
     "0x72656c617965722066656520544f2048494748": "relayer fee TO HIGH",
     "0x56616c7565206c6573732074686174206d696e696d756d": "Value less that minimum"
 };
+/**
+ * Parses a contract error string to extract a human-readable error message.
+ *
+ * This function searches through the error string for known hexadecimal error codes
+ * and returns the corresponding human-readable description. This is useful for
+ * providing better error messages to users when transactions fail.
+ *
+ * @param errorString - The error string from a failed transaction
+ * @returns The human-readable error message if found, null otherwise
+ *
+ * @example
+ * ```typescript
+ * const error = "execution failed with error: 0x496e76616c69642050726f6f66";
+ * const readable = parseContractError(error); // Returns "Invalid Proof"
+ * ```
+ */
 function parseContractError(errorString) {
     for (const [hexCode, description] of Object.entries(exports.CONTRACT_ERROR_CODES)) {
         if (errorString.includes(hexCode)) {

package/dist/errors/contracts.errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"contracts.errors.js","sourceRoot":"","sources":["../../src/errors/contracts.errors.ts"],"names":[],"mappings":";;;AA2BA,gDAOC;AAlCY,QAAA,oBAAoB,GAAG;IAClC,kCAAkC,EAAE,iBAAiB;IACrD,oDAAoD,EAAE,0BAA0B;IAChF,4CAA4C,EAAE,sBAAsB;IACpE,wCAAwC,EAAE,oBAAoB;IAC9D,wCAAwC,EAAE,oBAAoB;IAC9D,gCAAgC,EAAE,gBAAgB;IAClD,kCAAkC,EAAE,iBAAiB;IACrD,wCAAwC,EAAE,oBAAoB;IAC9D,wCAAwC,EAAE,oBAAoB;IAC9D,sCAAsC,EAAE,mBAAmB;IAC3D,8BAA8B,EAAE,eAAe;IAC/C,4BAA4B,EAAE,cAAc;IAC5C,wCAAwC,EAAE,oBAAoB;IAC9D,wCAAwC,EAAE,oBAAoB;IAC9D,gDAAgD,EAAE,wBAAwB;IAC1E,gCAAgC,EAAE,gBAAgB;IAClD,kDAAkD,EAAE,yBAAyB;IAC7E,0CAA0C,EAAE,qBAAqB;IACjE,4BAA4B,EAAE,cAAc;IAC5C,gCAAgC,EAAE,gBAAgB;IAClD,0CAA0C,EAAE,qBAAqB;IACjE,wCAAwC,EAAE,oBAAoB;IAC9D,0CAA0C,EAAE,qBAAqB;IACjE,kDAAkD,EAAE,yBAAyB;CACrE,CAAC;AAEX,SAAgB,kBAAkB,CAAC,WAAmB;IACpD,KAAK,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,4BAAoB,CAAC,EAAE,CAAC;QAC1E,IAAI,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
+{"version":3,"file":"contracts.errors.js","sourceRoot":"","sources":["../../src/errors/contracts.errors.ts"],"names":[],"mappings":";;;AAoDA,gDAOC;AA3DD;;;;;;;;GAQG;AACU,QAAA,oBAAoB,GAAG;IAClC,kCAAkC,EAAE,iBAAiB;IACrD,oDAAoD,EAAE,0BAA0B;IAChF,4CAA4C,EAAE,sBAAsB;IACpE,wCAAwC,EAAE,oBAAoB;IAC9D,wCAAwC,EAAE,oBAAoB;IAC9D,gCAAgC,EAAE,gBAAgB;IAClD,kCAAkC,EAAE,iBAAiB;IACrD,wCAAwC,EAAE,oBAAoB;IAC9D,wCAAwC,EAAE,oBAAoB;IAC9D,sCAAsC,EAAE,mBAAmB;IAC3D,8BAA8B,EAAE,eAAe;IAC/C,4BAA4B,EAAE,cAAc;IAC5C,wCAAwC,EAAE,oBAAoB;IAC9D,wCAAwC,EAAE,oBAAoB;IAC9D,gDAAgD,EAAE,wBAAwB;IAC1E,gCAAgC,EAAE,gBAAgB;IAClD,kDAAkD,EAAE,yBAAyB;IAC7E,0CAA0C,EAAE,qBAAqB;IACjE,4BAA4B,EAAE,cAAc;IAC5C,gCAAgC,EAAE,gBAAgB;IAClD,0CAA0C,EAAE,qBAAqB;IACjE,wCAAwC,EAAE,oBAAoB;IAC9D,0CAA0C,EAAE,qBAAqB;IACjE,kDAAkD,EAAE,yBAAyB;CACrE,CAAC;AAEX;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,kBAAkB,CAAC,WAAmB;IACpD,KAAK,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,4BAAoB,CAAC,EAAE,CAAC;QAC1E,IAAI,WAAW,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAClC,OAAO,WAAW,CAAC;QACrB,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/errors/index.d.ts

@@ -1,37 +1,109 @@
+/** Base error codes for fundamental SDK errors */
 export declare enum SNBaseErrorCode {
     UNKNOWN = 0,
     UNREACHABLE = 1,
     INTERNAL = 2
 }
+/** Error codes specific to privacy pool validation */
 export declare enum SNPoolErrorCode {
     AMOUNT_TOO_SMALL = 0
 }
+/** Error codes for contract interaction failures */
 export declare enum SNContractErrorCode {
     DEPOSIT_FAILED = 0,
     INVALID_IPFS_CID = 1,
     REVERT = 2
 }
+/** Error codes for data format and conversion issues */
 export declare enum SNFormatErrorCode {
     CONVERSION = 0
 }
+/** Union type of all possible error codes in the Starknet SDK */
 export type SNErrorCode = SNBaseErrorCode | SNPoolErrorCode | SNContractErrorCode | SNFormatErrorCode;
+/**
+ * Base error class for all Starknet SDK errors.
+ *
+ * This class extends the standard Error class and provides additional context
+ * through error codes. All SDK-specific errors should inherit from this class.
+ */
 export declare class StarknetSDKError extends Error {
     readonly code: SNErrorCode;
     readonly name: string;
     message: string;
+    /**
+     * Creates a new StarknetSDKError.
+     *
+     * @param message - The error message
+     * @param code - The specific error code for categorization
+     */
     constructor(message: string, code: SNErrorCode);
+    /**
+     * Creates an unknown error instance.
+     * @returns StarknetSDKError with UNKNOWN code
+     */
     static unknown(): StarknetSDKError;
+    /**
+     * Creates an unreachable code error instance.
+     * @returns StarknetSDKError with UNREACHABLE code
+     */
     static unreachable(): StarknetSDKError;
+    /**
+     * Creates an internal error instance.
+     * @param msg - Optional custom error message
+     * @returns StarknetSDKError with INTERNAL code
+     */
     static internal(msg?: string): StarknetSDKError;
 }
+/**
+ * Error class for data format and conversion issues.
+ *
+ * This error is thrown when data conversion operations fail, such as
+ * converting between different proof formats or parsing verification keys.
+ */
 export declare class SNFormatError extends StarknetSDKError {
-    static conversion(conetxt?: string): SNFormatError;
+    /**
+     * Creates a conversion error instance.
+     * @param context - Optional context about what conversion failed
+     * @returns SNFormatError with CONVERSION code
+     */
+    static conversion(context?: string): SNFormatError;
 }
+/**
+ * Error class for privacy pool validation failures.
+ *
+ * This error is thrown when privacy pool operations fail validation,
+ * such as insufficient deposit amounts or invalid pool parameters.
+ */
 export declare class SNPoolError extends StarknetSDKError {
-    static amountTooSmall(conetxt?: string): SNPoolError;
+    /**
+     * Creates an error for deposit amounts that are too small.
+     * @param context - Optional context about the minimum amount requirement
+     * @returns SNPoolError with AMOUNT_TOO_SMALL code
+     */
+    static amountTooSmall(context?: string): SNPoolError;
 }
+/**
+ * Error class for smart contract interaction failures.
+ *
+ * This error is thrown when contract calls fail or return unexpected results,
+ * including transaction reverts and invalid parameters.
+ */
 export declare class SNContractError extends StarknetSDKError {
+    /**
+     * Creates an error for failed deposit operations.
+     * @returns SNContractError with DEPOSIT_FAILED code
+     */
     static depositFailed(): SNContractError;
+    /**
+     * Creates an error for invalid IPFS CID sizes.
+     * @param ipfsCID - The invalid IPFS CID
+     * @returns SNContractError with INVALID_IPFS_CID code
+     */
     static invalidIPFSsize(ipfsCID: string): SNContractError;
+    /**
+     * Creates an error for contract execution reverts.
+     * @param reason - The revert reason from the contract
+     * @returns SNContractError with REVERT code
+     */
     static revert(reason: string): SNContractError;
 }