@aztec/pxe 5.0.0-rc.1 → 5.0.0-rc.2

package/src/storage/backwards_compatibility_tests/schema_tests.ts

@@ -2,6 +2,7 @@
 import { CONTRACT_CLASS_LOG_SIZE_IN_FIELDS, PRIVATE_LOG_SIZE_IN_FIELDS } from '@aztec/constants';
 import { BlockNumber, CheckpointNumber, IndexWithinCheckpoint, SlotNumber } from '@aztec/foundation/branded-types';
 import { Fr } from '@aztec/foundation/curves/bn254';
+import { Point } from '@aztec/foundation/curves/grumpkin';
 import { EthAddress } from '@aztec/foundation/eth-address';
 import type { Tuple } from '@aztec/foundation/serialize';
 import { KeyStore } from '@aztec/key-store';
@@ -39,9 +40,11 @@ import { AddressStore } from '../address_store/address_store.js';
 import { AnchorBlockStore } from '../anchor_block_store/index.js';
 import { CapsuleStore } from '../capsule_store/capsule_store.js';
 import { ContractStore } from '../contract_store/contract_store.js';
+import { FactStore } from '../fact_store/fact_store.js';
+import { FactCollectionKey } from '../fact_store/fact_store_keys.js';
 import { NoteStore } from '../note_store/note_store.js';
 import { PrivateEventStore } from '../private_event_store/private_event_store.js';
