♻️ Refactor sdk and add policies

packages/sdk/src/bindings/contracts.gen.ts

@@ -2,38 +2,6 @@ import { DojoProvider } from "@dojoengine/core";
 import { Account, AccountInterface, BigNumberish, ByteArray } from "starknet";
 
 export function setupWorld(provider: DojoProvider) {
-  const Registry_pin = async (snAccount: Account | AccountInterface, achievementId: BigNumberish) => {
-    try {
-      return await provider.execute(
-        snAccount,
-        {
-          contractName: "Registry",
-          entrypoint: "pin",
-          calldata: [achievementId],
-        },
-        "ARCADE",
-      );
-    } catch (error) {
-      console.error(error);
-    }
-  };
-
-  const Registry_unpin = async (snAccount: Account | AccountInterface, achievementId: BigNumberish) => {
-    try {
-      return await provider.execute(
-        snAccount,
-        {
-          contractName: "Registry",
-          entrypoint: "unpin",
-          calldata: [achievementId],
-        },
-        "ARCADE",
-      );
-    } catch (error) {
-      console.error(error);
-    }
-  };
-
   const Registry_registerGame = async (
     snAccount: Account | AccountInterface,
     worldAddress: BigNumberish,
@@ -370,6 +338,37 @@ export function setupWorld(provider: DojoProvider) {
       console.error(error);
     }
   };
+  const Social_pin = async (snAccount: Account | AccountInterface, achievementId: BigNumberish) => {
+    try {
+      return await provider.execute(
+        snAccount,
+        {
+          contractName: "Social",
+          entrypoint: "pin",
+          calldata: [achievementId],
+        },
+        "ARCADE",
+      );
+    } catch (error) {
+      console.error(error);
+    }
+  };
+
+  const Social_unpin = async (snAccount: Account | AccountInterface, achievementId: BigNumberish) => {
+    try {
+      return await provider.execute(
+        snAccount,
+        {
+          contractName: "Social",
+          entrypoint: "unpin",
+          calldata: [achievementId],
+        },
+        "ARCADE",
+      );
+    } catch (error) {
+      console.error(error);
+    }
+  };
 
   const Social_follow = async (snAccount: Account | AccountInterface, target: BigNumberish) => {
     try {
@@ -823,8 +822,6 @@ export function setupWorld(provider: DojoProvider) {
 
   return {
     Registry: {
-      pin: Registry_pin,
-      unpin: Registry_unpin,
       registerGame: Registry_registerGame,
       updateGame: Registry_updateGame,
       publishGame: Registry_publishGame,
@@ -841,6 +838,8 @@ export function setupWorld(provider: DojoProvider) {
       removeAchievement: Registry_removeAchievement,
     },
     Social: {
+      pin: Social_pin,
+      unpin: Social_unpin,
       follow: Social_follow,
       unfollow: Social_unfollow,
       createAlliance: Social_createAlliance,

packages/sdk/src/classes/index.ts

@@ -0,0 +1,2 @@
+export * from "./metadata";
+export * from "./socials";

packages/sdk/src/classes/metadata.ts

@@ -0,0 +1,25 @@
+export class Metadata {
+  constructor(
+    public color: string,
+    public name: string,
+    public description: string,
+    public image: string,
+    public banner: string,
+  ) {
+    this.color = color;
+    this.name = name;
+    this.description = description;
+    this.image = image;
+    this.banner = banner;
+  }
+
+  static from(value: string) {
+    try {
+      const json = JSON.parse(value);
+      return new Metadata(json.color, json.name, json.description, json.image, json.banner);
+    } catch (error: unknown) {
+      console.error("Error parsing metadata:", error);
+      return new Metadata("", "", "", "", "");
+    }
+  }
+}

packages/sdk/src/classes/socials.ts

@@ -0,0 +1,25 @@
+export class Socials {
+  constructor(
+    public discord: string,
+    public telegram: string,
+    public twitter: string,
+    public youtube: string,
+    public website: string,
+  ) {
+    this.discord = discord;
+    this.telegram = telegram;
+    this.twitter = twitter;
+    this.youtube = youtube;
+    this.website = website;
+  }
+
+  static from(value: string) {
+    try {
+      const json = JSON.parse(value);
+      return new Socials(json.discord, json.telegram, json.twitter, json.youtube, json.website);
+    } catch (error: unknown) {
+      console.error("Error parsing socials:", error);
+      return new Socials("", "", "", "", "");
+    }
+  }
+}

packages/sdk/src/index.ts

@@ -3,3 +3,4 @@ export * from "./provider";
 export * from "./bindings";
 export * from "./manifests";
 export * from "./modules";
+export * from "./classes";

packages/sdk/src/modules/index.ts

@@ -1,4 +1,5 @@
 export * from "./registry";
+export * from "./social";
 import { init } from "@dojoengine/sdk";
 import { configs } from "../configs";
 import { SchemaType, schema } from "../bindings/models.gen";

packages/sdk/src/modules/registry/achievement.ts

@@ -34,11 +34,13 @@ export class AchievementModel {
 }
 
 export const Achievement = {
+  address: undefined as string | undefined,
   sdk: undefined as SDK<SchemaType> | undefined,
   unsubscribe: undefined as (() => void) | undefined,
 
-  init: (sdk: SDK<SchemaType>) => {
+  init: (sdk: SDK<SchemaType>, address: string) => {
     Achievement.sdk = sdk;
+    Achievement.address = address;
   },
 
   fetch: async (callback: (models: AchievementModel[]) => void) => {
@@ -101,4 +103,30 @@ export const Achievement = {
     Achievement.unsubscribe();
     Achievement.unsubscribe = undefined;
   },
+
+  policies: () => {
+    if (!Achievement.address) {
+      throw new Error("Achievement module is not initialized");
+    }
+    return {
+      contracts: {
+        [Achievement.address]: {
+          name: "Registry",
+          description: "Registry contract for games and achievements",
+          methods: Achievement.methods(),
+        },
+      },
+    };
+  },
+
+  methods: () => [
+    { name: "register_achievement", entrypoint: "register_achievement", description: "Register an achievement." },
+    { name: "update_achievement", entrypoint: "update_achievement", description: "Update an achievement." },
+    { name: "publish_achievement", entrypoint: "publish_achievement", description: "Publish an achievement." },
+    { name: "hide_achievement", entrypoint: "hide_achievement", description: "Hide an achievement." },
+    { name: "whitelist_achievement", entrypoint: "whitelist_achievement", description: "Whitelist an achievement." },
+    { name: "blacklist_achievement", entrypoint: "blacklist_achievement", description: "Blacklist an achievement." },
+    { name: "remove_achievement", entrypoint: "remove_achievement", description: "Remove an achievement." },
+  ]
 };
+

packages/sdk/src/modules/registry/game.ts

@@ -2,6 +2,7 @@ import { NAMESPACE } from "../../constants";
 import { shortString, addAddressPadding } from "starknet";
 import { SchemaType } from "../../bindings";
 import { ParsedEntity, QueryBuilder, SDK, StandardizedQueryResult } from "@dojoengine/sdk";
+import { Metadata, Socials } from "../../classes";
 
 const MODEL_NAME = "Game";
 
@@ -60,64 +61,14 @@ export class GameModel {
   }
 }
 
-export class Metadata {
-  constructor(
-    public color: string,
-    public name: string,
-    public description: string,
-    public image: string,
-    public banner: string,
-  ) {
-    this.color = color;
-    this.name = name;
-    this.description = description;
-    this.image = image;
-    this.banner = banner;
-  }
-
-  static from(value: string) {
-    try {
-      const json = JSON.parse(value);
-      return new Metadata(json.color, json.name, json.description, json.image, json.banner);
-    } catch (error: unknown) {
-      console.error("Error parsing metadata:", error);
-      return new Metadata("", "", "", "", "");
-    }
-  }
-}
-
-export class Socials {
-  constructor(
-    public discord: string,
-    public telegram: string,
-    public twitter: string,
-    public youtube: string,
-    public website: string,
-  ) {
-    this.discord = discord;
-    this.telegram = telegram;
-    this.twitter = twitter;
-    this.youtube = youtube;
-    this.website = website;
-  }
-
-  static from(value: string) {
-    try {
-      const json = JSON.parse(value);
-      return new Socials(json.discord, json.telegram, json.twitter, json.youtube, json.website);
-    } catch (error: unknown) {
-      console.error("Error parsing socials:", error);
-      return new Socials("", "", "", "", "");
-    }
-  }
-}
-
 export const Game = {
+  address: undefined as string | undefined,
   sdk: undefined as SDK<SchemaType> | undefined,
   unsubscribe: undefined as (() => void) | undefined,
 
-  init: (sdk: SDK<SchemaType>) => {
+  init: (sdk: SDK<SchemaType>, address: string) => {
     Game.sdk = sdk;
+    Game.address = address;
   },
 
   fetch: async (callback: (models: GameModel[]) => void) => {
@@ -180,4 +131,29 @@ export const Game = {
     Game.unsubscribe();
     Game.unsubscribe = undefined;
   },
+
+  policies: () => {
+    if (!Game.address) {
+      throw new Error("Game module is not initialized");
+    }
+    return {
+      contracts: {
+        [Game.address]: {
+          name: "Registry",
+          description: "Registry contract for games and achievements",
+          methods: Game.methods(),
+        },
+      },
+    };
+  },
+
+  methods: () => [
+    { name: "register_game", entrypoint: "register_game", description: "Register a game." },
+    { name: "update_game", entrypoint: "update_game", description: "Update a game." },
+    { name: "publish_game", entrypoint: "publish_game", description: "Publish a game." },
+    { name: "hide_game", entrypoint: "hide_game", description: "Hide a game." },
+    { name: "whitelist_game", entrypoint: "whitelist_game", description: "Whitelist a game." },
+    { name: "blacklist_game", entrypoint: "blacklist_game", description: "Blacklist a game." },
+    { name: "remove_game", entrypoint: "remove_game", description: "Remove a game." },
+  ]
 };

packages/sdk/src/modules/registry/index.ts

@@ -1,16 +1,38 @@
-import { Pinning, PinningEvent } from "./pinning";
-import { Game, GameModel, Metadata, Socials } from "./game";
+import { Game, GameModel } from "./game";
 import { initSDK } from "..";
 import { constants } from "starknet";
-export type { PinningEvent, GameModel, Metadata, Socials };
+import { Achievement } from "./achievement";
+import { configs } from "../../configs";
+import { getContractByName } from "../../provider/helpers";
+
+export type { GameModel };
 
 export const Registry = {
-  Pinning: Pinning,
+  address: undefined as string | undefined,
   Game: Game,
+  Achievement: Achievement,
 
   init: async (chainId: constants.StarknetChainId) => {
+    const config = configs[chainId];
+    const address = getContractByName(config.manifest, "Registry");
     const sdk = await initSDK(chainId);
-    Pinning.init(sdk);
-    Game.init(sdk);
+    Registry.address = address;
+    Game.init(sdk, address);
+    Achievement.init(sdk, address);
+  },
+
+  policies: () => {
+    if (!Registry.address) {
+      throw new Error("Registry module is not initialized");
+    }
+    return {
+      contracts: {
+        [Registry.address]: {
+          name: "Registry",
+          description: "Registry contract for games and achievements",
+          methods: [...Game.methods(), ...Achievement.methods()],
+        },
+      },
+    };
   },
 };