Merge pull request #420 from dojoengine/feat/sdk-hooks

feat: add useModels hook

Author: MartianGreed

.changeset/brave-kiwis-explode.md

@@ -0,0 +1,15 @@
+---
+"@dojoengine/utils": patch
+"@dojoengine/sdk": patch
+"@dojoengine/core": patch
+"@dojoengine/create-burner": patch
+"@dojoengine/create-dojo": patch
+"@dojoengine/predeployed-connector": patch
+"@dojoengine/react": patch
+"@dojoengine/state": patch
+"@dojoengine/torii-client": patch
+"@dojoengine/torii-wasm": patch
+"@dojoengine/utils-wasm": patch
+---
+
+fix: cairo option and enum ignore in zustand merge

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

@@ -35,7 +35,11 @@ function App() {
                 // Querying Moves and Position models that has at least [account.address] as key
                 KeysClause(
                     [ModelsMapping.Moves, ModelsMapping.Position],
-                    [addAddressPadding(account?.address ?? "0")],
+                    [
+                        account?.address
+                            ? addAddressPadding(account.address)
+                            : undefined,
+                    ],
                     "FixedLen"
                 ).build()
             )

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

@@ -22,8 +22,6 @@ import StarknetProvider from "./starknet-provider.tsx";
 async function main() {
     const sdk = await init<SchemaType>({
         client: {
-            toriiUrl: dojoConfig.toriiUrl,
-            relayUrl: dojoConfig.relayUrl,
             worldAddress: dojoConfig.manifest.world.address,
         },
         domain: {

package.json

@@ -11,7 +11,8 @@
         "format:check": "turbo format:check",
         "release": "pnpm build && pnpm -F './packages/**' publish -r --force --no-git-checks",
         "release:dry-run": "pnpm -F './packages/**' publish -r --force --dry-run",
-        "dev": "turbo dev --concurrency 15"
+        "dev": "turbo watch dev --concurrency 15",
+        "docs": "turbo run docs --ui stream"
     },
     "devDependencies": {
         "@commitlint/cli": "^18.6.1",

packages/sdk/src/experimental/index.ts

@@ -3,14 +3,20 @@ import { SchemaType, SDKConfig, StandardizedQueryResult } from "../types";
 import { parseEntities } from "../parseEntities";
 import { parseHistoricalEvents } from "../parseHistoricalEvents";
 import { intoEntityKeysClause } from "../convertClauseToEntityKeysClause";
+import { defaultClientConfig } from "..";
 
 export type ToriiSubscriptionCallback<T extends SchemaType> = (response: {
     data?: StandardizedQueryResult<T> | StandardizedQueryResult<T>[];
     error?: Error;
 }) => void;
 
 export async function init<T extends SchemaType>(options: SDKConfig) {
-    const client = await torii.createClient(options.client);
+    const clientConfig = {
+        ...defaultClientConfig,
+        ...options.client,
+    } as torii.ClientConfig;
+
+    const client = await torii.createClient(clientConfig);
 
     return {
         getEntities: async (query: torii.Query) => {

packages/sdk/src/index.ts

@@ -1,7 +1,7 @@
 import * as torii from "@dojoengine/torii-client";
-import { Account, Signature, StarknetDomain, TypedData } from "starknet";
+import type { Account, Signature, StarknetDomain, TypedData } from "starknet";
 
-import {
+import type {
     GetParams,
     SchemaType,
     SDK,
@@ -14,7 +14,7 @@ import {
 import { intoEntityKeysClause } from "./convertClauseToEntityKeysClause";
 import { parseEntities } from "./parseEntities";
 import { parseHistoricalEvents } from "./parseHistoricalEvents";
-import { ToriiQueryBuilder } from "./toriiQueryBuilder";
+import type { ToriiQueryBuilder } from "./toriiQueryBuilder";
 import { generateTypedData } from "./generateTypedData";
 
 export * from "./types";
@@ -34,6 +34,11 @@ export async function createClient(
     return await torii.createClient(config);
 }
 
+export const defaultClientConfig: Partial<torii.ClientConfig> = {
+    toriiUrl: "http://localhost:8080",
+    relayUrl: "/ip4/127.0.0.1/tcp/9090",
+};
+
 /**
  * Initializes the SDK with the provided configuration and schema.
  *
@@ -43,7 +48,11 @@ export async function createClient(
 export async function init<T extends SchemaType>(
     options: SDKConfig
 ): Promise<SDK<T>> {
-    const client = await createClient(options.client);
+    const clientConfig = {
+        ...defaultClientConfig,
+        ...options.client,
+    } as torii.ClientConfig;
+    const client = await createClient(clientConfig);
 
     return {
         client,
@@ -137,6 +146,7 @@ export async function init<T extends SchemaType>(
                                 const parsedData = historical
                                     ? parseHistoricalEvents<T>(data)
                                     : parseEntities<T>(data);
+
                                 callback({
                                     data: parsedData as ToriiResponse<
                                         T,

packages/sdk/src/parseEntities.ts

@@ -76,7 +76,8 @@ function parseValue(value: torii.Ty): any {
                     CairoOptionVariant.Some,
                     parseValue((value.value as torii.EnumValue).value)
                 );
-            } else if ("None" === (value.value as torii.EnumValue).option) {
+            }
+            if ("None" === (value.value as torii.EnumValue).option) {
                 return new CairoOption(CairoOptionVariant.None);
             }
 

packages/sdk/src/react/hooks.ts

@@ -63,6 +63,31 @@ export function useModel<
     return modelData;
 }
 
+/**
+ * Custom hook to retrieve all entities that have a specific model.
+ *
+ * @param model - The model to retrieve, specified as a string in the format "namespace-modelName".
+ * @returns The model structure if found, otherwise undefined.
+ */
+export function useModels<
+    N extends keyof SchemaType,
+    M extends keyof SchemaType[N] & string,
+    Client extends (...args: any) => any,
+    Schema extends SchemaType
+>(model: `${N}-${M}`): { [entityId: string]: SchemaType[N][M] | undefined } {
+    const [namespace, modelName] = model.split("-") as [N, M];
+    const { useDojoStore } =
+        useContext<DojoContextType<Client, Schema>>(DojoContext);
+
+    const modelData = useDojoStore((state) =>
+        state.getEntitiesByModel(namespace, modelName).map((entity) => ({
+            [entity.entityId]: entity.models?.[namespace]?.[modelName],
+        }))
+    ) as unknown as { [entityId: string]: SchemaType[N][M] | undefined };
+
+    return modelData;
+}
+
 /**
  * Hook that exposes sdk features.
  *
@@ -223,6 +248,7 @@ export function useEntityQuery<Schema extends SchemaType>(
         processInitialData: (data) => state.mergeEntities(data),
         processUpdateData: (data) => {
             const entity = data.pop();
+
             if (entity && entity.entityId !== "0x0") {
                 state.updateEntity(entity);
             }