@zkp2p/indexer-schema 0.2.2 → 0.2.3

package/README.md

@@ -33,7 +33,7 @@ schema: node_modules/@zkp2p/indexer-schema/dist/schema.graphql
 
 ## Exported Types
 
-**Domain entities:** Deposit, DepositPaymentMethod, MethodCurrency, Intent, QuoteCandidate, ReferralFeeDistribution
+**Domain entities:** Deposit, DepositPaymentMethod, MethodCurrency, Intent, QuoteCandidate, WhitelistEntry, ReferralFeeDistribution
 
 **Stats:** TakerStats, MakerStats, MakerPlatformStats, MakerCurrencyStats, ManagerStats, ManagerAggregateStats, ManagerDailySnapshot
 

package/dist/schema.graphql

@@ -68,6 +68,9 @@ type Deposit {
   rateManagerAddress: String
   delegatedAt: BigInt
 
+  # Whitelist hook address (optional)
+  whitelistHookAddress: String  # Address of the active whitelist pre-intent hook (optional)
+
   # Reverse links for convenience in GraphQL (via @derivedFrom)
   intents: [Intent!]! @derivedFrom(field: "depositId")
   paymentMethods: [DepositPaymentMethod!]! @derivedFrom(field: "depositId")
@@ -447,6 +450,7 @@ type QuoteCandidate {
   successRateBps: Int!        # Maker success rate for deposit-level filtering
   payeeDetailsHash: String!   # Hashed payee details required for verification
   intentGatingService: String # Optional gating service that must authorize takers
+  whitelistHookAddress: String # Address of the active whitelist pre-intent hook for this deposit (optional)
   isActive: Boolean!          # Whether this tuple is currently quoteable for takers
   hasMinLiquidity: Boolean!   # Whether availableTokenAmount is at least intentAmountMin
   minFiatSupported: BigInt!   # intentAmountMin converted using takerConversionRate
@@ -454,3 +458,18 @@ type QuoteCandidate {
   maxFiatAvail: BigInt!       # availableTokenAmount converted using takerConversionRate
   updatedAt: BigInt!          # Last time the denormalized row was refreshed
 }
+
+"""
+Per-deposit taker whitelist entry. Created when a taker is whitelisted for a specific deposit via a WhitelistPreIntentHook contract. Deleted when the taker is removed or the hook is rotated.
+"""
+type WhitelistEntry {
+  id: ID!              # escrowAddress_depositId_taker
+  chainId: Int!
+  hookAddress: String!
+  escrowAddress: String! @index
+  depositId: String! @index
+  depositIdOnContract: BigInt!
+  taker: String! @index
+  createdAt: BigInt!
+  updatedAt: BigInt!
+}

package/dist/types.d.ts

@@ -98,6 +98,8 @@ export interface Deposit {
   rateManagerAddress?: string;
   /** Timestamp when the current delegated manager assignment was applied. */
   delegatedAt?: string;
+  /** Optional address of the active whitelist pre-intent hook for private orderbooks. When set, only whitelisted takers can signal intents against this deposit. */
+  whitelistHookAddress?: string;
 }
 
 /**
@@ -840,6 +842,8 @@ export interface QuoteCandidate {
   payeeDetailsHash: string;
   /** Optional gating service copied from `DepositPaymentMethod`. */
   intentGatingService?: string;
+  /** Optional whitelist hook address denormalized from `Deposit`. When non-null, this deposit is private and only whitelisted takers can access it. */
+  whitelistHookAddress?: string;
   /** Final quoteability flag. It is `true` only when the payment method is active, the deposit is accepting intents, and the taker-facing rate is non-zero. */
   isActive: boolean;
   /** Whether `availableTokenAmount >= intentAmountMin`. */
@@ -853,3 +857,32 @@ export interface QuoteCandidate {
   /** Last time the denormalized row was recomputed. */
   updatedAt: string;
 }
+
+/**
+ * Per-deposit taker whitelist entry for private orderbooks. Created when the `WhitelistPreIntentHook` contract emits a `TakerWhitelisted` event and the emitting hook matches the deposit's active `whitelistHookAddress`. Purged when the hook is rotated/cleared via `DepositWhitelistHookSet` or when the taker is explicitly removed.
+ * 
+ * @id escrowAddress_depositId_taker
+ * 
+ * **Relationships:**
+ * - Many-to-one to `Deposit` via `depositId`
+ */
+export interface WhitelistEntry {
+  /** Composite key `escrowAddress_depositId_taker` (all lowercased). */
+  id: string;
+  /** Chain where the deposit lives. */
+  chainId: number;
+  /** Address of the `WhitelistPreIntentHook` contract that emitted the event. */
+  hookAddress: string;
+  /** Escrow contract address scoping the deposit. */
+  escrowAddress: string;
+  /** Foreign-key string to `Deposit.id` (composite: `escrowAddress_depositId`). */
+  depositId: string;
+  /** Raw on-chain deposit identifier. */
+  depositIdOnContract: string;
+  /** Lowercased address of the whitelisted taker. */
+  taker: string;
+  /** Timestamp when the taker was first whitelisted. */
+  createdAt: string;
+  /** Timestamp of the most recent mutation to this entry. */
+  updatedAt: string;
+}

package/dist/types.ts

@@ -100,6 +100,8 @@ export interface Deposit {
   rateManagerAddress?: string;
   /** Timestamp when the current delegated manager assignment was applied. */
   delegatedAt?: string;
+  /** Optional address of the active whitelist pre-intent hook for private orderbooks. When set, only whitelisted takers can signal intents against this deposit. */
+  whitelistHookAddress?: string;
 }
 
 /**
@@ -842,6 +844,8 @@ export interface QuoteCandidate {
   payeeDetailsHash: string;
   /** Optional gating service copied from `DepositPaymentMethod`. */
   intentGatingService?: string;
+  /** Optional whitelist hook address denormalized from `Deposit`. When non-null, this deposit is private and only whitelisted takers can access it. */
+  whitelistHookAddress?: string;
   /** Final quoteability flag. It is `true` only when the payment method is active, the deposit is accepting intents, and the taker-facing rate is non-zero. */
   isActive: boolean;
   /** Whether `availableTokenAmount >= intentAmountMin`. */
@@ -855,3 +859,32 @@ export interface QuoteCandidate {
   /** Last time the denormalized row was recomputed. */
   updatedAt: string;
 }
+
+/**
+ * Per-deposit taker whitelist entry for private orderbooks. Created when the `WhitelistPreIntentHook` contract emits a `TakerWhitelisted` event and the emitting hook matches the deposit's active `whitelistHookAddress`. Purged when the hook is rotated/cleared via `DepositWhitelistHookSet` or when the taker is explicitly removed.
+ * 
+ * @id escrowAddress_depositId_taker
+ * 
+ * **Relationships:**
+ * - Many-to-one to `Deposit` via `depositId`
+ */
+export interface WhitelistEntry {
+  /** Composite key `escrowAddress_depositId_taker` (all lowercased). */
+  id: string;
+  /** Chain where the deposit lives. */
+  chainId: number;
+  /** Address of the `WhitelistPreIntentHook` contract that emitted the event. */
+  hookAddress: string;
+  /** Escrow contract address scoping the deposit. */
+  escrowAddress: string;
+  /** Foreign-key string to `Deposit.id` (composite: `escrowAddress_depositId`). */
+  depositId: string;
+  /** Raw on-chain deposit identifier. */
+  depositIdOnContract: string;
+  /** Lowercased address of the whitelisted taker. */
+  taker: string;
+  /** Timestamp when the taker was first whitelisted. */
+  createdAt: string;
+  /** Timestamp of the most recent mutation to this entry. */
+  updatedAt: string;
+}

package/docs/schema-field-reference.md

@@ -103,6 +103,7 @@ Canonical maker-owned escrow position. This is the root entity for most business
 | `rateManagerId` | Optional delegated rate-manager identifier currently assigned to the deposit. |
 | `rateManagerAddress` | Optional rate-manager contract address paired with `rateManagerId`. |
 | `delegatedAt` | Timestamp when the current delegated manager assignment was applied. |
+| `whitelistHookAddress` | Optional address of the active whitelist pre-intent hook for private orderbooks. When set, only whitelisted takers can signal intents against this deposit. |
 | `intents` | Reverse GraphQL edge to all `Intent` rows whose `depositId` points at this deposit. |
 | `paymentMethods` | Reverse edge to `DepositPaymentMethod` rows for this deposit. |
 | `currencies` | Reverse edge to `MethodCurrency` rows for this deposit. |
@@ -233,6 +234,26 @@ Per-recipient referral-fee settlement rows for v2.2. The `Intent` stores the agg
 | `txHash` | Transaction that emitted the distribution event. |
 | `timestamp` | Settlement timestamp for this distribution row. |
 
+### `WhitelistEntry`
+
+Per-deposit taker whitelist entry for private orderbooks. Created when the `WhitelistPreIntentHook` contract emits a `TakerWhitelisted` event and the emitting hook matches the deposit's active `whitelistHookAddress`. Purged when the hook is rotated/cleared via `DepositWhitelistHookSet` or when the taker is explicitly removed.
+
+**Relationships**
+
+- Many-to-one to `Deposit` via `depositId`
+
+| Field | Meaning |
+| --- | --- |
+| `id` | Composite key `escrowAddress_depositId_taker` (all lowercased). |
+| `chainId` | Chain where the deposit lives. |
+| `hookAddress` | Address of the `WhitelistPreIntentHook` contract that emitted the event. |
+| `escrowAddress` | Escrow contract address scoping the deposit. |
+| `depositId` | Foreign-key string to `Deposit.id` (composite: `escrowAddress_depositId`). |
+| `depositIdOnContract` | Raw on-chain deposit identifier. |
+| `taker` | Lowercased address of the whitelisted taker. |
+| `createdAt` | Timestamp when the taker was first whitelisted. |
+| `updatedAt` | Timestamp of the most recent mutation to this entry. |
+
 ### `TakerStats`
 
 Per-owner behavioral aggregate. This row is updated from signaled, fulfilled/manual-release, and prune flows. In v21 it also carries a `lockScore` penalty based on how long cancelled intents kept liquidity locked.
@@ -582,6 +603,7 @@ Read-optimized quoting view. This is intentionally denormalized so curator/quote
 | `successRateBps` | Deposit-level success signal copied from `Deposit`. |
 | `payeeDetailsHash` | Hashed payee details copied from `DepositPaymentMethod`. |
 | `intentGatingService` | Optional gating service copied from `DepositPaymentMethod`. |
+| `whitelistHookAddress` | Optional whitelist hook address denormalized from `Deposit`. When non-null, this deposit is private and only whitelisted takers can access it. |
 | `isActive` | Final quoteability flag. It is `true` only when the payment method is active, the deposit is accepting intents, and the taker-facing rate is non-zero. |
 | `hasMinLiquidity` | Whether `availableTokenAmount >= intentAmountMin`. |
 | `minFiatSupported` | Fiat value of `intentAmountMin` using the taker-facing rate. |

package/llms.txt

@@ -69,6 +69,7 @@ RateManager (1)──(N) RateManagerRate (per method × currency)
 PriceSnapshot ←── daily FX rates (USD/EUR/GBP/etc.)
 MakerProfitSnapshot ←── per-intent profit: quote rate vs oracle FX rate
 ReferralFeeDistribution ←── per-intent referral fee breakdown
+WhitelistEntry ←── per-deposit taker whitelist for private orderbooks
 ```
 
 ### Explicit Schema Edges
@@ -287,6 +288,25 @@ Per-recipient referral-fee settlement rows for v2.2. The `Intent` stores the agg
 | `txHash` | `string` | Transaction that emitted the distribution event. |
 | `timestamp` | `string (BigInt)` | Settlement timestamp for this distribution row. |
 
+### `WhitelistEntry`
+
+Per-deposit taker whitelist entry for private orderbooks. Created when the `WhitelistPreIntentHook` contract emits `TakerWhitelisted` and the hook matches the deposit's active `whitelistHookAddress`. Purged when the hook is rotated/cleared or the taker is removed.
+
+**Relationships:**
+- Many-to-one to `Deposit` via `depositId`
+
+| Field | Type | Meaning |
+|-------|------|---------|
+| `id` | `string` | Composite key `escrowAddress_depositId_taker` (all lowercased). |
+| `chainId` | `number` | Chain where the deposit lives. |
+| `hookAddress` | `string` | WhitelistPreIntentHook contract address that emitted the event. |
+| `escrowAddress` | `string` | Escrow contract address. |
+| `depositId` | `string` | FK to `Deposit.id` (composite: `escrowAddress_depositId`). |
+| `depositIdOnContract` | `string (BigInt)` | Raw on-chain deposit identifier. |
+| `taker` | `string` | Lowercased address of the whitelisted taker. |
+| `createdAt` | `string (BigInt)` | Timestamp when taker was first whitelisted. |
+| `updatedAt` | `string (BigInt)` | Timestamp of most recent mutation. |
+
 ### `QuoteCandidate`
 
 Read-optimized quoting view. This is intentionally denormalized so curator/quote APIs do not need to join `Deposit`, `DepositPaymentMethod`, and `MethodCurrency` at request time.
@@ -635,6 +655,7 @@ Per-deposit stats row for a delegated manager. Where `ManagerAggregateStats` is
 | QuoteCandidate | same as MethodCurrency |
 | DepositPaymentMethod | `{escrow}_{depositId}_{paymentMethodHash}` |
 | ReferralFeeDistribution | `{chainId}_{intentHash}_{feeRecipient}` |
+| WhitelistEntry | `{escrowAddress}_{depositId}_{taker}` |
 | MakerStats | `{chainId}_{makerAddress}` |
 | TakerStats | `{chainId}_{ownerAddress}` |
 | MakerPlatformStats | `{chainId}_{maker}_{paymentMethodHash}` |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zkp2p/indexer-schema",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "ZKP2P Indexer GraphQL schema and TypeScript types",
   "private": false,
   "publishConfig": {