Get Started
This section covers ZWallet CLI repository configuration, and installation.
Last updated
This section covers ZWallet CLI repository configuration, and installation.
Last updated
To properly build components, you must have a machine setup with the following requirements:
Linux (Ubuntu Preferred) Version: 20.04 or Above Mac(Apple Silicon or Intel) Version: Big Sur or Above Windows : Windows 10 or Above
4 vCPU, 4 GB Memory at minimum
1 GB of space minimum for zwallet build components
Open terminal and download the latest linux zwalletcli archive release
Extract the downloaded archive to a specified directory using the command below.
3. Provide execution privileges to the executable.
4. Navigate to the extracted directory path.
Run the zwallet executable by using the command below.
On successful installation you will see a help section:
Extract the executable from archive zwallet-windows.zip
Run the executable zwallet.exe
in windows command prompt.
On successful installation you will see a help section similar to response below :
Extract the downloaded archive to a specified directory using the command below:
Provide execution privileges to the executable.
Navigate to extracted directory path .
Run the zwallet executable using the command below.
On successful installation you will see a help section similar to response below :
Note: The above response is shortened for formatting purposes.
Windows 64bit (tested with Windows 11)
Open MSYS2 MINGW64 shell from the windows start menu. The MINGW64 shell window will be similar to screenshot below.
Install the following libraries:
Install clang, go for mingw64 and unzip
Note: Restart mingw64 shell for Go to make changes.
Set environment variables
Clone zwalletcli
Navigate to zwalletcli and run the following command :
Unzip and copy dll's to zwalletcli directory. The zwalletcli directory will be available at the following path C:\msys64\home\<windows_username>\zboxcli
if cloned under mingw64 shell.
Now run the ./zwallet
command under zwalletcli directory .
On a successful build you will see a help section
The build essential package is required to build and make zwallet application. It includes the necessary GCC/g++ compilers and other essential critical libraries and utilities.
Run apt update command to update the packages.
Get Build-essential package.
Git is required to retrieve and clone the Zbox repository. Install Git by using the command
1. Clone the zwallet repository using the command
2. Navigate to zwallet directory using
3. Use the make install command to compile the source code.
This might take couple of minutes. Sample output after successful compiling:
Start the zwallet by typing
On a successful build you will see a help section.
Open terminal and make a new .zcn folder in the home directory of your system using the command below:
Note: For windows create a folder named .zcn at `C:\Users\<windows_username>
`path
Open the config.yaml
file located at $HOME/.zcn
path of your system.The contents should be similar to the file below.
ZWallet CLI provides a long list of commands to use. Lets begin with creation of wallet on Züs decentralized network.
For creating a wallet using ZWallet. Simply run create-wallet
command and this creates a wallet at default location~/.zcn/wallet.json
Sample Command
Sample Output
Here is a sample with faucet
command which will create a wallet with test tokens at default location~/.zcn/wallet.json
To add tokens to the wallet run zwallet faucet
command.
To check whether the wallet is successfully created, verify the token balance in zwallet using
Note that by default zwallet checks balance for the wallet specified in wallet.json
file located in the zcn folder in linux home directory.
Successful Response for ./zwallet getbalance
command:
If getting Get balance failed.
error when running ./zwallet getbalance
command. Run the ./zwallet faucet --methodName pour --input "{Pay day}"
command and then check the balance again.
The faucet
command will get test tokens into the wallet for transactional purposes and make the wallet usable. Successful Response of the faucet
command:
Now you have a wallet with available ZCN tokens, which can be used with 0chain blockchain and decentralized storage services.
6.
7.
Download the latest windows zwalletcli archive release from .
Note: The above response is shortened for formatting purposes. 5.
6.
Open terminal and download the latest mac zwalletcli archive release
6.
7.
Installing msys2 from .
Download necessary dll files as zip from .
11.
12.
Installation instructions for Go can be found.
8.
9.
Configuration for the Züs network by default is stored in network/config.yaml
file of the which we will copy to a new config.yaml
file in our local system .
Copy from network directory in zwalletcli repo to .zcn
directory.
Zwallet connects to the Züs network using the block_worker
field. These network details are automatically fetched from the blockWorker's network API. Preferred Blobbers are also present which you can uncomment for using specified storage providers for handling your files.
Note: In case you are configuring zwallet network for the block_worker
should be set to