fix(avm-simulator): fix env getters (#6357)

AztecProtocol · May 15, 2024 · f3a540b · f3a540b
1 parent 57ba0d5
commit f3a540b
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 101 deletions.
diff --git a/docs/docs/protocol-specs/public-vm/gen/_instruction-set.mdx b/docs/docs/protocol-specs/public-vm/gen/_instruction-set.mdx
@@ -800,7 +800,7 @@ Get the address of the currently executing l2 contract
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.address`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/ADDRESS.png)](/img/protocol-specs/public-vm/bit-formats/ADDRESS.png)
@@ -818,7 +818,7 @@ Get the _storage_ address of the currently executing context
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.storageAddress`
 - **Details**: The storage address is used for public storage accesses.
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/STORAGEADDRESS.png)](/img/protocol-specs/public-vm/bit-formats/STORAGEADDRESS.png)
@@ -835,7 +835,7 @@ Get the address of the sender (caller of the current context)
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.sender`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/SENDER.png)](/img/protocol-specs/public-vm/bit-formats/SENDER.png)
@@ -852,7 +852,7 @@ Get the fee to be paid per "L2 gas" - constant for entire transaction
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.feePerL2Gas`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/FEEPERL2GAS.png)](/img/protocol-specs/public-vm/bit-formats/FEEPERL2GAS.png)
@@ -869,7 +869,7 @@ Get the fee to be paid per "DA gas" - constant for entire transaction
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.feePerDaGas`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/FEEPERDAGAS.png)](/img/protocol-specs/public-vm/bit-formats/FEEPERDAGAS.png)
@@ -886,7 +886,7 @@ Get the computed transaction fee during teardown phase, zero otherwise
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.transactionFee`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 
@@ -903,7 +903,7 @@ Get how many contract calls deep the current call context is
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.contractCallDepth`
 - **Details**: Note: security issues with EVM's tx.origin can be resolved by asserting `calldepth == 0`.
-- **Tag updates**: `T[dstOffset] = u8`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/CONTRACTCALLDEPTH.png)](/img/protocol-specs/public-vm/bit-formats/CONTRACTCALLDEPTH.png)
@@ -920,7 +920,7 @@ Get this rollup's L1 chain ID
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.globals.chainId`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/CHAINID.png)](/img/protocol-specs/public-vm/bit-formats/CHAINID.png)
@@ -937,7 +937,7 @@ Get this rollup's L2 version ID
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.globals.version`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/VERSION.png)](/img/protocol-specs/public-vm/bit-formats/VERSION.png)
@@ -954,7 +954,7 @@ Get this L2 block's number
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.globals.blocknumber`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/BLOCKNUMBER.png)](/img/protocol-specs/public-vm/bit-formats/BLOCKNUMBER.png)
@@ -988,7 +988,7 @@ Get the block's beneficiary address
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.globals.coinbase`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/COINBASE.png)](/img/protocol-specs/public-vm/bit-formats/COINBASE.png)
@@ -1005,7 +1005,7 @@ Total amount of "L2 gas" that a block can consume
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.globals.l2GasLimit`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/BLOCKL2GASLIMIT.png)](/img/protocol-specs/public-vm/bit-formats/BLOCKL2GASLIMIT.png)
@@ -1022,7 +1022,7 @@ Total amount of "DA gas" that a block can consume
 - **Args**: 
 	- **dstOffset**: memory offset specifying where to store operation's result
 - **Expression**: `M[dstOffset] = context.environment.globals.daGasLimit`
-- **Tag updates**: `T[dstOffset] = u32`
+- **Tag updates**: `T[dstOffset] = field`
 - **Bit-size**: 56
 
 [![](/img/protocol-specs/public-vm/bit-formats/BLOCKDAGASLIMIT.png)](/img/protocol-specs/public-vm/bit-formats/BLOCKDAGASLIMIT.png)

diff --git a/docs/src/preprocess/InstructionSet/InstructionSet.js b/docs/src/preprocess/InstructionSet/InstructionSet.js
@@ -511,7 +511,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get the address of the currently executing l2 contract",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "storageaddress",
@@ -529,7 +529,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get the _storage_ address of the currently executing context",
     Details: "The storage address is used for public storage accesses.",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "sender",
