@zkp2p/sdk 0.9.0 → 0.10.0-rc.0

package/README.md

@@ -80,7 +80,7 @@ const client = new Zkp2pClient({
 - `indexerUrl` and `baseApiUrl`: override defaults when you are targeting custom deployments
 - `timeouts`: `{ api?: number }` — API timeout in milliseconds (default 15000)
 
-**No external API key is required.** `createDeposit`, `registerPayeeDetails`, `getQuote`, `getTakerTier`, `signalIntent`, and the rest of the public SDK flows work without `apiKey` or `authorizationToken`. When `baseApiUrl` is configured, `signalIntent()` can auto-fetch a gating service signature from curator `/v3/intent/sign` without auth. Quote responses include resolved maker payee details (`offchainId`, `telegramUsername`, `metadata`) when curator has them.
+**No external API key is required.** `createDeposit`, `registerPayeeDetails`, `getQuote`, `signalIntent`, and the rest of the public SDK flows work without `apiKey` or `authorizationToken`. When `baseApiUrl` is configured, `signalIntent()` can auto-fetch a gating service signature from curator `/v3/intent/sign` without auth. Quote responses include resolved maker payee details (`offchainId`, `telegramUsername`, `metadata`) when curator has them.
 
 Indexer defaults by environment:
 
@@ -96,14 +96,15 @@ Indexer defaults by environment:
 | Payment methods and currencies | `addPaymentMethods`, `removePaymentMethod`, `setPaymentMethodActive`, `addCurrencies`, `removeCurrency`, `deactivateCurrency`, `pruneExpiredIntents`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 | Intents                        | `signalIntent`, `fulfillIntent`, `cancelIntent`, `releaseFundsToPayer`, `getFulfillIntentInputs`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
 | Prepared transactions          | `client.prepareCreateDeposit(...)`, `client.signalIntent.prepare(...)`, `client.fulfillIntent.prepare(...)`, `client.setVaultFee.prepare(...)`, and equivalent prepare flows across the rest of the prepareable write surface                                                                                                                                                                                                                                                                                                                                                                                                                                               |
-| Payee and quote APIs           | `registerPayeeDetails`, `resolvePayeeHash`, `getQuote`, `getQuotesBestByPlatform`, `getTakerTier`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| Payee and quote APIs           | `registerPayeeDetails`, `resolvePayeeHash`, `getQuote`, `getQuotesBestByPlatform`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | Seller automated release       | `uploadSellerCredential`, `getSellerCredentialStatus`, `verifySellerPayment`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
 | Delegation and hooks           | `setDelegate`, `removeDelegate`, `setRateManager`, `clearRateManager`, `setDepositRateManager`, `clearDepositRateManager`, `setDepositPreIntentHook`, `setDepositWhitelistHook`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | Vault / DRM                    | `createRateManager`, `setVaultMinRate`, `setVaultMinRatesBatch`, `setVaultFee`, `setVaultConfig`, `getDepositRateManager`, `getManagerFee`, `getEffectiveRate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| Taker staking                  | `ensureStakeAllowance`, `depositStake`, `depositStakeFor`, partial withdrawal and full-exit methods, stake-owner permission methods, direct StakeVault reads, and exact risk-capacity math                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
 | Oracle config                  | `setOracleRateConfig`, `setOracleRateConfigBatch`, `removeOracleRateConfig`, `updateCurrencyConfigBatch`, `deactivateCurrenciesBatch`, `supportsInlineOracleRateConfig`, `validateOracleFeedsOnChain`                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | RPC reads                      | `getDeposits`, `getDeposit`, `getDepositsById`, `getIntents`, `getIntent`, `getPvDepositById`, `getPvDepositsFromIds`, `getPvAccountDeposits`, `getPvAccountIntents`, `getPvIntent`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 | Indexer                        | `client.indexer.getDeposits`, `getDepositsWithRelations`, `getDepositById`, `getDepositsByIds`, `getDepositsByIdsWithRelations`, `getDepositsByPayeeHash`, `getIntentsForDeposits`, `getOwnerIntents`, `getIntentsByRateManager`, `getIntentByHash`, `getExpiredIntents`, `getFulfilledIntentEvents`, `getIntentFulfillmentAmounts`, `getFulfillmentAndPayment`, `getDepositFundActivities`, `getMakerFundActivities`, `getDepositDailySnapshots`, `getProfitSnapshotsByDeposits`, `getRateManagers`, `getRateManagerDetail`, `getRateManagerDelegations`, `getDelegationForDeposit`, `getManagerDailySnapshots`, `getManualRateUpdates`, `getOracleConfigUpdates`, `query` |
-| React hooks                    | `@zkp2p/sdk/react` exports hooks for deposits, intents, delegation, vaults, payment methods, and taker tier                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| React hooks                    | `@zkp2p/sdk/react` exports hooks for deposits, intents, delegation, vaults, and payment methods                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | Attribution                    | ERC-8021 helpers like `sendTransactionWithAttribution`, `encodeWithAttribution`, and `txOverrides.referrer` support                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
 
 ## Extension Metadata Bridge
@@ -180,7 +181,7 @@ console.log(result.depositDetails);
 
 If you do not pass `payeeDetailsHashes`, `createDeposit()` can register the payee details for you. If you want to pre-register or reuse hashes across deposits, use `registerPayeeDetails()` first.
 
-## Payee Registration, Quotes, and Taker Tier
+## Payee Registration and Quotes
 
 ```ts
 import { resolvePaymentMethodHash } from '@zkp2p/sdk';
@@ -212,18 +213,57 @@ const quote = await client.getQuote({
   isExactFiat: true,
 });
 
-const takerTier = await client.getTakerTier({
-  owner: '0xBuyer',
-  chainId: 8453,
-});
-
 const payeeHash = await client.resolvePayeeHash(
   42n,
   resolvePaymentMethodHash('wise', { env: 'production' }),
 );
 ```
 
-`getQuote()` returns available liquidity plus payee details when authenticated. Use `getQuotesBestByPlatform()` to fetch the best quote per supported payment platform in a single call (handy for cross-platform comparison UIs). `getTakerTier()` returns limits, cooldown data, Peer Pay volume progression, and `volumeBreakdown` rows for taker UX.
+`getQuote()` returns available liquidity plus payee details when authenticated. Use `getQuotesBestByPlatform()` to fetch the best quote per supported payment platform in a single call (handy for cross-platform comparison UIs). Quotes do not reserve or filter by OrchestratorV3 stake capacity; fetch the configured Curator environment's capacity view separately and treat on-chain admission as final.
+
+## Taker Stake & Capacity
+
+```ts
+const amount = 250_000000n;
+const approval = await client.ensureStakeAllowance({ amount });
+// Wait for approval.hash to confirm when hadAllowance is false.
+
+await client.depositStake({ amount });
+// Or prepare for a smart account/relayer:
+const prepared = await client.depositStakeFor.prepare({
+  taker: delegatedTakerAddress,
+  amount,
+});
+
+const stake = await client.getTakerStake({ owner: takerAddress, chainId: 8453 });
+// stake.responseObject.balances: stakedUsdc, pendingWithdrawalUsdc, eligibleUsdc,
+// reservedUsdc (locked), freeUsdc — each { raw, formatted } in 6-decimal base units.
+
+const capacity = await client.getTakerCapacity({ owner: takerAddress, chainId: 8453 });
+// capacity.responseObject.platforms[]: bondedTakingCapacity, freeTakes, griefing and
+// chargeback curve terms, warnings; operationalGates carries pause state.
+
+const onchain = await client.getStakeVaultState({
+  staker: stakeOwnerAddress,
+  taker: takerAddress,
+});
+```
+
+Stake writes expose direct and `.prepare()` variants: `depositStake`,
+`depositStakeFor`, `requestStakeWithdrawal`, `cancelStakeWithdrawal`,
+`withdrawRequestedStake`, `requestExit`, `cancelExit`, `withdrawStake`,
+`setStakeDelegationEnabled`, `setAllowedStakeOwner`, and `clearStakeOwner`.
+StakeVault is currently staging-only; SDK contract resolution fails closed in
+production/preproduction until a deployment exists.
+
+`getTakerStake()` and `getTakerCapacity()` wrap curator
+`GET /v2/taker/stake` and `GET /v2/taker/capacity`, the hard replacement for
+the removed `/v2/taker/tier` endpoint. Platform capacities are alternative
+views of one shared stake-owner portfolio — never sum them, and never filter
+quotes by capacity. Free takes are separate whole intents (at most
+`amountPerTakeUsdc` each) and cannot be combined with bonded capacity.
+Capacity can change whenever any authorized relayer uses the shared stake, so
+refetch immediately before signaling; the contract stays authoritative.
 
 For table-style liquidity UIs, the low-level `apiGetOrderbookTable()` adapter exposes curator's paginated public/private orderbook rows and row-level privacy metadata.
 
@@ -626,14 +666,12 @@ import {
   useSignalIntent,
   useCreateVault,
   useVaultDelegation,
-  useGetTakerTier,
 } from '@zkp2p/sdk/react';
 
 const createDeposit = useCreateDeposit({ client });
 const signalIntent = useSignalIntent({ client });
 const createVault = useCreateVault({ client, sendTransaction });
 const vaultDelegation = useVaultDelegation({ client, sendTransaction, sendBatch });
-const takerTier = useGetTakerTier({ client, owner, chainId, autoFetch: true });
 ```
 
 Hook groups:
@@ -643,7 +681,7 @@ Hook groups:
 - Intent lifecycle: `useSignalIntent`, `useFulfillIntent`, `useReleaseFundsToPayer`, `usePruneExpiredIntents`
 - Delegation: `useSetDelegate`, `useRemoveDelegate`
 - Vault / DRM: `useCreateVault`, `useVaultDelegation`, `useSetVaultFee`, `useSetVaultMinRate`, `useSetVaultConfig`
-- Taker tier: `useGetTakerTier`, plus `getTierDisplayInfo()` and `getNextTierCap()` helpers
+- Taker stake and capacity: `useGetTakerStake`, `useGetTakerCapacity`
 
 `useVaultDelegation()` is the batching-oriented hook. It returns `delegateDeposit`, `delegateDeposits`, `clearDelegation`, and `clearDelegations`.
 
@@ -654,12 +692,14 @@ import {
   getContracts,
   getPaymentMethodsCatalog,
   getRateManagerContracts,
+  getStakeVaultContract,
   resolveFiatCurrencyBytes32,
   resolvePaymentMethodHash,
 } from '@zkp2p/sdk';
 
 const contracts = getContracts(8453, 'production');
 const rateManagerContracts = getRateManagerContracts(8453, 'production');
+const stakeVault = getStakeVaultContract(8453, 'staging');
 const paymentMethods = getPaymentMethodsCatalog(8453, 'production');
 const usdHash = resolveFiatCurrencyBytes32('USD');
 const wiseHash = resolvePaymentMethodHash('wise', { env: 'production' });