chore(world-module-erc20): export erc20 module from internal (#3319)

Co-authored-by: Kevin Ingersoll <[email protected]>
latticexyz · Oct 23, 2024 · 9080377 · 9080377
1 parent 1712814
commit 9080377
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 10 deletions.
diff --git a/.changeset/giant-birds-argue.md b/.changeset/giant-birds-argue.md
@@ -7,10 +7,10 @@ The new ERC20 World Module provides a simpler alternative to the ERC20 Puppet Mo
 To install this module, you can import and define the module configuration from the NPM package:
 
 ```typescript
-import { defineERC20Config } from "@latticexyz/world-module-erc20";
+import { defineERC20Module } from "@latticexyz/world-module-erc20/internal";
 
 // Add the output of this function to your World's modules
-const config = defineERC20Config({ namespace: "erc20Namespace", name: "MyToken", symbol: "MTK" });
+const erc20Module = defineERC20Module({ namespace: "erc20Namespace", name: "MyToken", symbol: "MTK" });
 ```
 
 For detailed installation instructions, please check out the [`@latticexyz/world-module-erc20` README.md](https://github.com/latticexyz/mud/blob/main/packages/world-module-erc20/README.md).
diff --git a/packages/world-module-erc20/README.md b/packages/world-module-erc20/README.md
@@ -92,7 +92,7 @@ In your MUD config:
 
 ```typescript
 import { defineWorld } from "@latticexyz/world";
-import { defineERC20Config } from "@latticexyz/world-module-erc20";
+import { defineERC20Module } from "@latticexyz/world-module-erc20/internal";
 
 export default defineWorld({
   namespace: "app",
@@ -105,7 +105,7 @@ export default defineWorld({
     },
   },
   modules: [
-    defineERC20Config({
+    defineERC20Module({
       namespace: "erc20Namespace",
       name: "MyToken",
       symbol: "MTK",

diff --git a/packages/world-module-erc20/package.json b/packages/world-module-erc20/package.json
@@ -10,17 +10,17 @@
   "license": "MIT",
   "type": "module",
   "exports": {
+    "./internal": "./dist/internal.js",
     "./mud.config": "./dist/mud.config.js",
-    ".": "./dist/index.js",
     "./out/*": "./out/*"
   },
   "typesVersions": {
     "*": {
       "mud.config": [
         "./dist/mud.config.d.ts"
       ],
-      "module": [
-        "./dist/module.d.ts"
+      "internal": [
+        "./dist/internal.d.ts"
       ]
     }
   },

diff --git a/...es/world-module-erc20/ts/exports/index.ts → ...orld-module-erc20/ts/defineERC20Module.ts b/...es/world-module-erc20/ts/exports/index.ts → ...orld-module-erc20/ts/defineERC20Module.ts
@@ -1,12 +1,13 @@
 import { encodeAbiParameters, stringToHex } from "viem";
+import { ModuleInput } from "@latticexyz/world/internal";
 
-export type DefineERC20ConfigInput = {
+export type DefineERC20ModuleInput = {
   namespace: string;
   name: string;
   symbol: string;
 };
 
-export function defineERC20Config({ namespace, name, symbol }: DefineERC20ConfigInput) {
+export function defineERC20Module({ namespace, name, symbol }: DefineERC20ModuleInput): ModuleInput {
   const erc20ModuleArgs = encodeAbiParameters(
     [{ type: "bytes14" }, { type: "string" }, { type: "string" }],
     [stringToHex(namespace, { size: 14 }), name, symbol],

diff --git a/packages/world-module-erc20/ts/exports/internal.ts b/packages/world-module-erc20/ts/exports/internal.ts
@@ -0,0 +1 @@
+export { defineERC20Module } from "../defineERC20Module";
diff --git a/packages/world-module-erc20/tsup.config.ts b/packages/world-module-erc20/tsup.config.ts
@@ -3,7 +3,7 @@ import { defineConfig } from "tsup";
 export default defineConfig({
   entry: {
     "mud.config": "mud.config.ts",
-    index: "ts/exports/index.ts",
+    internal: "ts/exports/internal.ts",
   },
   target: "esnext",
   format: ["esm"],

diff --git a/packages/world/ts/exports/internal.ts b/packages/world/ts/exports/internal.ts
@@ -11,3 +11,4 @@ export * from "../getFunctions";
 export * from "../getWorldAbi";
 
 export { resolveTableId, resolveWithContext } from "../config/v2/dynamicResolution";
+export { ModuleInput } from "../config/v2/input";