Myst CLI is a command line interface that allows you to manipulate a Mysterium node using just your terminal.
To get familiar with
myst cli usage follow the below guide which explains initial set up
and available commands for node operators. Mysterium CLI allows you to create, unlock & register node identity, claim your node into my.mysterium.network, set bounty payout address, view NAT Traversal status & NAT type, manually start/stop WireGuard service and more.
To start open your terminal and execute:
Once started your terminal window should change to the
myst cli interface.
To get help and see a full list of possible commands execute:
Each command has an output, if the output does not start with
[WARNING] consider that command a success.
Commands can be autocompleted using the
tab key on your keyboard.
If you have already installed a Mysterium node but have no access to the NodeUI to complete the onboarding process, you'll have to unlock and register your identity with Mysterium CLI. Go ahead and fire up the cli application and follow the steps below.
In order to identify yourself in the network you must have an identity which was created during the installation process. Use the command below to print your node identity address to your terminal.
identities unlock <providerIdentity>
In order to use the created identity it has to be unlocked first.
Unlocking has to be done every time we launch the
myst cli and want to use the created identity.
For the sake of simplicity let's say we've received an identity:
which we'll use in all later steps.
To unlock it we'd have to execute:
identities unlock 0x4570fe47a49af9ae9bd76f029818413ea18620000
After creating and unlocking the identity it must be registered so that Mysterium services are aware
about it and it's balance, to do that execute the
identities register command.
identities register <providerIdentity>
Note: You can find and copy your MMN API key in your MMN profile.
identities set-payout-address <providerIdentity> <beneficiary>
There are two types of wallets that you can use:
Exchange wallets (HitBTC and Bittrex deposit addresses are supported only);
Direct Blockchain wallets (Metamask, Trust wallet, Atomic, MEW, MyCrypto, Trezor, Ledger ...).
MYST is a standard ERC20 token, if wallet supports ERC-20 tokens (has possibility to add any custom ERC-20 token), then MYST can be added there.
Ensure that beneficiary wallet address has been successfully changed:
identities get-payout-address <providerIdentity>
You can use the CLI to withdraw MYST you've earned. Make sure your identity is unlocked and check your balance and earnings:
identities get <providerIdentity>
(Optional) The amount which you can withdraw will be displayed as your balance. Your earnings are periodically settled in to your balance. If you want to settle earnings in to balance yourself (it will cost you a certain amount MYST in fees), you can do so by running:
identities settle <providerIdentity>
After that's done you can now withdraw your funds using the withdraw command:
identities withdraw <providerIdentity> <withdrawToAddress> <toChain> [amount]
You can withdraw to two chains:
- 1 (ETH mainnet)
- 137 (Matic mainnet)
Note that when dealing with ETH mainnet the fees will be a lot higher for any operation including withdrawal.
[amount] argument is optional and if skipped all your balance will be withdrawn.
To start WireGuard service we'd have to execute (note that WireGuard service is started automatically upon installation, therefore you don't need to start it manually):
service start <your-identity> wireguard
service stop <your-identity> wireguard
If you are seeing the similar output to the one below - your service is up and running!
[Running] ID: 7b4652a8-2021-4b9d-aeea-da7a60709678 ProviderID: 0x00f735d4ad380b56b92cd6c9f078763bbfeab3e8 Type: wireguard