etherlime

What is etherlime?

etherlime is an ethereum development and deployment framework based on ethers.js.

This framework provides alternative to the other web3.js based frameworks and allows for ultimate control by the developer. It also adds much needed verboseness in the deployment process so that you can be aware of what is really going on (as opposed to the general shooting in the dark technique).

This framework was born out of necessity, hardships and trouble in the development and deployment of ethereum smart contracts. We are trying to ease the pain of deployment, compilation and unit testing and add much needed stability to the process. In our mind ethers is much more stable alternative than web3.js for the moment therefore this framework is born.

Etherlime can be used as library and/or command line tool. The command line tools give you great boosts but you can skip them fully and use plain old node.js including the etherlime library.

Milestones

• [Ready] Being able to deploy compiled contracts on local and infura nodes <—- Done
• [Ready] Being able to compile contracts to the desired formats for deployment <—- Done
• [Ready] Being able to run unit tests on the compiled contracts <—- Done
• [Ready] Being able to run unit tests with code coverage <—- Done
• [Ready] Being able to debug transactions <—- Done
• [Not Ready] Being able to verify contracts <—- Next

Community

Join our community group

Developer Documentation

• Quick Start
  • Installing
  • Running embedded ganache-cli
  • Deploying with etherlime
    • Initialize etherlime
    • Deployer Example
    • Verifying Smart Contract Example
    • Deploying
    • History of your deploys
• Etherlime Library API
  • Deployer
    • Deployer functionality
    • Deployers
  • Deployed Contract Wrapper
    • Wrappers
    • Working with previously deployed contracts
• Etherlime CLI
  • Installing & Help
    • Syntax
    • Help
    • Version
  • etherlime init
    • Syntax
  • etherlime ganache
    • Syntax
  • etherlime compile
    • Syntax
  • etherlime deploy
    • Syntax
  • etherlime history
    • Syntax
  • etherlime test
    • Syntax
    • Global Objects
    • Available Utils
    • Examples
  • etherlime coverage
    • Syntax
  • etherlime debug
    • Syntax
    • Available Commands
  • etherlime shape
    • Syntax
    • References:
  • etherlime flatten
    • Syntax
  • etherlime ide
    • Syntax
  • etherlime zk
    • Circuit Compilation
    • Establish Trusted Setup
    • Generate ZK Proof
    • Verify Proof (Off-chain)
    • Generate Smart Contract for On-Chain Verification
    • Generate output call based for On-chanin Verification
• Migration from Truffle to Etherlime
  • Install & Initialize Etherlime
  • Write new scripts for deployment using the template provided
  • Modify tests
    • Flexibility
    • Assertions and available utils
  • Final steps:

---

License

Completely MIT Licensed. Including ALL dependencies.