-
Notifications
You must be signed in to change notification settings - Fork 196
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add store/world config changesets #2497
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
--- | ||
"@latticexyz/store": major | ||
"@latticexyz/world": major | ||
--- | ||
|
||
Store and World configs have been rebuilt with strong types. The shape of these configs have also changed slightly for clarity, the biggest change of which is merging of `keySchema` and `valueSchema` into a single `schema` with a separate `key` for a table's primary key. | ||
|
||
To migrate, first update the imported config method: | ||
|
||
```diff filename="mud.config.ts" | ||
-import { mudConfig } from "@latticexyz/world/register"; | ||
+import { defineWorld } from "@latticexyz/world"; | ||
|
||
-export default mudConfig({ | ||
+export default defineWorld({ | ||
``` | ||
|
||
_Note that if you are only using Store, you will need to import `defineStore` from `@latticexyz/store`._ | ||
|
||
Then migrate the table key by renaming `keySchema` to `schema` and define the table `key` with each field name from your key schema: | ||
|
||
```diff filename="mud.config.ts" | ||
export default defineWorld({ | ||
tables: { | ||
Position: { | ||
- keySchema: { | ||
+ schema: { | ||
player: "address", | ||
}, | ||
valueSchema: { | ||
x: "int32", | ||
y: "int32", | ||
}, | ||
+ key: ['player'], | ||
}, | ||
}, | ||
}); | ||
``` | ||
|
||
Now we can merge the `valueSchema` into `schema`. | ||
|
||
```diff filename="mud.config.ts" | ||
export default defineWorld({ | ||
tables: { | ||
Position: { | ||
schema: { | ||
player: "address", | ||
- }, | ||
- valueSchema: { | ||
x: "int32", | ||
y: "int32", | ||
}, | ||
key: ['player'], | ||
}, | ||
}, | ||
}); | ||
``` | ||
|
||
If you previously used the table config shorthand without the full `keySchema` and `valueSchema`, some of the defaults have changed. Shorthands now use an `id: "bytes32"` field by default rather than `key: "bytes32"` and corresponding `key: ["id"]`. To keep previous behavior, you may have to manually define your `schema` with the previous `key` and `value` fields. | ||
|
||
```diff filename="mud.config.ts" | ||
export default defineWorld({ | ||
tables: { | ||
- OwnedBy: "address", | ||
+ OwnedBy: { | ||
+ schema: { | ||
+ key: "bytes32", | ||
+ value: "address", | ||
+ }, | ||
+ key: ["key"], | ||
+ }, | ||
}, | ||
}); | ||
``` | ||
|
||
Singleton tables are defined similarly, where an empty `key` rather than `keySchema` is provided: | ||
|
||
```diff filename="mud.config.ts" | ||
-keySchema: {} | ||
+key: [] | ||
``` | ||
|
||
Offchain tables are now defined as a table `type` instead an `offchainOnly` boolean: | ||
|
||
```diff filename="mud.config.ts" | ||
-offchainOnly: true | ||
+type: 'offchainTable' | ||
``` | ||
|
||
All codegen options have moved under `codegen`: | ||
|
||
```diff filename="mud.config.ts" | ||
export default defineWorld({ | ||
- codegenDirectory: "…", | ||
+ codegen: { | ||
+ outputDirectory: "…", | ||
+ }, | ||
tables: { | ||
Position: { | ||
schema: { | ||
player: "address", | ||
x: "int32", | ||
y: "int32", | ||
}, | ||
key: ['player'], | ||
- directory: "…", | ||
- dataStruct: false, | ||
+ codegen: { | ||
+ outputDirectory: "…", | ||
+ dataStruct: false, | ||
+ }, | ||
}, | ||
}, | ||
}); | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am hoping this shows up nicely in docs!