haechi-labs / henesis-cli Goto Github PK

View Code? Open in Web Editor NEW

9.0 11.0 0.0 234 KB

🚀 Command Line Interface tool to Utilize henesis

Home Page: https://henesis.io

License: GNU Lesser General Public License v3.0

JavaScript 15.58% Batchfile 0.04% TypeScript 83.90% Shell 0.49%

henesis blockchain ethereum querylayer cli klaytn

henesis-cli's Introduction

henesis-cli

🚀 Command Line Interface tool to Utilize henesis

Install

To use henesis-cli, Node v10 or higher must be installed.

$ npm install -g @haechi-labs/henesis-cli

$ henesis help

VERSION
  @haechi-labs/henesis-cli/1.0.0-beta.39 darwin-x64 node-v10.16.0

USAGE
  $ henesis [COMMAND]

COMMANDS
  changepw     change password
  help         display help for henesis
  init         create the folder structure required for your project
  integration  manage integrations
  login        perform a login
  logout       perform a logout
  nft          manage nft api
  node         manage trusted nodes

How to Setup Henesis AutoComplete

$ henesis autocomplete

Enter the following script according to your shell type.

zsh:

$ printf "$(henesis autocomplete:script zsh)" >> ~/.zshrc; source ~/.zshrc

bash:

$ printf "$(henesis autocomplete:script bash)" >> ~/.bashrc; source ~/.bashrc

Usage

account

You must be logged in to use this features.

manage your account

USAGE
  $ henesis account:COMMAND

COMMANDS
  account:changepw  change account password
  account:describe  describe account information

account:changepw

Command Line

$ henesis account:changepw
Password: ******
New Password: ******
Again New Password: ******
🦄 Password changed!

account:describe

Command Line

$ henesis account:describe
Email: [email protected]
Name: haechi
Organization: haechi-labs
clientId: 49e77d0be585ef71c337f758e61e1f16

help

Use help as:

  $ henesis help [COMMAND]

For example, you can call help about integration:delete command like:

$ henesis help integration:delete
delete a integration

USAGE
  $ henesis integration:delete [INTEGRATIONID]

EXAMPLE
  $ henesis integration:delete my-integration-id

init

The directory in which the init command is run must be empty.

$ henesis init -n sample-project
sample-project directory has been created.

After this, the following folder structure is created.

sample_project
├── contracts
│   └── example.sol
└── henesis.yaml

integration

You can use command where the henesis.yaml file exists.

$ henesis integration
manage integrations

USAGE
  $ cli integration:COMMAND

COMMANDS
  integration:delete    delete a integration
  integration:deploy    deploy a integration
  integration:describe  describe a integration
  integration:status    get integrations
  integration:usage     show event streamer statistics

There are tasks to be done before the deploy command.

Place the contract file distributed in Blockchain inside the contract directory.
Modify the henesis.yaml file to match the event you want to subscribe to and place the file with logic in the handler directory.
You can run the deploy command and check the status of the distribution through the status command.

integration:delete

Command Line

$ henesis integration:delete <integrationId>

integration:deploy

Command Line

$ henesis integration:deploy

Options

-f or --force: Erase existing deployed content and deploy current configuration.
-p or --path: Specify where henesis.yaml is located.

integration:describe

Command Line

henesis integration:describe <integrationId>

integration:status

Command Line

henesis integration:status

integration:describe

Command Line

henesis integration:describe <integrationId>

login

$ henesis login
Allow Henesis to collect anonymous CLI usage and error reporting information
yes(y) or no(n): y
email: [email protected]
password: ***********

🎉 Login Success from [email protected] 🎉

logout

$ henesis logout
🤗 Logout Success 👍

node

manage trusted nodes

USAGE
  $ henesis node:COMMAND

COMMANDS
  node:status  show truested node information
  node:usage   show truested node statistics

node:status

Command Line

$ henesis node:status
Platform     Network   Endpoint
ethereum     mainnet   https://tn.henesis.io/ethereum/mainnet
ethereum     ropsten   https://tn.henesis.io/ethereum/ropsten
ethereum     rinkeby   https://tn.henesis.io/ethereum/rinkeby

