Merge pull request #60 from AztecProtocol/jz/test-sponsored-fpc

Jz/test sponsored fpc

Author: jzaki

.github/workflows/tests.yaml

@@ -28,7 +28,7 @@ jobs:
 
       - name: Set Aztec version and start sandbox
         run: |
-          VERSION=0.77.1 aztec-up
+          VERSION=0.78.1 aztec-up
           aztec start --sandbox &
 
       - name: Install project dependencies

Nargo.toml

@@ -5,4 +5,4 @@ authors = [ "" ]
 compiler_version = ">=0.18.0"
 
 [dependencies]
-aztec = { git = "https://github.com/AztecProtocol/aztec-packages/", tag = "v0.77.1", directory = "noir-projects/aztec-nr/aztec" }
+aztec = { git = "https://github.com/AztecProtocol/aztec-packages/", tag = "v0.78.1", directory = "noir-projects/aztec-nr/aztec" }

README.md

@@ -40,7 +40,7 @@ bash -i <(curl -s https://install.aztec.network)
 Install the correct version of the toolkit with:
 
 ```bash
-aztec-up 0.77.1
+aztec-up 0.78.1
 ```
 
 Start the sandbox with:

package.json

@@ -20,10 +20,10 @@
     "update-readme-version": "node ./.github/scripts/update-readme-version.js"
   },
   "dependencies": {
-    "@aztec/accounts": "0.77.1",
-    "@aztec/aztec.js": "0.77.1",
-    "@aztec/noir-contracts.js": "0.77.1",
-    "@aztec/stdlib": "0.77.1",
+    "@aztec/accounts": "0.78.1",
+    "@aztec/aztec.js": "0.78.1",
+    "@aztec/noir-contracts.js": "0.78.1",
+    "@aztec/stdlib": "0.78.1",
     "@types/node": "^22.5.1"
   },
   "devDependencies": {

src/test/index.test.ts

@@ -1,7 +1,9 @@
 import { EasyPrivateVotingContractArtifact, EasyPrivateVotingContract } from "../artifacts/EasyPrivateVoting.js"
-import { AccountWallet, CompleteAddress, ContractDeployer, createLogger, Fr, PXE, waitForPXE, TxStatus, createPXEClient, getContractInstanceFromDeployParams, Logger } from "@aztec/aztec.js";
-import { getInitialTestAccountsWallets } from "@aztec/accounts/testing"
+import { AccountManager, AccountWallet, CompleteAddress, ContractDeployer, createLogger, Fr, PXE, waitForPXE, TxStatus, createPXEClient, getContractInstanceFromDeployParams, Logger } from "@aztec/aztec.js";
+import { getInitialTestAccountsWallets, generateSchnorrAccounts } from "@aztec/accounts/testing"
+import { getSchnorrAccount } from '@aztec/accounts/schnorr';
 import { spawn } from 'child_process';
+import { SponsoredFeePaymentMethod } from './sponsored_fee_payment_method.js';
 
 const setupSandbox = async () => {
     const { PXE_URL = 'http://localhost:8080' } = process.env;
@@ -17,6 +19,7 @@ describe("Voting", () => {
     let accounts: CompleteAddress[] = [];
     let logger: Logger;
     let sandboxInstance;
+    let sponsoredPaymentMethod: SponsoredFeePaymentMethod;
 
     beforeAll(async () => {
         sandboxInstance = spawn("aztec", ["start", "--sandbox"], {
@@ -31,6 +34,7 @@ describe("Voting", () => {
 
         wallets = await getInitialTestAccountsWallets(pxe);
         accounts = wallets.map(w => w.getCompleteAddress())
+        sponsoredPaymentMethod = await SponsoredFeePaymentMethod.new(pxe);
     })
 
     afterAll(async () => {
@@ -40,8 +44,17 @@ describe("Voting", () => {
     it("Deploys the contract", async () => {
         const salt = Fr.random();
         const VotingContractArtifact = EasyPrivateVotingContractArtifact
-        const [deployerWallet, adminWallet] = wallets; // using first account as deployer and second as contract admin
-        const adminAddress = adminWallet.getCompleteAddress().address;
+        // const [deployerWallet, adminWallet] = wallets; // using first account as deployer and second as contract admin
+        const accounts = await Promise.all(
+            (await generateSchnorrAccounts(2)).map(
+                async a => await getSchnorrAccount(pxe, a.secret, a.signingKey, a.salt)
+            )
+        );
+        await Promise.all(accounts.map(a => a.deploy({ fee: { paymentMethod: sponsoredPaymentMethod } })));
+        const daWallets = await Promise.all(accounts.map(a => a.getWallet()));
+        const [deployerWallet, adminWallet] = daWallets;
+        const [deployerAddress, adminAddress] = daWallets.map(w => w.getAddress());
+        // const adminAddress = adminWallet.getCompleteAddress().address;
 
         const deploymentData = await getContractInstanceFromDeployParams(VotingContractArtifact,
             {
@@ -50,7 +63,10 @@ describe("Voting", () => {
                 deployer: deployerWallet.getAddress()
             });
         const deployer = new ContractDeployer(VotingContractArtifact, deployerWallet);
-        const tx = deployer.deploy(adminAddress).send({ contractAddressSalt: salt })
+        const tx = deployer.deploy(adminAddress).send({
+            contractAddressSalt: salt,
+            fee: { paymentMethod: sponsoredPaymentMethod } // without the sponsoredFPC the deployment fails, thus confirming it works
+        })
         const receipt = await tx.getReceipt();
 
         expect(receipt).toEqual(

src/test/sponsored_fee_payment_method.ts

@@ -0,0 +1,46 @@
+import type { FeePaymentMethod } from '@aztec/aztec.js';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { type FunctionCall, FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { PXE } from '@aztec/stdlib/interfaces/client';
+
+import { getDeployedSponsoredFPCAddress } from './sponsored_fpc.js';
+
+/**
+ * A payment method that uses the SponsoredFPCContract to pay the fee unconditionally.
+ */
+export class SponsoredFeePaymentMethod implements FeePaymentMethod {
+  constructor(
+    /**
+     * Contract which will pay the fee.
+     */
+    private paymentContract: AztecAddress,
+  ) {}
+
+  static async new(pxe: PXE) {
+    const sponsoredFPC = await getDeployedSponsoredFPCAddress(pxe);
+    return new SponsoredFeePaymentMethod(sponsoredFPC);
+  }
+
+  getAsset(): Promise<AztecAddress> {
+    return Promise.resolve(ProtocolContractAddress.FeeJuice);
+  }
+
+  getFeePayer(): Promise<AztecAddress> {
+    return Promise.resolve(this.paymentContract);
+  }
+
+  async getFunctionCalls(): Promise<FunctionCall[]> {
+    return [
+      {
+        name: 'sponsor_unconditionally',
+        to: this.paymentContract,
+        selector: await FunctionSelector.fromSignature('sponsor_unconditionally()'),
+        type: FunctionType.PRIVATE,
+        isStatic: false,
+        args: [],
+        returnTypes: [],
+      },
+    ];
+  }
+}

src/test/sponsored_fpc.ts

@@ -0,0 +1,38 @@
+import {
+  type ContractInstanceWithAddress,
+  Fr,
+  type PXE,
+  type Wallet,
+  getContractInstanceFromDeployParams,
+} from '@aztec/aztec.js';
+import type { LogFn } from '@aztec/foundation/log';
+import { SponsoredFPCContract } from '@aztec/noir-contracts.js/SponsoredFPC';
+
+const SPONSORED_FPC_SALT = new Fr(0);
+
+async function getSponsoredFPCInstance(): Promise<ContractInstanceWithAddress> {
+  return await getContractInstanceFromDeployParams(SponsoredFPCContract.artifact, {
+    salt: SPONSORED_FPC_SALT,
+  });
+}
+
+export async function getSponsoredFPCAddress() {
+  return (await getSponsoredFPCInstance()).address;
+}
+
+export async function setupSponsoredFPC(deployer: Wallet, log: LogFn) {
+  const deployed = await SponsoredFPCContract.deploy(deployer)
+    .send({ contractAddressSalt: SPONSORED_FPC_SALT, universalDeploy: true })
+    .deployed();
+
+  log(`SponsoredFPC: ${deployed.address}`);
+}
+
+export async function getDeployedSponsoredFPCAddress(pxe: PXE) {
+  const fpc = await getSponsoredFPCAddress();
+  const contracts = await pxe.getContracts();
+  if (!contracts.find(c => c.equals(fpc))) {
+    throw new Error('SponsoredFPC not deployed.');
+  }
+  return fpc;
+}