Merge pull request #443 from algorandfoundation/feat/dynamic_scratch_slot

fix: increment scratch slots

Author: joe-p

src/lib/compiler.ts

@@ -3580,6 +3580,23 @@ export default class Compiler {
         storageName = getStorageName(node.getExpression() as ts.PropertyAccessExpression);
       } else storageName = getStorageName(node);
 
+      if (this.scratch[storageName!]) {
+        const scratch = this.scratch[storageName!];
+        const { slot, type } = scratch;
+
+        typeComparison(this.lastType, type);
+        if (slot !== undefined) {
+          this.pushVoid(node, `store ${slot}`);
+        } else {
+          const call = node.getDescendantsOfKind(ts.SyntaxKind.CallExpression)[0];
+
+          this.processNode(call.getArguments()[0]);
+          this.pushVoid(node, 'swap');
+          this.pushVoid(node, `stores`);
+        }
+
+        return;
+      }
       const storageProp = this.storageProps[storageName!];
 
       const { type, valueType } = storageProp;
@@ -4545,7 +4562,7 @@ export default class Compiler {
           .getFirstChild()
           ?.getType()
           .getText()
-          .match(/(Box|LocalState|GlobalState)Value/);
+          .match(/(Scratch|Box|LocalState|GlobalState)Value/);
 
         const isExprChain =
           leftNode.isKind(ts.SyntaxKind.ElementAccessExpression) ||

tests/contracts/artifacts/GeneralTest.approval.teal

@@ -2238,6 +2238,73 @@ dynamicScratchSlot:
 	assert
 	retsub
 
+// incrementScratchSlot()void
+*abi_route_incrementScratchSlot:
+	// execute incrementScratchSlot()void
+	callsub incrementScratchSlot
+	int 1
+	return
+
+// incrementScratchSlot(): void
+incrementScratchSlot:
+	proto 0 0
+
+	// tests/contracts/general.algo.ts:448
+	// this.scratch.value = 1337
+	int 1337
+	store 0
+
+	// tests/contracts/general.algo.ts:449
+	// this.scratch.value += 1
+	load 0
+	int 1
+	+
+	store 0
+
+	// tests/contracts/general.algo.ts:450
+	// assert(this.scratch.value === 1338)
+	load 0
+	int 1338
+	==
+	assert
+	retsub
+
+// incrementDynamicScratchSlot()void
+*abi_route_incrementDynamicScratchSlot:
+	// execute incrementDynamicScratchSlot()void
+	callsub incrementDynamicScratchSlot
+	int 1
+	return
+
+// incrementDynamicScratchSlot(): void
+incrementDynamicScratchSlot:
+	proto 0 0
+
+	// tests/contracts/general.algo.ts:454
+	// this.dynamicScratch(2).value = 1337
+	int 2
+	int 1337
+	stores
+
+	// tests/contracts/general.algo.ts:455
+	// this.dynamicScratch(2).value += 1
+	int 2
+	loads
+	int 1
+	+
+	int 2
+	swap
+	stores
+
+	// tests/contracts/general.algo.ts:456
+	// assert(this.dynamicScratch(2).value === 1338)
+	int 2
+	loads
+	int 1338
+	==
+	assert
+	retsub
+
 *abi_route_createApplication:
 	int 1
 	return
@@ -2309,8 +2376,10 @@ dynamicScratchSlot:
 	method "staticValueLen(uint256)void"
 	method "staticTypeLen()void"
 	method "dynamicScratchSlot()void"
+	method "incrementScratchSlot()void"
+	method "incrementDynamicScratchSlot()void"
 	txna ApplicationArgs 0
-	match *abi_route_txnTypeEnum *abi_route_txnGroupLength *abi_route_asserts *abi_route_verifyTxnFromArg *abi_route_verifyTxnFromTxnGroup *abi_route_verifyTxnCondition *abi_route_verifyTxnIncludedIn *abi_route_verifyTxnNotIncludedIn *abi_route_submitPendingGroup *abi_route_methodWithTxnArgs *abi_route_shift *abi_route_fromBytes *abi_route_fromUint64 *abi_route_bzeroFunction *abi_route_events *abi_route_letOptimization *abi_route_staticContractProperties *abi_route_numberToString *abi_route_methodOnParens *abi_route_stringSubstring *abi_route_idProperty *abi_route_scratchSlot *abi_route_ecdsa *abi_route_verifyTxnTypes *abi_route_stringPlusEquals *abi_route_importedProgram *abi_route_callPrivateDefinedLater *abi_route_interalPublicMethod *abi_route_callInternalPublicMethod *abi_route_appLoadScratch *abi_route_uintNWithUnderscore *abi_route_opUp *abi_route_returnValueOnAssignment *abi_route_returnArrayValueOnAssignment *abi_route_returnStorageValueOnAssignment *abi_route_returnOperatorAssignmentValue *abi_route_returnArrayValueOnOperatorAssignment *abi_route_returnArrayInStorageValueOnOperatorAssignment *abi_route_consts *abi_route_assertWithMessage *abi_route_opcodeAliases *abi_route_vrfVerifyOp *abi_route_ecMath *abi_route_gitxn *abi_route_getSetBytes *abi_route_getSetUint64 *abi_route_blockOp *abi_route_b64 *abi_route_json *abi_route_bitlenOp *abi_route_computedConst *abi_route_multiComputedConst *abi_route_computedConstAsStaticArrayLength *abi_route_readSchema *abi_route_comparisonOr *abi_route_txnArgsMethod *abi_route_callTxnArgsMethod *abi_route_staticValueLen *abi_route_staticTypeLen *abi_route_dynamicScratchSlot
+	match *abi_route_txnTypeEnum *abi_route_txnGroupLength *abi_route_asserts *abi_route_verifyTxnFromArg *abi_route_verifyTxnFromTxnGroup *abi_route_verifyTxnCondition *abi_route_verifyTxnIncludedIn *abi_route_verifyTxnNotIncludedIn *abi_route_submitPendingGroup *abi_route_methodWithTxnArgs *abi_route_shift *abi_route_fromBytes *abi_route_fromUint64 *abi_route_bzeroFunction *abi_route_events *abi_route_letOptimization *abi_route_staticContractProperties *abi_route_numberToString *abi_route_methodOnParens *abi_route_stringSubstring *abi_route_idProperty *abi_route_scratchSlot *abi_route_ecdsa *abi_route_verifyTxnTypes *abi_route_stringPlusEquals *abi_route_importedProgram *abi_route_callPrivateDefinedLater *abi_route_interalPublicMethod *abi_route_callInternalPublicMethod *abi_route_appLoadScratch *abi_route_uintNWithUnderscore *abi_route_opUp *abi_route_returnValueOnAssignment *abi_route_returnArrayValueOnAssignment *abi_route_returnStorageValueOnAssignment *abi_route_returnOperatorAssignmentValue *abi_route_returnArrayValueOnOperatorAssignment *abi_route_returnArrayInStorageValueOnOperatorAssignment *abi_route_consts *abi_route_assertWithMessage *abi_route_opcodeAliases *abi_route_vrfVerifyOp *abi_route_ecMath *abi_route_gitxn *abi_route_getSetBytes *abi_route_getSetUint64 *abi_route_blockOp *abi_route_b64 *abi_route_json *abi_route_bitlenOp *abi_route_computedConst *abi_route_multiComputedConst *abi_route_computedConstAsStaticArrayLength *abi_route_readSchema *abi_route_comparisonOr *abi_route_txnArgsMethod *abi_route_callTxnArgsMethod *abi_route_staticValueLen *abi_route_staticTypeLen *abi_route_dynamicScratchSlot *abi_route_incrementScratchSlot *abi_route_incrementDynamicScratchSlot
 	err
 
 *intToAscii:

tests/contracts/artifacts/GeneralTest.arc32.json

@@ -478,6 +478,20 @@
         "type": "void"
       }
     },
