@aztec/cli 0.0.0-test.0

package/dest/cmds/pxe/get_node_info.js

@@ -0,0 +1,61 @@
+import { createAztecNodeClient, createCompatibleClient } from '@aztec/aztec.js';
+export async function getNodeInfo(rpcUrl, pxeRequest, debugLogger, json, log, logJson) {
+    let client;
+    if (pxeRequest) {
+        client = await createCompatibleClient(rpcUrl, debugLogger);
+    } else {
+        client = createAztecNodeClient(rpcUrl);
+    }
+    const info = await client.getNodeInfo();
+    if (json) {
+        logJson({
+            nodeVersion: info.nodeVersion,
+            l1ChainId: info.l1ChainId,
+            protocolVersion: info.protocolVersion,
+            enr: info.enr,
+            l1ContractAddresses: {
+                rollup: info.l1ContractAddresses.rollupAddress.toString(),
+                registry: info.l1ContractAddresses.registryAddress.toString(),
+                inbox: info.l1ContractAddresses.inboxAddress.toString(),
+                outbox: info.l1ContractAddresses.outboxAddress.toString(),
+                feeJuice: info.l1ContractAddresses.feeJuiceAddress.toString(),
+                stakingAsset: info.l1ContractAddresses.stakingAssetAddress.toString(),
+                feeJuicePortal: info.l1ContractAddresses.feeJuicePortalAddress.toString(),
+                coinIssuer: info.l1ContractAddresses.coinIssuerAddress.toString(),
+                rewardDistributor: info.l1ContractAddresses.rewardDistributorAddress.toString(),
+                governanceProposer: info.l1ContractAddresses.governanceProposerAddress.toString(),
+                governance: info.l1ContractAddresses.governanceAddress.toString(),
+                slashFactory: info.l1ContractAddresses.slashFactoryAddress?.toString()
+            },
+            protocolContractAddresses: {
+                classRegisterer: info.protocolContractAddresses.classRegisterer.toString(),
+                feeJuice: info.protocolContractAddresses.feeJuice.toString(),
+                instanceDeployer: info.protocolContractAddresses.instanceDeployer.toString(),
+                multiCallEntrypoint: info.protocolContractAddresses.multiCallEntrypoint.toString()
+            }
+        });
+    } else {
+        log(`Node Version: ${info.nodeVersion}`);
+        log(`Chain Id: ${info.l1ChainId}`);
+        log(`Protocol Version: ${info.protocolVersion}`);
+        log(`Node ENR: ${info.enr}`);
+        log(`L1 Contract Addresses:`);
+        log(` Rollup Address: ${info.l1ContractAddresses.rollupAddress.toString()}`);
+        log(` Registry Address: ${info.l1ContractAddresses.registryAddress.toString()}`);
+        log(` L1 -> L2 Inbox Address: ${info.l1ContractAddresses.inboxAddress.toString()}`);
+        log(` L2 -> L1 Outbox Address: ${info.l1ContractAddresses.outboxAddress.toString()}`);
+        log(` Fee Juice Address: ${info.l1ContractAddresses.feeJuiceAddress.toString()}`);
+        log(` Staking Asset Address: ${info.l1ContractAddresses.stakingAssetAddress.toString()}`);
+        log(` Fee Juice Portal Address: ${info.l1ContractAddresses.feeJuicePortalAddress.toString()}`);
+        log(` CoinIssuer Address: ${info.l1ContractAddresses.coinIssuerAddress.toString()}`);
+        log(` RewardDistributor Address: ${info.l1ContractAddresses.rewardDistributorAddress.toString()}`);
+        log(` GovernanceProposer Address: ${info.l1ContractAddresses.governanceProposerAddress.toString()}`);
+        log(` Governance Address: ${info.l1ContractAddresses.governanceAddress.toString()}`);
+        log(` SlashFactory Address: ${info.l1ContractAddresses.slashFactoryAddress?.toString()}`);
+        log(`L2 Contract Addresses:`);
+        log(` Class Registerer: ${info.protocolContractAddresses.classRegisterer.toString()}`);
+        log(` Fee Juice: ${info.protocolContractAddresses.feeJuice.toString()}`);
+        log(` Instance Deployer: ${info.protocolContractAddresses.instanceDeployer.toString()}`);
+        log(` MultiCall: ${info.protocolContractAddresses.multiCallEntrypoint.toString()}`);
+    }
+}

