Algod: Replace logic.DebuggerHook with logic.EvalTracer interface

cmd/tealdbg/debugger_test.go

@@ -102,7 +102,7 @@ func TestDebuggerSimple(t *testing.T) {
 	debugger.AddAdapter(da)
 
 	ep := logic.NewEvalParams(make([]transactions.SignedTxnWithAD, 1), &proto, nil)
-	ep.Debugger = debugger
+	ep.Debugger = logic.MakeLegacyDebuggerAdaptor(debugger)
 	ep.SigLedger = logic.NoHeaderLedger{}
 
 	source := `int 0

cmd/tealdbg/local.go

@@ -536,7 +536,7 @@ func (r *LocalRunner) RunAll() error {
 		// ep.Debugger = r.debugger
 		// if ep.Debugger != nil // FALSE
 		if r.debugger != nil {
-			ep.Debugger = r.debugger
+			ep.Debugger = logic.MakeLegacyDebuggerAdaptor(r.debugger)
 		}
 	}
 

config/localTemplate.go

@@ -452,6 +452,9 @@ type Local struct {
 	// MaxAcctLookback sets the maximum lookback range for account states,
 	// i.e. the ledger can answer account states questions for the range Latest-MaxAcctLookback...Latest
 	MaxAcctLookback uint64 `version[23]:"4"`
+
+	// EnableTransactionSimulator enables the simulation API endpoint.
+	EnableTransactionSimulator bool `version[23]:"false"`
 }
 
 // DNSBootstrapArray returns an array of one or more DNS Bootstrap identifiers

config/local_defaults.go

@@ -70,6 +70,7 @@ var defaultLocal = Local{
 	EnableRequestLogger:                        false,
 	EnableRuntimeMetrics:                       false,
 	EnableTopAccountsReporting:                 false,
+	EnableTransactionSimulator:                 false,
 	EnableVerbosedTransactionSyncLogging:       false,
 	EndpointAddress:                            "127.0.0.1:0",
 	FallbackDNSResolverAddress:                 "",

crypto/merklesignature/committablePublicKeys.go

@@ -34,7 +34,7 @@ type (
 		keyLifetime uint64
 	}
 
-	// CommittablePublicKey  is used to create a binary representation of public keys in the merkle
+	// CommittablePublicKey is used to create a binary representation of public keys in the merkle
 	// signature scheme.
 	CommittablePublicKey struct {
 		VerifyingKey crypto.FalconVerifier

daemon/algod/api/algod.oas2.json

@@ -1096,6 +1096,65 @@
         }
       }
     },
+    "/v2/transactions/simulate": {
+      "post": {
+        "consumes": [
+          "application/x-binary"
+        ],
+        "produces": [
+          "application/msgpack"
+        ],
+        "schemes": [
+          "http"
+        ],
+        "summary": "Simulates a raw transaction as it would be evaluated on the network.",
+        "operationId": "SimulateTransaction",
+        "parameters": [
+          {
+            "description": "The byte encoded transaction to simulate",
+            "name": "rawtxn",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "format": "binary"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "$ref": "#/responses/SimulationResponse"
+          },
+          "400": {
+            "description": "Bad Request - Malformed Algorand transaction",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          },
+          "401": {
+            "description": "Invalid API Token",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          },
+          "500": {
+            "description": "Internal Error",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          },
+          "503": {
+            "description": "Service Temporarily Unavailable",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          },
+          "default": {
+            "description": "Unknown Error"
+          }
+        }
+      }
+    },
     "/v2/transactions/params": {
       "get": {
         "produces": [
@@ -3237,6 +3296,26 @@
         }
       }
     },
+    "SimulationResponse": {
+      "description": "Result of a transaction group simulation.",
+      "schema": {
+        "type": "object",
+        "required": [
+          "failure-message",
+          "missing-signatures"
+        ],
+        "properties": {
+          "failure-message": {
+            "description": "\\[fm\\] Failure message, if the transaction would have failed during a live broadcast.",
+            "type": "string"
+          },
+          "missing-signatures": {
+            "description": "\\[ms\\] Whether any transactions would have failed during a live broadcast because they were missing signatures.",
+            "type": "boolean"
+          }
+        }
+      }
+    },
     "SupplyResponse": {
       "description": "Supply represents the current supply of MicroAlgos in the system.",
       "schema": {

daemon/algod/api/algod.oas3.yml

@@ -630,6 +630,30 @@
         },
         "description": "Transaction ID of the submission."
       },
+      "SimulationResponse": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "properties": {
+                "failure-message": {
+                  "description": "\\[fm\\] Failure message, if the transaction would have failed during a live broadcast.",
+                  "type": "string"
+                },
+                "missing-signatures": {
+                  "description": "\\[ms\\] Whether any transactions would have failed during a live broadcast because they were missing signatures.",
+                  "type": "boolean"
+                }
+              },
+              "required": [
+                "failure-message",
+                "missing-signatures"
+              ],
+              "type": "object"
+            }
+          }
+        },
+        "description": "Result of a transaction group simulation."
+      },
       "StateProofResponse": {
         "content": {
           "application/json": {
@@ -4586,6 +4610,95 @@
         "summary": "Get a specific pending transaction."
       }
     },
+    "/v2/transactions/simulate": {
+      "post": {
+        "operationId": "SimulateTransaction",
+        "requestBody": {
+          "content": {
+            "application/x-binary": {
+              "schema": {
+                "format": "binary",
+                "type": "string"
+              }
+            }
+          },
+          "description": "The byte encoded transaction to simulate",
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/msgpack": {
+                "schema": {
+                  "properties": {
+                    "failure-message": {
+                      "description": "\\[fm\\] Failure message, if the transaction would have failed during a live broadcast.",
+                      "type": "string"
+                    },
+                    "missing-signatures": {
+                      "description": "\\[ms\\] Whether any transactions would have failed during a live broadcast because they were missing signatures.",
+                      "type": "boolean"
+                    }
+                  },
+                  "required": [
+                    "failure-message",
+                    "missing-signatures"
+                  ],
+                  "type": "object"
+                }
+              }
+            },
+            "description": "Result of a transaction group simulation."
+          },
+          "400": {
+            "content": {
+              "application/msgpack": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Bad Request - Malformed Algorand transaction"
+          },
+          "401": {
+            "content": {
+              "application/msgpack": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Invalid API Token"
+          },
+          "500": {
+            "content": {
+              "application/msgpack": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Internal Error"
+          },
+          "503": {
+            "content": {
+              "application/msgpack": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Service Temporarily Unavailable"
+          },
+          "default": {
+            "content": {},
+            "description": "Unknown Error"
+          }
+        },
+        "summary": "Simulates a raw transaction as it would be evaluated on the network.",
+        "x-codegen-request-body-name": "rawtxn"
+      }
+    },
     "/versions": {
       "get": {
         "description": "Retrieves the supported API versions, binary build versions, and genesis information.",

daemon/algod/api/server/v2/dryrun.go

@@ -181,22 +181,22 @@ func (ddr *dryrunDebugReceiver) stateToState(state *logic.DebugState) generated.
 	return st
 }
 
-// Register is fired on program creation (DebuggerHook interface)
+// Register is fired on program creation (LegacyDebuggerHook interface)
 func (ddr *dryrunDebugReceiver) Register(state *logic.DebugState) error {
 	ddr.disassembly = state.Disassembly
 	ddr.lines = strings.Split(state.Disassembly, "\n")
 	return nil
 }
 
-// Update is fired on every step (DebuggerHook interface)
+// Update is fired on every step (LegacyDebuggerHook interface)
 func (ddr *dryrunDebugReceiver) Update(state *logic.DebugState) error {
 	st := ddr.stateToState(state)
 	ddr.history = append(ddr.history, st)
 	ddr.updateScratch()
 	return nil
 }
 
-// Complete is called when the program exits (DebuggerHook interface)
+// Complete is called when the program exits (LegacyDebuggerHook interface)
 func (ddr *dryrunDebugReceiver) Complete(state *logic.DebugState) error {
 	return ddr.Update(state)
 }
@@ -417,7 +417,7 @@ func doDryrunRequest(dr *DryrunRequest, response *generated.DryrunResponse) {
 		var result generated.DryrunTxnResult
 		if len(stxn.Lsig.Logic) > 0 {
 			var debug dryrunDebugReceiver
-			ep.Debugger = &debug
+			ep.Debugger = logic.MakeLegacyDebuggerAdaptor(&debug)
 			ep.SigLedger = &dl
 			pass, err := logic.EvalSignature(ti, ep)
 			var messages []string
@@ -501,7 +501,7 @@ func doDryrunRequest(dr *DryrunRequest, response *generated.DryrunResponse) {
 				messages[0] = fmt.Sprintf("uploaded state did not include app id %d referenced in txn[%d]", appIdx, ti)
 			} else {
 				var debug dryrunDebugReceiver
-				ep.Debugger = &debug
+				ep.Debugger = logic.MakeLegacyDebuggerAdaptor(&debug)
 				var program []byte
 				messages = make([]string, 1)
 				if stxn.Txn.OnCompletion == transactions.ClearStateOC {