@latticexyz/[email protected]

Major Changes

• #1482 07dd6f32 Thanks @alvrs! - Renamed all occurrences of schema where it is used as "value schema" to valueSchema to clearly distinguish it from "key schema".
  The only breaking change for users is the change from schema to valueSchema in mud.config.ts.

  // mud.config.ts
  export default mudConfig({
    tables: {
      CounterTable: {
        keySchema: {},
  -     schema: {
  +     valueSchema: {
          value: "uint32",
        },
      },
    }
  }

• #1354 331dbfdc Thanks @dk1a! - readHex was moved from @latticexyz/protocol-parser to @latticexyz/common

Minor Changes

• #1336 de151fec Thanks @dk1a! - - Add FieldLayout, which is a bytes32 user-type similar to Schema.

  Both FieldLayout and Schema have the same kind of data in the first 4 bytes.

  • 2 bytes for total length of all static fields
  • 1 byte for number of static size fields
  • 1 byte for number of dynamic size fields

  But whereas Schema has SchemaType enum in each of the other 28 bytes, FieldLayout has static byte lengths in each of the other 28 bytes.

  • Replace Schema valueSchema with FieldLayout fieldLayout in Store and World contracts.

    FieldLayout is more gas-efficient because it already has lengths, and Schema has types which need to be converted to lengths.

  • Add getFieldLayout to IStore interface.

    There is no FieldLayout for keys, only for values, because key byte lengths aren't usually relevant on-chain. You can still use getKeySchema if you need key types.

  • Add fieldLayoutToHex utility to protocol-parser package.

  • Add constants.sol for constants shared between FieldLayout, Schema and PackedCounter.

• #1476 9ff4dd95 Thanks @holic! - Adds valueSchemaToFieldLayoutHex helper

Patch Changes

• #1481 f8a01a04 Thanks @holic! - Export valueSchemaToFieldLayoutHex helper

• Updated dependencies [65c9546c, 331dbfdc, 0b8ce3f2, 44a5432a, 331dbfdc, 92de5998, bfcb293d, 5e723b90, 24a6cd53, 708b49c5, c4f49240, cea754dd]:

  • @latticexyz/[email protected]
  • @latticexyz/[email protected]