package/dest/cmds/pxe/get_pxe_info.d.ts

@@ -0,0 +1,3 @@
+import type { LogFn, Logger } from '@aztec/foundation/log';
+export declare function getPXEInfo(rpcUrl: string, debugLogger: Logger, log: LogFn): Promise<void>;
+//# sourceMappingURL=get_pxe_info.d.ts.map

package/dest/cmds/pxe/get_pxe_info.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get_pxe_info.d.ts","sourceRoot":"","sources":["../../../src/cmds/pxe/get_pxe_info.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,wBAAsB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,iBAS/E"}

package/dest/cmds/pxe/get_pxe_info.js

@@ -0,0 +1,11 @@
+import { createCompatibleClient } from '@aztec/aztec.js';
+export async function getPXEInfo(rpcUrl, debugLogger, log) {
+    const client = await createCompatibleClient(rpcUrl, debugLogger);
+    const info = await client.getPXEInfo();
+    log(`PXE Version: ${info.pxeVersion}`);
+    log(`Protocol Contract Addresses:`);
+    log(` Class Registerer: ${info.protocolContractAddresses.classRegisterer.toString()}`);
+    log(` Fee Juice: ${info.protocolContractAddresses.feeJuice.toString()}`);
+    log(` Instance Deployer: ${info.protocolContractAddresses.instanceDeployer.toString()}`);
+    log(` Multi Call Entrypoint: ${info.protocolContractAddresses.multiCallEntrypoint.toString()}`);
+}

package/dest/cmds/pxe/index.d.ts

@@ -0,0 +1,4 @@
+import type { LogFn, Logger } from '@aztec/foundation/log';
+import type { Command } from 'commander';
+export declare function injectCommands(program: Command, log: LogFn, debugLogger: Logger): Command;
+//# sourceMappingURL=index.d.ts.map

package/dest/cmds/pxe/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cmds/pxe/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAiBzC,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,WAqJ/E"}

package/dest/cmds/pxe/index.js

