Skip to content

Commit

Permalink
chore(release): 1.7.3 [skip ci]
Browse files Browse the repository at this point in the history
## [1.7.3](v1.7.2...v1.7.3) (2020-12-06)

### Bug Fixes

* automated deployment & CI ([c45feac](c45feac))
* commit new version to package.json ([35a3a5f](35a3a5f))
* help test in search command ([3c9f254](3c9f254))
* sync response from API call in grpc.js ([106fd23](106fd23))
* update dependencies ([7e40624](7e40624))
* update docs on release ([5a22888](5a22888))
  • Loading branch information
semantic-release-bot committed Dec 6, 2020
1 parent 55c292e commit 2807fb7
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 21 deletions.
129 changes: 109 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ $ npm install -g @theqrl/cli
$ qrl-cli COMMAND
running command...
$ qrl-cli (-v|--version|version)
@theqrl/cli/1.7.2 darwin-x64 node-v10.16.3
@theqrl/cli/1.7.3 linux-x64 node-v10.16.3
$ qrl-cli --help [COMMAND]
USAGE
$ qrl-cli COMMAND
Expand Down Expand Up @@ -56,6 +56,14 @@ USAGE
Get a wallet balance from the network

```
Get a wallet balance from the network
Queries the balance of the wallet.json file or address.
Use the (-p) flag to pass the password of encrypted wallet file.
See the documentation at https://docs.theqrl.org/developers/qrl-cli
USAGE
$ qrl-cli balance ADDRESS
Expand All @@ -78,13 +86,21 @@ DESCRIPTION
See the documentation at https://docs.theqrl.org/developers/qrl-cli
```

_See code: [src/commands/balance.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/balance.js)_
_See code: [src/commands/balance.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/balance.js)_

## `qrl-cli create-lattice`

Send lattice transaction

```
Send lattice transaction
To create a lattice transaction you will need to have a wallet file (see create-wallet command)
The generated private keys will be save to the file defined with the -o command using the same password as the one for the wallet
Documentation at https://docs.theqrl.org/developers/qrl-cli
USAGE
$ qrl-cli create-lattice
Expand All @@ -107,13 +123,21 @@ DESCRIPTION
Documentation at https://docs.theqrl.org/developers/qrl-cli
```

_See code: [src/commands/create-lattice.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/create-lattice.js)_
_See code: [src/commands/create-lattice.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/create-lattice.js)_

## `qrl-cli create-wallet`

Create a QRL address

```
Create a QRL address
QRL addresses can be created with various tree height (-h) and hashing mechanisms (1-3)
You can output to a file (-f) in JSON and encrypt with a user set password (-p).
Documentation at https://docs.theqrl.org/developers/qrl-cli
USAGE
$ qrl-cli create-wallet
Expand All @@ -132,13 +156,16 @@ DESCRIPTION
Documentation at https://docs.theqrl.org/developers/qrl-cli
```

_See code: [src/commands/create-wallet.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/create-wallet.js)_
_See code: [src/commands/create-wallet.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/create-wallet.js)_

## `qrl-cli decrypt`

Encrypt message using recipient public keys

```
Encrypt message using recipient public keys
USAGE
$ qrl-cli decrypt
Expand All @@ -148,13 +175,16 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/decrypt.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/decrypt.js)_
_See code: [src/commands/decrypt.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/decrypt.js)_

## `qrl-cli encrypt [ADDRESS] [ITEM_PER_PAGE] [PAGE_NUMBER] [MESSAGE]`

Encrypt message using recipient public keys

```
Encrypt message using recipient public keys
USAGE
$ qrl-cli encrypt [ADDRESS] [ITEM_PER_PAGE] [PAGE_NUMBER] [MESSAGE]
Expand All @@ -172,13 +202,16 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/encrypt.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/encrypt.js)_
_See code: [src/commands/encrypt.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/encrypt.js)_

## `qrl-cli get-keys ADDRESS ITEM_PER_PAGE PAGE_NUMBER`

Get Ephemeral keys associated to a QRL address

```
Get Ephemeral keys associated to a QRL address
USAGE
$ qrl-cli get-keys ADDRESS ITEM_PER_PAGE PAGE_NUMBER
Expand All @@ -194,13 +227,15 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/get-keys.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/get-keys.js)_
_See code: [src/commands/get-keys.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/get-keys.js)_

## `qrl-cli help [COMMAND]`

display help for qrl-cli

```
display help for <%= config.bin %>
USAGE
$ qrl-cli help [COMMAND]
Expand All @@ -211,13 +246,21 @@ OPTIONS
--all see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_

## `qrl-cli ots ADDRESS`

Get a address's OTS state from the network

```
Get a address's OTS state from the network
Reports the next unused available OTS key. Pass either an address starting with
QQ0004 or a wallet.json file to se the next OTS. You can set the network flag with either (-t) testnet or (-m) mainnet
If the wallet file is encrypted use the -p flag to pass the wallet file encryption password.
USAGE
$ qrl-cli ots ADDRESS
Expand All @@ -238,13 +281,19 @@ DESCRIPTION
If the wallet file is encrypted use the -p flag to pass the wallet file encryption password.
```

_See code: [src/commands/ots.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/ots.js)_
_See code: [src/commands/ots.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/ots.js)_

## `qrl-cli receive ADDRESS`

Displays a QR code of the QRL address to receive a transaction

```
Displays a QR code of the QRL address to receive a transaction
Prints the QRL address in both textual and QR format. Pass either an address or a wallet.json file
If using an encrypted wallet file pass the encryption password with the (-p) flag.
USAGE
$ qrl-cli receive ADDRESS
Expand All @@ -259,13 +308,16 @@ DESCRIPTION
If using an encrypted wallet file pass the encryption password with the (-p) flag.
```

