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

docs: api: clarify MpoolClear params
filecoin-project · Mar 28, 2023 · 5aa6dd1 · 5aa6dd1
2 parents 2120fae + 8bb5d98
commit 5aa6dd1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/api/api_full.go b/api/api_full.go
@@ -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

diff --git a/build/openrpc/full.json.gz b/build/openrpc/full.json.gz
diff --git a/documentation/en/api-v1-unstable-methods.md b/documentation/en/api-v1-unstable-methods.md
@@ -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