@@ -0,0 +1,55 @@
+import { Fr } from '@aztec/foundation/fields';
+import { logJson, makePxeOption, parseAztecAddress, parseEthereumAddress, parseField, parseFieldFromHexString, parseOptionalAztecAddress, parseOptionalInteger, parseOptionalLogId, parseOptionalTxHash, parsePublicKey, pxeOption } from '../../utils/commands.js';
+export function injectCommands(program, log, debugLogger) {
+    program.command('add-contract').description('Adds an existing contract to the PXE. This is useful if you have deployed a contract outside of the PXE and want to use it with the PXE.').requiredOption('-c, --contract-artifact <fileLocation>', "A compiled Aztec.nr contract's ABI in JSON format or name of a contract ABI exported by @aztec/noir-contracts.js").requiredOption('-ca, --contract-address <address>', 'Aztec address of the contract.', parseAztecAddress).requiredOption('--init-hash <init hash>', 'Initialization hash', parseFieldFromHexString).option('--salt <salt>', 'Optional deployment salt', parseFieldFromHexString).option('-p, --public-key <public key>', 'Optional public key for this contract', parsePublicKey).option('--portal-address <address>', 'Optional address to a portal contract on L1', parseEthereumAddress).option('--deployer-address <address>', 'Optional address of the contract deployer', parseAztecAddress).addOption(pxeOption).action(async (options)=>{
+        const { addContract } = await import('./add_contract.js');
+        await addContract(options.rpcUrl, options.contractArtifact, options.contractAddress, options.initHash, options.salt ?? Fr.ZERO, options.publicKey, options.deployerAddress, debugLogger, log);
+    });
+    program.command('get-block').description('Gets info for a given block or latest.').argument('[blockNumber]', 'Block height', parseOptionalInteger).addOption(pxeOption).action(async (blockNumber, options)=>{
+        const { getBlock } = await import('./get_block.js');
+        await getBlock(options.rpcUrl, blockNumber, debugLogger, log);
+    });
+    program.command('get-current-base-fee').description('Gets the current base fee.').addOption(pxeOption).action(async (options)=>{
+        const { getCurrentBaseFee } = await import('./get_current_base_fee.js');
+        await getCurrentBaseFee(options.rpcUrl, debugLogger, log);
+    });
+    program.command('get-contract-data').description('Gets information about the Aztec contract deployed at the specified address.').argument('<contractAddress>', 'Aztec address of the contract.', parseAztecAddress).addOption(pxeOption).option('-b, --include-bytecode <boolean>', "Include the contract's public function bytecode, if any.", false).action(async (contractAddress, options)=>{
+        const { getContractData } = await import('./get_contract_data.js');
+        await getContractData(options.rpcUrl, contractAddress, options.includeBytecode, debugLogger, log);
+    });
+    program.command('get-logs').description('Gets all the public logs from an intersection of all the filter params.').option('-tx, --tx-hash <txHash>', 'A transaction hash to get the receipt for.', parseOptionalTxHash).option('-fb, --from-block <blockNum>', 'Initial block number for getting logs (defaults to 1).', parseOptionalInteger).option('-tb, --to-block <blockNum>', 'Up to which block to fetch logs (defaults to latest).', parseOptionalInteger).option('-al --after-log <logId>', 'ID of a log after which to fetch the logs.', parseOptionalLogId).option('-ca, --contract-address <address>', 'Contract address to filter logs by.', parseOptionalAztecAddress).addOption(pxeOption).option('--follow', 'If set, will keep polling for new logs until interrupted.').action(async ({ txHash, fromBlock, toBlock, afterLog, contractAddress, rpcUrl, follow })=>{
+        const { getLogs } = await import('./get_logs.js');
+        await getLogs(txHash, fromBlock, toBlock, afterLog, contractAddress, rpcUrl, follow, debugLogger, log);
+    });
+    program.command('get-accounts').description('Gets all the Aztec accounts stored in the PXE.').addOption(pxeOption).option('--json', 'Emit output as json').action(async (options)=>{
+        const { getAccounts } = await import('./get_accounts.js');
+        await getAccounts(options.rpcUrl, options.json, debugLogger, log, logJson(log));
+    });
+    program.command('get-account').description('Gets an account given its Aztec address.').argument('<address>', 'The Aztec address to get account for', parseAztecAddress).addOption(pxeOption).action(async (address, options)=>{
+        const { getAccount } = await import('./get_account.js');
+        await getAccount(address, options.rpcUrl, debugLogger, log);
+    });
+    program.command('block-number').description('Gets the current Aztec L2 block number.').addOption(pxeOption).action(async (options)=>{
+        const { blockNumber } = await import('./block_number.js');
+        await blockNumber(options.rpcUrl, debugLogger, log);
+    });
+    program.command('get-l1-to-l2-message-witness').description('Gets a L1 to L2 message witness.').requiredOption('-ca, --contract-address <address>', 'Aztec address of the contract.', parseAztecAddress).requiredOption('--message-hash <messageHash>', 'The L1 to L2 message hash.', parseField).requiredOption('--secret <secret>', 'The secret used to claim the L1 to L2 message', parseField).addOption(pxeOption).action(async ({ contractAddress, messageHash, secret, rpcUrl })=>{
+        const { getL1ToL2MessageWitness } = await import('./get_l1_to_l2_message_witness.js');
+        await getL1ToL2MessageWitness(rpcUrl, contractAddress, messageHash, secret, debugLogger, log);
+    });
+    program.command('get-node-info').description('Gets the information of an Aztec node from a PXE or directly from an Aztec node.').option('--node-url <string>', 'URL of the node.').option('--json', 'Emit output as json').addOption(makePxeOption(false)).action(async (options)=>{
+        const { getNodeInfo } = await import('./get_node_info.js');
+        let url;
+        if (options.nodeUrl) {
+            url = options.nodeUrl;
+        } else {
+            url = options.rpcUrl;
+        }
+        await getNodeInfo(url, !options.nodeUrl, debugLogger, options.json, log, logJson(log));
+    });
+    program.command('get-pxe-info').description('Gets the information of a PXE at a URL.').addOption(pxeOption).action(async (options)=>{
+        const { getPXEInfo } = await import('./get_pxe_info.js');
+        await getPXEInfo(options.rpcUrl, debugLogger, log);
+    });
+    return program;
+}

package/dest/utils/aztec.d.ts

