# Commands Korean version: [README-ko.md](./README-ko.md) - [init](#init): Initialize project directory - [compile](#compile): Compile solidity contract files - [deploy-contract](#deploy-contract): Deploy contract - [deploy-service](#deploy-service): Deploy service - [gen-script](#gen-script): Generate javascript APIs interacting with smart contract on blockchain - [console](#console): Provides a console environment that can invoke contracts interactively. - [flatten](#flatten): Flatten several contract files in one file ## init > vvisp init [name] [options] Start the project through this command. If you specify directory name in [name], `name` directory will be generated and vvisp will initialize at there. #### Options `-s, --silent` : do not print logs. `--klaytn`: initialize for klaytn platform. #### Examples ```bash $ vvisp init ``` #### Outputs ``` root/ ├── contracts/ ├──── Migrations.sol ├── migrations/ ├──── 1_initial_migration.js ├── scripts/ ├──── test.sh ├──── coverage.sh ├──── local_eth_ganache_option.js ├── test/ ├──── Example.test.js ├── .babelrc ├── .gitattributes ├── .gitignore ├── .solcover.js ├── .soliumignore ├── .soliumrc.json ├── package.json ├── service.vvisp.json ├── truffle-config.json └── vvisp-config.json ``` > - `package.json` will be generated. Several libraries used by HAECHI LABS have been added. > - The `contracts` folder will be generated. Contract code, please work here. > - The `contracts/Migrations.sol` file will be generated. This Contract is necessary for using truffle. > - The `vvisp-config.js` file will be generated. Set environment variables here. [See details](../../../CONFIGURATION.md#config). > - `.soliumignore`,` .solcover.js`, and `.soliumrc.json` files for [solium](https://github.com/duaraghav8/Solium), a proofing tool for solidity, will be generated. > - `scripts/test.sh` will be generated and the` $ npm run test` script will be added to `package.json`. This is useful for truffle contract testing. > - `scripts/coverage.sh` will be generated and the` $ npm run coverage` script will be added to `package.json`. This shows the coverage of test codes about your contracts. > - `scripts/local_eth_ganache_option.js` will be generated. This file is necessary for running `npm run test`. > - `truffle-config.js` will be generated. Required when using truffle and contains relevant configuration information. > - `migrations/1_initial_migration.js` will be generated. Required for truffle testing. > - `test` folder will be generated. Please build test code for truffle test at here. > - For information about truffle, see [truffle documentation](https://truffleframework.com/docs/truffle/overview). > - You can use [openzeppelin-test-helpers](https://github.com/OpenZeppelin/openzeppelin-test-helpers) to help you to build test cases. > - A sample test file, `Example.test.js` will be generated in `test/` directory. > - The `service.vvisp.json` file will be generated. Before you run `$ vvisp deploy-service`, set the variables in this file. [See details](../../../CONFIGURATION.md#service). ## compile > vvisp compile [files...] [options] Compile solidity source code. #### Options `-s, --silent` : do not print logs. #### Examples ```bash $ vvisp compile contracts/A.sol contracts/B.sol ``` #### Outputs (Created at `build` folder) ``` build/contracts/ ├── A.json └── B.json ``` > If no file name is entered, all solidity files in the `contracts` folder are compiled. ## deploy-contract > vvisp deploy-contract [arguments...] [options] Deploy the target contract. #### Options `-s, --silent` : do not print logs. `-n, --network `: specify the network to deploy on. `-p, --platform `: specify the platform to deploy on. `--gasLimit ` : specify gasLimit to use for deploying. `--gasPrice ` : specify gasPrice to use for deploying. `--from ` : specify privateKey to use for deploying. #### Examples ```bash $ vvisp deploy-contract contracts/ContractA.sol input1 input2 ``` #### Outputs ```shell ContractA Deploying... ContractA Created! Contract Address : 0xcfb... ``` > The contract is deployed according to the configured environment variable, and after waiting for confirmation, the generated contract address is printed out. ## deploy-service > vvisp deploy-service [options] Deploy the service described in `service.vvisp.json`. First, we make sure that `service.vvisp.json` is defined. When it is first deployed, `state.vvisp.json` is created to save the deployment status. If you upgrade to another version later, you can change `service.vvisp.json` and deploy again. The service will be upgraded to the state defined in modified `service.vvisp.json`. If deployment fails due to an unexpected problem during deployment, re-enter the command and redeploy it from the point of interruption. **It is not recommended to change `state.vvisp.json` unless it is a special case.** To create `service.vvisp.json`, see [here](../../../CONFIGURATION.md#service). #### Options `-s, --silent` : do not print logs. `-n, --network `: specify the network to deploy on. `-p, --platform `: specify the platform to deploy on. `--gasLimit ` : specify gasLimit to use for deploying. `--gasPrice ` : specify gasPrice to use for deploying. `--from ` : specify privateKey to use for deploying. `-f, --force` : remove existing `state.vvisp.json` and deploy. #### Example ```bash $ vvisp deploy-service ``` #### Process The deployment sequence is as follows. If there is no target to deploy, skip that task. 1) Deploy contracts. 1) Perform initialization of contracts. #### Outputs __`state.vvisp.json`__ This is the file where you can view the status of the currently deployed service. ```json { "serviceName": "Haechi", //(1) "contracts": { //(2) "ContractKeyName1": { //(3) "address": "0x863...", //(4) "fileName": "Contract1.sol", //(5) "name": "Contract1" //(6) }, "ContractKeyName2": { "address": "0x73c...", "fileName": "Contract2.sol", "name": "Contract2" } } } ``` 1. The name of the configured service. 1. Json format of the information of deployed contracts. 1. Indicates the name of the deployed contract. 1. Represents the address of deployed contract. 1. Represents the file name of the currently deployed contract version. 1. Represents the contract name of the currently deployed contract version. ## gen-script > vvisp gen-script [filesOrDirectory...] [options] The `gen-script` is a command that automatically creates a javascript library to help you easily call deployed smart contracts. The repository used in the tutorial is as follows. (https://github.com/HAECHI-LABS/vvisp-sample) If there is no filename entered, this command will automatically generate scripts for all the solidity files in the `contracts/` folder. #### Usage `vvisp gen-script [filesOrDirectory...] [options]` #### Options `-s, --silent` : do not print logs. `-f, --front `: Generate JavaScript source code that can be executed in front-end (browser) #### Example ```bash $ vvisp gen-script contracts/HaechiV1.sol Compiling... compile contracts/HaechiV1.sol... Generate Finished! $ vvisp gen-script -f contracts/HaechiV1.sol Compiling... compile contracts/HaechiV1.sol... Generate Finished! ``` #### Output When you run `gen-script`, the `contractApis/` folder is created in the directory you have run. ```bash $ ls README.md contracts node_modules package.json service.vvisp.json test contractApis migrations package-lock.json scripts service2.vvisp.json truffle-config.js ``` The structure of the generated `contractApis/` folder is as follows: ``` contractApis/ ├── back/ ├──── abi/ ├────── HaechiV1.json ├────── ... ├──── js/ ├────── HaechiV1.js ├────── ... ├── front/ ├──── abi/ ├────── HaechiV1.json ├────── ... ├──── js/ ├────── HaechiV1.js ├────── ... ├──── index.js exampleUserApi.js ``` > - The abi files of the contracts are generated in `contractApis/back/abi/`. > - The APIs are generated in `contractApis/back/js/`. > - `exampleUserApi.js` will be generated at root directory. Refer this file to use generated apis. - `-f, --front ` option > - The abi files of the contracts are created in `contractApis/front/abi/`. > - The APIs are created in `contractApis/front/js/`. **(not needed)** > - The APIs are bundled in `contractApis/front/name.js`. (The file name follows the name you entered) In the case of the front API, it is set to [web3 old version](https://github.com/ethereum/wiki/wiki/wiki/JavaScript-API) for interacting with the Metamask. #### How to use generated contractApis? You can easily implement the function of invoking contract using the generated contractApis file. ```javascript /* HaechiV1 has following methods velocities: function(input1) haechiIds: function(input1) distances: function(input1) gym: function() makeNewHaechi: function(_id) increaseVelocity: function(_haechiId, _diff) run: function() initialize: function(_gym) */ // You can give configuration arguments like below. // If you described vvisp-config.json already, you don't have to give arguments. const config = { from: PRIVATE_KEY, gasPrice: GAS_PRICE, gasLimit: GAS_LIMIT }; // Write url or make provider object const webSetter = 'URL_OR_PROVIDER'; const { HaechiV1 } = require('../contractApis/back')(config, webSetter); main(); async function main() { // HaechiV1_ADDRESS is a address of HaechiV1 contract const haechiV1 = new HaechiV1(HaechiV1_ADDRESS); // call the run method in the HaechiV1 contract const receipt = await haechiV1.methods.run(); console.log(receipt); } ``` ## console > vvisp console [options] The `console` is a command providing an interactive and easy-to-use shell environment for contractApis generated by `gen-script`. The repository used in the tutorial is as follows. (https://github.com/HAECHI-LABS/vvisp-sample) **Before starting console, contractApis must be created and contract used to create contractApis must be deployed.** #### Usage `vvisp console ` If you do not enter a `` value, it will automatically find `contractApis/` in the current folder and run console. #### Options `-n, --network `: specify the network to deploy on. `-p, --platform `: specify the platform to deploy on. `--gasLimit ` : specify gasLimit to use for deploying. `--gasPrice ` : specify gasPrice to use for deploying. `--from ` : specify privateKey to use for deploying. #### Example ```bash $ vvisp console Available contract contracts: Index Name Contract Address [0] Haechi Haechi 0x660dd4EaDb8df267cE912797C588Fc9eadfa1861 [1] Gym HaechiGym 0xDc7C74e475e8100F7714DeE869b73E8DC91Af510 [2] Token SampleToken 0x54Cd384968d10C980bEe2A258E1ff8CF45a6354D If you are wondering how to use it, type help command. Use exit or Ctrl-c to exit >> ``` Once you start the vvisp console, you can easily invoke the registered contract using the vvisp console command. #### Command The commands available in the vvisp console are call, show list help exit. - help ``` >> help Usage: [] where is one of: call, show, list, help Commands: register register the address of smart contracts list list the available smart contracts show show the available method of a smart contract call [Params...] call a smart contract api method ``` `Help` command shows currently available commands. - list ``` >> list Index Name Contract Address [0] Haechi Haechi 0x660dd4EaDb8df267cE912797C588Fc9eadfa1861 [1] Gym HaechiGym 0xDc7C74e475e8100F7714DeE869b73E8DC91Af510 [2] Token SampleToken 0x54Cd384968d10C980bEe2A258E1ff8CF45a6354D ``` `list` command shows the list of contract and address - show \ ``` >> show HaechiV1 [Method] [Args] distances [uint256 _id] gym [] haechiIds [address _owner] increaseVelocity [uint256 _haechiId, uint256 _diff] initialize [address _gym] makeNewHaechi [uint256 _id] run [] velocities [uint256 _id] ``` `show` command shows a list of methods that contract can use. - call \ \ \[Arguments] ``` >> call HaechiV1 makeNewHaechi 123 { "transactionHash": "0x8ee8273a95c8f9e09e56358bd0c05ff1bf81a1ce91ea0b212347fb42c08dbcc6", "transactionIndex": 1, "blockNumber": 2493275, "from": "0x0d4010164401111f7bcf862e95708dd0624a1115", "to": "0x3f2e170de66ca0ed6c66db38479a8f8c33835475", "gasUsed": 63753, "logs": [ { "transactionHash": "0x8ee8273a95c8f9e09e56358bd0c05ff1bf81a1ce91ea0b212347fb42c08dbcc6", "name": "NewHaechi", "args": { "id": "123", "owner": "0x0D4010164401111f7bcF862e95708DD0624a1115" } } ] } ``` `call` command executes the contract's method. #### Tips 1. There should be no inconsistency with the `state.vvisp.json` file and `contractApis/`. 2. If only `contractApis/` exists and the `state.vvisp.json` file does not exist, the address of contract will be entered via stdin. ```bash $ vvisp console 'state.vvisp.json' does not existing in current path(/Users/jun/workspace/haechi/vvisp-sample) Run 'vvisp deploy-service' command to create state.vvisp.json and rerun 'vvisp console' again, or enter the address of the currently registered contract Available contract contracts: HaechiGym HaechiV1 SampleToken Enter the address of HaechiGym: 0x5c06aa41561Ef806dA109B1e9c6271208e203758 Enter the address of HaechiV1: 0xc95663de3398D74972c16Ad34aCd0c31baa6859e Enter the address of SampleToken: ``` 3. The name of automatically generated js files(such as `HaechiV1.js` and `HaechiGym.js` in `contractApis/back/js`) by `gen-script` must be the same as the contracts in `state.vvisp.json`. ## flatten > vvisp flatten [options] It bundles target contracts and imported contracts into one file. #### Options `-s, --silent` : do not print logs. `-o, --output ` : Create a flatten result in the current directory as a file with a file name of `name`. #### Examples ```bash $ vvisp flatten contracts/ContractA.sol -o Output.sol ``` #### Outputs > It bundles the target contracts and all the files that depend on each contract into a single console window. - `-o, --output ` option > The information to be output to the console is written to a file with the name you entered.