@aztec/stdlib 0.0.0-test.1 → 0.0.1-commit.1142ef1

package/src/note/note.ts

@@ -1,16 +1,75 @@
-import { Fr } from '@aztec/foundation/fields';
-import { schemas } from '@aztec/foundation/schemas';
+import { randomInt } from '@aztec/foundation/crypto/random';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader } from '@aztec/foundation/serialize';
+import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
 
-import { Payload } from '../logs/l1_payload/payload.js';
+import { schemas } from '../schemas/index.js';
+import { Vector } from '../types/shared.js';
 
-export class Note extends Payload {
-  static override get schema() {
+/**
+ * The Note class represents a Note emitted from a Noir contract as a vector of Fr (finite field) elements.
+ * This data also represents a preimage to a note hash.
+ */
+export class Note extends Vector<Fr> {
+  toJSON() {
+    return this.toBuffer();
+  }
+
+  static get schema() {
     return schemas.Buffer.transform(Note.fromBuffer);
   }
 
-  static override fromBuffer(buffer: Buffer | BufferReader) {
+  /**
+   * Create a Note instance from a Buffer or BufferReader.
+   * The input 'buffer' can be either a Buffer containing the serialized Fr elements or a BufferReader instance.
+   * This function reads the Fr elements in the buffer and constructs a Note with them.
+   *
+   * @param buffer - The Buffer or BufferReader containing the serialized Fr elements.
+   * @returns A Note instance containing the deserialized Fr elements.
+   */
+  static fromBuffer(buffer: Buffer | BufferReader) {
     const reader = BufferReader.asReader(buffer);
     return new Note(reader.readVector(Fr));
   }
+
+  /**
+   * Generates a random Note instance with a variable number of items.
+   * The number of items is determined by a random value between 1 and 10 (inclusive).
+   * Each item in the Note is generated using the Fr.random() method.
+   *
+   * @returns A randomly generated Note instance.
+   */
+  static random() {
+    const numItems = randomInt(10) + 1;
+    const items = Array.from({ length: numItems }, () => Fr.random());
+    return new Note(items);
+  }
+
+  /**
+   * Returns a hex representation of the note.
+   * @returns A hex string with the vector length as first element.
+   */
+  override toString() {
+    return bufferToHex(this.toBuffer());
+  }
+
+  /**
+   * Creates a new Note instance from a hex string.
+   * @param str - Hex representation.
+   * @returns A Note instance.
+   */
+  static fromString(str: string) {
+    return Note.fromBuffer(hexToBuffer(str));
+  }
+
+  get length() {
+    return this.items.length;
+  }
+
+  equals(other: Note) {
+    if (this.items.length !== other.items.length) {
+      return false;
+    }
+    return this.items.every((item, index) => item.equals(other.items[index]));
+  }
 }

package/src/note/note_dao.ts

@@ -0,0 +1,182 @@
+import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
+import { BlockNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { Point } from '@aztec/foundation/curves/grumpkin';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import { Note } from '@aztec/stdlib/note';
+import { TxHash } from '@aztec/stdlib/tx';
+
+/**
+ * A Note Data Access Object, representing a note that was committed to the note hash tree, holding all of the
+ * information required to use it during execution and manage its state.
+ */
+export class NoteDao {
+  constructor(
+    // Note information
+
+    /** The packed content of the note, as will be returned in the getNotes oracle. */
+    public note: Note,
+    /** The address of the contract that created the note (i.e. the address used by the kernel during siloing). */
+    public contractAddress: AztecAddress,
+    /** The owner of the note - generally the account that can spend the note. */
+    public owner: AztecAddress,
+    /**
+     * The storage location of the note. This value is not used for anything in PXE, but we do index by storage slot
+     * since contracts typically make queries based on it.
+     */
+    public storageSlot: Fr,
+    /**
+     * The randomness injected to the note hash preimage.
+     */
+    public randomness: Fr,
+    /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
+    public noteNonce: Fr,
+
+    // Computed values
+    /**
+     * The inner hash (non-unique, non-siloed) of the note. Each contract determines how the note is hashed. Can
+     * be used alongside contractAddress and nonce to compute the uniqueNoteHash and the siloedNoteHash.
+     */
+    public noteHash: Fr,
+    /**
+     * The nullifier of the note, siloed by contract address.
+     * Note: Might be set as 0 if the note was added to PXE as nullified.
+     */
+    public siloedNullifier: Fr,
+
+    // Metadata
+    /** The hash of the tx in which this note was created. Knowing the tx hash allows for efficient node queries e.g.
+     *  when searching for txEffects.
+     */
+    public txHash: TxHash,
+    /** The L2 block number in which the tx with this note was included. Used for note management while processing
+     * reorgs.*/
+    public l2BlockNumber: BlockNumber,
+    /** The L2 block hash in which the tx with this note was included. Used for note management while processing
+     * reorgs.*/
+    public l2BlockHash: string,
+    /** The index of the leaf in the global note hash tree the note is stored at */
+    public index: bigint,
+  ) {}
+
+  toBuffer(): Buffer {
+    return serializeToBuffer([
+      this.note,
+      this.contractAddress,
+      this.owner,
+      this.storageSlot,
+      this.randomness,
+      this.noteNonce,
+      this.noteHash,
+      this.siloedNullifier,
+      this.txHash,
+      this.l2BlockNumber,
+      Fr.fromHexString(this.l2BlockHash),
+      this.index,
+    ]);
+  }
+
+  static fromBuffer(buffer: Buffer | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+
+    const note = Note.fromBuffer(reader);
+    const contractAddress = AztecAddress.fromBuffer(reader);
+    const owner = AztecAddress.fromBuffer(reader);
+    const storageSlot = Fr.fromBuffer(reader);
+    const randomness = Fr.fromBuffer(reader);
+    const noteNonce = Fr.fromBuffer(reader);
+    const noteHash = Fr.fromBuffer(reader);
+    const siloedNullifier = Fr.fromBuffer(reader);
+    const txHash = reader.readObject(TxHash);
+    const l2BlockNumber = BlockNumber(reader.readNumber());
+    const l2BlockHash = Fr.fromBuffer(reader).toString();
+    const index = toBigIntBE(reader.readBytes(32));
+
+    return new NoteDao(
+      note,
+      contractAddress,
+      owner,
+      storageSlot,
+      randomness,
+      noteNonce,
+      noteHash,
+      siloedNullifier,
+      txHash,
+      l2BlockNumber,
+      l2BlockHash,
+      index,
+    );
+  }
+
+  toString() {
+    return '0x' + this.toBuffer().toString('hex');
+  }
+
+  static fromString(str: string) {
+    const hex = str.replace(/^0x/, '');
+    return NoteDao.fromBuffer(Buffer.from(hex, 'hex'));
+  }
+
+  /**
+   * Returns true if this note is equal to the `other` one.
+   */
+  equals(other: NoteDao): boolean {
+    return (
+      this.note.equals(other.note) &&
+      this.contractAddress.equals(other.contractAddress) &&
+      this.owner.equals(other.owner) &&
+      this.storageSlot.equals(other.storageSlot) &&
+      this.randomness.equals(other.randomness) &&
+      this.noteNonce.equals(other.noteNonce) &&
+      this.noteHash.equals(other.noteHash) &&
+      this.siloedNullifier.equals(other.siloedNullifier) &&
+      this.txHash.equals(other.txHash) &&
+      this.l2BlockNumber === other.l2BlockNumber &&
+      this.l2BlockHash === other.l2BlockHash &&
+      this.index === other.index
+    );
+  }
+
+  /**
+   * Returns the size in bytes of the Note Dao.
+   * @returns - Its size in bytes.
+   */
+  public getSize() {
+    const indexSize = Math.ceil(Math.log2(Number(this.index)));
+    const noteSize = 4 + this.note.items.length * Fr.SIZE_IN_BYTES;
+    return (
+      noteSize + AztecAddress.SIZE_IN_BYTES * 2 + Fr.SIZE_IN_BYTES * 4 + TxHash.SIZE + Point.SIZE_IN_BYTES + indexSize
+    );
+  }
+
+  static async random({
+    note = Note.random(),
+    contractAddress = undefined,
+    owner = undefined,
+    storageSlot = Fr.random(),
+    randomness = Fr.random(),
+    noteNonce = Fr.random(),
+    noteHash = Fr.random(),
+    siloedNullifier = Fr.random(),
+    txHash = TxHash.random(),
+    l2BlockNumber = BlockNumber(Math.floor(Math.random() * 1000)),
+    l2BlockHash = Fr.random().toString(),
+    index = Fr.random().toBigInt(),
+  }: Partial<NoteDao> = {}) {
+    return new NoteDao(
+      note,
+      contractAddress ?? (await AztecAddress.random()),
+      owner ?? (await AztecAddress.random()),
+      storageSlot,
+      randomness,
+      noteNonce,
+      noteHash,
+      siloedNullifier,
+      txHash,
+      l2BlockNumber,
+      l2BlockHash,
+      index,
+    );
+  }
+}

package/src/note/notes_filter.ts

@@ -1,10 +1,9 @@
-import type { Fr } from '@aztec/foundation/fields';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 
 import { z } from 'zod';
 
 import type { AztecAddress } from '../aztec-address/index.js';
 import { type ZodFor, schemas } from '../schemas/index.js';
-import { TxHash } from '../tx/tx_hash.js';
 import { NoteStatus } from './note_status.js';
 
 /**
@@ -12,14 +11,15 @@ import { NoteStatus } from './note_status.js';
  * @remarks This filter is applied as an intersection of all its params.
  */
 export type NotesFilter = {
-  /** Hash of a transaction from which to fetch the notes. */
-  txHash?: TxHash;
-  /** The contract address the note belongs to. */
-  contractAddress?: AztecAddress;
+  /**
+   * The contract address the note belongs to.
+   * @remarks Providing a contract address is required as we need that information to trigger private state sync.
+   */
+  contractAddress: AztecAddress;
+  /** The owner of the note. */
+  owner?: AztecAddress;
   /** The specific storage location of the note on the contract. */
   storageSlot?: Fr;
-  /** The owner of the note (whose public key was used to encrypt the note). */
-  owner?: AztecAddress;
   /** The status of the note. Defaults to 'ACTIVE'. */
   status?: NoteStatus;
   /** The siloed nullifier for the note. */
@@ -29,10 +29,9 @@ export type NotesFilter = {
 };
 
 export const NotesFilterSchema: ZodFor<NotesFilter> = z.object({
-  txHash: TxHash.schema.optional(),
-  contractAddress: schemas.AztecAddress.optional(),
-  storageSlot: schemas.Fr.optional(),
+  contractAddress: schemas.AztecAddress,
   owner: schemas.AztecAddress.optional(),
+  storageSlot: schemas.Fr.optional(),
   status: z.nativeEnum(NoteStatus).optional(),
   siloedNullifier: schemas.Fr.optional(),
   scopes: z.array(schemas.AztecAddress).optional(),

package/src/p2p/attestation_utils.ts

@@ -0,0 +1,35 @@
+import type { EthAddress } from '@aztec/foundation/eth-address';
+
+import { CommitteeAttestation } from '../block/index.js';
+import type { CheckpointAttestation } from './checkpoint_attestation.js';
+
+/**
+ * Returns attestation signatures in the order of a series of provided ethereum addresses
+ * The rollup smart contract expects attestations to appear in the order of the committee
+ * @todo: perform this logic within the memory attestation store instead?
+ */
+export function orderAttestations(
+  attestations: CheckpointAttestation[],
+  orderAddresses: EthAddress[],
+): CommitteeAttestation[] {
+  // Create a map of sender addresses to attestations
+  const attestationMap = new Map<string, CommitteeAttestation>();
+
+  for (const attestation of attestations) {
+    const sender = attestation.getSender();
+    if (sender) {
+      attestationMap.set(
+        sender.toString(),
+        CommitteeAttestation.fromAddressAndSignature(sender, attestation.signature),
+      );
+    }
+  }
+
+  // Create the ordered array based on the orderAddresses, else return an empty attestation
+  const orderedAttestations = orderAddresses.map(address => {
+    const addressString = address.toString();
+    return attestationMap.get(addressString) || CommitteeAttestation.fromAddress(address);
+  });
+
+  return orderedAttestations;
+}

package/src/p2p/block_proposal.ts

@@ -1,18 +1,25 @@
+import { BlockNumber, SlotNumber } from '@aztec/foundation/branded-types';
 import { Buffer32 } from '@aztec/foundation/buffer';
-import { keccak256, recoverAddress } from '@aztec/foundation/crypto';
+import { keccak256 } from '@aztec/foundation/crypto/keccak';
+import { tryRecoverAddress } from '@aztec/foundation/crypto/secp256k1-signer';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import type { EthAddress } from '@aztec/foundation/eth-address';
 import { Signature } from '@aztec/foundation/eth-signature';
-import type { Fr } from '@aztec/foundation/fields';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
-import { ConsensusPayload } from './consensus_payload.js';
+import type { L2Block } from '../block/l2_block.js';
+import type { L2BlockInfo } from '../block/l2_block_info.js';
+import { BlockHeader } from '../tx/block_header.js';
+import { TxHash } from '../tx/index.js';
+import type { Tx } from '../tx/tx.js';
 import { Gossipable } from './gossipable.js';
 import {
   SignatureDomainSeparator,
   getHashedSignaturePayload,
   getHashedSignaturePayloadEthSignedMessage,
 } from './signature_utils.js';
-import { TopicType, createTopicString } from './topic_type.js';
+import { SignedTxs } from './signed_txs.js';
+import { TopicType } from './topic_type.js';
 
 export class BlockProposalHash extends Buffer32 {
   constructor(hash: Buffer) {
@@ -20,83 +27,266 @@ export class BlockProposalHash extends Buffer32 {
   }
 }
 
+export type BlockProposalOptions = {
+  publishFullTxs: boolean;
+  /** Whether to generate an invalid block proposal for broadcasting. Use only for testing. */
+  broadcastInvalidBlockProposal?: boolean;
+};
+
 /**
- * BlockProposal
- *
- * A block proposal is created by the leader of the chain proposing a sequence of transactions to
- * be included in the head of the chain
+ * A block proposal is created by the leader of the chain proposing a sequence of transactions
+ * to be included in a block within a checkpoint. This is used for non-last blocks in a slot.
+ * The last block is sent as part of a CheckpointProposal.
  */
 export class BlockProposal extends Gossipable {
-  static override p2pTopic = createTopicString(TopicType.block_proposal);
+  static override p2pTopic = TopicType.block_proposal;
 
   private sender: EthAddress | undefined;
 
   constructor(
-    /** The payload of the message, and what the signature is over */
-    public readonly payload: ConsensusPayload,
+    /** The per-block header containing block state and global variables */
+    public readonly blockHeader: BlockHeader,
+
+    // TODO(palla/mbps): Is this really needed? Can we just derive it from the indexWithinCheckpoint of the parent block and the slot number?
+    // See the block-proposal-handler, we have a lot of extra validations to check this is correct, so maybe we can avoid storing it here.
+    /** Index of this block within the checkpoint (0-indexed) */
+    public readonly indexWithinCheckpoint: number,
+
+    /** Hash of L1 to L2 messages for this checkpoint (constant across all blocks in checkpoint) */
+    public readonly inHash: Fr,
+
+    /** Archive root after this block is applied */
+    public readonly archiveRoot: Fr,
+
+    /** The sequence of transactions in the block */
+    public readonly txHashes: TxHash[],
 
-    /** The signer of the BlockProposal over the header of the new block*/
+    /** The proposer's signature over the block data */
     public readonly signature: Signature,
+
+    /** The signed transactions in the block (optional, for DA guarantees) */
+    public readonly signedTxs?: SignedTxs,
   ) {
     super();
   }
 
-  override p2pMessageIdentifier(): Promise<Buffer32> {
+  override generateP2PMessageIdentifier(): Promise<Buffer32> {
     return Promise.resolve(new BlockProposalHash(keccak256(this.signature.toBuffer())));
   }
 
   get archive(): Fr {
-    return this.payload.archive;
+    return this.archiveRoot;
+  }
+
+  get slotNumber(): SlotNumber {
+    return this.blockHeader.getSlot();
+  }
+
+  get blockNumber(): BlockNumber {
+    return this.blockHeader.getBlockNumber();
   }
 
-  get slotNumber(): Fr {
-    return this.payload.header.globalVariables.slotNumber;
+  /** Convenience getter for txs from signedTxs */
+  get txs(): Tx[] | undefined {
+    return this.signedTxs?.txs;
   }
 
-  get blockNumber(): Fr {
-    return this.payload.header.globalVariables.blockNumber;
+  toBlockInfo(): Omit<L2BlockInfo, 'blockNumber'> {
+    return {
+      slotNumber: this.slotNumber,
+      lastArchive: this.blockHeader.lastArchive.root,
+      timestamp: this.blockHeader.globalVariables.timestamp,
+      archive: this.archiveRoot,
+      txCount: this.txHashes.length,
+    };
+  }
+
+  /**
+   * Get the payload to sign for this block proposal.
+   * The signature is over: blockHeader + indexWithinCheckpoint + inHash + archiveRoot + txHashes
+   */
+  getPayloadToSign(domainSeparator: SignatureDomainSeparator): Buffer {
+    return serializeToBuffer([
+      domainSeparator,
+      this.blockHeader,
+      this.indexWithinCheckpoint,
+      this.inHash,
+      this.archiveRoot,
+      this.txHashes.length,
+      this.txHashes,
+    ]);
   }
 
   static async createProposalFromSigner(
-    payload: ConsensusPayload,
+    blockHeader: BlockHeader,
+    indexWithinCheckpoint: number,
+    inHash: Fr,
+    archiveRoot: Fr,
+    txHashes: TxHash[],
+    txs: Tx[] | undefined,
     payloadSigner: (payload: Buffer32) => Promise<Signature>,
-  ) {
-    const hashed = await getHashedSignaturePayload(payload, SignatureDomainSeparator.blockProposal);
+  ): Promise<BlockProposal> {
+    // Create a temporary proposal to get the payload to sign
+    const tempProposal = new BlockProposal(
+      blockHeader,
+      indexWithinCheckpoint,
+      inHash,
+      archiveRoot,
+      txHashes,
+      Signature.empty(),
+    );
+
+    const hashed = getHashedSignaturePayload(tempProposal, SignatureDomainSeparator.blockProposal);
     const sig = await payloadSigner(hashed);
 
-    return new BlockProposal(payload, sig);
+    // If txs are provided, sign them as well
+    let signedTxs: SignedTxs | undefined;
+    if (txs) {
+      signedTxs = await SignedTxs.createFromSigner(txs, payloadSigner);
+    }
+
+    return new BlockProposal(blockHeader, indexWithinCheckpoint, inHash, archiveRoot, txHashes, sig, signedTxs);
   }
 
-  /**Get Sender
-   * Lazily evaluate the sender of the proposal; result is cached
+  /**
+   * Lazily evaluate the sender of the proposal; result is cached.
+   * If there's signedTxs, also verifies the signedTxs sender matches the block proposal sender.
+   * @returns The sender address, or undefined if signature recovery fails or senders don't match
    */
-  async getSender() {
+  getSender(): EthAddress | undefined {
     if (!this.sender) {
-      const hashed = await getHashedSignaturePayloadEthSignedMessage(
-        this.payload,
-        SignatureDomainSeparator.blockProposal,
-      );
+      const hashed = getHashedSignaturePayloadEthSignedMessage(this, SignatureDomainSeparator.blockProposal);
+      const blockSender = tryRecoverAddress(hashed, this.signature);
+
+      // If there's signedTxs, verify the sender matches
+      if (blockSender && this.signedTxs) {
+        const txsSender = this.signedTxs.getSender();
+        if (!txsSender || !txsSender.equals(blockSender)) {
+          return undefined; // Sender mismatch - fail
+        }
+      }
+
       // Cache the sender for later use
-      this.sender = recoverAddress(hashed, this.signature);
+      this.sender = blockSender;
     }
 
     return this.sender;
   }
 
   getPayload() {
-    return this.payload.getPayloadToSign(SignatureDomainSeparator.blockProposal);
+    return this.getPayloadToSign(SignatureDomainSeparator.blockProposal);
   }
 
   toBuffer(): Buffer {
-    return serializeToBuffer([this.payload, this.signature]);
+    const buffer: any[] = [
+      this.blockHeader,
+      this.indexWithinCheckpoint,
+      this.inHash,
+      this.archiveRoot,
+      this.signature,
+      this.txHashes.length,
+      this.txHashes,
+    ];
+    if (this.signedTxs) {
+      buffer.push(1); // hasSignedTxs = true
+      buffer.push(this.signedTxs.toBuffer());
+    } else {
+      buffer.push(0); // hasSignedTxs = false
+    }
+    return serializeToBuffer(buffer);
   }
 
   static fromBuffer(buf: Buffer | BufferReader): BlockProposal {
     const reader = BufferReader.asReader(buf);
-    return new BlockProposal(reader.readObject(ConsensusPayload), reader.readObject(Signature));
+
+    const blockHeader = reader.readObject(BlockHeader);
+    const indexWithinCheckpoint = reader.readNumber();
+    const inHash = reader.readObject(Fr);
+    const archiveRoot = reader.readObject(Fr);
+    const signature = reader.readObject(Signature);
+    const txHashes = reader.readArray(reader.readNumber(), TxHash);
+
+    if (!reader.isEmpty()) {
+      const hasSignedTxs = reader.readNumber();
+      if (hasSignedTxs) {
+        const signedTxs = SignedTxs.fromBuffer(reader);
+        return new BlockProposal(
+          blockHeader,
+          indexWithinCheckpoint,
+          inHash,
+          archiveRoot,
+          txHashes,
+          signature,
+          signedTxs,
+        );
+      }
+    }
+
+    return new BlockProposal(blockHeader, indexWithinCheckpoint, inHash, archiveRoot, txHashes, signature);
   }
 
   getSize(): number {
-    return this.payload.getSize() + this.signature.getSize();
+    return (
+      this.blockHeader.getSize() +
+      4 /* indexWithinCheckpoint */ +
+      this.inHash.size +
+      this.archiveRoot.size +
+      this.signature.getSize() +
+      4 /* txHashes.length */ +
+      this.txHashes.length * TxHash.SIZE +
+      4 /* hasSignedTxs flag */ +
+      (this.signedTxs ? this.signedTxs.getSize() : 0)
+    );
+  }
+
+  static empty(): BlockProposal {
+    return new BlockProposal(BlockHeader.empty(), 0, Fr.ZERO, Fr.ZERO, [], Signature.empty());
+  }
+
+  static random(): BlockProposal {
+    return new BlockProposal(
+      BlockHeader.random(),
+      Math.floor(Math.random() * 5),
+      Fr.random(),
+      Fr.random(),
+      [TxHash.random(), TxHash.random()],
+      Signature.random(),
+    );
+  }
+
+  toInspect() {
+    return {
+      blockHeader: this.blockHeader.toInspect(),
+      indexWithinCheckpoint: this.indexWithinCheckpoint,
+      inHash: this.inHash.toString(),
+      archiveRoot: this.archiveRoot.toString(),
+      signature: this.signature.toString(),
+      txHashes: this.txHashes.map(h => h.toString()),
+    };
+  }
+
+  /**
+   * Check if this proposal matches the given block.
+   * Compares the archive root and block header.
+   * @param block - The L2Block to compare against
+   * @returns True if the proposal matches the block
+   */
+  matchesBlock(block: L2Block): boolean {
+    return this.archiveRoot.equals(block.archive.root) && this.blockHeader.equals(block.getBlockHeader());
+  }
+
+  /**
+   * Returns a copy of this proposal without signedTxs.
+   * Used when storing proposals in attestation pool to avoid storing full tx data.
+   */
+  withoutSignedTxs(): BlockProposal {
+    return new BlockProposal(
+      this.blockHeader,
+      this.indexWithinCheckpoint,
+      this.inHash,
+      this.archiveRoot,
+      this.txHashes,
+      this.signature,
+    );
   }
 }