@@ -0,0 +1,68 @@
+import type { EthAddress, PXE } from '@aztec/aztec.js';
+import { type ContractArtifact, type FunctionArtifact } from '@aztec/aztec.js/abi';
+import type { DeployL1ContractsReturnType, L1ContractsConfig, RollupContract } from '@aztec/ethereum';
+import type { Fr } from '@aztec/foundation/fields';
+import type { LogFn, Logger } from '@aztec/foundation/log';
+import type { NoirPackageConfig } from '@aztec/foundation/noir';
+/**
+ * Helper to get an ABI function or throw error if it doesn't exist.
+ * @param artifact - Contract's build artifact in JSON format.
+ * @param fnName - Function name to be found.
+ * @returns The function's ABI.
+ */
+export declare function getFunctionArtifact(artifact: ContractArtifact, fnName: string): FunctionArtifact;
+/**
+ * Function to execute the 'deployRollupContracts' command.
+ * @param rpcUrls - The RPC URL of the ethereum node.
+ * @param chainId - The chain ID of the L1 host.
+ * @param privateKey - The private key to be used in contract deployment.
+ * @param mnemonic - The mnemonic to be used in contract deployment.
+ */
+export declare function deployAztecContracts(rpcUrls: string[], chainId: number, privateKey: string | undefined, mnemonic: string, mnemonicIndex: number, salt: number | undefined, initialValidators: EthAddress[], genesisArchiveRoot: Fr, genesisBlockHash: Fr, acceleratedTestDeployments: boolean, config: L1ContractsConfig, debugLogger: Logger): Promise<DeployL1ContractsReturnType>;
+export declare function deployNewRollupContracts(registryAddress: EthAddress, rpcUrls: string[], chainId: number, privateKey: string | undefined, mnemonic: string, mnemonicIndex: number, salt: number | undefined, initialValidators: EthAddress[], genesisArchiveRoot: Fr, genesisBlockHash: Fr, config: L1ContractsConfig, logger: Logger): Promise<{
+    payloadAddress: EthAddress;
+    rollup: RollupContract;
+}>;
+/**
+ * Gets all contracts available in \@aztec/noir-contracts.js.
+ * @returns The contract names.
+ */
+export declare function getExampleContractNames(): Promise<string[]>;
+/**
+ * Reads a file and converts it to an Aztec Contract ABI.
+ * @param fileDir - The directory of the compiled contract ABI.
+ * @returns The parsed contract artifact.
+ */
+export declare function getContractArtifact(fileDir: string, log: LogFn): Promise<ContractArtifact>;
+/**
+ * Performs necessary checks, conversions & operations to call a contract fn from the CLI.
+ * @param contractFile - Directory of the compiled contract ABI.
+ * @param functionName - Name of the function to be called.
+ * @param _functionArgs - Arguments to call the function with.
+ * @param log - Logger instance that will output to the CLI
+ * @returns Formatted contract address, function arguments and caller's aztec address.
+ */
+export declare function prepTx(contractFile: string, functionName: string, _functionArgs: string[], log: LogFn): Promise<{
+    functionArgs: any[];
+    contractArtifact: ContractArtifact;
+    isPrivate: boolean;
+}>;
+/**
+ * Removes the leading 0x from a hex string. If no leading 0x is found the string is returned unchanged.
+ * @param hex - A hex string
+ * @returns A new string with leading 0x removed
+ */
+export declare const stripLeadingHex: (hex: string) => string;
+/**
+ * Pretty prints Nargo.toml contents to a string
+ * @param config - Nargo.toml contents
+ * @returns The Nargo.toml contents as a string
+ */
+export declare function prettyPrintNargoToml(config: NoirPackageConfig): string;
+/**
+ * Checks that Private eXecution Environment (PXE) version matches the expected one by this CLI. Throws if not.
+ * @param pxe - PXE client.
+ * @param expectedVersionRange - Expected version by CLI.
+ */
+export declare function checkServerVersion(pxe: PXE, expectedVersionRange: string): Promise<void>;
+//# sourceMappingURL=aztec.d.ts.map

