cerc-io/lotus
16
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 27 Wiki Activity

Merge pull request #10550 from filecoin-project/asr/api-comment

Browse Source 
docs: api: clarify MpoolClear params
This commit is contained in:
Łukasz Magiera 2023-03-28 09:50:46 +02:00 committed by GitHub
commit 5aa6dd100c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api/api_full.go
View File

@ -297,8 +297,10 @@ type FullNode interface {
MpoolGetNonce(context.Context, address.Address) (uint64, error) //perm:read MpoolGetNonce(context.Context, address.Address) (uint64, error) //perm:read
MpoolSub(context.Context) (<-chan MpoolUpdate, error) //perm:read MpoolSub(context.Context) (<-chan MpoolUpdate, error) //perm:read
// MpoolClear clears pending messages from the mpool // MpoolClear clears pending messages from the mpool.
MpoolClear(context.Context, bool) error //perm:write // If clearLocal is true, ALL messages will be cleared.
// If clearLocal is false, local messages will be protected, all others will be cleared.
MpoolClear(ctx context.Context, clearLocal bool) error //perm:write
// MpoolGetConfig returns (a copy of) the current mpool config // MpoolGetConfig returns (a copy of) the current mpool config
MpoolGetConfig(context.Context) (*types.MpoolConfig, error) //perm:read MpoolGetConfig(context.Context) (*types.MpoolConfig, error) //perm:read

BIN
build/openrpc/full.json.gz
View File

Binary file not shown.

4
documentation/en/api-v1-unstable-methods.md
View File

@ -3941,7 +3941,9 @@ Response:
``` ```
### MpoolClear ### MpoolClear
MpoolClear clears pending messages from the mpool MpoolClear clears pending messages from the mpool.
If clearLocal is true, ALL messages will be cleared.
If clearLocal is false, local messages will be protected, all others will be cleared.
Perms: write Perms: write