Simulate: Allow unnamed foreign resource access

cmd/goal/clerk.go

@@ -74,10 +74,11 @@
 	simulateAllowMoreOpcodeBudget bool
 	simulateExtraOpcodeBudget     uint64
 
-	simulateFullTrace          bool
-	simulateEnableRequestTrace bool
-	simulateStackChange        bool
-	simulateScratchChange      bool
+	simulateFullTrace             bool
+	simulateEnableRequestTrace    bool
+	simulateStackChange           bool
+	simulateScratchChange         bool
+	simulateAllowUnnamedResources bool
 )
 
 func init() {
@@ -171,6 +172,7 @@
 	simulateCmd.Flags().BoolVar(&simulateEnableRequestTrace, "trace", false, "Enable simulation time execution trace of app calls")
 	simulateCmd.Flags().BoolVar(&simulateStackChange, "stack", false, "Report stack change during simulation time")
 	simulateCmd.Flags().BoolVar(&simulateScratchChange, "scratch", false, "Report scratch change during simulation time")
+	simulateCmd.Flags().BoolVar(&simulateAllowUnnamedResources, "allow-unnamed-resources", false, "Allow access to unnamed resources during simulation")
 }
 
 var clerkCmd = &cobra.Command{
@@ -1281,10 +1283,11 @@
 						Txns: txgroup,
 					},
 				},
-				AllowEmptySignatures: simulateAllowEmptySignatures,
-				AllowMoreLogging:     simulateAllowMoreLogging,
-				ExtraOpcodeBudget:    simulateExtraOpcodeBudget,
-				ExecTraceConfig:      traceCmdOptionToSimulateTraceConfigModel(),
+				AllowEmptySignatures:  simulateAllowEmptySignatures,
+				AllowMoreLogging:      simulateAllowMoreLogging,
+				AllowUnnamedResources: simulateAllowUnnamedResources,
+				ExtraOpcodeBudget:     simulateExtraOpcodeBudget,
+				ExecTraceConfig:       traceCmdOptionToSimulateTraceConfigModel(),
 			}
 			err := writeFile(requestOutFilename, protocol.EncodeJSON(simulateRequest), 0600)
 			if err != nil {
@@ -1305,10 +1308,11 @@
 						Txns: txgroup,
 					},
 				},
-				AllowEmptySignatures: simulateAllowEmptySignatures,
-				AllowMoreLogging:     simulateAllowMoreLogging,
-				ExtraOpcodeBudget:    simulateExtraOpcodeBudget,
-				ExecTraceConfig:      traceCmdOptionToSimulateTraceConfigModel(),
+				AllowEmptySignatures:  simulateAllowEmptySignatures,
+				AllowMoreLogging:      simulateAllowMoreLogging,
+				AllowUnnamedResources: simulateAllowUnnamedResources,
+				ExtraOpcodeBudget:     simulateExtraOpcodeBudget,
+				ExecTraceConfig:       traceCmdOptionToSimulateTraceConfigModel(),
 			}
 			simulateResponse, responseErr = client.SimulateTransactions(simulateRequest)
 		} else {

daemon/algod/api/algod.oas2.json

@@ -3093,6 +3093,46 @@
         }
       }
     },
+    "AssetHoldingReference": {
+      "description": "References an asset held by an account.",
+      "type": "object",
+      "required": [
+        "account",
+        "asset"
+      ],
+      "properties": {
+        "account": {
+          "description": "Address of the account holding the asset.",
+          "type": "string",
+          "x-algorand-format": "Address"
+        },
+        "asset": {
+          "description": "Asset ID of the holding.",
+          "type": "integer",
+          "x-algorand-format": "uint64"
+        }
+      }
+    },
+    "ApplicationLocalReference": {
+      "description": "References an account's local state for an application.",
+      "type": "object",
+      "required": [
+        "account",
+        "app"
+      ],
+      "properties": {
+        "account": {
+          "description": "Address of the account with the local state.",
+          "type": "string",
+          "x-algorand-format": "Address"
+        },
+        "app": {
+          "description": "Application ID of the local state application.",
+          "type": "integer",
+          "x-algorand-format": "uint64"
+        }
+      }
+    },
     "ApplicationStateSchema": {
       "description": "Specifies maximums on the number of each type that may be stored.",
       "type": "object",
@@ -3590,13 +3630,17 @@
           }
         },
         "allow-empty-signatures": {
-          "description": "Allow transactions without signatures to be simulated as if they had correct signatures.",
+          "description": "Allows transactions without signatures to be simulated as if they had correct signatures.",
           "type": "boolean"
         },
         "allow-more-logging": {
           "description": "Lifts limits on log opcode usage during simulation.",
           "type": "boolean"
         },
