docs(world): add changeset for system call helpers (#1747)

Co-authored-by: alvarius <[email protected]>
latticexyz · Oct 12, 2023 · 7fa2ca1 · 7fa2ca1
1 parent 4fe0793
commit 7fa2ca1
Showing 1 changed file with 47 additions and 0 deletions.
diff --git a/.changeset/chatty-planets-heal.md b/.changeset/chatty-planets-heal.md
@@ -0,0 +1,47 @@
+---
+"@latticexyz/world": minor
+---
+
+Added TS helpers for calling systems dynamically via the World.
+
+- `encodeSystemCall` for `world.call`
+
+  ```ts
+  worldContract.write.call(encodeSystemCall({
+    abi: worldContract.abi,
+    systemId: resourceToHex({ ... }),
+    functionName: "registerDelegation",
+    args: [ ... ],
+  }));
+  ```
+
+- `encodeSystemCallFrom` for `world.callFrom`
+
+  ```ts
+  worldContract.write.callFrom(encodeSystemCallFrom({
+    abi: worldContract.abi,
+    from: "0x...",
+    systemId: resourceToHex({ ... }),
+    functionName: "registerDelegation",
+    args: [ ... ],
+  }));
+  ```
+
+- `encodeSystemCalls` for `world.batchCall`
+
+  ```ts
+  worldContract.write.batchCall(encodeSystemCalls(abi, [{
+    systemId: resourceToHex({ ... }),
+    functionName: "registerDelegation",
+    args: [ ... ],
+  }]));
+  ```
+
+- `encodeSystemCallsFrom` for `world.batchCallFrom`
+  ```ts
+  worldContract.write.batchCallFrom(encodeSystemCallsFrom(abi, "0x...", [{
+    systemId: resourceToHex({ ... }),
+    functionName: "registerDelegation",
+    args: [ ... ],
+  }]));
+  ```