@@ -547,7 +547,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get the address of the sender (caller of the current context)",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "feeperl2gas",
@@ -566,7 +566,7 @@ const INSTRUCTION_SET_RAW = [
       'Get the fee to be paid per "L2 gas" - constant for entire transaction',
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "feeperdagas",
@@ -585,7 +585,7 @@ const INSTRUCTION_SET_RAW = [
       'Get the fee to be paid per "DA gas" - constant for entire transaction',
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "transactionfee",
@@ -604,7 +604,7 @@ const INSTRUCTION_SET_RAW = [
       "Get the computed transaction fee during teardown phase, zero otherwise",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "contractcalldepth",
@@ -623,7 +623,7 @@ const INSTRUCTION_SET_RAW = [
     Details:
       "Note: security issues with EVM's tx.origin can be resolved by asserting `calldepth == 0`.",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u8`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "chainid",
@@ -641,7 +641,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get this rollup's L1 chain ID",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "version",
@@ -659,7 +659,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get this rollup's L2 version ID",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "blocknumber",
@@ -677,7 +677,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get this L2 block's number",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "timestamp",
@@ -713,7 +713,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: "Get the block's beneficiary address",
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "blockl2gaslimit",
@@ -731,7 +731,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: 'Total amount of "L2 gas" that a block can consume',
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "blockdagaslimit",
@@ -749,7 +749,7 @@ const INSTRUCTION_SET_RAW = [
     Summary: 'Total amount of "DA gas" that a block can consume',
     Details: "",
     "Tag checks": "",
-    "Tag updates": "`T[dstOffset] = u32`",
+    "Tag updates": "`T[dstOffset] = field`",
   },
   {
     id: "calldatacopy",
@@ -1549,7 +1549,8 @@ halt
       },
       {
         name: "dstOffset",
-        description: "memory offset specifying where the first limb of the radix-conversion result is stored.",
+        description:
+          "memory offset specifying where the first limb of the radix-conversion result is stored.",
       },
       {
         name: "radix",
@@ -1562,14 +1563,15 @@ halt
         description: "the number of limbs the word will be converted into.",
         type: "u32",
         mode: "immediate",
-      }
+      },
     ],
 
     Expression: `TBD: Storage of limbs and if T[dstOffset] is constrained to U8`,
     Summary: "Convert a word to an array of limbs in little-endian radix form",
-    Details: "The limbs will be stored in a contiguous memory block starting at `dstOffset`.",
+    Details:
+      "The limbs will be stored in a contiguous memory block starting at `dstOffset`.",
     "Tag checks": "`T[srcOffset] == field`",
-  }
+  },
 ];
 const INSTRUCTION_SET = INSTRUCTION_SET_RAW.map((instr) => {
   instr["Bit-size"] = instructionSize(instr);

diff --git a/noir-projects/aztec-nr/aztec/src/context/avm_context.nr b/noir-projects/aztec-nr/aztec/src/context/avm_context.nr
@@ -30,6 +30,7 @@ impl AvmContext {
     pub fn fee_per_da_gas(self) -> Field {
         fee_per_da_gas()
     }
+
     /**
     * Emit a log with the given event selector and message.
     *

diff --git a/yarn-project/simulator/src/avm/opcodes/environment_getters.test.ts b/yarn-project/simulator/src/avm/opcodes/environment_getters.test.ts
@@ -1,5 +1,6 @@
 import { Fr } from '@aztec/foundation/fields';
 
+import { TypeTag } from '../avm_memory_types.js';
 import { initContext, initExecutionEnvironment, initGlobalVariables } from '../fixtures/index.js';
 import {
   Address,
@@ -49,18 +50,19 @@ describe.each([
 
     await instruction.execute(context);
 
+    expect(context.machineState.memory.getTag(0)).toBe(TypeTag.FIELD);
     const actual = context.machineState.memory.get(0).toFr();
     expect(actual).toEqual(value);
   });
 });
 
 type GlobalsInstruction = typeof ChainId | typeof Version | typeof BlockNumber | typeof Timestamp;
 describe.each([
-  [ChainId, 'chainId'],
-  [Version, 'version'],
-  [BlockNumber, 'blockNumber'],
-  [Timestamp, 'timestamp'],
-])('Global Variables', (clsValue: GlobalsInstruction, key: string) => {
+  [ChainId, 'chainId', TypeTag.FIELD],
+  [Version, 'version', TypeTag.FIELD],
+  [BlockNumber, 'blockNumber', TypeTag.FIELD],
+  [Timestamp, 'timestamp', TypeTag.UINT64],
+])('Global Variables', (clsValue: GlobalsInstruction, key: string, tag: TypeTag) => {
   it(`${clsValue.name} should (de)serialize correctly`, () => {
     const buf = Buffer.from([
       clsValue.opcode, // opcode
@@ -81,6 +83,7 @@ describe.each([
 
     await instruction.execute(context);
 
+    expect(context.machineState.memory.getTag(0)).toBe(tag);
     const actual = context.machineState.memory.get(0).toFr();
     expect(actual).toEqual(value);
   });
-Original file line number
+Diff line change
@@ Expand Up / @@ -30,6 +30,7 @@ impl AvmContext { @@
         pub fn fee_per_da_gas(self) -> Field {
             fee_per_da_gas()
         }
         /**
         * Emit a log with the given event selector and message.
         *
@@ Expand Down @@