Deploy & Run

The Deploy & Run module is for sending transactions to the current Environment.

For deploying, you need to have a contract compiled. To check that there is a compiled contract, find the CONTRACT select box (which is under the VALUE input field), you can use this module.

If nothing is there, you need to compile a file. If you do not see the contract you want, you need to select a contract in the editor to make it active.

Environment

  • Remix VM (Merge) : Connects to a sandbox blockchain in the browser. The Remix VM (previously called JavaScript VM) is its own “blockchain” and on each reload the old chain will be cleared and a new blockchain will be started. The old one will not be saved. Merge refers to the fork of Ethereum when the Merge occurred. This fork is also known as the Paris fork.

  • Remix VM (London) : Same as above except this chain is using the London fork of Ethereum.

  • Remix VM (Berlin) : Same as above except this chain is using the Berlin fork of Ethereum.

  • Remix VM - Mainnet fork : This will fork the Ethereum mainnet and will load it into the Remix VM. It is useful for developing contracts that need to access deployed mainnet contracts. (See below for more info about Forking)

  • Remix VM - Goerli fork : Same as above except this forks the Goerli testnet. (See below for more info about Forking)

  • Remix VM - Sepolia fork : Same as above except this forks the Sepolia testnet. (See below for more info about Forking)

  • Remix VM - Custom fork : Forks a chain, at block number, and in an EVM version of your choice. (See below for more info about Forking)

  • Injected Provider - provider name: Connects Remix to an injected web3 provider. The most common injected provider is Metamask.

  • Custom - External HTTP Provider: Remix will connect to a remote node. You will need to provide the URL to the selected provider: geth, parity or any Ethereum client. This was previously called Web3 Provider. (See below for more info about External HTTP Provider)

  • Dev - Hardhat Provider: Connects Remix to a local Hardhat test chain.

  • Dev - Ganache Provider: Connects Remix to a local Truffle Ganache test chain.

  • Dev - Foundry Provider: Connects Remix to a local Foundry Anvil test chain.

  • L2 - Optimism Provider: Connects Remix to an Injected Provider (usually Metamask) with the settings for the mainnet of Optimism.

  • L2 - Arbitrum One Provider: Connects Remix to an Injected Provider (usually Metamask) with the settings for the Arbitrum One network.

  • WalletConnect: Connects Remix to a wallet on a mobile device.

Forking chains in Remix

Forking is a great technique for developing a contract that interacts with deployed contracts on a specific chain. By bringing in a chain to the Remix VM, you’ll have the 10 accounts loaded with 100ETH.

Careful though, if you refresh the browser, you’ll lose the forked chain.

Custom Fork

The Custom fork option allows you to specify a chain’s RPC server, a block number, and an EVM version.

You can get the Node URL from chainlist.org. If the chain does not load, you may need to choose a different RPC server. You will also need to choose an EVM version appropriate to the block number. So, if you choose a very low block number, the EVM with the Merge “flavor” won’t work because this version of the EVM came out later.

More about External HTTP Provider

If you are using Geth & https://remix.ethereum.org, please use the following Geth command to allow requests from Remix:

geth --http --http.corsdomain https://remix.ethereum.org

Also see Geth Docs about the http server

To run Remix using https://remix.ethereum.org & a local test node, use this Geth command:

geth --http --http.corsdomain="https://remix.ethereum.org" --http.api web3,eth,debug,personal,net --vmdebug --datadir <path/to/local/folder/for/test/chain> --dev console

If you are using remix-alpha or a local version of remix - replace the url of the –http.corsdomain with the url of Remix that you are using.

To run Remix Desktop & a local test node, use this Geth command:

geth --http --http.corsdomain="package://a7df6d3c223593f3550b35e90d7b0b1f.mod" --http.api web3,eth,debug,personal,net --vmdebug --datadir <path/to/local/folder/for/test/chain> --dev console

Also see Geth Docs on Dev mode

The Web3 Provider Endpoint for a local node is http://localhost:8545


WARNING: Don’t get lazy. It is a bad idea to use the Geth flag –http.corsdomain with a wildcard: --http.corsdomain *

If you put the wildcard *, it means everyone can request the node. Whereas, if you put a URL, it restricts the urls to just that one - e.g. --http.corsdomain 'https://remix-alpha.ethereum.org'

Only use --http.corsdomain * when using a test chain AND using only test accounts. For real accounts or on the mainchain specify the url.


