Skip to content

Commit 0ce8fc3

Browse files
committed
docs: Replace oasis-node CLI with oasis CLI docs
1 parent d8a3c46 commit 0ce8fc3

12 files changed

Lines changed: 422 additions & 37 deletions

File tree

docs/general/manage-tokens/README.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For your own security and peace of mind, please only use wallets that are listed
2525
findSidebarItem('/general/manage-tokens/terminology'),
2626
findSidebarItem('/general/manage-tokens/staking-and-delegating'),
2727
findSidebarItem('/general/manage-tokens/oasis-wallets/'),
28-
findSidebarItem('/general/manage-tokens/advanced/oasis-cli-tools/'),
28+
findSidebarItem('/general/manage-tokens/cli/'),
2929
findSidebarItem('/general/manage-tokens/holding-rose-tokens/custody-providers'),
3030
findSidebarItem('/general/manage-tokens/holding-rose-tokens/bitpie-wallet'),
3131
findSidebarItem('/general/manage-tokens/holding-rose-tokens/ledger-wallet'),

docs/general/manage-tokens/advanced/oasis-cli-tools/setup.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,7 @@ To run a command that requires a connection to an online Oasis node (i.e. the `s
1111

1212
Here are some examples of Oasis Node CLI commands that need a connection to an online Oasis node:
1313

14-
* `oasis-node stake info`: Shows general staking information.
15-
* `oasis-node stake list`: Lists all accounts with positive balance.
16-
* `oasis-node stake account info`: Shows detailed information for an account.
17-
* `oasis-node consensus submit_tx`: Submits a pre-generated transaction to the network.
14+
1815

1916
## Local commands
2017

docs/general/manage-tokens/advanced/oasis-cli-tools/transfer-tokens.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ Escrow Account:
8282
...
8383
```
8484

85-
We can observe that both, the general account and the escrow account (actively bounded and debonding), have a balance of 0 tokens.
85+
We can observe that both, the general account and the escrow account (actively
86+
bounded and debonding), have a balance of 0 tokens.
8687

8788
## Generate a Transfer Transaction
8889

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Oasis CLI
2+
3+
Oasis command-line interface (CLI) is a powerful all-in-one tool for
4+
interacting with the Oasis Network. You can download the latest release
5+
binaries from the [GitHub repository].
6+
7+
It boasts a number of handy features:
8+
9+
- Flexible setup:
10+
- supports Mainnet, Testnet, Localnet or any other Oasis network deployment
11+
- consensus layer configuration with arbitrary token
12+
- configuration of custom ParaTimes with arbitrary token
13+
- connecting to remote (via TCP/IP) or local (Unix socket) Oasis node
14+
instance
15+
- Powerful wallet features:
16+
- standard token operations (transfers, allowances, deposits, withdrawals and
17+
balance queries)
18+
- file-based wallet with password protection
19+
- full Ledger hardware wallet support
20+
- address book
21+
- generation, signing and submitting transactions in non-interactive mode
22+
- offline transaction generation for air-gapped machines
23+
- transaction encryption with Deoxys-II envelope
24+
- Ed25519 and Ethereum-compatible Secp256k1 encryption schemes
25+
- raw, BIP-44, ADR-8 and Ledger's legacy derivation paths
26+
- Developer and devops features:
27+
- Oasis node inspection and healthchecks
28+
- official testing accounts for Oasis Localnet, test runners and debugging
29+
- WebAssembly smart contract code deployment, instantiation, management and
30+
calls
31+
- debugging tools for deployed WebAssembly contracts
32+
33+
[GitHub repository]: https://github.com/oasisprotocol/cli/releases

docs/general/manage-tokens/advanced/oasis-cli-tools/deposit-withdraw-tokens-to-from-paratime.mdx renamed to docs/general/manage-tokens/cli/accounts.mdx

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,13 @@
11
import DocCard from '@theme/DocCard';
22
import {findSidebarItem} from '@site/src/sidebarUtils';
33

4-
# Deposit/Withdraw Tokens to/from ParaTime
4+
# Account transactions
55

6-
To perform ParaTime deposits or withdrawals using a command line interface, you will need `oasis` executable which is part of the [Oasis CLI](https://github.com/oasisprotocol/oasis-sdk/tree/main/cli). `oasis` is supplemental to `oasis-node` and supports ParaTime-related operations such as deposits, withdrawals, transfers and manipulation of the smart contracts, in contrast to `oasis-node` which only supports consensus layer features.
6+
## Transfer
77

8-
We will assume that your already have an Oasis wallet with some ROSE and that you want to Deposit or Withdraw ROSE to or from Emerald ParaTime running on the Mainnet network.
8+
TODO
99

10-
:::info
11-
12-
At time of writing, no precompiled `oasis` binaries are available. You will need to clone the [`oasis-sdk` git repository](https://github.com/oasisprotocol/oasis-sdk/) and compile the tool yourself. The process is straight forward - just follow the [Readme](https://github.com/oasisprotocol/oasis-sdk/blob/main/cli/README.md).
13-
14-
:::
15-
16-
:::info
17-
18-
This chapter describes the command line interface for depositing and withdrawing ROSE which is tailored toward advanced users such as node operators. If you are interested in the end-user wallets with a graphical user interface, consult the [How to Transfer ROSE into a ParaTime](../../how-to-transfer-rose-into-paratime.mdx) chapter.
19-
20-
:::
21-
22-
## Import your wallet
23-
24-
To sign any transaction you will need to import an Oasis wallet. Prepare your base64-encoded private key or the BIP39 mnemonic of your Oasis account and run:
25-
26-
```
27-
oasis wallet import <SOME_WALLET_NAME>
28-
```
29-
30-
Follow the interactive instructions that will guide you through the import procedure. If this is the first time you are running `oasis`, the imported wallet will become your default wallet and transactions will be signed with the key stored in this wallet, if not otherwise specified with the `--wallet` parameter.
31-
32-
## Configure Allowance
10+
## Allowance
3311

3412
In order to deposit ROSE to a ParaTime, you will first need to grant the ParaTime access to your Oasis account on the consensus layer. The following command allows Emerald to access up to 100 ROSE stored on your Oasis account which you will deposit afterwards:
3513

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Setup
2+
3+
## Download and Run
4+
5+
Download the latest release [here][cli-releases] and extract it to your
6+
favorite application folder.
7+
8+
:::info
9+
10+
Oasis is currently providing official builds for x86 Linux only. If you want
11+
to run it on another platform, you will have to [build it from source][cli-source].
12+
13+
:::
14+
15+
:::info
16+
17+
We suggest that you update your system path to include a directory containing
18+
`oasis` binary or create a symbolic link to `oasis` in your
19+
system path, so you can access it globally.
20+
21+
:::
22+
23+
Run the Oasis CLI by typing `oasis`:
24+
25+
```
26+
$ oasis
27+
CLI for interacting with the Oasis network
28+
29+
Usage:
30+
oasis [command]
31+
32+
Available Commands:
33+
accounts Account operations
34+
addressbook Manage addresses in the local address book
35+
completion Generate the autocompletion script for the specified shell
36+
contracts WebAssembly smart contracts operations
37+
help Help about any command
38+
inspect Inspect the network
39+
network Manage network endpoints
40+
paratime Manage paratimes
41+
registry Registry operations
42+
tx Raw transaction operations
43+
wallet Manage accounts in the local wallet
44+
45+
Flags:
46+
--config string config file to use
47+
-h, --help help for oasis
48+
-v, --version version for oasis
49+
50+
Use "oasis [command] --help" for more information about a command.
51+
```
52+
53+
When running Oasis CLI for the first time, it will generate a configuration
54+
file and populate it with the current Mainnet and Testnet networks. It will also
55+
configure all [Oasis-supported ParaTimes][paratimes].
56+
57+
## Configuration
58+
59+
The configuration folder of Oasis CLI is located:
60+
61+
- on Windows:
62+
- `%USERPROFILE%\AppData\Roaming\Oasis\`
63+
- on macOS:
64+
- `/Users/$USER/Library/Application Support/Oasis/`
65+
- on Linux:
66+
- `$HOME/.config/oasis/`
67+
68+
There, you will find `cli.toml` which contains configuration of the networks,
69+
ParaTimes and your wallet. Additionally, each file-based account in your wallet
70+
will have a separate, password-encrypted `.toml` file in the same folder named
71+
after the name of the account and `.wallet` extension.
72+
73+
You can have multiple profiles of your wallet. To use a different profile, pass
74+
`--config` parameter pointing to a specific `cli.toml` file.
75+
76+
```
77+
$ oasis wallet create myaccount
78+
$ oasis wallet list
79+
ACCOUNT KIND ADDRESS
80+
myaccount file (ed25519-adr8:0) oasis1qq59js97ytn2xcnscyx9n25z5y4dc6z6qcqsydyr
81+
$ mv ~/.config/oasis ~/.config/oasis_work
82+
$ oasis wallet list
83+
ACCOUNT KIND ADDRESS
84+
$ oasis wallet list --config ~/.config/oasis_work/cli.toml
85+
ACCOUNT KIND ADDRESS
86+
myaccount file (ed25519-adr8:0) oasis1qq59js97ytn2xcnscyx9n25z5y4dc6z6qcqsydyr
87+
```
88+
89+
## Backing up your wallet
90+
91+
To back up your wallet, simply archive the folder containing `cli.toml` and
92+
`.wallet` files.
93+
94+
[cli-releases]: https://github.com/oasisprotocol/cli/releases
95+
[cli-source]: https://github.com/oasisprotocol/cli
96+
[paratimes]: ../../../dapp/README.mdx

0 commit comments

Comments
 (0)