fix(sdk): zustand historical hook

Author: MartianGreed

.changeset/heavy-waves-hide.md

@@ -0,0 +1,5 @@
+---
+"@dojoengine/sdk": patch
+---
+
+fix: zustand historical state hook

examples/example-vite-react-sdk/src/App.tsx

@@ -1,4 +1,8 @@
-import { KeysClause, ToriiQueryBuilder } from "@dojoengine/sdk";
+import {
+    HistoricalToriiQueryBuilder,
+    KeysClause,
+    ToriiQueryBuilder,
+} from "@dojoengine/sdk";
 
 import { ModelsMapping } from "./typescript/models.gen.ts";
 import { useSystemCalls } from "./useSystemCalls.ts";
@@ -9,6 +13,7 @@ import {
     useDojoSDK,
     useEntityId,
     useEntityQuery,
+    useHistoricalEntityQuery,
     useModel,
 } from "@dojoengine/sdk/react";
 import { addAddressPadding, CairoCustomEnum } from "starknet";
@@ -45,6 +50,22 @@ function App() {
             )
             .includeHashedKeys()
     );
+    useHistoricalEntityQuery(
+        new HistoricalToriiQueryBuilder()
+            .withClause(
+                // Querying Moves and Position models that has at least [account.address] as key
+                KeysClause(
+                    [ModelsMapping.Moves, ModelsMapping.Position],
+                    [
+                        account?.address
+                            ? addAddressPadding(account.address)
+                            : undefined,
+                    ],
+                    "FixedLen"
+                ).build()
+            )
+            .includeHashedKeys()
+    );
 
     const moves = useModel(entityId as string, ModelsMapping.Moves);
     const position = useModel(entityId as string, ModelsMapping.Position);

packages/sdk/src/__tests__/toriiQueryBuilder.test.ts

@@ -1,5 +1,8 @@
 import { describe, expect, it } from "vitest";
-import { ToriiQueryBuilder } from "../internal/toriiQueryBuilder";
+import {
+    ToriiQueryBuilder,
+    HistoricalToriiQueryBuilder,
+} from "../internal/toriiQueryBuilder";
 import type { Clause, OrderBy } from "@dojoengine/torii-wasm";
 import type { SchemaType } from "../internal/types";
 import { ClauseBuilder } from "../internal/clauseBuilder";
@@ -177,3 +180,33 @@ describe("ToriiQueryBuilder", () => {
         });
     });
 });
+describe("HistoricalToriiQueryBuilder", () => {
+    it("should be historical", () => {
+        const builder = new HistoricalToriiQueryBuilder<TestModels>();
+        const query = builder
+            .withLimit(10)
+            .withCursor("cursor")
+            .addEntityModel("dojo_starter-Position")
+            .addOrderBy("x", "Asc")
+            .includeHashedKeys()
+            .build();
+
+        expect(query).toEqual({
+            pagination: {
+                limit: 10,
+                cursor: "cursor",
+                direction: "Forward",
+                order_by: [
+                    {
+                        field: "x",
+                        direction: "Asc",
+                    },
+                ],
+            },
+            clause: undefined,
+            no_hashed_keys: false,
+            models: ["dojo_starter-Position"],
+            historical: true,
+        });
+    });
+});

packages/sdk/src/web/react/hooks/entities.ts

@@ -50,7 +50,7 @@ export function useEntityQuery<Schema extends SchemaType>(
 export function useHistoricalEntityQuery<Schema extends SchemaType>(
     query: ToriiQueryBuilder<Schema>
 ) {
-    if (query.isHistorical()) {
+    if (!query.isHistorical()) {
         throw new Error("Query must be  HistoricalToriiQueryBuilder");
     }
     const { sdk, useDojoStore } = useDojoSDK<() => any, Schema>();