@haechi-labs/vvisp
v2.1.1
Published
The easiest smart contract development framework and command line interface on EVM based blockchain
Downloads
25
Readme
vvisp
The easiest smart contract development framework and command line interface on EVM based blockchain.
Simple and fast smart contract deployment and execution with a single command line
Key Benefits
- Improving Environment of Blockchain Service Development
- Reducing Operation Time of Blockchain Service Development
- Shortening the Learning Curve of Developers Who Are Not Familiar with Blockchain
Table of Contents
Description
CLI tool easy to use for developers who are not familiar with blockchain.
: Smart contracts in the blockchain are uncommon development areas.
There are many things that developers are unfamiliar with DApp development.
Even if you create a contract by referring to several references, there is an entry barrier to learn how to deploy and how to use smart contracts.
vvisp
is a command line interface (CLI) tool designed to reduce the learning curve.
(1) Deploying a contract with a single line of command
: Deploying smart contracts to a blockchain is very complex.
In order to deploy a contract, you must write your smart contract deployment codes as well as create smart contracts.
A developer needs to consider deploying multiple smart contracts in order for DApp.
vvisp
defines deployment target as a simple configuration file and then deploys smart contracts by considering the dependencies automatically with a single line of command instead of hundreds lines of code.
(2) Executing the contract function with one command line
: Developers had to study the library, call the function, and manually write the function call code to execute the function of a contract.
This is a big entry barrier for developers who are unfamiliar with smart contract development.
However, vvisp
is designed to execute a specific function of a contract with a single command line and to receive results without complex processes.
| Contributors: Please see the Contributing section of this README. | | --- |
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, see here.
1. Start your project
$ vvisp init my-project
$ cd my-project
$ npm install #or yarn install
You don't have to do $ npm init
or $ truffle init
.
We supports environment for truffle and it will make package.json
automatically.
See details for $ vvisp init
.
2. Make your Contracts at contracts/
Now, you can use gen-script
, compile
and flatten
commands.
3. Set vvisp-config.js
file
Please set environment variables in vvisp-config.js
file.
See here for more information about vvisp-config.js
.
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: Start your project
- compile: Compile solidity contract files
- deploy-contract: Deploy contract
- deploy-service: Deploy service of your contracts
- gen-script: Generate javascript APIs interacting with smart contract on blockchain
- console: Provides a console environment that can invoke contracts interactively.
- 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 versiondev
: Work targeting stable release
To contribute, please see CONTRIBUTING.md.
Contact
- General Contact: [email protected]
- Medium
License
MIT