@aztec/stdlib 0.77.0-testnet-ignition.17

package/dest/event/l1_event_payload.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { type Fq } from '@aztec/foundation/fields';
+import { EventSelector } from '../abi/event_selector.js';
+import { AztecAddress } from '../aztec-address/index.js';
+import type { PrivateLog } from '../logs/private_log.js';
+import { Event } from './event.js';
+/**
+ * A class which wraps event data which is pushed on L1.
+ */
+export declare class L1EventPayload {
+    #private;
+    /**
+     * A event as emitted from Noir contract. Can be used along with private key to compute nullifier.
+     */
+    event: Event;
+    /**
+     * Address of the contract this tx is interacting with.
+     */
+    contractAddress: AztecAddress;
+    /**
+     * Type identifier for the underlying event, required to determine how to compute its hash and nullifier.
+     */
+    eventTypeId: EventSelector;
+    constructor(
+    /**
+     * A event as emitted from Noir contract. Can be used along with private key to compute nullifier.
+     */
+    event: Event, 
+    /**
+     * Address of the contract this tx is interacting with.
+     */
+    contractAddress: AztecAddress, 
+    /**
+     * Type identifier for the underlying event, required to determine how to compute its hash and nullifier.
+     */
+    eventTypeId: EventSelector);
+    static decryptAsIncoming(log: PrivateLog, sk: Fq): Promise<L1EventPayload | undefined>;
+    /**
+     * Serializes the L1EventPayload object into a Buffer.
+     * @returns Buffer representation of the L1EventPayload object.
+     */
+    toIncomingBodyPlaintext(): Buffer;
+    /**
+     * Create a random L1EventPayload object (useful for testing purposes).
+     * @param contract - The address of a contract the event was emitted from.
+     * @returns A random L1EventPayload object.
+     */
+    static random(contract?: AztecAddress): Promise<L1EventPayload>;
+    equals(other: L1EventPayload): boolean;
+}
+//# sourceMappingURL=l1_event_payload.d.ts.map

package/dest/event/l1_event_payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"l1_event_payload.d.ts","sourceRoot":"","sources":["../../src/event/l1_event_payload.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,KAAK,EAAE,EAAM,MAAM,0BAA0B,CAAC;AAGvD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAEzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;GAEG;AACH,qBAAa,cAAc;;IAEvB;;OAEG;IACI,KAAK,EAAE,KAAK;IACnB;;OAEG;IACI,eAAe,EAAE,YAAY;IACpC;;OAEG;IACI,WAAW,EAAE,aAAa;;IAXjC;;OAEG;IACI,KAAK,EAAE,KAAK;IACnB;;OAEG;IACI,eAAe,EAAE,YAAY;IACpC;;OAEG;IACI,WAAW,EAAE,aAAa;WAwBtB,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,cAAc,GAAG,SAAS,CAAC;IAY5F;;;OAGG;IACH,uBAAuB;IAKvB;;;;OAIG;WACU,MAAM,CAAC,QAAQ,CAAC,EAAE,YAAY;IAIpC,MAAM,CAAC,KAAK,EAAE,cAAc;CAOpC"}

package/dest/event/l1_event_payload.js

