feat: v2 event decoding #415

holic · 2023-02-17T21:02:43Z

Parses v2 events into schema registrations and data to populate client ECS with it.

TODO

alvrs

Nothing blocking (except from the comment in package.json of world/store). Are you planning to add all TODO comments to some tracker and link the tracker in the code?

Almost there!!

alvrs · 2023-03-15T01:25:07Z

packages/cli/src/config/loadStoreConfig.ts

@@ -7,7 +7,7 @@ export async function loadStoreConfig(configPath?: string) {
  const config = await loadConfig(configPath);

  try {
-    return parseStoreConfig(config);
+    return parseStoreConfig(config as any);


why is this needed?

loadConfig has a return value of unknown, and if I don't cast it, I get

this is happening now because I changed the argument type in parseStoreConfig to help with defineStoreComponents (to "expand" the mud config into something reasonable/without tons of shorthand and conditional branching)

alvrs · 2023-03-15T01:31:31Z

packages/network/src/v2/schemas/decodeData.ts

+import { decodeStaticField } from "./decodeStaticField";
+import { decodeDynamicField } from "./decodeDynamicField";
+
+export const decodeData = (schema: TableSchema, hexData: string): Record<number, any> => {


I think the function definitions are a bit more common in the current codebase, we should align everything at some point for consistency. Not blocking for this PR though.

alvrs · 2023-03-15T01:34:18Z

packages/network/src/v2/schemas/tableMetadata.ts

+  console.log("fetching metadata for table", { table: table.toString(), world: world.address });
+  const metadataPromise = Promise.all([
+    registerSchema(world, metadataTableId),
+    // TODO: figure out how to pass in rawSchema, it was giving me "incorrect length" errors before


maybe we have to pad the raw schema string to 32 bytes?

not sure, but also not too worried since this is a getter and we still have to do both fetch calls anyway

alvrs · 2023-03-15T01:34:55Z

packages/network/src/v2/schemas/tableMetadata.ts

+    // TODO: figure out how to pass in rawSchema, it was giving me "incorrect length" errors before
+    world["getRecord(uint256,bytes32[])"](metadataTableId.toHexString(), [table.toHexString()]),
+  ]).then(([metadataSchema, metadataRecord]) => {
+    // TODO: error if schema or record not found?


should we at least log a warning here?

alvrs · 2023-03-15T01:42:20Z

packages/store/package.json

@@ -13,7 +13,7 @@
    "prepare": "yarn build && chmod u+x git-install.sh",
    "git:install": "bash git-install.sh",
    "codegen": "ts-node ./scripts/codegen.ts",
-    "tablegen": "../cli/dist/mud.js tablegen",
+    "tablegen": "mud tablegen",


i'd prefer keeping the local version for this script, so it works in the CI when we do changes to tablegen (without releasing a new version)

what if, instead, we have CI use a locally linked mud CLI?

That would work too, we just have to set it up. If it "just works" I'm down to do that instead in this PR, but wouldn't lose too much time on it, we can always change it in a follow up

will change it back for ease and add an issue to come back to this

alvrs · 2023-03-15T01:42:52Z

packages/world/package.json

@@ -12,7 +12,7 @@
  "scripts": {
    "prepare": "yarn build && chmod u+x git-install.sh",
    "git:install": "bash git-install.sh",
-    "tablegen": "../cli/dist/mud.js tablegen",
+    "tablegen": "mud tablegen",


Same here, see comment above (in store/package.json)

alvrs · 2023-03-15T19:16:58Z

packages/network/src/v2/ecsEventFromLog.ts

@@ -19,7 +19,7 @@ export const ecsEventFromLog = async (
  const tableId = TableId.fromBytes32(utils.arrayify(args.table));
  const component = tableId.toString();
  // TODO: revisit key tuple encoding for client
-  const entity = args.key.join(":") as EntityID;
+  const entity = `v2:${args.key.join(":")}` as EntityID;


This might break something if I want to use v2 with ECS, and want to refer to another entity in my component

Example: OwnedBy component, Bob (0x01) is owned by Alice (0x02), so I have an entry in the OwnedBy table with key 0x01 and value 0x02. Now I want to do an recs query on the client to get all entities owned by Alice, so I do getEntitiesWithValue(OwnedBy, {value: Alice}), but because Alice is normalized to v2:0x02 it wouldn't find the 0x02 value of key 0x01.

updated in 9c13cd7

alvrs

Let's go!

holic force-pushed the holic/sync-store-v2 branch from 678cd09 to f3fb706 Compare February 20, 2023 16:02

holic added 5 commits March 1, 2023 13:07

feat(network): integrate v2 events into network package

7f1feae

feat(store): use schema-type

f1456a2

fix(world): system schema order

6bc4d12

wip field updates

1004b91

fix: partial updates

5c588e5

holic force-pushed the holic/sync-store-v2 branch 2 times, most recently from 5c588e5 to f1e27de Compare March 2, 2023 01:22

holic changed the base branch from v2 to main March 2, 2023 01:22

holic force-pushed the holic/sync-store-v2 branch from f1e27de to 5c588e5 Compare March 2, 2023 01:22

holic added 5 commits March 2, 2023 06:59

feat: set table metadata when registering schema

bbd06a2

feat: metadata getter

82a4b98

fix: don't explode when component definition is missing key

ef105ad

feat: add named field->values to component value

63070f1

fix: named fields for partial updates

c6912cf

holic force-pushed the holic/sync-store-v2 branch 3 times, most recently from b8fb384 to 7863484 Compare March 2, 2023 21:12

holic added 3 commits March 2, 2023 15:36

refactor: move files around

48380d8

docs: add v2 network readme

9949404

refactor: move dirs

8b8b633

holic force-pushed the holic/sync-store-v2 branch from 7863484 to 8b8b633 Compare March 2, 2023 23:38

holic added 4 commits March 2, 2023 15:38

Merge remote-tracking branch 'origin/main' into holic/sync-store-v2

8653a45

docs: readme clarification

dd9579c

refactor(cli): move/separate parse/load config

2a25400

feat(recs): add defineStoreComponents

e6491e8

holic force-pushed the holic/sync-store-v2 branch from 580373b to e6491e8 Compare March 7, 2023 01:31

holic added 2 commits March 6, 2023 18:03

refactor(network): clean up

43645e8

refactor(network): parallelize

0afa82d

holic force-pushed the holic/sync-store-v2 branch from df2fafb to 0afa82d Compare March 7, 2023 02:24

holic added 12 commits March 14, 2023 16:54

fix(schema-type): missing js import

45e4095

refactor(recs): clarify missing key warning

e54b3d3

Merge remote-tracking branch 'origin/main' into holic/sync-store-v2

e9ce7e8

refactor: minimize lodash imports

1212208

build(std-client): add peer deps

3280b79

build: use latest mud in peer deps

1d3ee37

build: align TS versions

688e6a1

fix(utils): fix type issues with hexStringToUint8Array

7b79194

fix(recs): don't use bind

b5340e0

fix(react): get tests working again

8c6f2ae

test(network): fix tests

05b2236

chore(phaserx): eslint ignore ts ignore

1a76458

alvrs reviewed Mar 15, 2023

View reviewed changes

holic added 3 commits March 15, 2023 10:14

build: revert back to local cli

97d34d3

Merge remote-tracking branch 'origin/main' into holic/sync-store-v2

98d723f

style: swap function position for smaller diff

05a1e68

holic requested a review from alvrs March 15, 2023 17:45

holic added 3 commits March 15, 2023 10:52

docs(network): update method name

1a5a9d2

feat(network): add warnings for missing schemas/metadata

c6cdc5f

fix(network): don't normalize v2 entity IDs

b67e334

alvrs reviewed Mar 15, 2023

View reviewed changes

holic added 3 commits March 15, 2023 12:23

fix(network): normalize single keys, leave composite keys alone

9c13cd7

Merge remote-tracking branch 'origin/main' into holic/sync-store-v2

1935b6b

fix(network): typo

50ca00d

alvrs approved these changes Mar 15, 2023

View reviewed changes

holic merged commit 374ed54 into main Mar 15, 2023

This was referenced Mar 15, 2023

Tracker: v2 todos #444

Open

Update for v2 events latticexyz/v2sandbox#2

Merged

alvrs deleted the holic/sync-store-v2 branch May 18, 2023 12:53

github-actions bot mentioned this pull request Jul 4, 2023

chore: release 2.0.0-next.0 #1103

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: v2 event decoding #415

feat: v2 event decoding #415

holic commented Feb 17, 2023 •

edited

Loading

alvrs left a comment

alvrs Mar 15, 2023

holic Mar 15, 2023 •

edited

Loading

alvrs Mar 15, 2023

alvrs Mar 15, 2023

holic Mar 15, 2023

alvrs Mar 15, 2023

alvrs Mar 15, 2023

holic Mar 15, 2023 •

edited

Loading

alvrs Mar 15, 2023

holic Mar 15, 2023 •

edited

Loading

holic Mar 15, 2023

alvrs Mar 15, 2023

holic Mar 15, 2023

alvrs Mar 15, 2023

holic Mar 15, 2023

alvrs left a comment

feat: v2 event decoding #415

feat: v2 event decoding #415

Conversation

holic commented Feb 17, 2023 • edited Loading

alvrs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holic Mar 15, 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

Choose a reason for hiding this comment

holic Mar 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

holic Mar 15, 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

Choose a reason for hiding this comment

alvrs left a comment

Choose a reason for hiding this comment

holic commented Feb 17, 2023 •

edited

Loading

holic Mar 15, 2023 •

edited

Loading

holic Mar 15, 2023 •

edited

Loading

holic Mar 15, 2023 •

edited

Loading