fix: exposing PXE.getBlock, exporting createAztecNodeClient from …

…`aztec.js` (#3139)

A few fixes of issues which were stumbled upon by a grantee
@harshnambiar.

Issues:
1. `getBlock` method was not exposed on `PXE` even though it's
implemented in `PXEService`,
2. `createAztecNodeRpcClient` naming is not consistent with
`createPXEClient` (`createAztecNodeRpcClient` -->
`createAztecNodeClient`),
3. `createAztecNodeClient` method is not exposed in `aztec.js`.

yarn-project/aztec.js/src/index.ts

@@ -32,6 +32,7 @@ export {
   TxStatus,
   UnencryptedL2Log,
   emptyFunctionCall,
+  createAztecNodeClient,
 } from '@aztec/types';
 export { ContractArtifact } from '@aztec/foundation/abi';
 export { createDebugLogger, DebugLogger } from '@aztec/foundation/log';

yarn-project/aztec.js/src/pxe_client.ts

@@ -14,6 +14,7 @@ import {
   ExtendedContractData,
   ExtendedNote,
   ExtendedUnencryptedL2Log,
+  L2Block,
   L2BlockL2Logs,
   L2Tx,
   LogId,
@@ -27,6 +28,12 @@ import {
 
 export { makeFetch } from '@aztec/foundation/json-rpc/client';
 
+/**
+ * Creates a JSON-RPC client to remotely talk to PXE.
+ * @param url - The URL of the PXE.
+ * @param fetch - The fetch implementation to use.
+ * @returns A JSON-RPC client of PXE.
+ */
 export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], true)): PXE =>
   createJsonRpcClient<PXE>(
     url,
@@ -48,6 +55,7 @@ export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], true))
       AuthWitness,
       L2Tx,
       LogId,
+      L2Block,
     },
     { Tx, TxReceipt, L2BlockL2Logs },
     false,

yarn-project/aztec.js/src/wallet/base_wallet.ts

@@ -7,6 +7,7 @@ import {
   ExtendedNote,
   FunctionCall,
   GetUnencryptedLogsResponse,
+  L2Block,
   L2Tx,
   LogFilter,
   NodeInfo,
@@ -82,6 +83,9 @@ export abstract class BaseWallet implements Wallet {
   getNoteNonces(note: ExtendedNote): Promise<Fr[]> {
     return this.pxe.getNoteNonces(note);
   }
+  getBlock(number: number): Promise<L2Block | undefined> {
+    return this.pxe.getBlock(number);
+  }
   viewTx(functionName: string, args: any[], to: AztecAddress, from?: AztecAddress | undefined): Promise<any> {
     return this.pxe.viewTx(functionName, args, to, from);
   }

yarn-project/end-to-end/src/fixtures/utils.ts

@@ -29,7 +29,7 @@ import {
 } from '@aztec/l1-artifacts';
 import { PXEService, createPXEService, getPXEServiceConfig } from '@aztec/pxe';
 import { SequencerClient } from '@aztec/sequencer-client';
-import { AztecNode, L2BlockL2Logs, LogType, PXE, createAztecNodeRpcClient } from '@aztec/types';
+import { AztecNode, L2BlockL2Logs, LogType, PXE, createAztecNodeClient } from '@aztec/types';
 
 import * as path from 'path';
 import {
@@ -166,7 +166,7 @@ async function setupWithSandbox(account: Account, config: AztecNodeConfig, logge
   // we are setting up against the sandbox, l1 contracts are already deployed
   const aztecNodeUrl = getAztecNodeUrl();
   logger(`Creating Aztec Node client to remote host ${aztecNodeUrl}`);
-  const aztecNode = createAztecNodeRpcClient(aztecNodeUrl);
+  const aztecNode = createAztecNodeClient(aztecNodeUrl);
   logger(`Creating PXE client to remote host ${PXE_URL}`);
   const pxeClient = createPXEClient(PXE_URL);
   await waitForPXE(pxeClient, logger);

yarn-project/pxe/src/bin/index.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env -S node --no-warnings
 import { createDebugLogger } from '@aztec/foundation/log';
-import { createAztecNodeRpcClient } from '@aztec/types';
+import { createAztecNodeClient } from '@aztec/types';
 
 import { getPXEServiceConfig } from '../config/index.js';
 import { startPXEHttpServer } from '../pxe_http/index.js';
@@ -17,7 +17,7 @@ async function main() {
   logger.info(`Setting up PXE...`);
 
   const pxeConfig = getPXEServiceConfig();
-  const nodeRpcClient = createAztecNodeRpcClient(AZTEC_NODE_URL);
+  const nodeRpcClient = createAztecNodeClient(AZTEC_NODE_URL);
   const pxeService = await createPXEService(nodeRpcClient, pxeConfig);
 
   const shutdown = async () => {

yarn-project/types/src/aztec_node/rpc/http_rpc_client.ts → yarn-project/types/src/aztec_node/rpc/aztec_node_client.ts

@@ -19,13 +19,13 @@ import {
 } from '@aztec/types';
 
 /**
- * Creates a JSON-RPC client to remotely talk to an AztecNode.
- * @param url - The URL of the AztecNode
- * @param fetch - The fetch implementation to use
- * @returns A JSON-RPC client
+ * Creates a JSON-RPC client to remotely talk to an Aztec Node.
+ * @param url - The URL of the Aztec Node.
+ * @param fetch - The fetch implementation to use.
+ * @returns A JSON-RPC client of Aztec Node.
  */
-export function createAztecNodeRpcClient(url: string, fetch = defaultFetch): AztecNode {
-  const rpcClient = createJsonRpcClient<AztecNode>(
+export function createAztecNodeClient(url: string, fetch = defaultFetch): AztecNode {
+  return createJsonRpcClient<AztecNode>(
     url,
     {
       AztecAddress,
@@ -47,5 +47,4 @@ export function createAztecNodeRpcClient(url: string, fetch = defaultFetch): Azt
     false,
     fetch,
   );
-  return rpcClient;
 }

yarn-project/types/src/aztec_node/rpc/index.ts

@@ -1 +1 @@
-export * from './http_rpc_client.js';
+export * from './aztec_node_client.js';

yarn-project/types/src/interfaces/pxe.ts

@@ -6,6 +6,7 @@ import {
   ExtendedContractData,
   ExtendedNote,
   GetUnencryptedLogsResponse,
+  L2Block,
   L2Tx,
   LogFilter,
   Tx,
@@ -181,6 +182,13 @@ export interface PXE {
    */
   getNoteNonces(note: ExtendedNote): Promise<Fr[]>;
 
+  /**
+   * Get the a given block.
+   * @param number - The block number being requested.
+   * @returns The blocks requested.
+   */
+  getBlock(number: number): Promise<L2Block | undefined>;
+
   /**
    * Simulate the execution of a view (read-only) function on a deployed contract without actually modifying state.
    * This is useful to inspect contract state, for example fetching a variable value or calling a getter function.