Awesome
xdeployer 💥
Hardhat plugin to deploy your smart contracts across multiple Ethereum Virtual Machine (EVM) chains with the same deterministic address.
[!TIP] It is pronounced cross-deployer.
What
This plugin will help you make easier and safer usage of the CREATE2
EVM opcode. CREATE2
can be used to compute in advance the address where a smart contract will be deployed, which allows for interesting new mechanisms known as counterfactual interactions.
Installation
With npm
versions >=7
:
# based on ethers v6
npm install --save-dev xdeployer
With npm
version 6
:
# based on ethers v6
npm install --save-dev xdeployer @nomicfoundation/hardhat-ethers ethers
<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>
With npm
versions >=7
:
# based on ethers v5
npm install --save-dev 'xdeployer@^1.2.7'
With npm
version 6
:
# based on ethers v5
npm install --save-dev 'xdeployer@^1.2.7' @nomiclabs/hardhat-ethers 'ethers@^5.7.2' '@openzeppelin/contracts@^4.9.0'
</details>
Or if you are using Yarn:
# based on ethers v6
yarn add --dev xdeployer @nomicfoundation/hardhat-ethers ethers
<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>
# based on ethers v5
yarn add --dev 'xdeployer@^1.2.7' @nomiclabs/hardhat-ethers 'ethers@^5.7.2' '@openzeppelin/contracts@^4.9.0'
</details>
In case you are using pnpm, invoke:
# based on ethers v6
pnpm add --save-dev xdeployer
<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>
# based on ethers v5
pnpm add --save-dev 'xdeployer@^1.2.7'
</details>
[!NOTE] This plugin uses the optional chaining operator (
?.
). Optional chaining is not supported in Node.jsv13
and below.
Import the plugin in your hardhat.config.js
:
require("xdeployer");
Or if you are using TypeScript, in your hardhat.config.ts
:
import "xdeployer";
Required Plugins
Tasks
This plugin provides the xdeploy
task, which allows you to deploy your smart contracts across multiple EVM chains with the same deterministic address:
npx hardhat xdeploy
Environment Extensions
This plugin does not extend the environment.
Configuration
You need to add the following configurations to your hardhat.config.js
file:
module.exports = {
networks: {
mainnet: { ... }
},
xdeploy: {
contract: "YOUR_CONTRACT_NAME_TO_BE_DEPLOYED",
constructorArgsPath: "PATH_TO_CONSTRUCTOR_ARGS", // optional; default value is `undefined`
salt: "YOUR_SALT_MESSAGE",
signer: "SIGNER_PRIVATE_KEY",
networks: ["LIST_OF_NETWORKS"],
rpcUrls: ["LIST_OF_RPCURLS"],
gasLimit: 1_500_000, // optional; default value is `1.5e6`
},
};
Or if you are using TypeScript, in your hardhat.config.ts
:
const config: HardhatUserConfig = {
networks: {
mainnet: { ... }
},
xdeploy: {
contract: "YOUR_CONTRACT_NAME_TO_BE_DEPLOYED",
constructorArgsPath: "PATH_TO_CONSTRUCTOR_ARGS", // optional; default value is `undefined`
salt: "YOUR_SALT_MESSAGE",
signer: "SIGNER_PRIVATE_KEY",
networks: ["LIST_OF_NETWORKS"],
rpcUrls: ["LIST_OF_RPCURLS"],
gasLimit: 1_500_000, // optional; default value is `1.5e6`
},
};
The parameters constructorArgsPath
and gasLimit
are optional. The salt
parameter is a random string value used to create the contract address. If you have previously deployed the same contract with the identical salt
, the contract creation transaction will fail due to EIP-684. For more details, see also here.
[!IMPORTANT] Please note that
xdeployer
computes the UTF-8 byte representation of the specifiedsalt
and calculates thekeccak256
hash, which represents the 32-bytesalt
value that is passed toCREATE2
.
Example:
xdeploy: {
contract: "ERC20Mock",
constructorArgsPath: "./deploy-args.ts",
salt: "WAGMI",
signer: vars.get("PRIVATE_KEY", ""),
networks: ["hardhat", "sepolia", "holesky"],
rpcUrls: [
"hardhat",
vars.get("ETH_SEPOLIA_TESTNET_URL", "https://rpc.sepolia.org"),
vars.get("ETH_HOLESKY_TESTNET_URL", "https://holesky.rpc.thirdweb.com"),
],
gasLimit: 1.2 * 10 ** 6,
},
[!NOTE] We recommend using Hardhat configuration variables introduced in Hardhat version
2.19.0
to set the private key of your signer.
The current available networks are:
[!TIP] To display the complete list of supported networks with the corresponding block explorer links and chain IDs, run
npx hardhat xdeploy --list-networks
.
- Local:
localhost
hardhat
- EVM-Based Test Networks:
sepolia
holesky
bscTestnet
optimismSepolia
arbitrumSepolia
amoy
polygonZkEVMTestnet
fantomTestnet
fuji
chiado
moonbaseAlpha
alfajores
auroraTestnet
harmonyTestnet
spark
cronosTestnet
evmosTestnet
bobaTestnet
cantoTestnet
baseSepolia
mantleTestnet
filecoinTestnet
scrollSepolia
lineaTestnet
zoraSepolia
luksoTestnet
mantaTestnet
blastTestnet
dosTestnet
fraxtalTestnet
metisTestnet
modeTestnet
seiArcticTestnet
xlayerTestnet
bobTestnet
coreTestnet
telosTestnet
rootstockTestnet
chilizTestnet
taraxaTestnet
taikoTestnet
zetaChainTestnet
5ireChainTestnet
sapphireTestnet
worldChainTestnet
plumeTestnet
unichainTestnet
xdcTestnet
sxTestnet
liskTestnet
metalL2Testnet
superseedTestnet
- EVM-Based Production Networks:
ethMain
bscMain
optimismMain
arbitrumOne
arbitrumNova
polygon
polygonZkEVMMain
fantomMain
avalanche
gnosis
moonriver
moonbeam
celo
auroraMain
harmonyMain
fuse
cronosMain
evmosMain
bobaMain
cantoMain
baseMain
mantleMain
filecoinMain
scrollMain
lineaMain
zoraMain
luksoMain
mantaMain
blastMain
dosMain
fraxtalMain
enduranceMain
kavaMain
metisMain
modeMain
xlayerMain
bobMain
coreMain
telosMain
rootstockMain
chilizMain
taraxaMain
gravityAlphaMain
taikoMain
zetaChainMain
5ireChainMain
sapphireMain
worldChainMain
xdcMain
sxMain
liskMain
metalL2Main
[!IMPORTANT] Note that you must ensure that your deployment account has sufficient funds on all target networks.
Local Deployment
If you also want to test deploy your smart contracts on "hardhat"
or "localhost"
, you must first add the following Solidity file called Create2DeployerLocal.sol
to your contracts/
folder:
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.23;
import { CreateX } from "xdeployer/src/contracts/CreateX.sol";
contract Create2DeployerLocal is CreateX {}
For this kind of deployment, you must set the Solidity version in the
hardhat.config.js
orhardhat.config.ts
file to0.8.23
or higher.
The RPC URL for hardhat
is simply hardhat
, while for localhost
you must first run npx hardhat node
, which defaults to http://127.0.0.1:8545
. It is important to note that the local deployment does not generate the same deterministic address as on all live test/production networks, since the address of the smart contract that calls the opcode CREATE2
differs locally from the live test/production networks. I recommend using local deployments for general testing, for example to understand the correct gasLimit
target size.
Further Considerations
The constructor arguments file must have an exportable field called data
in case you are using TypeScript:
const data = [
"arg1",
"arg2",
...
];
export { data };
BigInt literals (e.g.
100_000_000_000_000_000_000n
) can be used for the constructor arguments if you settarget: ES2020
or higher in yourtsconfig.json
file. See also here for an example.
If you are using common JavaScript:
module.exports = [
"arg1",
"arg2",
...
];
The gasLimit
field is set to 1'500'000 by default because the CREATE2
operations are a complex sequence of opcode executions. Usually the providers do not manage to estimate the gasLimit
for these calls, so a predefined value is set.
The contract creation transaction is displayed on Etherscan (or any other block explorer) as a so-called internal transaction. An internal transaction is an action that is occurring within, or between, one or multiple smart contracts. In other words, it is initiated inside the code itself, rather than externally, from a wallet address controlled by a human. For more details on why it works this way, see here.
[!WARNING] Solidity version
0.8.20
introduced support for the new opcodePUSH0
, which was added as part of the Shanghai hard fork. Prior to running a deployment with a>=0.8.20
-compiled bytecode (using the EVM versionshanghai
), please verify that all targeted EVM networks support thePUSH0
opcode. Otherwise, a deployment attempt on an EVM chain withoutPUSH0
support may result in deployment or runtime failure(s).
[!WARNING] Solidity version
0.8.25
defaults to EVM versioncancun
, which features a number of new opcodes. Prior to running a deployment with a>=0.8.25
-compiled bytecode (using the EVM versioncancun
), please verify that all targeted EVM networks support the newcancun
opcodes. Otherwise, a deployment attempt on an EVM chain withoutcancun
support may result in deployment or runtime failure(s).
Usage
npx hardhat xdeploy
Usage With Truffle
Truffle suite users can leverage the Hardhat plugin hardhat-truffle5
(or if you use Truffle v4
hardhat-truffle4
) to integrate with TruffleContract
from Truffle v5
. This plugin allows tests and scripts written for Truffle to work with Hardhat.
How It Works
EVM opcodes can only be called via a smart contract. I have deployed a helper smart contract CreateX
with the same address across all the available networks to make easier and safer usage of the CREATE2
EVM opcode. During your deployment, the plugin will call this contract.
A Note on SELFDESTRUCT
Using the CREATE2
EVM opcode always allows to redeploy a new smart contract to a previously selfdestructed contract address. However, if a contract creation is attempted, due to either a creation transaction or the CREATE
/CREATE2
EVM opcode, and the destination address already has either nonzero nonce, or non-empty code, then the creation throws immediately, with exactly the same behavior as would arise if the first byte in the init code were an invalid opcode. This applies retroactively starting from genesis.
A Note on the Contract Creation Transaction
It is important to note that the msg.sender
of the contract creation transaction is the helper smart contract CreateX
with address 0xba5Ed099633D3B313e4D5F7bdc1305d3c28ba5Ed
. If you are relying on common smart contract libraries such as OpenZeppelin Contracts1 for your smart contract, which set certain constructor arguments to msg.sender
(e.g. owner
), you will need to change these arguments to tx.origin
so that they are set to your deployer's EOA address. For another workaround, see here.
[!CAUTION] Please familiarise yourself with the security considerations concerning
tx.origin
. You can find more information about it, e.g. here.
Donation
I am a strong advocate of the open-source and free software paradigm. However, if you feel my work deserves a donation, you can send it to this address: 0x07bF3CDA34aA78d92949bbDce31520714AB5b228
. I can pledge that I will use this money to help fix more existing challenges in the Ethereum ecosystem 🤝.
Footnotes
-
Please note that OpenZeppelin Contracts version
5.0.0
has made the initialowner
explicit (see PR #4267). ↩