docs(examples): add PostDeploy, test examples (latticexyz#725)

* fix(examples): add PostDeploy that tests expect

* docs(examples): add test command

* ci: test examples

* docs(examples): check in example .env

* ci: rename example workflow

* docs(examples): clarify .env comment a bit more

---------

Co-authored-by: Kevin Ingersoll <kingersoll@gmail.com>

.github/workflows/examples.yml

@@ -7,8 +7,8 @@ on:
   pull_request:
 
 jobs:
-  build:
-    name: Build examples
+  main:
+    name: Build/test examples
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -33,3 +33,7 @@ jobs:
 
       - name: Outdated files, run `pnpm gas-report` and commit them
         uses: ./.github/actions/require-empty-diff
+
+      - name: Run tests
+        working-directory: ./examples/${{ matrix.example }}
+        run: pnpm test

.gitignore

@@ -9,7 +9,6 @@ yarn.lock
 .docs
 lerna-debug.log
 .retype
-.env
 yarn-error.log
 .turbo
 

examples/v2-minimal/package.json

@@ -7,7 +7,8 @@
     "dev:client": "pnpm --filter 'client' run dev",
     "dev:contracts": "pnpm --filter 'contracts' dev",
     "dev:node": "pnpm --filter 'contracts' devnode",
-    "initialize": "pnpm recursive run initialize"
+    "initialize": "pnpm recursive run initialize",
+    "test": "pnpm recursive run test"
   },
   "devDependencies": {
     "run-pty": "^4.0.3"

examples/v2-minimal/packages/contracts/.env

@@ -0,0 +1,8 @@
+# This .env file is for demonstration purposes only.
+#
+# This should usually be excluded via .gitignore and the env vars attached to
+# your deployment enviroment, but we're including this here for ease of local
+# development. Please do not commit changes to this file!
+#
+# Anvil default private key:
+PRIVATE_KEY=0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

examples/v2-minimal/packages/contracts/.gitignore

@@ -5,7 +5,6 @@ bindings/
 artifacts/
 abi/
 broadcast/
-.env
 
 # Ignore all deploy artifacts
 deploys/**/*.json

examples/v2-minimal/packages/contracts/script/PostDeploy.s.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.0;
+
+import { Script } from "forge-std/Script.sol";
+import { console } from "forge-std/console.sol";
+import { IWorld } from "../src/codegen/world/IWorld.sol";
+
+contract PostDeploy is Script {
+  function run(address worldAddress) external {
+    // Load the private key from the `PRIVATE_KEY` environment variable (in .env)
+    uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+
+    // Start broadcasting transactions from the deployer account
+    vm.startBroadcast(deployerPrivateKey);
+
+    // ------------------ EXAMPLES ------------------
+
+    // Call increment on the world via the registered function selector
+    uint32 newValue = IWorld(worldAddress).increment();
+    console.log("Increment via IWorld:", newValue);
+
+    vm.stopBroadcast();
+  }
+}