Algod: Simulation run with extra budget per transaction group

cmd/goal/clerk.go

@@ -37,38 +37,42 @@ import (
 	"github.com/algorand/go-algorand/data/transactions"
 	"github.com/algorand/go-algorand/data/transactions/logic"
 	"github.com/algorand/go-algorand/data/transactions/verify"
+	"github.com/algorand/go-algorand/ledger/simulation"
 	"github.com/algorand/go-algorand/libgoal"
 	"github.com/algorand/go-algorand/protocol"
 
 	"github.com/spf13/cobra"
 )
 
 var (
-	toAddress                    string
-	account                      string
-	amount                       uint64
-	txFilename                   string
-	rejectsFilename              string
-	closeToAddress               string
-	noProgramOutput              bool
-	writeSourceMap               bool
-	signProgram                  bool
-	programSource                string
-	argB64Strings                []string
-	disassemble                  bool
-	verbose                      bool
-	progByteFile                 string
-	msigParams                   string
-	logicSigFile                 string
-	timeStamp                    int64
-	protoVersion                 string
-	rekeyToAddress               string
-	signerAddress                string
-	rawOutput                    bool
-	requestFilename              string
-	requestOutFilename           string
-	simulateAllowEmptySignatures bool
-	simulateAllowMoreLogging     bool
+	toAddress          string
+	account            string
+	amount             uint64
+	txFilename         string
+	rejectsFilename    string
+	closeToAddress     string
+	noProgramOutput    bool
+	writeSourceMap     bool
+	signProgram        bool
+	programSource      string
+	argB64Strings      []string
+	disassemble        bool
+	verbose            bool
+	progByteFile       string
+	msigParams         string
+	logicSigFile       string
+	timeStamp          int64
+	protoVersion       string
+	rekeyToAddress     string
+	signerAddress      string
+	rawOutput          bool
+	requestFilename    string
+	requestOutFilename string
+
+	simulateAllowEmptySignatures   bool
+	simulateAllowMoreLogging       bool
+	simulateAllowExtraOpcodeBudget bool
+	simulateExtraOpcodeBudget      uint64
 )
 
 func init() {
@@ -155,6 +159,8 @@ func init() {
 	simulateCmd.Flags().StringVarP(&outFilename, "result-out", "o", "", "Filename for writing simulation result")
 	simulateCmd.Flags().BoolVar(&simulateAllowEmptySignatures, "allow-empty-signatures", false, "Allow transactions without signatures to be simulated as if they had correct signatures")
 	simulateCmd.Flags().BoolVar(&simulateAllowMoreLogging, "allow-more-logging", false, "Lift the limits on log opcode during simulation")
+	simulateCmd.Flags().BoolVar(&simulateAllowExtraOpcodeBudget, "allow-extra-opcode-budget", false, "Apply max extra opcode budget for apps per transaction group (default 320000) during simulation")
+	simulateCmd.Flags().Uint64Var(&simulateExtraOpcodeBudget, "extra-opcode-budget", 0, "Apply extra opcode budget for apps per transaction group during simulation")
 }
 
 var clerkCmd = &cobra.Command{
@@ -1240,6 +1246,15 @@ var simulateCmd = &cobra.Command{
 			reportErrorf("exactly one of --txfile or --request must be provided")
 		}
 
+		allowExtraBudgetProvided := cmd.Flags().Changed("allow-extra-opcode-budget")
+		extraBudgetProvided := cmd.Flags().Changed("extra-opcode-budget")
+		if allowExtraBudgetProvided && extraBudgetProvided {
+			reportErrorf("--allow-extra-opcode-budget and --extra-opcode-budget are mutually exclusive")
+		}
+		if allowExtraBudgetProvided {
+			simulateExtraOpcodeBudget = simulation.MaxExtraOpcodeBudget
+		}
+
 		requestOutProvided := cmd.Flags().Changed("request-only-out")
 		resultOutProvided := cmd.Flags().Changed("result-out")
 		if requestOutProvided && resultOutProvided {
@@ -1261,6 +1276,7 @@ var simulateCmd = &cobra.Command{
 				},
 				AllowEmptySignatures: simulateAllowEmptySignatures,
 				AllowMoreLogging:     simulateAllowMoreLogging,
+				ExtraOpcodeBudget:    simulateExtraOpcodeBudget,
 			}
 			err := writeFile(requestOutFilename, protocol.EncodeJSON(simulateRequest), 0600)
 			if err != nil {
@@ -1283,6 +1299,7 @@ var simulateCmd = &cobra.Command{
 				},
 				AllowEmptySignatures: simulateAllowEmptySignatures,
 				AllowMoreLogging:     simulateAllowMoreLogging,
+				ExtraOpcodeBudget:    simulateExtraOpcodeBudget,
 			}
 			simulateResponse, responseErr = client.SimulateTransactions(simulateRequest)
 		} else {

daemon/algod/api/algod.oas2.json

@@ -3293,6 +3293,10 @@
         "allow-more-logging": {
           "description": "Lifts limits on log opcode usage during simulation.",
           "type": "boolean"
+        },
+        "extra-opcode-budget": {
+          "description": "Applies extra opcode budget during simulation for each transaction group.",
+          "type": "integer"
         }
       }
     },
@@ -3659,13 +3663,15 @@
         },
         "max-log-calls": {
           "description": "The maximum log calls one can make during simulation",
-          "type": "integer",
-          "x-algorand-format": "uint64"
+          "type": "integer"
         },
         "max-log-size": {
           "description": "The maximum byte number to log during simulation",
-          "type": "integer",
-          "x-algorand-format": "uint64"
+          "type": "integer"
+        },
+        "extra-opcode-budget": {
+          "description": "The extra opcode budget added to each transaction group during simulation",
+          "type": "integer"
         }
       }
     }

daemon/algod/api/algod.oas3.yml

@@ -1868,6 +1868,10 @@
             "description": "Lifts limits on log opcode usage during simulation.",
             "type": "boolean"
           },
+          "extra-opcode-budget": {
+            "description": "Applies extra opcode budget during simulation for each transaction group.",
+            "type": "integer"
+          },
           "txn-groups": {
             "description": "The transaction groups to simulate.",
             "items": {
@@ -1962,15 +1966,17 @@
             "description": "If true, transactions without signatures are allowed and simulated as if they were properly signed.",
             "type": "boolean"
           },
+          "extra-opcode-budget": {
+            "description": "The extra opcode budget added to each transaction group during simulation",
+            "type": "integer"
+          },
           "max-log-calls": {
             "description": "The maximum log calls one can make during simulation",
-            "type": "integer",
-            "x-algorand-format": "uint64"
+            "type": "integer"
           },
           "max-log-size": {
             "description": "The maximum byte number to log during simulation",
-            "type": "integer",
-            "x-algorand-format": "uint64"
+            "type": "integer"
           }
         },
         "type": "object"