package/dest/utils/aztec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aztec.d.ts","sourceRoot":"","sources":["../../src/utils/aztec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,gBAAgB,EAAwB,MAAM,qBAAqB,CAAC;AACzG,OAAO,KAAK,EAAE,2BAA2B,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACtG,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAUhE;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,GAAG,gBAAgB,CAMhG;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,iBAAiB,EAAE,UAAU,EAAE,EAC/B,kBAAkB,EAAE,EAAE,EACtB,gBAAgB,EAAE,EAAE,EACpB,0BAA0B,EAAE,OAAO,EACnC,MAAM,EAAE,iBAAiB,EACzB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,2BAA2B,CAAC,CA6BtC;AAED,wBAAsB,wBAAwB,CAC5C,eAAe,EAAE,UAAU,EAC3B,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EACrB,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,iBAAiB,EAAE,UAAU,EAAE,EAC/B,kBAAkB,EAAE,EAAE,EACtB,gBAAgB,EAAE,EAAE,EACpB,MAAM,EAAE,iBAAiB,EACzB,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,cAAc,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,cAAc,CAAA;CAAE,CAAC,CA6BjE;AAED;;;GAGG;AACH,wBAAsB,uBAAuB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAKjE;AAED;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,6BA4BpE;AAED;;;;;;;GAOG;AACH,wBAAsB,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,KAAK;;;;GAO3G;AAED;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAS,MAAM,WAK1C,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,GAAG,MAAM,CAUtE;AAKD;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,oBAAoB,EAAE,MAAM,iBAyB9E"}

package/dest/utils/aztec.js

