# @vitriollabs/immutable-deployment-factory > Deterministic omni-chain smart contract deployments Latest version **0.1.1** (published 2024-01-24) · MIT license · 0 weekly downloads ## Install ```sh npm install @vitriollabs/immutable-deployment-factory pnpm add @vitriollabs/immutable-deployment-factory yarn add @vitriollabs/immutable-deployment-factory bun add @vitriollabs/immutable-deployment-factory ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.1 | | Published | 2024-01-24 | | First published | 2024-01-21 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 1 | | Unpacked size | 39.8 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Cameron White | | Maintainers | vitriollabs, slvrfn | | Keywords | solidity, sol, ethereum, eth, create2, create3, deployment | ## Links - npm: https://www.npmjs.com/package/@vitriollabs/immutable-deployment-factory - Repository: https://github.com/VitriolLabs/immutable-deployment-factory - Homepage: https://github.com/VitriolLabs/immutable-deployment-factory#readme - Issues: https://github.com/VitriolLabs/immutable-deployment-factory/issues - npm.io page: https://npm.io/package/@vitriollabs/immutable-deployment-factory ## Dependencies (1) - [solady](https://npm.io/package/solady.md) ^0.0.161 ## Alternatives - [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads - [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads - [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads - [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads - [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads ## Recent versions - 0.1.1 (latest) — 2024-01-24 - 0.1.0 — 2024-01-21 ## README

ImmutableDeploymentFactory

..deterministic omni-chain smart contract deployments


The ImmutableDeploymentFactory can be used to deterministically deploy immutable smart contracts on any EVM-compatible chain to the same address using both create2 and create3 deployment functions.

Contracts deployed with this factory are immutable, and cannot be overwritten. Salts used for deployment can optionally include the caller's address to prevent front-running.

npm version
*** ## Usage: The following functions are available to based on hash and deployment method (create2/3) - `findCreate[#]Address` - find contract deployment address based on salt - `safeCreate[#]Address` - perform contract deployment based on salt ```solidity function safeCreate2(bytes32 salt, bytes calldata initializationCode) returns (address deploymentAddress); function findCreate2Address(bytes32 salt, bytes calldata initCode) returns (address deploymentAddress); function findCreate2AddressViaHash(bytes32 salt, bytes32 initCodeHash) returns (address deploymentAddress); function safeCreate3(bytes32 salt, bytes calldata initializationCode) returns (address deploymentAddress); function findCreate3Address(bytes32 salt) returns (address deploymentAddress); ``` > Note: create2 deployment addresses are influenced by the deploying contract's bytecode
When providing a salt during the deployment process, you have the **option** to prevent front-running of your deployment. This is accomplished by including the caller's address in the first 20 bytes of the salt. If you do not care to prevent front-running, the first 20 bytes of the salt must all be zeros. ## Deployment: The `ImmutableDeploymentFactory` has been deployed to `0x0000086e1910D5977302116fC27934DC0254266C` on the following networks: - Ethereum - [Mainnet](https://etherscan.io/address/0x0000086e1910d5977302116fc27934dc0254266c) - [Goerli Testnet](https://goerli.etherscan.io/address/0x0000086e1910d5977302116fc27934dc0254266c) - [Sepolia Testnet](https://sepolia.etherscan.io/address/0x0000086e1910d5977302116fc27934dc0254266c) - Optimism - [Sepolia Testnet](https://sepolia-optimism.etherscan.io/address/0x0000086e1910D5977302116fC27934DC0254266C) - BSC - [Testnet](https://testnet.bscscan.com/address/0x0000086e1910d5977302116fc27934dc0254266c) The `ImmutableDeploymentFactory` was initially deployed using [Nick's method](https://yamenmerhi.medium.com/nicks-method-ethereum-keyless-execution-168a6659479c) for keyless contract deployments. You can deploy a copy of the factory to any EVM compatible chain by: 1. Funding the deployment address `0x0D6470aED3287d05dF6cE19Ba4fab50852a49b5e` with `0.07` chain-currency (possibly with additional chain fees ex: L1 fees on Optimism) 2. Broadcast `signedTx` from [keylessDeployment.json](https://github.com/VitriolLabs/immutable-deployment-factory/blob/main/deployment/keylessDeployment.json) when gas is less than 100 gwei. You **MUST** fund the account prior to broadcasting the transaction. Some web3 providers filter out Type-0 transactions (Ethereum legacy transactions), which are used here for omni-chain deployment. We had success using the [Alchemy Sandbox](https://dashboard.alchemy.com/sandbox) to broadcast the deployment transactions. ## Authors / Mentions This repo was created by [Cameron White (Slvrfn)](https://ca.meron.dev) of [Vitriol Labs](https://vitriol.sh), but would not have been possible without the contributions of: - [0age (ImmutableCreate2Factory)](https://github.com/0age/metamorphic/blob/master/contracts/ImmutableCreate2Factory.sol) - [Vectorized (CREATE3)](https://github.com/Vectorized/solady). ## Contributing Contributions are welcome, please review [CONTRIBUTIONS](https://github.com/VitriolLabs/immutable-deployment-factory/blob/main/CONTRIBUTING.md) for more details. ## License The files contained therein are licensed under The MIT License (MIT). See the [LICENSE](https://github.com/VitriolLabs/immutable-deployment-factory/blob/main/LICENSE.md) file for more details. ## Disclaimer Please review the [DISCLAIMER](https://github.com/VitriolLabs/immutable-deployment-factory/blob/main/DISCLAIMER.md) for more details. *** ## Donations (beermoney): - Eth: [vitriollabs.eth](https://etherscan.io/address/0xFe9fe85c7E894917B5a42656548a9D143f96f12E) or `0xFe9fe85c7E894917B5a42656548a9D143f96f12E` on any EVM chain. - Btc: bc1qwf9xndxfwhfuul93seaq603xkgr64cwkc4d4dd --- _Source: https://npm.io/package/@vitriollabs/immutable-deployment-factory · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._