solidity-deploy is an npm module which allows someone to create custom contract deployment scripts, including an abstracted compiler and flattener. Ideally, it also allows for smart contracts to be verified on Etherscan smoothly (still buggy).
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Luiserebii f3a223a1da
Adding LICENSE badge
2 months ago
compile Fixing some mistakes/errors found by LGTM; wow, this is a nice app 3 months ago
config Successfully moved num of confirmations into options! 5 months ago
deploy More fixes, such as unused variables and non-explicit semicolons; I love this thing 3 months ago
docs Updating documentation 5 months ago
flatten More fixes, such as unused variables and non-explicit semicolons; I love this thing 3 months ago
logging Fixing some mistakes/errors found by LGTM; wow, this is a nice app 3 months ago
meta Re-configured to add README.md to homepage of generated documentation, and added link to Documentation in README.md 6 months ago
styling Documented PrettyPrint 6 months ago
test/truffle-env-1 Bump lodash from 4.17.11 to 4.17.14 in /test/truffle-env-1 4 months ago
verify Removing unused imports 3 months ago
.gitattributes Comitting .gitattributes along with package.json 7 months ago
.gitignore Quick, but important edit to gitignore 6 months ago
.npmignore Added a few important additions to npmignore to protect config data 6 months ago
LICENSE Added MIT LICENSE 7 months ago
README.md Adding LICENSE badge 2 months ago
index.js More fixes, such as unused variables and non-explicit semicolons; I love this thing 3 months ago
package-lock.json Bump lodash from 4.17.11 to 4.17.14 4 months ago
package.json Bumping version up after changes 3 months ago

README.md

solidity-deploy

npm version GitHub Total alerts

solidity-deploy is an npm module which allows someone to create custom contract deployment scripts, including an abstracted compiler and flattener. Ideally, it also allows for smart contracts to be verified on Etherscan smoothly (still buggy).

Sample run of a script using solidity-deploy. Full video

Description

Currently structured as a node module, with tests passing; however, there are a number of changes this project will go through, including but not limited to:

  • Addition of proper Mocha tests (tests at this point are limited to a .sh script and mini-node script which runs deployments and flattening, respectively.)
  • API documentation

At the moment, the module is currently reliant on truffle-flattener for flattening; however, in the future, this will be phased out for a more general flattener, or at least give the user some choice on which flattener to use.

Verification is still very buggy, needs success cases of verification via Etherscan’s Contract API. The class holding Etherscan verification (verify/etherscan-verify.js) may not be up to date with a few things on the rest of repository (may work in a vacuum, but not optimized for the module as a whole)

The general entry point of this module offers both initialization of a SolidityDeploy object, or access to any of the other classes directly. The advantage of using a SolidityDeploy object is avoiding repetition in passing options/config; the object supplies functions with the create prefix which handles this minimized

Documentation

Documentation is currently hosted on GitHub Pages at: https://luiserebii.github.io/solidity-deploy/

Mirror

A mirror of this repository is available at: https://serebii.io:2501/Luiserebii/solidity-deploy

Credits

Thanks to those generous developers who entertained my questions, and helped me understand npm module design better!