Merge pull request #92 from AztecProtocol/jc/pxe-service

Use independent PXE service instead of the one included in the sandbox

Author: critesjosh

.github/workflows/tests.yaml

@@ -47,4 +47,4 @@ jobs:
         run: script -e -c "NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --no-cache --runInBand --config jest.integration.config.json && aztec test"
 
       - name: Run scripts
-        run: script -e -c "yarn deploy && yarn deploy-account && yarn fees"
+        run: script -e -c "yarn deploy && yarn deploy-account && yarn fees && yarn multiple-pxe"

.gitignore

@@ -5,3 +5,4 @@ log/
 .vscode
 .DS_Store
 codegenCache.json
+store/

README.md

@@ -92,6 +92,8 @@ yarn codegen
 
 ---
 
+:warning: Tests and scripts set up and run the Private Execution Environment (PXE) and store PXE data in the `./store` directory. If you restart the sandbox, you will need to delete the `./store` directory to avoid errors.
+
 ## 🧪 **Test**
 
 **Make sure the sandbox is running before running tests.**
@@ -112,8 +114,19 @@ Note: The Typescript tests spawn an instance of the sandbox to test against, and
 
 ---
 
+## Scripts
+
+You can find a handful of scripts in the `./scripts` folder.
+
+- `./scripts/deploy-accounts.ts` is an example of how to deploy a schnorr account.
+- `./scripts/deploy.ts` is an example of how to deploy a contract.
+- `./scripts/fees.ts` is an example of how to pay for a contract deployment using various fee payment methods.
+- `./scripts/multiple_pxe.ts` is an example of how to deploy a contract from one PXE instance and interact with it from another.
+
 ## ❗ **Error Resolution**
 
