Skip to content

Commit

Permalink
feat(store): rename StoreCore.registerCoreTables to registerInternalT…
Browse files Browse the repository at this point in the history
…ables (#2225)
  • Loading branch information
holic committed Feb 2, 2024
1 parent ed05cb3 commit 5c52bee
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 15 deletions.
6 changes: 6 additions & 0 deletions .changeset/twelve-terms-lay.md
@@ -0,0 +1,6 @@
---
"@latticexyz/store": major
"@latticexyz/world": patch
---

Renamed `StoreCore`'s `registerCoreTables` method to `registerInternalTables`.
6 changes: 3 additions & 3 deletions docs/pages/store/reference/store-core.mdx
Expand Up @@ -21,15 +21,15 @@ StoreSwitch uses internal methods to write data instead of external calls._
function initialize() internal;
```

### registerCoreTables
### registerInternalTables

Register core tables in the store.
Register Store protocol's internal tables in the store.

_Consumers must call this function in their constructor before setting
any table data to allow indexers to decode table events._

```solidity
function registerCoreTables() internal;
function registerInternalTables() internal;
```

### getFieldLayout
Expand Down
4 changes: 2 additions & 2 deletions packages/store/src/StoreCore.sol
Expand Up @@ -88,11 +88,11 @@ library StoreCore {
}

/**
* @notice Register core tables in the store.
* @notice Register Store protocol's internal tables in the store.
* @dev Consumers must call this function in their constructor before setting
* any table data to allow indexers to decode table events.
*/
function registerCoreTables() internal {
function registerInternalTables() internal {
// Because `registerTable` writes to both `Tables` and `ResourceIds`, we can't use it
// directly here without creating a race condition, where we'd write to one or the other
// before they exist (depending on the order of registration).
Expand Down
2 changes: 1 addition & 1 deletion packages/store/test/StoreMock.sol
Expand Up @@ -18,7 +18,7 @@ import { ResourceId } from "../src/ResourceId.sol";
contract StoreMock is IStore, StoreData {
constructor() {
StoreCore.initialize();
StoreCore.registerCoreTables();
StoreCore.registerInternalTables();
StoreSwitch.setStoreAddress(address(this));
}

Expand Down
18 changes: 9 additions & 9 deletions packages/world/src/modules/core/CoreModule.sol
Expand Up @@ -62,8 +62,8 @@ contract CoreModule is Module {
* @dev Registers core tables, systems, and function selectors in the World.
*/
function installRoot(bytes memory) public override {
_registerCoreTables();
_registerCoreSystems();
_registerTables();
_registerSystems();
_registerFunctionSelectors();
}

Expand All @@ -76,11 +76,11 @@ contract CoreModule is Module {
}

/**
* @notice Register core tables in the World.
* @notice Register World's tables.
* @dev This internal function registers various tables and sets initial permissions.
*/
function _registerCoreTables() internal {
StoreCore.registerCoreTables();
function _registerTables() internal {
StoreCore.registerInternalTables();
NamespaceOwner.register();
Balances.register();
InstalledModules.register();
Expand Down Expand Up @@ -108,18 +108,18 @@ contract CoreModule is Module {
}

/**
* @notice Register the core systems in the World.
* @notice Register the systems in the World.
*/
function _registerCoreSystems() internal {
function _registerSystems() internal {
_registerSystem(accessManagementSystem, ACCESS_MANAGEMENT_SYSTEM_ID);
_registerSystem(balanceTransferSystem, BALANCE_TRANSFER_SYSTEM_ID);
_registerSystem(batchCallSystem, BATCH_CALL_SYSTEM_ID);
_registerSystem(coreRegistrationSystem, CORE_REGISTRATION_SYSTEM_ID);
}

/**
* @notice Register the core system in the World.
* @dev Uses the CoreRegistrationSystem's `registerSystem` implementation to register the system on the World.
* @notice Register the internal system in the World.
* @dev Uses the WorldRegistrationSystem's `registerSystem` implementation to register the system on the World.
*/
function _registerSystem(address target, ResourceId systemId) internal {
WorldContextProviderLib.delegatecallWithContextOrRevert({
Expand Down

0 comments on commit 5c52bee

Please sign in to comment.