node:usage

Command Line

$ henesis node:usage
Henesis Trusted Node (Ethereum) Statistics

Total rpc call of this month: 226,233,096
This command shows the trusted node usage this month(The stat is updated every hour).
The daily statistic is added at UTC+0.
Date         Usage        Bandwidth
2019-12-04   27,105,464   75.96 GB
2019-12-03   107,220,983  300.35 GB
2019-12-02   51,677,543   135.39 GB
2019-12-01   40,229,106   107.58 GB

nft

manage nft api

USAGE
  $ henesis nft:COMMAND

COMMANDS
  nft:usage  show nft api statistics

nft:usage

Command Line

$ henesis nft:usage
Henesis NFT API (Ethereum) Statistics

Total api call of this month: 25,904
This command shows the nft api usage this month.
Date         Usage        
2020-02-05   6,250        
2020-02-04   11,500       
2020-02-03   8,154

About henesis.yaml

webSocket

name: sample
version: v1    # (TBD) The version of this yaml file.
apiVersion: v1 # (TBD) The version of Henesis api. The type of message you receive can be changed depending on this version.

blockchain:
  platform: ethereum
  network: mainnet
  threshold: 12 # optional.
                # Ethereum: (default: 12, min: 6)
                # Klaytn: (default: 0, min: 0)

filters:
  contracts:
    - address: '0x'
      name: example
      files: # The events of the contracts listed below can be combined together at this address.
        - path: ./contracts/example.sol
          contractName: example
          compilerVersion: 0.5.8

provider:
  type: webSocket

webhook

name: sample
version: v1    # (TBD) The version of this yaml file.
apiVersion: v1 # (TBD) The version of Henesis api. The type of message you receive can be changed depending on this version.

blockchain:
  platform: ethereum
  network: mainnet
  threshold: 12 # optional.
                # Ethereum: (default: 12, min: 6)
                # Klaytn: (default: 0, min: 0)

filters:
  contracts:
    - address: '0x'
      name: example
      files: # The events of the contracts listed below can be combined together at this address.
        - path: ./contracts/example.sol
          contractName: example
          compilerVersion: 0.5.8

provider:
  type: webhook
  url: https://localhost:8080
  method: POST
  headers:
    Authorization: 'Bearer YOUR-OWN-TOKEN'

Parameter Details

The following are detailed explanations for parameters used to henesis.yaml.

version & name

The version and name are used as delimiters to identify the project. The name must consist only of lowercase letters, numbers, '-' and '.', the maximum length is 253 characters.

apiVersion

The apiVersion is the version of Henesis api. The type of message you receive can be changed depending on this version.

blockchain

The blockchain part is an area that describes the platform and network name of the blockchain in which the smart contract to e subscribed is deployed.

platform

The blockchain platform you want to use.

We support now

ethereum
klaytn

network

The blockchain network you want to use.

We support now below chains.

platform	network	chain
ethereum	mainnet	mainnet
ethereum	ropsten	ropsten testnet
ethereum	rinkeby	rinkeby testnet
klaytn	mainnet	cypress mainnet
klaytn	baobob	baobob testnet

threshold

Minimum confirmation thresohld which you want to received.

Caution : when receiving data, we wait for a threshold of block confirmation.

filters

The filters part is about information for the smart contracts you want to subscribe through Henesis.

You can subscribe to more than one contract.

contracts

address

An address of the deployed smart contract

name

A name of the contract filter

files

path

A file path of the smart contract source code

contractName

A name of the contract to subscribe in the source code

compilerVersion

A solidity compiler version. Must be identical to the compiler version at the time of deployment.

provider

The provider is where you choose how to receive events from Henesis. We support WebSocket and Webhook

The WebSocket doesn't need any settings like url, method, headers.

type

WebSocket or Webhook

url

URL which you want to hook

method

HTTP method like a GET, POST, PUT, DELETE

headers

Authorization

If you want to set authorization (like a JWT), you can set authorization

We also support tutorial.

henesis-cli's People

Contributors

Stargazers

Watchers

henesis-cli's Issues

