@aztec/cli 0.16.1 → 0.16.3

package/src/cmds/get_logs.ts

@@ -0,0 +1,71 @@
+import { AztecAddress, FunctionSelector, LogFilter, LogId, TxHash } from '@aztec/aztec.js';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+import { sleep } from '@aztec/foundation/sleep';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function getLogs(
+  txHash: TxHash,
+  fromBlock: number,
+  toBlock: number,
+  afterLog: LogId,
+  contractAddress: AztecAddress,
+  selector: FunctionSelector,
+  rpcUrl: string,
+  follow: boolean,
+  debugLogger: DebugLogger,
+  log: LogFn,
+) {
+  const pxe = await createCompatibleClient(rpcUrl, debugLogger);
+
+  if (follow) {
+    if (txHash) {
+      throw Error('Cannot use --follow with --tx-hash');
+    }
+    if (toBlock) {
+      throw Error('Cannot use --follow with --to-block');
+    }
+  }
+
+  const filter: LogFilter = { txHash, fromBlock, toBlock, afterLog, contractAddress, selector };
+
+  const fetchLogs = async () => {
+    const response = await pxe.getUnencryptedLogs(filter);
+    const logs = response.logs;
+
+    if (!logs.length) {
+      const filterOptions = Object.entries(filter)
+        .filter(([, value]) => value !== undefined)
+        .map(([key, value]) => `${key}: ${value}`)
+        .join(', ');
+      if (!follow) {
+        log(`No logs found for filter: {${filterOptions}}`);
+      }
+    } else {
+      if (!follow && !filter.afterLog) {
+        log('Logs found: \n');
+      }
+      logs.forEach(unencryptedLog => log(unencryptedLog.toHumanReadable()));
+      // Set the continuation parameter for the following requests
+      filter.afterLog = logs[logs.length - 1].id;
+    }
+    return response.maxLogsHit;
+  };
+
+  if (follow) {
+    log('Fetching logs...');
+    while (true) {
+      const maxLogsHit = await fetchLogs();
+      if (!maxLogsHit) {
+        await sleep(1000);
+      }
+    }
+  } else {
+    while (await fetchLogs()) {
+      // Keep fetching logs until we reach the end.
+    }
+  }
+}

package/src/cmds/get_node_info.ts

@@ -0,0 +1,17 @@
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function getNodeInfo(rpcUrl: string, debugLogger: DebugLogger, log: LogFn) {
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+  const info = await client.getNodeInfo();
+  log(`\nNode Info:\n`);
+  log(`Sandbox Version: ${info.sandboxVersion}\n`);
+  log(`Compatible Nargo Version: ${info.compatibleNargoVersion}\n`);
+  log(`Chain Id: ${info.chainId}\n`);
+  log(`Protocol Version: ${info.protocolVersion}\n`);
+  log(`Rollup Address: ${info.l1ContractAddresses.rollupAddress.toString()}`);
+}

package/src/cmds/get_recipient.ts

@@ -0,0 +1,18 @@
+import { AztecAddress } from '@aztec/aztec.js';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function getRecipient(aztecAddress: AztecAddress, rpcUrl: string, debugLogger: DebugLogger, log: LogFn) {
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+  const recipient = await client.getRecipient(aztecAddress);
+
+  if (!recipient) {
+    log(`Unknown recipient ${aztecAddress.toString()}`);
+  } else {
+    log(recipient.toReadableString());
+  }
+}

package/src/cmds/get_recipients.ts

@@ -0,0 +1,19 @@
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function getRecipients(rpcUrl: string, debugLogger: DebugLogger, log: LogFn) {
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+  const recipients = await client.getRecipients();
+  if (!recipients.length) {
+    log('No recipients found.');
+  } else {
+    log(`Recipients found: \n`);
+    for (const recipient of recipients) {
+      log(recipient.toReadableString());
+    }
+  }
+}

package/src/cmds/get_tx_receipt.ts

@@ -0,0 +1,18 @@
+import { TxHash } from '@aztec/aztec.js';
+import { JsonStringify } from '@aztec/foundation/json-rpc';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function getTxReceipt(rpcUrl: string, txHash: TxHash, debugLogger: DebugLogger, log: LogFn) {
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+  const receipt = await client.getTxReceipt(txHash);
+  if (!receipt) {
+    log(`No receipt found for transaction hash ${txHash.toString()}`);
+  } else {
+    log(`\nTransaction receipt: \n${JsonStringify(receipt, true)}\n`);
+  }
+}

package/src/cmds/inspect_contract.ts

@@ -0,0 +1,29 @@
+import {
+  FunctionSelector,
+  decodeFunctionSignature,
+  decodeFunctionSignatureWithParameterNames,
+} from '@aztec/foundation/abi';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { getContractArtifact } from '../utils.js';
+
+/**
+ *
+ */
+export async function inspectContract(contractArtifactFile: string, debugLogger: DebugLogger, log: LogFn) {
+  const contractArtifact = await getContractArtifact(contractArtifactFile, debugLogger);
+  const contractFns = contractArtifact.functions.filter(
+    f => !f.isInternal && f.name !== 'compute_note_hash_and_nullifier',
+  );
+  if (contractFns.length === 0) {
+    log(`No external functions found for contract ${contractArtifact.name}`);
+  }
+  for (const fn of contractFns) {
+    const signatureWithParameterNames = decodeFunctionSignatureWithParameterNames(fn.name, fn.parameters);
+    const signature = decodeFunctionSignature(fn.name, fn.parameters);
+    const selector = FunctionSelector.fromSignature(signature);
+    log(
+      `${fn.functionType} ${signatureWithParameterNames} \n\tfunction signature: ${signature}\n\tselector: ${selector}`,
+    );
+  }
+}

