https://github.com/0xpolygon/deployer-kit
https://github.com/0xpolygon/deployer-kit
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/0xpolygon/deployer-kit
- Owner: 0xPolygon
- License: apache-2.0
- Created: 2023-11-28T05:13:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-11T12:59:55.000Z (over 2 years ago)
- Last Synced: 2025-08-17T04:33:09.790Z (10 months ago)
- Language: JavaScript
- Size: 35.2 KB
- Stars: 9
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE.md
Awesome Lists containing this project
README
# Deployer Kit
The deployer kit script is a tool to streamline the deployment of contracts between scripts and unit tests. Sharing a single script during testing and production deployment reduces the risk of errors and allows to test the deployment process in advance.
## Requirements
The script utilizes Node.js to run. We recommend the node version defined in the `.nvmrc` file.
## Installation
```bash
forge install 0xPolygon/deployer-kit
```
## Usage Example
The following command will create a deployer contract for the `MyExample` contract from the `src/Example.sol` file in the `test/deployers/MyExampleDeployer.s.sol` file.
```bash
node lib/deployer-kit src/Example.sol -o test/deployers -n MyExample
```
## Flags
| --flag | -flag | Description |
| --------- | ----- | --------------------------------------------------------- |
| --output | -o | Output directory (default: script/deployers) |
| --name | -n | Name of the contract (default: name of the contract file) |
| Options | | |
| --help | -h | Print help |
| --version | -v | Print the version number |
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
---
© 2023 PT Services DMCC