-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- fixed some typos and removed the cpu miner description
- Loading branch information
Showing
1 changed file
with
27 additions
and
55 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,61 @@ | ||
| Please note - this is an alpha version of the softeware, not all features are currently functional. | ||
| Please note - this is an alpha version of the software, and not all features are currently functional. | ||
|
|
||
| If using a dekstop or a web version of this software, you can use Ctrl+'+' or Ctrl+'-' (Command on MacOS) to | ||
| change the terminal font size. | ||
| If you are using the desktop or web version of this software, you can adjust the terminal font size with Ctrl+'+' or Ctrl+'-' (use Command on MacOS). | ||
|
|
||
| If using a desktop version, you can use Ctrl+M (Command on MacOS) to bring up metrics. | ||
| For the desktop version, you can press Ctrl+M (Command on MacOS) to bring up metrics. | ||
|
|
||
| Type `help` to see the complete list of commands. `exit` to exit this application. | ||
| On Windows you can use `Alt+F4` and on MacOS `Command+Q` to exit. | ||
| Type `help` to view the full list of commands. To exit the application, type `exit`. On Windows, you can also use `Alt+F4`, and on MacOS, use `Command+Q` to exit. | ||
|
|
||
| --- | ||
|
|
||
| Before you start, you must configure the default network setting. There are currently | ||
| 3 networks available. `mainnet`, `testnet-1` and `testnet-11`. While this software | ||
| is in alpha stage, you should not use it on the mainnet. If you wish to experiment, | ||
| you should select `testnet-1` by entering `network testnet-1` | ||
| Before starting, you need to configure the default network setting. Currently, three networks are available: `mainnet`, `testnet-1`, and `testnet-11`. While this software is in the alpha stage, you should avoid using it on the mainnet. For experimentation, select `testnet-1` by entering `network testnet-1`. | ||
|
|
||
| The `server` command configures the target server. You can connect to any Rusty Karlsen | ||
| node that has User RPC enabled with `--rpclisten-borsh=public`. If you are running the node | ||
| from within KOS, it is locked to listen to a local IP address. | ||
| The `server` command configures the target server. You can connect to any Rusty Karlsen node with User RPC enabled using `--rpclisten-borsh=public`. If running the node within KOS, it is restricted to listen to a local IP address. | ||
|
|
||
| Both network and server values are stored in the application settings and are | ||
| used when running a local node or connecting to a remote node. | ||
| Both the network and server settings are stored in the application and are used when running a local node or connecting to a remote one. | ||
|
|
||
| --- | ||
|
|
||
| You can use `node start` to start the node. Type `node` to see an overview of commands. | ||
| `node mute` toggles node log output (you can also use `node logs`). `node select` allows | ||
| you to choose between locally installed flavors (if running in the development environment). | ||
| You can also specify an absolute path by typing `node select <path to rusty karlsen binary>`. | ||
| Use `node start` to start the node. Type `node` to view an overview of commands. The `node mute` command toggles node log output (alternatively, you can use `node logs`). The `node select` command allows you to choose between locally installed versions if running in a development environment. You can also specify an absolute path by typing `node select <path to rusty karlsen binary>`. | ||
|
|
||
| For developers: `node select` scans 'target' folder for the debug and release builds | ||
| so you can switch between builds at runtime using the `node select` command. | ||
| For developers, the `node select` command scans the 'target' folder for debug and release builds, allowing you to switch between builds at runtime. | ||
|
|
||
| Once you node is running, you can connect to it using the `connect` command. | ||
| Once your node is running, connect to it using the `connect` command. | ||
|
|
||
| When starting the node and the `server` setting is configured to your local host, | ||
| the `connect` action will occure automatically. | ||
| If the `server` setting is configured to your local host when starting the node, the `connect` action will occur automatically. | ||
|
|
||
| `wallet create [<name>]` Use theis command to create a local wallet. The <name> argument | ||
| is optional (the default wallet name is "karlsen") and allows you to create multiple | ||
| named wallets. Only one wallet can be opened at a time. Keep in mind that a wallet can have multiple | ||
| accounts, as such you only need one wallet, unless, for example, you want to separate wallets for | ||
| personal and business needs (but you can also create isolated accounts within a wallet). | ||
| `wallet create [<name>]` - Use this command to create a local wallet. The `<name>` argument is optional (the default wallet name is "karlsen"), allowing you to create multiple named wallets. Only one wallet can be open at a time. Remember, a wallet can have multiple accounts, so you may only need one wallet unless you want to separate wallets for personal and business use (though you can also create isolated accounts within a wallet). | ||
|
|
||
| Make sure to record your mnemonic, even if working with a testnet, not to loose your | ||
| testnet KLS. | ||
| Be sure to record your mnemonic, even when working with a testnet, to avoid losing your testnet KLS. | ||
|
|
||
| `open <name>` - opens the wallet (the wallet is open automatically after creation). | ||
| `open <name>` - Opens the wallet (the wallet is opened automatically after creation). | ||
|
|
||
| `list` - Lists all wallet accounts and their balances. | ||
|
|
||
| `select <account-name>` - Selects an active account. The <account-name> can be the first few letters of the name or id of the account. | ||
| `select <account-name>` - Selects an active account. The `<account-name>` can be the first few letters of the account name or ID. | ||
|
|
||
| `account create bip32 [<name>]` - Allows you to create additional HD wallet accounts linked to the default private key of your wallet. | ||
| `account create bip32 [<name>]` - Creates additional HD wallet accounts linked to the wallet's default private key. | ||
|
|
||
| `address` - shows your selected account address | ||
| `address` - Displays the address of the selected account. | ||
|
|
||
| Note - you can click on the address to copy it to the clipboard. (When on mainnet, Ctrl+Click on addresses, transactions and | ||
| block hashes will open a new browser window with an explorer.) | ||
| Note - you can click on the address to copy it to the clipboard. When on the mainnet, Ctrl+Clicking on addresses, transactions, and block hashes will open a new browser window with an explorer. | ||
|
|
||
| Before you transact: `mute` option (enabled by default) toggles mute on/off. Mute enables terminal | ||
| output of internal framework events. Rust and JavaScript/TypeScript applications integrating with this platform | ||
| are meant to update their state by monitoring event notifications. Mute allows you to see these events in | ||
| the terminal. When mute is off, all events are displayed in the terminal. When mute is on, you can use 'track' | ||
| command to enable specific event notification. | ||
| Before transacting: The `mute` option (enabled by default) toggles mute on/off. Mute controls terminal output of internal framework events. Rust and JavaScript/TypeScript applications integrating with this platform update their state by monitoring event notifications. Mute allows you to see these events in the terminal. When mute is off, all events are displayed. When mute is on, use the `track` command to enable specific event notifications. | ||
|
|
||
| `transfer <account-name> <amount>` - Transfers from the active to a different account. For example 'transfer p 1' will transfer 1 KLS from | ||
| the selected account to an account named 'pete' (starts with a 'p' letter) | ||
| `transfer <account-name> <amount>` - Transfers funds from the active account to a different account. For example, 'transfer p 1' transfers 1 KLS from the selected account to an account starting with 'p'. | ||
|
|
||
| `send <address> <amount>` - Send funds to a destination address . | ||
| `send <address> <amount>` - Sends funds to a specified address. | ||
|
|
||
| `estimate <amount>` - Provides a fee and UTXO consumption estimate for a transaction of a given amount. | ||
| `estimate <amount>` - Provides a fee and UTXO consumption estimate for a transaction of a specified amount. | ||
|
|
||
| `sweep` - Sweeps account UTXOs to reduce the UTXO size. | ||
| `sweep` - Sweeps account UTXOs to reduce their size. | ||
|
|
||
| `history list` - Shows previous account transactions. | ||
| `history list` - Displays a list of previous account transactions. | ||
|
|
||
| `history details` - Show previous account transactions with extended information. | ||
| `history details` - Displays previous account transactions with extended information. | ||
|
|
||
| Once your node is synced, you can start the CPU miner. | ||
|
|
||
| `miner start` - Starts the miner. The miner will mine to your currently selected account. (So you need to have a wallet open and an | ||
| account selected to start the miner) | ||
| Once your node is synced, you can begin mining. | ||
|
|
||
| `monitor` - A test screen environment that periodically updates account balances. | ||
|
|
||
| `rpc` - Allows you to execute RPC methods against the node (not all methods are currently available) | ||
|
|
||
| `rpc` - Allows you to execute RPC methods against the node (note that not all methods are currently available). |