_See code: [src/commands/receive.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/receive.js)_
_See code: [src/commands/receive.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/receive.js)_

## `qrl-cli receive-initial-message FILE`

Receive initial message for channel opening

```
Receive initial message for channel opening
USAGE
$ qrl-cli receive-initial-message FILE
Expand All @@ -281,13 +333,16 @@ OPTIONS
-t, --testnet uses testnet for this function
```

_See code: [src/commands/receive-initial-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/receive-initial-message.js)_
_See code: [src/commands/receive-initial-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/receive-initial-message.js)_

## `qrl-cli receive-next-message INDEX`

Receive next message for channel opening

```
Receive next message for channel opening
USAGE
$ qrl-cli receive-next-message INDEX
Expand All @@ -300,13 +355,19 @@ OPTIONS
-t, --testnet uses testnet for this function
```

_See code: [src/commands/receive-next-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/receive-next-message.js)_
_See code: [src/commands/receive-next-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/receive-next-message.js)_

## `qrl-cli search SEARCH`

Searches for a transaction, block or address

```
Searches for a transaction, block or address
Fetches data about queried transaction/block/address. Defaults to mainnet; network selection flags are (-m) mainnet, (-t) testnet or (-d) devnet.
Advanced: you can use a custom defined node to query for status. Use the (-g) grpc endpoint.
USAGE
$ qrl-cli search SEARCH
Expand All @@ -325,13 +386,18 @@ DESCRIPTION
Advanced: you can use a custom defined node to query for status. Use the (-g) grpc endpoint.
```

_See code: [src/commands/search.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/search.js)_
_See code: [src/commands/search.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/search.js)_

## `qrl-cli send QUANTITY`

Send Quanta

```
Send Quanta
...
TODO
USAGE
$ qrl-cli send QUANTITY
Expand All @@ -357,13 +423,16 @@ DESCRIPTION
TODO
```

_See code: [src/commands/send.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/send.js)_
_See code: [src/commands/send.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/send.js)_

## `qrl-cli send-initial-message FILE`

Send initial message for channel opening

```
Send initial message for channel opening
USAGE
$ qrl-cli send-initial-message FILE
Expand All @@ -379,13 +448,16 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/send-initial-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/send-initial-message.js)_
_See code: [src/commands/send-initial-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/send-initial-message.js)_

## `qrl-cli send-next-message INDEX MESSAGE`

Send initial message for channel opening

```
Send initial message for channel opening
USAGE
$ qrl-cli send-next-message INDEX MESSAGE
Expand All @@ -399,13 +471,16 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/send-next-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/send-next-message.js)_
_See code: [src/commands/send-next-message.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/send-next-message.js)_

## `qrl-cli sign`

Sign message using saved private keys

```
Sign message using saved private keys
USAGE
$ qrl-cli sign
Expand All @@ -418,13 +493,19 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/sign.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/sign.js)_
_See code: [src/commands/sign.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/sign.js)_

## `qrl-cli status`

Gets the network status

```
Gets the network status
Reports network status from the node queried. You can select either (-m) mainnet or (-t) testnet
Advanced: you can use a custom defined node to query for status. Use the (-g) grpc endpoint.
USAGE
$ qrl-cli status
Expand All @@ -439,13 +520,18 @@ DESCRIPTION
Advanced: you can use a custom defined node to query for status. Use the (-g) grpc endpoint.
```

_See code: [src/commands/status.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/status.js)_
_See code: [src/commands/status.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/status.js)_

## `qrl-cli validate ADDRESS`

Validate a QRL address

```
Validate a QRL address
...
when passed a QRL address in hexstring (preceded by 'Q'), will return details about the addresses validity.
USAGE
$ qrl-cli validate ADDRESS
Expand All @@ -460,13 +546,16 @@ DESCRIPTION
when passed a QRL address in hexstring (preceded by 'Q'), will return details about the addresses validity.
```

_See code: [src/commands/validate.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/validate.js)_
_See code: [src/commands/validate.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/validate.js)_

## `qrl-cli verify ADDRESS ITEM_PER_PAGE PAGE_NUMBER`

Encrypt message using recipient public keys

```
Encrypt message using recipient public keys
USAGE
$ qrl-cli verify ADDRESS ITEM_PER_PAGE PAGE_NUMBER
Expand All @@ -481,5 +570,5 @@ OPTIONS
-t, --testnet queries testnet for the OTS state
```

_See code: [src/commands/verify.js](https://github.com/theqrl/qrl-cli/blob/v1.7.2/src/commands/verify.js)_
_See code: [src/commands/verify.js](https://github.com/theqrl/qrl-cli/blob/v1.7.3/src/commands/verify.js)_
<!-- commandsstop -->
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@theqrl/cli",
"description": "QRL CLI functions",
"version": "1.7.2",
"version": "1.7.3",
"author": "JP Lomas <[email protected]>, The QRL Foundation",
"bin": {
"qrl-cli": "./bin/run"
Expand All @@ -13,6 +13,7 @@
"@oclif/command": "^1",
"@oclif/config": "^1",
"@oclif/plugin-help": "^2",
"@semantic-release/git": "^9.0.0",
"@theqrl/explorer-helpers": "2.0.0",
"@theqrl/qrl-proto-sha256": "^3.3.0",
"@theqrl/qrlbase.proto": "^1.1.0",
Expand Down

0 comments on commit 2807fb7

Please sign in to comment.