Skip to content

Commit b72c749

Browse files
TamaraRingasTamaraRingas
committed
Merge branch 'main' of https://github.com/latticexyz/mud into tr/erc20-module-own-store
2 parents 5ea8fbb + 0eb2556 commit b72c749

File tree

28 files changed

+135
-33
lines changed

28 files changed

+135
-33
lines changed

‎.changeset/real-waves-bathe.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"create-mud": patch
3+
---
4+
5+
New projects created with `pnpm create mud` now include the World Explorer and SQLite indexer running as additional services.

‎.changeset/swift-rabbits-appear.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
"@latticexyz/explorer": minor
33
---
44

5-
Initial release of the @latticexyz/explorer package. Explorer is a standalone tool designed to explore and manage worlds. This initial release supports local worlds, with plans to extend support to any world in the future.
5+
Initial release of the `@latticexyz/explorer` package. World Explorer is a standalone tool designed to explore and manage worlds. This initial release supports local worlds, with plans to extend support to any world in the future.
66

7-
Read more on how to get started or contribute in the [Explorer README](https://github.com/latticexyz/mud/blob/main/packages/explorer/README.md).
7+
Read more on how to get started or contribute in the [World Explorer README](https://github.com/latticexyz/mud/blob/main/packages/explorer/README.md).

‎.github/workflows/changeset.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Changeset
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
changeset:
8+
name: Validate changeset
9+
runs-on: depot-ubuntu-22.04-16
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v3
13+
with:
14+
fetch-depth: 0
15+
16+
- name: Setup
17+
uses: ./.github/actions/setup
18+
19+
- name: Changeset
20+
run: pnpm changeset status --since origin/main

‎examples/local-explorer/mprocs.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ procs:
99
cwd: packages/contracts
1010
shell: anvil --base-fee 0 --block-time 2
1111
indexer:
12+
cwd: packages/contracts
1213
shell: rimraf $SQLITE_FILENAME && pnpm sqlite-indexer
1314
env:
1415
RPC_HTTP_URL: "http://127.0.0.1:8545"
1516
FOLLOW_BLOCK_TAG: "latest"
1617
SQLITE_FILENAME: "indexer.db"
1718
explorer:
18-
shell: pnpm explorer --worldsFile packages/contracts/worlds.json
19+
cwd: packages/contracts
20+
shell: pnpm explorer

‎packages/explorer/README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Explorer
1+
# World Explorer
22

3-
Explorer is a GUI tool designed for visually exploring and manipulating the state of worlds.
3+
World Explorer is a GUI tool designed for visually exploring and manipulating the state of worlds.
44

55
## Getting started
66

@@ -14,7 +14,7 @@ Explorer is a GUI tool designed for visually exploring and manipulating the stat
1414

1515
Ensure you have a local development chain running.
1616

17-
3. **Run the explorer**
17+
3. **Run the World Explorer**
1818

1919
```sh
2020
npx @latticexyz/explorer --worldAddress <YOUR_WORLD_ADDRESS>
@@ -30,20 +30,20 @@ Explorer is a GUI tool designed for visually exploring and manipulating the stat
3030

3131
## CLI arguments
3232

33-
The explorer accepts the following CLI arguments:
33+
The World Explorer accepts the following CLI arguments:
3434

35-
| Argument | Description | Default value |
36-
| ----------------- | -------------------------------------------------------------------------- | ------------- |
37-
| `worldAddress` | The address of the world to explore | None |
38-
| `worldsFile` | Path to a worlds configuration file (used to resolve world address) | None |
39-
| `indexerDatabase` | Path to your SQLite indexer database | "indexer.db" |
40-
| `chainId` | The chain ID of the network | 31337 |
41-
| `port` | The port on which to run the explorer | 13690 |
42-
| `env` | The environment to run the explorer in (e.g., "development", "production") | "production" |
35+
| Argument | Description | Default value |
36+
| ----------------- | -------------------------------------------------------------------------------- | ------------- |
37+
| `worldAddress` | The address of the world to explore | None |
38+
| `worldsFile` | Path to a worlds configuration file (used to resolve world address) | None |
39+
| `indexerDatabase` | Path to your SQLite indexer database | "indexer.db" |
40+
| `chainId` | The chain ID of the network | 31337 |
41+
| `port` | The port on which to run the World Explorer | 13690 |
42+
| `env` | The environment to run the World Explorer in (e.g., "development", "production") | "production" |
4343

4444
## Example setup
4545

46-
An example setup is provided in the `examples/local-explorer` directory, demonstrating a full setup for using the explorer in a local development environment:
46+
An example setup is provided in the `examples/local-explorer` directory, demonstrating a full setup for using the World Explorer in a local development environment:
4747

4848
1. **Setup**
4949

@@ -61,15 +61,15 @@ An example setup is provided in the `examples/local-explorer` directory, demonst
6161

6262
## Contributing
6363

64-
To contribute to or modify the explorer, the easiest way is to run the example setup in `development` mode:
64+
To contribute to or modify the World Explorer, the easiest way is to run the example setup in `development` mode:
6565

6666
1. **Setup**
6767

6868
Navigate to the `examples/local-explorer` directory and locate the `mprocs.yaml` file.
6969

7070
2. **Configure**
7171

72-
In `mprocs.yaml`, ensure the explorer command is set up correctly. For example:
72+
In `mprocs.yaml`, ensure the `explorer` command is set up correctly. For example:
7373

7474
```yaml
7575
explorer:
@@ -82,4 +82,4 @@ To contribute to or modify the explorer, the easiest way is to run the example s
8282
pnpm dev
8383
```
8484

85-
Files can now be edited in the `packages/explorer` directory, and changes will be reflected in the running explorer instance.
85+
Files can now be edited in the `packages/explorer` directory, and changes will be reflected in the running World Explorer instance.

‎packages/explorer/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@latticexyz/explorer",
33
"version": "2.1.1",
4-
"description": "Explorer is a tool for visually exploring and manipulating the state of worlds",
4+
"description": "World Explorer is a tool for visually exploring and manipulating the state of worlds",
55
"type": "module",
66
"bin": {
77
"explorer": "./dist/explorer.js"

‎packages/explorer/src/app/Providers.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export const wagmiConfig = createConfig({
1515
injected(),
1616
metaMask({
1717
dappMetadata: {
18-
name: "Explorer",
18+
name: "World Explorer",
1919
},
2020
}),
2121
safe(),

‎packages/explorer/src/app/layout.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ const jetbrains = JetBrains_Mono({
1919
});
2020

2121
export const metadata: Metadata = {
22-
title: "Explorer",
23-
description: "Explorer is a tool for visually exploring and manipulating the state of worlds",
22+
title: "World Explorer",
23+
description: "World Explorer is a tool for visually exploring and manipulating the state of worlds",
2424
};
2525

2626
export default function RootLayout({

‎templates/phaser/.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
node_modules
1+
node_modules
2+
3+
# mud sqlite indexer data
4+
indexer.db

‎templates/phaser/mprocs.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,13 @@ procs:
88
anvil:
99
cwd: packages/contracts
1010
shell: anvil --base-fee 0 --block-time 2
11+
indexer:
12+
cwd: packages/contracts
13+
shell: rimraf $SQLITE_FILENAME && pnpm sqlite-indexer
14+
env:
15+
RPC_HTTP_URL: "http://127.0.0.1:8545"
16+
FOLLOW_BLOCK_TAG: "latest"
17+
SQLITE_FILENAME: "indexer.db"
18+
explorer:
19+
cwd: packages/contracts
20+
shell: pnpm explorer

‎templates/phaser/package.json

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
"devDependencies": {
1515
"@latticexyz/cli": "link:../../packages/cli",
1616
"@latticexyz/common": "link:../../packages/common",
17+
"@latticexyz/explorer": "link:../../packages/explorer",
18+
"@latticexyz/store-indexer": "link:../../packages/store-indexer",
1719
"@types/debug": "4.1.7",
1820
"@typescript-eslint/eslint-plugin": "7.1.1",
1921
"@typescript-eslint/parser": "7.1.1",

‎templates/phaser/packages/contracts/worlds.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"31337": {
3-
"address": "0x4f4ddafbc93cf8d11a253f21ddbcf836139efdec"
3+
"address": "0x8d8b6b8414e1e3dcfd4168561b9be6bd3bf6ec4b"
44
}
55
}

‎templates/react-ecs/.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
node_modules
1+
node_modules
2+
3+
# mud sqlite indexer data
4+
indexer.db

‎templates/react-ecs/mprocs.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,13 @@ procs:
88
anvil:
99
cwd: packages/contracts
1010
shell: anvil --base-fee 0 --block-time 2
11+
indexer:
12+
cwd: packages/contracts
13+
shell: rimraf $SQLITE_FILENAME && pnpm sqlite-indexer
14+
env:
15+
RPC_HTTP_URL: "http://127.0.0.1:8545"
16+
FOLLOW_BLOCK_TAG: "latest"
17+
SQLITE_FILENAME: "indexer.db"
18+
explorer:
19+
cwd: packages/contracts
20+
shell: pnpm explorer

‎templates/react-ecs/package.json

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
"devDependencies": {
1515
"@latticexyz/cli": "link:../../packages/cli",
1616
"@latticexyz/common": "link:../../packages/common",
17+
"@latticexyz/explorer": "link:../../packages/explorer",
18+
"@latticexyz/store-indexer": "link:../../packages/store-indexer",
1719
"@types/debug": "4.1.7",
1820
"@typescript-eslint/eslint-plugin": "7.1.1",
1921
"@typescript-eslint/parser": "7.1.1",

‎templates/react-ecs/packages/contracts/worlds.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"31337": {
3-
"address": "0x4f4ddafbc93cf8d11a253f21ddbcf836139efdec"
3+
"address": "0x8d8b6b8414e1e3dcfd4168561b9be6bd3bf6ec4b"
44
}
55
}

‎templates/react/.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
node_modules
1+
node_modules
2+
3+
# mud sqlite indexer data
4+
indexer.db

‎templates/react/mprocs.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,13 @@ procs:
88
anvil:
99
cwd: packages/contracts
1010
shell: anvil --base-fee 0 --block-time 2
11+
indexer:
12+
cwd: packages/contracts
13+
shell: rimraf $SQLITE_FILENAME && pnpm sqlite-indexer
14+
env:
15+
RPC_HTTP_URL: "http://127.0.0.1:8545"
16+
FOLLOW_BLOCK_TAG: "latest"
17+
SQLITE_FILENAME: "indexer.db"
18+
explorer:
19+
cwd: packages/contracts
20+
shell: pnpm explorer

‎templates/react/package.json

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
"devDependencies": {
1515
"@latticexyz/cli": "link:../../packages/cli",
1616
"@latticexyz/common": "link:../../packages/common",
17+
"@latticexyz/explorer": "link:../../packages/explorer",
18+
"@latticexyz/store-indexer": "link:../../packages/store-indexer",
1719
"@types/debug": "4.1.7",
1820
"@typescript-eslint/eslint-plugin": "7.1.1",
1921
"@typescript-eslint/parser": "7.1.1",

‎templates/react/packages/contracts/worlds.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"31337": {
3-
"address": "0x4f4ddafbc93cf8d11a253f21ddbcf836139efdec"
3+
"address": "0x8d8b6b8414e1e3dcfd4168561b9be6bd3bf6ec4b"
44
}
55
}

‎templates/threejs/.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
node_modules
1+
node_modules
2+
3+
# mud sqlite indexer data
4+
indexer.db

‎templates/threejs/mprocs.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,13 @@ procs:
88
anvil:
99
cwd: packages/contracts
1010
shell: anvil --base-fee 0 --block-time 2
11+
indexer:
12+
cwd: packages/contracts
13+
shell: rimraf $SQLITE_FILENAME && pnpm sqlite-indexer
14+
env:
15+
RPC_HTTP_URL: "http://127.0.0.1:8545"
16+
FOLLOW_BLOCK_TAG: "latest"
17+
SQLITE_FILENAME: "indexer.db"
18+
explorer:
19+
cwd: packages/contracts
20+
shell: pnpm explorer

‎templates/threejs/package.json

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
"devDependencies": {
1515
"@latticexyz/cli": "link:../../packages/cli",
1616
"@latticexyz/common": "link:../../packages/common",
17+
"@latticexyz/explorer": "link:../../packages/explorer",
18+
"@latticexyz/store-indexer": "link:../../packages/store-indexer",
1719
"@types/debug": "4.1.7",
1820
"@typescript-eslint/eslint-plugin": "7.1.1",
1921
"@typescript-eslint/parser": "7.1.1",

‎templates/threejs/packages/contracts/worlds.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"31337": {
3-
"address": "0x4f4ddafbc93cf8d11a253f21ddbcf836139efdec"
3+
"address": "0x8d8b6b8414e1e3dcfd4168561b9be6bd3bf6ec4b"
44
}
55
}

‎templates/vanilla/.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
1-
node_modules
1+
node_modules
2+
3+
# mud sqlite indexer data
4+
indexer.db

‎templates/vanilla/mprocs.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,13 @@ procs:
88
anvil:
99
cwd: packages/contracts
1010
shell: anvil --base-fee 0 --block-time 2
11+
indexer:
12+
cwd: packages/contracts
13+
shell: rimraf $SQLITE_FILENAME && pnpm sqlite-indexer
14+
env:
15+
RPC_HTTP_URL: "http://127.0.0.1:8545"
16+
FOLLOW_BLOCK_TAG: "latest"
17+
SQLITE_FILENAME: "indexer.db"
18+
explorer:
19+
cwd: packages/contracts
20+
shell: pnpm explorer

‎templates/vanilla/package.json

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@
1414
"devDependencies": {
1515
"@latticexyz/cli": "link:../../packages/cli",
1616
"@latticexyz/common": "link:../../packages/common",
17+
"@latticexyz/explorer": "link:../../packages/explorer",
18+
"@latticexyz/store-indexer": "link:../../packages/store-indexer",
1719
"@types/debug": "4.1.7",
1820
"@typescript-eslint/eslint-plugin": "7.1.1",
1921
"@typescript-eslint/parser": "7.1.1",

‎templates/vanilla/packages/contracts/worlds.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"31337": {
3-
"address": "0x4f4ddafbc93cf8d11a253f21ddbcf836139efdec"
3+
"address": "0x8d8b6b8414e1e3dcfd4168561b9be6bd3bf6ec4b"
44
}
55
}

0 commit comments

Comments
 (0)