Account:

  • Account: the list of accounts associated with the current environment (and their associated balances). On the Remix VM, you have a choice of 5 accounts. If using Injected Web3 with MetaMask, you need to change the account in MetaMask.

Gas Limit:

  • This sets the maximum amount of gas that will be allowed for all the transactions created in Remix.

Value:

  • This sets the amount of ETH, WEI, GWEI etc that is sent to a contract or a payable function.
    Note: payable functions have a red button.

The Value field is always reset to 0 after each transaction execution.
The Value field is NOT for gas.

Deploy & AtAddress

  • In the image above, the select box is set to Ballot. This select box will contain the list of compiled contracts.

  • Deploy sends a transaction that deploys the selected contract. When the transaction is mined, the newly created instance will be added (this might take several seconds).
    Note: If the contract’s constructor function has parameters, you need to specify them.

  • At Address is used to access a contract that has already been deployed. Because the contract is already deployed, accessing a contract with AtAddress does not cost gas.

Note: When using AtAddress, be sure you trust the contract at that address.

To use AtAddress, you need to have the source code or ABI of the deployed contract in the active tab of the editor. When using the source code, it must be compiled with the same compilation settings as the deployed contract that you are trying to access.

Using the ABI with AtAddress

The ABI is a JSON array which describes the contract’s interface.

To interact with a contract using the ABI, create a new file in Remix with extension *.abi and copy the ABI content to it.

Make sure this file is the active tab in the editor. Then, in the field next to At Address, input the contract’s address and click on At Address. If successful, an instance of the contract will appear below - in the list of Deployed Contracts.

Note: To generate the ABI, in the Solidity compiler, after a contract is compiled, click on the Compilation Details button. A modal will come up with that contains the ABI among other info.

Pending Instances

Validating a transaction takes several seconds. During this time, the GUI shows it in a pending mode. When the transaction is mined, the number of pending transactions is updated and the transaction is added to the log (see terminal).

Using the Recorder

The Recorder is a tool used to save a bunch of transactions in a JSON file and re-run them later either in the same environment or in another.

Saving to the JSON file (by default it’s called scenario.json) allows one to easily check the transaction list, tweak input parameters, change linked library, etc…

There are many use cases for the recorder.

For instance:

  • After having coded and tested contracts in a constrained environment (like the Remix VM), you could then change the environment and redeploy it to a more realistic environment like a public testnet or to a Geth node. By using the generated scenario.json file, you will be using all the same settings that you used in the Remix VM. And this means that you won’t need to click the interface 100 times or whatever to get the state that you achieved originally. So the recorder could be a tool to protect your sanity.

    You can also change the settings in the scenario.json file to customize the playback.

  • Deploying contract does often require more than creating one transaction and so the recorder will automate this deployment.

  • Working in a dev environment often requires setting up the state in the first place.

When checked, the option Run transactions using the last compilation result allows you to develop a contract and easily set the state using the latest compiled versions of the contracts.

scenario.json

To create this file in the recorder, you first of course need to have run some transactions. In the image above - it has a 0 next to Transactions Recorded. So this isn’t the right moment to save transactions because - well because there aren’t any. Each time you make a transaction, that number will increment. Then when you are ready, click the floppy disk icon and the scenario.json file will be created.

The JSON file below is an example of the scenario.json file.

In it, 3 transactions are executed:

The first corresponds to the deployment of the lib testLib.

The second corresponds to the deployment of the contract test with the first parameter of the constructor set to 11. That contract depends on a library. The linkage is done using the property linkReferences. In that case we use the address of the previously created library : created{1512830014773}. The number is the id (timestamp) of the transaction that led to the creation of the library.

The third record corresponds to the call to the function set of the contract test (the property to is set to: created{1512830015080}) . Input parameters are 1 and 0xca35b7d915458ef540ade6068dfe2f44e8fa733c

All these transactions are created using the value of the accounts account{0}.

