feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id #1182

alvrs · 2023-07-19T11:33:49Z

This PR includes a few breaking changes:

Store's registerSchema and setMetadata are combined into a single registerTable method. This means metadata (key names, field names) is immutable and indexers can create tables with this metadata when a new table is registered on-chain.
World's registerTable method is updated to also include key names and field names, setMetadata is removed
The getSchema method is renamed to getValueSchema on all interfaces
The internal Schema table is now an actual table instead of receiving special treatment. It is renamed to Tables, and the table id chagned from "mudstore:schema" to "mudstore:Tables"

We need to integrate these changes into our networking stack before merging, so this PR is blocked on replacing v1 networking code with v2 (otherwise we'd have to integrate these chagnes into the deprecated v1 networking code which will be removed very soon).

Consumers who are using default MUD table libraries don't need to do anything to integrate these breaking changes except update to the latest version and regenerate the table libraries (which happens automatically during the build step of projects started from MUD templates)

changeset-bot · 2023-07-19T11:33:51Z

🦋 Changeset detected

Latest commit: 3ce006c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 26 packages

Name	Type
@latticexyz/cli	Major
@latticexyz/store	Major
@latticexyz/world	Major
@latticexyz/store-sync	Major
create-mud	Major
@latticexyz/std-client	Major
@latticexyz/dev-tools	Major
@latticexyz/react	Major
@latticexyz/store-cache	Major
@latticexyz/store-indexer	Major
@latticexyz/ecs-browser	Major
@latticexyz/block-logs-stream	Major
@latticexyz/common	Major
@latticexyz/config	Major
@latticexyz/gas-report	Major
@latticexyz/noise	Major
@latticexyz/phaserx	Major
@latticexyz/protocol-parser	Major
@latticexyz/recs	Major
@latticexyz/schema-type	Major
@latticexyz/services	Major
@latticexyz/solecs	Major
solhint-config-mud	Major
solhint-plugin-mud	Major
@latticexyz/std-contracts	Major
@latticexyz/utils	Major

Not sure what this means? Click here to learn what changesets are.

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

holic · 2023-07-19T11:39:50Z

packages/store/src/codegen/tables/TableData.sol

+bytes32 constant _tableId = bytes32(abi.encodePacked(bytes16("mudstore"), bytes16("TableData")));
+bytes32 constant TableDataTableId = _tableId;
+
+struct TableDataData {


not blocking but "data data" is a little weird

would calling this table Table be too weird/confusing?

we'd get TableTableId

what about TableMetadata or StoreMetadata? (since the old table can go away, and the new one can get an extra field - tableName)

holic · 2023-07-19T11:40:21Z

packages/store/mud.config.ts

+        abiEncodedKeyNames: "bytes",
+        abiEncodedValueNames: "bytes",
+      },
+    },
    StoreMetadata: {


this can go away now, right?

alvrs · 2023-07-28T15:18:12Z

Current dependencies on/for this PR:

main
- PR refactor: remove v1 network package, remove snap sync module, deprecate std-client #1311
  - PR feat(world, store): stop loading schema from storage, require schema as an argument #1174
    - PR feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id #1182 👈
      - PR refactor: combine name and namespace to resource selector in World methods #1208

This comment was auto-generated by Graphite.

holic · 2023-08-16T16:47:06Z

packages/store-sync/src/recs/defineInternalComponents.ts

      world,
      { table: Type.T },
-      { metadata: { componentName: "TableMetadata" } }
+      { metadata: { componentName: "Tables" } }


I think this got renamed by mistake!

Might be worth adjusting this name anyway to like RegisteredClientTables or something

That said, I wonder if the now-built-in Tables component (derived from mud config) would have everything I need (minus some nice-to-haves like an already parsed table schema).

good catch!

.changeset/modern-hornets-jam.md

docs/pages/store/internals.mdx

holic · 2023-08-16T17:34:16Z

packages/store/src/StoreCore.sol

-    StoreMetadata.set(StoreCoreInternal.SCHEMA_TABLE, "schema", abi.encode(fieldNames));
+    // Register internal tables
+    Tables.register();
+    Hooks.register();


packages/store/src/StoreCore.sol

Co-authored-by: Kevin Ingersoll <[email protected]>

alvrs · 2023-08-16T21:46:24Z

merging since only comment changes since last approval

vercel bot deployed to Preview July 19, 2023 11:35 View deployment

holic reviewed Jul 19, 2023

View reviewed changes

alvrs mentioned this pull request Jul 28, 2023

feat(world, store): stop loading schema from storage, require schema as an argument #1174

Merged

alvrs mentioned this pull request Jul 28, 2023

refactor: combine name and namespace to resource selector in World methods #1208

Merged

vercel bot deployed to Preview July 28, 2023 15:20 View deployment

alvrs force-pushed the alvrs/real-schema branch from b50fea3 to 0b8a66d Compare July 28, 2023 15:21

alvrs force-pushed the alvrs/schema-methods branch from f433947 to 233c35c Compare August 9, 2023 17:18

alvrs force-pushed the alvrs/real-schema branch from 0b8a66d to 7ff27a1 Compare August 9, 2023 17:18

vercel bot deployed to Preview August 9, 2023 17:20 View deployment

alvrs force-pushed the alvrs/schema-methods branch from 233c35c to d3a7d26 Compare August 15, 2023 10:30

alvrs force-pushed the alvrs/real-schema branch from 7ff27a1 to 4d918cd Compare August 15, 2023 10:30

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

alvrs force-pushed the alvrs/schema-methods branch from c628440 to f862270 Compare August 15, 2023 14:56

alvrs force-pushed the alvrs/real-schema branch from 4d918cd to 4a52c4a Compare August 15, 2023 14:56

alvrs mentioned this pull request Aug 15, 2023

refactor: remove v1 network package, remove snap sync module, deprecate std-client #1311

Merged

vercel bot deployed to Preview August 15, 2023 14:59 View deployment

alvrs force-pushed the alvrs/schema-methods branch from f862270 to 5908a3d Compare August 15, 2023 16:16

alvrs force-pushed the alvrs/real-schema branch from 4a52c4a to c49c11e Compare August 15, 2023 16:16

vercel bot deployed to Preview August 15, 2023 16:19 View deployment

alvrs force-pushed the alvrs/schema-methods branch from 5908a3d to 20e5702 Compare August 15, 2023 17:47

alvrs force-pushed the alvrs/real-schema branch from c49c11e to 8a2d0d1 Compare August 15, 2023 17:47

vercel bot deployed to Preview August 15, 2023 18:17 View deployment

alvrs force-pushed the alvrs/schema-methods branch from b84618f to 840d930 Compare August 16, 2023 10:54

alvrs force-pushed the alvrs/real-schema branch from 8a2d0d1 to 0ca3474 Compare August 16, 2023 10:55

vercel bot deployed to Preview August 16, 2023 10:57 View deployment

alvrs force-pushed the alvrs/real-schema branch from 0ca3474 to 2dc150b Compare August 16, 2023 11:38

vercel bot deployed to Preview August 16, 2023 11:39 View deployment

alvrs force-pushed the alvrs/real-schema branch from 9b1c72a to 44fab13 Compare August 16, 2023 16:22

vercel bot deployed to Preview August 16, 2023 16:23 View deployment

fix trace

84d19ff

vercel bot deployed to Preview August 16, 2023 16:28 View deployment

alvrs added 2 commits August 16, 2023 18:33

rename valueNames to fieldNames

c3caf80

rename TableMetadata to Tables

d1c3531

vercel bot deployed to Preview August 16, 2023 16:43 View deployment

holic reviewed Aug 16, 2023

View reviewed changes

rename internal recs table back to TableMetadata

f8892b4

vercel bot deployed to Preview August 16, 2023 16:54 View deployment

rename internal client component to RegisteredTables

0acea5e

vercel bot deployed to Preview August 16, 2023 17:04 View deployment

update table ID, remove comments

420ed7b

vercel bot deployed to Preview August 16, 2023 17:10 View deployment

gas-report

274cfff

vercel bot deployed to Preview August 16, 2023 17:21 View deployment

alvrs marked this pull request as ready for review August 16, 2023 17:22

alvrs requested a review from holic August 16, 2023 17:22

holic reviewed Aug 16, 2023

View reviewed changes

prettier

b7d2a61

vercel bot deployed to Preview August 16, 2023 21:17 View deployment

alvrs and others added 2 commits August 16, 2023 23:20

Apply suggestions from code review

2721b51

Co-authored-by: Kevin Ingersoll <[email protected]>

Update packages/store/src/StoreCore.sol

1816eb5

Co-authored-by: Kevin Ingersoll <[email protected]>

vercel bot deployed to Preview August 16, 2023 21:23 View deployment

update changeset

3ce006c

vercel bot deployed to Preview August 16, 2023 21:24 View deployment

alvrs merged commit afaf2f5 into main Aug 16, 2023
9 checks passed

alvrs deleted the alvrs/real-schema branch August 16, 2023 21:46

github-actions bot mentioned this pull request Aug 16, 2023

Version Packages (next) #1313

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id #1182

feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id #1182

alvrs commented Jul 19, 2023 •

edited by holic

Loading

changeset-bot bot commented Jul 19, 2023 •

edited

Loading

holic Jul 19, 2023

dk1a Jul 19, 2023

dk1a Jul 19, 2023

holic Jul 19, 2023

alvrs commented Jul 28, 2023 •

edited

Loading

holic Aug 16, 2023

holic Aug 16, 2023

holic Aug 16, 2023

alvrs Aug 16, 2023

holic Aug 16, 2023

alvrs commented Aug 16, 2023

feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id #1182

feat(store,world): combine schema and metadata registration, rename getSchema to getValueSchema, change Schema table id #1182

Conversation

alvrs commented Jul 19, 2023 • edited by holic Loading

changeset-bot bot commented Jul 19, 2023 • edited Loading

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alvrs commented Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alvrs commented Aug 16, 2023

alvrs commented Jul 19, 2023 •

edited by holic

Loading

changeset-bot bot commented Jul 19, 2023 •

edited

Loading

alvrs commented Jul 28, 2023 •

edited

Loading