feat(world): add support for modules, move logic to RegistrationModule #482
Conversation
| @@ -237,6 +237,8 @@ export async function deploy(mudConfig: MUDConfig, deployConfig: DeployConfig): | |||
| throw new MUDError( | |||
| `Error deploying ${contractName}: invalid bytecode. Note that linking of public libraries is not supported yet, make sure none of your libraries use "external" functions.` | |||
| ); | |||
| } else if (error?.message.includes("CreateContractLimit")) { | |||
| throw new MUDError(`Error deploying ${contractName}: CreateContractLimit exceeded.`); | |||
There was a problem hiding this comment.
no changes needed here, but we should be sure to not throw away the original error in case its useful (today or in the future) for debugging
viem has a good example of wrapping errors with nicer messages: https://github.com/wagmi-dev/viem/blob/main/src/errors/contract.ts
There was a problem hiding this comment.
Agreed! In this case the original error message includes the entire bytecode, so it makes your terminal explode and buries the actual error message, but we could add a CLI flag (sth like --debug) to print the full error message too
There was a problem hiding this comment.
(will leave that to a follow PR to not bloat this one too much)
| @@ -114,7 +117,9 @@ contract WorldTest is Test { | |||
|
|
|||
| function setUp() public { | |||
| world = IWorld(address(new World())); | |||
| world.initialize(); | |||
| world.installRootModule(new CoreModule()); | |||
| world.installRootModule(new RegistrationModule()); | |||
|
Force pushed to rebase on main, here are the commits since the last review: https://github.com/latticexyz/mud/pull/482/files/194df284fb610f1b9fb9b16890b072be595d2780..5b83e738343406bc3e31958d03735dbe2653b676 |
| // Require the CoreModule to be installed in the root namespace | ||
| if (InstalledModules.get(ROOT_NAMESPACE, CORE_MODULE_NAME).moduleAddress == address(0)) { | ||
| revert RequiredModuleNotFound(ResourceSelector.from(ROOT_NAMESPACE, CORE_MODULE_NAME).toString()); | ||
| } |
There was a problem hiding this comment.
we're so close to having a real package system hahaha
packages/cli/src/utils/deploy-v2.ts
Outdated
| @@ -60,12 +64,20 @@ export async function deploy(mudConfig: MUDConfig, deployConfig: DeployConfig): | |||
| World: worldContractName | |||
| ? deployContractByName(worldContractName) | |||
| : deployContract(WorldABI, WorldBytecode, "World"), | |||
| CoreModule: deployContract(CoreModuleData.abi, CoreModuleData.bytecode, "CoreModule"), | |||
| RegistrationModule: deployContract(RegistrationModuleData.abi, RegistrationModuleData.bytecode, "RootModule"), | |||
There was a problem hiding this comment.
is this intentionally called RootModule?
There was a problem hiding this comment.
curious what this would have affected if left uncaught?
There was a problem hiding this comment.
It's just used for logging, the logs would have said "Deploying RootModule"
packages/world/mud.config.mts
Outdated
| // TODO: this is a workaround to use `getRecord` instead of `getField` in the autogen library, | ||
| // to allow using the table before it is registered. This is because `getRecord` passes the schema | ||
| // to store, while `getField` loads it from storage. Remove this once we have support for passing the | ||
| // schema in `getField` too. |
This PR adds support for "Modules" (see #393 for the original concept).
Modules encapsulate installation logic for coupled pieces of logic/data (see
RegistrationModuleas an example).This PR also moves out all logic and tables related to "registration" to a
RegistrationModuleand the initialization of a couple core tables toCoreModule. This is mainly to reduce the bytecode size of World, which recently passed the contract size limit. With these changes we're well below the limit again.