refactor(store,world,world-modules): use BYTE_TO_BITS constant where applicable [N-09]

[yonadaa]

No description provided.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7820ce2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[alvrs]

Unfortunately the changes increase gas cost in a way that makes me doubt if it's worth it. I think the gas cost increase only comes from the places where we replace an inline 8 in code, not in places where we only use it to define another constant that already exists. Maybe a good compromise would be to only change it in those constant definitions where it doesn't impact gas cost, and just add a comment in the other places?

[yonadaa]

@alvrs I agree with the direction of adding comments, but the increases actually come from constant definitions(!), not inline code. I've added comments to these files instead, and the gas reports are now equivalent to main.

Specifically, the increase comes from these constants in the Resource ID files:

ResourceId.sol

/// @dev Number of bits reserved for the type in the ResourceId.
uint256 constant TYPE_BITS = 2 * 8;
/// @dev Number of bits reserved for the name in the ResourceId.
uint256 constant NAME_BITS = 32 * 8 - TYPE_BITS;

WorldResourceId.sol

uint256 constant NAMESPACE_BITS = 14 * 8;
uint256 constant NAME_BITS = 16 * 8;

[alvrs]

the named constant's purpose is mostly to make the calculations easier to parse for humans; in places where using the constant would increase gas, using a verbose comment instead is an acceptable alternative imo (no need to use the exact same BYTE_TO_BITS token here since this isn't a value that's ever going to change so we don't need to be able to ie search for it)