Merge remote-tracking branch 'origin/main' into holic/store-sync-recs

latticexyz · Jul 31, 2023 · 543334c · 543334c
2 parents 84c54cd + b24502c
commit 543334c
Show file tree

Hide file tree

Showing 68 changed files with 3,389 additions and 403 deletions.
diff --git a/.changeset/afraid-hotels-bathe.md b/.changeset/afraid-hotels-bathe.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/cli": patch
+---
+
+Add support for legacy transactions in deploy script by falling back to `gasPrice` if `lastBaseFeePerGas` is not available
diff --git a/.changeset/big-goats-prove.md b/.changeset/big-goats-prove.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/services": patch
+---
+
+protocol-parser in Go
diff --git a/.changeset/brave-rings-tickle.md b/.changeset/brave-rings-tickle.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/store": patch
+---
+
+Optimize storage library
diff --git a/.changeset/mean-pans-study.md b/.changeset/mean-pans-study.md
@@ -0,0 +1,6 @@
+---
+"@latticexyz/cli": patch
+"@latticexyz/std-client": patch
+---
+
+Generated `contractComponents` now properly import `World` as type
diff --git a/.github/workflows/snapshot.yml b/.github/workflows/snapshot.yml
@@ -28,6 +28,10 @@ jobs:
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
+      # Remove this once https://github.com/changesets/changesets/issues/1195 is addressed
+      - name: Temporarily exit pre-release mode to release a snapshot
+        run: pnpm changeset pre exit
+
       - name: Clean
         shell: bash
         run: pnpm turbo run clean --force --concurrency 10
@@ -44,4 +48,3 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
diff --git a/.prettierignore b/.prettierignore
@@ -1,4 +1,5 @@
 dist
 **/types/ethers-contracts
 **/.next