@@ -0,0 +1,174 @@
+import { loadContractArtifact } from '@aztec/aztec.js/abi';
+import { ProtocolContractAddress, protocolContractTreeRoot } from '@aztec/protocol-contracts';
+import { FunctionType } from '@aztec/stdlib/abi';
+import TOML from '@iarna/toml';
+import { readFile } from 'fs/promises';
+import { gtr, ltr, satisfies, valid } from 'semver';
+import { encodeArgs } from './encoding.js';
+/**
+ * Helper to get an ABI function or throw error if it doesn't exist.
+ * @param artifact - Contract's build artifact in JSON format.
+ * @param fnName - Function name to be found.
+ * @returns The function's ABI.
+ */ export function getFunctionArtifact(artifact, fnName) {
+    const fn = artifact.functions.find(({ name })=>name === fnName);
+    if (!fn) {
+        throw Error(`Function ${fnName} not found in contract ABI.`);
+    }
+    return fn;
+}
+/**
+ * Function to execute the 'deployRollupContracts' command.
+ * @param rpcUrls - The RPC URL of the ethereum node.
+ * @param chainId - The chain ID of the L1 host.
+ * @param privateKey - The private key to be used in contract deployment.
+ * @param mnemonic - The mnemonic to be used in contract deployment.
+ */ export async function deployAztecContracts(rpcUrls, chainId, privateKey, mnemonic, mnemonicIndex, salt, initialValidators, genesisArchiveRoot, genesisBlockHash, acceleratedTestDeployments, config, debugLogger) {
+    const { createEthereumChain, deployL1Contracts } = await import('@aztec/ethereum');
+    const { mnemonicToAccount, privateKeyToAccount } = await import('viem/accounts');
+    const account = !privateKey ? mnemonicToAccount(mnemonic, {
+        addressIndex: mnemonicIndex
+    }) : privateKeyToAccount(`${privateKey.startsWith('0x') ? '' : '0x'}${privateKey}`);
+    const chain = createEthereumChain(rpcUrls, chainId);
+    const { getVKTreeRoot } = await import('@aztec/noir-protocol-circuits-types/vk-tree');
+    return await deployL1Contracts(chain.rpcUrls, account, chain.chainInfo, debugLogger, {
+        l2FeeJuiceAddress: ProtocolContractAddress.FeeJuice.toField(),
+        vkTreeRoot: getVKTreeRoot(),
+        protocolContractTreeRoot,
+        genesisArchiveRoot,
+        genesisBlockHash,
+        salt,
+        initialValidators,
+        acceleratedTestDeployments,
+        ...config
+    }, config);
+}
+export async function deployNewRollupContracts(registryAddress, rpcUrls, chainId, privateKey, mnemonic, mnemonicIndex, salt, initialValidators, genesisArchiveRoot, genesisBlockHash, config, logger) {
+    const { createEthereumChain, deployRollupAndPeriphery, createL1Clients } = await import('@aztec/ethereum');
+    const { mnemonicToAccount, privateKeyToAccount } = await import('viem/accounts');
+    const { getVKTreeRoot } = await import('@aztec/noir-protocol-circuits-types/vk-tree');
+    const account = !privateKey ? mnemonicToAccount(mnemonic, {
+        addressIndex: mnemonicIndex
+    }) : privateKeyToAccount(`${privateKey.startsWith('0x') ? '' : '0x'}${privateKey}`);
+    const chain = createEthereumChain(rpcUrls, chainId);
+    const clients = createL1Clients(rpcUrls, account, chain.chainInfo, mnemonicIndex);
+    const { payloadAddress, rollup } = await deployRollupAndPeriphery(clients, {
+        salt,
+        vkTreeRoot: getVKTreeRoot(),
+        protocolContractTreeRoot,
+        l2FeeJuiceAddress: ProtocolContractAddress.FeeJuice.toField(),
+        genesisArchiveRoot,
+        genesisBlockHash,
+        initialValidators,
+        ...config
+    }, registryAddress, logger, config);
+    return {
+        payloadAddress,
+        rollup
+    };
+}
+/**
+ * Gets all contracts available in \@aztec/noir-contracts.js.
+ * @returns The contract names.
+ */ export async function getExampleContractNames() {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - Importing noir-contracts.js even in devDeps results in a circular dependency error. Need to ignore because this line doesn't cause an error in a dev environment
+    const { ContractNames } = await import('@aztec/noir-contracts.js');
+    return ContractNames;
+}
+/**
+ * Reads a file and converts it to an Aztec Contract ABI.
+ * @param fileDir - The directory of the compiled contract ABI.
+ * @returns The parsed contract artifact.
+ */ export async function getContractArtifact(fileDir, log) {
+    // first check if it's a noir-contracts example
+    const allNames = await getExampleContractNames();
+    const contractName = fileDir.replace(/Contract(Artifact)?$/, '');
+    if (allNames.includes(contractName)) {
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore - Importing noir-contracts.js even in devDeps results in a circular dependency error. Need to ignore because this line doesn't cause an error in a dev environment
+        const imported = await import(`@aztec/noir-contracts.js/${contractName}`);
+        const artifact = imported[`${contractName}ContractArtifact`];
+        if (!artifact) {
+            throw Error(`Could not import ${contractName}ContractArtifact from @aztec/noir-contracts.js/${contractName}`);
+        }
+        return artifact;
+    }
+    let contents;
+    try {
+        contents = await readFile(fileDir, 'utf8');
+    } catch  {
+        throw Error(`Contract ${fileDir} not found`);
+    }
+    try {
+        return loadContractArtifact(JSON.parse(contents));
+    } catch (err) {
+        log('Invalid file used. Please try again.');
+        throw err;
+    }
+}
+/**
+ * Performs necessary checks, conversions & operations to call a contract fn from the CLI.
+ * @param contractFile - Directory of the compiled contract ABI.
+ * @param functionName - Name of the function to be called.
+ * @param _functionArgs - Arguments to call the function with.
+ * @param log - Logger instance that will output to the CLI
+ * @returns Formatted contract address, function arguments and caller's aztec address.
+ */ export async function prepTx(contractFile, functionName, _functionArgs, log) {
+    const contractArtifact = await getContractArtifact(contractFile, log);
+    const functionArtifact = getFunctionArtifact(contractArtifact, functionName);
+    const functionArgs = encodeArgs(_functionArgs, functionArtifact.parameters);
+    const isPrivate = functionArtifact.functionType === FunctionType.PRIVATE;
+    return {
+        functionArgs,
+        contractArtifact,
+        isPrivate
+    };
+}
+/**
+ * Removes the leading 0x from a hex string. If no leading 0x is found the string is returned unchanged.
+ * @param hex - A hex string
+ * @returns A new string with leading 0x removed
+ */ export const stripLeadingHex = (hex)=>{
+    if (hex.length > 2 && hex.startsWith('0x')) {
+        return hex.substring(2);
+    }
+    return hex;
+};
+/**
+ * Pretty prints Nargo.toml contents to a string
+ * @param config - Nargo.toml contents
+ * @returns The Nargo.toml contents as a string
+ */ export function prettyPrintNargoToml(config) {
+    const withoutDependencies = Object.fromEntries(Object.entries(config).filter(([key])=>key !== 'dependencies'));
+    const partialToml = TOML.stringify(withoutDependencies);
+    const dependenciesToml = Object.entries(config.dependencies).map(([name, dep])=>{
+        const depToml = TOML.stringify.value(dep);
+        return `${name} = ${depToml}`;
+    });
+    return partialToml + '\n[dependencies]\n' + dependenciesToml.join('\n') + '\n';
+}
+/** Mismatch between server and client versions. */ class VersionMismatchError extends Error {
+}
+/**
+ * Checks that Private eXecution Environment (PXE) version matches the expected one by this CLI. Throws if not.
+ * @param pxe - PXE client.
+ * @param expectedVersionRange - Expected version by CLI.
+ */ export async function checkServerVersion(pxe, expectedVersionRange) {
+    const serverName = 'Aztec Node';
+    const { nodeVersion } = await pxe.getNodeInfo();
+    if (!nodeVersion) {
+        throw new VersionMismatchError(`Couldn't determine ${serverName} version. You may run into issues.`);
+    }
+    if (!nodeVersion || !valid(nodeVersion)) {
+        throw new VersionMismatchError(`Missing or invalid version identifier for ${serverName} (${nodeVersion ?? 'empty'}).`);
+    } else if (!satisfies(nodeVersion, expectedVersionRange)) {
+        if (gtr(nodeVersion, expectedVersionRange)) {
+            throw new VersionMismatchError(`${serverName} is running version ${nodeVersion} which is newer than the expected by this CLI (${expectedVersionRange}). Consider upgrading your CLI to a newer version.`);
+        } else if (ltr(nodeVersion, expectedVersionRange)) {
+            throw new VersionMismatchError(`${serverName} is running version ${nodeVersion} which is older than the expected by this CLI (${expectedVersionRange}). Consider upgrading your ${serverName} to a newer version.`);
+        } else {
+            throw new VersionMismatchError(`${serverName} is running version ${nodeVersion} which does not match the expected by this CLI (${expectedVersionRange}).`);
+        }
+    }
+}