@@ -0,0 +1,64 @@
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { EventSelector } from '../abi/event_selector.js';
+import { AztecAddress } from '../aztec-address/index.js';
+import { EncryptedLogPayload } from '../logs/l1_payload/encrypted_log_payload.js';
+import { Event } from './event.js';
+/**
+ * A class which wraps event data which is pushed on L1.
+ */ export class L1EventPayload {
+    event;
+    contractAddress;
+    eventTypeId;
+    constructor(/**
+     * A event as emitted from Noir contract. Can be used along with private key to compute nullifier.
+     */ event, /**
+     * Address of the contract this tx is interacting with.
+     */ contractAddress, /**
+     * Type identifier for the underlying event, required to determine how to compute its hash and nullifier.
+     */ eventTypeId){
+        this.event = event;
+        this.contractAddress = contractAddress;
+        this.eventTypeId = eventTypeId;
+    }
+    static #fromIncomingBodyPlaintextAndContractAddress(plaintext, contractAddress) {
+        let payload;
+        try {
+            const reader = BufferReader.asReader(plaintext);
+            const fields = reader.readArray(plaintext.length / Fr.SIZE_IN_BYTES, Fr);
+            const eventTypeId = EventSelector.fromField(fields[0]);
+            const event = new Event(fields.slice(1));
+            payload = new L1EventPayload(event, contractAddress, eventTypeId);
+        } catch (e) {
+            return undefined;
+        }
+        return payload;
+    }
+    static async decryptAsIncoming(log, sk) {
+        const decryptedLog = await EncryptedLogPayload.decryptAsIncoming(log.fields, sk);
+        if (!decryptedLog) {
+            return undefined;
+        }
+        return this.#fromIncomingBodyPlaintextAndContractAddress(decryptedLog.incomingBodyPlaintext, decryptedLog.contractAddress);
+    }
+    /**
+   * Serializes the L1EventPayload object into a Buffer.
+   * @returns Buffer representation of the L1EventPayload object.
+   */ toIncomingBodyPlaintext() {
+        const fields = [
+            this.eventTypeId.toField(),
+            ...this.event.items
+        ];
+        return serializeToBuffer(fields);
+    }
+    /**
+   * Create a random L1EventPayload object (useful for testing purposes).
+   * @param contract - The address of a contract the event was emitted from.
+   * @returns A random L1EventPayload object.
+   */ static async random(contract) {
+        return new L1EventPayload(Event.random(), contract ?? await AztecAddress.random(), EventSelector.random());
+    }
+    equals(other) {
+        return this.event.equals(other.event) && this.contractAddress.equals(other.contractAddress) && this.eventTypeId.equals(other.eventTypeId);
+    }
+}

package/dest/fees/index.d.ts

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

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

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

package/dest/fees/index.js

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

package/dest/fees/transaction_fee.d.ts

@@ -0,0 +1,6 @@
+import type { Fr } from '@aztec/foundation/fields';
+import type { Gas } from '../gas/gas.js';
+import { GasFees } from '../gas/gas_fees.js';
+import type { GasSettings } from '../gas/gas_settings.js';
+export declare function computeTransactionFee(gasFees: GasFees, gasSettings: GasSettings, gasUsed: Gas): Fr;
+//# sourceMappingURL=transaction_fee.d.ts.map

package/dest/fees/transaction_fee.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction_fee.d.ts","sourceRoot":"","sources":["../../src/fees/transaction_fee.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAE1D,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,GAAG,EAAE,CAclG"}

package/dest/fees/transaction_fee.js

@@ -0,0 +1,8 @@
+import { GasFees } from '../gas/gas_fees.js';
+export function computeTransactionFee(gasFees, gasSettings, gasUsed) {
+    const { maxFeesPerGas, maxPriorityFeesPerGas } = gasSettings;
+    const minField = (f1, f2)=>f1.lt(f2) ? f1 : f2;
+    const priorityFees = new GasFees(minField(maxPriorityFeesPerGas.feePerDaGas, maxFeesPerGas.feePerDaGas.sub(gasFees.feePerDaGas)), minField(maxPriorityFeesPerGas.feePerL2Gas, maxFeesPerGas.feePerL2Gas.sub(gasFees.feePerL2Gas)));
+    const totalFees = new GasFees(gasFees.feePerDaGas.add(priorityFees.feePerDaGas), gasFees.feePerL2Gas.add(priorityFees.feePerL2Gas));
+    return gasUsed.computeFee(totalFees);
+}