Need to handle error about undefined function in config file

handlers/transfer.ts

exports.execution2 = function...

henesis.yaml

...
handlers:
  event2:
    event: Transfer(address,address,uint256)
    version: v1
    runtime: tsnode8
    path: ./handlers/transfer.ts
    dep: ./handlers/package.json
    function: transfer

So, the situation is that the function name in henesis.yaml and exported function name are different. CLI needs to determine this.

[Current Behavior]
User can deploy, but there is no error occurred. User can only find the error with log at kibana.

[Expected Behavior]
Cannot find function name transfer err msg occurred.

update integration class

getting verified contract source code from etherscan

If the contract code has already been verified, eliminate "copy and paste" work by getting the source code from etherscan.

[docs] add description for autocomplete

[command] implement handler subcommand

refactor date to dayjs

convert date to dayjs
extracts common logic

[command] implement autocomplete feature

https://github.com/oclif/plugin-autocomplete

[command] No longer : must be able to separate command itself.

[command] config -e option need to allow http

This command is originally generated for test usability, so it needs to allow both http and https to be easily tested.

[command] change "integration deploy -f" cmd to "integration update"

[common] Create anonymous identity for usage pattern collection.

update henesis.yaml template file with optional timeout parameter

provider:
type: webSocket
timeout: 10000 // optional

[rpc] implement user rpc

show help message `henesis integration:delete`, `henesis integration:describe`

henesis integration:delete, henesis integration:describe

This two commands should show help message

complier version auto injection and remove from yaml file

refer to truffle

Should print a deploy failed message if the status is unavailable after deploying integration

generate henesis.yaml via interactive way

[bug] henesis cannot update due to autocomplete setting

set up henesis autocomplete by adding env var to shell profile
printf "$(henesis autocomplete:script zsh)" >> ~/.zshrc; source ~/.zshrc
then
HENESIS_AC_ZSH_SETUP_PATH=/Users/brant/Library/Caches/@haechi-labs/henesis-cli/autocomplete/zsh_setup && test -f $HENESIS_AC_ZSH_SETUP_PATH && source $HENESIS_AC_ZSH_SETUP_PATH statement is enrolled in profile file(.zshrc).
And then if you update henesis-cli version by npm install -g @haechi-labs/henesis-cli, henesiscommand is still not updated due to above setting which refer to cache.

[Readme] update readme based on beta.23

remove connectionLimit and interval in henesis.yaml

[command] implement user command

[rpc] implement handler rpc

Should be handled even if the blockchain information in henesis.yaml is capital letters

[bug] need to check global 401 error catcher

as-is:
jwt 401 error case:
-> json parser exception

need guide to print error message friendly when compilation fails

[api] user api versioning

EVM Version bug

EVM version is fixed to petersburg now,
It should determine appropriate EVM version depends on compiler version.

[JWT] auto-refresh token expiration time

[command] implement integration subcommand

do some work for listening proxy contract event

combining both contract's abi
refine henesis.yaml file for contract information

subcommand help enhancement

current behavior:

USAGE
$ henesis integration:describe [INTEGRATIONID]

EXAMPLE
$ henesis integration:describe

example doesn't represent real situation. it missed integration id argument.

it could be better if we give more practical example, such as

EXAMPLE
$ henesis integration:describe my-integration-id-xeqd

$ henesis login
email:

Expected Behavior:

$ henesis login
You already logged in with [email protected]

Background
When I was deploying with Henesis event-streamer, returning error was too vague to spot the particular cause.

Then I added console.log(error) and finally spot the cause.

modify error message more friendly

current behavior:

when we miss the arguments( e.g. integrationId), cli blame like this

Error: integrationId is undefined

but if cli can give more user-friendly error message such as

Error: Missing arguments:integrationId

user could catch their mistake more quickly.

Compiler cache directory name should be changed

Compiler cache directory name is set to vvisp. It should be changed to henesis.

show more helpful message when `henesis integration:status` with no integrationId

Currently when henesis integration:status with no integrationId, it shows irrelevant message

Error: {"error":{"code":401,"message":"unauthorized error"}}

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.