Skip to content

Latest commit

 

History

History
213 lines (161 loc) · 5.33 KB

README.md

File metadata and controls

213 lines (161 loc) · 5.33 KB
Raw

YAC: Yet Another Cli of Iroha

CircleCI

PyPI version

hyperledger/iroha is open source, I want to contribute to it...

Suppert version

  • python2.7 => ToDo
  • python3.4 => ToDo
  • python3.5 => ⚪️
  • python3.6 => ToDo

Simple install

$ pip install iroha-ya-cli

How to use

0) Make keypair and config.yml in this.

$ iroha-ya-cli keygen  --account_name mizuki --make_conf yes

Result

$ ls -lth | head  -n 4
total 76K
-rw-r--r--   1 mizuki staff  122 Oct 27 07:38 config.yml
-rw-r--r--   1 mizuki staff   88 Oct 27 07:38 mizuki.pri
-rw-r--r--   1 mizuki staff   44 Oct 27 07:38 mizuki.pub

Please change permission for protect key!!

1) Change information in generated config.yml

This file contains target peer information and my account info.

account:
  name: mizuki
  privateKeyPath: mizuki.pri
  publicKeyPath: mizuki.pub
peer:
  address: localhost
  port: 50051

Peer is target where cli send tx to. I guess Iroha uses grpc, so port is 50051.

2) Check config is whether correct or not using config command.

$ iroha-ya-cli config --config config.yml

  Config
 =========

 name      : mizuki
 publicKey : d5MxIVcHE2eq883JFYxkQVKZV794hWqR2VnXj/iSU1A=
 privateKey: GOcAK**...**Gvg==
 targetPeer: localhost:50051

3) Send tx like this

$ iroha-ya-cli tx  CreateAsset --domain_id japan --precision 0 --asset_name yen --config config.yml
== Grpc happens error ==
- Server is active?: False
- What's happen?   : Connect Failed

Transaction is not arrived...
Could you ckeck this => localhost:50051

I sent. (This error is expected, no problem 😅 😅 )

4) You can know optin using -h or --help command.

In first, you can see all command use this.

irohac

In second, you can see detail of each command.

$ iroha-ya-cli tx CreateAsset -h
usage: iroha-ya-cli tx CreateAsset [-h] --asset_name ASSET_NAME --domain_id
                                   DOMAIN_ID [--precision PRECISION]
                                   [--config CONFIG]

optional arguments:
  -h, --help            show this help message and exit
  --asset_name ASSET_NAME
                        asset name like mizuki
  --domain_id DOMAIN_ID
                        new account will be in this domain like japan
  --precision PRECISION
                        how much support .000, default 0
  --config CONFIG       config.yml's path

5) You can know data in Iroha using query.

irohac --hostname=localhost:50051 --account_id=admin@test GetAccount --account_id admin@test

Response is json. so you can use command like jq

{
  "account": {
    "permissions": {
      "canTransfer": true,
      "readAllAccounts": true,
      "createDomains": true,
      "removeSignatory": true,
      "setQuorum": true,
      "createAccounts": true,
      "createAssets": true,
      "addSignatory": true,
      "issueAssets": true,
      "setPermissions": true
    },
    "accountId": "admin@test",
    "quorum": 1,
    "domainName": "test"
  }
}

Sample

Tx

  • CreateDomain
irohac --hostname=localhost:50051 --account_id=admin@test CreateDomain --default_role user --domain_id aizu
  • CreateAccount
irohac --hostname=localhost:50051 --account_id=admin@test CreateAccount --account_name mizuki --domain_id japan

....

Query

  • GetAccount
irohac --hostname=localhost:50051 --account_id=admin@test GetAccount --account_id admin@test
  • GetAccountTransactions
irohac --hostname=localhost:50051 --account_id=admin@test GetAccountTransactions --account_id admin@test

....

Test

python -m unittest discover

Develop

# Compile protofile 
git clone https://github.com/MizukiSonoko/iroha-cli.git
cd iroha-cli
docker run -it -v  $(pwd):/opt/iroha-mizuki-cli mizukisonoko/alpine-grpc-protobuf sh -c  "cd /opt/iroha-mizuki-cli/schema; ls *.proto | xargs -I{} sh -c 'protoc -I=./ --python_out=../ {}; protoc -I=./ --python_out=../ --grpc_out=../ --plugin=protoc-gen-grpc=`which grpc_python_plugin` {}'"
pip install -r requirements.txt

Env

Tips

How to conver hyperledger/iroha-cli's key and cli's key? You can use ase64.b64encode(bytearray.fromhex()) and binascii.hexlify(base64.b64decode())

pubkey_in_iroha = 'c2b800f08c0b45ac9935f03471a04aa1414a974a9f03300503529f578e2031de'
pubkey_in_cli   = 'wrgA8IwLRayZNfA0caBKoUFKl0qfAzAFA1KfV44gMd4='
converted_pubkey_iroha = base64.b64encode(bytearray.fromhex(pubkey_in_iroha)).decode()
converted_pubkey_cli = binascii.hexlify(base64.b64decode(pubkey_in_cli)).decode()

print(converted_pubkey_iroha == pubkey_in_cli)
print(converted_pubkey_cli == pubkey_in_iroha)

Be careful decode()/encode(), byte,str

It happens this

Running PyYAML-3.12/setup.py -q bdist_egg --dist-dir /tmp/easy_install-wwituzoz/PyYAML-3.12/egg-dist-tmp-kgc91i9t
build/temp.linux-x86_64-3.5/check_libyaml.c:2:18: fatal error: yaml.h: No such file or directory
compilation terminated.

libyaml is not found or a compiler error: forcing --without-libyaml

=> apt install -y libyaml-dev