@aztec/stdlib 0.0.1-commit.3100065 → 0.0.1-commit.321f6a9

package/src/avm/contract_storage_update_request.ts

@@ -1,93 +0,0 @@
-import { CONTRACT_STORAGE_UPDATE_REQUEST_LENGTH } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import type { AztecAddress } from '../aztec-address/index.js';
-
-/**
- * Contract storage update request for a slot on a specific contract.
- *
- * Note: Similar to `PublicDataUpdateRequest` but it's from the POV of contract storage so we are not working with
- * public data tree leaf index but storage slot index.
- */
-export class ContractStorageUpdateRequest {
-  constructor(
-    /**
-     * Storage slot we are updating.
-     */
-    public readonly storageSlot: Fr,
-    /**
-     * New value of the storage slot.
-     */
-    public readonly newValue: Fr,
-    /**
-     * Side effect counter tracking position of this event in tx execution.
-     */
-    public readonly counter: number,
-    /**
-     * Contract address whose storage is being read.
-     */
-    public contractAddress?: AztecAddress, // TODO: Should not be optional. This is a temporary hack to silo the storage slot with the correct address for nested executions.
-  ) {}
-
-  toBuffer() {
-    return serializeToBuffer(this.storageSlot, this.newValue, this.counter);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new ContractStorageUpdateRequest(Fr.fromBuffer(reader), Fr.fromBuffer(reader), reader.readNumber());
-  }
-
-  /**
-   * Create ContractStorageUpdateRequest from a fields dictionary.
-   * @param fields - The dictionary.
-   * @returns A ContractStorageUpdateRequest object.
-   */
-  static from(fields: FieldsOf<ContractStorageUpdateRequest>): ContractStorageUpdateRequest {
-    return new ContractStorageUpdateRequest(...ContractStorageUpdateRequest.getFields(fields));
-  }
-
-  /**
-   * Serialize into a field array. Low-level utility.
-   * @param fields - Object with fields.
-   * @returns The array.
-   */
-  static getFields(fields: FieldsOf<ContractStorageUpdateRequest>) {
-    return [fields.storageSlot, fields.newValue, fields.counter, fields.contractAddress] as const;
-  }
-
-  static empty() {
-    return new ContractStorageUpdateRequest(Fr.ZERO, Fr.ZERO, 0);
-  }
-
-  isEmpty() {
-    return this.storageSlot.isZero() && this.newValue.isZero();
-  }
-
-  toFriendlyJSON() {
-    return `Slot=${this.storageSlot.toFriendlyJSON()}: ${this.newValue.toFriendlyJSON()}, sideEffectCounter=${
-      this.counter
-    }`;
-  }
-
-  toFields(): Fr[] {
-    const fields = [this.storageSlot, this.newValue, new Fr(this.counter)];
-    if (fields.length !== CONTRACT_STORAGE_UPDATE_REQUEST_LENGTH) {
-      throw new Error(
-        `Invalid number of fields for ContractStorageUpdateRequest. Expected ${CONTRACT_STORAGE_UPDATE_REQUEST_LENGTH}, got ${fields.length}`,
-      );
-    }
-    return fields;
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): ContractStorageUpdateRequest {
-    const reader = FieldReader.asReader(fields);
-
-    const storageSlot = reader.readField();
-    const newValue = reader.readField();
-
-    return new ContractStorageUpdateRequest(storageSlot, newValue, reader.readU32());
-  }
-}

package/src/avm/public_call_stack_item_compressed.ts

