update mpool documentation
This commit is contained in:
@@ -20,6 +20,7 @@ The full node API defines the following methods for interacting with the mpool:
|
|||||||
MpoolSub(context.Context) (<-chan MpoolUpdate, error)
|
MpoolSub(context.Context) (<-chan MpoolUpdate, error)
|
||||||
MpoolGetConfig(context.Context) (*types.MpoolConfig, error)
|
MpoolGetConfig(context.Context) (*types.MpoolConfig, error)
|
||||||
MpoolSetConfig(context.Context, *types.MpoolConfig) error
|
MpoolSetConfig(context.Context, *types.MpoolConfig) error
|
||||||
|
MpoolClear(context.Context) error
|
||||||
```
|
```
|
||||||
|
|
||||||
### MpoolPending
|
### MpoolPending
|
||||||
@@ -61,6 +62,12 @@ Returns (a copy of) the current mpool configuration.
|
|||||||
|
|
||||||
Sets the mpool configuration to (a copy of) the supplied configuration object.
|
Sets the mpool configuration to (a copy of) the supplied configuration object.
|
||||||
|
|
||||||
|
### MpoolClear
|
||||||
|
|
||||||
|
Unconditionally clears all pending messages from the mpool.
|
||||||
|
This should be used with extreme care and only in the case of errors during head changes that
|
||||||
|
would leave the mpool in an inconsistent state.
|
||||||
|
|
||||||
|
|
||||||
## Command Line Interfae
|
## Command Line Interfae
|
||||||
|
|
||||||
@@ -75,6 +82,7 @@ lotus mpool stat [--local]
|
|||||||
lotus mpool replace [--gas-feecap <feecap>] [--gas-premium <premium>] [--gas-limit <limit>] [from] [nonce]
|
lotus mpool replace [--gas-feecap <feecap>] [--gas-premium <premium>] [--gas-limit <limit>] [from] [nonce]
|
||||||
lotus mpool find [--from <address>] [--to <address>] [--method <int>]
|
lotus mpool find [--from <address>] [--to <address>] [--method <int>]
|
||||||
lotus mpool config [<configuration>]
|
lotus mpool config [<configuration>]
|
||||||
|
lotus mpool clear
|
||||||
```
|
```
|
||||||
|
|
||||||
### lotus mpool pending
|
### lotus mpool pending
|
||||||
@@ -98,6 +106,12 @@ Searches for messages in the mpool.
|
|||||||
### lotus mpool config
|
### lotus mpool config
|
||||||
Gets or sets the current mpool configuration.
|
Gets or sets the current mpool configuration.
|
||||||
|
|
||||||
|
### lotus mpool clear
|
||||||
|
Unconditionally clears all pending messages from the mpool.
|
||||||
|
|
||||||
|
*Warning*: this command should only be used in the case of head change errors leaving the mpool in an
|
||||||
|
inconsistent state.
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
The mpool a few parameters that can be configured by the user, either through the API
|
The mpool a few parameters that can be configured by the user, either through the API
|
||||||
|
|||||||
Reference in New Issue
Block a user