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/internal/createSDK.ts

@@ -28,7 +28,7 @@ import {
     updateTokenBalanceSubscription,
 } from "./token.ts";
 import { subscribeQueryModelCallback } from "./subscribeQueryModel.ts";
-import { Pagination } from "./pagination.ts";
+import { defaultToriiPagination, Pagination } from "./pagination.ts";
 import { parseEntities } from "./parseEntities.ts";
 
 export interface CreateSDKOptions {
@@ -316,9 +316,15 @@ export function createSDK<T extends SchemaType>({
          * @returns {Promise<torii.Controllers>}
          */
         getControllers: async (
-            contract_addresses: string[]
+            contract_addresses: string[],
+            usernames: string[],
+            pagination: torii.Pagination = defaultToriiPagination
         ): Promise<torii.Controllers> => {
-            return await client.getControllers(contract_addresses, []);
+            return await client.getControllers({
+                contract_addresses,
+                usernames,
+                pagination,
+            });
         },
 
         /**

packages/sdk/src/internal/pagination.ts

@@ -1,7 +1,16 @@
-import type { PaginationDirection } from "@dojoengine/torii-wasm/types";
+import type {
+    PaginationDirection,
+    Pagination as ToriiPagination,
+} from "@dojoengine/torii-wasm/types";
 import type { SchemaType, ToriiQueryBuilder } from "./types.ts";
 
 const DEFAULT_LIMIT = 1000;
+export const defaultToriiPagination: ToriiPagination = {
+    limit: DEFAULT_LIMIT,
+    cursor: undefined,
+    direction: "Forward",
+    order_by: [],
+};
 
 /**
  * A generic pagination class that handles cursor-based pagination for query results.

packages/sdk/src/internal/token.ts

@@ -9,6 +9,11 @@ import type {
 } from "./types.ts";
 
 import { addAddressPadding } from "starknet";
+import { defaultToriiPagination } from "./pagination.ts";
+
+type Strict<T> = {
+    [K in keyof T]-?: NonNullable<T[K]>;
+};
 
 /**
  * Creates a safe callback wrapper that handles errors
@@ -49,7 +54,7 @@ export const defaultTokenBalance: torii.TokenBalance = {
 
 function parseTokenRequest<T extends GetTokenRequest & GetTokenBalanceRequest>(
     req: T
-): T {
+): Strict<T> {
     if (req.contractAddresses) {
         req.contractAddresses = req.contractAddresses.map((r) =>
             addAddressPadding(r)
@@ -62,7 +67,12 @@ function parseTokenRequest<T extends GetTokenRequest & GetTokenBalanceRequest>(
         );
     }
 
-    return req;
+    return {
+        contractAddresses: req.accountAddresses ?? [],
+        accountAddresses: req.accountAddresses ?? [],
+        tokenIds: req.tokenIds ?? [],
+        pagination: req.pagination ?? defaultToriiPagination,
+    } as Strict<T>;
 }
 /**
  * @param {GetTokenRequest} request
@@ -72,8 +82,13 @@ export async function getTokens(
     client: torii.ToriiClient,
     request: GetTokenRequest
 ): Promise<torii.Tokens> {
-    const { contractAddresses, tokenIds } = parseTokenRequest(request);
-    return await client.getTokens(contractAddresses ?? [], tokenIds ?? []);
+    const { contractAddresses, tokenIds, pagination } =
+        parseTokenRequest(request);
+    return await client.getTokens({
+        contract_addresses: contractAddresses,
+        token_ids: tokenIds,
+        pagination,
+    });
 }
 
 /**
@@ -84,13 +99,14 @@ export async function getTokenBalances(
     client: torii.ToriiClient,
     request: GetTokenBalanceRequest
 ): Promise<torii.TokenBalances> {
-    const { contractAddresses, accountAddresses, tokenIds } =
+    const { contractAddresses, accountAddresses, tokenIds, pagination } =
         parseTokenRequest(request);
-    return await client.getTokenBalances(
-        contractAddresses ?? [],
-        accountAddresses ?? [],
-        tokenIds ?? []
-    );
+    return await client.getTokenBalances({
+        contract_addresses: contractAddresses,
+        account_addresses: accountAddresses,
+        token_ids: tokenIds,
+        pagination,
+    });
 }
 
 /**

packages/sdk/src/internal/types.ts

@@ -121,7 +121,7 @@ export type ToriiResponse<T extends SchemaType> = Pagination<
  */
 export type SubscribeResponse<T extends SchemaType> = [
     ToriiResponse<T>,
-    torii.Subscription
+    torii.Subscription,
 ];
 
 /**
@@ -130,6 +130,7 @@ export type SubscribeResponse<T extends SchemaType> = [
 export interface GetTokenRequest {
     contractAddresses?: string[];
     tokenIds?: string[];
+    pagination?: torii.Pagination;
 }
 
 /**
@@ -449,10 +450,14 @@ export interface SDK<T extends SchemaType> {
      * Gets controller information for the specified contract addresses.
      *
      * @param {string[]} contract_addresses - Contract addresses to query (empty for all)
+     * @param {string[]} usernames - usernames to query (empty for all)
+     * @param {torii.Pagination} pagination - torii pagination object
      * @returns {Promise<torii.Controllers>} - Controller information
      */
     getControllers: (
-        contract_addresses: string[]
+        contract_addresses: string[],
+        usernames: string[],
+        pagination?: torii.Pagination
     ) => Promise<torii.Controllers>;
 }
 

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>();