package/dest/gas/gas.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, FieldReader } from '@aztec/foundation/serialize';
+import type { FieldsOf } from '@aztec/foundation/types';
+import { inspect } from 'util';
+import { z } from 'zod';
+import type { UInt32 } from '../types/shared.js';
+import type { GasFees } from './gas_fees.js';
+export declare const GasDimensions: readonly ["da", "l2"];
+export type GasDimensions = (typeof GasDimensions)[number];
+/** Gas amounts in each dimension. */
+export declare class Gas {
+    readonly daGas: UInt32;
+    readonly l2Gas: UInt32;
+    constructor(daGas: UInt32, l2Gas: UInt32);
+    static get schema(): z.ZodEffects<z.ZodObject<{
+        daGas: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>;
+        l2Gas: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        daGas: number;
+        l2Gas: number;
+    }, {
+        daGas: string | number | bigint;
+        l2Gas: string | number | bigint;
+    }>, Gas, {
+        daGas: string | number | bigint;
+        l2Gas: string | number | bigint;
+    }>;
+    clone(): Gas;
+    get(dimension: GasDimensions): number;
+    equals(other: Gas): boolean;
+    static from(fields: Partial<FieldsOf<Gas>>): Gas;
+    static empty(): Gas;
+    static random(): Gas;
+    isEmpty(): boolean;
+    static fromBuffer(buffer: Buffer | BufferReader): Gas;
+    toBuffer(): Buffer;
+    [inspect.custom](): string;
+    add(other: Gas): Gas;
+    sub(other: Gas): Gas;
+    mul(scalar: number): Gas;
+    /** Returns true if any of this instance's dimensions is greater than the corresponding on the other. */
+    gtAny(other: Gas): boolean;
+    computeFee(gasFees: GasFees): Fr;
+    toFields(): Fr[];
+    static fromFields(fields: Fr[] | FieldReader): Gas;
+}
+//# sourceMappingURL=gas.d.ts.map

package/dest/gas/gas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas.d.ts","sourceRoot":"","sources":["../../src/gas/gas.ts"],"names":[],"mappings":";;;AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAwC,MAAM,6BAA6B,CAAC;AAC9G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAO,MAAM,aAAa,uBAAwB,CAAC;AACnD,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAE3D,qCAAqC;AACrC,qBAAa,GAAG;aACc,KAAK,EAAE,MAAM;aAAkB,KAAK,EAAE,MAAM;gBAA5C,KAAK,EAAE,MAAM,EAAkB,KAAK,EAAE,MAAM;IAExE,MAAM,KAAK,MAAM;;;;;;;;;;;;OAOhB;IAED,KAAK,IAAI,GAAG;IAIZ,GAAG,CAAC,SAAS,EAAE,aAAa;IAI5B,MAAM,CAAC,KAAK,EAAE,GAAG;IAIjB,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAI1C,MAAM,CAAC,KAAK;IAIZ,MAAM,CAAC,MAAM;IAIb,OAAO;IAIP,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,GAAG;IAKrD,QAAQ;IAIR,CAAC,OAAO,CAAC,MAAM,CAAC;IAIhB,GAAG,CAAC,KAAK,EAAE,GAAG;IAId,GAAG,CAAC,KAAK,EAAE,GAAG;IAId,GAAG,CAAC,MAAM,EAAE,MAAM;IAIlB,wGAAwG;IACxG,KAAK,CAAC,KAAK,EAAE,GAAG;IAIhB,UAAU,CAAC,OAAO,EAAE,OAAO;IAO3B,QAAQ;IAIR,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW;CAI7C"}

package/dest/gas/gas.js

