Provider Commandline Mannual

This article will introduce in detail the use of the command line function of the provider-Node of the MEMO system; the provider needs to download the binary and execute the program 'mefs-provider' to start a Memo provider-Node.

Usage

Use the following command to view all commands

mefs-provider -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

Example

The example sets the root directory of the node to: ~/.memo-provider

Introduction

The command is used to start and stop an provider-Node

Usage

Options

Example

Introduction

This command implements the related functions of operating the wallet.

Usage

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

2.3.4 wallet export

Introduction

Export the wallet's private key

Example

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

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

Options

Example

Configure the value of contract.endPoint

2.4.2 config get

Introduction

This command is used to get the value of the specified configuration item

Usage

Example

Get the contract.endPoint value

Introduction

This command is used to set the bootstrap node in the configuration file, multiple bootstrap nodes can be added.

Usage

Subcommands

2.5.1 list

Introduction

View the current node bootstrap node list

2.5.2 add

Introduction

Add a bootstrap node

Example

2.5.3 clear

Introduction

clear the bootstrap node

Introduction

Network related commands

Usage

Subcommands

3.1.1 info

Introduction

This command checks node network information

Usage

Example

'12D3K...' here is the peerID of this node.

3.1.2 peers

Introduction

Show the network information of all nodes currently connected.

Usage

3.1.3 connect

Introduction

This command connects to a specified node manually.

Usage

Note

About how to construction the multiaddr for a node.

First use the net info command to view the network information of the node.

And the multiaddr of this node is:

3.1.4 findpeer

Introduction

View node information according to peerID, command usage:

Usage

Example

3.1.5 declare

Introduction

Used for the provider node to declare its own public network ip address; (only the provider node needs to use this command)

Usage

Introduction

This command interacts with state db to obtain pay and penalty information about this node, or settle current income of this node.

Usage

Subcommands

3.2.1 post

This command is used to read from state db to show 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

3.4 info

Introduction

This command checks the basic information of this node

Usage

Options

Example

or

Introduction

Node pledge, withdrawal and other operations.

Usage

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

Example

To pledge 1 Memo for this node.

3.5.3 pledgeGet

Introduction

View the current pledge amount.

Example

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

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

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

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 providers and keepers, the role pledge amount provided when registering the role can be withdrawn after run quitRole.

Example

3.5.8 alterPayee

Introduction

alterPayee used to change the current payee.

Introduction

View current node version

Usage

Introduction

View order related information

Usage

Subcommands

3.7.1 list

Introductoion

List all users who has data stored in this provider.

Usage

3.7.2 payList

Introductoion

List all order status with provider nodes

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

Example

Repair state database

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

Example

Export the state database to the current directory

4.2.2 import

Introduciton

To import a database from a file, use the following method:

Usage

Example

import state database

Introduction

The provider node sets the whitelist function. When creating a bucket, the nodes in the whitelist are given priority.

Usage

Subcommands

4.3.1 list

Introduction

View whitelist node

Example

View the nodes in the whitelist

4.3.2 add

Introduction

Add whitelist node

Example

Add provider node to whitelist

The parameter PID is the provider node ID to be added to the whitelist

4.3.3 delete

Introduction

delete whitelist node

Example

Delete whitelist nodes

The parameter PID is the provider 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-provider restrict has PID The parameter PID is the provider node ID to be added to the whitelist

4.3.5 set

Introduction

Set whitelist status

Example

Enable the whitelist function

Turn off the whitelist function

4.3.6 stat

Introduction

Check whitelist status

Example

Check whitelist status

Introduction

Query the value of the token file of the node. The token file is located in the root directory of the node. Ordinary providers do not need to pay attention to this value.

Usage

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 providers 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 providers to use.

Subcommands

5.2.1 setLevel

Usage

Example

Last updated

Was this helpful?