Image

Client wallet

Explains how to use the Nyzo client wallet created by the developers
graphical divider

Client wallet

Avatar
28/03/20
Image

Using the Nyzo client wallet

If you're somewhat proficient with handling command line tools, you will find little to no obstacles using the client. If not, this page goes into as much detail as possible to make sure you know your way around the client.

The first step to using the client is for you to install a Nyzo verifier or sentinel.
Tutorials for doing so can be found in the Getting started section of the Knowledgebase.

Functions

To determine if use of the Nyzo client is necessary for the task you're looking to complete, I'll go through the full scope of what the client can do first.

  • display wallet balances
  • send a standard transaction
  • create Nyzo strings for a private seed
  • create Nyzo string for a public identifier
  • create a Nyzo prefilled-data transaction
  • send a cycle transaction
  • list cycle transactions
  • sign a cycle transaction
  • generate NTTP sender data
  • search for transactions in the blockchain
  • display coins in circulation
  • display the frozen edge
  • forward a transaction

Initiating the client

After using SSH to access your verifier, use the following command as outlined on the Commands page of the Knowledgebase:

cd /home/ubuntu/nyzoVerifier
sudo java -jar build/libs/nyzoVerifier-1.0.jar co.nyzo.verifier.client.Client

Using the client

After initiation of the client, a window accepting user input opens and should look more or less like following (depending on the version of Nyzo verifier you're using):



Next is to enter the command of your choosing into the user input field, this can be either the short command or the full command.
I will go through the entire set of possibilities in the section down below.

Commands

Each command segment down below will contain an overview of the arguments which that command expects to receive, the output of that command and what both the input and output may look like through the use of exemplary data.

BL - balance

Display wallet balances.
This command accepts the following arguments in succession:

  • wallet ID or prefix:
    • 4402e5d532b576fb-70cac2f508caa3bf-673503ecc17c3ac2-163b06c5b50415a4
    • id__84g2XukQKosZtcI2.gAaFZ.EdgfJNoNYNypZ1JnT11nBI_n9yaSa

The result of executing this command returns:

  • verifier block height
    • 6947063
  • wallet identifier
    • 4402e5d532b576fb-70cac2f508caa3bf-673503ecc17c3ac2-163b06c5b50415a4
  • wallet identifier NyzoString
    • id__84g2XukQKosZtcI2.gAaFZ.EdgfJNoNYNypZ1JnT11nBI_n9yaSa
  • balance
    • ∩90.910235

ST - send

Send a standard transaction.
This command accepts the following arguments in succession:

  • sender key:
    • key_8a2B4csRaX5tIHbRigRIUsRsPuLHfN2w_KVG-eQcSV5GTQuoFbpe
  • receiver ID:
    • id__84g2XukQKosZtcI2.gAaFZ.EdgfJNoNYNypZ1JnT11nBI_n9yaSa
  • sender data (max 32 bits):
    • 01234567890123456789012345678901
  • amount in Nyzos:
    • 25
Before the command will be executed by the client, it has to be reviewed and approved by the user.
An example of such an approval screen looks as follows:

The result of approving and therefore executing this command returns:

  • status message
    • transaction not accepted by ab3a...957c
      transaction not processed

In this example the status message indicates a failure, this is due to the sender key not holding a balance. Expect to see a different output when a valid transaction is sent to the network.

NSS - seedString

Create Nyzo strings for a private seed.
This command accepts the following arguments in succession:

  • private key:
    • 4402e5d532b576fb-70cac2f508caa3bf-673503ecc17c3ac2-163b06c5b50415a3

The result of executing this command returns:

  • private seed (raw)
    • 4402e5d532b576fb-70cac2f508caa3bf-673503ecc17c3ac2-163b06c5b50415a3
  • private seed (Nyzo string)
    • key_84g2XukQKosZtcI2.gAaFZ.EdgfJNoNYNypZ1JnT11nAUJ7K.tND
  • public ID (raw)
    • f02a29b19197599e-9e24b977b3c5b60a-3076dc627100fc0c-aee047d8cbb4873f
  • public ID (Nyzo string)
    • id__8f0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_JRHDXM_k

NIS - idString

Create Nyzo string for a public ID.
This command accepts the following arguments in succession:

  • public ID:
    • f02a29b19197599e-9e24b977b3c5b60a-3076dc627100fc0c-aee047d8cbb4873f

The result of executing this command returns:

  • public ID (raw)
    • f02a29b19197599e-9e24b977b3c5b60a-3076dc627100fc0c-aee047d8cbb4873f
  • public ID (Nyzo string)
    • id__8f0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_JRHDXM_k

PRC - createPrefill

Create a Nyzo prefilled-data string.
This command accepts the following arguments in succession:

  • receiver ID:
    • id__8f0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_JRHDXM_k
  • sender data:
    • 01234567890123456789012345678901

The result of executing this command returns:

  • receiver ID (raw)
    • id__8f0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_JRHDXM_k
  • sender data
    • 01234567890123456789012345678901
  • prefilled-data string
    • pre_gw0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_830PcAcSdjpVe3BNcj8Rd3kUdRxXc34QcRgTdAtWej0PaU~W5dYx

PRS - sendPrefill

Send a prefilled-data transaction.
This command accepts the following arguments in succession:

  • sender key:
    • key_8a2B4csRaX5tIHbRigRIUsRsPuLHfN2w_KVG-eQcSV5GTQuoFbpe
  • prefilled-data string:
    • pre_gw0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_830PcAcSdjpVe3BNcj8Rd3kUdRxXc34QcRgTdAtWej0PaU~W5dYx
  • amount in Nyzos:
    • 25
Before the command will be executed by the client, it has to be reviewed and approved by the user.
An example of such an approval screen looks as follows:

The result of approving and therefore executing this command returns:

  • status message
    • transaction not accepted by ab3a...957c
      transaction not processed

In this example the status message indicates a failure, this is due to the sender key not holding a balance. Expect to see a different output when a valid transaction is sent to the network.

CTS - cycleSend

Send a cycle transaction.
This command accepts the following arguments in succession:

  • initiator key (in-cycle verifier):
    • key_8a2B4csRaX5tIHbRigRIUsRsPuLHfN2w_KVG-eQcSV5GTQuoFbpe
  • receiver ID:
    • id__8f0Has6hCTDvEziXuZf5KxFNuKPztg3-3aZxh.AbK8t_JRHDXM_k
  • sender data:
    • tutorial_test
  • amount in Nyzos:
    • 25
Before the command will be executed by the client, it has to be reviewed and approved by the user.
An example of such an approval screen looks as follows:

The result of approving and therefore executing this command returns:

  • message queue information


The workings of the CTS command are expected to be changed after integration of Version 573 (NTTP-3). Until this notice does not appear any longer, the contents of this command have not been updated post blockchain v2 integration.

CTL - cycleList

List cycle transactions.
This command accepts the following arguments in succession:

  • in-cycle verifier key (leave empty to list locally stored transactions):
    • key_8a2B4csRaX5tIHbRigRIUsRsPuLHfN2w_KVG-eQcSV5GTQuoFbpe

The result of executing this command returns:

  • warning
    • the verifier you specified does not appear to be in the cycle
  • no cycle transactions available

The workings of the CTL command are expected to be changed after integration of Version 573 (NTTP-3). Until this notice does not appear any longer, the contents of this command have not been updated post blockchain v2 integration.

CTX - cycleSign

Sign a cycle transaction.
This command accepts the following arguments in succession:

  • transaction index to sign (from cycleList/CTL command):
    • 4e5454502d333a20c835d176f8502b9a0d7b0b7eeb65653dad90094c
  • signer key:
    • key_8a2B4csRaX5tIHbRigRIUsRsPuLHfN2w_KVG-eQcSV5GTQuoFbpe

The result of executing this command returns:

  • warning
    • the verifier you specified does not appear to be in the cycle
  • no cycle transactions available

The workings of the CTL command are expected to be changed after integration of Version 573 (NTTP-3). Until this notice does not appear any longer, the contents of this command have not been updated post blockchain v2 integration.

NTTP - nttpGenerate

Generate NTTP sender data.
This command accepts the following arguments in succession:

  • NTTP number:
    • 1
  • Git hash:
    • b72063fdd1d15bdccaf6e4ebb2ee9094be40dae6

The result of executing this command returns:

  • notice
    • "Please use this in the sender-data field of the cycle-transaction send command (CTS/cycleSend) to initiate a vote for NTTP-5 at commit b72063fdd1d15bdccaf6e4ebb2ee9094be40dae6."
  • NTTP number
    • 1
  • Git hash
    • b72063fdd1d15bdccaf6e4ebb2ee9094be40dae6
  • sender data
    • X(4e5454502d353a20b72063fdd1d15bdccaf6e4ebb2ee9094be40dae6________)

TS - transactionSearch

Search for transactions in the blockchain.
This command accepts the following arguments in succession:

  • timestamp (optional):
  • block height (optional):
    • 6957083
  • Nyzo string (optional):

The result of executing this command returns:

  • notice
    • Using block height of 6957083 for search
  • height
    • 6957083
  • timestamp (ms)
    • 1585496382000
  • type value (transaction type)
    • 1
  • type
    • seed
  • amount
    • ∩448.373215
  • receiver ID
    • 12d454a69523f739-eb5eb71c7deb8701-1804df336ae0e2c1-9e0b24a636683e31
  • sender ID
    • 12d454a69523f739-eb5eb71c7deb8701-1804df336ae0e2c1-9e0b24a636683e31
  • previous hash height
    • 0
  • sender data
  • transaction (Nyzo string)
    • tx__Dx400005P ... HNI.d.

CC - circulation

Display coins in circulation.
This command does not accept any arguments.
The result of executing this command returns:

  • block height
    • 6957158
  • coins in system
    • 6957158
  • locked account sum
    • - ∩552,735.765942
  • unlock threshold
    • + ∩216,553.548270
  • unlock transfer sum
    • - ∩0.033592
  • seed account balance
    • - ∩10,938,753.520749
  • transfer account balance
    • - ∩0.000002
  • cycle account balance
    • - ∩77,120,615.429050
  • coins in circulation
    • = ∩11,604,448.798935

FE - frozenEdge

Display the frozen edge.
This command does not accept any arguments.
The result of executing this command returns:

  • height
    • 6957198
  • hash
    • bb443323f7c0e370-f9a83c5cd221a26c-48d00591bdf5d980-965bc6720f3cb905
  • verification timestamp (ms)
    • 1585497194647
  • distance from open edge
    • 1

TF - forwardTransaction

Forward a transaction.
This command accepts the following arguments in succession:

  • transaction (Nyzo string):
    • tx__Dx900015P ... FNI.e

The result of executing this command returns:

  • notice
    • Progress on transaction forwarding status

X - exit

Use this command as an alternative to using the shortcut CTRL + X to close the client.

Wallets

This page goes into detail about the client wallet only, discover other solutions available for managing and storing your Nyzo securely.

Discover Wallets
Share this article:
twitter social icon facebook social icon
divider graphic
arrow-up icon