Skip to content

Update README.md#319

Open
digismash wants to merge 16 commits into
stagingfrom
digismash-patch-2
Open

Update README.md#319
digismash wants to merge 16 commits into
stagingfrom
digismash-patch-2

Conversation

@digismash
Copy link
Copy Markdown

A brief description of the changes in this PR:

Tasks to complete before merging PR:

  • Ensure system tests are passing. If not Run them manually to check for any regressions 📋
  • Do any new system tests need added to test this change? do any existing system tests need updated? If so create a PR at 0chain/system_test
  • Merge your system tests PR to master AFTER merging this PR

Associated PRs (Link as appropriate):

  • blobber:
  • gosdk:
  • system_test:
  • zboxcli:
  • 0chain:
  • Other: ...

@digismash digismash marked this pull request as ready for review November 4, 2023 12:43
Comment thread README.md Outdated
# zwallet - a CLI for Züs wallet

`zwallet` is a command line interface (CLI) to demonstrate the wallet functionalities of Züs.
ZWallet CLI is a Go-based command-line tool for managing ZCN tokens on the Züs blockchain. It provides an interactive way to receive, send, store, stake, and exchange ZCN tokens, as well as fetch information about Züs components such as miners, sharders, and blobbers.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing: ZWallet CLI is also used to create and manage wallet

Comment thread README.md
[Züs](https://zus.network/) is a high-performance cloud on a fast blockchain offering privacy and configurable uptime. It is an alternative to traditional cloud S3 and has shown better performance on a test network due to its parallel data architecture. The technology uses erasure code to distribute the data between data and parity servers. Züs storage is configurable to provide flexibility for IT managers to design for desired security and uptime, can design a hybrid or a multi-cloud architecture with a few clicks using [Blimp's](https://blimp.software/) workflow, and can change redundancy and providers on the fly.

For instance, the user can start with 10 data and 5 parity providers and select where they are located globally, and later decide to add a provider on-the-fly to increase resilience, performance, or switch to a lower cost provider.
For instance, the user can start with 10 data and 5 parity providers and select where they are located globally, and later decide to add a provider on-the-fly to increase resilience, and performance or switch to a lower-cost provider.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lower-cost provider is fine but Low-cost provider is most commonly used phrase

Comment thread README.md Outdated
| `--configDir` | Config directory | `~/.zcn` |
| `--network` | [Network file](#override-network) | `network.yaml` |
| `--silent` | Do not print detailed logs | `false` |
| `--h,--help` | Shows help/parameters for a particular command (./zwallet -h) will list all help commands. To know detail about a particular command like example 'send' use (./zwallet send --help ) | |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for --help command spacing is not correct

Comment thread README.md Outdated
| `--silent` | Do not print detailed logs | `false` |
| `--h,--help` | Shows help/parameters for a particular command (./zwallet -h) will list all help commands. To know detail about a particular command like example 'send' use (./zwallet send --help ) | |
| `--config` | [Config file](https://github.com/0chain/zwalletcli/blob/staging/network/config.yaml) and [description](https://github.com/0chain/zwalletcli#zcnconfigyaml). Configuration file | `config.yaml` |
| `--configDir` | Configuration directory | `~/.zcn` |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

incrase the parameter coplumn size so that commands can fit in and does not break line for commands

Comment thread README.md Outdated
./zwallet faucet --methodName pour --input "new wallet"
```

#### Creating a second wallet with 'faucet' command
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The output for this command shows that this command is finding if a wallet exists or not then its creating another wallet so its better to allign the command with the heading or change the heading to "Creating a second wallet with 'faucent' command " then its output should not show that the no wallet exists in the path because its task is to create the wallet not to find an existing wallet

Comment thread README.md Outdated
| `--hash` | Yes | Hash of transaction to verify | | valid transaction hash |

Note: Not all `zwallet` commands (eg. `send`) prints the transaction hash created. To see more details printed including the hashes, use `--verbose` global parameter.
Note: Not all `zwallet` commands (e.g., `send`) prints the transaction hash created. To see more details printed, including the hashes, use `--verbose` global parameter.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(e.g., send) should be (e.g, send)

Copy link
Copy Markdown

@HassanAbbas7357 HassanAbbas7357 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have commented out some minor mistakes please walk though the comments to fix them accordingly

@digismash digismash assigned digismash and unassigned hm90121 Nov 7, 2023
@digismash digismash added the documentation Improvements or additions to documentation label Nov 7, 2023
@digismash digismash assigned hm90121 and unassigned digismash Nov 11, 2023
@hm90121 hm90121 added the WIP label Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO NOT MERGE documentation Improvements or additions to documentation WIP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants