Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(x/circuit): Update specific detail on x/circuit module document #22453

Merged
merged 4 commits into from
Nov 6, 2024
Merged

docs(x/circuit): Update specific detail on x/circuit module document #22453

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce5d585
update to specific detail on circuit module
GNaD13 Nov 6, 2024
759cbb3
nit
GNaD13 Nov 6, 2024
2ca603c
nit
GNaD13 Nov 6, 2024
88365dc
Merge branch 'main' into dang/readme-circuit-module
GNaD13 Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions x/circuit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down
Loading