+        "allow-unnamed-resources": {
+          "description": "Allows access to unnamed resources during simulation.",
+          "type": "boolean"
+        },
         "extra-opcode-budget": {
           "description": "Applies extra opcode budget during simulation for each transaction group.",
           "type": "integer"
@@ -3682,6 +3726,25 @@
         }
       }
     },
+    "BoxReference": {
+      "description": "References a box of an application.",
+      "type": "object",
+      "required": [
+        "app",
+        "name"
+      ],
+      "properties": {
+        "app": {
+          "description": "Application ID which this box belongs to",
+          "type": "integer"
+        },
+        "name": {
+          "description": "Base64 encoded box name",
+          "type": "string",
+          "format": "byte"
+        }
+      }
+    },
     "KvDelta": {
       "description": "A single Delta containing the key, the previous value and the current value for a single round.",
       "type": "object",
@@ -3874,6 +3937,9 @@
         "app-budget-consumed": {
           "description": "Total budget consumed during execution of app calls in the transaction group.",
           "type": "integer"
+        },
+        "unnamed-resources-accessed": {
+          "$ref": "#/definitions/SimulateUnnamedResourcesAccessed"
         }
       }
     },
@@ -3897,6 +3963,9 @@
         },
         "exec-trace": {
           "$ref": "#/definitions/SimulationTransactionExecTrace"
+        },
+        "unnamed-resources-accessed": {
+          "$ref": "#/definitions/SimulateUnnamedResourcesAccessed"
         }
       }
     },
@@ -3988,6 +4057,10 @@
           "description": "If true, transactions without signatures are allowed and simulated as if they were properly signed.",
           "type": "boolean"
         },
+        "allow-unnamed-resources": {
+          "description": "If true, allows access to unnamed resources during simulation.",
+          "type": "boolean"
+        },
         "max-log-calls": {
           "description": "The maximum log calls one can make during simulation",
           "type": "integer"
@@ -4090,6 +4163,61 @@
           }
         }
       }
+    },
+    "SimulateUnnamedResourcesAccessed": {
+      "description": "These are resources that were accessed by this group that would normally have caused failure, but were allowed in simulation. Depending on where this object is in the response, the unnamed resources it contains may or may not qualify for group resource sharing. If this is a field in SimulateTransactionGroupResult, the resources do qualify, but if this is a field in SimulateTransactionResult, they do not qualify. In order to make this group valid for actual submission, resources that qualify for group sharing can be made available by any transaction of the group; otherwise, resources must be placed in the same transaction which accessed them.",
+      "type": "object",
+      "properties": {
+        "accounts": {
+          "description": "The unnamed accounts that were referenced. The order of this array is arbitrary.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "x-algorand-format": "Address"
+          }
+        },
+        "assets": {
+          "description": "The unnamed assets that were referenced. The order of this array is arbitrary.",
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "x-algorand-format": "uint64"
+          }
+        },
+        "apps": {
+          "description": "The unnamed applications that were referenced. The order of this array is arbitrary.",
+          "type": "array",
+          "items": {
+            "type": "integer",
+            "x-algorand-format": "uint64"
+          }
+        },
+        "boxes": {
+          "description": "The unnamed boxes that were referenced. The order of this array is arbitrary.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/BoxReference"
+          }
+        },
+        "extra-box-refs": {
+          "description": "The number of extra box references used to increase the IO budget. This is in addition to the references defined in the input transaction group and any referenced to unnamed boxes.",
+          "type": "integer"
+        },
+        "asset-holdings": {
+          "description": "The unnamed asset holdings that were referenced. The order of this array is arbitrary.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/AssetHoldingReference"
+          }
+        },
+        "app-locals": {
+          "description": "The unnamed application local states that were referenced. The order of this array is arbitrary.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ApplicationLocalReference"
+          }
+        }
+      }
     }
   },
   "parameters": {