@0xobelisk/graphql-client 1.2.0-pre.123 → 1.2.0-pre.125

package/dist/types.d.ts

@@ -118,6 +118,48 @@ export interface DubheUserStorageRow {
     lastUpdateDigest: string;
     lastEventSeq: string;
 }
+export interface SceneStorageRow {
+    sceneId: string;
+    dappKey: string;
+    sceneType: string;
+    sceneTypeRaw: string;
+    authorizationKind?: string | null;
+    authorizationKindRaw?: string | null;
+    authorizedPermitId?: string | null;
+    isDestroyed: boolean;
+    createdAtCheckpoint: string;
+    destroyedAtCheckpoint?: string | null;
+    updatedAtCheckpoint: string;
+    lastUpdateDigest: string;
+    lastEventSeq: string;
+}
+export interface SceneStorageFieldRow {
+    sceneId: string;
+    fieldNameRaw: string;
+    dappKey: string;
+    sceneType: string;
+    sceneTypeRaw: string;
+    fieldName: string;
+    fieldValueRaw?: string | null;
+    isDeleted: boolean;
+    deletedAtCheckpoint?: string | null;
+    updatedAtCheckpoint: string;
+    lastUpdateDigest: string;
+    lastEventSeq: string;
+}
+export interface ObjectStorageRow {
+    objectId: string;
+    dappKey: string;
+    objectType: string;
+    objectTypeRaw: string;
+    entityIdRaw: string;
+    isDestroyed: boolean;
+    createdAtCheckpoint: string;
+    destroyedAtCheckpoint?: string | null;
+    updatedAtCheckpoint: string;
+    lastUpdateDigest: string;
+    lastEventSeq: string;
+}
 export interface DubheDappRuntimeStateRow {
     dappKey: string;
     admin?: string | null;
@@ -254,6 +296,27 @@ export interface DubheClientConfig {
     fetchOptions?: RequestInit;
     retryOptions?: RetryOptions;
     dubheMetadata?: any;
+    /**
+     * When true, outgoing HTTP queries are collected within `batchInterval` ms
+     * and sent as a single batched POST request. The server must have
+     * `enableQueryBatching` / `allowBatchedHttpRequests` enabled (PostGraphile
+     * already sets this by default).
+     *
+     * Default: false
+     */
+    batchRequests?: boolean;
+    /**
+     * Time window (ms) to collect queries before flushing a batch.
+     * Only used when `batchRequests` is true.
+     * Default: 10
+     */
+    batchInterval?: number;
+    /**
+     * Maximum number of operations per batch.
+     * Only used when `batchRequests` is true.
+     * Default: 20
+     */
+    batchMax?: number;
     cacheConfig?: {
         paginatedTables?: string[];
         strategy?: PaginationCacheStrategy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xobelisk/graphql-client",
-  "version": "1.2.0-pre.123",
+  "version": "1.2.0-pre.125",
   "description": "Tookit for interacting with dubhe graphql client",
   "keywords": [
     "sui",

package/src/client.ts

@@ -11,12 +11,98 @@ import {
   FetchPolicy,
   OperationVariables
 } from '@apollo/client';
+import { BatchHttpLink } from '@apollo/client/link/batch-http';
 import { RetryLink } from '@apollo/client/link/retry';
 import { GraphQLWsLink } from '@apollo/client/link/subscriptions';
 import { getMainDefinition } from '@apollo/client/utilities';
 import { createClient } from 'graphql-ws';
 import pluralize from 'pluralize';
 
+/**
+ * Static field registry for Dubhe system tables.
+ *
+ * These tables are exposed via `store_dubhe_*` views in the graphql-server.
+ * They are NOT in the DApp's dubhe.config schema, so `convertTableFields`
+ * cannot auto-discover their fields. Registering them here means callers
+ * can use `getAllTables('dubheDappMarketplaceFees', ...)` without passing
+ * `fields` explicitly.
+ *
+ * Key: the simplified GraphQL field name (after SimpleNamingPlugin strips
+ *      the `storeDubhe` prefix and removes the `all` prefix).
+ * Value: camelCase GraphQL field names matching the PostGraphile schema.
+ */
+const SYSTEM_TABLE_FIELDS: Record<string, string[]> = {
+  dubheDappMarketplaceFees: [
+    'dappKey',
+    'listingId',
+    'coinType',
+    'totalFee',
+    'treasuryAmount',
+    'dappAmount',
+    'updatedAtCheckpoint',
+    'lastUpdateDigest'
+  ],
+  dubheDappRuntimeState: [
+    'dappKey',
+    'admin',
+    'paused',
+    'settlementMode',
+    'creditPool',
+    'writeFeeShareBps',
+    'lastRuntimeEvent',
+    'lastRuntimeActor',
+    'lastRuntimeAmount',
+    'updatedAtCheckpoint',
+    'lastUpdateDigest'
+  ],
+  dubheDappFeeState: [
+    'entityId',
+    'baseFeePerWrite',
+    'bytesFeePerByte',
+    'freeCredit',
+    'creditPool',
+    'totalSettled',
+    'updatedAtTimestampMs',
+    'lastUpdateDigest'
+  ],
+  dubheDappRevenueState: [
+    'entityId',
+    'dappRevenue',
+    'coinType',
+    'updatedAtTimestampMs',
+    'lastUpdateDigest'
+  ],
+  dubheMarketplaceListings: [
+    'dappKey',
+    'listingId',
+    'seller',
+    'recordType',
+    'price',
+    'coinType',
+    'isFungible',
+    'listedUntil',
+    'status',
+    'updatedAtCheckpoint',
+    'lastUpdateDigest'
+  ],
+  dubheSessions: [
+    'dappKey',
+    'canonical',
+    'sessionWallet',
+    'expiresAt',
+    'active',
+    'updatedAtCheckpoint',
+    'lastUpdateDigest'
+  ],
+  dubheUserStorages: [
+    'dappKey',
+    'canonicalOwner',
+    'userStorageId',
+    'updatedAtCheckpoint',
+    'lastUpdateDigest'
+  ]
+};
+
 import {
   DubheClientConfig,
   Connection,
@@ -36,7 +122,10 @@ import {
   MarketplaceListingRow,
   DubheSessionRow,
   DubheUserStorageRow,
-  DubheDappRuntimeStateRow
+  DubheDappRuntimeStateRow,
+  SceneStorageRow,
+  SceneStorageFieldRow,
+  ObjectStorageRow
 } from './types';
 
 // Convert cache policy type
@@ -57,6 +146,37 @@ function mapCachePolicyToFetchPolicy(cachePolicy: CachePolicy): FetchPolicy {
   }
 }
 
+/**
+ * Build the HTTP transport link.
+ *
+ * When `config.batchRequests` is true, returns a `BatchHttpLink` that collects
+ * queries fired within `batchInterval` ms (default 10 ms) and sends them as a
+ * single POST request. The PostGraphile server already has `enableQueryBatching`
+ * enabled, so no server-side changes are needed.
+ *
+ * Falls back to the standard `createHttpLink` when batching is disabled.
+ */
+function buildHttpLink(config: DubheClientConfig): ApolloLink {
+  const fetchFn = (input: RequestInfo | URL, init?: RequestInit) =>
+    fetch(input, { ...config.fetchOptions, ...(init ?? {}) });
+
+  if (config.batchRequests) {
+    return new BatchHttpLink({
+      uri: config.endpoint,
+      headers: config.headers,
+      fetch: fetchFn,
+      batchInterval: config.batchInterval ?? 10,
+      batchMax: config.batchMax ?? 20
+    });
+  }
+
+  return createHttpLink({
+    uri: config.endpoint,
+    headers: config.headers,
+    fetch: fetchFn
+  });
+}
+
 export class DubheGraphqlClient {
   private apolloClient: ApolloClient<NormalizedCacheObject>;
   private subscriptionClient?: any;
@@ -77,12 +197,8 @@ export class DubheGraphqlClient {
       this.parseTableInfoFromConfig();
     }
 
-    // Create HTTP Link
-    const httpLink = createHttpLink({
-      uri: config.endpoint,
-      headers: config.headers,
-      fetch: (input, init) => fetch(input, { ...config.fetchOptions, ...init })
-    });
+    // Create HTTP link (batched or standard depending on config.batchRequests)
+    const httpLink = buildHttpLink(config);
 
     // Create retry link
     const retryLink = new RetryLink({
@@ -248,12 +364,8 @@ export class DubheGraphqlClient {
         this.subscriptionClient = undefined;
       }
 
-      // Recreate HTTP Link
-      const httpLink = createHttpLink({
-        uri: this.currentConfig.endpoint,
-        headers: this.currentConfig.headers,
-        fetch: (input, init) => fetch(input, { ...this.currentConfig.fetchOptions, ...init })
-      });
+      // Recreate HTTP link (batched or standard depending on config)
+      const httpLink = buildHttpLink(this.currentConfig);
 
       // Recreate retry link with current config
       const retryLink = new RetryLink({
@@ -1099,6 +1211,228 @@ export class DubheGraphqlClient {
     );
   }
 
+  /**
+   * Query SceneStorage system rows indexed by the Dubhe indexer
+   * (scene_storages table, exposed as dubheSceneStorages in GraphQL).
+   * Field values live in the companion scene_storage_fields table —
+   * see getSceneStorageFields.
+   */
+  async getSceneStorages(options?: {
+    dappKey?: string;
+    sceneType?: string;
+    sceneId?: string;
+    isDestroyed?: boolean;
+    first?: number;
+    after?: string;
+  }): Promise<Connection<SceneStorageRow>> {
+    const filter: Record<string, any> = {};
+    if (options?.dappKey) filter.dappKey = { equalTo: options.dappKey };
+    if (options?.sceneType) filter.sceneType = { equalTo: options.sceneType };
+    if (options?.sceneId) filter.sceneId = { equalTo: options.sceneId };
+    if (options?.isDestroyed !== undefined) filter.isDestroyed = { equalTo: options.isDestroyed };
+
+    const query = gql`
+      query GetSceneStorages(
+        $first: Int
+        $after: Cursor
+        $filter: StoreDubheSceneStorageFilter
+        $orderBy: [StoreDubheSceneStoragesOrderBy!]
+      ) {
+        dubheSceneStorages(first: $first, after: $after, filter: $filter, orderBy: $orderBy) {
+          totalCount
+          pageInfo {
+            hasNextPage
+            hasPreviousPage
+            startCursor
+            endCursor
+          }
+          edges {
+            cursor
+            node {
+              sceneId
+              dappKey
+              sceneType
+              authorizationKind
+              authorizedPermitId
+              isDestroyed
+              createdAtCheckpoint
+              updatedAtCheckpoint
+              lastUpdateDigest
+              lastEventSeq
+            }
+          }
+        }
+      }
+    `;
+
+    const result = await this.apolloClient.query({
+      query,
+      variables: {
+        first: options?.first ?? 100,
+        after: options?.after,
+        filter: Object.keys(filter).length > 0 ? filter : undefined,
+        orderBy: ['UPDATED_AT_CHECKPOINT_DESC']
+      },
+      fetchPolicy: 'network-only'
+    });
+
+    if (result.error) throw result.error;
+    return (
+      (result.data as any)?.dubheSceneStorages ?? {
+        edges: [],
+        pageInfo: { hasNextPage: false, hasPreviousPage: false },
+        totalCount: 0
+      }
+    );
+  }
+
+  /**
+   * Query raw field rows of SceneStorages (scene_storage_fields table,
+   * exposed as dubheSceneStorageFields in GraphQL). Values are hex-encoded
+   * BCS — decode with the decoders exported from this package.
+   */
+  async getSceneStorageFields(options?: {
+    dappKey?: string;
+    sceneIds?: string[];
+    sceneId?: string;
+    fieldName?: string;
+    isDeleted?: boolean;
+    first?: number;
+    after?: string;
+  }): Promise<Connection<SceneStorageFieldRow>> {
+    const filter: Record<string, any> = {};
+    if (options?.dappKey) filter.dappKey = { equalTo: options.dappKey };
+    if (options?.sceneIds && options.sceneIds.length > 0) filter.sceneId = { in: options.sceneIds };
+    if (options?.sceneId) filter.sceneId = { equalTo: options.sceneId };
+    if (options?.fieldName) filter.fieldName = { equalTo: options.fieldName };
+    if (options?.isDeleted !== undefined) filter.isDeleted = { equalTo: options.isDeleted };
+
+    const query = gql`
+      query GetSceneStorageFields(
+        $first: Int
+        $after: Cursor
+        $filter: StoreDubheSceneStorageFieldFilter
+        $orderBy: [StoreDubheSceneStorageFieldsOrderBy!]
+      ) {
+        dubheSceneStorageFields(first: $first, after: $after, filter: $filter, orderBy: $orderBy) {
+          totalCount
+          pageInfo {
+            hasNextPage
+            hasPreviousPage
+            startCursor
+            endCursor
+          }
+          edges {
+            cursor
+            node {
+              sceneId
+              dappKey
+              sceneType
+              fieldName
+              fieldValueRaw
+              isDeleted
+              updatedAtCheckpoint
+              lastUpdateDigest
+              lastEventSeq
+            }
+          }
+        }
+      }
+    `;
+
+    const result = await this.apolloClient.query({
+      query,
+      variables: {
+        first: options?.first ?? 1000,
+        after: options?.after,
+        filter: Object.keys(filter).length > 0 ? filter : undefined,
+        orderBy: ['UPDATED_AT_CHECKPOINT_DESC']
+      },
+      fetchPolicy: 'network-only'
+    });
+
+    if (result.error) throw result.error;
+    return (
+      (result.data as any)?.dubheSceneStorageFields ?? {
+        edges: [],
+        pageInfo: { hasNextPage: false, hasPreviousPage: false },
+        totalCount: 0
+      }
+    );
+  }
+
+  /**
+   * Query ObjectStorage system rows indexed by the Dubhe indexer
+   * (object_storages table, exposed as dubheObjectStorages in GraphQL).
+   */
+  async getObjectStorages(options?: {
+    dappKey?: string;
+    objectType?: string;
+    objectId?: string;
+    isDestroyed?: boolean;
+    first?: number;
+    after?: string;
+  }): Promise<Connection<ObjectStorageRow>> {
+    const filter: Record<string, any> = {};
+    if (options?.dappKey) filter.dappKey = { equalTo: options.dappKey };
+    if (options?.objectType) filter.objectType = { equalTo: options.objectType };
+    if (options?.objectId) filter.objectId = { equalTo: options.objectId };
+    if (options?.isDestroyed !== undefined) filter.isDestroyed = { equalTo: options.isDestroyed };
+
+    const query = gql`
+      query GetObjectStorages(
+        $first: Int
+        $after: Cursor
+        $filter: StoreDubheObjectStorageFilter
+        $orderBy: [StoreDubheObjectStoragesOrderBy!]
+      ) {
+        dubheObjectStorages(first: $first, after: $after, filter: $filter, orderBy: $orderBy) {
+          totalCount
+          pageInfo {
+            hasNextPage
+            hasPreviousPage
+            startCursor
+            endCursor
+          }
+          edges {
+            cursor
+            node {
+              objectId
+              dappKey
+              objectType
+              entityIdRaw
+              isDestroyed
+              createdAtCheckpoint
+              updatedAtCheckpoint
+              lastUpdateDigest
+              lastEventSeq
+            }
+          }
+        }
+      }
+    `;
+
+    const result = await this.apolloClient.query({
+      query,
+      variables: {
+        first: options?.first ?? 100,
+        after: options?.after,
+        filter: Object.keys(filter).length > 0 ? filter : undefined,
+        orderBy: ['UPDATED_AT_CHECKPOINT_DESC']
+      },
+      fetchPolicy: 'network-only'
+    });
+
+    if (result.error) throw result.error;
+    return (
+      (result.data as any)?.dubheObjectStorages ?? {
+        edges: [],
+        pageInfo: { hasNextPage: false, hasPreviousPage: false },
+        totalCount: 0
+      }
+    );
+  }
+
   /**
    * Query DApp runtime state (credit pool, admin, package version, etc.).
    * Exposed as dubheDappRuntimeStates in GraphQL.
@@ -1491,12 +1825,24 @@ export class DubheGraphqlClient {
     if (customFields && customFields.length > 0) {
       fields = customFields;
     } else {
-      // Try to get fields from dubhe configuration
-      const autoFields = this.getTableFields(tableName);
-      if (autoFields.length > 0) {
-        fields = autoFields;
+      // 1. Check system table registry first
+      const systemFields = SYSTEM_TABLE_FIELDS[tableName];
+      if (systemFields) {
+        fields = systemFields;
       } else {
-        fields = ['createdAtTimestampMs', 'updatedAtTimestampMs', 'isDeleted', 'lastUpdateDigest'];
+        // 2. Try to get fields from dubhe configuration (DApp store tables)
+        const autoFields = this.getTableFields(tableName);
+        if (autoFields.length > 0) {
+          fields = autoFields;
+        } else {
+          // 3. Generic fallback for store_* tables
+          fields = [
+            'createdAtTimestampMs',
+            'updatedAtTimestampMs',
+            'isDeleted',
+            'lastUpdateDigest'
+          ];
+        }
       }
     }
 
@@ -1504,6 +1850,74 @@ export class DubheGraphqlClient {
 
     return fields.join('\n      ');
   }
+
+  // ── Typed system-table query methods ─────────────────────────────────────
+
+  /** Latest DApp fee state snapshot (credit_pool, total_settled, fee rates). */
+  async getDappFeeState(): Promise<{
+    entityId: string;
+    baseFeePerWrite: string;
+    bytesFeePerByte: string;
+    freeCredit: string;
+    creditPool: string;
+    totalSettled: string;
+    updatedAtTimestampMs: string;
+  } | null> {
+    const result = await this.getAllTables<any>('dubheDappFeeState', { first: 1 }).catch(
+      () => null
+    );
+    return result?.edges?.[0]?.node ?? null;
+  }
+
+  /** Latest DApp revenue balance (USER_PAYS mode collected revenue). */
+  async getDappRevenueState(): Promise<{
+    entityId: string;
+    dappRevenue: string;
+    coinType: string;
+    updatedAtTimestampMs: string;
+  } | null> {
+    const result = await this.getAllTables<any>('dubheDappRevenueState', { first: 1 }).catch(
+      () => null
+    );
+    return result?.edges?.[0]?.node ?? null;
+  }
+
+  /** Latest DApp runtime state (admin, settlement mode, last event). */
+  async getDappRuntimeState(): Promise<{
+    dappKey: string;
+    admin: string;
+    paused: boolean;
+    settlementMode: number;
+    creditPool: string;
+    writeFeeShareBps: number;
+    lastRuntimeEvent: string;
+    lastRuntimeActor: string;
+    lastRuntimeAmount: string;
+  } | null> {
+    const result = await this.getAllTables<any>('dubheDappRuntimeState', { first: 1 }).catch(
+      () => null
+    );
+    return result?.edges?.[0]?.node ?? null;
+  }
+
+  /** Marketplace fee records (one row per listing sold). */
+  async getDappMarketplaceFees(options?: { first?: number; after?: string }): Promise<
+    Connection<{
+      dappKey: string;
+      listingId: string;
+      coinType: string;
+      totalFee: string;
+      treasuryAmount: string;
+      dappAmount: string;
+      updatedAtCheckpoint: string;
+    }>
+  > {
+    return this.getAllTables<any>('dubheDappMarketplaceFees', {
+      first: options?.first ?? 20,
+      after: options?.after,
+      orderBy: [{ field: 'updatedAtCheckpoint', direction: 'DESC' }]
+    });
+  }
 }
 
 // Export convenience function

package/src/decoders.ts

@@ -0,0 +1,100 @@
+/**
+ * Minimal BCS decoders for indexer raw values.
+ *
+ * The Dubhe indexer stores scene/object field values and marketplace record
+ * data as hex-encoded BCS bytes (e.g. "0x0c00000000000000" for u64 12).
+ * These helpers decode the primitive types commonly stored in system tables.
+ */
+
+export const ZERO_ADDRESS = '0x' + '0'.repeat(64);
+
+export function hexToBytes(hex: string): Uint8Array {
+  const clean = hex.replace(/^0x/i, '');
+  const pairs = clean.match(/../g) ?? [];
+  return Uint8Array.from(pairs.map((b) => parseInt(b, 16)));
+}
+
+function readUIntLE(bytes: Uint8Array, offset: number, width: number): bigint {
+  let n = 0n;
+  for (let i = width - 1; i >= 0; i--) {
+    n = (n << 8n) | BigInt(bytes[offset + i] ?? 0);
+  }
+  return n;
+}
+
+/** Read a ULEB128-encoded length prefix. Returns [value, bytesConsumed]. */
+function readUleb(bytes: Uint8Array, offset: number): [number, number] {
+  let value = 0;
+  let shift = 0;
+  let consumed = 0;
+  for (;;) {
+    const byte = bytes[offset + consumed] ?? 0;
+    value |= (byte & 0x7f) << shift;
+    consumed++;
+    if ((byte & 0x80) === 0) break;
+    shift += 7;
+  }
+  return [value, consumed];
+}
+
+export function decodeU8(hex: string): number {
+  return Number(readUIntLE(hexToBytes(hex), 0, 1));
+}
+
+export function decodeU16(hex: string): number {
+  return Number(readUIntLE(hexToBytes(hex), 0, 2));
+}
+
+export function decodeU32(hex: string): number {
+  return Number(readUIntLE(hexToBytes(hex), 0, 4));
+}
+
+export function decodeU64(hex: string): bigint {
+  return readUIntLE(hexToBytes(hex), 0, 8);
+}
+
+export function decodeU128(hex: string): bigint {
+  return readUIntLE(hexToBytes(hex), 0, 16);
+}
+
+export function decodeBool(hex: string): boolean {
+  return (hexToBytes(hex)[0] ?? 0) !== 0;
+}
+
+export function decodeAddress(hex: string): string {
+  const bytes = hexToBytes(hex);
+  return '0x' + Array.from(bytes.slice(0, 32), (b) => b.toString(16).padStart(2, '0')).join('');
+}
+
+export function decodeVectorAddress(hex: string): string[] {
+  const bytes = hexToBytes(hex);
+  const [len, consumed] = readUleb(bytes, 0);
+  const out: string[] = [];
+  for (let i = 0; i < len; i++) {
+    const start = consumed + i * 32;
+    out.push(
+      '0x' +
+        Array.from(bytes.slice(start, start + 32), (b) => b.toString(16).padStart(2, '0')).join('')
+    );
+  }
+  return out;
+}
+
+/** Decode a BCS ascii/utf8 String (ULEB length prefix + bytes). */
+export function decodeString(hex: string): string {
+  const bytes = hexToBytes(hex);
+  const [len, consumed] = readUleb(bytes, 0);
+  return new TextDecoder().decode(bytes.slice(consumed, consumed + len));
+}
+
+/**
+ * Marketplace recordDataRaw is a JSON array of per-field hex strings
+ * (non-key fields, in schema order).
+ */
+export function parseRecordData(recordDataRaw: string): string[] {
+  try {
+    return JSON.parse(recordDataRaw) as string[];
+  } catch {
+    return [recordDataRaw];
+  }
+}

package/src/index.ts

@@ -1,3 +1,4 @@
 export { DubheGraphqlClient, createDubheGraphqlClient, QueryBuilders } from './client';
 export * from './types';
 export type * from './types';
+export * from './decoders';