diff --git a/yarn-project/simulator/docs/avm/opcodes/add.md b/yarn-project/simulator/docs/avm/opcodes/add.md
index 26f46de1052a..4ab028e9d673 100644
--- a/yarn-project/simulator/docs/avm/opcodes/add.md
+++ b/yarn-project/simulator/docs/avm/opcodes/add.md
@@ -22,18 +22,18 @@ Performs addition. Both operands must have the same type tag. For integer types
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first input |
-| `bOffset` | Memory offset | Memory offset of second input |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `aOffset` | Memory offset | Memory offset of the first operand |
+| `bOffset` | Memory offset | Memory offset of the second operand |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**ADD_8** (Opcode 0x00):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/and.md b/yarn-project/simulator/docs/avm/opcodes/and.md
index deaaac0f8bc4..e387fc6748d5 100644
--- a/yarn-project/simulator/docs/avm/opcodes/and.md
+++ b/yarn-project/simulator/docs/avm/opcodes/and.md
@@ -23,18 +23,18 @@ Performs bitwise AND operation. Both operands must have the same integral type t
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
| L2 Dynamic | 3 | - |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first input |
-| `bOffset` | Memory offset | Memory offset of second input |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `aOffset` | Memory offset | Memory offset of the first operand |
+| `bOffset` | Memory offset | Memory offset of the second operand |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**AND_8** (Opcode 0x10):
@@ -71,7 +71,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/call.md b/yarn-project/simulator/docs/avm/opcodes/call.md
index 5fd493284fa1..da91188541cc 100644
--- a/yarn-project/simulator/docs/avm/opcodes/call.md
+++ b/yarn-project/simulator/docs/avm/opcodes/call.md
@@ -29,7 +29,7 @@ Calls another contract with the specified calldata and gas allocation. Can modif
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -42,7 +42,7 @@ Calls another contract with the specified calldata and gas allocation. Can modif
| `argsOffset` | Memory offset | Memory offset of the start of the calldata |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**CALL** (Opcode 0x39):
@@ -64,7 +64,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
16-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/calldatacopy.md b/yarn-project/simulator/docs/avm/opcodes/calldatacopy.md
index d1eaa2437305..a5219e535a7e 100644
--- a/yarn-project/simulator/docs/avm/opcodes/calldatacopy.md
+++ b/yarn-project/simulator/docs/avm/opcodes/calldatacopy.md
@@ -23,7 +23,7 @@ Copies a section of the current call's calldata into memory at the specified off
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
| L2 Dynamic | 3 | `M[copySizeOffset]` |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -31,10 +31,10 @@ Copies a section of the current call's calldata into memory at the specified off
|------|------|-------------|
| `copySizeOffset` | Memory offset | Memory offset of the number of elements to copy |
| `cdStartOffset` | Memory offset | Memory offset of the calldata start index to copy from |
-| `dstOffset` | Memory offset | Memory offset for writing calldata |
+| `dstOffset` | Memory offset | Memory offset where the calldata will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**CALLDATACOPY** (Opcode 0x1F):
@@ -54,7 +54,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/cast.md b/yarn-project/simulator/docs/avm/opcodes/cast.md
index db6e6f9be67d..17fd51fe9820 100644
--- a/yarn-project/simulator/docs/avm/opcodes/cast.md
+++ b/yarn-project/simulator/docs/avm/opcodes/cast.md
@@ -22,18 +22,18 @@ Changes the type tag of a value. The value itself is preserved if casting to a l
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
| `srcOffset` | Memory offset | Memory offset of the value to cast |
-| `dstOffset` | Memory offset | Memory offset for casted value |
+| `dstOffset` | Memory offset | Memory offset where the casted value will be written |
| `dstTag` | Type tag | Type tag to cast the value to |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**CAST_8** (Opcode 0x1C):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/debuglog.md b/yarn-project/simulator/docs/avm/opcodes/debuglog.md
index 72db704097e9..83f18dd17cac 100644
--- a/yarn-project/simulator/docs/avm/opcodes/debuglog.md
+++ b/yarn-project/simulator/docs/avm/opcodes/debuglog.md
@@ -22,20 +22,20 @@ Prints a debug log to console as a formatted message, and pushes a structured de
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `levelOffset` | Memory offset | Memory offset |
+| `levelOffset` | Memory offset | Memory offset of the log level |
| `messageOffset` | Memory offset | Memory offset of the message string |
| `fieldsOffset` | Memory offset | Memory offset of the start of field values to log |
| `fieldsSizeOffset` | Memory offset | Memory offset of the number of fields to log |
| `messageSize` | Memory offset | Immediate value specifying message string length |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**DEBUGLOG** (Opcode 0x3E):
@@ -57,7 +57,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/div.md b/yarn-project/simulator/docs/avm/opcodes/div.md
index c8b527a3001c..5f40cc4c0683 100644
--- a/yarn-project/simulator/docs/avm/opcodes/div.md
+++ b/yarn-project/simulator/docs/avm/opcodes/div.md
@@ -22,7 +22,7 @@ Performs integer division (truncating). Both operands must have the same integra
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs integer division (truncating). Both operands must have the same integra
|------|------|-------------|
| `aOffset` | Memory offset | Memory offset of the dividend |
| `bOffset` | Memory offset | Memory offset of the divisor |
-| `dstOffset` | Memory offset | Memory offset for quotient |
+| `dstOffset` | Memory offset | Memory offset where the quotient will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**DIV_8** (Opcode 0x06):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/ecadd.md b/yarn-project/simulator/docs/avm/opcodes/ecadd.md
index 7e367b9ca7d8..e24ccc07a1c7 100644
--- a/yarn-project/simulator/docs/avm/opcodes/ecadd.md
+++ b/yarn-project/simulator/docs/avm/opcodes/ecadd.md
@@ -25,7 +25,7 @@ Performs elliptic curve point addition on the Grumpkin curve. Each point is repr
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -37,10 +37,10 @@ Performs elliptic curve point addition on the Grumpkin curve. Each point is repr
| `p2XOffset` | Memory offset | Memory offset of the second point's x-coordinate |
| `p2YOffset` | Memory offset | Memory offset of the second point's y-coordinate |
| `p2IsInfiniteOffset` | Memory offset | Memory offset of the second point's infinity flag |
-| `dstOffset` | Memory offset | Memory offset for result point will be written (3 values) |
+| `dstOffset` | Memory offset | Memory offset where the result point will be written (3 values) |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**ECADD** (Opcode 0x42):
@@ -64,7 +64,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
16-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/emitnotehash.md b/yarn-project/simulator/docs/avm/opcodes/emitnotehash.md
index 1390841fab0a..2daede7fce07 100644
--- a/yarn-project/simulator/docs/avm/opcodes/emitnotehash.md
+++ b/yarn-project/simulator/docs/avm/opcodes/emitnotehash.md
@@ -22,7 +22,7 @@ Writes a new note hash to the Note Hash Tree. Note hash must have type tag FIELD
| DA Base | 512 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -31,7 +31,7 @@ Writes a new note hash to the Note Hash Tree. Note hash must have type tag FIELD
| `noteHashOffset` | Memory offset | Memory offset of the note hash to emit |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**EMITNOTEHASH** (Opcode 0x32):
@@ -49,7 +49,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/emitnullifier.md b/yarn-project/simulator/docs/avm/opcodes/emitnullifier.md
index ca49f1bd2120..068184488150 100644
--- a/yarn-project/simulator/docs/avm/opcodes/emitnullifier.md
+++ b/yarn-project/simulator/docs/avm/opcodes/emitnullifier.md
@@ -22,7 +22,7 @@ Writes a new nullifier to the Nullifier Tree. This opcode can only emit nullifie
| DA Base | 512 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -31,7 +31,7 @@ Writes a new nullifier to the Nullifier Tree. This opcode can only emit nullifie
| `nullifierOffset` | Memory offset | Memory offset of the nullifier to emit |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**EMITNULLIFIER** (Opcode 0x34):
@@ -49,7 +49,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/emitunencryptedlog.md b/yarn-project/simulator/docs/avm/opcodes/emitunencryptedlog.md
index c9b8bc3acebd..665927499f2b 100644
--- a/yarn-project/simulator/docs/avm/opcodes/emitunencryptedlog.md
+++ b/yarn-project/simulator/docs/avm/opcodes/emitunencryptedlog.md
@@ -24,7 +24,7 @@ Emits a public log from the currently executing contract. Log size must be Uint3
| L2 Dynamic | 3 | `M[logSizeOffset]` |
| DA Dynamic | 512 | `M[logSizeOffset]` |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -34,7 +34,7 @@ Emits a public log from the currently executing contract. Log size must be Uint3
| `logOffset` | Memory offset | Memory offset of the start of the log data |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**EMITUNENCRYPTEDLOG** (Opcode 0x37):
@@ -53,7 +53,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/eq.md b/yarn-project/simulator/docs/avm/opcodes/eq.md
index cc9ff4c11fbd..cb4375974e09 100644
--- a/yarn-project/simulator/docs/avm/opcodes/eq.md
+++ b/yarn-project/simulator/docs/avm/opcodes/eq.md
@@ -22,18 +22,18 @@ Compares two values for equality. Both operands must have the same type tag. The
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first value to compare |
-| `bOffset` | Memory offset | Memory offset of second value to compare |
-| `dstOffset` | Memory offset | Memory offset for result (0 or 1) |
+| `aOffset` | Memory offset | Memory offset of the first value to compare |
+| `bOffset` | Memory offset | Memory offset of the second value to compare |
+| `dstOffset` | Memory offset | Memory offset where the result (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**EQ_8** (Opcode 0x0A):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/fdiv.md b/yarn-project/simulator/docs/avm/opcodes/fdiv.md
index 7460066d5280..7476af00493f 100644
--- a/yarn-project/simulator/docs/avm/opcodes/fdiv.md
+++ b/yarn-project/simulator/docs/avm/opcodes/fdiv.md
@@ -22,7 +22,7 @@ Performs field division (computes a * b^(-1) mod p where p is the BN254 field mo
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs field division (computes a * b^(-1) mod p where p is the BN254 field mo
|------|------|-------------|
| `aOffset` | Memory offset | Memory offset of the dividend |
| `bOffset` | Memory offset | Memory offset of the divisor |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**FDIV_8** (Opcode 0x08):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/getcontractinstance.md b/yarn-project/simulator/docs/avm/opcodes/getcontractinstance.md
index 21135c4c50c5..7e570e0eb2de 100644
--- a/yarn-project/simulator/docs/avm/opcodes/getcontractinstance.md
+++ b/yarn-project/simulator/docs/avm/opcodes/getcontractinstance.md
@@ -46,18 +46,18 @@ This separation allows for:
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `addressOffset` | Memory offset | Memory offset |
-| `dstOffset` | Memory offset | Memory offset |
+| `addressOffset` | Memory offset | Memory offset of the contract address to look up |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
| `memberEnum` | Memory offset | Immediate value specifying which contract instance member to retrieve |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**GETCONTRACTINSTANCE** (Opcode 0x36):
@@ -77,7 +77,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/getenvvar.md b/yarn-project/simulator/docs/avm/opcodes/getenvvar.md
index b1c42d2f455c..80fd823e92cb 100644
--- a/yarn-project/simulator/docs/avm/opcodes/getenvvar.md
+++ b/yarn-project/simulator/docs/avm/opcodes/getenvvar.md
@@ -39,17 +39,17 @@ Retrieves environment variables from the currently executing context. The variab
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `dstOffset` | Memory offset | Memory offset |
+| `dstOffset` | Memory offset | Memory offset where the environment variable value will be written |
| `varEnum` | Memory offset | Immediate value specifying which environment variable to read |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**GETENVVAR_16** (Opcode 0x1E):
@@ -68,7 +68,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/internalcall.md b/yarn-project/simulator/docs/avm/opcodes/internalcall.md
index a0ef7020a358..cde25f1bd768 100644
--- a/yarn-project/simulator/docs/avm/opcodes/internalcall.md
+++ b/yarn-project/simulator/docs/avm/opcodes/internalcall.md
@@ -21,7 +21,7 @@ Pushes current PC and return PC onto internal call stack, then jumps to the targ
| L2 Base | 9 |
| DA Base | 0 |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,7 +30,7 @@ Pushes current PC and return PC onto internal call stack, then jumps to the targ
| `loc` | Memory offset | Immediate bytecode offset of the function to call |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**INTERNALCALL** (Opcode 0x25):
diff --git a/yarn-project/simulator/docs/avm/opcodes/internalreturn.md b/yarn-project/simulator/docs/avm/opcodes/internalreturn.md
index 228d628f0397..2576b266a9a1 100644
--- a/yarn-project/simulator/docs/avm/opcodes/internalreturn.md
+++ b/yarn-project/simulator/docs/avm/opcodes/internalreturn.md
@@ -21,10 +21,10 @@ Pops return PC from internal call stack and sets PC to it.
| L2 Base | 9 |
| DA Base | 0 |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**INTERNALRETURN** (Opcode 0x26):
diff --git a/yarn-project/simulator/docs/avm/opcodes/jump.md b/yarn-project/simulator/docs/avm/opcodes/jump.md
index f118d3d96544..b803f7f9b22c 100644
--- a/yarn-project/simulator/docs/avm/opcodes/jump.md
+++ b/yarn-project/simulator/docs/avm/opcodes/jump.md
@@ -21,7 +21,7 @@ Sets the program counter to the specified offset. The offset is an immediate val
| L2 Base | 9 |
| DA Base | 0 |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,7 +30,7 @@ Sets the program counter to the specified offset. The offset is an immediate val
| `jumpOffset` | Memory offset | Immediate bytecode offset to jump to |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**JUMP** (Opcode 0x23):
diff --git a/yarn-project/simulator/docs/avm/opcodes/jumpi.md b/yarn-project/simulator/docs/avm/opcodes/jumpi.md
index 804e59899a7e..de8154a21c4f 100644
--- a/yarn-project/simulator/docs/avm/opcodes/jumpi.md
+++ b/yarn-project/simulator/docs/avm/opcodes/jumpi.md
@@ -22,7 +22,7 @@ Jumps to the specified location if the condition is non-zero (true). The conditi
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -32,7 +32,7 @@ Jumps to the specified location if the condition is non-zero (true). The conditi
| `loc` | Memory offset | Immediate bytecode offset to jump to if condition is true |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**JUMPI** (Opcode 0x24):
@@ -51,7 +51,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/keccakf1600.md b/yarn-project/simulator/docs/avm/opcodes/keccakf1600.md
index ee9d06d4c988..7c52ff2098cf 100644
--- a/yarn-project/simulator/docs/avm/opcodes/keccakf1600.md
+++ b/yarn-project/simulator/docs/avm/opcodes/keccakf1600.md
@@ -22,17 +22,17 @@ Computes the Keccak-f[1600] permutation on a state of 25 Uint64 elements. Input
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `dstOffset` | Memory offset | Memory offset for output state will be written |
+| `dstOffset` | Memory offset | Memory offset where the output state will be written |
| `inputOffset` | Memory offset | Memory offset of the input state (25 Uint64 elements) |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**KECCAKF1600** (Opcode 0x41):
@@ -51,7 +51,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/l1tol2msgexists.md b/yarn-project/simulator/docs/avm/opcodes/l1tol2msgexists.md
index c2c7135d6aa3..ce4968e1b067 100644
--- a/yarn-project/simulator/docs/avm/opcodes/l1tol2msgexists.md
+++ b/yarn-project/simulator/docs/avm/opcodes/l1tol2msgexists.md
@@ -22,7 +22,7 @@ Checks whether the specified L1-to-L2 message hash exists in the L1 to L2 messag
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Checks whether the specified L1-to-L2 message hash exists in the L1 to L2 messag
|------|------|-------------|
| `msgHashOffset` | Memory offset | Memory offset of the L1-to-L2 message hash |
| `msgLeafIndexOffset` | Memory offset | Memory offset of the leaf index in the message tree |
-| `existsOffset` | Memory offset | Memory offset for result (0 or 1) will be written |
+| `existsOffset` | Memory offset | Memory offset where the result (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**L1TOL2MSGEXISTS** (Opcode 0x35):
@@ -53,7 +53,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/lt.md b/yarn-project/simulator/docs/avm/opcodes/lt.md
index 7a6c213a1a09..353299f25657 100644
--- a/yarn-project/simulator/docs/avm/opcodes/lt.md
+++ b/yarn-project/simulator/docs/avm/opcodes/lt.md
@@ -22,18 +22,18 @@ Compares two values. Both operands must have the same type tag. For integer type
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first value to compare |
-| `bOffset` | Memory offset | Memory offset of second value to compare |
-| `dstOffset` | Memory offset | Memory offset for result (0 or 1) |
+| `aOffset` | Memory offset | Memory offset of the first value to compare |
+| `bOffset` | Memory offset | Memory offset of the second value to compare |
+| `dstOffset` | Memory offset | Memory offset where the result (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**LT_8** (Opcode 0x0C):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/lte.md b/yarn-project/simulator/docs/avm/opcodes/lte.md
index 9ef0496a14e6..76744e01eab2 100644
--- a/yarn-project/simulator/docs/avm/opcodes/lte.md
+++ b/yarn-project/simulator/docs/avm/opcodes/lte.md
@@ -22,18 +22,18 @@ Compares two values. Both operands must have the same type tag. For integer type
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first value to compare |
-| `bOffset` | Memory offset | Memory offset of second value to compare |
-| `dstOffset` | Memory offset | Memory offset for result (0 or 1) |
+| `aOffset` | Memory offset | Memory offset of the first value to compare |
+| `bOffset` | Memory offset | Memory offset of the second value to compare |
+| `dstOffset` | Memory offset | Memory offset where the result (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**LTE_8** (Opcode 0x0E):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/mov.md b/yarn-project/simulator/docs/avm/opcodes/mov.md
index d16a6ecf7ea5..af796de1eb9e 100644
--- a/yarn-project/simulator/docs/avm/opcodes/mov.md
+++ b/yarn-project/simulator/docs/avm/opcodes/mov.md
@@ -22,17 +22,17 @@ Copies a value and its type tag from the source memory offset to the destination
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `srcOffset` | Memory offset | Memory offset to read from |
-| `dstOffset` | Memory offset | Memory offset to write to |
+| `srcOffset` | Memory offset | Memory offset of the value to copy |
+| `dstOffset` | Memory offset | Memory offset where the value will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**MOV_8** (Opcode 0x2D):
@@ -67,7 +67,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/mul.md b/yarn-project/simulator/docs/avm/opcodes/mul.md
index fc9b12265689..ff88121fac3f 100644
--- a/yarn-project/simulator/docs/avm/opcodes/mul.md
+++ b/yarn-project/simulator/docs/avm/opcodes/mul.md
@@ -22,7 +22,7 @@ Performs multiplication. Both operands must have the same type tag. For integer
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs multiplication. Both operands must have the same type tag. For integer
|------|------|-------------|
| `aOffset` | Memory offset | Memory offset of the first factor |
| `bOffset` | Memory offset | Memory offset of the second factor |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**MUL_8** (Opcode 0x04):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/not.md b/yarn-project/simulator/docs/avm/opcodes/not.md
index 85a25c056972..5e09443a3ea0 100644
--- a/yarn-project/simulator/docs/avm/opcodes/not.md
+++ b/yarn-project/simulator/docs/avm/opcodes/not.md
@@ -22,17 +22,17 @@ Performs bitwise NOT operation (one's complement). The operand must have an inte
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
| `srcOffset` | Memory offset | Memory offset of the value to negate |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**NOT_8** (Opcode 0x16):
@@ -67,7 +67,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/notehashexists.md b/yarn-project/simulator/docs/avm/opcodes/notehashexists.md
index ad058cadae3b..856528da8ee9 100644
--- a/yarn-project/simulator/docs/avm/opcodes/notehashexists.md
+++ b/yarn-project/simulator/docs/avm/opcodes/notehashexists.md
@@ -22,7 +22,7 @@ Performs a read of the Note Hash Tree to query whether the specified note hash e
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs a read of the Note Hash Tree to query whether the specified note hash e
|------|------|-------------|
| `noteHashOffset` | Memory offset | Memory offset of the note hash to check |
| `leafIndexOffset` | Memory offset | Memory offset of the leaf index in the note hash tree |
-| `existsOffset` | Memory offset | Memory offset for result (0 or 1) will be written |
+| `existsOffset` | Memory offset | Memory offset where the result (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**NOTEHASHEXISTS** (Opcode 0x31):
@@ -53,7 +53,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/nullifierexists.md b/yarn-project/simulator/docs/avm/opcodes/nullifierexists.md
index d52aaf87546a..da9cf1a22478 100644
--- a/yarn-project/simulator/docs/avm/opcodes/nullifierexists.md
+++ b/yarn-project/simulator/docs/avm/opcodes/nullifierexists.md
@@ -22,7 +22,7 @@ Performs a read of the Nullifier Tree to query whether the specified nullifier e
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs a read of the Nullifier Tree to query whether the specified nullifier e
|------|------|-------------|
| `nullifierOffset` | Memory offset | Memory offset of the nullifier to check |
| `addressOffset` | Memory offset | Memory offset of the contract address |
-| `existsOffset` | Memory offset | Memory offset for result (0 or 1) will be written |
+| `existsOffset` | Memory offset | Memory offset where the result (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**NULLIFIEREXISTS** (Opcode 0x33):
@@ -53,7 +53,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/or.md b/yarn-project/simulator/docs/avm/opcodes/or.md
index 59e4ff87fae2..43017271a9e7 100644
--- a/yarn-project/simulator/docs/avm/opcodes/or.md
+++ b/yarn-project/simulator/docs/avm/opcodes/or.md
@@ -23,18 +23,18 @@ Performs bitwise OR operation. Both operands must have the same integral type ta
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
| L2 Dynamic | 3 | - |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first input |
-| `bOffset` | Memory offset | Memory offset of second input |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `aOffset` | Memory offset | Memory offset of the first operand |
+| `bOffset` | Memory offset | Memory offset of the second operand |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**OR_8** (Opcode 0x12):
@@ -71,7 +71,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/poseidon2.md b/yarn-project/simulator/docs/avm/opcodes/poseidon2.md
index 0feae7fc4b3d..74c6036ce97c 100644
--- a/yarn-project/simulator/docs/avm/opcodes/poseidon2.md
+++ b/yarn-project/simulator/docs/avm/opcodes/poseidon2.md
@@ -22,17 +22,17 @@ Computes the Poseidon2 permutation on a state of 4 field elements. Input and out
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
| `inputStateOffset` | Memory offset | Memory offset of the input state (4 field elements) |
-| `outputStateOffset` | Memory offset | Memory offset for output state will be written |
+| `outputStateOffset` | Memory offset | Memory offset where the output state will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**POSEIDON2** (Opcode 0x3F):
@@ -51,7 +51,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/return.md b/yarn-project/simulator/docs/avm/opcodes/return.md
index 6e43fec78301..328f2fe2b7ce 100644
--- a/yarn-project/simulator/docs/avm/opcodes/return.md
+++ b/yarn-project/simulator/docs/avm/opcodes/return.md
@@ -23,7 +23,7 @@ Halts execution and returns data to the caller. Return size must be Uint32. Sets
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -33,7 +33,7 @@ Halts execution and returns data to the caller. Return size must be Uint32. Sets
| `returnOffset` | Memory offset | Memory offset of the start of the return data |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**RETURN** (Opcode 0x3B):
@@ -52,7 +52,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/returndatacopy.md b/yarn-project/simulator/docs/avm/opcodes/returndatacopy.md
index 775b6e1abdcb..c2aa665de4cd 100644
--- a/yarn-project/simulator/docs/avm/opcodes/returndatacopy.md
+++ b/yarn-project/simulator/docs/avm/opcodes/returndatacopy.md
@@ -23,7 +23,7 @@ Copies a section of the returndata from the most recent nested external call (CA
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
| L2 Dynamic | 3 | `M[copySizeOffset]` |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -31,10 +31,10 @@ Copies a section of the returndata from the most recent nested external call (CA
|------|------|-------------|
| `copySizeOffset` | Memory offset | Memory offset of the number of elements to copy |
| `rdStartOffset` | Memory offset | Memory offset of the return data start index to copy from |
-| `dstOffset` | Memory offset | Memory offset for writing return data |
+| `dstOffset` | Memory offset | Memory offset where the return data will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**RETURNDATACOPY** (Opcode 0x22):
@@ -54,7 +54,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/returndatasize.md b/yarn-project/simulator/docs/avm/opcodes/returndatasize.md
index 4f4812d1e3e3..98ddf9fc135a 100644
--- a/yarn-project/simulator/docs/avm/opcodes/returndatasize.md
+++ b/yarn-project/simulator/docs/avm/opcodes/returndatasize.md
@@ -22,16 +22,16 @@ Returns the size of the return data from the most recent nested external call (C
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `dstOffset` | Memory offset | Memory offset for size will be written |
+| `dstOffset` | Memory offset | Memory offset where the size will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**RETURNDATASIZE** (Opcode 0x21):
@@ -49,7 +49,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/revert.md b/yarn-project/simulator/docs/avm/opcodes/revert.md
index 02c91de229cc..facf8ab42638 100644
--- a/yarn-project/simulator/docs/avm/opcodes/revert.md
+++ b/yarn-project/simulator/docs/avm/opcodes/revert.md
@@ -23,7 +23,7 @@ Halts execution with revert status and returns error data to the caller. Revert
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -33,7 +33,7 @@ Halts execution with revert status and returns error data to the caller. Revert
| `returnOffset` | Memory offset | Memory offset of the start of the revert data |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**REVERT_8** (Opcode 0x3C):
@@ -68,7 +68,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/sendl2tol1msg.md b/yarn-project/simulator/docs/avm/opcodes/sendl2tol1msg.md
index b359a07e7de2..18df27aae8f6 100644
--- a/yarn-project/simulator/docs/avm/opcodes/sendl2tol1msg.md
+++ b/yarn-project/simulator/docs/avm/opcodes/sendl2tol1msg.md
@@ -22,7 +22,7 @@ Sends a message to L1, with the specified recipient, from the currently executin
| DA Base | 512 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -32,7 +32,7 @@ Sends a message to L1, with the specified recipient, from the currently executin
| `contentOffset` | Memory offset | Memory offset of the message content |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SENDL2TOL1MSG** (Opcode 0x38):
@@ -51,7 +51,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/set.md b/yarn-project/simulator/docs/avm/opcodes/set.md
index e95c6b10dfcc..5db1270f2eed 100644
--- a/yarn-project/simulator/docs/avm/opcodes/set.md
+++ b/yarn-project/simulator/docs/avm/opcodes/set.md
@@ -22,18 +22,18 @@ Stores an immediate value (a constant encoded directly in the bytecode) at the s
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `dstOffset` | Memory offset | Memory offset for value will be stored |
+| `dstOffset` | Memory offset | Memory offset where the value will be stored |
| `inTag` | Type tag | Type tag to assign to the value. Unrelated to the opcode's wire format (`SET_8` vs `SET_16`, etc.) |
| `value` | Immediate value | Constant from the bytecode to store into memory |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SET_8** (Opcode 0x27):
@@ -138,7 +138,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/sha256compression.md b/yarn-project/simulator/docs/avm/opcodes/sha256compression.md
index 309e262d9abe..352624195018 100644
--- a/yarn-project/simulator/docs/avm/opcodes/sha256compression.md
+++ b/yarn-project/simulator/docs/avm/opcodes/sha256compression.md
@@ -22,18 +22,18 @@ Computes the SHA-256 compression function on an 8-word state and 16-word input b
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `outputOffset` | Memory offset | Memory offset for 8-word output state will be written |
+| `outputOffset` | Memory offset | Memory offset where the 8-word output state will be written |
| `stateOffset` | Memory offset | Memory offset of the 8-word SHA-256 state |
| `inputsOffset` | Memory offset | Memory offset of the 16-word input block |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SHA256COMPRESSION** (Opcode 0x40):
@@ -53,7 +53,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/shl.md b/yarn-project/simulator/docs/avm/opcodes/shl.md
index 8b3413b303c0..b5cc37f45180 100644
--- a/yarn-project/simulator/docs/avm/opcodes/shl.md
+++ b/yarn-project/simulator/docs/avm/opcodes/shl.md
@@ -22,7 +22,7 @@ Performs left bit shift. Both operands must have the same integral type tag (UIN
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs left bit shift. Both operands must have the same integral type tag (UIN
|------|------|-------------|
| `aOffset` | Memory offset | Memory offset of the value to shift |
| `bOffset` | Memory offset | Memory offset of the shift amount |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SHL_8** (Opcode 0x18):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/shr.md b/yarn-project/simulator/docs/avm/opcodes/shr.md
index 3d1182f5f514..2981ef35d1a7 100644
--- a/yarn-project/simulator/docs/avm/opcodes/shr.md
+++ b/yarn-project/simulator/docs/avm/opcodes/shr.md
@@ -22,7 +22,7 @@ Performs right bit shift (logical, zero-fill). Both operands must have the same
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs right bit shift (logical, zero-fill). Both operands must have the same
|------|------|-------------|
| `aOffset` | Memory offset | Memory offset of the value to shift |
| `bOffset` | Memory offset | Memory offset of the shift amount |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SHR_8** (Opcode 0x1A):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/sload.md b/yarn-project/simulator/docs/avm/opcodes/sload.md
index ac04d3b47e07..762445c9bfff 100644
--- a/yarn-project/simulator/docs/avm/opcodes/sload.md
+++ b/yarn-project/simulator/docs/avm/opcodes/sload.md
@@ -22,17 +22,17 @@ Reads from public storage at the specified slot. Performs a read of the Public D
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
| `slotOffset` | Memory offset | Memory offset of the storage slot to read from |
-| `dstOffset` | Memory offset | Memory offset for loaded value will be written |
+| `dstOffset` | Memory offset | Memory offset where the loaded value will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SLOAD** (Opcode 0x2F):
@@ -51,7 +51,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/sstore.md b/yarn-project/simulator/docs/avm/opcodes/sstore.md
index 510dacf49985..27bdcf805ad0 100644
--- a/yarn-project/simulator/docs/avm/opcodes/sstore.md
+++ b/yarn-project/simulator/docs/avm/opcodes/sstore.md
@@ -23,7 +23,7 @@ Writes to public storage at the specified slot. Performs a write to the Public D
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
| DA Dynamic | 1024 | - |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -33,7 +33,7 @@ Writes to public storage at the specified slot. Performs a write to the Public D
| `slotOffset` | Memory offset | Memory offset of the storage slot to write to |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SSTORE** (Opcode 0x30):
@@ -52,7 +52,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/staticcall.md b/yarn-project/simulator/docs/avm/opcodes/staticcall.md
index de0876b5eb87..94197d44057d 100644
--- a/yarn-project/simulator/docs/avm/opcodes/staticcall.md
+++ b/yarn-project/simulator/docs/avm/opcodes/staticcall.md
@@ -30,7 +30,7 @@ Calls another contract in static mode (read-only). Any state modifications in th
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -43,7 +43,7 @@ Calls another contract in static mode (read-only). Any state modifications in th
| `argsOffset` | Memory offset | Memory offset of the start of the calldata |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**STATICCALL** (Opcode 0x3A):
@@ -65,7 +65,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
16-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/sub.md b/yarn-project/simulator/docs/avm/opcodes/sub.md
index 5ef25da63eb6..4da84ab292a1 100644
--- a/yarn-project/simulator/docs/avm/opcodes/sub.md
+++ b/yarn-project/simulator/docs/avm/opcodes/sub.md
@@ -22,7 +22,7 @@ Performs subtraction. Both operands must have the same type tag. For integer typ
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -30,10 +30,10 @@ Performs subtraction. Both operands must have the same type tag. For integer typ
|------|------|-------------|
| `aOffset` | Memory offset | Memory offset of the minuend |
| `bOffset` | Memory offset | Memory offset of the subtrahend |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SUB_8** (Opcode 0x02):
@@ -70,7 +70,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/successcopy.md b/yarn-project/simulator/docs/avm/opcodes/successcopy.md
index c4e0dc15f07b..320a78bb6d83 100644
--- a/yarn-project/simulator/docs/avm/opcodes/successcopy.md
+++ b/yarn-project/simulator/docs/avm/opcodes/successcopy.md
@@ -22,16 +22,16 @@ Returns 1 if the most recent nested external call (CALL or STATICCALL instructio
| DA Base | 0 | - |
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `dstOffset` | Memory offset | Memory offset for success status (0 or 1) will be written |
+| `dstOffset` | Memory offset | Memory offset where the success status (0 or 1) will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**SUCCESSCOPY** (Opcode 0x20):
@@ -49,7 +49,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/toradixbe.md b/yarn-project/simulator/docs/avm/opcodes/toradixbe.md
index 9b88579d17cc..c8f4f0ba8a72 100644
--- a/yarn-project/simulator/docs/avm/opcodes/toradixbe.md
+++ b/yarn-project/simulator/docs/avm/opcodes/toradixbe.md
@@ -30,7 +30,7 @@ Decomposes a field element into limbs in the specified radix (2-256). If outputB
\*Note: The L2 gas cost scales linearly with M[numLimbsOffset], but also includes a per-limb multiplier based on M[radixOffset]
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
@@ -40,10 +40,10 @@ Decomposes a field element into limbs in the specified radix (2-256). If outputB
| `radixOffset` | Memory offset | Memory offset of the radix (base) for decomposition |
| `numLimbsOffset` | Memory offset | Memory offset of the number of limbs to generate |
| `outputBitsOffset` | Memory offset | Memory offset of the output mode flag (1 for bits, 0 for bytes) |
-| `dstOffset` | Memory offset | Memory offset for limb array will be written |
+| `dstOffset` | Memory offset | Memory offset where the limb array will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**TORADIXBE** (Opcode 0x43):
@@ -65,7 +65,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
16-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)
diff --git a/yarn-project/simulator/docs/avm/opcodes/xor.md b/yarn-project/simulator/docs/avm/opcodes/xor.md
index 81d6730327d7..58aa369ae197 100644
--- a/yarn-project/simulator/docs/avm/opcodes/xor.md
+++ b/yarn-project/simulator/docs/avm/opcodes/xor.md
@@ -23,18 +23,18 @@ Performs bitwise XOR operation. Both operands must have the same integral type t
| L2 Addressing | 3 | 3 L2 gas per indirect memory offset
3 L2 gas per relative memory offset |
| L2 Dynamic | 3 | - |
-\* See [Gas Metering](gas.md) for details on how gas costs are computed and applied.
+\* See [Gas Metering](../gas.md) for details on how gas costs are computed and applied.
## Operands
| Name | Type | Description |
|------|------|-------------|
-| `aOffset` | Memory offset | Memory offset of first input |
-| `bOffset` | Memory offset | Memory offset of second input |
-| `dstOffset` | Memory offset | Memory offset for result |
+| `aOffset` | Memory offset | Memory offset of the first operand |
+| `bOffset` | Memory offset | Memory offset of the second operand |
+| `dstOffset` | Memory offset | Memory offset where the result will be written |
## Wire Formats
-See [Wire Format](wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
+See [Wire Format](../wire-format.md) page for an explanation of wire format variants and opcode naming (e.g., why `ADD_8` vs `ADD_16`).
**XOR_8** (Opcode 0x14):
@@ -71,7 +71,7 @@ packet-beta
```
## Addressing Modes
-See [Addressing](addressing.md) page for a detailed explanation.
+See [Addressing](../addressing.md) page for a detailed explanation.
8-bit bitmask: 2 bits per memory offset operand (indirect flag + relative flag)