@latticexyz/cli 1.34.0 → 1.36.0

package/src/utils/deploy.ts

@@ -73,6 +73,7 @@ export type DeployOptions = {
   worldAddress?: string;
   rpc: string;
   systems?: string | string[];
+  reuseComponents?: boolean;
   clear?: boolean;
   gasPrice?: number;
 };
@@ -94,15 +95,11 @@ export async function generateAndDeploy(args: DeployOptions) {
       args.deployerPrivateKey,
       args.rpc,
       args.worldAddress,
-      Boolean(args.systems),
+      Boolean(args.reuseComponents),
       args.gasPrice
     );
     deployedWorldAddress = result.deployedWorldAddress;
     initialBlockNumber = result.initialBlockNumber;
-
-    // Extract world address from deploy script
-  } catch (e) {
-    console.error(e);
   } finally {
     // Remove generated LibDeploy
     console.log("Cleaning up deployment script");

package/src/utils/forgeConfig.ts

@@ -0,0 +1,45 @@
+import { execa } from "execa";
+
+export interface ForgeConfig {
+  // project
+  src: string;
+  test: string;
+  out: string;
+  libs: string[];
+
+  // all unspecified keys (this interface is far from comprehensive)
+  [key: string]: unknown;
+}
+
+/**
+ * Get forge config as a parsed json object.
+ */
+export async function getForgeConfig() {
+  const { stdout } = await execa("forge", ["config", "--json"], { stdio: ["inherit", "pipe", "pipe"] });
+
+  return JSON.parse(stdout) as ForgeConfig;
+}
+
+/**
+ * Get the value of "src" from forge config.
+ * The path to the contract sources relative to the root of the project.
+ */
+export async function getSrcDirectory() {
+  return (await getForgeConfig()).src;
+}
+
+/**
+ * Get the value of "test" from forge config.
+ * The path to the test contract sources relative to the root of the project.
+ */
+export async function getTestDirectory() {
+  return (await getForgeConfig()).test;
+}
+
+/**
+ * Get the value of "out" from forge config.
+ * The path to put contract artifacts in, relative to the root of the project.
+ */
+export async function getOutDirectory() {
+  return (await getForgeConfig()).out;
+}

package/src/utils/types.ts

@@ -5,6 +5,8 @@ import { extractIdFromFile } from "./ids";
 import { rmSync, writeFileSync } from "fs";
 import path from "path";
 import { filterAbi, forgeBuild } from "./build";
+import { getOutDirectory, getSrcDirectory } from "./forgeConfig";
+import { systemsDir } from "./constants";
 
 export async function generateAbiTypes(
   inputDir: string,
@@ -31,7 +33,7 @@ export async function generateAbiTypes(
   console.log(`Successfully generated ${result.filesGenerated} files`);
 }
 
-export async function generateSystemTypes(inputDir: string, outputDir: string, options?: { clear?: boolean }) {
+export async function generateSystemTypes(outputDir: string, options?: { clear?: boolean }) {
   if (options?.clear) {
     console.log("Clearing system type output files", outputDir);
     rmSync(path.join(outputDir, "/SystemTypes.ts"), { force: true });
@@ -45,7 +47,8 @@ export async function generateSystemTypes(inputDir: string, outputDir: string, o
   let ids: string[] = [];
   let typePaths: string[] = [];
 
-  const systemsPath = `${inputDir}/*.sol`;
+  const srcDir = await getSrcDirectory();
+  const systemsPath = path.join(srcDir, systemsDir, "*.sol");
 
   const [resolve, , promise] = deferred<void>();
   glob(systemsPath, {}, (_, matches) => {
@@ -126,12 +129,12 @@ ${systems.map((system, index) => `  "${ids[index]}": ${system}.abi,`).join("\n")
 export async function generateTypes(abiDir?: string, outputDir = "./types", options?: { clear?: boolean }) {
   if (!abiDir) {
     console.log("Compiling contracts");
-    const buildOutput = "./out";
+    const buildOutput = await getOutDirectory();
     abiDir = "./abi";
-    await forgeBuild(buildOutput, options);
+    await forgeBuild(options);
     filterAbi(buildOutput, abiDir);
   }
 
   await generateAbiTypes(abiDir, path.join(outputDir, "ethers-contracts"), options);
-  await generateSystemTypes("./src/systems", outputDir, options);
+  await generateSystemTypes(outputDir, options);
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022-present Lattice Labs Ltd.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/src/contracts/Cheats.sol

@@ -1,320 +0,0 @@
-// SPDX-License-Identifier: MIT
-pragma solidity >=0.8.0;
-
-interface Cheats {
-  // This allows us to getRecordedLogs()
-  struct Log {
-    bytes32[] topics;
-    bytes data;
-  }
-
-  // Set block.timestamp (newTimestamp)
-  function warp(uint256) external;
-
-  // Set block.height (newHeight)
-  function roll(uint256) external;
-
-  // Set block.basefee (newBasefee)
-  function fee(uint256) external;
-
-  // Set block.coinbase (who)
-  function coinbase(address) external;
-
-  // Loads a storage slot from an address (who, slot)
-  function load(address, bytes32) external returns (bytes32);
-
-  // Stores a value to an address' storage slot, (who, slot, value)
-  function store(
-    address,
-    bytes32,
-    bytes32
-  ) external;
-
-  // Signs data, (privateKey, digest) => (v, r, s)
-  function sign(uint256, bytes32)
-    external
-    returns (
-      uint8,
-      bytes32,
-      bytes32
-    );
-
-  // Gets address for a given private key, (privateKey) => (address)
-  function addr(uint256) external returns (address);
-
-  // Derive a private key from a provided mnenomic string (or mnenomic file path) at the derivation path m/44'/60'/0'/0/{index}
-  function deriveKey(string calldata, uint32) external returns (uint256);
-
-  // Derive a private key from a provided mnenomic string (or mnenomic file path) at the derivation path {path}{index}
-  function deriveKey(
-    string calldata,
-    string calldata,
-    uint32
-  ) external returns (uint256);
-
-  // Performs a foreign function call via terminal, (stringInputs) => (result)
-  function ffi(string[] calldata) external returns (bytes memory);
-
-  // Set environment variables, (name, value)
-  function setEnv(string calldata, string calldata) external;
-
-  // Read environment variables, (name) => (value)
-  function envBool(string calldata) external returns (bool);
-
-  function envUint(string calldata) external returns (uint256);
-
-  function envInt(string calldata) external returns (int256);
-
-  function envAddress(string calldata) external returns (address);
-
-  function envBytes32(string calldata) external returns (bytes32);
-
-  function envString(string calldata) external returns (string memory);
-
-  function envBytes(string calldata) external returns (bytes memory);
-
-  // Read environment variables as arrays, (name, delim) => (value[])
-  function envBool(string calldata, string calldata) external returns (bool[] memory);
-
-  function envUint(string calldata, string calldata) external returns (uint256[] memory);
-
-  function envInt(string calldata, string calldata) external returns (int256[] memory);
-
-  function envAddress(string calldata, string calldata) external returns (address[] memory);
-
-  function envBytes32(string calldata, string calldata) external returns (bytes32[] memory);
-
-  function envString(string calldata, string calldata) external returns (string[] memory);
-
-  function envBytes(string calldata, string calldata) external returns (bytes[] memory);
-
-  // Sets the *next* call's msg.sender to be the input address
-  function prank(address) external;
-
-  // Sets all subsequent calls' msg.sender to be the input address until `stopPrank` is called
-  function startPrank(address) external;
-
-  // Sets the *next* call's msg.sender to be the input address, and the tx.origin to be the second input
-  function prank(address, address) external;
-
-  // Sets all subsequent calls' msg.sender to be the input address until `stopPrank` is called, and the tx.origin to be the second input
-  function startPrank(address, address) external;
-
-  // Resets subsequent calls' msg.sender to be `address(this)`
-  function stopPrank() external;
-
-  // Sets an address' balance, (who, newBalance)
-  function deal(address, uint256) external;
-
-  // Sets an address' code, (who, newCode)
-  function etch(address, bytes calldata) external;
-
-  // Expects an error on next call
-  function expectRevert() external;
-
-  function expectRevert(bytes calldata) external;
-
-  function expectRevert(bytes4) external;
-
-  // Record all storage reads and writes
-  function record() external;
-
-  // Gets all accessed reads and write slot from a recording session, for a given address
-  function accesses(address) external returns (bytes32[] memory reads, bytes32[] memory writes);
-
-  // Record all the transaction logs
-  function recordLogs() external;
-
-  // Gets all the recorded logs
-  function getRecordedLogs() external returns (Log[] memory);
-
-  // Prepare an expected log with (bool checkTopic1, bool checkTopic2, bool checkTopic3, bool checkData).
-  // Call this function, then emit an event, then call a function. Internally after the call, we check if
-  // logs were emitted in the expected order with the expected topics and data (as specified by the booleans).
-  // Second form also checks supplied address against emitting contract.
-  function expectEmit(
-    bool,
-    bool,
-    bool,
-    bool
-  ) external;
-
-  function expectEmit(
-    bool,
-    bool,
-    bool,
-    bool,
-    address
-  ) external;
-
-  // Mocks a call to an address, returning specified data.
-  // Calldata can either be strict or a partial match, e.g. if you only
-  // pass a Solidity selector to the expected calldata, then the entire Solidity
-  // function will be mocked.
-  function mockCall(
-    address,
-    bytes calldata,
-    bytes calldata
-  ) external;
-
-  // Mocks a call to an address with a specific msg.value, returning specified data.
-  // Calldata match takes precedence over msg.value in case of ambiguity.
-  function mockCall(
-    address,
-    uint256,
-    bytes calldata,
-    bytes calldata
-  ) external;
-
-  // Clears all mocked calls
-  function clearMockedCalls() external;
-
-  // Expect a call to an address with the specified calldata.
-  // Calldata can either be strict or a partial match
-  function expectCall(address, bytes calldata) external;
-
-  // Expect a call to an address with the specified msg.value and calldata
-  function expectCall(
-    address,
-    uint256,
-    bytes calldata
-  ) external;
-
-  // Gets the code from an artifact file. Takes in the relative path to the json file
-  function getCode(string calldata) external returns (bytes memory);
-
-  // Labels an address in call traces
-  function label(address, string calldata) external;
-
-  // If the condition is false, discard this run's fuzz inputs and generate new ones
-  function assume(bool) external;
-
-  // Set nonce for an account
-  function setNonce(address, uint64) external;
-
-  // Get nonce for an account
-  function getNonce(address) external returns (uint64);
-
-  // Set block.chainid (newChainId)
-  function chainId(uint256) external;
-
-  // Using the address that calls the test contract, has the next call (at this call depth only) create a transaction that can later be signed and sent onchain
-  function broadcast() external;
-
-  // Has the next call (at this call depth only) create a transaction with the address provided as the sender that can later be signed and sent onchain
-  function broadcast(address) external;
-
-  // Using the address that calls the test contract, has the all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain
-  function startBroadcast() external;
-
-  // Has the all subsequent calls (at this call depth only) create transactions that can later be signed and sent onchain
-  function startBroadcast(address) external;
-
-  // Stops collecting onchain transactions
-  function stopBroadcast() external;
-
-  // Reads the entire content of file to string. Path is relative to the project root. (path) => (data)
-  function readFile(string calldata) external returns (string memory);
-
-  // Reads next line of file to string, (path) => (line)
-  function readLine(string calldata) external returns (string memory);
-
-  // Writes data to file, creating a file if it does not exist, and entirely replacing its contents if it does.
-  // Path is relative to the project root. (path, data) => ()
-  function writeFile(string calldata, string calldata) external;
-
-  // Writes line to file, creating a file if it does not exist.
-  // Path is relative to the project root. (path, data) => ()
-  function writeLine(string calldata, string calldata) external;
-
-  // Closes file for reading, resetting the offset and allowing to read it from beginning with readLine.
-  // Path is relative to the project root. (path) => ()
-  function closeFile(string calldata) external;
-
-  // Removes file. This cheatcode will revert in the following situations, but is not limited to just these cases:
-  // - Path points to a directory.
-  // - The file doesn't exist.
-  // - The user lacks permissions to remove the file.
-  // Path is relative to the project root. (path) => ()
-  function removeFile(string calldata) external;
-
-  function toString(address) external returns (string memory);
-
-  function toString(bytes calldata) external returns (string memory);
-
-  function toString(bytes32) external returns (string memory);
-
-  function toString(bool) external returns (string memory);
-
-  function toString(uint256) external returns (string memory);
-
-  function toString(int256) external returns (string memory);
-
-  // Snapshot the current state of the evm.
-  // Returns the id of the snapshot that was created.
-  // To revert a snapshot use `revertTo`
-  function snapshot() external returns (uint256);
-
-  // Revert the state of the evm to a previous snapshot
-  // Takes the snapshot id to revert to.
-  // This deletes the snapshot and all snapshots taken after the given snapshot id.
-  function revertTo(uint256) external returns (bool);
-
-  // Creates a new fork with the given endpoint and block and returns the identifier of the fork
-  function createFork(string calldata, uint256) external returns (uint256);
-
-  // Creates a new fork with the given endpoint and the _latest_ block and returns the identifier of the fork
-  function createFork(string calldata) external returns (uint256);
-
-  // Creates _and_ also selects a new fork with the given endpoint and block and returns the identifier of the fork
-  function createSelectFork(string calldata, uint256) external returns (uint256);
-
-  // Creates _and_ also selects a new fork with the given endpoint and the latest block and returns the identifier of the fork
-  function createSelectFork(string calldata) external returns (uint256);
-
-  // Takes a fork identifier created by `createFork` and sets the corresponding forked state as active.
-  function selectFork(uint256) external;
-
-  // Returns the currently active fork
-  // Reverts if no fork is currently active
-  function activeFork() external returns (uint256);
-
-  // Marks that the account(s) should use persistent storage across fork swaps.
-  // Meaning, changes made to the state of this account will be kept when switching forks
-  function makePersistent(address) external;
-
-  function makePersistent(address, address) external;
-
-  function makePersistent(
-    address,
-    address,
-    address
-  ) external;
-
-  function makePersistent(address[] calldata) external;
-
-  // Revokes persistent status from the address, previously added via `makePersistent`
-  function revokePersistent(address) external;
-
-  function revokePersistent(address[] calldata) external;
-
-  // Returns true if the account is marked as persistent
-  function isPersistent(address) external returns (bool);
-
-  // Updates the currently active fork to given block number
-  // This is similar to `roll` but for the currently active fork
-  function rollFork(uint256) external;
-
-  // Updates the given fork to given block number
-  function rollFork(uint256 forkId, uint256 blockNumber) external;
-
-  /// Returns the RPC url for the given alias
-  function rpcUrl(string calldata) external returns (string memory);
-
-  /// Returns all rpc urls and their aliases `[alias, url][]`
-  function rpcUrls() external returns (string[2][] memory);
-
-  function parseJson(string calldata, string calldata) external returns (bytes memory);
-
-  function parseJson(string calldata) external returns (bytes memory);
-}