Add TODOs for issue #3417

AztecProtocol · Nov 24, 2023 · 52f31bf · 52f31bf
1 parent 2001d47
commit 52f31bf
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 0 deletions.
diff --git a/yarn-project/circuits.js/src/structs/kernel/combined_accumulated_data.ts b/yarn-project/circuits.js/src/structs/kernel/combined_accumulated_data.ts
@@ -490,6 +490,7 @@ export class FinalAccumulatedData {
     public nullifiedCommitments: Tuple<Fr, typeof MAX_NEW_NULLIFIERS_PER_TX>,
     /**
      * Current private call stack.
+     * TODO(#3417): Given this field must empty, should we just remove it?
      */
     public privateCallStack: Tuple<Fr, typeof MAX_PRIVATE_CALL_STACK_LENGTH_PER_TX>,
     /**

diff --git a/yarn-project/circuits.js/src/structs/public_call_request.ts b/yarn-project/circuits.js/src/structs/public_call_request.ts
@@ -25,10 +25,12 @@ export class PublicCallRequest {
     public contractAddress: AztecAddress,
     /**
      * Data identifying the function being called.
+     * TODO(#3417): Remove this since the only useful data is the function selector, which is already part of the call context.
      */
     public functionData: FunctionData,
     /**
      * Context of the public call.
+     * TODO(#3417): Check if all fields of CallContext are actually needed.
      */
     public callContext: CallContext,
     /**

diff --git a/yarn-project/circuits.js/src/structs/tx_context.ts b/yarn-project/circuits.js/src/structs/tx_context.ts
@@ -74,6 +74,7 @@ export class TxContext {
   constructor(
     /**
      * Whether this is a fee paying tx. If not other tx in a bundle will pay the fee.
+     * TODO(#3417): Remove fee and rebate payment fields.
      */
     public isFeePaymentTx: boolean,
     /**

diff --git a/yarn-project/types/src/tx/tx.ts b/yarn-project/types/src/tx/tx.ts
@@ -45,6 +45,7 @@ export class Tx {
     /**
      * Contracts deployed in this tx.
      * Note: Portal address is always set to zero in the tx's new contracts.
+     * TODO(#3417): Check if portal addresses are still always set to zero
      */
     public readonly newContracts: Tuple<ExtendedContractData, typeof MAX_NEW_CONTRACTS_PER_TX>,
   ) {

diff --git a/yarn-project/types/src/tx_execution_request.ts b/yarn-project/types/src/tx_execution_request.ts
@@ -15,6 +15,7 @@ export class TxExecutionRequest {
     public origin: AztecAddress,
     /**
      * Function data representing the function to call.
+     * TODO(#3417): Remove this field and replace with a function selector.
      */
     public functionData: FunctionData,
     /**