@@ -1,113 +0,0 @@
-import { PUBLIC_CALL_STACK_ITEM_COMPRESSED_LENGTH } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { AztecAddress } from '../aztec-address/index.js';
-import { Gas } from '../gas/gas.js';
-import { CallContext } from '../tx/call_context.js';
-import { RevertCode } from './revert_code.js';
-
-// TO BE REMOVED
-/**
- * Compressed call stack item on a public call.
- */
-export class PublicCallStackItemCompressed {
-  constructor(
-    public contractAddress: AztecAddress,
-    public callContext: CallContext,
-    public argsHash: Fr,
-    public returnsHash: Fr,
-    public revertCode: RevertCode,
-    /** How much gas was available for execution. */
-    public startGasLeft: Gas,
-    /** How much gas was left after execution. */
-    public endGasLeft: Gas,
-  ) {}
-
-  static getFields(fields: FieldsOf<PublicCallStackItemCompressed>) {
-    return [
-      fields.contractAddress,
-      fields.callContext,
-      fields.argsHash,
-      fields.returnsHash,
-      fields.revertCode,
-      fields.startGasLeft,
-      fields.endGasLeft,
-    ] as const;
-  }
-
-  toFields(): Fr[] {
-    const fields = serializeToFields(...PublicCallStackItemCompressed.getFields(this));
-    if (fields.length !== PUBLIC_CALL_STACK_ITEM_COMPRESSED_LENGTH) {
-      throw new Error(
-        `Invalid number of fields for PublicCallStackItemCompressed. Expected ${PUBLIC_CALL_STACK_ITEM_COMPRESSED_LENGTH}, got ${fields.length}`,
-      );
-    }
-    return fields;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...PublicCallStackItemCompressed.getFields(this));
-  }
-
-  /**
-   * Deserializes from a buffer or reader.
-   * @param buffer - Buffer or reader to read from.
-   * @returns The deserialized instance.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader): PublicCallStackItemCompressed {
-    const reader = BufferReader.asReader(buffer);
-    return new PublicCallStackItemCompressed(
-      reader.readObject(AztecAddress),
-      reader.readObject(CallContext),
-      reader.readObject(Fr),
-      reader.readObject(Fr),
-      reader.readObject(RevertCode),
-      reader.readObject(Gas),
-      reader.readObject(Gas),
-    );
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): PublicCallStackItemCompressed {
-    const reader = FieldReader.asReader(fields);
-
-    return new PublicCallStackItemCompressed(
-      AztecAddress.fromFields(reader),
-      CallContext.fromFields(reader),
-      reader.readField(),
-      reader.readField(),
-      RevertCode.fromFields(reader),
-      Gas.fromFields(reader),
-      Gas.fromFields(reader),
-    );
-  }
-
-  /**
-   * Returns a new instance of PublicCallStackItem with zero contract address, function data and public inputs.
-   * @returns A new instance of PublicCallStackItem with zero contract address, function data and public inputs.
-   */
-  public static empty(): PublicCallStackItemCompressed {
-    return new PublicCallStackItemCompressed(
-      AztecAddress.ZERO,
-      CallContext.empty(),
-      Fr.ZERO,
-      Fr.ZERO,
-      RevertCode.OK,
-      Gas.empty(),
-      Gas.empty(),
-    );
-  }
-
-  isEmpty() {
-    return (
-      this.contractAddress.isZero() &&
-      this.callContext.isEmpty() &&
-      this.argsHash.isEmpty() &&
-      this.returnsHash.isEmpty() &&
-      this.revertCode.equals(RevertCode.OK) &&
-      this.startGasLeft.isEmpty() &&
-      this.endGasLeft.isEmpty()
-    );
-  }
-}

package/src/avm/public_data_update_request.ts

