fix: split setup/teardown functions when there's no public app logic (#…

…5156) This PR fixes an issue where the phase manager was incorrectly extracting setup and teardown enqueued public function calls when there was no app logic in between them. Fix #5150 Stacked on top of #5129 Co-authored-by: Mitchell Tracy <[email protected]>
AztecProtocol · Mar 13, 2024 · 2ee13b3 · 2ee13b3
1 parent d666f6f
commit 2ee13b3
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 4 deletions.
diff --git a/yarn-project/end-to-end/src/e2e_fees.test.ts b/yarn-project/end-to-end/src/e2e_fees.test.ts
@@ -197,6 +197,8 @@ describe('e2e_fees', () => {
     let InitialAlicePublicBananas: bigint;
     let InitialAliceGas: bigint;
 
+    let InitialBobPrivateBananas: bigint;
+
     let InitialFPCPrivateBananas: bigint;
     let InitialFPCPublicBananas: bigint;
     let InitialFPCGas: bigint;
@@ -220,16 +222,82 @@ describe('e2e_fees', () => {
       RefundSecret = Fr.random();
 
       [
-        [InitialAlicePrivateBananas, InitialFPCPrivateBananas],
+        [InitialAlicePrivateBananas, InitialBobPrivateBananas, InitialFPCPrivateBananas],
         [InitialAlicePublicBananas, InitialFPCPublicBananas],
         [InitialAliceGas, InitialFPCGas, InitialSequencerGas],
       ] = await Promise.all([
-        bananaPrivateBalances(aliceAddress, bananaFPC.address, sequencerAddress),
-        bananaPublicBalances(aliceAddress, bananaFPC.address, sequencerAddress),
+        bananaPrivateBalances(aliceAddress, bobAddress, bananaFPC.address),
+        bananaPublicBalances(aliceAddress, bananaFPC.address),
         gasBalances(aliceAddress, bananaFPC.address, sequencerAddress),
       ]);
     });
 
+    it("pays fees for tx that don't run public app logic", async () => {
+      /**
+       * PRIVATE SETUP
+       * check authwit
+       * reduce alice BC.private by MaxFee
+       * enqueue public call to increase FPC BC.public by MaxFee
+       * enqueue public call for fpc.pay_fee_with_shielded_rebate
+       *
+       * PRIVATE APP LOGIC
+       * reduce Alice's BC.private by transferAmount
+       * create note for Bob of transferAmount
+       *
+       * PUBLIC SETUP
+       * increase FPC BC.public by MaxFee
+       *
+       * PUBLIC APP LOGIC
+       * N/A
+       *
+       * PUBLIC TEARDOWN
+       * call gas.pay_fee
+       *   decrease FPC AZT by FeeAmount
+       *   increase sequencer AZT by FeeAmount
+       * call banana.shield
+       *   decrease FPC BC.public by RefundAmount
+       *   create transparent note with RefundAmount
+       *
+       * this is expected to squash notes and nullifiers
+       */
+      const transferAmount = 5n;
+      const tx = await bananaCoin.methods
+        .transfer(aliceAddress, bobAddress, transferAmount, 0n)
+        .send({
+          fee: {
+            maxFee: MaxFee,
+            paymentMethod: new PrivateFeePaymentMethod(
+              bananaCoin.address,
+              bananaFPC.address,
+              aliceWallet,
+              RefundSecret,
+            ),
+          },
+        })
+        .wait();
+
+      await expectMapping(
+        bananaPrivateBalances,
+        [aliceAddress, bobAddress, bananaFPC.address, sequencerAddress],
+        [InitialAlicePrivateBananas - MaxFee - transferAmount, transferAmount, InitialFPCPrivateBananas, 0n],
+      );
+      await expectMapping(
+        bananaPublicBalances,
+        [aliceAddress, bananaFPC.address, sequencerAddress],
+        [InitialAlicePublicBananas, InitialFPCPublicBananas + MaxFee - RefundAmount, 0n],
+      );
+      await expectMapping(
+        gasBalances,
+        [aliceAddress, bananaFPC.address, sequencerAddress],
+        [InitialAliceGas, InitialFPCGas - FeeAmount, InitialSequencerGas + FeeAmount],
+      );
+
+      await expect(
+        // this rejects if note can't be added
+        addPendingShieldNoteToPXE(0, RefundAmount, computeMessageSecretHash(RefundSecret), tx.txHash),
+      ).resolves.toBeUndefined();
+    });
+
     it('pays fees for tx that creates notes in private', async () => {
       /**
        * PRIVATE SETUP
@@ -412,7 +480,12 @@ describe('e2e_fees', () => {
       await expectMapping(
         bananaPrivateBalances,
         [aliceAddress, bobAddress, bananaFPC.address, sequencerAddress],
-        [InitialAlicePrivateBananas - MaxFee - privateTransfer, privateTransfer, InitialFPCPrivateBananas, 0n],
+        [
+          InitialAlicePrivateBananas - MaxFee - privateTransfer,
+          InitialBobPrivateBananas + privateTransfer,
+          InitialFPCPrivateBananas,
+          0n,
+        ],
       );
       await expectMapping(
         bananaPublicBalances,

diff --git a/yarn-project/sequencer-client/src/sequencer/abstract_phase_manager.ts b/yarn-project/sequencer-client/src/sequencer/abstract_phase_manager.ts
@@ -155,6 +155,14 @@ export abstract class AbstractPhaseManager {
         [PublicKernelPhase.TEARDOWN]: [],
         [PublicKernelPhase.TAIL]: [],
       };
+    } else if (firstRevertibleCallIndex === -1) {
+      // there's no app logic, split the functions between setup (many) and teardown (just one function call)
+      return {
+        [PublicKernelPhase.SETUP]: publicCallsStack.slice(0, -1),
+        [PublicKernelPhase.APP_LOGIC]: [],
+        [PublicKernelPhase.TEARDOWN]: [publicCallsStack[publicCallsStack.length - 1]],
+        [PublicKernelPhase.TAIL]: [],
+      };
     } else {
       return {
         [PublicKernelPhase.SETUP]: publicCallsStack.slice(0, firstRevertibleCallIndex - 1),