+    {
+      "name": "incrementScratchSlot",
+      "args": [],
+      "returns": {
+        "type": "void"
+      }
+    },
+    {
+      "name": "incrementDynamicScratchSlot",
+      "args": [],
+      "returns": {
+        "type": "void"
+      }
+    },
     {
       "name": "createApplication",
       "args": [],

tests/contracts/artifacts/GeneralTest.arc4.json

@@ -443,4 +443,16 @@ class GeneralTest extends Contract {
     this.dynamicScratch(1).value = 1337;
     assert(this.dynamicScratch(1).value === 1337);
   }
+
+  incrementScratchSlot(): void {
+    this.scratch.value = 1337;
+    this.scratch.value += 1;
+    assert(this.scratch.value === 1338);
+  }
+
+  incrementDynamicScratchSlot(): void {
+    this.dynamicScratch(2).value = 1337;
+    this.dynamicScratch(2).value += 1;
+    assert(this.dynamicScratch(2).value === 1338);
+  }
 }

tests/contracts/general.algo.ts

@@ -36,6 +36,8 @@ describe('General', function () {
       'callInternalPublicMethod',
       'opUp',
       'dynamicScratchSlot',
+      'incrementScratchSlot',
+      'incrementDynamicScratchSlot',
     ].forEach((method) => {
       test(method, async function () {
         const { appClient } = await compileAndCreate(await sender, PATH, ARTIFACTS_DIR, NAME);