@zkp2p/contracts-v2 0.0.1-rc3 → 0.0.1-rc4

package/README.md

@@ -12,23 +12,25 @@ yarn add @zkp2p/contracts-v2
 pnpm add @zkp2p/contracts-v2
 ```
 
-## Quick Start (root import)
+## Quick Start (subpath imports)
 
 ```typescript
-import { addresses, abis, constants, paymentMethods, utils } from '@zkp2p/contracts-v2';
+import baseAddresses from '@zkp2p/contracts-v2/addresses/base.json';
+import * as baseAbis from '@zkp2p/contracts-v2/abis/base';
+import { base as baseConstants } from '@zkp2p/contracts-v2/constants';
+import { base as basePaymentMethods } from '@zkp2p/contracts-v2/paymentMethods';
 import { ethers } from 'ethers';
 
 // Create contract instance
 const provider = new ethers.providers.JsonRpcProvider('https://mainnet.base.org');
 const orchestrator = new ethers.Contract(
-  addresses.base.Orchestrator,
-  abis.base.Orchestrator,
+  baseAddresses.Orchestrator,
+  baseAbis.Orchestrator,
   provider
 );
 
-console.log('Intent expiration:', constants.base.INTENT_EXPIRATION_PERIOD);
-console.log('Venmo config:', paymentMethods.base.venmo);
-console.log('USD info:', utils.getCurrencyInfo(utils.Currency.USD));
+console.log('Intent expiration:', baseConstants.INTENT_EXPIRATION_PERIOD);
+console.log('Venmo config:', basePaymentMethods.venmo);
 ```
 
 ## Features
@@ -38,10 +40,11 @@ console.log('USD info:', utils.getCurrencyInfo(utils.Currency.USD));
 Pre-configured addresses for all deployed networks, exported per-network:
 
 ```typescript
-import { addresses } from '@zkp2p/contracts-v2';
-console.log(addresses.base.Orchestrator);
-console.log(addresses.base.Escrow);
-console.log(addresses.baseSepolia.UnifiedPaymentVerifier);
+import base from '@zkp2p/contracts-v2/addresses/base.json';
+import baseSepolia from '@zkp2p/contracts-v2/addresses/baseSepolia.json';
+console.log(base.Orchestrator);
+console.log(base.Escrow);
+console.log(baseSepolia.UnifiedPaymentVerifier);
 ```
 
 Supported networks:
@@ -53,9 +56,9 @@ Supported networks:
 Minimal ABIs extracted from on-chain deployments:
 
 ```typescript
-import { abis } from '@zkp2p/contracts-v2';
-const orchestratorABI = abis.base.Orchestrator;
-const escrowABI = abis.base.Escrow;
+import * as baseAbis from '@zkp2p/contracts-v2/abis/base';
+const orchestratorABI = baseAbis.Orchestrator;
+const escrowABI = baseAbis.Escrow;
 ```
 
 ### 🔧 Network-Specific Protocol Constants
@@ -63,8 +66,8 @@ const escrowABI = abis.base.Escrow;
 All protocol parameters and configurations per network:
 
 ```typescript
-import { constants } from '@zkp2p/contracts-v2';
-const { INTENT_EXPIRATION_PERIOD, MAX_INTENTS_PER_DEPOSIT, DUST_THRESHOLD } = constants.base;
+import { base as baseConstants } from '@zkp2p/contracts-v2/constants';
+const { INTENT_EXPIRATION_PERIOD, MAX_INTENTS_PER_DEPOSIT, DUST_THRESHOLD } = baseConstants;
 ```
 
 ### 💳 Payment Methods with Provider Hashes
@@ -72,8 +75,8 @@ const { INTENT_EXPIRATION_PERIOD, MAX_INTENTS_PER_DEPOSIT, DUST_THRESHOLD } = co
 Unified payment method configurations including provider hashes from deployment:
 
 ```typescript
-import { paymentMethods } from '@zkp2p/contracts-v2';
-const venmoConfig = paymentMethods.base.venmo;
+import { base as basePaymentMethods } from '@zkp2p/contracts-v2/paymentMethods';
+const venmoConfig = basePaymentMethods.venmo;
 console.log('Payment Method Hash:', venmoConfig.paymentMethodHash);
 console.log('Provider Hashes:', venmoConfig.providerHashes);
 console.log('Currencies:', venmoConfig.currencies);
@@ -85,7 +88,7 @@ console.log('Timestamp Buffer:', venmoConfig.timestampBuffer);
 Protocol utility functions:
 
 ```typescript
-import { utils } from '@zkp2p/contracts-v2';
+import * as utils from '@zkp2p/contracts-v2/utils';
 const usdInfo = utils.getCurrencyInfo(utils.Currency.USD);
 console.log('Currency code:', usdInfo.code);
 console.log('Decimals:', usdInfo.decimals);
@@ -96,8 +99,13 @@ console.log('Decimals:', usdInfo.decimals);
 
 ### Imports
 
-- Preferred (simple): `import { addresses, abis, constants, paymentMethods, utils } from '@zkp2p/contracts-v2'`
-- Advanced (fine-grained): subpath imports like `@zkp2p/contracts-v2/addresses/base.json` or `@zkp2p/contracts-v2/abis/base`
+- Prefer subpaths for clarity and smaller bundles:
+  - `@zkp2p/contracts-v2/addresses` and `@zkp2p/contracts-v2/addresses/*.json`
+  - `@zkp2p/contracts-v2/abis/<network>`
+  - `@zkp2p/contracts-v2/constants`
+  - `@zkp2p/contracts-v2/paymentMethods`
+  - `@zkp2p/contracts-v2/utils`
+  - `@zkp2p/contracts-v2/types`
 
 ## Development
 

package/dist/addresses/base.json

@@ -15,6 +15,6 @@
     "ZelleCitiReclaimVerifier": "0x3128BadC46Dbe2E37BDd2d64F33fB3B3a639570E"
   },
   "meta": {
-    "generatedAt": "2025-09-01T17:02:37.638Z"
+    "generatedAt": "2025-09-01T17:30:55.247Z"
   }
 }

package/dist/addresses/baseSepolia.json

@@ -15,6 +15,6 @@
     "UnifiedPaymentVerifier": "0x09618E223f22652e3d83B98614A745D12A7ae991"
   },
   "meta": {
-    "generatedAt": "2025-09-01T17:02:37.798Z"
+    "generatedAt": "2025-09-01T17:30:55.330Z"
   }
 }