@aztec/pxe 0.0.1-fake-ceab37513c → 0.0.6-commit.a2d1860fe9

package/dest/storage/tagging_data_provider/tagging_data_provider.js

@@ -1,82 +0,0 @@
-import { toArray } from '@aztec/foundation/iterable';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-export class TaggingDataProvider {
-    #store;
-    #addressBook;
-    // Stores the last index used for each tagging secret, taking direction into account
-    // This is necessary to avoid reusing the same index for the same secret, which happens if
-    // sender and recipient are the same
-    #taggingSecretIndexesForSenders;
-    #taggingSecretIndexesForRecipients;
-    constructor(store){
-        this.#store = store;
-        this.#addressBook = this.#store.openMap('address_book');
-        this.#taggingSecretIndexesForSenders = this.#store.openMap('tagging_secret_indexes_for_senders');
-        this.#taggingSecretIndexesForRecipients = this.#store.openMap('tagging_secret_indexes_for_recipients');
-    }
-    setTaggingSecretsIndexesAsSender(indexedSecrets, sender) {
-        return this.#setTaggingSecretsIndexes(indexedSecrets, this.#taggingSecretIndexesForSenders, sender);
-    }
-    setTaggingSecretsIndexesAsRecipient(indexedSecrets, recipient) {
-        return this.#setTaggingSecretsIndexes(indexedSecrets, this.#taggingSecretIndexesForRecipients, recipient);
-    }
-    /**
-   * Sets the indexes of the tagging secrets for the given app tagging secrets in the direction of the given address.
-   * @dev We need to specify the direction because app tagging secrets are direction-less due to the way they are generated
-   * but we need to guarantee that the index is stored under a uni-directional key because the tags are themselves
-   * uni-directional.
-   * @param indexedSecrets - The app tagging secrets and indexes to set.
-   * @param storageMap - The storage map to set the indexes in.
-   * @param inDirectionOf - The address that the secrets are in the direction of.
-   */ #setTaggingSecretsIndexes(indexedSecrets, storageMap, inDirectionOf) {
-        return Promise.all(indexedSecrets.map((indexedSecret)=>storageMap.set(`${indexedSecret.appTaggingSecret.toString()}_${inDirectionOf.toString()}`, indexedSecret.index)));
-    }
-    getTaggingSecretsIndexesAsRecipient(appTaggingSecrets, recipient) {
-        return this.#getTaggingSecretsIndexes(appTaggingSecrets, this.#taggingSecretIndexesForRecipients, recipient);
-    }
-    getTaggingSecretsIndexesAsSender(appTaggingSecrets, sender) {
-        return this.#getTaggingSecretsIndexes(appTaggingSecrets, this.#taggingSecretIndexesForSenders, sender);
-    }
-    /**
-   * Returns the indexes of the tagging secrets for the given app tagging secrets in the direction of the given address.
-   * @dev We need to specify the direction because app tagging secrets are direction-less due to the way they are generated
-   * but we need to guarantee that the index is stored under a uni-directional key because the tags are themselves
-   * uni-directional.
-   * @param appTaggingSecrets - The app tagging secrets to get the indexes for.
-   * @param storageMap - The storage map to get the indexes from.
-   * @param inDirectionOf - The address that the secrets are in the direction of.
-   * @returns The indexes of the tagging secrets.
-   */ #getTaggingSecretsIndexes(appTaggingSecrets, storageMap, inDirectionOf) {
-        return Promise.all(appTaggingSecrets.map(async (secret)=>await storageMap.getAsync(`${secret.toString()}_${inDirectionOf.toString()}`) ?? 0));
-    }
-    resetNoteSyncData() {
-        return this.#store.transactionAsync(async ()=>{
-            const recipients = await toArray(this.#taggingSecretIndexesForRecipients.keysAsync());
-            await Promise.all(recipients.map((recipient)=>this.#taggingSecretIndexesForRecipients.delete(recipient)));
-            const senders = await toArray(this.#taggingSecretIndexesForSenders.keysAsync());
-            await Promise.all(senders.map((sender)=>this.#taggingSecretIndexesForSenders.delete(sender)));
-        });
-    }
-    async addSenderAddress(address) {
-        if (await this.#addressBook.hasAsync(address.toString())) {
-            return false;
-        }
-        await this.#addressBook.set(address.toString(), true);
-        return true;
-    }
-    async getSenderAddresses() {
-        return (await toArray(this.#addressBook.keysAsync())).map(AztecAddress.fromString);
-    }
-    async removeSenderAddress(address) {
-        if (!await this.#addressBook.hasAsync(address.toString())) {
-            return false;
-        }
-        await this.#addressBook.delete(address.toString());
-        return true;
-    }
-    async getSize() {
-        const addressesCount = (await toArray(this.#addressBook.keysAsync())).length;
-        // All keys are addresses
-        return 3 * addressesCount * AztecAddress.SIZE_IN_BYTES;
-    }
-}

package/dest/synchronizer/index.d.ts

@@ -1,2 +0,0 @@
-export * from './synchronizer.js';
-//# sourceMappingURL=index.d.ts.map

package/dest/synchronizer/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/synchronizer/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC"}

package/dest/synchronizer/index.js

@@ -1 +0,0 @@
-export * from './synchronizer.js';

package/dest/synchronizer/synchronizer.d.ts

@@ -1,35 +0,0 @@
-import { type Logger } from '@aztec/foundation/log';
-import type { L2TipsKVStore } from '@aztec/kv-store/stores';
-import { L2BlockStream, type L2BlockStreamEvent, type L2BlockStreamEventHandler } from '@aztec/stdlib/block';
-import type { AztecNode } from '@aztec/stdlib/interfaces/client';
-import type { PXEConfig } from '../config/index.js';
-import type { NoteDataProvider } from '../storage/note_data_provider/note_data_provider.js';
-import type { SyncDataProvider } from '../storage/sync_data_provider/sync_data_provider.js';
-import type { TaggingDataProvider } from '../storage/tagging_data_provider/tagging_data_provider.js';
-/**
- * The Synchronizer class orchestrates synchronization between the PXE and Aztec node, maintaining an up-to-date
- * view of the L2 chain state. It handles block header retrieval, chain reorganizations, and provides an interface
- * for querying sync status.
- */
-export declare class Synchronizer implements L2BlockStreamEventHandler {
-    private node;
-    private syncDataProvider;
-    private noteDataProvider;
-    private taggingDataProvider;
-    private l2TipsStore;
-    private log;
-    private isSyncing;
-    protected readonly blockStream: L2BlockStream;
-    constructor(node: AztecNode, syncDataProvider: SyncDataProvider, noteDataProvider: NoteDataProvider, taggingDataProvider: TaggingDataProvider, l2TipsStore: L2TipsKVStore, config?: Partial<Pick<PXEConfig, 'l2BlockBatchSize'>>, loggerOrSuffix?: string | Logger);
-    protected createBlockStream(config: Partial<Pick<PXEConfig, 'l2BlockBatchSize'>>): L2BlockStream;
-    /** Handle events emitted by the block stream. */
-    handleBlockStreamEvent(event: L2BlockStreamEvent): Promise<void>;
-    /**
-     * Syncs PXE and the node by downloading the metadata of the latest blocks, allowing simulations to use
-     * recent data (e.g. notes), and handling any reorgs that might have occurred.
-     */
-    sync(): Promise<void>;
-    private doSync;
-    getSynchedBlockNumber(): Promise<number>;
-}
-//# sourceMappingURL=synchronizer.d.ts.map

package/dest/synchronizer/synchronizer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"synchronizer.d.ts","sourceRoot":"","sources":["../../src/synchronizer/synchronizer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAgB,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAC7G,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qDAAqD,CAAC;AAC5F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qDAAqD,CAAC;AAC5F,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2DAA2D,CAAC;AAErG;;;;GAIG;AACH,qBAAa,YAAa,YAAW,yBAAyB;IAM1D,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,gBAAgB;IACxB,OAAO,CAAC,gBAAgB;IACxB,OAAO,CAAC,mBAAmB;IAC3B,OAAO,CAAC,WAAW;IATrB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,SAAS,CAA4B;IAC7C,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC;gBAGpC,IAAI,EAAE,SAAS,EACf,gBAAgB,EAAE,gBAAgB,EAClC,gBAAgB,EAAE,gBAAgB,EAClC,mBAAmB,EAAE,mBAAmB,EACxC,WAAW,EAAE,aAAa,EAClC,MAAM,GAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAM,EACzD,cAAc,CAAC,EAAE,MAAM,GAAG,MAAM;IASlC,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IAShF,iDAAiD;IACpC,sBAAsB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC7E;;;OAGG;IACU,IAAI;YAiBH,MAAM;IAeb,qBAAqB;CAG7B"}

package/dest/synchronizer/synchronizer.js

@@ -1,102 +0,0 @@
-import { createLogger } from '@aztec/foundation/log';
-import { L2BlockStream } from '@aztec/stdlib/block';
-/**
- * The Synchronizer class orchestrates synchronization between the PXE and Aztec node, maintaining an up-to-date
- * view of the L2 chain state. It handles block header retrieval, chain reorganizations, and provides an interface
- * for querying sync status.
- */ export class Synchronizer {
-    node;
-    syncDataProvider;
-    noteDataProvider;
-    taggingDataProvider;
-    l2TipsStore;
-    log;
-    isSyncing;
-    blockStream;
-    constructor(node, syncDataProvider, noteDataProvider, taggingDataProvider, l2TipsStore, config = {}, loggerOrSuffix){
-        this.node = node;
-        this.syncDataProvider = syncDataProvider;
-        this.noteDataProvider = noteDataProvider;
-        this.taggingDataProvider = taggingDataProvider;
-        this.l2TipsStore = l2TipsStore;
-        this.log = !loggerOrSuffix || typeof loggerOrSuffix === 'string' ? createLogger(loggerOrSuffix ? `pxe:synchronizer:${loggerOrSuffix}` : `pxe:synchronizer`) : loggerOrSuffix;
-        this.blockStream = this.createBlockStream(config);
-    }
-    createBlockStream(config) {
-        return new L2BlockStream(this.node, this.l2TipsStore, this, createLogger('pxe:block_stream'), {
-            batchSize: config.l2BlockBatchSize,
-            // Skipping finalized blocks makes us sync much faster - we only need to download blocks other than the latest one
-            // in order to detect reorgs, and there can be no reorgs on finalized block, making this safe.
-            skipFinalized: true
-        });
-    }
-    /** Handle events emitted by the block stream. */ async handleBlockStreamEvent(event) {
-        await this.l2TipsStore.handleBlockStreamEvent(event);
-        switch(event.type){
-            case 'blocks-added':
-                {
-                    const lastBlock = event.blocks.at(-1).block;
-                    this.log.verbose(`Updated pxe last block to ${lastBlock.number}`, {
-                        blockHash: lastBlock.hash(),
-                        archive: lastBlock.archive.root.toString(),
-                        header: lastBlock.header.toInspect()
-                    });
-                    await this.syncDataProvider.setHeader(lastBlock.header);
-                    break;
-                }
-            case 'chain-pruned':
-                {
-                    this.log.warn(`Pruning data after block ${event.block.number} due to reorg`);
-                    // We first unnullify and then remove so that unnullified notes that were created after the block number end up deleted.
-                    const lastSynchedBlockNumber = await this.syncDataProvider.getBlockNumber();
-                    await this.noteDataProvider.unnullifyNotesAfter(event.block.number, lastSynchedBlockNumber);
-                    await this.noteDataProvider.removeNotesAfter(event.block.number);
-                    // Remove all note tagging indexes to force a full resync. This is suboptimal, but unless we track the
-                    // block number in which each index is used it's all we can do.
-                    await this.taggingDataProvider.resetNoteSyncData();
-                    // Update the header to the last block.
-                    const newHeader = await this.node.getBlockHeader(event.block.number);
-                    if (!newHeader) {
-                        this.log.error(`Block header not found for block number ${event.block.number} during chain prune`);
-                    } else {
-                        await this.syncDataProvider.setHeader(newHeader);
-                    }
-                    break;
-                }
-        }
-    }
-    /**
-   * Syncs PXE and the node by downloading the metadata of the latest blocks, allowing simulations to use
-   * recent data (e.g. notes), and handling any reorgs that might have occurred.
-   */ async sync() {
-        if (this.isSyncing !== undefined) {
-            this.log.debug(`Waiting for the ongoing sync to finish`);
-            await this.isSyncing;
-            return;
-        }
-        this.log.debug(`Syncing PXE with the node`);
-        const isSyncing = this.doSync();
-        this.isSyncing = isSyncing;
-        try {
-            await isSyncing;
-        } finally{
-            this.isSyncing = undefined;
-        }
-    }
-    async doSync() {
-        let currentHeader;
-        try {
-            currentHeader = await this.syncDataProvider.getBlockHeader();
-        } catch  {
-            this.log.debug('Header is not set, requesting from the node');
-        }
-        if (!currentHeader) {
-            // REFACTOR: We should know the header of the genesis block without having to request it from the node.
-            await this.syncDataProvider.setHeader(await this.node.getBlockHeader(0));
-        }
-        await this.blockStream.sync();
-    }
-    getSynchedBlockNumber() {
-        return this.syncDataProvider.getBlockNumber();
-    }
-}

package/dest/test/pxe_test_suite.d.ts

@@ -1,3 +0,0 @@
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-export declare const pxeTestSuite: (testName: string, pxeSetup: () => Promise<PXE>) => void;
-//# sourceMappingURL=pxe_test_suite.d.ts.map

package/dest/test/pxe_test_suite.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"pxe_test_suite.d.ts","sourceRoot":"","sources":["../../src/test/pxe_test_suite.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAS3D,eAAO,MAAM,YAAY,GAAI,UAAU,MAAM,EAAE,UAAU,MAAM,OAAO,CAAC,GAAG,CAAC,SAmG1E,CAAC"}

package/dest/test/pxe_test_suite.js

@@ -1,97 +0,0 @@
-import { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { getContractClassFromArtifact } from '@aztec/stdlib/contract';
-import { randomContractArtifact, randomContractInstanceWithAddress, randomDeployedContract } from '@aztec/stdlib/testing';
-import omit from 'lodash.omit';
-export const pxeTestSuite = (testName, pxeSetup)=>{
-    describe(testName, ()=>{
-        let pxe;
-        beforeAll(async ()=>{
-            pxe = await pxeSetup();
-        }, 120_000);
-        it('registers an account and returns it as an account only and not as a recipient', async ()=>{
-            const randomSecretKey = Fr.random();
-            const randomPartialAddress = Fr.random();
-            const completeAddress = await pxe.registerAccount(randomSecretKey, randomPartialAddress);
-            // Check that the account is correctly registered using the getAccounts and getRecipients methods
-            const accounts = await pxe.getRegisteredAccounts();
-            expect(accounts).toContainEqual(completeAddress);
-        });
-        it('does not throw when registering the same account twice (just ignores the second attempt)', async ()=>{
-            const randomSecretKey = Fr.random();
-            const randomPartialAddress = Fr.random();
-            await pxe.registerAccount(randomSecretKey, randomPartialAddress);
-            await pxe.registerAccount(randomSecretKey, randomPartialAddress);
-        });
-        it('successfully adds a contract', async ()=>{
-            const contracts = await Promise.all([
-                randomDeployedContract(),
-                randomDeployedContract()
-            ]);
-            for (const contract of contracts){
-                await pxe.registerContract(contract);
-            }
-            const expectedContractAddresses = contracts.map((contract)=>contract.instance.address);
-            const contractAddresses = await pxe.getContracts();
-            expect(contractAddresses).toEqual(expect.arrayContaining(expectedContractAddresses));
-        });
-        it('registers a class and adds a contract for it', async ()=>{
-            const artifact = randomContractArtifact();
-            const contractClass = await getContractClassFromArtifact(artifact);
-            const contractClassId = contractClass.id;
-            const instance = await randomContractInstanceWithAddress({
-                contractClassId
-            });
-            await pxe.registerContractClass(artifact);
-            expect((await pxe.getContractClassMetadata(contractClassId)).contractClass).toMatchObject(omit(contractClass, 'privateFunctionsRoot', 'publicBytecodeCommitment'));
-            await pxe.registerContract({
-                instance
-            });
-            expect((await pxe.getContractMetadata(instance.address)).contractInstance).toEqual(instance);
-        });
-        it('refuses to register a class with a mismatched address', async ()=>{
-            const artifact = randomContractArtifact();
-            const contractClass = await getContractClassFromArtifact(artifact);
-            const contractClassId = contractClass.id;
-            const instance = await randomContractInstanceWithAddress({
-                contractClassId
-            });
-            await expect(pxe.registerContract({
-                instance: {
-                    ...instance,
-                    address: await AztecAddress.random()
-                },
-                artifact
-            })).rejects.toThrow(/Added a contract in which the address does not match the contract instance./);
-        });
-        it('refuses to register a contract with a class that has not been registered', async ()=>{
-            const instance = await randomContractInstanceWithAddress();
-            await expect(pxe.registerContract({
-                instance
-            })).rejects.toThrow(/Artifact not found when registering an instance/);
-        });
-        it('refuses to register a contract with an artifact with mismatching class id', async ()=>{
-            const artifact = randomContractArtifact();
-            const instance = await randomContractInstanceWithAddress();
-            await expect(pxe.registerContract({
-                instance,
-                artifact
-            })).rejects.toThrow(/Artifact does not match/i);
-        });
-        // Note: Not testing a successful run of `proveTx`, `sendTx`, `getTxReceipt` and `simulateUtility` here as it
-        //       requires a larger setup and it's sufficiently tested in the e2e tests.
-        // Note: Not testing `getContractData`, `getPublicLogs` and `getPublicStorageAt` here as these
-        //       functions only call AztecNode and these methods are frequently used by the e2e tests.
-        it('successfully gets a block number', async ()=>{
-            const blockNum = await pxe.getBlockNumber();
-            expect(blockNum).toBeGreaterThanOrEqual(INITIAL_L2_BLOCK_NUM);
-        });
-        it('successfully gets node info', async ()=>{
-            const nodeInfo = await pxe.getNodeInfo();
-            expect(typeof nodeInfo.rollupVersion).toEqual('number');
-            expect(typeof nodeInfo.l1ChainId).toEqual('number');
-            expect(nodeInfo.l1ContractAddresses.rollupAddress.toString()).toMatch(/0x[a-fA-F0-9]+/);
-        });
-    });
-};

package/src/bin/index.ts

@@ -1,62 +0,0 @@
-#!/usr/bin/env -S node --no-warnings
-import { type SafeJsonRpcServerOptions, createNamespacedSafeJsonRpcServer } from '@aztec/foundation/json-rpc/server';
-import { createLogger } from '@aztec/foundation/log';
-import { type PXE, PXESchema, createAztecNodeClient } from '@aztec/stdlib/interfaces/client';
-
-import http from 'http';
-
-import { getPXEServiceConfig } from '../config/index.js';
-import { createPXEService } from '../entrypoints/server/utils.js';
-
-const { PXE_PORT = 8080, AZTEC_NODE_URL = 'http://localhost:8079' } = process.env;
-
-const logger = createLogger('pxe:service');
-
-/**
- * Creates an http server that forwards calls to the PXE and starts it on the given port.
- * @param pxeService - PXE that answers queries to the created HTTP server.
- * @param port - Port to listen in.
- * @param maxBatchSize - Maximum allowed batch size for JSON RPC batch requests.
- * @returns A running http server.
- */
-function startPXEHttpServer(
-  pxeService: PXE,
-  port: string | number,
-  opts: Pick<SafeJsonRpcServerOptions, 'maxBatchSize'> = {},
-): http.Server {
-  const rpcServer = createNamespacedSafeJsonRpcServer({ pxe: [pxeService, PXESchema] }, opts);
-
-  const app = rpcServer.getApp();
-  // eslint-disable-next-line @typescript-eslint/no-misused-promises
-  const httpServer = http.createServer(app.callback());
-  httpServer.listen(port);
-
-  return httpServer;
-}
-
-/**
- * Create and start a new PXE HTTP Server
- */
-async function main() {
-  logger.info(`Setting up PXE...`);
-
-  const pxeConfig = getPXEServiceConfig();
-  const nodeRpcClient = createAztecNodeClient(AZTEC_NODE_URL, {});
-  const pxeService = await createPXEService(nodeRpcClient, pxeConfig);
-
-  const shutdown = () => {
-    logger.info('Shutting down...');
-    process.exit(0);
-  };
-
-  process.once('SIGINT', shutdown);
-  process.once('SIGTERM', shutdown);
-
-  startPXEHttpServer(pxeService, PXE_PORT);
-  logger.info(`PXE listening on port ${PXE_PORT}`);
-}
-
-main().catch(err => {
-  logger.error(err);
-  process.exit(1);
-});