This article will introduce in detail the use of the command line function of the keeper-Node of the MEMO system; the keeper needs to download the binary and execute the program 'mefs-keeper' to start a Memo keeper-Node.
Usage
Use the following command to view all commands
Copy mefs-keeper -h
COMMANDS:
init Initialize a memoriae repo
daemon Run a network-connected Memoriae node.
auth Interact with auth
wallet Interact with wallet
net Interact with net
config Interact with config
state Interact with state manager
role Interact with role manager
info print information of this node
register register an account id for the wallet first, then register a role for it, at last, add it into a group.
version Print version
backup backup export or import
bootstrap bootstrap
recover recover
log Manage logging
settle Interact with settlement chain
order Interact with order
restrict Interact with restrict
transfer transfer eth or memo
help, h Shows a list of commands or help for one command Introduction
Used to create a wallet in the specified path. If the wallet information already exists in this path, the existing wallet will be used directly without recreating the wallet. Assign the MEFS_PATH environment virable to specify a path for this node.
Usage
Options
Copy --setPass set password using input (default: false )
--password value, --pwd value set password for access secret key (default: "memoriae" )
--secretKey value, --sk value secret key
--keyfile value, --kf value absolute path of keyfile
--kpw value password to decrypt keyfile
--help, -h show help (default: false ) Example
Copy MEFS_PATH = ~/.memo-keeper ./mefs-keeper init --setPass=true The example sets the root directory of the node to: ~/.memo-keeper
Introduction
The command is used to start and stop an keeper-Node
Usage
Copy mefs-keeper daemon start -h
COMMANDS:
start Start a running mefs daemon
stop Stop a running mefs daemon
help, h Shows a list of commands or help for one command Options
Copy --password value, --pwd value Use the password when registering (default: memoriae )
--api value Set the api address to use (default: /ip4/127.0.0.1/tcp/5001 )
--secretKey value, --sk value Use the private key to create the node, if not, please initialize the node
--swarm-port value Set the swarm port to be used by the node (default: 4001 )
--group value Set the group the node will enter (default: 0 )
--price value set the price (default: 0, means not modify the price in config.json )
--secureAPI Whether it is a secure API (default: true )
--help, -h View more help Example
Copy MEFS_PATH = ~/.memo-keeper nohup ./mefs-keeper daemon start --api=/ip4/127.0.0.1/tcp/5001 --swarm-port=4001 --group=1 & > keeper.log 2>&1 & Introduction
This command implements the related functions of operating the wallet.
Usage
Copy mefs-keeper wallet -h
COMMANDS:
new create a new wallet address
list list all addrs
default print default wallet address
export export wallet secret key
help, h Shows a list of commands or help for one command Subcommands
2.3.1 wallet new
Introduction
Create a new wallet address
2.3.2 wallet list
Introduction
View all wallet addresses default Display
2.3.3 wallet default
Introduction
View the default wallet address
Example
Copy mefs-keeper wallet default 2.3.4 wallet export
Introduction
Export the wallet's private key
Example
Copy mefs-keeper wallet export wallet-address Parameter wallet-address is the wallet address of the node.
Introduction
This command is used to modify the configuration file, which takes effect only when the node is not started; if the config is modified while the node is running, the node needs to be restarted to make it take effect;
The path where the configuration file is located: config.json in the root directory of the node which is specified when init the node.
Usage
Copy mefs-keeper config -h
COMMANDS:
set Set config key
get Get config key
help, h Shows a list of commands or help for one command Subcommands
2.4.1 config set
Introduction
The set subcommand is used to set the value of the specified option in the configuration file
Usage
Copy mefs-keeper config set -h Options
Copy --key value The key of the config entry (eg "api.address" )
--value value The value with which to set the config entry
--help, -h show help (default: false ) Example
Configure the value of contract.endPoint
Copy mefs-keeper config set --key=contract.endPoint --value= "https://testchain.metamemo.one:24180" 2.4.2 config get
Introduction
This command is used to get the value of the specified configuration item
Usage
Copy mefs-keeper config get -h Example
Get the contract.endPoint value
Copy mefs-keeper config get --key=contract.endPoint Introduction
This command is used to set the bootstrap node in the configuration file, multiple bootstrap nodes can be added.
Usage
Copy mefs-keeper bootstrap -h
COMMANDS:
list list bootstrap addresses
add add bootstrap addresses
clear remove all bootstrap addresses
help, h Shows a list of commands or help for one command Subcommands
2.5.1 list
Introduction
View the current node bootstrap node list
2.5.2 add
Introduction
Add a bootstrap node
Example
Copy mefs-keeper bootstrap add "/ip4/103.xx.xx.xx/tcp/44006/p2p/12D3KooWQgakkyTFzcMh8JVbNK3FtiwJZz264sStq8QKBTeHwR3D" 2.5.3 clear
Introduction
clear the bootstrap node
Introduction
Network related commands
Usage
Copy ./mefs-keeper net -h
COMMANDS:
info get net info
connect connet a peer
peers print peers
findpeer find peers
declare declare public network address
help, h Shows a list of commands or help for one command Subcommands
3.1.1 info
Introduction
This command checks node network information
Usage
Copy mefs-keeper info -h
USAGE:
mefs-keeper info command [command options] [arguments...]
COMMANDS:
self print node id
help, h Shows a list of commands or help for one command Example
Copy mefs-keeper net info
Network ID 12D3K..., IP [/ip4/172.xx.xx.xx/tcp/4001 /ip4/128.xx.xx.xx/tcp/39525 /ip4/10.xx.xx.xx/tcp/39525], Type: Private '12D3K...' here is the peerID of this node.
Copy mefs-keeper net info self
ID: 26 keeper 2 3.1.2 peers
Introduction
Show the network information of all nodes currently connected.
Usage
Copy mefs-keeper net peers
12D3KooWHXmKSneyGqE8fPrTmNTBs2rR9pWTdNcgVG3Tt5htJef7 [/ip4/121.37.158.192/tcp/23456]
12D3KooWB5yMrUL6NG6wHrdR9V114mUDkpJ5Mp3c1sLPHwiFi6DN [/ip4/192.168.1.46/tcp/4201] 3.1.3 connect
Introduction
This command connects to a specified node manually.
Usage
Copy mefs-keeper net connect -h
USAGE:
mefs-keeper net connect [command options] [peer multiaddr (/ip4/1.2.3.4/tcp/5678/p2p/12D...)] Note
About how to construction the multiaddr for a node.
First use the net info command to view the network information of the node.
Copy ./mefs-keeper net info
Network ID 12D3K..., IP [/ip4/1.2.3.4/tcp/5678/], Type: Private And the multiaddr of this node is:
Copy /ip4/1.2.3.4/tcp/5678/p2p/12D3K... 3.1.4 findpeer
Introduction
View node information according to peerID, command usage:
Usage
Copy mefs-keeper net findpeer -h
USAGE:
mefs-keeper net findpeer [command options] [peerID (12D...)] Example
Copy mefs-keeper net findpeer 12D3KooW... 3.1.5 declare
Introduction
Used for the keeper node to declare its own public network ip address; (only the keeper node needs to use this command)
Usage
Copy ./mefs-keeper net declare -h
NAME:
mefs-keeper net declare - declare public network address
USAGE:
mefs-keeper net declare [command options] [net address (/ip4/1.2.3.4/tcp/5678)] Introduction
This command interacts with state db to obtain pay and penalty information about this node, or settle current income of this node.
Usage
Copy mefs-provider state -h
COMMANDS:
post list post
pay list pay
withdraw provider income of storing data
help, h Shows a list of commands or help for one command Subcommands
3.2.1 post
This command is used to read from state db to get the payment and penalty information of storage orders between user and provider nodes.
3.2.2 pay
This command is used to read from state db to show the current balance in fs and in memo token.
3.2.3 withdraw
This command is used for provider nodes to settle the current storage income.
Introduction
View commands for connected nodes
3.3.1 list
Introduction
This command is used to list connected roles
Usage
Copy mefs-keeper role list 3.4 info
Introduction
This command checks the basic information of this node
Usage
Options
Copy --update (default: false )
--all value, -a value Display all info information of the node (default: "false" )
--help, -h View more help Example
or
Copy mefs-keeper info -all true Introduction
Node pledge, withdrawal and other operations.
Usage
Copy mefs-keeper settle -h
COMMANDS:
setDesc Set description for a node. Especially for keepers, if desc is set to 'cloud' , they will be selected as dc in buckets preferentially.
withdraw withdraw memo from fs
pledgeAdd add pledge value
pledgeGet get pledge information
pledgeWithdraw move pledge value to fs, then call settle withdraw
pledgeRewardWithdraw move pledge reward value to fs, then call settle withdraw
quitRole change its state to inactive, this op is invocatable and daemon will fail at next start
alterPayee alter current payee to a new one, need to be comfirmed by new payee to finish.
help, h Shows a list of commands or help for one command Subcommands
Note
About parameter 'amount' in subcommands
Quotes should be used for the amount parameter, and there must be a space between the amount and the unit. The unit is not case-sensitive. It can be Memo, NanoMemo, AttoMemo. The relationship between them is: 1 Memo=10^9 NanoMemo=10 ^ 18 AttoMemo
3.5.1 setDesc
Introduction
Used to set the description for a node.
3.5.2 pledgeAdd
Introduction
Used to pledge some Memo for this node. Efficiant amount of Memo in wallet is required.
Usage
Copy USAGE:
mefs-keeper settle pledgeAdd [command options] [amount (Memo / NanoMemo / AttoMemo ) required] Example
To pledge 1 Memo for this node.
Copy mefs-keeper settle pledgeAdd "1 Memo" 3.5.3 pledgeGet
Introduction
View the current pledge amount.
Example
Copy mefs-keeper settle pledgeGet 3.5.4 pledgeWithdraw
Introducton
Take out some pledged Memo from pledge balance to fs balance.
Example
Withdraw the pledge of 0.5 Memo to the Fs account
Copy mefs-keeper settle pledgeWithdraw "0.5 Memo" 3.5.5 pledgeRewardWithdraw
Introduction
pledgeRewardWithdraw Withdraw the pledge income to the FS file system.
Example
Withdraw 0.5Memo of pledge reward to Fs account
Copy mefs-keeper settle pledgeRewardWithdraw "0.5 Memo" 3.5.6 withdraw
Introduction
withdraw Take out the token of the file system to the (Erc20) wallet
Example
Take out 0.5memo of the Fs file system to the (Erc20) wallet
Copy mefs-keeper settle withdraw "0.5 Memo" 3.5.7 quitRole
Introduction
This command makes the node exit the current role. Wallet address and the balance in it is not effected.
Caution
Role-related functions will no longer be available at this time. However, the wallet balance will not be affected. For keepers and keepers, the role pledge amount provided when registering the role can be withdrawn after run quitRole.
Example
Copy mefs-keeper settle quitRole --really-do-it 3.5.8 alterPayee
Introduction
alterPayee used to change the current payee.
Introduction
View current node version
Usage
Introduction
It is used to repair the db as much as possible when the node starts abnormally. Warning: Do not exit the node abnormally. When you want to exit the node, you should use the daemon stop command to exit normally. Failure to do so may result in db corruption beyond repair
Usage
Copy mefs-keeper recover db -h
--path specifies the database path to repair --deType the type of repair data (meta or state ) Example
Repair state database
Copy mefs-keeper recover db --path=/root/.memo-keeper/state --dbType=state Introduction
Used when the node is down. Import/export state (or meta) database.
Subcommands
4.2.1 export
Introduction
Export the state database to a file, using the following method:
Usage
Copy mefs-keeper backup export -h
USAGE:
mefs-keeper backup export [command options] [arguments...]
OPTIONS:
--path value path to store
--dbType value export dbtype: meta or state (default: "state" )
--help, -h show help (default: false ) Example
Export the state database to the current directory
Copy mefs-keeper backup export --path=./ --dbType=state 4.2.2 import
Introduciton
To import a database from a file, use the following method:
Usage
Copy mefs-keeper backup import -h
USAGE:
mefs-keeper backup import [command options] [arguments...]
OPTIONS:
--path value path of file import from
--dbType value export dbtype: meta or state (default: "state" )
--help, -h show help (default: false ) Example
import state database
Copy mefs-keeper backup import --path=./state-xxxxxxxxx.db --dbType=state Introduction
The keeper node sets the whitelist function. When creating a bucket, the nodes in the whitelist are given priority.
Usage
Copy mefs-keeper restrict -h
USAGE:
mefs-keeper restrict command [command options] [arguments...]
COMMANDS:
list list all accepted keepers/keepers
add add node ( s ) to restrict list
delete remove node ( s ) from restrict list
has test whether node ( s ) in restrict list
set enable/disable restrict
stat restrict stat ( enable/disable )
help, h Shows a list of commands or help for one command Subcommands
4.3.1 list
Introduction
View whitelist node
Example
View the nodes in the whitelist
Copy mefs-keeper restrict list 4.3.2 add
Introduction
Add whitelist node
Example
Add keeper node to whitelist
Copy mefs-keeper restrict add PID The parameter PID is the keeper node ID to be added to the whitelist
4.3.3 delete
Introduction
delete whitelist node
Example
Delete whitelist nodes
Copy mefs-keeper restrict delete PID The parameter PID is the keeper node ID to be added to the whitelist
4.3.4 has
Introduction
Check whether the node is in the whitelist
Example
Check whether the node is in the current whitelist
mefs-keeper restrict has PID The parameter PID is the keeper node ID to be added to the whitelist
4.3.5 set
Introduction
Set whitelist status
Example
Enable the whitelist function
Copy mefs-keeper restrict set --enable Turn off the whitelist function
Copy mefs-keeper restrict set disable 4.3.6 stat
Introduction
Check whitelist status
Example
Check whitelist status
Copy mefs-keeper restrict stat Introduction
Query the value of the token file of the node. The token file is located in the root directory of the node. Ordinary keepers do not need to pay attention to this value.
Usage
Copy mefs-keeper auth info -h
USAGE:
mefs-keeper restrict command [command options] [arguments...]
COMMANDS:
list list all accepted keepers/keepers
add add node ( s ) to restrict list
delete remove node ( s ) from restrict list
has test whether node ( s ) in restrict list
set enable/disable restrict
stat restrict stat ( enable/disable )
help, h Shows a list of commands or help for one command Introduction
This command is used to set the log level. Different levels display log information of different alarm levels. The default is info level, which only displays normal status information. Ordinary keepers should use info log level. The debug/warn/error level is used by developers to view detailed error logs. This level will generate a large number of logs and cannot be in debug mode for a long time, otherwise it will take up a lot of disk space. It is not recommended for ordinary keepers to use.
Subcommands
5.2.1 setLevel
Usage
Copy mefs-keeper log setLevel -h
NAME:
mefs-keeper log setLevel - Set log level
USAGE:
mefs-keeper log setLevel [command options] [level (debug/info/warn/error)] Example
Copy mefs-keeper log setLevel debug 