mud dev-contracts

mud dev-contracts

Start a development server for MUD contracts, and redeploy or modify the World when contracts change.

Using the command

Before you run mud dev-contracts you need to specify the private key of the deploying account. There are several ways to do this:

  • Export an environment variable.

    export PRIVATE_KEY=0x<key goes here>
  • Edit .env to specify the PRIVATE_KEY value.

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

You also need to specify a URL to the blockchain. Again, there are several ways to do this:

These are the command line options you can specify on mud dev-contracts:

OptionMeaningTypeDefault value
--versionShow version numberbooleanfalse
--configPathPath to the config filestringmud.config.ts
--rpc1The RPC URL to usestringEmpty, in which case the command starts anvil (opens in a new tab) for you
--worldAddressDeploy to an existing World at the given addressstringEmpty, deploy new World
--alwaysRunPostDeployRun PostDeploy.s.sol after each deploybooleanfalse (run the script only when deploying a new World)
--helpShow helpbooleanfalse

(1) The hostname localhost may not work. If that is the case, use instead.