package/src/cmds/parse_parameter_struct.ts

@@ -0,0 +1,30 @@
+import { StructType } from '@aztec/foundation/abi';
+import { JsonStringify } from '@aztec/foundation/json-rpc';
+import { LogFn } from '@aztec/foundation/log';
+
+import { parseStructString } from '../encoding.js';
+import { getContractArtifact } from '../utils.js';
+
+/**
+ *
+ */
+export async function parseParameterStruct(
+  encodedString: string,
+  contractArtifactPath: string,
+  parameterName: string,
+  log: LogFn,
+) {
+  const contractArtifact = await getContractArtifact(contractArtifactPath, log);
+  const parameterAbitype = contractArtifact.functions
+    .map(({ parameters }) => parameters)
+    .flat()
+    .find(({ name, type }) => name === parameterName && type.kind === 'struct');
+
+  if (!parameterAbitype) {
+    log(`No struct parameter found with name ${parameterName}`);
+    return;
+  }
+
+  const data = parseStructString(encodedString, parameterAbitype.type as StructType);
+  log(`\nStruct Data: \n${JsonStringify(data, true)}\n`);
+}

package/src/cmds/register_account.ts

@@ -0,0 +1,24 @@
+import { Fq, Fr } from '@aztec/foundation/fields';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function registerAccount(
+  rpcUrl: string,
+  privateKey: Fq,
+  partialAddress: Fr,
+  debugLogger: DebugLogger,
+  log: LogFn,
+) {
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+
+  const { address, publicKey } = await client.registerAccount(privateKey, partialAddress);
+
+  log(`\nRegistered account:\n`);
+  log(`Address:         ${address.toString()}`);
+  log(`Public key:      ${publicKey.toString()}`);
+  log(`Partial address: ${partialAddress.toString()}`);
+}

package/src/cmds/register_recipient.ts

@@ -0,0 +1,21 @@
+import { AztecAddress, Fr, Point } from '@aztec/aztec.js';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+import { CompleteAddress } from '@aztec/types';
+
+import { createCompatibleClient } from '../client.js';
+
+/**
+ *
+ */
+export async function registerRecipient(
+  aztecAddress: AztecAddress,
+  publicKey: Point,
+  partialAddress: Fr,
+  rpcUrl: string,
+  debugLogger: DebugLogger,
+  log: LogFn,
+) {
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+  await client.registerRecipient(CompleteAddress.create(aztecAddress, publicKey, partialAddress));
+  log(`\nRegistered details for account with address: ${aztecAddress}\n`);
+}

package/src/cmds/send.ts

@@ -0,0 +1,40 @@
+import { AztecAddress, Contract, Fq, Fr, getSchnorrAccount } from '@aztec/aztec.js';
+import { DebugLogger, LogFn } from '@aztec/foundation/log';
+
+import { createCompatibleClient } from '../client.js';
+import { prepTx } from '../utils.js';
+
+/**
+ *
+ */
+export async function send(
+  functionName: string,
+  functionArgsIn: any[],
+  contractArtifactPath: string,
+  contractAddress: AztecAddress,
+  privateKey: Fq,
+  rpcUrl: string,
+  wait: boolean,
+  debugLogger: DebugLogger,
+  log: LogFn,
+) {
+  const { functionArgs, contractArtifact } = await prepTx(contractArtifactPath, functionName, functionArgsIn, log);
+
+  const client = await createCompatibleClient(rpcUrl, debugLogger);
+  const wallet = await getSchnorrAccount(client, privateKey, privateKey, Fr.ZERO).getWallet();
+  const contract = await Contract.at(contractAddress, contractArtifact, wallet);
+  const tx = contract.methods[functionName](...functionArgs).send();
+  log(`\nTransaction hash: ${(await tx.getTxHash()).toString()}`);
+  if (wait) {
+    await tx.wait();
+
+    log('Transaction has been mined');
+
+    const receipt = await tx.getReceipt();
+    log(`Status: ${receipt.status}\n`);
+    log(`Block number: ${receipt.blockNumber}`);
+    log(`Block hash: ${receipt.blockHash?.toString('hex')}`);
+  } else {
+    log('Transaction pending. Check status with get-tx-receipt');
+  }
+}

package/src/cmds/unbox.ts

@@ -0,0 +1,11 @@
+import { LogFn } from '@aztec/foundation/log';
+
+import { unboxContract } from '../unbox.js';
+
+/**
+ *
+ */
+export async function unbox(contractName: string, localDirectory: string | undefined, cliVersion: string, log: LogFn) {
+  const unboxTo: string = localDirectory ? localDirectory : contractName;
+  await unboxContract(contractName, unboxTo, cliVersion, log);
+}