docs: add authz reference info in the circuit antehandler (backport #20146) (#20155)

mergify[bot] · reecepbcups · web-flow · commit 016389c75617 · 2024-04-23T12:09:29.000+02:00
Co-authored-by: Reece Williams &lt;31943163+Reecepbcups@users.noreply.github.com&gt;
diff --git a/x/circuit/ante/circuit.go b/x/circuit/ante/circuit.go
@@ -24,6 +24,10 @@ func NewCircuitBreakerDecorator(ck CircuitBreaker) CircuitBreakerDecorator {
 	}
 }
 
+// If you copy this as reference and your app has the authz module enabled, you must either:
+// - recursively check for nested authz.Exec messages in this function.
+// - or error early if a nested authz grant is found.
+// The circuit AnteHandler handles this with baseapp's service router: https://github.com/cosmos/cosmos-sdk/issues/18632.
 func (cbd CircuitBreakerDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error) {
 	// loop through all the messages and check if the message type is allowed
 	for _, msg := range tx.GetMsgs() {

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,10 @@ func NewCircuitBreakerDecorator(ck CircuitBreaker) CircuitBreakerDecorator {`
`24`	`24`	`}`
`25`	`25`	`}`
`26`	`26`
	`27`	`+// If you copy this as reference and your app has the authz module enabled, you must either:`
	`28`	`+// - recursively check for nested authz.Exec messages in this function.`
	`29`	`+// - or error early if a nested authz grant is found.`
	`30`	`+// The circuit AnteHandler handles this with baseapp's service router: https://github.com/cosmos/cosmos-sdk/issues/18632.`
`27`	`31`	`func (cbd CircuitBreakerDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error) {`
`28`	`32`	`// loop through all the messages and check if the message type is allowed`
`29`	`33`	`for _, msg := range tx.GetMsgs() {`