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

package/README.md

@@ -12,35 +12,23 @@ yarn add @zkp2p/contracts-v2
 pnpm add @zkp2p/contracts-v2
 ```
 
-## Quick Start
+## Quick Start (root import)
 
 ```typescript
-import { addresses, abis, constants, paymentMethods } from '@zkp2p/contracts-v2';
+import { addresses, abis, constants, paymentMethods, utils } from '@zkp2p/contracts-v2';
 import { ethers } from 'ethers';
 
-// Get contract addresses for Base mainnet
-const baseAddresses = addresses.base;
-console.log('Orchestrator:', baseAddresses.Orchestrator);
-console.log('Escrow:', baseAddresses.Escrow);
-
-// Get ABIs for Base mainnet
-const baseAbis = abis.base;
-
 // Create contract instance
 const provider = new ethers.providers.JsonRpcProvider('https://mainnet.base.org');
 const orchestrator = new ethers.Contract(
-  baseAddresses.Orchestrator,
-  baseAbis.Orchestrator,
+  addresses.base.Orchestrator,
+  abis.base.Orchestrator,
   provider
 );
 
-// Use network-specific constants
-const baseConstants = constants.base;
-console.log('Intent expiration:', baseConstants.INTENT_EXPIRATION_PERIOD);
-
-// Access payment methods with provider hashes
-const basePaymentMethods = paymentMethods.base;
-console.log('Venmo config:', basePaymentMethods.venmo);
+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));
 ```
 
 ## Features
@@ -51,16 +39,9 @@ Pre-configured addresses for all deployed networks, exported per-network:
 
 ```typescript
 import { addresses } from '@zkp2p/contracts-v2';
-
-// Network-specific addresses
-const baseAddresses = addresses.base;
-const baseSepoliaAddresses = addresses.baseSepolia;
-
-// Access individual contracts
-console.log(baseAddresses.Orchestrator);
-console.log(baseAddresses.Escrow);
-console.log(baseAddresses.UnifiedPaymentVerifier);
-console.log(baseAddresses.SimpleAttestationVerifier);
+console.log(addresses.base.Orchestrator);
+console.log(addresses.base.Escrow);
+console.log(addresses.baseSepolia.UnifiedPaymentVerifier);
 ```
 
 Supported networks:
@@ -73,14 +54,8 @@ Minimal ABIs extracted from on-chain deployments:
 
 ```typescript
 import { abis } from '@zkp2p/contracts-v2';
-
-// Network-specific ABIs
-const baseAbis = abis.base;
-const baseSepoliaAbis = abis.baseSepolia;
-
-// Individual contract ABIs
-const orchestratorABI = baseAbis.Orchestrator;
-const escrowABI = baseAbis.Escrow;
+const orchestratorABI = abis.base.Orchestrator;
+const escrowABI = abis.base.Escrow;
 ```
 
 ### 🔧 Network-Specific Protocol Constants
@@ -89,17 +64,7 @@ All protocol parameters and configurations per network:
 
 ```typescript
 import { constants } from '@zkp2p/contracts-v2';
-
-// Network-specific constants
-const baseConstants = constants.base;
-
-// Protocol parameters
-const {
-  INTENT_EXPIRATION_PERIOD,
-  MAX_INTENTS_PER_DEPOSIT,
-  DUST_THRESHOLD,
-  PARTIAL_MANUAL_RELEASE_DELAY
-} = baseConstants;
+const { INTENT_EXPIRATION_PERIOD, MAX_INTENTS_PER_DEPOSIT, DUST_THRESHOLD } = constants.base;
 ```
 
 ### 💳 Payment Methods with Provider Hashes
@@ -108,14 +73,9 @@ Unified payment method configurations including provider hashes from deployment:
 
 ```typescript
 import { paymentMethods } from '@zkp2p/contracts-v2';
