@0xobelisk/graphql-client 1.2.0-pre.99 → 2.0.0

package/LICENSE

@@ -0,0 +1,92 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Obelisk Labs
+
+Licensed Work:        Dubhe
+                      The Licensed Work is (c) 2023 Obelisk Labs
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { ApolloClient, NormalizedCacheObject, Observable, OperationVariables } from '@apollo/client';
-import { DubheClientConfig, Connection, BaseQueryParams, OrderBy, QueryOptions, QueryResult, SubscriptionResult, SubscriptionOptions, StoreTableRow, TypedDocumentNode, MultiTableSubscriptionConfig, MultiTableSubscriptionData, ParsedTableInfo, DubheMetadata } from './types';
+import { DubheClientConfig, Connection, BaseQueryParams, OrderBy, QueryOptions, QueryResult, SubscriptionResult, SubscriptionOptions, StoreTableRow, TypedDocumentNode, MultiTableSubscriptionConfig, MultiTableSubscriptionData, ParsedTableInfo, DubheMetadata, MarketplaceListingRow, DubheSessionRow, DubheUserStorageRow, DubheDappRuntimeStateRow, SceneStorageRow, SceneStorageFieldRow, ObjectStorageRow } from './types';
 export declare class DubheGraphqlClient {
     private apolloClient;
     private subscriptionClient?;
@@ -129,6 +129,84 @@ export declare class DubheGraphqlClient {
     createRealTimeDataStream<T extends StoreTableRow>(tableName: string, initialQuery?: BaseQueryParams & {
         filter?: Record<string, any>;
     }): Observable<Connection<T>>;
+    /**
+     * Query marketplace listings indexed by the Dubhe indexer.
+     * Uses the marketplace_listings PostgreSQL table (exposed as dubheMarketplaceListings in GraphQL).
+     * The record_type field is pre-decoded text ("wheat", "corn", …) and status tracks
+     * active/sold/cancelled directly — no extra RPC calls needed.
+     */
+    getMarketplaceListings(options?: {
+        dappKey?: string;
+        status?: 'listed' | 'sold' | 'cancelled' | 'expired';
+        recordType?: string;
+        seller?: string;
+        first?: number;
+        after?: string;
+    }): Promise<Connection<MarketplaceListingRow>>;
+    /**
+     * Query session keys indexed by the Dubhe indexer (dubheSessions in GraphQL).
+     */
+    getDubheSessions(options?: {
+        dappKey?: string;
+        canonical?: string;
+        active?: boolean;
+        first?: number;
+        after?: string;
+    }): Promise<Connection<DubheSessionRow>>;
+    /**
+     * Query user storage registrations indexed by the Dubhe indexer (dubheUserStorages in GraphQL).
+     */
+    getDubheUserStorages(options?: {
+        dappKey?: string;
+        canonicalOwner?: string;
+        first?: number;
+        after?: string;
+    }): Promise<Connection<DubheUserStorageRow>>;
+    /**
+     * 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.
+     */
+    getSceneStorages(options?: {
+        dappKey?: string;
+        sceneType?: string;
+        sceneId?: string;
+        isDestroyed?: boolean;
+        first?: number;
+        after?: string;
+    }): Promise<Connection<SceneStorageRow>>;
+    /**
+     * 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.
+     */
+    getSceneStorageFields(options?: {
+        dappKey?: string;
+        sceneIds?: string[];
+        sceneId?: string;
+        fieldName?: string;
+        isDeleted?: boolean;
+        first?: number;
+        after?: string;
+    }): Promise<Connection<SceneStorageFieldRow>>;
+    /**
+     * Query ObjectStorage system rows indexed by the Dubhe indexer
+     * (object_storages table, exposed as dubheObjectStorages in GraphQL).
+     */
+    getObjectStorages(options?: {
+        dappKey?: string;
+        objectType?: string;
+        objectId?: string;
+        isDestroyed?: boolean;
+        first?: number;
+        after?: string;
+    }): Promise<Connection<ObjectStorageRow>>;
+    /**
+     * Query DApp runtime state (credit pool, admin, package version, etc.).
+     * Exposed as dubheDappRuntimeStates in GraphQL.
+     */
+    getDubheDappRuntimeState(dappKey: string): Promise<DubheDappRuntimeStateRow | null>;
     private getFilterTypeName;
     private getOrderByTypeName;
     /**
@@ -217,6 +295,48 @@ export declare class DubheGraphqlClient {
      * Convert table fields to GraphQL query string
      */
     private convertTableFields;
+    /** Latest DApp fee state snapshot (credit_pool, total_settled, fee rates). */
+    getDappFeeState(): Promise<{
+        entityId: string;
+        baseFeePerWrite: string;
+        bytesFeePerByte: string;
+        freeCredit: string;
+        creditPool: string;
+        totalSettled: string;
+        updatedAtTimestampMs: string;
+    } | null>;
+    /** Latest DApp revenue balance (USER_PAYS mode collected revenue). */
+    getDappRevenueState(): Promise<{
+        entityId: string;
+        dappRevenue: string;
+        coinType: string;
+        updatedAtTimestampMs: string;
+    } | null>;
+    /** Latest DApp runtime state (admin, settlement mode, last event). */
+    getDappRuntimeState(): Promise<{
+        dappKey: string;
+        admin: string;
+        paused: boolean;
+        settlementMode: number;
+        creditPool: string;
+        writeFeeShareBps: number;
+        lastRuntimeEvent: string;
+        lastRuntimeActor: string;
+        lastRuntimeAmount: string;
+    } | null>;
+    /** Marketplace fee records (one row per listing sold). */
+    getDappMarketplaceFees(options?: {
+        first?: number;
+        after?: string;
+    }): Promise<Connection<{
+        dappKey: string;
+        listingId: string;
+        coinType: string;
+        totalFee: string;
+        treasuryAmount: string;
+        dappAmount: string;
+        updatedAtCheckpoint: string;
+    }>>;
 }
 export declare function createDubheGraphqlClient(config: DubheClientConfig): DubheGraphqlClient;
 export declare const QueryBuilders: {

package/dist/decoders.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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 declare const ZERO_ADDRESS: string;
+export declare function hexToBytes(hex: string): Uint8Array;
+export declare function decodeU8(hex: string): number;
+export declare function decodeU16(hex: string): number;
+export declare function decodeU32(hex: string): number;
+export declare function decodeU64(hex: string): bigint;
+export declare function decodeU128(hex: string): bigint;
+export declare function decodeBool(hex: string): boolean;
+export declare function decodeAddress(hex: string): string;
+export declare function decodeVectorAddress(hex: string): string[];
+/** Decode a BCS ascii/utf8 String (ULEB length prefix + bytes). */
+export declare function decodeString(hex: string): string;
+/**
+ * Marketplace recordDataRaw is a JSON array of per-field hex strings
+ * (non-key fields, in schema order).
+ */
+export declare function parseRecordData(recordDataRaw: string): string[];

package/dist/index.d.ts

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