@@ -1,106 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { inspect } from 'util';
-
-import type { AztecAddress } from '../aztec-address/index.js';
-import { computePublicDataTreeLeafSlot } from '../hash/hash.js';
-import type { ContractStorageUpdateRequest } from './contract_storage_update_request.js';
-
-// TO BE REMOVED.
-/**
- * Write operations on the public data tree including the previous value.
- */
-export class PublicDataUpdateRequest {
-  constructor(
-    /**
-     * Index of the leaf in the public data tree which is to be updated.
-     */
-    public readonly leafSlot: Fr,
-    /**
-     * New value of the leaf.
-     */
-    public readonly newValue: Fr,
-    /**
-     * Side effect counter tracking position of this event in tx execution.
-     */
-    public readonly sideEffectCounter: number,
-  ) {}
-
-  static from(args: {
-    /**
-     * Index of the leaf in the public data tree which is to be updated.
-     */
-    leafIndex: Fr;
-    /**
-     * New value of the leaf.
-     */
-    newValue: Fr;
-
-    /**
-     * Side effect counter tracking position of this event in tx execution.
-     */
-    sideEffectCounter: number;
-  }) {
-    return new PublicDataUpdateRequest(args.leafIndex, args.newValue, args.sideEffectCounter);
-  }
-
-  get counter() {
-    return this.sideEffectCounter;
-  }
-
-  get position() {
-    return this.leafSlot;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(this.leafSlot, this.newValue, this.sideEffectCounter);
-  }
-
-  isEmpty() {
-    return this.leafSlot.isZero() && this.newValue.isZero();
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    return new PublicDataUpdateRequest(reader.readField(), reader.readField(), reader.readU32());
-  }
-
-  static isEmpty(x: PublicDataUpdateRequest) {
-    return x.isEmpty();
-  }
-
-  equals(other: PublicDataUpdateRequest) {
-    return this.leafSlot.equals(other.leafSlot) && this.newValue.equals(other.newValue);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new PublicDataUpdateRequest(Fr.fromBuffer(reader), Fr.fromBuffer(reader), reader.readNumber());
-  }
-
-  static async fromContractStorageUpdateRequest(
-    contractAddress: AztecAddress,
-    updateRequest: ContractStorageUpdateRequest,
-  ) {
-    const leafSlot = await computePublicDataTreeLeafSlot(contractAddress, updateRequest.storageSlot);
-
-    return new PublicDataUpdateRequest(leafSlot, updateRequest.newValue, updateRequest.counter);
-  }
-
-  static empty() {
-    return new PublicDataUpdateRequest(Fr.ZERO, Fr.ZERO, 0);
-  }
-
-  toFriendlyJSON() {
-    return `Leaf=${this.leafSlot.toFriendlyJSON()}: ${this.newValue.toFriendlyJSON()}, SideEffectCounter=${
-      this.sideEffectCounter
-    }`;
-  }
-
-  [inspect.custom]() {
-    return `PublicDataUpdateRequest { leafSlot: ${this.leafSlot.toFriendlyJSON()}, newValue: ${this.newValue.toFriendlyJSON()}, sideEffectCounter: ${
-      this.sideEffectCounter
-    } }`;
-  }
-}

package/src/avm/public_inner_call_request.ts