-
-// Network-specific payment methods
-const basePaymentMethods = paymentMethods.base;
-
-// Access payment method configuration
-const venmoConfig = basePaymentMethods.venmo;
-console.log('Payment ID:', venmoConfig.paymentId);
-console.log('Provider Hash:', venmoConfig.providerHash);
+const venmoConfig = paymentMethods.base.venmo;
+console.log('Payment Method Hash:', venmoConfig.paymentMethodHash);
+console.log('Provider Hashes:', venmoConfig.providerHashes);
 console.log('Currencies:', venmoConfig.currencies);
 console.log('Timestamp Buffer:', venmoConfig.timestampBuffer);
 ```
@@ -126,67 +86,29 @@ Protocol utility functions:
 
 ```typescript
 import { utils } from '@zkp2p/contracts-v2';
-import { Currency, getCurrencyInfo, getPaymentMethodId } from '@zkp2p/contracts-v2';
-
-// Currency utilities
-const usdInfo = getCurrencyInfo(Currency.USD);
+const usdInfo = utils.getCurrencyInfo(utils.Currency.USD);
 console.log('Currency code:', usdInfo.code);
 console.log('Decimals:', usdInfo.decimals);
-
-// Payment method utilities
-const venmoId = getPaymentMethodId('venmo');
 ```
 
 
 ## API Reference
 
-### Main Exports
-
-| Export | Type | Description |
-|--------|------|-------------|
-| `addresses` | Object | Network-specific contract addresses |
-| `abis` | Object | Network-specific contract ABIs |
-| `constants` | Object | Network-specific protocol constants |
-| `paymentMethods` | Object | Network-specific payment method configs |
-| `utils` | Object | Protocol utility functions |
-| `Currency` | Enum | Currency enumeration |
-| `getCurrencyInfo` | Function | Get currency details |
-| `getPaymentMethodId` | Function | Get payment method identifier |
-
-### Package Exports
-
-The package provides multiple entry points:
-
-```json
-{
-  "@zkp2p/contracts-v2": "Main package exports",
-  "@zkp2p/contracts-v2/addresses": "Address exports only",
-  "@zkp2p/contracts-v2/addresses/*": "Network-specific addresses",
-  "@zkp2p/contracts-v2/abis/*": "Network-specific ABIs", 
-  "@zkp2p/contracts-v2/constants": "Constants exports",
-  "@zkp2p/contracts-v2/constants/*": "Network-specific constants",
-  "@zkp2p/contracts-v2/paymentMethods": "Payment method configs",
-  "@zkp2p/contracts-v2/paymentMethods/*": "Network-specific payment methods",
-  "@zkp2p/contracts-v2/types": "TypeChain types",
-  "@zkp2p/contracts-v2/utils": "Utility functions"
-}
-```
+### Imports
 
-## Development
+- 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`
 
-### Package Scripts
+## Development
 
-From the root directory:
-- `yarn package:extract` - Extract addresses, ABIs, and constants from deployments
-- `yarn package:build` - Build the package for distribution
+### Build & Publish
 
-From the package directory (`packages/contracts`):
-- `yarn extract` - Extract data from deployments
-- `yarn build` - Build package for distribution
-- `yarn clean` - Clean generated files
-- `yarn test` - Run package tests
+From `packages/contracts`:
+- `yarn build` – Clean, extract, and bundle to `dist/`
+- `npm pack` – Preview tarball contents
+- `npm publish --access public` – Publish (runs prepublishOnly)
 
-This ensures the package always reflects the actual deployed state of the protocol.
+Note: The package publishes `dist/` only. Tests and config files are excluded.
 
 ## License
 
@@ -196,4 +118,4 @@ MIT
 
 - [GitHub Repository](https://github.com/zkp2p/zkp2p-v2-contracts)
 - [Documentation](https://docs.zkp2p.xyz)
-- [Website](https://zkp2p.xyz)
+- [Website](https://zkp2p.xyz)

package/dist/addresses/base.json

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

package/dist/addresses/baseSepolia.json

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