package/dest/utils/commands.d.ts

@@ -0,0 +1,143 @@
+import { FunctionSelector } from '@aztec/aztec.js/abi';
+import { AztecAddress } from '@aztec/aztec.js/addresses';
+import { EthAddress } from '@aztec/aztec.js/eth_address';
+import { Fr } from '@aztec/aztec.js/fields';
+import { LogId } from '@aztec/aztec.js/log_id';
+import { TxHash } from '@aztec/aztec.js/tx_hash';
+import type { LogFn } from '@aztec/foundation/log';
+import type { PXE } from '@aztec/stdlib/interfaces/client';
+import { PublicKeys } from '@aztec/stdlib/keys';
+import { type Command, Option } from 'commander';
+/**
+ * If we can successfully resolve 'host.docker.internal', then we are running in a container, and we should treat
+ * localhost as being host.docker.internal.
+ */
+export declare const getLocalhost: () => Promise<string>;
+export declare const LOCALHOST: string;
+export declare const ETHEREUM_HOSTS: string, PRIVATE_KEY: string | undefined, API_KEY: string | undefined, CLI_VERSION: string | undefined;
+export declare function addOptions(program: Command, options: Option[]): Command;
+export declare const makePxeOption: (mandatory: boolean) => Option;
+export declare const pxeOption: Option;
+export declare const l1ChainIdOption: Option;
+export declare const createSecretKeyOption: (description: string, mandatory: boolean, argsParser?: (value: string, previous: Fr) => Fr) => Option;
+export declare const logJson: (log: LogFn) => (obj: object) => void;
+/**
+ * Updates a file in place atomically.
+ * @param filePath - Path to file
+ * @param contents - New contents to write
+ */
+export declare function atomicUpdateFile(filePath: string, contents: string): Promise<void>;
+/**
+ * Utility to select a TX sender either from user input
+ * or from the first account that is found in a PXE instance.
+ * @param pxe - The PXE instance that will be checked for an account.
+ * @param _from - The user input.
+ * @returns An Aztec address. Will throw if one can't be found in either options.
+ */
+export declare function getTxSender(pxe: PXE, _from?: string): Promise<AztecAddress>;
+export declare function parseBigint(bigint: string): bigint | undefined;
+/**
+ * Parses a hex encoded string to an Fr integer
+ * @param str - Hex encoded string
+ * @returns A integer
+ */
+export declare function parseFieldFromHexString(str: string): Fr;
+/**
+ * Parses an AztecAddress from a string.
+ * @param address - A serialized Aztec address
+ * @returns An Aztec address
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseAztecAddress(address: string): AztecAddress;
+/**
+ * Parses an Ethereum address from a string.
+ * @param address - A serialized Ethereum address
+ * @returns An Ethereum address
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseEthereumAddress(address: string): EthAddress;
+/**
+ * Parses an AztecAddress from a string.
+ * @param address - A serialized Aztec address
+ * @returns An Aztec address
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseOptionalAztecAddress(address: string): AztecAddress | undefined;
+/**
+ * Parses an optional log ID string into a LogId object.
+ *
+ * @param logId - The log ID string to parse.
+ * @returns The parsed LogId object, or undefined if the log ID is missing or empty.
+ */
+export declare function parseOptionalLogId(logId: string): LogId | undefined;
+/**
+ * Parses a selector from a string.
+ * @param selector - A serialized selector.
+ * @returns A selector.
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseOptionalSelector(selector: string): FunctionSelector | undefined;
+/**
+ * Parses a string into an integer or returns undefined if the input is falsy.
+ *
+ * @param value - The string to parse into an integer.
+ * @returns The parsed integer, or undefined if the input string is falsy.
+ * @throws If the input is not a valid integer.
+ */
+export declare function parseOptionalInteger(value: string): number | undefined;
+/**
+ * Parses a TxHash from a string.
+ * @param txHash - A transaction hash
+ * @returns A TxHash instance
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseTxHash(txHash: string): TxHash;
+/**
+ * Parses an optional TxHash from a string.
+ * Calls parseTxHash internally.
+ * @param txHash - A transaction hash
+ * @returns A TxHash instance, or undefined if the input string is falsy.
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseOptionalTxHash(txHash: string): TxHash | undefined;
+/**
+ * Parses a public key from a string.
+ * @param publicKey - A public keys object serialised as a string
+ * @returns A PublicKeys instance
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parsePublicKey(publicKey: string): PublicKeys | undefined;
+/**
+ * Parses a partial address from a string.
+ * @param address - A partial address
+ * @returns A Fr instance
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parsePartialAddress(address: string): Fr;
+/**
+ * Parses a secret key from a string.
+ * @param privateKey - A string
+ * @returns A secret key
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseSecretKey(secretKey: string): Fr;
+/**
+ * Parses a field from a string.
+ * @param field - A string representing the field.
+ * @returns A field.
+ * @throws InvalidArgumentError if the input string is not valid.
+ */
+export declare function parseField(field: string): Fr;
+/**
+ * Parses an array of strings to Frs.
+ * @param fields - An array of strings representing the fields.
+ * @returns An array of Frs.
+ */
+export declare function parseFields(fields: string[]): Fr[];
+/**
+ * Pretty prints an object as JSON
+ * @param data - The object to stringify
+ * @returns A JSON string
+ */
+export declare function prettyPrintJSON(data: Record<string, any>): string;
+//# sourceMappingURL=commands.d.ts.map

