@palindromepay/sdk 2.0.6 → 2.0.7

package/README.md

@@ -10,7 +10,22 @@ A TypeScript/Node SDK for interacting with the PalindromePay escrow smart contra
 
 ## 📚 Documentation
 
-**Full documentation available at: [sdk.palindromepay.com](https://sdk.palindromepay.com)**
+**Full documentation available at: [palindromepay.com/sdk](https://www.palindromepay.com/sdk)**
+
+---
+
+## ✨ Features
+
+- Interact with on-chain escrow contracts using public & wallet clients
+- Supports ERC20 deposits, fee calculation, and contract state queries
+- Buyer, Seller, Arbiter roles—plus dispute/resolve logic
+- Meta-transaction signature helpers (EIP-712 compatible)
+- Auto-release and time/maturity helpers
+- Subgraph GraphQL queries to fetch and filter escrows and dispute messages
+- Flexible error classes and codes for wallet/client state
+- Utilities for fee calculation, token formatting, deadlines, and maturity times
+- Gas estimation helpers for transaction planning
+- Comprehensive state and role validation helpers
 
 ---
 
@@ -67,4 +82,4 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 ## 📞 Support
 
 - GitHub Issues: https://github.com/palindromepay/SDKPalindromePay/issues
-- Documentation: https://sdk.palindromepay.com
+- Documentation: https://www.palindromepay.com/sdk

package/dist/PalindromePaySDK.d.ts

@@ -99,7 +99,8 @@ export interface PalindromePaySDKConfig {
     publicClient: PublicClient;
     contractAddress: Address;
     walletClient?: EscrowWalletClient;
-    apolloClient?: ApolloClient;
+    /** Apollo client for subgraph queries (required) */
+    apolloClient: ApolloClient;
     chain?: Chain;
     /** Cache TTL in milliseconds (default: 5000) */
     cacheTTL?: number;
@@ -115,7 +116,6 @@ export interface PalindromePaySDKConfig {
     gasBuffer?: number;
     /** Transaction receipt timeout in milliseconds (default: 60000) */
     receiptTimeout?: number;
-    subgraphUrl?: string;
     /**
      * Skip eth_call simulation before sending transactions (default: false)
      * Enable this for chains with unreliable RPC simulation (e.g., Base Sepolia)
@@ -237,6 +237,8 @@ export declare class PalindromePaySDK {
     private tokenDecimalsCache;
     /** Cache for immutable contract values */
     private feeReceiverCache;
+    /** Cached default arbiter from contract (immutable) */
+    private defaultArbiterCache;
     /** Cached multicall support status per chain (null = not yet detected) */
     private multicallSupported;
     private readonly STATE_NAMES;
@@ -1214,6 +1216,20 @@ export declare class PalindromePaySDK {
      * @param forceRefresh - Set to true to bypass cache and fetch fresh value
      */
     getFeeReceiver(forceRefresh?: boolean): Promise<Address>;
+    /**
+     * Check if an escrow uses the default Palindrome Pay arbiter.
+     *
+     * @param escrow - The escrow data to check
+     * @returns True if the escrow uses the default arbiter
+     */
+    isDefaultArbiter(escrow: EscrowData): Promise<boolean>;
+    /**
+     * Get the default Palindrome Pay arbiter address from contract.
+     * Result is cached since the value is immutable.
+     *
+     * @returns The default arbiter address
+     */
+    getDefaultArbiter(): Promise<Address>;
     /** Cached fee basis points (lazily computed from contract) */
     private cachedFeeBps;
     /**

package/dist/PalindromePaySDK.js

@@ -30,7 +30,6 @@ const actions_1 = require("viem/actions");
 const PalindromePay_json_1 = __importDefault(require("./contract/PalindromePay.json"));
 const PalindromePayWallet_json_1 = __importDefault(require("./contract/PalindromePayWallet.json"));
 const USDT_json_1 = __importDefault(require("./contract/USDT.json"));
-const client_1 = require("@apollo/client");
 /** Type guard to check if error is a Viem error */
 function isViemError(error) {
     return (typeof error === 'object' &&
@@ -100,6 +99,8 @@ const MAX_STRING_LENGTH = 500;
 const USER_REJECTION_CODE = 4001;
 /** Seconds per day for maturity calculations */
 const SECONDS_PER_DAY = 86400n;
+/** Maximum maturity days (10 years) */
+const MAX_MATURITY_DAYS = 3650n;
 /** Nonce bitmap word size in bits */
 const NONCE_BITMAP_SIZE = 256;
 /** Default cache TTL in milliseconds */
@@ -201,6 +202,8 @@ class PalindromePaySDK {
         this.tokenDecimalsCache = new Map();
         /** Cache for immutable contract values */
         this.feeReceiverCache = null;
+        /** Cached default arbiter from contract (immutable) */
+        this.defaultArbiterCache = null;
         /** Cached multicall support status per chain (null = not yet detected) */
         this.multicallSupported = null;
         this.STATE_NAMES = [
@@ -267,12 +270,10 @@ class PalindromePaySDK {
         this.defaultGasLimit = config.defaultGasLimit ?? 500000n;
         this.logLevel = config.logLevel ?? 'info';
         this.logger = config.logger ?? (this.logLevel === 'none' ? noOpLogger : defaultLogger);
-        this.apollo = config.apolloClient ?? new client_1.ApolloClient({
-            link: new client_1.HttpLink({
-                uri: config.subgraphUrl ?? "https://api.studio.thegraph.com/query/121986/palindrome-finance-subgraph/version/latest",
-            }),
-            cache: new client_1.InMemoryCache(),
-        });
+        if (!config.apolloClient) {
+            throw new SDKError("apolloClient is required", SDKErrorCode.VALIDATION_ERROR);
+        }
+        this.apollo = config.apolloClient;
     }
     // ==========================================================================
     // PRIVATE HELPERS
@@ -419,6 +420,9 @@ class PalindromePaySDK {
         if (maturityDays < 0n) {
             throw new SDKError("Maturity days cannot be negative", SDKErrorCode.VALIDATION_ERROR);
         }
+        if (maturityDays > MAX_MATURITY_DAYS) {
+            throw new SDKError(`Maturity days cannot exceed ${MAX_MATURITY_DAYS} days (10 years)`, SDKErrorCode.VALIDATION_ERROR);
+        }
         if (!title || title.trim().length === 0) {
             throw new SDKError("Title cannot be empty", SDKErrorCode.VALIDATION_ERROR);
         }
@@ -1041,10 +1045,19 @@ class PalindromePaySDK {
         // Validate and normalize addresses
         const token = validateAddress(params.token, "token");
         const buyer = validateAddress(params.buyer, "buyer");
-        const arbiter = params.arbiter
-            ? validateAddress(params.arbiter, "arbiter")
-            : viem_1.zeroAddress;
         const sellerAddress = walletClient.account.address;
+        // Use default arbiter if none provided, reject zero address
+        let arbiter;
+        if (params.arbiter) {
+            const validatedArbiter = validateAddress(params.arbiter, "arbiter");
+            if (isZeroAddress(validatedArbiter)) {
+                throw new SDKError("Zero address not allowed for arbiter. Omit arbiter param to use Palindrome Pay default.", SDKErrorCode.VALIDATION_ERROR);
+            }
+            arbiter = validatedArbiter;
+        }
+        else {
+            arbiter = await this.getDefaultArbiter();
+        }
         const maturityDays = params.maturityTimeDays ?? 1n;
         // Validate using helper
         this.validateCreateEscrowParams({
@@ -1057,13 +1070,11 @@ class PalindromePaySDK {
             title: params.title,
         });
         // Validate arbiter is not buyer or seller
-        if (!isZeroAddress(arbiter)) {
-            if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(buyer)) {
-                throw new SDKError("Arbiter cannot be the buyer", SDKErrorCode.VALIDATION_ERROR);
-            }
-            if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(sellerAddress)) {
-                throw new SDKError("Arbiter cannot be the seller", SDKErrorCode.VALIDATION_ERROR);
-            }
+        if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(buyer)) {
+            throw new SDKError("Arbiter cannot be the buyer", SDKErrorCode.VALIDATION_ERROR);
+        }
+        if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(sellerAddress)) {
+            throw new SDKError("Arbiter cannot be the seller", SDKErrorCode.VALIDATION_ERROR);
         }
         const ipfsHash = params.ipfsHash ?? "";
         // Predict next escrow ID and wallet address
@@ -1158,10 +1169,19 @@ class PalindromePaySDK {
         // Validate and normalize addresses
         const token = validateAddress(params.token, "token");
         const seller = validateAddress(params.seller, "seller");
-        const arbiter = params.arbiter
-            ? validateAddress(params.arbiter, "arbiter")
-            : viem_1.zeroAddress;
         const buyerAddress = walletClient.account.address;
+        // Use default arbiter if none provided, reject zero address
+        let arbiter;
+        if (params.arbiter) {
+            const validatedArbiter = validateAddress(params.arbiter, "arbiter");
+            if (isZeroAddress(validatedArbiter)) {
+                throw new SDKError("Zero address not allowed for arbiter. Omit arbiter param to use Palindrome Pay default.", SDKErrorCode.VALIDATION_ERROR);
+            }
+            arbiter = validatedArbiter;
+        }
+        else {
+            arbiter = await this.getDefaultArbiter();
+        }
         const maturityDays = params.maturityTimeDays ?? 1n;
         // Validate using helper
         this.validateCreateEscrowParams({
@@ -1174,13 +1194,11 @@ class PalindromePaySDK {
             title: params.title,
         });
         // Validate arbiter is not buyer or seller
-        if (!isZeroAddress(arbiter)) {
-            if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(seller)) {
-                throw new SDKError("Arbiter cannot be the seller", SDKErrorCode.VALIDATION_ERROR);
-            }
-            if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(buyerAddress)) {
-                throw new SDKError("Arbiter cannot be the buyer", SDKErrorCode.VALIDATION_ERROR);
-            }
+        if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(seller)) {
+            throw new SDKError("Arbiter cannot be the seller", SDKErrorCode.VALIDATION_ERROR);
+        }
+        if ((0, viem_1.getAddress)(arbiter) === (0, viem_1.getAddress)(buyerAddress)) {
+            throw new SDKError("Arbiter cannot be the buyer", SDKErrorCode.VALIDATION_ERROR);
         }
         const ipfsHash = params.ipfsHash ?? "";
         // Approve token spending
@@ -2189,6 +2207,7 @@ class PalindromePaySDK {
         this.escrowCache.clear();
         this.tokenDecimalsCache.clear();
         this.feeReceiverCache = null;
+        this.defaultArbiterCache = null;
         this.cachedFeeBps = null;
         this.multicallSupported = null;
         await this.clearApolloCache();
@@ -2814,6 +2833,34 @@ class PalindromePaySDK {
         });
         return this.feeReceiverCache;
     }
+    /**
+     * Check if an escrow uses the default Palindrome Pay arbiter.
+     *
+     * @param escrow - The escrow data to check
+     * @returns True if the escrow uses the default arbiter
+     */
+    async isDefaultArbiter(escrow) {
+        const defaultArbiter = await this.getDefaultArbiter();
+        return escrow.arbiter.toLowerCase() === defaultArbiter.toLowerCase();
+    }
+    /**
+     * Get the default Palindrome Pay arbiter address from contract.
+     * Result is cached since the value is immutable.
+     *
+     * @returns The default arbiter address
+     */
+    async getDefaultArbiter() {
+        if (this.defaultArbiterCache) {
+            return this.defaultArbiterCache;
+        }
+        const arbiter = await (0, actions_1.readContract)(this.publicClient, {
+            address: this.contractAddress,
+            abi: PalindromePay_json_1.default.abi,
+            functionName: "DEFAULT_ARBITER",
+        });
+        this.defaultArbiterCache = arbiter;
+        return this.defaultArbiterCache;
+    }
     /**
      * Get fee percentage in basis points.
      * Tries to read FEE_BPS from contract, falls back to default (100 = 1%).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@palindromepay/sdk",
-  "version": "2.0.6",
+  "version": "2.0.7",
   "description": "TypeScript SDK for PalindromeCryptoEscrow - Secure blockchain escrow with buyer/seller protection",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,7 +34,7 @@
   "bugs": {
     "url": "https://github.com/palindromepay/SDKPalindromePay/issues"
   },
-  "homepage": "https://sdk.palindromepay.com",
+  "homepage": "https://www.palindromepay.com/sdk",
   "files": [
     "dist",
     "README.md",
@@ -56,6 +56,9 @@
     "undici-types": "^7.16.0",
     "viem": "^2.38.0"
   },
+  "peerDependencies": {
+    "@apollo/client": "^4.0.0"
+  },
   "devDependencies": {
     "@apollo/client": "^4.0.7",
     "@types/jest": "^30.0.0",