@@ -0,0 +1,76 @@
+import { Fr } from '@aztec/foundation/fields';
+import { schemas } from '@aztec/foundation/schemas';
+import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
+import { inspect } from 'util';
+import { z } from 'zod';
+export const GasDimensions = [
+    'da',
+    'l2'
+];
+/** Gas amounts in each dimension. */ export class Gas {
+    daGas;
+    l2Gas;
+    constructor(daGas, l2Gas){
+        this.daGas = daGas;
+        this.l2Gas = l2Gas;
+    }
+    static get schema() {
+        return z.object({
+            daGas: schemas.UInt32,
+            l2Gas: schemas.UInt32
+        }).transform(Gas.from);
+    }
+    clone() {
+        return new Gas(this.daGas, this.l2Gas);
+    }
+    get(dimension) {
+        return this[`${dimension}Gas`];
+    }
+    equals(other) {
+        return this.daGas === other.daGas && this.l2Gas === other.l2Gas;
+    }
+    static from(fields) {
+        return new Gas(fields.daGas ?? 0, fields.l2Gas ?? 0);
+    }
+    static empty() {
+        return new Gas(0, 0);
+    }
+    static random() {
+        return new Gas(Math.floor(Math.random() * 1e9), Math.floor(Math.random() * 1e9));
+    }
+    isEmpty() {
+        return this.daGas === 0 && this.l2Gas === 0;
+    }
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new Gas(reader.readNumber(), reader.readNumber());
+    }
+    toBuffer() {
+        return serializeToBuffer(this.daGas, this.l2Gas);
+    }
+    [inspect.custom]() {
+        return `Gas { daGas=${this.daGas} l2Gas=${this.l2Gas} }`;
+    }
+    add(other) {
+        return new Gas(this.daGas + other.daGas, this.l2Gas + other.l2Gas);
+    }
+    sub(other) {
+        return new Gas(this.daGas - other.daGas, this.l2Gas - other.l2Gas);
+    }
+    mul(scalar) {
+        return new Gas(Math.ceil(this.daGas * scalar), Math.ceil(this.l2Gas * scalar));
+    }
+    /** Returns true if any of this instance's dimensions is greater than the corresponding on the other. */ gtAny(other) {
+        return this.daGas > other.daGas || this.l2Gas > other.l2Gas;
+    }
+    computeFee(gasFees) {
+        return GasDimensions.reduce((acc, dimension)=>acc.add(gasFees.get(dimension).mul(new Fr(this.get(dimension)))), Fr.ZERO);
+    }
+    toFields() {
+        return serializeToFields(this.daGas, this.l2Gas);
+    }
+    static fromFields(fields) {
+        const reader = FieldReader.asReader(fields);
+        return new Gas(reader.readU32(), reader.readU32());
+    }
+}

package/dest/gas/gas_fees.d.ts

@@ -0,0 +1,46 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, FieldReader } from '@aztec/foundation/serialize';
+import type { FieldsOf } from '@aztec/foundation/types';
+import { inspect } from 'util';
+import { z } from 'zod';
+import type { GasDimensions } from './gas.js';
+/** Gas prices for each dimension. */
+export declare class GasFees {
+    readonly feePerDaGas: Fr;
+    readonly feePerL2Gas: Fr;
+    constructor(feePerDaGas: Fr | number | bigint, feePerL2Gas: Fr | number | bigint);
+    static get schema(): z.ZodEffects<z.ZodObject<{
+        feePerDaGas: z.ZodType<Fr, any, string>;
+        feePerL2Gas: z.ZodType<Fr, any, string>;
+    }, "strip", z.ZodTypeAny, {
+        feePerDaGas: Fr;
+        feePerL2Gas: Fr;
+    }, {
+        feePerDaGas: string;
+        feePerL2Gas: string;
+    }>, GasFees, {
+        feePerDaGas: string;
+        feePerL2Gas: string;
+    }>;
+    clone(): GasFees;
+    equals(other: GasFees): boolean;
+    get(dimension: GasDimensions): Fr;
+    mul(scalar: number | bigint): GasFees;
+    static from(fields: FieldsOf<GasFees>): GasFees;
+    static random(): GasFees;
+    static empty(): GasFees;
+    isEmpty(): boolean;
+    static fromBuffer(buffer: Buffer | BufferReader): GasFees;
+    toBuffer(): Buffer;
+    static fromFields(fields: Fr[] | FieldReader): GasFees;
+    toFields(): Fr[];
+    toInspect(): {
+        feePerDaGas: number;
+        feePerL2Gas: number;
+    };
+    [inspect.custom](): string;
+}
+//# sourceMappingURL=gas_fees.d.ts.map

