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

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

View File

@ -297,8 +297,10 @@ type FullNode interface {
MpoolGetNonce(context.Context, address.Address) (uint64, error) //perm:read
MpoolSub(context.Context) (<-chan MpoolUpdate, error) //perm:read
// MpoolClear clears pending messages from the mpool
MpoolClear(context.Context, bool) error //perm:write
// 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.
MpoolClear(ctx context.Context, clearLocal bool) error //perm:write
// MpoolGetConfig returns (a copy of) the current mpool config
MpoolGetConfig(context.Context) (*types.MpoolConfig, error) //perm:read

Binary file not shown.

View File

@ -3941,7 +3941,9 @@ Response:
```
### 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