Apply suggestions from code review

Co-authored-by: Nicolás Venturo <nicolas.venturo@gmail.com>
AztecProtocol · Aug 12, 2024 · 33c9509 · 33c9509
1 parent 595b0ad
commit 33c9509
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 7 deletions.
diff --git a/yarn-project/aztec-node/src/aztec-node/server.ts b/yarn-project/aztec-node/src/aztec-node/server.ts
@@ -341,7 +341,7 @@ export class AztecNodeService implements AztecNode {
     const timer = new Timer();
     this.log.info(`Received tx ${tx.getTxHash()}`);
 
-    if ((await this.validateTx(tx)) === false) {
+    if (!(await this.isValidTx(tx))) {
       this.metrics.receivedTx(timer.ms(), false);
       return;
     }
@@ -768,7 +768,7 @@ export class AztecNodeService implements AztecNode {
     );
   }
 
-  public async validateTx(tx: Tx): Promise<boolean> {
+  public async isValidTx(tx: Tx): Promise<boolean> {
     const [_, invalidTxs] = await this.txValidator.validateTxs([tx]);
     if (invalidTxs.length > 0) {
       this.log.warn(`Rejecting tx ${tx.getTxHash()} because of validation errors`);

diff --git a/yarn-project/aztec.js/src/contract/contract_function_interaction.ts b/yarn-project/aztec.js/src/contract/contract_function_interaction.ts
@@ -23,7 +23,7 @@ export type SimulateMethodOptions = {
   from?: AztecAddress;
   /** Gas settings for the simulation. */
   gasSettings?: GasSettings;
-  /** Simulate without validating tx against current state. */
+  /** Simulate without validating tx results against current state. */
   offline?: boolean;
 };
 

diff --git a/yarn-project/circuit-types/src/interfaces/aztec-node.ts b/yarn-project/circuit-types/src/interfaces/aztec-node.ts
@@ -317,11 +317,12 @@ export interface AztecNode {
   simulatePublicCalls(tx: Tx): Promise<PublicSimulationOutput>;
 
   /**
-   * Validates the correctness of the execution, namely that a transaction is valid if and
-   * only if the transaction can be added to a valid block at the current state.
+   * Returns true if the transaction is valid for inclusion at the current state. Valid transactions can be
+   * made invalid by *other* transactions if e.g. they emit the same nullifiers, or come become invalid
+   * due to e.g. the max_block_number property.
    * @param tx - The transaction to validate for correctness.
    */
-  validateTx(tx: Tx): Promise<boolean>;
+  isValidTx(tx: Tx): Promise<boolean>;
 
   /**
    * Updates the configuration of this node.

diff --git a/yarn-project/pxe/src/pxe_service/pxe_service.ts b/yarn-project/pxe/src/pxe_service/pxe_service.ts
@@ -507,7 +507,7 @@ export class PXEService implements PXE {
       }
 
       if (!offline) {
-        const isValidTx = await this.node.validateTx(simulatedTx.tx);
+        const isValidTx = await this.node.isValidTx(simulatedTx.tx);
 
         if (!isValidTx) {
           throw new Error('The simulated transaction is unable to be added to state and is invalid.');