@zkp2p/indexer-schema 0.1.0

package/README.md

@@ -0,0 +1,67 @@
+# @zkp2p/indexer-schema
+
+Exports the GraphQL schema used by the ZKP2P indexer.
+
+Install
+```
+pnpm add @zkp2p/indexer-schema
+```
+
+Usage
+```
+// Load the SDL string (GraphQL schema) in Node
+import { schemaSDL } from '@zkp2p/indexer-schema';
+// or CommonJS: const { schemaSDL } = require('@zkp2p/indexer-schema');
+
+// Path reference for codegen configs
+schema: node_modules/@zkp2p/indexer-schema/dist/schema.graphql
+```
+
+Notes
+- Includes: Deposit, Intent, DepositPaymentMethod, MethodCurrency.
+- The file is generated at publish time from the indexer repo.
+
+
+## Backend Codegen Example (using domain.graphql)
+
+This is a minimal example to generate TypeScript types from the exported domain schema.
+
+### 1) Install codegen tooling
+
+```
+pnpm add -D @graphql-codegen/cli @graphql-codegen/typescript @graphql-codegen/typescript-operations
+```
+
+### 2) Add a codegen config (codegen.yml)
+
+```
+schema: node_modules/@zkp2p/indexer-schema/dist/schema.graphql
+# Alternatively, if using a workspace dependency:
+# schema: ../zkp2p-indexer/dist/schema.graphql
+
+generates:
+  src/__generated__/types.ts:
+    plugins:
+      - typescript
+      - typescript-operations
+    config:
+      avoidOptionals: true
+```
+
+### 3) Add an npm script
+
+```
+"scripts": {
+  "codegen": "graphql-codegen --config codegen.yml"
+}
+```
+
+### 4) Use the generated types
+
+- Import `Deposit`, `Intent`, etc. operation and type definitions from `src/__generated__/types.ts`.
+- If you serve GraphQL in the backend, you can build an executable schema from `domain.graphql` and provide resolvers that read from the indexer’s DB.
+- If you serve REST, use the generated types to type DTOs and service responses.
+
+Notes
+- We export the schema needed by backend consumers (no raw event entities). It matches the data model our handlers populate.
+- When the schema changes in a breaking way (e.g., a field becomes non‑null), bump the schema package version and update your backend accordingly.

package/dist/index.js

@@ -0,0 +1,4 @@
+const fs = require('fs');
+const path = require('path');
+const schemaSDL = fs.readFileSync(path.join(__dirname, 'schema.graphql'), 'utf8');
+module.exports = { schemaSDL };

package/dist/schema.graphql

@@ -0,0 +1,73 @@
+# Domain types
+
+type Deposit {
+  id: ID!  # escrowAddress_depositId
+  chainId: Int!
+  escrowAddress: String!
+  depositId: BigInt!
+  depositor: String!
+  token: String!
+  amount: BigInt!
+  remainingDeposits: BigInt!
+  intentAmountMin: BigInt!
+  intentAmountMax: BigInt!
+  acceptingIntents: Boolean!
+  status: String!  # ACTIVE | CLOSED | WITHDRAWN
+  
+  # Pre-calculated fields
+  outstandingIntentAmount: BigInt!
+  availableLiquidity: BigInt!
+
+  # Intent counters 
+  totalIntents: Int!
+  signaledIntents: Int!
+  fulfilledIntents: Int!
+  prunedIntents: Int!
+  
+  # Metadata
+  blockNumber: BigInt!
+  timestamp: BigInt!
+  txHash: String!
+  updatedAt: BigInt!
+}
+
+type DepositPaymentMethod {
+  id: ID!
+  chainId: Int!
+  depositIdOnContract: BigInt!
+  depositId: String!
+  paymentMethodHash: String!
+  verifierAddress: String!
+  intentGatingService: String!
+  payeeDetailsHash: String!
+}
+
+type MethodCurrency {
+  id: ID!
+  chainId: Int!
+  depositIdOnContract: BigInt!
+  depositId: String!
+  paymentMethodHash: String!
+  currencyCode: String!
+  minConversionRate: BigInt!  # Currently contract emits this field as conversionRate; todo: update it on contract 
+}
+
+type Intent {
+  id: ID!  # chainId_intentHash
+  intentHash: String!
+  depositId: String!
+  verifier: String!
+  owner: String!
+  toAddress: String!
+  amount: BigInt!
+  fiatCurrency: String!
+  conversionRate: BigInt!
+  status: String!  # SIGNALED | FULFILLED | PRUNED
+  signalTimestamp: BigInt!
+  signalTxHash: String!
+  fulfillTxHash: String
+  pruneTxHash: String
+
+  # Association to payment method
+  paymentMethodHash: String
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@zkp2p/indexer-schema",
+  "version": "0.1.0",
+  "description": "ZKP2P Indexer GraphQL schema",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "exports": {
+    ".": "./dist/index.js",
+    "./schema.graphql": "./dist/schema.graphql"
+  },
+  "files": [
+    "dist/schema.graphql",
+    "dist/index.js",
+    "README.md"
+  ],
+  "scripts": {
+    "prepack": "node scripts/copy-schema.js",
+    "pack:local": "npm pack"
+  },
+  "engines": {
+    "node": ">=16"
+  }
+}