+:warning: Tests and scripts set up and run the Private Execution Environment (PXE) and store PXE data in the `./store` directory. If you restart the sandbox, you will need to delete the `./store` directory to avoid errors.
+
 ### 🔄 **Update Node.js and Noir Dependencies**
 
 ```bash

package.json

@@ -10,13 +10,15 @@
   "scripts": {
     "fees": "node --loader ts-node/esm scripts/fees.ts",
     "clean": "rm -rf ./src/artifacts ./target",
+    "clear-store": "rm -rf ./store",
     "codegen": "aztec codegen target --outdir src/artifacts",
     "compile": "${AZTEC_NARGO:-aztec-nargo} compile",
-    "deploy": "node --loader ts-node/esm scripts/deploy-contract.ts",
-    "deploy-account": "node --loader ts-node/esm scripts/deploy-account.ts",
-    "get-block": "node --loader ts-node/esm scripts/getBlock.ts",
+    "deploy": "node --loader ts-node/esm scripts/deploy_contract.ts",
+    "deploy-account": "node --loader ts-node/esm scripts/deploy_account.ts",
+    "multiple-pxe": "node --loader ts-node/esm scripts/multiple_pxe.ts",
+    "get-block": "node --loader ts-node/esm scripts/get_block.ts",
     "test": "yarn test:js && yarn test:nr",
-    "test:js": "NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --no-cache --runInBand --config jest.integration.config.json",
+    "test:js": "rm -rf store/pxe && NODE_NO_WARNINGS=1 node --experimental-vm-modules $(yarn bin jest) --no-cache --runInBand --config jest.integration.config.json",
     "test:nr": "aztec test",
     "update": "aztec update --contract . && ./.github/scripts/update_contract.sh $(grep -oP 'tag\\s*=\\s*\"\\K[^\"]+' \"Nargo.toml\" | head -1) && yarn && yarn update-readme-version",
     "update-readme-version": "node ./.github/scripts/update-readme-version.js"
@@ -25,6 +27,8 @@
     "@aztec/accounts": "0.86.0",
     "@aztec/aztec.js": "0.86.0",
     "@aztec/noir-contracts.js": "0.86.0",
+    "@aztec/protocol-contracts": "0.86.0",
+    "@aztec/pxe": "0.86.0",
     "@aztec/stdlib": "0.86.0",
     "@types/node": "^22.5.1"
   },

scripts/deploy-contract.ts

@@ -0,0 +1,12 @@
+import { createLogger, Logger } from "@aztec/aztec.js";
+import { setupPXE } from "../src/utils/setup_pxe.js";
+import { deploySchnorrAccount } from "../src/utils/deploy_account.js";
+
+export async function deployAccount() {
+    let logger: Logger;
+    logger = createLogger('aztec:aztec-starter');
+    const pxe = await setupPXE()
+    await deploySchnorrAccount(pxe);
+}
+
+deployAccount();

scripts/deploy_account.ts

@@ -0,0 +1,30 @@
+import { EasyPrivateVotingContract } from "../src/artifacts/EasyPrivateVoting.js"
+import { createLogger, PXE, Logger, SponsoredFeePaymentMethod, Fr } from "@aztec/aztec.js";
+import { TokenContract } from "@aztec/noir-contracts.js/Token"
+import { setupPXE } from "../src/utils/setup_pxe.js";
+import { getSponsoredFPCInstance } from "../src/utils/sponsored_fpc.js";
+import { SponsoredFPCContract } from "@aztec/noir-contracts.js/SponsoredFPC";
+import { deploySchnorrAccount } from "../src/utils/deploy_account.js";
+
+async function main() {
+
+    let pxe: PXE;
+    let logger: Logger;
+
+    logger = createLogger('aztec:aztec-starter');
+
+    pxe = await setupPXE();
+
+    const sponsoredFPC = await getSponsoredFPCInstance();
+    await pxe.registerContract({ instance: sponsoredFPC, artifact: SponsoredFPCContract.artifact });
+    const sponsoredPaymentMethod = new SponsoredFeePaymentMethod(sponsoredFPC.address);
+
+    let accountManager = await deploySchnorrAccount(pxe);
+    const wallet = await accountManager.getWallet();
+    const address = await accountManager.getAddress();
+
+    const votingContract = await EasyPrivateVotingContract.deploy(wallet, address).send({ fee: { paymentMethod: sponsoredPaymentMethod } }).deployed();
+    logger.info(`Voting Contract deployed at: ${votingContract.address}`);
+}
+
+main();

scripts/deploy_contract.ts

@@ -1,12 +1,7 @@
-import { AccountWallet, CompleteAddress, createLogger, FeeJuicePaymentMethodWithClaim, Fr, L1FeeJuicePortalManager, PXE, waitForPXE , createPXEClient, Logger, FeeJuicePaymentMethod, PrivateFeePaymentMethod, PublicFeePaymentMethod } from "@aztec/aztec.js";
-import { getInitialTestAccountsWallets } from "@aztec/accounts/testing";
 import {
-    createPublicClient,
     createWalletClient,
     http,
 } from 'viem';
-import { getSchnorrAccount } from '@aztec/accounts/schnorr';
-import { deriveSigningKey } from '@aztec/stdlib/keys';
 import { foundry } from 'viem/chains'
 import { mnemonicToAccount } from 'viem/accounts';
 import { FeeJuiceContract } from "@aztec/noir-contracts.js/FeeJuice";
@@ -15,46 +10,46 @@ import { EasyPrivateVotingContract } from "../src/artifacts/EasyPrivateVoting.js
 import { TokenContract } from "@aztec/noir-contracts.js/Token";
 // TODO: replace with import from aztec.js when published
 import { SponsoredFeePaymentMethod } from '@aztec/aztec.js/fee/testing'
-import { getDeployedSponsoredFPCAddress } from "../src/utils/sponsored_fpc.js";
+import { getDeployedSponsoredFPCAddress, getSponsoredFPCInstance } from "../src/utils/sponsored_fpc.js";
 import { createEthereumChain, createExtendedL1Client } from "@aztec/ethereum";
-
-const setupSandbox = async () => {
-    const { PXE_URL = 'http://localhost:8080' } = process.env;
-    const pxe = await createPXEClient(PXE_URL);
-    await waitForPXE(pxe);
-    return pxe;
-};
+import { deploySchnorrAccount } from "../src/utils/deploy_account.js";
+import { setupPXE } from "../src/utils/setup_pxe.js";
+import { createLogger, FeeJuicePaymentMethod, FeeJuicePaymentMethodWithClaim, Fr, L1FeeJuicePortalManager, Logger, PrivateFeePaymentMethod, PublicFeePaymentMethod, PXE } from '@aztec/aztec.js';
+import { SponsoredFPCContract } from '@aztec/noir-contracts.js/SponsoredFPC';
+import { getCanonicalFeeJuice } from '@aztec/protocol-contracts/fee-juice';
+import { getSchnorrAccount } from '@aztec/accounts/schnorr';
+import { deriveSigningKey } from '@aztec/stdlib/keys';
 
 const MNEMONIC = 'test test test test test test test test test test test junk';
 const FEE_FUNDING_FOR_TESTER_ACCOUNT = 1000000000000000000n;
 
 let walletClient = getL1WalletClient(foundry.rpcUrls.default.http[0], 0);
 const ownerEthAddress = walletClient.account.address;
 
-
 async function main() {
 
     let pxe: PXE;
-    let wallets: AccountWallet[] = [];
     let logger: Logger;
 
     logger = createLogger('aztec:aztec-starter');
 
-    pxe = await setupSandbox();
-    wallets = await getInitialTestAccountsWallets(pxe);
+    pxe = await setupPXE();
+    // wallets = await getInitialTestAccountsWallets(pxe);
     const nodeInfo = (await pxe.getNodeInfo())
 
     const chain = createEthereumChain(['http://localhost:8545'], nodeInfo.l1ChainId);
     const l1Client = createExtendedL1Client(chain.rpcUrls, MNEMONIC, chain.chainInfo);
 
     // Setup Schnorr AccountManager
 
+    const account1 = await deploySchnorrAccount(pxe);
+    const wallet1 = await account1.getWallet();
+
     let secretKey = Fr.random();
     let salt = Fr.random();
-    let schnorrAccount = await getSchnorrAccount(pxe, secretKey, deriveSigningKey(secretKey), salt);
-    
-    const newWallet = await schnorrAccount.getWallet()
-    const feeJuiceReceipient = schnorrAccount.getAddress()
+    let account2 = await getSchnorrAccount(pxe, secretKey, deriveSigningKey(secretKey), salt);
+    const wallet2 = await account2.getWallet();
+    const feeJuiceRecipient = account2.getAddress();
 
     // Setup and bridge fee asset to L2 to get fee juice
 
@@ -65,26 +60,30 @@ async function main() {
         logger,
     );
 
-    const claim = await feeJuicePortalManager.bridgeTokensPublic(feeJuiceReceipient, FEE_FUNDING_FOR_TESTER_ACCOUNT, true);
+    const claim = await feeJuicePortalManager.bridgeTokensPublic(feeJuiceRecipient, FEE_FUNDING_FOR_TESTER_ACCOUNT, true);
+
+    logger.info(`Fee Juice minted to ${feeJuiceRecipient} on L2.`)
 
-    const feeJuice = await FeeJuiceContract.at(nodeInfo.protocolContractAddresses.feeJuice, wallets[0])
-    logger.info(`Fee Juice minted to ${feeJuiceReceipient} on L2.`)
+    // set up sponsored fee payments
+    const sponseredFPC = await getSponsoredFPCInstance();
+    await pxe.registerContract({ instance: sponseredFPC, artifact: SponsoredFPCContract.artifact });
+    const paymentMethod = new SponsoredFeePaymentMethod(sponseredFPC.address);
 
     // Two arbitraty txs to make the L1 message available on L2
-    const votingContract = await EasyPrivateVotingContract.deploy(wallets[0], wallets[0].getAddress()).send().deployed();
-    const bananaCoin = await TokenContract.deploy(wallets[0], wallets[0].getAddress(), "bananaCoin", "BNC", 18).send().deployed()
+    const votingContract = await EasyPrivateVotingContract.deploy(wallet1, wallet1.getAddress()).send({ fee: { paymentMethod } }).deployed();
+    const bananaCoin = await TokenContract.deploy(wallet1, wallet1.getAddress(), "bananaCoin", "BNC", 18).send({ fee: { paymentMethod } }).deployed()
 
     // Claim Fee Juice & Pay Fees yourself
 
-    const claimAndPay = new FeeJuicePaymentMethodWithClaim(newWallet, claim)
-    await schnorrAccount.deploy({ fee: { paymentMethod: claimAndPay } }).wait()
-    logger.info(`New account at ${newWallet.getAddress()} deployed using claimed funds for fees.`)
+    const claimAndPay = new FeeJuicePaymentMethodWithClaim(wallet2, claim)
+    await account2.deploy({ fee: { paymentMethod: claimAndPay } }).wait()
+    logger.info(`New account at ${account2.getAddress()} deployed using claimed funds for fees.`)
 
     // Pay fees yourself
 
     // Create a new voting contract instance, interacting from the newWallet
-    const useFeeJuice = new FeeJuicePaymentMethod(newWallet.getAddress())
-    await votingContract.withWallet(newWallet).methods.cast_vote(wallets[0].getAddress()).send({ fee: { paymentMethod: useFeeJuice }}).wait()
+    const useFeeJuice = new FeeJuicePaymentMethod(account2.getAddress())
+    await votingContract.withWallet(wallet2).methods.cast_vote(wallet1.getAddress()).send({ fee: { paymentMethod: useFeeJuice } }).wait()
     logger.info(`Vote cast from new account, paying fees via newWallet.`)
 
     // Private Fee Payments via FPC
@@ -93,38 +92,40 @@ async function main() {
     // Need to deploy an FPC to use Private Fee payment methods
 
     // This uses bananaCoin as the fee paying asset that will be exchanged for fee juice
-    const fpc = await FPCContract.deploy(wallets[0], bananaCoin.address, wallets[0].getAddress()).send().deployed()
+    const fpc = await FPCContract.deploy(wallet1, bananaCoin.address, wallet1.getAddress()).send({ fee: { paymentMethod } }).deployed()
     const fpcClaim = await feeJuicePortalManager.bridgeTokensPublic(fpc.address, FEE_FUNDING_FOR_TESTER_ACCOUNT, true);
     // 2 public txs to make the bridged fee juice available
     // Mint some bananaCoin and send to the newWallet to pay fees privately
-    await bananaCoin.methods.mint_to_private(wallets[0].getAddress(), newWallet.getAddress(), FEE_FUNDING_FOR_TESTER_ACCOUNT).send().wait()
+    await bananaCoin.methods.mint_to_private(wallet1.getAddress(), wallet2.getAddress(), FEE_FUNDING_FOR_TESTER_ACCOUNT).send({ fee: { paymentMethod } }).wait()
     // mint some public bananaCoin to the newWallet to pay fees publicly
-    await bananaCoin.methods.mint_to_public(newWallet.getAddress(), FEE_FUNDING_FOR_TESTER_ACCOUNT).send().wait()
-    const bananaBalance = await bananaCoin.withWallet(newWallet).methods.balance_of_private(newWallet.getAddress()).simulate()
+    await bananaCoin.methods.mint_to_public(wallet2.getAddress(), FEE_FUNDING_FOR_TESTER_ACCOUNT).send({ fee: { paymentMethod } }).wait()
+    const bananaBalance = await bananaCoin.withWallet(wallet2).methods.balance_of_private(wallet2.getAddress()).simulate()
 
     logger.info(`BananaCoin balance of newWallet is ${bananaBalance}`)
 
+    const feeJuiceInstance = await getCanonicalFeeJuice();
+    const feeJuice = await FeeJuiceContract.at(feeJuiceInstance.address, wallet2)
     await feeJuice.methods.claim(fpc.address, fpcClaim.claimAmount, fpcClaim.claimSecret, fpcClaim.messageLeafIndex).send().wait()
 
     logger.info(`Fpc fee juice balance ${await feeJuice.methods.balance_of_public(fpc.address).simulate()}`)
 
-    const privateFee = new PrivateFeePaymentMethod(fpc.address, newWallet)    
-    await bananaCoin.withWallet(newWallet).methods.transfer_in_private(newWallet.getAddress(), wallets[0].getAddress(), 10, 0).send({ fee: { paymentMethod: privateFee }}).wait()
-    
+    const privateFee = new PrivateFeePaymentMethod(fpc.address, wallet2)
+    await bananaCoin.withWallet(wallet2).methods.transfer_in_private(wallet2.getAddress(), wallet1.getAddress(), 10, 0).send({ fee: { paymentMethod: privateFee } }).wait()
+
     logger.info(`Transfer paid with fees via the FPC, privately.`)
 
     // Public Fee Payments via FPC
 
-    const publicFee = new PublicFeePaymentMethod(fpc.address, newWallet)
-    await bananaCoin.withWallet(newWallet).methods.transfer_in_private(newWallet.getAddress(), wallets[0].getAddress(), 10, 0).send({ fee: { paymentMethod: publicFee }}).wait()
+    const publicFee = new PublicFeePaymentMethod(fpc.address, wallet2)
+    await bananaCoin.withWallet(wallet2).methods.transfer_in_private(wallet2.getAddress(), wallet1.getAddress(), 10, 0).send({ fee: { paymentMethod: publicFee } }).wait()
     logger.info(`Transfer paid with fees via the FPC, publicly.`)
 
     // Sponsored Fee Payment
 
     // This method will only work in environments where there is a sponsored fee contract deployed 
     const deployedSponseredFPC = await getDeployedSponsoredFPCAddress(pxe);
     const sponsoredPaymentMethod = new SponsoredFeePaymentMethod(deployedSponseredFPC);
-    await bananaCoin.withWallet(newWallet).methods.transfer_in_private(newWallet.getAddress(), wallets[0].getAddress(), 10, 0).send({ fee: { paymentMethod: sponsoredPaymentMethod }}).wait()
+    await bananaCoin.withWallet(wallet2).methods.transfer_in_private(wallet2.getAddress(), wallet1.getAddress(), 10, 0).send({ fee: { paymentMethod: sponsoredPaymentMethod } }).wait()
     logger.info(`Transfer paid with fees from Sponsored FPC.`)
 }
 
@@ -138,4 +139,5 @@ function getL1WalletClient(rpcUrl: string, index: number) {
         chain: foundry,
         transport: http(rpcUrl),
     });
-}
+}
+

scripts/fees.ts

@@ -0,0 +1,14 @@
+import { PXE } from "@aztec/aztec.js";
+import { setupPXE } from "../src/utils/setup_pxe.js";
+
+async function main() {
+
+    let pxe: PXE;
+    pxe = await setupPXE();
+
+    let block = await pxe.getBlock(1);
+    console.log(block)
+    console.log(await block?.hash())
+}
+
+main();