-import { RecipientTaggingStore, SenderAddressBookStore, SenderTaggingStore } from '../tagging_store/index.js';
+import { RecipientTaggingStore, SenderTaggingStore, TaggingSecretSourcesStore } from '../tagging_store/index.js';
 import { snapshotArray, snapshotMap, snapshotSingleton } from './kv_store_snapshot.js';
 
 /**
@@ -106,7 +109,7 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
             SlotNumber(47),
             53n,
             EthAddress.fromField(new Fr(59n)),
-            AztecAddress.fromBigInt(61n),
+            AztecAddress.fromBigIntUnsafe(61n),
             new GasFees(67n, 71n),
           ),
           new Fr(73n),
@@ -125,8 +128,8 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
       const capsuleStore = new CapsuleStore(kvStore);
 
       const jobId = 'fixture-job';
-      const contractAddress = AztecAddress.fromBigInt(2n);
-      const scope = AztecAddress.fromBigInt(3n);
+      const contractAddress = AztecAddress.fromBigIntUnsafe(2n);
+      const scope = AztecAddress.fromBigIntUnsafe(3n);
 
       // Three setCapsule calls (2-element, 1-element, 0-element value vector) pin every value-encoding length case.
       capsuleStore.setCapsule(contractAddress, new Fr(5n), [new Fr(7n), new Fr(11n)], jobId, scope);
@@ -188,7 +191,7 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
         new SerializableContractInstance({
           version: 2,
           salt: new Fr(73n),
-          deployer: AztecAddress.fromBigInt(79n),
+          deployer: AztecAddress.fromBigIntUnsafe(79n),
           currentContractClassId: new Fr(83n),
           originalContractClassId: new Fr(89n),
           initializationHash: new Fr(97n),
@@ -204,7 +207,7 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
             new Fr(71n),
             new Fr(73n),
           ),
-        }).withAddress(AztecAddress.fromBigInt(101n)),
+        }).withAddress(AztecAddress.fromBigIntUnsafe(101n)),
       );
     },
     snapshotStore: async kvStore => ({
@@ -214,6 +217,40 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
     }),
   },
 
+  {
+    name: 'FactStore',
+    writeToStore: async kvStore => {
+      const factStore = new FactStore(kvStore);
+      const jobId = 'fixture-job';
+      const contract = AztecAddress.fromBigIntUnsafe(100n);
+      const scope = AztecAddress.fromBigIntUnsafe(1n);
+      const factCollectionTypeId = new Fr(7n);
+      const keyA = FactCollectionKey.from({
+        contractAddress: contract,
+        scope,
+        factCollectionTypeId,
+        factCollectionId: new Fr(0xaan),
+      });
+      const keyB = FactCollectionKey.from({
+        contractAddress: contract,
+        scope,
+        factCollectionTypeId,
+        factCollectionId: new Fr(0xbbn),
+      });
+      // A collection whose only fact is retractable (origin block 6): pruned on a reorg above block 6.
+      await factStore.recordFact(keyA, new Fr(3n), [new Fr(5n)], { blockNumber: 6, blockHash: new Fr(2n) }, jobId);
+      // A collection with a non-retractable and a retractable fact.
+      await factStore.recordFact(keyB, new Fr(1n), [new Fr(9n)], undefined, jobId);
+      await factStore.recordFact(keyB, new Fr(2n), [], { blockNumber: 5, blockHash: new Fr(1n) }, jobId);
+      await kvStore.transactionAsync(() => factStore.commit(jobId));
+    },
+    snapshotStore: async kvStore => ({
+      facts: await snapshotMap(kvStore.openMap<string, Buffer>('facts')),
+      facts_by_collection: await snapshotMap(kvStore.openMultiMap<string, string>('facts_by_collection')),
+      facts_by_block: await snapshotMap(kvStore.openMultiMap<number, string>('facts_by_block')),
+    }),
+  },
+
   {
     name: 'KeyStore',
     writeToStore: async kvStore => {
@@ -243,9 +280,10 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
             SlotNumber(19),
             23n,
             EthAddress.fromField(new Fr(29n)),
-            AztecAddress.fromBigInt(31n),
+            AztecAddress.fromBigIntUnsafe(31n),
             new GasFees(37n, 41n),
             new Fr(43n),
+            new Fr(47n),
           ),
           [block],
           CheckpointNumber(47),
@@ -261,7 +299,10 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
       await l2TipsStore.handleBlockStreamEvent({
         type: 'chain-checkpointed',
         block: { number: BlockNumber(71), hash: new Fr(73n).toString() },
-        checkpoint: publishedCheckpoint,
+        checkpoint: {
+          number: publishedCheckpoint.checkpoint.number,
+          hash: publishedCheckpoint.checkpoint.hash().toString(),
+        },
       });
       // `'chain-proven'` writes the 'proven' tag. `'finalized'` is omitted because its handler runs delete-before
       // logic that would depend on the order of preceding events.
@@ -289,17 +330,17 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
 
       // Two contracts so `note_nullifiers_by_contract` exhibits both a multi-value row (contractA → {n1, n2}) and a
       // single-value row (contractB → {n3}).
-      const contractA = AztecAddress.fromBigInt(2n);
-      const contractB = AztecAddress.fromBigInt(3n);
-      const scopeX = AztecAddress.fromBigInt(5n);
-      const scopeY = AztecAddress.fromBigInt(7n);
+      const contractA = AztecAddress.fromBigIntUnsafe(2n);
+      const contractB = AztecAddress.fromBigIntUnsafe(3n);
+      const scopeX = AztecAddress.fromBigIntUnsafe(5n);
+      const scopeY = AztecAddress.fromBigIntUnsafe(7n);
 
       // note1: active, will be added under two scopes to exercise the multi-element scopes vector encoding in
       // `StoredNote.toBuffer`.
       const note1 = new NoteDao(
         new Note([new Fr(13n), new Fr(17n), new Fr(19n)]),
         contractA,
-        AztecAddress.fromBigInt(23n),
+        AztecAddress.fromBigIntUnsafe(23n),
         new Fr(29n),
         new Fr(31n),
         new Fr(37n),
@@ -316,7 +357,7 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
       const note2 = new NoteDao(
         new Note([new Fr(71n), new Fr(73n), new Fr(79n)]),
         contractA,
-        AztecAddress.fromBigInt(83n),
+        AztecAddress.fromBigIntUnsafe(83n),
         new Fr(89n),
         new Fr(97n),
         new Fr(101n),
@@ -334,7 +375,7 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
       const note3 = new NoteDao(
         new Note([new Fr(139n), new Fr(149n), new Fr(151n)]),
         contractB,
-        AztecAddress.fromBigInt(157n),
+        AztecAddress.fromBigIntUnsafe(157n),
         new Fr(163n),
         new Fr(167n),
         new Fr(173n),
@@ -387,12 +428,12 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
 
       // Two (contract, selector) pairs and two block numbers so each multimap exhibits both a multi-value row
       // (contractA/selectorA → {e1, e2} and blockN1 → {e1, e2}) and a contrasting single-value row.
-      const contractA = AztecAddress.fromBigInt(2n);
-      const contractB = AztecAddress.fromBigInt(3n);
+      const contractA = AztecAddress.fromBigIntUnsafe(2n);
+      const contractB = AztecAddress.fromBigIntUnsafe(3n);
       const selectorA = EventSelector.fromField(new Fr(5n));
       const selectorB = EventSelector.fromField(new Fr(7n));
-      const scopeX = AztecAddress.fromBigInt(11n);
-      const scopeY = AztecAddress.fromBigInt(13n);
+      const scopeX = AztecAddress.fromBigIntUnsafe(11n);
+      const scopeY = AztecAddress.fromBigIntUnsafe(13n);
       const blockN1 = BlockNumber(17);
       const blockN2 = BlockNumber(19);
 
@@ -487,8 +528,8 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
       const recipientTaggingStore = new RecipientTaggingStore(kvStore);
 
       const jobId = 'fixture-job';
-      const secretA = new AppTaggingSecret(new Fr(2n), AztecAddress.fromBigInt(3n));
-      const secretB = new AppTaggingSecret(new Fr(5n), AztecAddress.fromBigInt(7n));
+      const secretA = new AppTaggingSecret(new Fr(2n), AztecAddress.fromBigIntUnsafe(3n));
+      const secretB = new AppTaggingSecret(new Fr(5n), AztecAddress.fromBigIntUnsafe(7n));
 
       await recipientTaggingStore.updateHighestFinalizedIndex(secretA, 11, jobId);
       await recipientTaggingStore.updateHighestAgedIndex(secretA, 13, jobId);
@@ -502,16 +543,30 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
   },
 
   {
-    name: 'SenderAddressBookStore',
+    name: 'TaggingSecretSourcesStore',
     writeToStore: async kvStore => {
-      const senderAddressBookStore = new SenderAddressBookStore(kvStore);
+      const taggingSecretSourcesStore = new TaggingSecretSourcesStore(kvStore);
+
+      await taggingSecretSourcesStore.addSender(AztecAddress.fromBigIntUnsafe(2n));
+      await taggingSecretSourcesStore.addSender(AztecAddress.fromBigIntUnsafe(3n));
+      await taggingSecretSourcesStore.addSender(AztecAddress.fromBigIntUnsafe(5n));
 
-      await senderAddressBookStore.addSender(AztecAddress.fromBigInt(2n));
-      await senderAddressBookStore.addSender(AztecAddress.fromBigInt(3n));
-      await senderAddressBookStore.addSender(AztecAddress.fromBigInt(5n));
+      await taggingSecretSourcesStore.addSharedSecret(
+        AztecAddress.fromBigIntUnsafe(7n),
+        new Point(new Fr(2n), new Fr(3n)),
+      );
+      await taggingSecretSourcesStore.addSharedSecret(
+        AztecAddress.fromBigIntUnsafe(7n),
+        new Point(new Fr(5n), new Fr(7n)),
+      );
+      await taggingSecretSourcesStore.addSharedSecret(
+        AztecAddress.fromBigIntUnsafe(11n),
+        new Point(new Fr(13n), new Fr(17n)),
+      );
     },
     snapshotStore: async kvStore => ({
-      address_book: await snapshotMap(kvStore.openMap<string, true>('address_book')),
+      senders: await snapshotMap(kvStore.openMap<string, true>('senders')),
+      recipient_shared_secrets: await snapshotMap(kvStore.openMultiMap<string, string>('recipient_shared_secrets')),
     }),
   },
 
@@ -521,9 +576,9 @@ export const SCHEMA_TESTS: readonly SchemaTest[] = [
       const senderTaggingStore = new SenderTaggingStore(kvStore);
 
       const jobId = 'fixture-job';
-      const secretA = new AppTaggingSecret(new Fr(2n), AztecAddress.fromBigInt(3n));
-      const secretB = new AppTaggingSecret(new Fr(5n), AztecAddress.fromBigInt(7n));
-      const secretC = new AppTaggingSecret(new Fr(11n), AztecAddress.fromBigInt(13n));
+      const secretA = new AppTaggingSecret(new Fr(2n), AztecAddress.fromBigIntUnsafe(3n));
+      const secretB = new AppTaggingSecret(new Fr(5n), AztecAddress.fromBigIntUnsafe(7n));
+      const secretC = new AppTaggingSecret(new Fr(11n), AztecAddress.fromBigIntUnsafe(13n));
       const txHashA = TxHash.fromBigInt(17n);
       const txHashB = TxHash.fromBigInt(19n);
       const txHashC = TxHash.fromBigInt(23n);
@@ -617,7 +672,7 @@ function buildL2Block(): L2Block {
       SlotNumber(181),
       191n,
       EthAddress.fromField(new Fr(193n)),
-      AztecAddress.fromBigInt(197n),
+      AztecAddress.fromBigIntUnsafe(197n),
       new GasFees(199n, 211n),
     ),
     new Fr(223n),
@@ -638,10 +693,10 @@ function buildL2Block(): L2Block {
         3,
       ),
     ],
-    [new PublicLog(AztecAddress.fromBigInt(281n), [new Fr(283n), new Fr(293n)])],
+    [new PublicLog(AztecAddress.fromBigIntUnsafe(281n), [new Fr(283n), new Fr(293n)])],
     [
       new ContractClassLog(
-        AztecAddress.fromBigInt(307n),
+        AztecAddress.fromBigIntUnsafe(307n),
         new ContractClassLogFields(paddedFrs([311n, 313n, 317n], CONTRACT_CLASS_LOG_SIZE_IN_FIELDS)),
         3,
       ),

package/src/storage/capsule_store/capsule_service.ts

@@ -2,6 +2,7 @@ import type { Fr } from '@aztec/foundation/curves/bn254';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { Capsule } from '@aztec/stdlib/tx';
 
+import { assertAllowedScope } from '../allowed_scopes.js';
 import type { CapsuleStore } from './capsule_store.js';
 
 /**
@@ -9,10 +10,15 @@ import type { CapsuleStore } from './capsule_store.js';
  * allowed scopes list before delegating to the underlying store.
  */
 export class CapsuleService {
+  private readonly allowedScopes: AztecAddress[];
+
   constructor(
     private readonly capsuleStore: CapsuleStore,
-    private readonly allowedScopes: AztecAddress[],
-  ) {}
+    allowedScopes: AztecAddress[],
+  ) {
+    // The zero address denotes the global capsule scope, which is always permitted.
+    this.allowedScopes = [...allowedScopes, AztecAddress.ZERO];
+  }
 
   setCapsule(contractAddress: AztecAddress, slot: Fr, capsule: Fr[], jobId: string, scope: AztecAddress) {
     assertAllowedScope(scope, this.allowedScopes);
@@ -77,14 +83,3 @@ export class CapsuleService {
     return this.capsuleStore.setCapsuleArray(contractAddress, baseSlot, content, jobId, scope);
   }
 }