package/dest/utils/commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/utils/commands.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,EAAE,EAAE,MAAM,wBAAwB,CAAC;AAC5C,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACjD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,OAAO,EAAE,KAAK,OAAO,EAAwC,MAAM,EAAE,MAAM,WAAW,CAAC;AAIvF;;;GAGG;AACH,eAAO,MAAM,YAAY,uBAGI,CAAC;AAE9B,eAAO,MAAM,SAAS,QAAuB,CAAC;AAC9C,eAAO,MAAQ,cAAc,UAA+B,WAAW,sBAAE,OAAO,sBAAE,WAAW,oBAAgB,CAAC;AAE9G,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAG7D;AAED,eAAO,MAAM,aAAa,cAAe,OAAO,WAKb,CAAC;AAEpC,eAAO,MAAM,SAAS,QAAsB,CAAC;AAE7C,eAAO,MAAM,eAAe,QASxB,CAAC;AAEL,eAAO,MAAM,qBAAqB,gBACnB,MAAM,aACR,OAAO,eACL,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,WAKf,CAAC;AAEpC,eAAO,MAAM,OAAO,QAAS,KAAK,WAAW,MAAM,SAAsC,CAAC;AAE1F;;;;GAIG;AACH,wBAAsB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,iBAqBxE;AAED;;;;;;GAMG;AACH,wBAAsB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,MAAM,yBAgBzD;AAcD,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE9D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,EAAE,CAqBvD;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,CAM/D;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAMhE;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAKnF;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAKnE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CASpF;AAED;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAStE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAKtE;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CASxE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,GAAG,EAAE,CAMvD;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,CAMpD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,EAAE,CAyB5C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,CAElD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAcjE"}