-templates/phaser/packages/art
+templates/phaser/packages/art
+**/contractComponents.ts
diff --git a/docs/components/Logo.tsx b/docs/components/Logo.tsx
@@ -5,8 +5,12 @@ export default function Logo() {
   const [src, setSrc] = useState("/logo512-white.png"); // default to the dark theme logo
   const { theme } = useTheme();
 
+  // useEffect(() => {
+  //   setSrc(theme === "light" ? "/logo512-black.png" : "/logo512-white.png");
+  //}, [theme]);
+
   useEffect(() => {
-    setSrc(theme === "light" ? "/logo512-black.png" : "/logo512-white.png");
+    setSrc(theme === "light" ? "/mud-cover-photo.png" : "/mud-cover-photo.png");
   }, [theme]);
 
   return <img src={src} alt="MUD logo" />;

diff --git a/docs/components/WarningBox.tsx b/docs/components/WarningBox.tsx
@@ -3,20 +3,19 @@ import React from "react";
 const WarningBox = ({ title, message }) => {
   const styles = {
     container: {
-      backgroundColor: "#ffebee",
+      backgroundColor: "#FDF2F3",
       borderRadius: "4px",
-      boxShadow: "0 2px 1px -1px rgba(0, 0, 0, 0.2), 0 1px 1px 0 rgba(0, 0, 0, 0.14), 0 1px 3px 0 rgba(0, 0, 0, 0.12)",
+      border: "1px solid #E8D9DA",
       padding: "12px 20px",
       margin: "16px 0",
-      color: "#b71c1c",
+      color: "#7D221C",
     },
     header: {
       display: "flex",
       alignItems: "center",
       fontSize: "1rem",
       fontWeight: "bold",
       lineHeight: "1.43",
-      letterSpacing: "0.01071em",
     },
     icon: {
       marginRight: "12px",
@@ -26,8 +25,8 @@ const WarningBox = ({ title, message }) => {
       fontSize: "1rem",
       fontWeight: "400",
       lineHeight: "1.43",
-      letterSpacing: "0.01071em",
       paddingLeft: "34px",
+      color: "#995A56",
     },
   };
 

diff --git a/docs/pages/_meta.js b/docs/pages/_meta.js
@@ -11,6 +11,12 @@ export default {
   plugins: "Plugins",
   tutorials: "Tutorials",
   contribute: "Contribute",
+  roadmap: {
+    title: "Roadmap",
+    type: "page",
+    href: "https://roadmap.mud.dev",
+    newWindow: true,
+  },
   community: {
     title: "Community",
     type: "page",

diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -7,27 +7,34 @@ import Logo from "../components/Logo";
     <>
       <p>
         Please note that MUD v2 is still under development and some APIs may change! Stay up to date with MUD core
-        development, changes, and roadmap by checking out the{" "}
-        <a href="https://github.com/latticexyz/mud" target="_blank" style={{ textDecoration: "underline" }}>
+        development, changes, and&nbsp;
+        <a href="https://roadmap.mud.dev" target="_blank" style={{ textDecoration: "underline", color: "#7D221C" }}>
+          roadmap
+        </a> by checking out the <a
+          href="https://github.com/latticexyz/mud"
+          target="_blank"
+          style={{ textDecoration: "underline", color: "#7D221C" }}
+        >
           Github repo
-        </a>{" "}
-        and join the{" "}
-        <a href="https://lattice.xyz/discord" target="_blank" style={{ textDecoration: "underline" }}>
-          MUD Discord
+        </a> and join the <a
+          href="https://lattice.xyz/discord"
+          target="_blank"
+          style={{ textDecoration: "underline", color: "#7D221C" }}
+        >
+          MUD Discord.
         </a>{" "}
       </p>
+      <div style={{ height: "12px" }} />
     </>
   }
 />
 <div style={{ display: "flex", justifyContent: "center" }}>
-  <div style={{ width: "200px", marginBottom: "20px" }}>
+  <div style={{ marginBottom: "24px", marginTop: "12px" }}>
     <Logo />
   </div>
 </div>
 
-# MUD
-
-## Introduction
+# MUD Introduction
 
 MUD is a framework for ambitious Ethereum applications. It compresses the complexity of building EVM apps with a tightly integrated software stack.
 
@@ -45,9 +52,14 @@ MUD is maximally onchain: the entire application state lives in the EVM, and the
 
 ## Community support
 
-[Join our Discord](https://lattice.xyz/discord) to get support and connect with the community!
+Check out the following resources to learn more and get support:
 
-Check out our [community wiki](https://community.mud.dev) for MUD projects and MUD-related articles, videos, and podcasts.
+- [Discord](https://lattice.xyz/discord): get support and connect with the community!
+- [New releases](https://github.com/latticexyz/mud/releases): see recent changes to MUD.
+- [Roadmap](https://roadmap.mud.dev): a high-level overview of what we'll be working on next.
+- [Status](https://status.mud.dev): take a look at ongoing and upcoming initatives.
+- [Contribute](https://contribute.mud.dev): start contributing with some good first tasks.
+- [Community wiki](https://community.mud.dev): for MUD projects and MUD-related articles, videos, and podcasts.
 
 ## License
 

diff --git a/docs/pages/world/world-101.mdx b/docs/pages/world/world-101.mdx
@@ -222,19 +222,29 @@ Now we can import our new table, and write something to it. Let’s write a func
 // SPDX-License-Identifier: MIT
 pragma solidity >=0.8.0;
 import { System } from "@latticexyz/world/src/System.sol";
-import { Dog } from "../codegen/tables/Dog.sol"; // import table we created
+import { Dog, DogData } from "../codegen/tables/Dog.sol"; // import table we created
+
 contract MySystem is System {
   function addEntry(string memory name, string memory color) public returns (bytes32) {
     bytes32 key = bytes32(abi.encodePacked(block.number, msg.sender, gasleft())); // creating a random key for the record
     address owner = _msgSender(); // IMPORTANT: always refer to the msg.sender using the _msgSender() function
-    Dog.set(key, {owner: owner, name: name, color: color}); // creating our record!
+    Dog.set(key, DogData({ owner: owner, name: name, color: color })); // creating our record!
     return key;
   }
 }
 ```
 
 That’s it! `MySystem`, just like `IncrementSystem`, will have access to Dog given they are in the same namespace.
 
+We can run `pnpm mud worldgen` in the contract folder to recreate the systems.
+
+```bash
+> pnpm mud worldgen
+Generated system interface: src/codegen/world/IIncrementSystem.sol
+Generated system interface: src/codegen/world/IMySystem.sol
+Generated system interface: src/codegen/world/IWorld.sol
+```
+
 After this step, the filesystem of the World is like this:
 
 ```bash

diff --git a/docs/public/mud-cover-photo.png b/docs/public/mud-cover-photo.png
diff --git a/e2e/packages/client-vanilla/src/mud/contractComponents.ts b/e2e/packages/client-vanilla/src/mud/contractComponents.ts
@@ -1,6 +1,10 @@
 /* Autogenerated file. Do not edit manually. */
 
-import { defineComponent, Type as RecsType, World } from "@latticexyz/recs";
+import {
+  defineComponent,
+  Type as RecsType,
+  type World,
+} from "@latticexyz/recs";
 
 export function defineContractComponents(world: World) {
   return {

diff --git a/examples/minimal/packages/client-phaser/src/mud/contractComponents.ts b/examples/minimal/packages/client-phaser/src/mud/contractComponents.ts
@@ -1,6 +1,10 @@
 /* Autogenerated file. Do not edit manually. */
 
-import { defineComponent, Type as RecsType, World } from "@latticexyz/recs";
+import {
+  defineComponent,
+  Type as RecsType,
+  type World,
+} from "@latticexyz/recs";
 
 export function defineContractComponents(world: World) {
   return {

diff --git a/examples/minimal/packages/client-react/src/mud/contractComponents.ts b/examples/minimal/packages/client-react/src/mud/contractComponents.ts
@@ -1,6 +1,10 @@
 /* Autogenerated file. Do not edit manually. */
 
-import { defineComponent, Type as RecsType, World } from "@latticexyz/recs";
+import {
+  defineComponent,
+  Type as RecsType,
+  type World,
+} from "@latticexyz/recs";
 
 export function defineContractComponents(world: World) {
   return {

diff --git a/examples/minimal/packages/client-vanilla/src/mud/contractComponents.ts b/examples/minimal/packages/client-vanilla/src/mud/contractComponents.ts
@@ -1,6 +1,10 @@
 /* Autogenerated file. Do not edit manually. */
 
-import { defineComponent, Type as RecsType, World } from "@latticexyz/recs";
+import {
+  defineComponent,
+  Type as RecsType,
+  type World,
+} from "@latticexyz/recs";
 
 export function defineContractComponents(world: World) {
   return {

diff --git a/packages/cli/src/render-ts/renderRecsV1Tables.ts b/packages/cli/src/render-ts/renderRecsV1Tables.ts
@@ -6,7 +6,7 @@ export function renderRecsV1Tables(options: RecsV1TableOptions) {
 
   return `/* Autogenerated file. Do not edit manually. */
 
-import { defineComponent, Type as RecsType, World } from "@latticexyz/recs";
+import { defineComponent, Type as RecsType, type World } from "@latticexyz/recs";
 
 export function defineContractComponents(world: World) {
   return {

diff --git a/packages/cli/src/utils/deploy.ts b/packages/cli/src/utils/deploy.ts
@@ -59,8 +59,10 @@ export async function deploy(
   console.log("Initial nonce", nonce);
 
   // Compute maxFeePerGas and maxPriorityFeePerGas like ethers, but allow for a multiplier to allow replacing pending transactions
-  let maxPriorityFeePerGas: number;
-  let maxFeePerGas: BigNumber;
+  let maxPriorityFeePerGas: number | undefined;
+  let maxFeePerGas: BigNumber | undefined;
+  let gasPrice: BigNumber | undefined;
+
   await setInternalFeePerGas(priorityFeeMultiplier);
 
   // Catch all to await any promises before exiting the script
@@ -402,6 +404,7 @@ export async function deploy(
           nonce: nonce++,
           maxPriorityFeePerGas,
           maxFeePerGas,
+          gasPrice,
         })
         .then((c) => (disableTxWait ? c : c.deployed()));
 
@@ -497,7 +500,7 @@ export async function deploy(
       const gasLimit = await contract.estimateGas[func].apply(null, args);
       console.log(chalk.gray(`executing transaction: ${functionName} with nonce ${nonce}`));
       const txPromise = contract[func]
-        .apply(null, [...args, { gasLimit, nonce: nonce++, maxPriorityFeePerGas, maxFeePerGas }])
+        .apply(null, [...args, { gasLimit, nonce: nonce++, maxPriorityFeePerGas, maxFeePerGas, gasPrice }])
         .then((tx: any) => (confirmations === 0 ? tx : tx.wait(confirmations)));
       promises.push(txPromise);
       return txPromise;
@@ -542,15 +545,28 @@ export async function deploy(
   async function setInternalFeePerGas(multiplier: number) {
     // Compute maxFeePerGas and maxPriorityFeePerGas like ethers, but allow for a multiplier to allow replacing pending transactions
     const feeData = await provider.getFeeData();
-    if (!feeData.lastBaseFeePerGas) throw new MUDError("Can not fetch lastBaseFeePerGas from RPC");
-    if (!feeData.lastBaseFeePerGas.eq(0) && (await signer.getBalance()).eq(0)) {
-      throw new MUDError(`Attempting to deploy to a chain with non-zero base fee with an account that has no balance.
-If you're deploying to the Lattice testnet, you can fund your account by running 'pnpm mud faucet --address ${await signer.getAddress()}'`);
-    }
 
-    // Set the priority fee to 0 for development chains with no base fee, to allow transactions from unfunded wallets
-    maxPriorityFeePerGas = feeData.lastBaseFeePerGas.eq(0) ? 0 : Math.floor(1_500_000_000 * multiplier);
-    maxFeePerGas = feeData.lastBaseFeePerGas.mul(2).add(maxPriorityFeePerGas);
+    if (feeData.lastBaseFeePerGas) {
+      if (!feeData.lastBaseFeePerGas.eq(0) && (await signer.getBalance()).eq(0)) {
+        throw new MUDError(`Attempting to deploy to a chain with non-zero base fee with an account that has no balance.
+        If you're deploying to the Lattice testnet, you can fund your account by running 'pnpm mud faucet --address ${await signer.getAddress()}'`);
+      }
+
+      // Set the priority fee to 0 for development chains with no base fee, to allow transactions from unfunded wallets
+      maxPriorityFeePerGas = feeData.lastBaseFeePerGas.eq(0) ? 0 : Math.floor(1_500_000_000 * multiplier);
+      maxFeePerGas = feeData.lastBaseFeePerGas.mul(2).add(maxPriorityFeePerGas);
+    } else if (feeData.gasPrice) {
+      // Legacy chains with gasPrice instead of maxFeePerGas
+      if (!feeData.gasPrice.eq(0) && (await signer.getBalance()).eq(0)) {
+        throw new MUDError(
+          `Attempting to deploy to a chain with non-zero gas price with an account that has no balance.`
+        );
+      }
+
+      gasPrice = feeData.gasPrice;
+    } else {
+      throw new MUDError("Can not fetch fee data from RPC");
+    }
   }
 }