{
"accounts": {
    "account{0}": "0xca35b7d915458ef540ade6068dfe2f44e8fa733c"
},
"linkReferences": {
    "testLib": "created{1512830014773}"
},
"transactions": [
    {
    "timestamp": 1512830014773,
    "record": {
        "value": "0",
        "parameters": [],
        "abi": "0xbc36789e7a1e281436464229828f817d6612f7b477d66591ff96a9e064bcc98a",
        "contractName": "testLib",
        "bytecode": "60606040523415600e57600080fd5b60968061001c6000396000f300606060405260043610603f576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff1680636d4ce63c146044575b600080fd5b604a6060565b6040518082815260200191505060405180910390f35b6000610d809050905600a165627a7a7230582022d123b15248b8176151f8d45c2dc132063bcc9bb8d5cd652aea7efae362c8050029",
        "linkReferences": {},
        "type": "constructor",
        "from": "account{0}"
    }
    },
    {
    "timestamp": 1512830015080,
    "record": {
        "value": "100",
        "parameters": [
        11
        ],
        "abi": "0xc41589e7559804ea4a2080dad19d876a024ccb05117835447d72ce08c1d020ec",
        "contractName": "test",
        "bytecode": "60606040526040516020806102b183398101604052808051906020019091905050806000819055505061027a806100376000396000f300606060405260043610610062576000357c0100000000000000000000000000000000000000000000000000000000900463ffffffff1680632f30c6f61461006757806338cc48311461009e57806362738998146100f357806387cc10e11461011c575b600080fd5b61009c600480803590602001909190803573ffffffffffffffffffffffffffffffffffffffff16906020019091905050610145565b005b34156100a957600080fd5b6100b1610191565b604051808273ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff16815260200191505060405180910390f35b34156100fe57600080fd5b6101066101bb565b6040518082815260200191505060405180910390f35b341561012757600080fd5b61012f6101c4565b6040518082815260200191505060405180910390f35b8160008190555080600160006101000a81548173ffffffffffffffffffffffffffffffffffffffff021916908373ffffffffffffffffffffffffffffffffffffffff1602179055505050565b6000600160009054906101000a900473ffffffffffffffffffffffffffffffffffffffff16905090565b60008054905090565b600073__browser/ballot.sol:testLib____________636d4ce63c6000604051602001526040518163ffffffff167c010000000000000000000000000000000000000000000000000000000002815260040160206040518083038186803b151561022e57600080fd5b6102c65a03f4151561023f57600080fd5b505050604051805190509050905600a165627a7a72305820e0b2510bb2890a0334bfe5613d96db3e72442e63b514cdeaee8fc2c6bbd19d3a0029",
        "linkReferences": {
        "browser/ballot.sol": {
            "testLib": [
            {
                "length": 20,
                "start": 511
            }
            ]
        }
        },
        "name": "",
        "type": "constructor",
        "from": "account{0}"
    }
    },
    {
    "timestamp": 1512830034180,
    "record": {
        "value": "1000000000000000000",
        "parameters": [
        1,
        "0xca35b7d915458ef540ade6068dfe2f44e8fa733c"
        ],
        "to": "created{1512830015080}",
        "abi": "0xc41589e7559804ea4a2080dad19d876a024ccb05117835447d72ce08c1d020ec",
        "name": "set",
        "type": "function",
        "from": "account{0}"
    }
    }
],
"abis": {
    "0xbc36789e7a1e281436464229828f817d6612f7b477d66591ff96a9e064bcc98a": [
    {
        "constant": true,
        "inputs": [],
        "name": "get",
        "outputs": [
        {
            "name": "",
            "type": "uint256"
        }
        ],
        "payable": false,
        "stateMutability": "view",
        "type": "function"
    }
    ],
    "0xc41589e7559804ea4a2080dad19d876a024ccb05117835447d72ce08c1d020ec": [
    {
        "constant": true,
        "inputs": [],
        "name": "getInt",
        "outputs": [
        {
            "name": "",
            "type": "uint256"
        }
        ],
        "payable": false,
        "stateMutability": "view",
        "type": "function"
    },
    {
        "constant": true,
        "inputs": [],
        "name": "getFromLib",
        "outputs": [
        {
            "name": "",
            "type": "uint256"
        }
        ],
        "payable": false,
        "stateMutability": "view",
        "type": "function"
    },
    {
        "constant": true,
        "inputs": [],
        "name": "getAddress",
        "outputs": [
        {
            "name": "",
            "type": "address"
        }
        ],
        "payable": false,
        "stateMutability": "view",
        "type": "function"
    },
    {
        "constant": false,
        "inputs": [
        {
            "name": "_t",
            "type": "uint256"
        },
        {
            "name": "_add",
            "type": "address"
        }
        ],
        "name": "set",
        "outputs": [],
        "payable": true,
        "stateMutability": "payable",
        "type": "function"
    },
    {
        "inputs": [
        {
            "name": "_r",
            "type": "uint256"
        }
        ],
        "payable": true,
        "stateMutability": "payable",
        "type": "constructor"
    }
    ]
}
}