@aztec/aztec.js 0.0.0-test.0

package/dest/api/ethereum/portal_manager.d.ts

@@ -0,0 +1,136 @@
+import type { ViemPublicClient, ViemWalletClient } from '@aztec/ethereum';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { Fr } from '@aztec/foundation/fields';
+import type { Logger } from '@aztec/foundation/log';
+import type { SiblingPath } from '@aztec/foundation/trees';
+import { TokenPortalAbi } from '@aztec/l1-artifacts';
+import type { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { PXE } from '@aztec/stdlib/interfaces/client';
+import { type GetContractReturnType, type Hex } from 'viem';
+/** L1 to L2 message info to claim it on L2. */
+export type L2Claim = {
+    /** Secret for claiming. */
+    claimSecret: Fr;
+    /** Hash of the secret for claiming. */
+    claimSecretHash: Fr;
+    /** Hash of the message. */
+    messageHash: Hex;
+    /** Leaf index in the L1 to L2 message tree. */
+    messageLeafIndex: bigint;
+};
+/** L1 to L2 message info that corresponds to an amount to claim. */
+export type L2AmountClaim = L2Claim & {
+    claimAmount: bigint;
+};
+/** L1 to L2 message info that corresponds to an amount to claim with associated recipient. */
+export type L2AmountClaimWithRecipient = L2AmountClaim & {
+    /** Address that will receive the newly minted notes. */ recipient: AztecAddress;
+};
+/** Generates a pair secret and secret hash */
+export declare function generateClaimSecret(logger?: Logger): Promise<[Fr, Fr]>;
+/** Helper for managing an ERC20 on L1. */
+export declare class L1TokenManager {
+    /** Address of the ERC20 contract. */
+    readonly address: EthAddress;
+    private publicClient;
+    private walletClient;
+    private logger;
+    private contract;
+    constructor(
+    /** Address of the ERC20 contract. */
+    address: EthAddress, publicClient: ViemPublicClient, walletClient: ViemWalletClient, logger: Logger);
+    /**
+     * Returns the balance of the given address.
+     * @param address - Address to get the balance of.
+     */
+    getL1TokenBalance(address: Hex): Promise<bigint>;
+    /**
+     * Mints tokens for the given address. Returns once the tx has been mined.
+     * @param amount - Amount to mint.
+     * @param address - Address to mint the tokens for.
+     * @param addressName - Optional name of the address for logging.
+     */
+    mint(amount: bigint, address: Hex, addressName?: string): Promise<void>;
+    /**
+     * Approves tokens for the given address. Returns once the tx has been mined.
+     * @param amount - Amount to approve.
+     * @param address - Address to approve the tokens for.
+     * @param addressName - Optional name of the address for logging.
+     */
+    approve(amount: bigint, address: Hex, addressName?: string): Promise<void>;
+}
+/** Helper for interacting with the FeeJuicePortal on L1. */
+export declare class L1FeeJuicePortalManager {
+    private readonly publicClient;
+    private readonly walletClient;
+    private readonly logger;
+    private readonly tokenManager;
+    private readonly contract;
+    constructor(portalAddress: EthAddress, tokenAddress: EthAddress, publicClient: ViemPublicClient, walletClient: ViemWalletClient, logger: Logger);
+    /** Returns the associated token manager for the L1 ERC20. */
+    getTokenManager(): L1TokenManager;
+    /**
+     * Bridges fee juice from L1 to L2 publicly. Handles L1 ERC20 approvals. Returns once the tx has been mined.
+     * @param to - Address to send the tokens to on L2.
+     * @param amount - Amount of tokens to send.
+     * @param mint - Whether to mint the tokens before sending (only during testing).
+     */
+    bridgeTokensPublic(to: AztecAddress, amount: bigint, mint?: boolean): Promise<L2AmountClaim>;
+    /**
+     * Creates a new instance
+     * @param pxe - PXE client used for retrieving the L1 contract addresses.
+     * @param publicClient - L1 public client.
+     * @param walletClient - L1 wallet client.
+     * @param logger - Logger.
+     */
+    static new(pxe: PXE, publicClient: ViemPublicClient, walletClient: ViemWalletClient, logger: Logger): Promise<L1FeeJuicePortalManager>;
+}
+/** Helper for interacting with a test TokenPortal on L1 for sending tokens to L2. */
+export declare class L1ToL2TokenPortalManager {
+    protected publicClient: ViemPublicClient;
+    protected walletClient: ViemWalletClient;
+    protected logger: Logger;
+    protected readonly portal: GetContractReturnType<typeof TokenPortalAbi, ViemWalletClient>;
+    protected readonly tokenManager: L1TokenManager;
+    constructor(portalAddress: EthAddress, tokenAddress: EthAddress, publicClient: ViemPublicClient, walletClient: ViemWalletClient, logger: Logger);
+    /** Returns the token manager for the underlying L1 token. */
+    getTokenManager(): L1TokenManager;
+    /**
+     * Bridges tokens from L1 to L2. Handles token approvals. Returns once the tx has been mined.
+     * @param to - Address to send the tokens to on L2.
+     * @param amount - Amount of tokens to send.
+     * @param mint - Whether to mint the tokens before sending (only during testing).
+     */
+    bridgeTokensPublic(to: AztecAddress, amount: bigint, mint?: boolean): Promise<L2AmountClaim>;
+    /**
+     * Bridges tokens from L1 to L2 privately. Handles token approvals. Returns once the tx has been mined.
+     * @param to - Address to send the tokens to on L2.
+     * @param amount - Amount of tokens to send.
+     * @param mint - Whether to mint the tokens before sending (only during testing).
+     */
+    bridgeTokensPrivate(to: AztecAddress, amount: bigint, mint?: boolean): Promise<L2AmountClaimWithRecipient>;
+    private bridgeSetup;
+}
+/** Helper for interacting with a test TokenPortal on L1 for both withdrawing from and bridging to L2. */
+export declare class L1TokenPortalManager extends L1ToL2TokenPortalManager {
+    private readonly outbox;
+    constructor(portalAddress: EthAddress, tokenAddress: EthAddress, outboxAddress: EthAddress, publicClient: ViemPublicClient, walletClient: ViemWalletClient, logger: Logger);
+    /**
+     * Withdraws funds from the portal by consuming an L2 to L1 message. Returns once the tx is mined on L1.
+     * @param amount - Amount to withdraw.
+     * @param recipient - Who will receive the funds.
+     * @param blockNumber - L2 block number of the message.
+     * @param messageIndex - Index of the message.
+     * @param siblingPath - Sibling path of the message.
+     */
+    withdrawFunds(amount: bigint, recipient: EthAddress, blockNumber: bigint, messageIndex: bigint, siblingPath: SiblingPath<number>): Promise<void>;
+    /**
+     * Computes the L2 to L1 message leaf for the given parameters.
+     * @param amount - Amount to bridge.
+     * @param recipient - Recipient on L1.
+     * @param l2Bridge - Address of the L2 bridge.
+     * @param callerOnL1 - Caller address on L1.
+     */
+    getL2ToL1MessageLeaf(amount: bigint, recipient: EthAddress, l2Bridge: AztecAddress, callerOnL1?: EthAddress): Fr;
+}
+//# sourceMappingURL=portal_manager.d.ts.map

package/dest/api/ethereum/portal_manager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"portal_manager.d.ts","sourceRoot":"","sources":["../../../src/api/ethereum/portal_manager.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAG1E,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAA8C,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACjG,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAE3D,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,GAAG,EAAmC,MAAM,MAAM,CAAC;AAI7F,+CAA+C;AAC/C,MAAM,MAAM,OAAO,GAAG;IACpB,2BAA2B;IAC3B,WAAW,EAAE,EAAE,CAAC;IAChB,uCAAuC;IACvC,eAAe,EAAE,EAAE,CAAC;IACpB,2BAA2B;IAC3B,WAAW,EAAE,GAAG,CAAC;IACjB,+CAA+C;IAC/C,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAGF,oEAAoE;AACpE,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG;IAAyB,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAGrF,8FAA8F;AAC9F,MAAM,MAAM,0BAA0B,GAAG,aAAa,GAAG;IACvD,wDAAwD,CAAC,SAAS,EAAE,YAAY,CAAC;CAClF,CAAC;AAOF,8CAA8C;AAC9C,wBAAsB,mBAAmB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAK5E;AAED,0CAA0C;AAC1C,qBAAa,cAAc;IAIvB,qCAAqC;aACrB,OAAO,EAAE,UAAU;IACnC,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,MAAM;IAPhB,OAAO,CAAC,QAAQ,CAA+D;;IAG7E,qCAAqC;IACrB,OAAO,EAAE,UAAU,EAC3B,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC9B,MAAM,EAAE,MAAM;IASxB;;;OAGG;IACU,iBAAiB,CAAC,OAAO,EAAE,GAAG;IAI3C;;;;;OAKG;IACU,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,CAAC,EAAE,MAAM;IAOpE;;;;;OAKG;IACU,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,SAAK;CAMpE;AAED,4DAA4D;AAC5D,qBAAa,uBAAuB;IAOhC,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IARzB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAiB;IAC9C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoE;gBAG3F,aAAa,EAAE,UAAU,EACzB,YAAY,EAAE,UAAU,EACP,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC9B,MAAM,EAAE,MAAM;IAUjC,6DAA6D;IACtD,eAAe;IAItB;;;;;OAKG;IACU,kBAAkB,CAAC,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAwCvG;;;;;;OAMG;WACiB,GAAG,CACrB,GAAG,EAAE,GAAG,EACR,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC9B,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,uBAAuB,CAAC;CAWpC;AAED,qFAAqF;AACrF,qBAAa,wBAAwB;IAOjC,SAAS,CAAC,YAAY,EAAE,gBAAgB;IACxC,SAAS,CAAC,YAAY,EAAE,gBAAgB;IACxC,SAAS,CAAC,MAAM,EAAE,MAAM;IAR1B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,qBAAqB,CAAC,OAAO,cAAc,EAAE,gBAAgB,CAAC,CAAC;IAC1F,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAC;gBAG9C,aAAa,EAAE,UAAU,EACzB,YAAY,EAAE,UAAU,EACd,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC9B,MAAM,EAAE,MAAM;IAU1B,6DAA6D;IACtD,eAAe;IAItB;;;;;OAKG;IACU,kBAAkB,CAAC,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,UAAQ,GAAG,OAAO,CAAC,aAAa,CAAC;IAmCvG;;;;;OAKG;IACU,mBAAmB,CAC9B,EAAE,EAAE,YAAY,EAChB,MAAM,EAAE,MAAM,EACd,IAAI,UAAQ,GACX,OAAO,CAAC,0BAA0B,CAAC;YAiCxB,WAAW;CAO1B;AAED,yGAAyG;AACzG,qBAAa,oBAAqB,SAAQ,wBAAwB;IAChE,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA4D;gBAGjF,aAAa,EAAE,UAAU,EACzB,YAAY,EAAE,UAAU,EACxB,aAAa,EAAE,UAAU,EACzB,YAAY,EAAE,gBAAgB,EAC9B,YAAY,EAAE,gBAAgB,EAC9B,MAAM,EAAE,MAAM;IAUhB;;;;;;;OAOG;IACU,aAAa,CACxB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,UAAU,EACrB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,WAAW,EAAE,WAAW,CAAC,MAAM,CAAC;IA6BlC;;;;;;OAMG;IACI,oBAAoB,CACzB,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,UAAU,EACrB,QAAQ,EAAE,YAAY,EACtB,UAAU,GAAE,UAA4B,GACvC,EAAE;CAiBN"}

package/dest/api/ethereum/portal_manager.js

@@ -0,0 +1,286 @@
+import { extractEvent } from '@aztec/ethereum/utils';
+import { sha256ToField } from '@aztec/foundation/crypto';
+import { EthAddress } from '@aztec/foundation/eth-address';
+import { Fr } from '@aztec/foundation/fields';
+import { FeeJuicePortalAbi, OutboxAbi, TestERC20Abi, TokenPortalAbi } from '@aztec/l1-artifacts';
+import { computeSecretHash } from '@aztec/stdlib/hash';
+import { getContract, toFunctionSelector } from 'viem';
+/** Stringifies an eth address for logging. */ function stringifyEthAddress(address, name) {
+    return name ? `${name} (${address.toString()})` : address.toString();
+}
+/** Generates a pair secret and secret hash */ export async function generateClaimSecret(logger) {
+    const secret = Fr.random();
+    const secretHash = await computeSecretHash(secret);
+    logger?.verbose(`Generated claim secret=${secret.toString()} hash=${secretHash.toString()}`);
+    return [
+        secret,
+        secretHash
+    ];
+}
+/** Helper for managing an ERC20 on L1. */ export class L1TokenManager {
+    address;
+    publicClient;
+    walletClient;
+    logger;
+    contract;
+    constructor(/** Address of the ERC20 contract. */ address, publicClient, walletClient, logger){
+        this.address = address;
+        this.publicClient = publicClient;
+        this.walletClient = walletClient;
+        this.logger = logger;
+        this.contract = getContract({
+            address: this.address.toString(),
+            abi: TestERC20Abi,
+            client: this.walletClient
+        });
+    }
+    /**
+   * Returns the balance of the given address.
+   * @param address - Address to get the balance of.
+   */ async getL1TokenBalance(address) {
+        return await this.contract.read.balanceOf([
+            address
+        ]);
+    }
+    /**
+   * Mints tokens for the given address. Returns once the tx has been mined.
+   * @param amount - Amount to mint.
+   * @param address - Address to mint the tokens for.
+   * @param addressName - Optional name of the address for logging.
+   */ async mint(amount, address, addressName) {
+        this.logger.info(`Minting ${amount} tokens for ${stringifyEthAddress(address, addressName)}`);
+        await this.publicClient.waitForTransactionReceipt({
+            hash: await this.contract.write.mint([
+                address,
+                amount
+            ])
+        });
+    }
+    /**
+   * Approves tokens for the given address. Returns once the tx has been mined.
+   * @param amount - Amount to approve.
+   * @param address - Address to approve the tokens for.
+   * @param addressName - Optional name of the address for logging.
+   */ async approve(amount, address, addressName = '') {
+        this.logger.info(`Approving ${amount} tokens for ${stringifyEthAddress(address, addressName)}`);
+        await this.publicClient.waitForTransactionReceipt({
+            hash: await this.contract.write.approve([
+                address,
+                amount
+            ])
+        });
+    }
+}
+/** Helper for interacting with the FeeJuicePortal on L1. */ export class L1FeeJuicePortalManager {
+    publicClient;
+    walletClient;
+    logger;
+    tokenManager;
+    contract;
+    constructor(portalAddress, tokenAddress, publicClient, walletClient, logger){
+        this.publicClient = publicClient;
+        this.walletClient = walletClient;
+        this.logger = logger;
+        this.tokenManager = new L1TokenManager(tokenAddress, publicClient, walletClient, logger);
+        this.contract = getContract({
+            address: portalAddress.toString(),
+            abi: FeeJuicePortalAbi,
+            client: this.walletClient
+        });
+    }
+    /** Returns the associated token manager for the L1 ERC20. */ getTokenManager() {
+        return this.tokenManager;
+    }
+    /**
+   * Bridges fee juice from L1 to L2 publicly. Handles L1 ERC20 approvals. Returns once the tx has been mined.
+   * @param to - Address to send the tokens to on L2.
+   * @param amount - Amount of tokens to send.
+   * @param mint - Whether to mint the tokens before sending (only during testing).
+   */ async bridgeTokensPublic(to, amount, mint = false) {
+        const [claimSecret, claimSecretHash] = await generateClaimSecret();
+        if (mint) {
+            await this.tokenManager.mint(amount, this.walletClient.account.address);
+        }
+        await this.tokenManager.approve(amount, this.contract.address, 'FeeJuice Portal');
+        this.logger.info('Sending L1 Fee Juice to L2 to be claimed publicly');
+        const args = [
+            to.toString(),
+            amount,
+            claimSecretHash.toString()
+        ];
+        await this.contract.simulate.depositToAztecPublic(args);
+        const txReceipt = await this.publicClient.waitForTransactionReceipt({
+            hash: await this.contract.write.depositToAztecPublic(args)
+        });
+        this.logger.info('Deposited to Aztec public successfully');
+        const log = extractEvent(txReceipt.logs, this.contract.address, this.contract.abi, 'DepositToAztecPublic', (log)=>log.args.secretHash === claimSecretHash.toString() && log.args.amount === amount && log.args.to === to.toString(), this.logger);
+        return {
+            claimAmount: amount,
+            claimSecret,
+            claimSecretHash,
+            messageHash: log.args.key,
+            messageLeafIndex: log.args.index
+        };
+    }
+    /**
+   * Creates a new instance
+   * @param pxe - PXE client used for retrieving the L1 contract addresses.
+   * @param publicClient - L1 public client.
+   * @param walletClient - L1 wallet client.
+   * @param logger - Logger.
+   */ static async new(pxe, publicClient, walletClient, logger) {
+        const { l1ContractAddresses: { feeJuiceAddress, feeJuicePortalAddress } } = await pxe.getNodeInfo();
+        if (feeJuiceAddress.isZero() || feeJuicePortalAddress.isZero()) {
+            throw new Error('Portal or token not deployed on L1');
+        }
+        return new L1FeeJuicePortalManager(feeJuicePortalAddress, feeJuiceAddress, publicClient, walletClient, logger);
+    }
+}
+/** Helper for interacting with a test TokenPortal on L1 for sending tokens to L2. */ export class L1ToL2TokenPortalManager {
+    publicClient;
+    walletClient;
+    logger;
+    portal;
+    tokenManager;
+    constructor(portalAddress, tokenAddress, publicClient, walletClient, logger){
+        this.publicClient = publicClient;
+        this.walletClient = walletClient;
+        this.logger = logger;
+        this.tokenManager = new L1TokenManager(tokenAddress, publicClient, walletClient, logger);
+        this.portal = getContract({
+            address: portalAddress.toString(),
+            abi: TokenPortalAbi,
+            client: this.walletClient
+        });
+    }
+    /** Returns the token manager for the underlying L1 token. */ getTokenManager() {
+        return this.tokenManager;
+    }
+    /**
+   * Bridges tokens from L1 to L2. Handles token approvals. Returns once the tx has been mined.
+   * @param to - Address to send the tokens to on L2.
+   * @param amount - Amount of tokens to send.
+   * @param mint - Whether to mint the tokens before sending (only during testing).
+   */ async bridgeTokensPublic(to, amount, mint = false) {
+        const [claimSecret, claimSecretHash] = await this.bridgeSetup(amount, mint);
+        this.logger.info('Sending L1 tokens to L2 to be claimed publicly');
+        const { request } = await this.portal.simulate.depositToAztecPublic([
+            to.toString(),
+            amount,
+            claimSecretHash.toString()
+        ]);
+        const txReceipt = await this.publicClient.waitForTransactionReceipt({
+            hash: await this.walletClient.writeContract(request)
+        });
+        const log = extractEvent(txReceipt.logs, this.portal.address, this.portal.abi, 'DepositToAztecPublic', (log)=>log.args.secretHash === claimSecretHash.toString() && log.args.amount === amount && log.args.to === to.toString(), this.logger);
+        return {
+            claimAmount: amount,
+            claimSecret,
+            claimSecretHash,
+            messageHash: log.args.key,
+            messageLeafIndex: log.args.index
+        };
+    }
+    /**
+   * Bridges tokens from L1 to L2 privately. Handles token approvals. Returns once the tx has been mined.
+   * @param to - Address to send the tokens to on L2.
+   * @param amount - Amount of tokens to send.
+   * @param mint - Whether to mint the tokens before sending (only during testing).
+   */ async bridgeTokensPrivate(to, amount, mint = false) {
+        const [claimSecret, claimSecretHash] = await this.bridgeSetup(amount, mint);
+        this.logger.info('Sending L1 tokens to L2 to be claimed privately');
+        const { request } = await this.portal.simulate.depositToAztecPrivate([
+            amount,
+            claimSecretHash.toString()
+        ]);
+        const txReceipt = await this.publicClient.waitForTransactionReceipt({
+            hash: await this.walletClient.writeContract(request)
+        });
+        const log = extractEvent(txReceipt.logs, this.portal.address, this.portal.abi, 'DepositToAztecPrivate', (log)=>log.args.amount === amount && log.args.secretHashForL2MessageConsumption === claimSecretHash.toString(), this.logger);
+        this.logger.info(`Claim message secret: ${claimSecret.toString()}, claim message secret hash: ${claimSecretHash.toString()}`);
+        return {
+            claimAmount: amount,
+            claimSecret,
+            claimSecretHash,
+            recipient: to,
+            messageHash: log.args.key,
+            messageLeafIndex: log.args.index
+        };
+    }
+    async bridgeSetup(amount, mint) {
+        if (mint) {
+            await this.tokenManager.mint(amount, this.walletClient.account.address);
+        }
+        await this.tokenManager.approve(amount, this.portal.address, 'TokenPortal');
+        return generateClaimSecret();
+    }
+}
+/** Helper for interacting with a test TokenPortal on L1 for both withdrawing from and bridging to L2. */ export class L1TokenPortalManager extends L1ToL2TokenPortalManager {
+    outbox;
+    constructor(portalAddress, tokenAddress, outboxAddress, publicClient, walletClient, logger){
+        super(portalAddress, tokenAddress, publicClient, walletClient, logger);
+        this.outbox = getContract({
+            address: outboxAddress.toString(),
+            abi: OutboxAbi,
+            client: walletClient
+        });
+    }
+    /**
+   * Withdraws funds from the portal by consuming an L2 to L1 message. Returns once the tx is mined on L1.
+   * @param amount - Amount to withdraw.
+   * @param recipient - Who will receive the funds.
+   * @param blockNumber - L2 block number of the message.
+   * @param messageIndex - Index of the message.
+   * @param siblingPath - Sibling path of the message.
+   */ async withdrawFunds(amount, recipient, blockNumber, messageIndex, siblingPath) {
+        this.logger.info(`Sending L1 tx to consume message at block ${blockNumber} index ${messageIndex} to withdraw ${amount}`);
+        const isConsumedBefore = await this.outbox.read.hasMessageBeenConsumedAtBlockAndIndex([
+            blockNumber,
+            messageIndex
+        ]);
+        if (isConsumedBefore) {
+            throw new Error(`L1 to L2 message at block ${blockNumber} index ${messageIndex} has already been consumed`);
+        }
+        // Call function on L1 contract to consume the message
+        const { request: withdrawRequest } = await this.portal.simulate.withdraw([
+            recipient.toString(),
+            amount,
+            false,
+            BigInt(blockNumber),
+            messageIndex,
+            siblingPath.toBufferArray().map((buf)=>`0x${buf.toString('hex')}`)
+        ]);
+        await this.publicClient.waitForTransactionReceipt({
+            hash: await this.walletClient.writeContract(withdrawRequest)
+        });
+        const isConsumedAfter = await this.outbox.read.hasMessageBeenConsumedAtBlockAndIndex([
+            blockNumber,
+            messageIndex
+        ]);
+        if (!isConsumedAfter) {
+            throw new Error(`L1 to L2 message at block ${blockNumber} index ${messageIndex} not consumed after withdrawal`);
+        }
+    }
+    /**
+   * Computes the L2 to L1 message leaf for the given parameters.
+   * @param amount - Amount to bridge.
+   * @param recipient - Recipient on L1.
+   * @param l2Bridge - Address of the L2 bridge.
+   * @param callerOnL1 - Caller address on L1.
+   */ getL2ToL1MessageLeaf(amount, recipient, l2Bridge, callerOnL1 = EthAddress.ZERO) {
+        const content = sha256ToField([
+            Buffer.from(toFunctionSelector('withdraw(address,uint256,address)').substring(2), 'hex'),
+            recipient.toBuffer32(),
+            new Fr(amount).toBuffer(),
+            callerOnL1.toBuffer32()
+        ]);
+        const leaf = sha256ToField([
+            l2Bridge.toBuffer(),
+            new Fr(1).toBuffer(),
+            EthAddress.fromString(this.portal.address).toBuffer32() ?? Buffer.alloc(32, 0),
+            new Fr(this.publicClient.chain.id).toBuffer(),
+            content.toBuffer()
+        ]);
+        return leaf;
+    }
+}

package/dest/api/fee.d.ts

@@ -0,0 +1,6 @@
+export type { FeePaymentMethod } from '../fee/fee_payment_method.js';
+export { FeeJuicePaymentMethod } from '../fee/fee_juice_payment_method.js';
+export { PrivateFeePaymentMethod } from '../fee/private_fee_payment_method.js';
+export { PublicFeePaymentMethod } from '../fee/public_fee_payment_method.js';
+export { FeeJuicePaymentMethodWithClaim } from '../fee/fee_juice_payment_method_with_claim.js';
+//# sourceMappingURL=fee.d.ts.map

package/dest/api/fee.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fee.d.ts","sourceRoot":"","sources":["../../src/api/fee.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAC7E,OAAO,EAAE,8BAA8B,EAAE,MAAM,+CAA+C,CAAC"}

package/dest/api/fee.js

@@ -0,0 +1,4 @@
+export { FeeJuicePaymentMethod } from '../fee/fee_juice_payment_method.js';
+export { PrivateFeePaymentMethod } from '../fee/private_fee_payment_method.js';
+export { PublicFeePaymentMethod } from '../fee/public_fee_payment_method.js';
+export { FeeJuicePaymentMethodWithClaim } from '../fee/fee_juice_payment_method_with_claim.js';

package/dest/api/fields.d.ts

@@ -0,0 +1,2 @@
+export { Point, Fr, Fq, GrumpkinScalar } from '@aztec/foundation/fields';
+//# sourceMappingURL=fields.d.ts.map

package/dest/api/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../src/api/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC"}

package/dest/api/fields.js

@@ -0,0 +1 @@
+export { Point, Fr, Fq, GrumpkinScalar } from '@aztec/foundation/fields';

package/dest/api/interfaces/pxe.d.ts

@@ -0,0 +1,2 @@
+export type { PXE } from '@aztec/stdlib/interfaces/client';
+//# sourceMappingURL=pxe.d.ts.map

package/dest/api/interfaces/pxe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pxe.d.ts","sourceRoot":"","sources":["../../../src/api/interfaces/pxe.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC"}

package/dest/api/interfaces/pxe.js

@@ -0,0 +1 @@
+export { };

package/dest/api/log.d.ts

@@ -0,0 +1,2 @@
+export { createLogger, type Logger } from '@aztec/foundation/log';
+//# sourceMappingURL=log.d.ts.map

package/dest/api/log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.d.ts","sourceRoot":"","sources":["../../src/api/log.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC"}

package/dest/api/log.js

@@ -0,0 +1 @@
+export { createLogger } from '@aztec/foundation/log';

package/dest/api/log_id.d.ts

@@ -0,0 +1,2 @@
+export { LogId } from '@aztec/stdlib/logs';
+//# sourceMappingURL=log_id.d.ts.map

package/dest/api/log_id.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"log_id.d.ts","sourceRoot":"","sources":["../../src/api/log_id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC"}

package/dest/api/log_id.js

@@ -0,0 +1 @@
+export { LogId } from '@aztec/stdlib/logs';

package/dest/api/tx_hash.d.ts

@@ -0,0 +1,2 @@
+export { TxHash } from '@aztec/stdlib/tx';
+//# sourceMappingURL=tx_hash.d.ts.map

package/dest/api/tx_hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tx_hash.d.ts","sourceRoot":"","sources":["../../src/api/tx_hash.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC"}

package/dest/api/tx_hash.js

@@ -0,0 +1 @@
+export { TxHash } from '@aztec/stdlib/tx';

package/dest/api/wallet.d.ts

@@ -0,0 +1,2 @@
+export { AccountWallet, AccountWalletWithSecretKey as AccountWalletWithSecretKey, SignerlessWallet, type Wallet, getWallet, } from '../wallet/index.js';
+//# sourceMappingURL=wallet.d.ts.map

package/dest/api/wallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../src/api/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,0BAA0B,IAAI,0BAA0B,EACxD,gBAAgB,EAChB,KAAK,MAAM,EACX,SAAS,GACV,MAAM,oBAAoB,CAAC"}

package/dest/api/wallet.js

@@ -0,0 +1 @@
+export { AccountWallet, AccountWalletWithSecretKey as AccountWalletWithSecretKey, SignerlessWallet, getWallet } from '../wallet/index.js';

package/dest/contract/base_contract_interaction.d.ts

@@ -0,0 +1,98 @@
+import type { Fr } from '@aztec/foundation/fields';
+import { GasSettings } from '@aztec/stdlib/gas';
+import type { Capsule, TxExecutionRequest, TxProvingResult } from '@aztec/stdlib/tx';
+import type { Wallet } from '../account/wallet.js';
+import type { ExecutionRequestInit } from '../entrypoint/entrypoint.js';
+import type { FeeOptions, UserFeeOptions } from '../entrypoint/payload.js';
+import { ProvenTx } from './proven_tx.js';
+import { SentTx } from './sent_tx.js';
+/**
+ * Represents options for calling a (constrained) function in a contract.
+ * Allows the user to specify the sender address and nonce for a transaction.
+ */
+export type SendMethodOptions = {
+    /** Wether to skip the simulation of the public part of the transaction. */
+    skipPublicSimulation?: boolean;
+    /** The fee options for the transaction. */
+    fee?: UserFeeOptions;
+    /** Custom nonce to inject into the app payload of the transaction. Useful when trying to cancel an ongoing transaction by creating a new one with a higher fee */
+    nonce?: Fr;
+    /** Whether the transaction can be cancelled. If true, an extra nullifier will be emitted: H(nonce, GENERATOR_INDEX__TX_NULLIFIER) */
+    cancellable?: boolean;
+};
+/**
+ * Base class for an interaction with a contract, be it a deployment, a function call, or a batch.
+ * Implements the sequence create/simulate/send.
+ */
+export declare abstract class BaseContractInteraction {
+    protected wallet: Wallet;
+    protected log: import("@aztec/foundation/log").Logger;
+    private capsules;
+    constructor(wallet: Wallet);
+    /**
+     * Create a transaction execution request ready to be simulated.
+     * @param options - An optional object containing additional configuration for the transaction.
+     * @returns A transaction execution request.
+     */
+    abstract create(options?: SendMethodOptions): Promise<TxExecutionRequest>;
+    /**
+     * Creates a transaction execution request, simulates and proves it. Differs from .prove in
+     * that its result does not include the wallet nor the composed tx object, but only the proving result.
+     * This object can then be used to either create a ProvenTx ready to be sent, or directly send the transaction.
+     * @param options - optional arguments to be used in the creation of the transaction
+     * @returns The proving result.
+     */
+    protected proveInternal(options?: SendMethodOptions): Promise<TxProvingResult>;
+    /**
+     * Proves a transaction execution request and returns a tx object ready to be sent.
+     * @param options - optional arguments to be used in the creation of the transaction
+     * @returns The resulting transaction
+     */
+    prove(options?: SendMethodOptions): Promise<ProvenTx>;
+    /**
+     * Sends a transaction to the contract function with the specified options.
+     * This function throws an error if called on an unconstrained function.
+     * It creates and signs the transaction if necessary, and returns a SentTx instance,
+     * which can be used to track the transaction status, receipt, and events.
+     * @param options - An optional object containing 'from' property representing
+     * the AztecAddress of the sender. If not provided, the default address is used.
+     * @returns A SentTx instance for tracking the transaction status and information.
+     */
+    send(options?: SendMethodOptions): SentTx;
+    /**
+     * Estimates gas for a given tx request and returns gas limits for it.
+     * @param opts - Options.
+     * @param pad - Percentage to pad the suggested gas limits by, if empty, defaults to 10%.
+     * @returns Gas limits.
+     */
+    estimateGas(opts?: Omit<SendMethodOptions, 'estimateGas' | 'skipPublicSimulation'>): Promise<Pick<GasSettings, 'gasLimits' | 'teardownGasLimits'>>;
+    /**
+     * Returns default fee options based on the user opts without running a simulation for gas estimation.
+     * @param fee - User-provided fee options.
+     */
+    protected getDefaultFeeOptions(fee: UserFeeOptions | undefined): Promise<FeeOptions>;
+    /**
+     * Return fee options based on the user opts, estimating tx gas if needed.
+     * @param request - Request to execute for this interaction.
+     * @param pad - Percentage to pad the suggested gas limits by, as decimal (e.g., 0.10 for 10%).
+     * @returns Fee options for the actual transaction.
+     */
+    protected getFeeOptions(request: Omit<ExecutionRequestInit, 'fee'> & {
+        fee?: UserFeeOptions;
+    }): Promise<FeeOptions>;
+    /**
+     * Add data passed to the oracle calls during this contract interaction.
+     * @param capsule - Data passed to oracle calls.
+     */
+    addCapsule(capsule: Capsule): void;
+    /**
+     * Add data passed to the oracle calls during this contract interaction.
+     * @param capsules - Data passed to oracle calls.
+     */
+    addCapsules(capsules: Capsule[]): void;
+    /**
+     * Return all capsules added for this function interaction.
+     */
+    getCapsules(): Capsule[];
+}
+//# sourceMappingURL=base_contract_interaction.d.ts.map

package/dest/contract/base_contract_interaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base_contract_interaction.d.ts","sourceRoot":"","sources":["../../src/contract/base_contract_interaction.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAErF,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG3E,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAEtC;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,2EAA2E;IAC3E,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,2CAA2C;IAC3C,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB,kKAAkK;IAClK,KAAK,CAAC,EAAE,EAAE,CAAC;IACX,qIAAqI;IACrI,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF;;;GAGG;AACH,8BAAsB,uBAAuB;IAK/B,SAAS,CAAC,MAAM,EAAE,MAAM;IAJpC,SAAS,CAAC,GAAG,yCAAgD;IAE7D,OAAO,CAAC,QAAQ,CAAiB;gBAEX,MAAM,EAAE,MAAM;IAEpC;;;;OAIG;aACa,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAEhF;;;;;;OAMG;cACa,aAAa,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAOxF;;;;OAIG;IACU,KAAK,CAAC,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAOtE;;;;;;;;OAQG;IACI,IAAI,CAAC,OAAO,GAAE,iBAAsB,GAAG,MAAM;IAUpD;;;;;OAKG;IACU,WAAW,CACtB,IAAI,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,aAAa,GAAG,sBAAsB,CAAC,GACrE,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,mBAAmB,CAAC,CAAC;IAiBhE;;;OAGG;cACa,oBAAoB,CAAC,GAAG,EAAE,cAAc,GAAG,SAAS,GAAG,OAAO,CAAC,UAAU,CAAC;IAU1F;;;;;OAKG;cACa,aAAa,CAC3B,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,KAAK,CAAC,GAAG;QAAmC,GAAG,CAAC,EAAE,cAAc,CAAA;KAAE,GACrG,OAAO,CAAC,UAAU,CAAC;IA+BtB;;;OAGG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO;IAIlC;;;OAGG;IACI,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE;IAItC;;OAEG;IACI,WAAW;CAGnB"}