@@ -1,85 +0,0 @@
-import type { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { inspect } from 'util';
-
-import { PublicCallStackItemCompressed } from './public_call_stack_item_compressed.js';
-
-// TO BE REMOVED
-/**
- * Represents a request to call a public function.
- */
-export class PublicInnerCallRequest {
-  constructor(
-    public item: PublicCallStackItemCompressed,
-    /**
-     * The counter for this call request.
-     */
-    public counter: number,
-  ) {}
-
-  getSize() {
-    return this.isEmpty() ? 0 : this.toBuffer().length;
-  }
-
-  /**
-   * Serialize this as a buffer.
-   * @returns The buffer.
-   */
-  toBuffer() {
-    return serializeToBuffer(this.item, this.counter);
-  }
-
-  /**
-   * Deserialize this from a buffer.
-   * @param buffer - The bufferable type from which to deserialize.
-   * @returns The deserialized instance of PublicInnerCallRequest.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new PublicInnerCallRequest(PublicCallStackItemCompressed.fromBuffer(reader), reader.readNumber());
-  }
-
-  /**
-   * Create PublicInnerCallRequest from a fields dictionary.
-   * @param fields - The dictionary.
-   * @returns A PublicInnerCallRequest object.
-   */
-  static from(fields: FieldsOf<PublicInnerCallRequest>): PublicInnerCallRequest {
-    return new PublicInnerCallRequest(...PublicInnerCallRequest.getFields(fields));
-  }
-
-  /**
-   * Serialize into a field array. Low-level utility.
-   * @param fields - Object with fields.
-   * @returns The array.
-   */
-  static getFields(fields: FieldsOf<PublicInnerCallRequest>) {
-    return [fields.item, fields.counter] as const;
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields([this.item, this.counter]);
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): PublicInnerCallRequest {
-    const reader = FieldReader.asReader(fields);
-    return new PublicInnerCallRequest(PublicCallStackItemCompressed.fromFields(reader), reader.readU32());
-  }
-
-  static empty() {
-    return new PublicInnerCallRequest(PublicCallStackItemCompressed.empty(), 0);
-  }
-
-  isEmpty(): boolean {
-    return this.item.isEmpty() && this.counter == 0;
-  }
-
-  [inspect.custom]() {
-    return `PublicInnerCallRequest {
-      item: ${this.item.toFields()}
-      counter: ${this.counter}
-    }`;
-  }
-}

package/src/contract/deployment_info.ts

@@ -1,25 +0,0 @@
-import type { Fr } from '@aztec/foundation/curves/bn254';
-
-import type { CompleteAddress } from './complete_address.js';
-
-/**
- * Represents the data generated as part of contract deployment.
- */
-export type DeploymentInfo = {
-  /**
-   * The complete address of the deployed contract.
-   */
-  completeAddress: CompleteAddress;
-  /**
-   * The contract's constructor verification key hash.
-   */
-  constructorVkHash: Fr;
-  /**
-   * The contract's constructor hash.
-   */
-  constructorHash: Fr;
-  /**
-   * The root of the contract's function tree.
-   */
-  functionTreeRoot: Fr;
-};

package/src/interfaces/prover-coordination.ts

@@ -1,17 +0,0 @@
-import { Tx } from '../tx/tx.js';
-import { TxHash } from '../tx/tx_hash.js';
-import type { P2PClient } from './p2p.js';
-
-/** Provides basic operations for ProverNodes to interact with other nodes in the network. */
-export interface ProverCoordination {
-  /**
-   * Returns a set of transactions given their hashes if available.
-   * @param txHashes - The hashes of the transactions, used as an ID.
-   * @returns The transactions found, no necessarily in the same order as the hashes.
-   */
-  getTxsByHash(txHashes: TxHash[]): Promise<Tx[]>;
-
-  gatherTxs(txHashes: TxHash[]): Promise<void>;
-
-  getP2PClient(): P2PClient | undefined;
-}

package/src/kernel/hints/tree_leaf_read_request.ts

@@ -1,35 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-export class TreeLeafReadRequest {
-  constructor(
-    public value: Fr,
-    public leafIndex: Fr,
-  ) {}
-
-  toBuffer(): Buffer {
-    return serializeToBuffer(this.value, this.leafIndex);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new TreeLeafReadRequest(Fr.fromBuffer(reader), Fr.fromBuffer(reader));
-  }
-
-  toFields(): Fr[] {
-    return [this.value, this.leafIndex];
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    return new TreeLeafReadRequest(reader.readField(), reader.readField());
-  }
-
-  isEmpty() {
-    return this.value.isZero() && this.leafIndex.isZero();
-  }
-
-  static empty() {
-    return new TreeLeafReadRequest(Fr.zero(), Fr.zero());
-  }
-}

package/src/kernel/utils/optional_number.ts

@@ -1,50 +0,0 @@
-import type { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-export class OptionalNumber {
-  constructor(
-    /**
-     * Whether a value was set.
-     */
-    public isSome: boolean,
-    /**
-     * The actual number, if isSome is true.
-     */
-    public value: number,
-  ) {}
-
-  getSize() {
-    return this.toBuffer().length;
-  }
-
-  static getFields(fields: FieldsOf<OptionalNumber>) {
-    return [fields.isSome, fields.value] as const;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...OptionalNumber.getFields(this));
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader): OptionalNumber {
-    const reader = BufferReader.asReader(buffer);
-    return new OptionalNumber(reader.readBoolean(), reader.readNumber());
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields(...OptionalNumber.getFields(this));
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): OptionalNumber {
-    const reader = FieldReader.asReader(fields);
-    return new OptionalNumber(reader.readBoolean(), reader.readU32());
-  }
-
-  isEmpty(): boolean {
-    return !this.isSome && !this.value;
-  }
-
-  static empty() {
-    return new OptionalNumber(false, 0);
-  }
-}

package/src/p2p/interface.ts

@@ -1,4 +0,0 @@
-export interface RawGossipMessage {
-  topic: string;
-  data: Uint8Array;
-}

package/src/tx/validator/empty_validator.ts

@@ -1,7 +0,0 @@
-import type { AnyTx, TxValidationResult, TxValidator } from './tx_validator.js';
-
-export class EmptyTxValidator<T = AnyTx> implements TxValidator<T> {
-  public validateTx(_tx: T): Promise<TxValidationResult> {
-    return Promise.resolve({ result: 'valid' });
-  }
-}