-
-function assertAllowedScope(scope: AztecAddress, allowedScopes: AztecAddress[]) {
-  if (scope.equals(AztecAddress.ZERO)) {
-    return;
-  }
-  if (!allowedScopes.some((allowed: AztecAddress) => allowed.equals(scope))) {
-    throw new Error(
-      `Scope ${scope.toString()} is not in the allowed scopes list: [${allowedScopes.map((s: AztecAddress) => s.toString()).join(', ')}]. See https://docs.aztec.network/errors/10`,
-    );
-  }
-}

package/src/storage/contract_store/contract_store.ts

@@ -215,7 +215,7 @@ export class ContractStore {
   getContractsAddresses(): Promise<AztecAddress[]> {
     return this.#store.transactionAsync(async () => {
       const keys = await toArray(this.#contractInstances.keysAsync());
-      return keys.map(AztecAddress.fromString);
+      return keys.map(AztecAddress.fromStringUnsafe);
     });
   }
 
@@ -383,7 +383,7 @@ export class ContractStore {
     const contract = await this.getContract(to);
     if (!contract) {
       throw new Error(
-        `Unknown contract ${to}: add it to PXE by calling server.addContracts(...).\nSee docs for context: https://docs.aztec.network/developers/resources/debugging/aztecnr-errors#unknown-contract-0x0-add-it-to-pxe-by-calling-serveraddcontracts`,
+        `Unknown contract ${to}: register it by calling wallet.registerContract(...).\nSee docs for context: https://docs.aztec.network/errors/14`,
       );
     }
 

package/src/storage/fact_store/fact_service.ts

@@ -0,0 +1,45 @@
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+
+import { assertAllowedScope } from '../allowed_scopes.js';
+import type { FactCollection, FactStore } from './fact_store.js';
+import type { FactCollectionKey, FactCollectionTypeKey, OriginBlock } from './fact_store_keys.js';
+
+/**
+ * Wraps a {@link FactStore} with scope-based access control.
+ *
+ * Each method asserts scope validity before delegating to FactStore, gating which accounts a contract may record facts
+ * under or read facts from.
+ */
+export class FactService {
+  constructor(
+    private readonly factStore: FactStore,
+    private readonly allowedScopes: AztecAddress[],
+  ) {}
+
+  recordFact(
+    factCollectionKey: FactCollectionKey,
+    factTypeId: Fr,
+    payload: Fr[],
+    originBlock: OriginBlock | undefined,
+    jobId: string,
+  ): Promise<void> {
+    assertAllowedScope(factCollectionKey.scope, this.allowedScopes);
+    return this.factStore.recordFact(factCollectionKey, factTypeId, payload, originBlock, jobId);
+  }
+
+  deleteFactCollection(factCollectionKey: FactCollectionKey, jobId: string): Promise<void> {
+    assertAllowedScope(factCollectionKey.scope, this.allowedScopes);
+    return this.factStore.deleteFactCollection(factCollectionKey, jobId);
+  }
+
+  getFactCollection(factCollectionKey: FactCollectionKey, jobId: string): Promise<FactCollection | undefined> {
+    assertAllowedScope(factCollectionKey.scope, this.allowedScopes);
+    return this.factStore.getFactCollection(factCollectionKey, jobId);
+  }
+
+  getFactCollectionsByType(factCollectionTypeKey: FactCollectionTypeKey, jobId: string): Promise<FactCollection[]> {
+    assertAllowedScope(factCollectionTypeKey.scope, this.allowedScopes);
+    return this.factStore.getFactCollectionsByType(factCollectionTypeKey, jobId);
+  }
+}