Merge pull request #373 from rsodre/dont-include-hashed-keys

fix: added missing params to getEventMessages()
dojoengine · Jan 14, 2025 · 3bf693c · 3bf693c
2 parents 2847bde + 194bee2
commit 3bf693c
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 91 deletions.
diff --git a/packages/sdk/src/getEntities.ts b/packages/sdk/src/getEntities.ts
@@ -2,7 +2,7 @@ import * as torii from "@dojoengine/torii-client";
 
 import { convertQueryToClause } from "./convertQuerytoClause";
 import { parseEntities } from "./parseEntities";
-import { QueryType, SchemaType, StandardizedQueryResult } from "./types";
+import { GetParams, SchemaType, StandardizedQueryResult } from "./types";
 
 /**
  * Fetches entities from the Torii client based on the provided query.
@@ -26,20 +26,22 @@ import { QueryType, SchemaType, StandardizedQueryResult } from "./types";
  *     }
  * }, 100, 0, { logging: true });
  */
-export async function getEntities<T extends SchemaType>(
-    client: torii.ToriiClient,
-    query: QueryType<T>,
-    schema: T,
-    callback: (response: {
-        data?: StandardizedQueryResult<T>;
-        error?: Error;
-    }) => void,
-    orderBy: torii.OrderBy[] = [],
-    entityModels: string[] = [],
-    limit: number = 100, // Default limit
-    offset: number = 0, // Default offset
-    options?: { logging?: boolean } // Logging option
-): Promise<StandardizedQueryResult<T>> {
+export async function getEntities<T extends SchemaType>({
+    client,
+    schema,
+    query,
+    callback,
+    orderBy = [],
+    entityModels = [],
+    limit = 100, // Default limit
+    offset = 0, // Default offset
+    options = { logging: false }, // Logging option
+    dontIncludeHashedKeys = false,
+    entityUpdatedAfter = 0,
+}: GetParams<T> & {
+    client: torii.ToriiClient;
+    schema: T;
+}): Promise<StandardizedQueryResult<T>> {
     const clause = convertQueryToClause(query, schema);
 
     let cursor = offset;
@@ -53,8 +55,8 @@ export async function getEntities<T extends SchemaType>(
             order_by: orderBy,
             entity_models: entityModels,
             clause,
-            dont_include_hashed_keys: false,
-            entity_updated_after: 0,
+            dont_include_hashed_keys: dontIncludeHashedKeys,
+            entity_updated_after: entityUpdatedAfter,
         };
 
         try {

diff --git a/packages/sdk/src/getEventMessages.ts b/packages/sdk/src/getEventMessages.ts
@@ -2,12 +2,7 @@ import * as torii from "@dojoengine/torii-client";
 
 import { convertQueryToClause } from "./convertQuerytoClause";
 import { parseEntities } from "./parseEntities";
-import {
-    ParsedEntity,
-    QueryType,
-    SchemaType,
-    StandardizedQueryResult,
-} from "./types";
+import { GetParams, SchemaType, StandardizedQueryResult } from "./types";
 import { parseHistoricalEvents } from "./parseHistoricalEvents";
 
 /**
@@ -32,23 +27,24 @@ import { parseHistoricalEvents } from "./parseHistoricalEvents";
  *     }
  * }, 100, 0, { logging: true });
  */
-export async function getEventMessages<T extends SchemaType>(
-    client: torii.ToriiClient,
-    query: QueryType<T>,
-    schema: T,
-    callback: (response: {
-        data?: StandardizedQueryResult<T> | StandardizedQueryResult<T>[];
-        error?: Error;
-    }) => void,
-    orderBy: torii.OrderBy[] = [],
-    entityModels: string[] = [],
-    limit: number = 100, // Default limit
-    offset: number = 0, // Default offset
-    options?: { logging?: boolean }, // Logging option
-    historical?: boolean
-): Promise<StandardizedQueryResult<T> | StandardizedQueryResult<T>[]> {
+export async function getEventMessages<T extends SchemaType>({
+    client,
+    schema,
+    query,
+    callback,
+    orderBy = [],
+    entityModels = [],
+    limit = 100, // Default limit
+    offset = 0, // Default offset
+    options = { logging: false }, // Logging option
+    historical = true,
+    dontIncludeHashedKeys = true,
+    entityUpdatedAfter = 0,
+}: GetParams<T> & {
+    client: torii.ToriiClient;
+    schema: T;
+}): Promise<StandardizedQueryResult<T> | StandardizedQueryResult<T>[]> {
     const clause = convertQueryToClause(query, schema);
-    const isHistorical = !!historical;
 
     let cursor = offset;
     let continueFetching = true;
@@ -61,14 +57,14 @@ export async function getEventMessages<T extends SchemaType>(
             order_by: orderBy,
             entity_models: entityModels,
             clause,
-            dont_include_hashed_keys: true,
-            entity_updated_after: 0,
+            dont_include_hashed_keys: dontIncludeHashedKeys,
+            entity_updated_after: entityUpdatedAfter,
         };
 
         try {
             const entities = await client.getEventMessages(
                 toriiQuery,
-                isHistorical
+                historical
             );
 
             if (options?.logging) {
@@ -77,7 +73,7 @@ export async function getEventMessages<T extends SchemaType>(
 
             Object.assign(allEntities, entities);
 
-            const parsedEntities = isHistorical
+            const parsedEntities = historical
                 ? parseHistoricalEvents<T>(allEntities, options)
                 : parseEntities<T>(allEntities, options);
 
@@ -101,7 +97,7 @@ export async function getEventMessages<T extends SchemaType>(
         console.log("All fetched entities:", allEntities);
     }
 
-    return isHistorical
+    return historical
         ? parseHistoricalEvents<T>(allEntities, options)
         : parseEntities<T>(allEntities, options);
 }
diff --git a/packages/sdk/src/index.ts b/packages/sdk/src/index.ts
@@ -46,22 +46,22 @@ export async function init<T extends SchemaType>(
          * @returns {Promise<void>} - A promise that resolves when the subscription is set up.
          */
         subscribeEntityQuery: ({ query, callback, options }) =>
-            subscribeEntityQuery(client, query, schema, callback, options),
+            subscribeEntityQuery({ client, schema, query, callback, options }),
         /**
          * Subscribes to event queries.
          *
          * @param {SubscribeParams<T>} params - Parameters object
          * @returns {Promise<void>} - A promise that resolves when the subscription is set up.
          */
         subscribeEventQuery: ({ query, callback, options, historical }) =>
-            subscribeEventQuery(
+            subscribeEventQuery({
                 client,
-                query,
                 schema,
+                query,
                 callback,
                 options,
-                historical
-            ),
+                historical,
+            }),
         /**
          * Fetches entities based on the provided query.
          *
@@ -76,18 +76,22 @@ export async function init<T extends SchemaType>(
             limit,
             offset,
             options,
+            dontIncludeHashedKeys,
+            entityUpdatedAfter,
         }) =>
-            getEntities(
+            getEntities({
                 client,
-                query,
                 schema,
+                query,
                 callback,
                 orderBy,
                 entityModels,
                 limit,
                 offset,
-                options
-            ),
+                options,
+                dontIncludeHashedKeys,
+                entityUpdatedAfter,
+            }),
         /**
          * Fetches event messages based on the provided query.
          *
@@ -103,19 +107,23 @@ export async function init<T extends SchemaType>(
             offset,
             options,
             historical,
+            dontIncludeHashedKeys,
+            entityUpdatedAfter,
         }) =>
-            getEventMessages(
+            getEventMessages({
                 client,
-                query,
                 schema,
+                query,
                 callback,
                 orderBy,
                 entityModels,
                 limit,
                 offset,
                 options,
-                historical
-            ),
+                historical,
+                dontIncludeHashedKeys,
+                entityUpdatedAfter,
+            }),
 
         /**
          * Generates typed data for any user-defined message.

diff --git a/packages/sdk/src/subscribeEntityQuery.ts b/packages/sdk/src/subscribeEntityQuery.ts
@@ -2,11 +2,7 @@ import * as torii from "@dojoengine/torii-client";
 
 import { convertQueryToEntityKeyClauses } from "./convertQueryToEntityKeyClauses";
 import { parseEntities } from "./parseEntities";
-import {
-    SchemaType,
-    StandardizedQueryResult,
-    SubscriptionQueryType,
-} from "./types";
+import { SchemaType, StandardizedQueryResult, SubscribeParams } from "./types";
 
 /**
  * Subscribes to entity updates based on the provided query and invokes the callback with the updated data.
@@ -28,16 +24,16 @@ import {
  *     }
  * }, { logging: true });
  */
-export async function subscribeEntityQuery<T extends SchemaType>(
-    client: torii.ToriiClient,
-    query: SubscriptionQueryType<T>,
-    schema: T,
-    callback?: (response: {
-        data?: StandardizedQueryResult<T>;
-        error?: Error;
-    }) => void,
-    options?: { logging?: boolean }
-): Promise<torii.Subscription> {
+export async function subscribeEntityQuery<T extends SchemaType>({
+    client,
+    schema,
+    query,
+    callback,
+    options = { logging: false },
+}: SubscribeParams<T> & {
+    client: torii.ToriiClient;
+    schema: T;
+}): Promise<torii.Subscription> {
     if (options?.logging) {
         console.log("Query:", query);
         console.log(

diff --git a/packages/sdk/src/subscribeEventQuery.ts b/packages/sdk/src/subscribeEventQuery.ts
@@ -2,11 +2,7 @@ import * as torii from "@dojoengine/torii-client";
 
 import { convertQueryToEntityKeyClauses } from "./convertQueryToEntityKeyClauses";
 import { parseEntities } from "./parseEntities";
-import {
-    SchemaType,
-    StandardizedQueryResult,
-    SubscriptionQueryType,
-} from "./types";
+import { SchemaType, StandardizedQueryResult, SubscribeParams } from "./types";
 import { parseHistoricalEvents } from "./parseHistoricalEvents";
 
 /**
@@ -29,26 +25,25 @@ import { parseHistoricalEvents } from "./parseHistoricalEvents";
  *     }
  * }, { logging: true });
  */
-export async function subscribeEventQuery<T extends SchemaType>(
-    client: torii.ToriiClient,
-    query: SubscriptionQueryType<T>,
-    schema: T,
-    callback?: (response: {
-        data?: StandardizedQueryResult<T> | StandardizedQueryResult<T>[];
-        error?: Error;
-    }) => void,
-    options?: { logging?: boolean },
-    historical?: boolean
-): Promise<torii.Subscription> {
-    const isHistorical = !!historical;
+export async function subscribeEventQuery<T extends SchemaType>({
+    client,
+    schema,
+    query,
+    callback,
+    options = { logging: false },
+    historical = true,
+}: SubscribeParams<T> & {
+    client: torii.ToriiClient;
+    schema: T;
+}): Promise<torii.Subscription> {
     return client.onEventMessageUpdated(
         convertQueryToEntityKeyClauses(query, schema),
-        isHistorical,
+        historical,
         (entityId: string, entityData: any) => {
             try {
                 if (callback) {
                     const data = { [entityId]: entityData };
-                    const parsedData = isHistorical
+                    const parsedData = historical
                         ? parseHistoricalEvents<T>(data, options)
                         : parseEntities<T>(data, options);
                     if (options?.logging) {

diff --git a/packages/sdk/src/types.ts b/packages/sdk/src/types.ts
@@ -416,4 +416,8 @@ export interface GetParams<T extends SchemaType> {
     options?: SDKFunctionOptions;
     // historical events
     historical?: boolean;
+    // hashed keys on events
+    dontIncludeHashedKeys?: boolean;
+    // entity updated after
+    entityUpdatedAfter?: number;
 }