From 84f29c8d4af47639c1904bafaa2a670ce60f43f8 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 19:53:44 +0100 Subject: [PATCH] docs(x/circuit): Update specific detail on x/circuit module document (backport #22453) (#22456) Co-authored-by: GnaD <89174180+GNaD13@users.noreply.github.com> --- x/circuit/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/x/circuit/README.md b/x/circuit/README.md index 0a8d3ee955..4b70367df3 100644 --- a/x/circuit/README.md +++ b/x/circuit/README.md @@ -79,7 +79,7 @@ Authorize, is called by the module authority (default governance module account) ### Trip -Trip, is called by an authorized account to disable message execution for a specific msgURL. If empty, all the msgs will be disabled. +Trip, is called by an authorized account to disable message execution for a specific msgURL. If empty, depending on the permission level of the sender, the corresponding messages will be disabled. For example: if the sender permission level is `LEVEL_SOME_MSGS` then all messages that sender has permission will be disabled. If the sender is `LEVEL_SUPER_ADMIN` or `LEVEL_ALL_MSGS` then all msgs will be disabled. ```protobuf // TripCircuitBreaker pauses processing of Msg's in the state machine. @@ -88,7 +88,7 @@ Trip, is called by an authorized account to disable message execution for a spec ### Reset -Reset is called by an authorized account to enable execution for a specific msgURL of previously disabled message. If empty, all the disabled messages will be enabled. +Reset is called by an authorized account to enable execution for a specific msgURL of previously disabled message. If empty, depending on the permission level of the sender, the corresponding disabled messages will be re-enabled. For example: if the sender permission level is `LEVEL_SOME_MSGS` all messages that sender has permission will be re-enabled. If the sender is `LEVEL_SUPER_ADMIN` or `LEVEL_ALL_MSGS` then all messages will be re-enabled. ```protobuf // ResetCircuitBreaker resumes processing of Msg's in the state machine that