xdeployer

# xdeployer 💥

[![Test xdeploy](https://github.com/pcaversaccio/xdeployer/actions/workflows/test.yml/badge.svg)](https://github.com/pcaversaccio/xdeployer/actions/workflows/test.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit)
[![npm package](https://img.shields.io/npm/v/xdeployer.svg)](https://www.npmjs.com/package/xdeployer)

[Hardhat](https://hardhat.org) plugin to deploy your smart contracts across multiple Ethereum Virtual Machine (EVM) chains with the same deterministic address.

> [!TIP]
> It is pronounced _cross_-deployer.

> [!IMPORTANT]
> This plugin currently targets Hardhat 2 and is not compatible with Hardhat 3.

## What

This plugin will help you make easier and safer usage of the [`CREATE2`](https://eips.ethereum.org/EIPS/eip-1014) EVM opcode. [`CREATE2`](https://eips.ethereum.org/EIPS/eip-1014) 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`:

```console
# based on ethers v6
npm install --save-dev xdeployer
```

With `npm` version `6`:

```console
# based on ethers v6
npm install --save-dev xdeployer '@nomicfoundation/hardhat-ethers@^3.1.3' ethers
```

<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>

With `npm` versions `>=7`:

```console
# based on ethers v5
npm install --save-dev 'xdeployer@^1.2.7'
```

With `npm` version `6`:

```console
# 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](https://classic.yarnpkg.com):

```console
# based on ethers v6
yarn add --dev xdeployer '@nomicfoundation/hardhat-ethers@^3.1.3' ethers
```

<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>

```console
# 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](https://pnpm.io), invoke:

```console
# based on ethers v6
pnpm add --save-dev xdeployer
```

<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>

```console
# based on ethers v5
pnpm add --save-dev 'xdeployer@^1.2.7'
```

</details>

If you are a [Bun](https://bun.sh) user, run:

```console
# based on ethers v6
bun add --dev xdeployer
```

<details>
<summary> Using <code>ethers</code> version <code>5</code> </summary>

```console
# based on ethers v5
bun add --dev 'xdeployer@^1.2.7'
```

</details>

> [!NOTE]
> This plugin uses the optional chaining operator (`?.`). Optional chaining is _not_ supported in [Node.js](https://nodejs.org/en) `v13` and below.

Import the plugin in your `hardhat.config.js`:

```js
require("xdeployer");
```

Or if you are using TypeScript, in your `hardhat.config.ts`:

```ts
import "xdeployer";
```

## Re