package/dest/gas/gas_fees.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas_fees.d.ts","sourceRoot":"","sources":["../../src/gas/gas_fees.ts"],"names":[],"mappings":";;;AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAwC,MAAM,6BAA6B,CAAC;AAC9G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,qCAAqC;AACrC,qBAAa,OAAO;IAClB,SAAgB,WAAW,EAAE,EAAE,CAAC;IAChC,SAAgB,WAAW,EAAE,EAAE,CAAC;gBAEpB,WAAW,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,MAAM,GAAG,MAAM;IAKhF,MAAM,KAAK,MAAM;;;;;;;;;;;;OAOhB;IAED,KAAK,IAAI,OAAO;IAIhB,MAAM,CAAC,KAAK,EAAE,OAAO;IAIrB,GAAG,CAAC,SAAS,EAAE,aAAa;IAS5B,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAa3B,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC;IAIrC,MAAM,CAAC,MAAM;IAIb,MAAM,CAAC,KAAK;IAIZ,OAAO;IAIP,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,OAAO;IAKzD,QAAQ;IAIR,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW;IAK5C,QAAQ;IAIR,SAAS;;;;IAOT,CAAC,OAAO,CAAC,MAAM,CAAC;CAGjB"}

package/dest/gas/gas_fees.js

@@ -0,0 +1,77 @@
+import { Fr } from '@aztec/foundation/fields';
+import { schemas } from '@aztec/foundation/schemas';
+import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
+import { inspect } from 'util';
+import { z } from 'zod';
+/** Gas prices for each dimension. */ export class GasFees {
+    feePerDaGas;
+    feePerL2Gas;
+    constructor(feePerDaGas, feePerL2Gas){
+        this.feePerDaGas = new Fr(feePerDaGas);
+        this.feePerL2Gas = new Fr(feePerL2Gas);
+    }
+    static get schema() {
+        return z.object({
+            feePerDaGas: schemas.Fr,
+            feePerL2Gas: schemas.Fr
+        }).transform(GasFees.from);
+    }
+    clone() {
+        return new GasFees(this.feePerDaGas, this.feePerL2Gas);
+    }
+    equals(other) {
+        return this.feePerDaGas.equals(other.feePerDaGas) && this.feePerL2Gas.equals(other.feePerL2Gas);
+    }
+    get(dimension) {
+        switch(dimension){
+            case 'da':
+                return this.feePerDaGas;
+            case 'l2':
+                return this.feePerL2Gas;
+        }
+    }
+    mul(scalar) {
+        if (scalar === 1 || scalar === 1n) {
+            return this.clone();
+        } else if (typeof scalar === 'bigint') {
+            return new GasFees(new Fr(this.feePerDaGas.toBigInt() * scalar), new Fr(this.feePerL2Gas.toBigInt() * scalar));
+        } else {
+            return new GasFees(new Fr(this.feePerDaGas.toNumberUnsafe() * scalar), new Fr(this.feePerL2Gas.toNumberUnsafe() * scalar));
+        }
+    }
+    static from(fields) {
+        return new GasFees(fields.feePerDaGas, fields.feePerL2Gas);
+    }
+    static random() {
+        return new GasFees(Fr.random(), Fr.random());
+    }
+    static empty() {
+        return new GasFees(Fr.ZERO, Fr.ZERO);
+    }
+    isEmpty() {
+        return this.feePerDaGas.isZero() && this.feePerL2Gas.isZero();
+    }
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new GasFees(reader.readObject(Fr), reader.readObject(Fr));
+    }
+    toBuffer() {
+        return serializeToBuffer(this.feePerDaGas, this.feePerL2Gas);
+    }
+    static fromFields(fields) {
+        const reader = FieldReader.asReader(fields);
+        return new GasFees(reader.readField(), reader.readField());
+    }
+    toFields() {
+        return serializeToFields(this.feePerDaGas, this.feePerL2Gas);
+    }
+    toInspect() {
+        return {
+            feePerDaGas: this.feePerDaGas.toNumberUnsafe(),
+            feePerL2Gas: this.feePerL2Gas.toNumberUnsafe()
+        };
+    }
+    [inspect.custom]() {
+        return `GasFees { feePerDaGas=${this.feePerDaGas.toBigInt()} feePerL2Gas=${this.feePerL2Gas.toBigInt()} }`;
+    }
+}

