refactor(store): event interfaces for Store libraries

[yonadaa]

Exploring my comment on #2158 (comment)

Basically some errors (FieldLayoutLib_*, PackedCounter_*, etc.), are not included in the IStore ABI because they are not defined in that interface or anything it inherits. Instead, they are defined in libraries and are referenced only in the implementation of Store.

Some solutions:

• Define error interfaces for each library, eg. IPackedCounterErrors (this PR)
• Move every error to a single IStoreErrors
• Use abstract contracts like OpenZeppelin (I'm not sure how that works)
• Stop using interfaces and have clients import the Store implementation

[changeset-bot]

🦋 Changeset detected

Latest commit: 091a713

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

This PR includes changesets to release 30 packages

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

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]

Can we add the why to each of these?

Suggested change

	/**
	* @title IFieldLayoutErrors
	* @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
	* @notice This interface includes errors for the FieldLayout library.
	*/
	/**
	* @title IFieldLayoutErrors
	* @author MUD (https://mud.dev) by Lattice (https://lattice.xyz)
	* @notice This interface includes errors for the FieldLayout library.
	* @dev We centralize and reference these errors in an interface (instead of in libraries or files) so that we can ensure that all possible errors are included in the resulting Store ABI for proper decoding in the frontend. This is a workaround until the Solidity compiler does this for us.
	*/

[holic]

looking good! just want to include a comment in each interface about why we're doing this approach, for future spelunkers (including ourselves)

did we double check we got all error types?

[yonadaa]

I agree we can improve the comments! afaik this covers all events in Store, then we tackle World later.

This is a workaround until the Solidity compiler does this for us.

Gonna reword this because I don't think this is actually a bug - we just didn't include those events in IStore. It's not obvious to the compiler that the events that StoreCore uses should be included in the IStore ABI, because it's just one implementation of the interface.

[holic]

wondering if we should include some/all errors in the other interfaces as well: https://github.com/latticexyz/mud/blob/main/packages/store/src/IStoreRead.sol#L13

[yonadaa]

wondering if we should include some/all errors in the other interfaces as well

Technically yes, but I tried it and there is an issue with inheritance (Linearization of inheritance graph impossible) because IStore inherits IStoreRead.

If we wanna do this properly, we should actually remove IStore is IStoreErrors, and have either IStoreRead or IStoreWrite inherit the errors that they can fail with (then IStore gets them via inheritance)

[holic]

one more comment for IStoreErrors imo (since it's the same pattern as our other error interfaces) but otherwise lgtm

[holic]

don't forget a changeset!