refactor(cli): split up deploy into modules #1384

johngrantuk · 2023-09-01T16:05:33Z

Initial refactor of cli deploy script. Should make it easier to do follow up work - using Viem and create2 deployments

Added TxHelper class that manages nonce state during deploy/transactions
Create separate classes for World/CoreModule/Systems/Modules with independent deploy and install functions
Simplify promises/handling

…tall handlers. Simplify Promise handling.

changeset-bot · 2023-09-01T16:05:37Z

⚠️ No Changeset found

Latest commit: 8ec9e9d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…installed.

alvrs · 2023-09-04T12:01:48Z

Thank you for picking this up! One high level feedback i have is we try to use utility functions + simple objects instead of classes, because it tends to produce small chunks of code that are easier to reuse and test. (We should probably note this decision with more context on the reasoning down somewhere). Would you be down to refactor the refactor to use a more functional approach?

… and use functions.

alvrs

thank you! added some comments. High level feedback: let's try to create lots of small utils and then use them to create higher level utils. I also think it would be nice if each of the utils would live in a file with its name, and utils that belong to the same category are grouped in a folder (eg systems, modules, etc) with an index.ts file to import them from there.

alvrs · 2023-09-07T17:54:17Z

packages/cli/src/utils/modules.ts

+ return configModules.filter((module) => !defaultModules.some((m) => m.name === module.name));
+}
+
+export async function installModules(


should we create a installModule util that we can use to both install the core module and the user-defined modules?

alvrs · 2023-09-07T18:01:22Z

packages/cli/src/utils/modules.ts

+ const { confirmations, worldContract, modules, moduleContracts, tableIds } = input;
+ // Install modules - non-blocking for tx, await all at end
+ const modulePromisesNew: Promise<TransactionResponse | TransactionReceipt>[] = [];
+ for (const module of modules) {


if we have a installModule util we can do something like

const modulePromises = modules.map(installModule); await Promise.all(modulePromises);

alvrs · 2023-09-07T18:02:59Z

packages/cli/src/utils/systems.ts

+ functionArgs: string;
+}
+
+export async function registerSystems(


same here, feels like it would be nice to have a small registerSystem and registerFunctionSelector util and then use it to create a small registerSystems util

packages/cli/src/utils/deploy.ts

packages/cli/src/utils/world.ts

alvrs

So much cleaner! And can't wait for the viem refactor. Added a couple nits and will push a commit to resolve them shortly.

alvrs · 2023-09-15T13:33:31Z

packages/cli/src/utils/systems/registerFunctionCalls.ts

+import { loadFunctionSignatures, toFunctionSelector } from "./utils";
+import { CallData } from "../utils/types";
+
+export function registerFunctionCalls(input: {


should we call this getRegisterFunctionSelector to make it consistent with the other function names? Or could even rename all to get<MethodName>CallData to make it extra clear (i was surprised for a second that this function doesn't actually register yet but just prepares the call by returning the calldata)

alvrs · 2023-09-15T13:37:35Z

packages/cli/src/utils/deploy.ts

- const schemaTypes = Object.values(schema).map((abiOrUserType) => {
- const { schemaType } = resolveAbiOrUserType(abiOrUserType, mudConfig);
- return schemaType;
+ // Deploy all contracts - World, Core, Systems, Module. Non-blocking.


Suggested change

// Deploy all contracts - World, Core, Systems, Module. Non-blocking.

// Deploy the World contract

alvrs · 2023-09-15T13:38:33Z

packages/cli/src/utils/deploy.ts

+ const txConfig = {
+ ...txParams,
+ signer,
+ debug: !!debug,


Suggested change

debug: !!debug,

debug: Boolean(debug),

alvrs · 2023-09-15T13:44:29Z

packages/cli/src/utils/modules/constants.ts

+import { ContractCode } from "../utils/types";
+
+// These modules are always deployed
+export const defaultModules: ContractCode[] = [


for consistency with the other variable names

Suggested change

export const defaultModules: ContractCode[] = [

export const defaultModuleContracts: ContractCode[] = [

johngrantuk added 3 commits August 31, 2023 16:33

refactor(cli:deploy): Add txHelper. Simplify promise handling.

73ba820

refactor(cli:deploy): Split into separate classes with own deploy/ins…

6c3ccd9

…tall handlers. Simplify Promise handling.

refactor(cli:deploy): Remove unused import.

ee06186

johngrantuk requested review from alvrs and holic as code owners September 1, 2023 16:05

johngrantuk changed the title ~~Initial Refactor of cli:deploy~~ refactor(cli:deploy): Initial Refactor of cli deploy Sep 1, 2023

johngrantuk mentioned this pull request Sep 1, 2023

feat(world): add world factory #1385

Merged

fix(cli:deploy): Handle coreModule installation correctly if already …

072be82

…installed.

refactor(cli:deploy): Initial pass at class refactor - remove classes…

a8ce4d9

… and use functions.

alvrs mentioned this pull request Sep 6, 2023

feat(cli,create-mud,store,world): add abi-ts to replace typechain #1403

Merged

2 tasks

johngrantuk added 4 commits September 6, 2023 19:34

refactor(cli:deploy): Refactor initial contract deployments.

013701b

refactor(cli:deploy): Remove txHelper class.

d829b12

chore(cli:deploy): Fix conflicts with main.

2a77044

fix(cli:deploy): Revert commits made by mistake.

53c921e

alvrs reviewed Sep 7, 2023

View reviewed changes

johngrantuk added 9 commits September 8, 2023 14:24

refactor(cli:deploy): Fix nit.

5d1068e

refactor(cli:deploy): Initial refactor of modules into utils.

c4b5e09

refactor(cli:deploy): Module refactor.

8401327

refactor(cli:deploy): Register namespace.

5f86b73

refactor(cli:deploy): Refactor table registration.

536b496

refactor(cli:deploy): System & function registrations.

64ad403

refactor(cli:deploy): Refactor grant access.

4d3e447

Refactor(cli:deploy): Refactored deployments.

154a0f4

refactor(cli:deploy): Move helper function to utils.

0b9a38a

holic changed the title ~~refactor(cli:deploy): Initial Refactor of cli deploy~~ refactor(cli): split up deploy into modules Sep 14, 2023

Merge remote-tracking branch 'origin/main' into refactor-deploy

126c0a8

holic requested a review from dk1a as a code owner September 15, 2023 10:20

holic force-pushed the refactor-deploy branch from 686bea0 to c0c0542 Compare September 15, 2023 10:32

vercel bot deployed to Preview September 15, 2023 10:33 View deployment

holic force-pushed the refactor-deploy branch from c0c0542 to 753e27f Compare September 15, 2023 10:38

switch from index imports to actual imports

aa5c711

holic force-pushed the refactor-deploy branch from 753e27f to aa5c711 Compare September 15, 2023 10:50

alvrs reviewed Sep 15, 2023

View reviewed changes

alvrs added 2 commits September 15, 2023 14:59

review

7938c70

Merge branch 'main' into refactor-deploy

8ec9e9d

alvrs approved these changes Sep 15, 2023

View reviewed changes

holic merged commit 76055f4 into latticexyz:main Sep 15, 2023
9 of 10 checks passed

holic mentioned this pull request Sep 15, 2023

docs: cli changeset after deploy changes #1503

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(cli): split up deploy into modules #1384

refactor(cli): split up deploy into modules #1384

johngrantuk commented Sep 1, 2023

changeset-bot bot commented Sep 1, 2023 •

edited

Loading

alvrs commented Sep 4, 2023

alvrs left a comment

alvrs Sep 7, 2023

alvrs Sep 7, 2023

alvrs Sep 7, 2023

alvrs left a comment

alvrs Sep 15, 2023

alvrs Sep 15, 2023

alvrs Sep 15, 2023

alvrs Sep 15, 2023

	// Deploy all contracts - World, Core, Systems, Module. Non-blocking.
	// Deploy the World contract

	export const defaultModules: ContractCode[] = [
	export const defaultModuleContracts: ContractCode[] = [

refactor(cli): split up deploy into modules #1384

refactor(cli): split up deploy into modules #1384

Conversation

johngrantuk commented Sep 1, 2023

changeset-bot bot commented Sep 1, 2023 • edited Loading

⚠️ No Changeset found

alvrs commented Sep 4, 2023

alvrs left a comment

Choose a reason for hiding this comment

alvrs Sep 7, 2023

Choose a reason for hiding this comment

alvrs Sep 7, 2023

Choose a reason for hiding this comment

alvrs Sep 7, 2023

Choose a reason for hiding this comment

alvrs left a comment

Choose a reason for hiding this comment

alvrs Sep 15, 2023

Choose a reason for hiding this comment

alvrs Sep 15, 2023

Choose a reason for hiding this comment

alvrs Sep 15, 2023

Choose a reason for hiding this comment

alvrs Sep 15, 2023

Choose a reason for hiding this comment

changeset-bot bot commented Sep 1, 2023 •

edited

Loading