README
¶
Oasis CLI
This is the official command-line interface (CLI) for interacting with the Oasis Network, both the consensus layer and ParaTimes built with the Oasis Runtime SDK.
Building
To build the CLI, run the following:
make
This will generate a binary called oasis which you are free to put somewhere
in your $PATH.
NOTE: The rest of the README assumes the oasis binary is somewhere in your
$PATH.
Quickstart
You can interact with the Oasis CLI by invoking it from the command line as follows:
oasis --help
Each (sub)command has a help section that shows what commands and arguments are available.
The Oasis CLI also comes with a default set of networks and ParaTimes configured. You can see the list by running:
oasis network list
oasis paratime list
Initial configuration currently defaults to mainnet and the emerald
ParaTime but this can easily be changed using the corresponding set-default
subcommand as follows:
oasis network set-default testnet
oasis paratime set-default testnet sapphire
To be able to sign transactions you will need to first create or import an account into your wallet. File-based (storing keys in an encrypted file) and Ledger-based (storing keys on a Ledger device) backends are supported. To create a new file-backed account run:
oasis wallet create myaccount
It will ask you to choose and confirm a passphrase to encrypt your account with. You can see a list of all accounts by running:
oasis wallet list
To show the account's balance on the default network/ParaTime, run:
oasis account show
The account command also allows you to transfer tokens, deposit or withdraw to
and from ParaTimes, delegate your assets to validators etc.
Check out the complete User's guide in [docs/README.md] and example invocations
of the CLI in examples folder to learn more.
Configuration
All configuration is stored in the $XDG_CONFIG_HOME/oasis directory (e.g.
$HOME/.config/oasis on Linux).
License
This software is licensed under Apache 2.0.
The content of the documentation (the /docs folder) including the media (e.g.
images and diagrams) is licensed under Creative Commons Attribution 4.0
International.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
build
|
|
|
cargo
Package cargo contains helper functions for building Rust applications using cargo.
|
Package cargo contains helper functions for building Rust applications using cargo. |
|
measurement
Package measurement implements utilities for reproducing enclave measurements.
|
Package measurement implements utilities for reproducing enclave measurements. |
|
sgxs
Package sgxs contains helper functions for dealing with ELF and SGXS binaries.
|
Package sgxs contains helper functions for dealing with ELF and SGXS binaries. |
|
Package metadata provides helpers for querying the metadata registry.
|
Package metadata provides helpers for querying the metadata registry. |