package/dest/gas/gas_settings.d.ts

@@ -0,0 +1,136 @@
+/// <reference types="node" resolution-mode="require"/>
+/// <reference types="node" resolution-mode="require"/>
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, FieldReader } from '@aztec/foundation/serialize';
+import type { FieldsOf } from '@aztec/foundation/types';
+import { z } from 'zod';
+import { Gas } from './gas.js';
+import { GasFees } from './gas_fees.js';
+/** Gas usage and fees limits set by the transaction sender for different dimensions and phases. */
+export declare class GasSettings {
+    readonly gasLimits: Gas;
+    readonly teardownGasLimits: Gas;
+    readonly maxFeesPerGas: GasFees;
+    readonly maxPriorityFeesPerGas: GasFees;
+    constructor(gasLimits: Gas, teardownGasLimits: Gas, maxFeesPerGas: GasFees, maxPriorityFeesPerGas: GasFees);
+    static get schema(): z.ZodEffects<z.ZodObject<{
+        gasLimits: z.ZodEffects<z.ZodObject<{
+            daGas: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>;
+            l2Gas: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            daGas: number;
+            l2Gas: number;
+        }, {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        }>, Gas, {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        }>;
+        teardownGasLimits: z.ZodEffects<z.ZodObject<{
+            daGas: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>;
+            l2Gas: z.ZodPipeline<z.ZodUnion<[z.ZodBigInt, z.ZodNumber, z.ZodString]>, z.ZodNumber>;
+        }, "strip", z.ZodTypeAny, {
+            daGas: number;
+            l2Gas: number;
+        }, {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        }>, Gas, {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        }>;
+        maxFeesPerGas: z.ZodEffects<z.ZodObject<{
+            feePerDaGas: z.ZodType<Fr, any, string>;
+            feePerL2Gas: z.ZodType<Fr, any, string>;
+        }, "strip", z.ZodTypeAny, {
+            feePerDaGas: Fr;
+            feePerL2Gas: Fr;
+        }, {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        }>, GasFees, {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        }>;
+        maxPriorityFeesPerGas: z.ZodEffects<z.ZodObject<{
+            feePerDaGas: z.ZodType<Fr, any, string>;
+            feePerL2Gas: z.ZodType<Fr, any, string>;
+        }, "strip", z.ZodTypeAny, {
+            feePerDaGas: Fr;
+            feePerL2Gas: Fr;
+        }, {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        }>, GasFees, {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        gasLimits: Gas;
+        teardownGasLimits: Gas;
+        maxFeesPerGas: GasFees;
+        maxPriorityFeesPerGas: GasFees;
+    }, {
+        gasLimits: {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        };
+        teardownGasLimits: {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        };
+        maxFeesPerGas: {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        };
+        maxPriorityFeesPerGas: {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        };
+    }>, GasSettings, {
+        gasLimits: {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        };
+        teardownGasLimits: {
+            daGas: string | number | bigint;
+            l2Gas: string | number | bigint;
+        };
+        maxFeesPerGas: {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        };
+        maxPriorityFeesPerGas: {
+            feePerDaGas: string;
+            feePerL2Gas: string;
+        };
+    }>;
+    getSize(): number;
+    static from(args: {
+        gasLimits: FieldsOf<Gas>;
+        teardownGasLimits: FieldsOf<Gas>;
+        maxFeesPerGas: FieldsOf<GasFees>;
+        maxPriorityFeesPerGas: FieldsOf<GasFees>;
+    }): GasSettings;
+    clone(): GasSettings;
+    /** Returns the maximum fee to be paid according to gas limits and max fees set. */
+    getFeeLimit(): Fr;
+    /** Zero-value gas settings. */
+    static empty(): GasSettings;
+    /** Default gas settings to use when user has not provided them. Requires explicit max fees per gas. */
+    static default(overrides: {
+        gasLimits?: Gas;
+        teardownGasLimits?: Gas;
+        maxFeesPerGas: GasFees;
+        maxPriorityFeesPerGas?: GasFees;
+    }): GasSettings;
+    isEmpty(): boolean;
+    equals(other: GasSettings): boolean;
+    static fromBuffer(buffer: Buffer | BufferReader): GasSettings;
+    toBuffer(): Buffer;
+    static fromFields(fields: Fr[] | FieldReader): GasSettings;
+    toFields(): Fr[];
+    static getFields(fields: FieldsOf<GasSettings>): readonly [Gas, Gas, GasFees, GasFees];
+}
+//# sourceMappingURL=gas_settings.d.ts.map

package/dest/gas/gas_settings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gas_settings.d.ts","sourceRoot":"","sources":["../../src/gas/gas_settings.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,WAAW,EAAwC,MAAM,6BAA6B,CAAC;AAC9G,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,GAAG,EAAiB,MAAM,UAAU,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAGxC,mGAAmG;AACnG,qBAAa,WAAW;aAEJ,SAAS,EAAE,GAAG;aACd,iBAAiB,EAAE,GAAG;aACtB,aAAa,EAAE,OAAO;aACtB,qBAAqB,EAAE,OAAO;gBAH9B,SAAS,EAAE,GAAG,EACd,iBAAiB,EAAE,GAAG,EACtB,aAAa,EAAE,OAAO,EACtB,qBAAqB,EAAE,OAAO;IAIhD,MAAM,KAAK,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAShB;IAED,OAAO,IAAI,MAAM;IAIjB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE;QAChB,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QACzB,iBAAiB,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;QACjC,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;QACjC,qBAAqB,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC;KAC1C;IASD,KAAK;IASL,mFAAmF;IACnF,WAAW;IAWX,+BAA+B;IAC/B,MAAM,CAAC,KAAK;IAIZ,uGAAuG;IACvG,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE;QACxB,SAAS,CAAC,EAAE,GAAG,CAAC;QAChB,iBAAiB,CAAC,EAAE,GAAG,CAAC;QACxB,aAAa,EAAE,OAAO,CAAC;QACvB,qBAAqB,CAAC,EAAE,OAAO,CAAC;KACjC;IAYD,OAAO;IASP,MAAM,CAAC,KAAK,EAAE,WAAW;IASzB,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,WAAW;IAU7D,QAAQ;IAIR,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,EAAE,GAAG,WAAW,GAAG,WAAW;IAU1D,QAAQ,IAAI,EAAE,EAAE;IAUhB,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC;CAG/C"}

package/dest/gas/gas_settings.js

@@ -0,0 +1,89 @@
+import { DEFAULT_GAS_LIMIT, DEFAULT_TEARDOWN_GAS_LIMIT, GAS_SETTINGS_LENGTH } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
+import { z } from 'zod';
+import { Gas, GasDimensions } from './gas.js';
+import { GasFees } from './gas_fees.js';
+// docs:start:gas_settings_vars
+/** Gas usage and fees limits set by the transaction sender for different dimensions and phases. */ export class GasSettings {
+    gasLimits;
+    teardownGasLimits;
+    maxFeesPerGas;
+    maxPriorityFeesPerGas;
+    constructor(gasLimits, teardownGasLimits, maxFeesPerGas, maxPriorityFeesPerGas){
+        this.gasLimits = gasLimits;
+        this.teardownGasLimits = teardownGasLimits;
+        this.maxFeesPerGas = maxFeesPerGas;
+        this.maxPriorityFeesPerGas = maxPriorityFeesPerGas;
+    }
+    // docs:end:gas_settings_vars
+    static get schema() {
+        return z.object({
+            gasLimits: Gas.schema,
+            teardownGasLimits: Gas.schema,
+            maxFeesPerGas: GasFees.schema,
+            maxPriorityFeesPerGas: GasFees.schema
+        }).transform(GasSettings.from);
+    }
+    getSize() {
+        return this.toBuffer().length;
+    }
+    static from(args) {
+        return new GasSettings(Gas.from(args.gasLimits), Gas.from(args.teardownGasLimits), GasFees.from(args.maxFeesPerGas), GasFees.from(args.maxPriorityFeesPerGas));
+    }
+    clone() {
+        return new GasSettings(this.gasLimits.clone(), this.teardownGasLimits.clone(), this.maxFeesPerGas.clone(), this.maxPriorityFeesPerGas.clone());
+    }
+    /** Returns the maximum fee to be paid according to gas limits and max fees set. */ getFeeLimit() {
+        return GasDimensions.reduce((acc, dimension)=>this.maxFeesPerGas.get(dimension).mul(new Fr(this.gasLimits.get(dimension))).add(acc), Fr.ZERO);
+    }
+    /** Zero-value gas settings. */ static empty() {
+        return new GasSettings(Gas.empty(), Gas.empty(), GasFees.empty(), GasFees.empty());
+    }
+    /** Default gas settings to use when user has not provided them. Requires explicit max fees per gas. */ static default(overrides) {
+        return GasSettings.from({
+            gasLimits: overrides.gasLimits ?? {
+                l2Gas: DEFAULT_GAS_LIMIT,
+                daGas: DEFAULT_GAS_LIMIT
+            },
+            teardownGasLimits: overrides.teardownGasLimits ?? {
+                l2Gas: DEFAULT_TEARDOWN_GAS_LIMIT,
+                daGas: DEFAULT_TEARDOWN_GAS_LIMIT
+            },
+            maxFeesPerGas: overrides.maxFeesPerGas,
+            maxPriorityFeesPerGas: overrides.maxPriorityFeesPerGas ?? GasFees.empty()
+        });
+    }
+    isEmpty() {
+        return this.gasLimits.isEmpty() && this.teardownGasLimits.isEmpty() && this.maxFeesPerGas.isEmpty() && this.maxPriorityFeesPerGas.isEmpty();
+    }
+    equals(other) {
+        return this.gasLimits.equals(other.gasLimits) && this.teardownGasLimits.equals(other.teardownGasLimits) && this.maxFeesPerGas.equals(other.maxFeesPerGas) && this.maxPriorityFeesPerGas.equals(other.maxPriorityFeesPerGas);
+    }
+    static fromBuffer(buffer) {
+        const reader = BufferReader.asReader(buffer);
+        return new GasSettings(reader.readObject(Gas), reader.readObject(Gas), reader.readObject(GasFees), reader.readObject(GasFees));
+    }
+    toBuffer() {
+        return serializeToBuffer(...GasSettings.getFields(this));
+    }
+    static fromFields(fields) {
+        const reader = FieldReader.asReader(fields);
+        return new GasSettings(reader.readObject(Gas), reader.readObject(Gas), reader.readObject(GasFees), reader.readObject(GasFees));
+    }
+    toFields() {
+        const fields = serializeToFields(...GasSettings.getFields(this));
+        if (fields.length !== GAS_SETTINGS_LENGTH) {
+            throw new Error(`Invalid number of fields for GasSettings. Expected ${GAS_SETTINGS_LENGTH} but got ${fields.length}`);
+        }
+        return fields;
+    }
+    static getFields(fields) {
+        return [
+            fields.gasLimits,
+            fields.teardownGasLimits,
+            fields.maxFeesPerGas,
+            fields.maxPriorityFeesPerGas
+        ];
+    }
+}

package/dest/gas/gas_used.d.ts

@@ -0,0 +1,20 @@
+import type { Gas } from './gas.js';
+export interface GasUsed {
+    /**
+     * Total gas used across both private and public executions.
+     * Note that this does not determine the transaction fee. The fee is calculated with billedGas, which uses `teardownGasLimits` from
+     * `GasSettings`, rather than actual teardown gas.
+     */
+    totalGas: Gas;
+    /** Total gas used during public execution, including actual teardown gas */
+    publicGas: Gas;
+    /**
+     * The actual gas used in the teardown phase.
+     */
+    teardownGas: Gas;
+    /**
+     * The gas billed for the transaction. This uses teardown gas limit instead of actual teardown gas.
+     */
+    billedGas: Gas;
+}
+//# sourceMappingURL=gas_used.d.ts.map