hexoul / vvisp

Command Line Interface for the Upgradeable Smart Contract Framework.

vvisp

Command Line Interface for the upgradeable smart contract framework.

vvisp is a new Command Line Interface tool created to help developers easily develop better DApps by providing an upgradeable smart contract framework as well as new development tools.

Upgradeable Smart Contract helps to easily fix bugs and update business logics for the DApp service. It also provides a high-quality user experience while maintaining the same entry point for users and updating smart contracts atomically.

It helps to develop, upgrade, test, compile and control the user’s current version of the DApp service.

If you want more information about the Upgradeable Smart Contract Framework, you can take a look at the HAECHI-LABS pdf file.

Contributors: Please see the Contributing section of this README.

Table of Contents

• Install
• Usage
• Commands
• Contributing
• Contact
• License

Install

Install Node.js first. Then, install npm and

$ npm install --global @haechi-labs/vvisp

or install yarn and

$ yarn global add @haechi-labs/vvisp

Usage

If you want to see sample repository and demo, see here.

1. Initialize your directory

$ mkdir my-project
$ cd my-project
$ vvisp init

You don't have to do $ npm init or $ truffle init. We supports environment for truffle.

See details for $ vvisp init.

2. Make your Contracts at contracts/

We do not recommend generated contracts by $ vvisp init. Now, you can use abi-to-script, compile and flatten commands.

3. Set .env file

Please set environment variables in .env file. See here for more information about .env. Now you can use deploy-contract command.

4. Set service.vvisp.json file

Please set information about your DApp service in service.vvisp.json. See here for more information about service.vvisp.json. Now you can use deploy-service command.

Please see CONFIGURATION.md to configure your project.

Run $ vvisp --help for more details about functions of vvisp.

Commands

Please see linked documentation below:

• init: Initialize project directory
• compile: Compile solidity contract files
• deploy-contract: Deploy contract
• deploy-service: Deploy service according to Upgradeable Smart Contract Framework
• abi-to-script: Generate javascript APIs interacting with smart contract on blockchain
• flatten: Flatten several contract files in one file

Contributing

Thank you for considering to join this project! We always welcome contributors :)

Notes on project main branches:

• master: Stable, released version
• dev: Work targeting stable release

To contribute, please see CONTRIBUTING.md.

Contact

• General Contact: [email protected]
• Facebook
• Medium

License

MIT