worm-deployer v0.0.4

!WARNING
This is a proof of concept developed for the Wormhole Hackathon. This is a project driven by personal interest and is currently in an experimental stage (Although people are using it). Mainnet deployment is still under active development.

Features

• Single-transaction Multi-chain Deployment: Deploy to multiple chains from a single source transaction.
• Deterministic Addressing via CREATE2: Same contract address across all target chains.
• Source Chain Gas Payment: Pay gas only on the source chain.
• Flexible Chain Selection: Support for various source and destination chain combinations. (supported chains)

Supported Frameworks

• Hardhat
• Foundry

Supported Chains (Testnet only)

• Ethereum Sepolia 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9
• Base Sepolia 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9
• Optimism Sepolia 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9
• Arbitrum Sepolia 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9
• Celo Alfajores 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9
• Avalanche Fuji 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9
• Binance Smart Chain Testnet 0xB6C636Fc86B4d008faEE98C0c7c493D41fa483e9

Getting Started

!IMPORTANT
Need to install node v21.1.0 on your system (steps here using nvm).

Remote usage (as npx command)

npx worm-deployer@latest

Then follow the prompts to deploy the contracts.

Local usage (as local command)

1. Clone the repository:

git clone https://github.com/startup-dreamer/worm-deployer.git

2. Install dependencies:

cd worm-deployer
npm install

3. Link the package:

npm link

4. Run the command:

worm-deployer

5. Then follow the prompts to deploy the contracts.

Demo Deployment

Test deployment contract: https://wormholescan.io/#/tx/0xb4032d06e1a5f87429ee7628543984d1d3fa9623ad0b137571c7cb42e5463d38

Worm-Deployer Architecture

Contract Architecture

User Flow

Wormhole Tech Used

• Standard Relaying for EVM chains message passing through Wormhole protocol.
• Wormhole Solidity SDK to connect wormdeployer contract with relayer interface.
• Wormhole Base SDK to get the wormhole specific chain parameters for configuring the deployment.

Worm-Deployer Development

• Implemented as an NPX package compatible with both Hardhat and Foundry projects.

Workflow:

• User runs the worm-deployer package in their project directory.
• Selects the contract to deploy.
• worm-deployer compiles the contract using appropriate build tools.
• Extracts bytecode from contract artifacts.
• User provides custom salt for deterministic address generation.
• Calls deployAcrossChains function on source chain's WormholeDeployer contract.
• Wormhole relayer sends transaction to destination chains.
• receiveWormholeMessages function deploys the contract on destination chains using CREATE2 opcode.

Future Work

Pre-Mainnet Launch

1. Mainnet readiness
2. Multi-chain support expansion
3. Batch deployments
   • Deploy multiple contracts in a single transaction
   • Optimize gas fees and simplify complex deployments
4. Automatic contract verification
   • Integrate with block explorers across supported chains

Post-Mainnet Launch

1. Cross-chain contract interaction

   • Allow initialization and configuration of newly deployed contracts
   • Support interaction with deployed contracts on other chains

2. Upgrade Mechanism

   • Contract upgradeability across multiple chains, Using proxy patterns.

3. Specialized relayer integration

Contact

Twitter - @Krieger
Mail - prsumit35@gmail.com

Contribution

Contributions are more than welcome! Please open an issue for any bugs or feature requests and maybe submit a PR as well.

Acknowledgment

Thanks to Encode Club for making the Wormhole Hackathon possible, and to the Wormhole Foundation for providing the innovative and user-friendly framework for cross-chain messaging that inspired me to create Worm-Deployer. I would greatly appreciate any feedback or guidance from the judges.

References

• Wormhole Docs: Docs
• Foundry Create2 Tutorial: Tutorial
• OpenZeppelin Create2 Library: Library
• Wormhole Architecture: Architecture
• Wormhole SDK: SDK
• Wormhole Solidity SDK: Solidity SDK