aurora-is-near / aurora-cli-rs Goto Github PK

Arch users prefer to install everything via AUR, and basically it will be nice to have a simple command yay -S aurora-cli instead of cloning this repo and manually installing.

The cli-rs do not count with unit testing, so it is required to write tests that can be run with the cargo test command and that test behaviors at the command line. These should be exhaustive, meaning they should test for all the commands and options combinations and provide an acceptable coverage level, i.e., around 80% of the code in the src folder.

Write a documentation that complies with the standards and it is publishable on the docs.rs site

What should be done

Create documentation for:

• all commands and subcommands
• include all parameters for commands
• for Aurora Engine specific commands - create a full list of available calls, their parametres and responses
• same for NEAR Protocol specific commands

Motivation

As a first-time coming user, I need detailed documentation and instructions on how to use aurora-cli. As far as I can see currently it's two main commands: engine and near. And it means communication with Aurora Engine smart contract, and NEAR Protocol itself.

For now, to use aurora-cli, I should deep diving to Aurora Engine code to understand what functions, parameters, and responses I can use (Aurora Engine do not have full-featured documentation for that). Especially how to use it with CLI commands, for example with "borshified" parameters.

It will be good to have documentation for all commands and parameters for it.

Also, it will be good to have documentation, instructions, and examples for each one for:

1. Aurora Engine public methods, including views, their parameters, and responses.
2. NEAR Protocol public methods, including views, their parameters, and responses.

Having this kind of documentation, that covers all cases of use for aurora-cli makes this tool useful and convenient for real-world usage, for users that do not have enough context about Aurora Engine and NEAR protocol commands.

Write a .readme file that is equivalent in content to the previous version cli (https://github.com/aurora-is-near/aurora-cli) that is currently deprecated. We expect the file to contain the same sections and include usage examples equivalent to those here (https://github.com/aurora-is-near/aurora-engine#usage.) We expect the file to be compliant with the following specifications https://github.com/RichardLitt/standard-readme/blob/master/spec.md

Currently, aurora's documentation source is in the following repo https://github.com/aurora-is-near/doc.aurora.dev. We require a new section for the cli-rs that follows the same structure and style as the rest of the sections. It should explain how the cli is installed and used, including an exhaustive description of all the commands and options available to the final user.

Currently, the following command is required to install the cli: cargo install --git https://github.com/aurora-is-near/aurora-cli-rs.git, but it would be simpler to host a binary at crates.io so it can be installed using the cargo add aurora command. We require the corresponding .readme file, "version," "dependencies," and "dependants" sections in crates.io to be properly completed. Similarly, the links to the "documentation" ad "repository" should be added and accurate, as well as the "owner" and "categories" information.

What should be done

Currently in docs directory located an example only for localnet.

Also should exist examples and how-to for NEAR blockchain networks: maintnet and testnet.

Motivation

For real-world usage, it's important to have clear instructions how-to on using and testing smart contracts (primarily Aurora Engine) for testnet. And how to use it in production for mainnet.

Testing....