Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: capitalizing x in pxe #2564

Merged
merged 2 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion yarn-project/aztec-node/src/bin/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ async function createAndDeployAztecNode() {
}

/**
* Creates a router for helper API endpoints of the Private Execution Environment (PXE).
* Creates a router for helper API endpoints of the Private eXecution Environment (PXE).
* @param apiPrefix - The prefix to use for all api requests
* @returns - The router for handling status requests.
*/
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/aztec-sandbox/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# aztec-sandbox

Aztec Sandbox is a package that allows for a simple development environment on Aztec stack. It creates an Private Execution Environment (PXE) that listens for HTTP requests on `localhost:8080` by default. When started, it deploys all necessary L1 Aztec contracts and then starts listening for RPC requests.
Aztec Sandbox is a package that allows for a simple development environment on Aztec stack. It creates an Private eXecution Environment (PXE) that listens for HTTP requests on `localhost:8080` by default. When started, it deploys all necessary L1 Aztec contracts and then starts listening for RPC requests.

## How to run:

Expand Down
2 changes: 1 addition & 1 deletion yarn-project/aztec-sandbox/src/routes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Koa from 'koa';
import Router from 'koa-router';

/**
* Creates a router for helper API endpoints of the Private Execution Environment (PXE).
* Creates a router for helper API endpoints of the Private eXecution Environment (PXE).
* @param aztecNode - An instance of the aztec node.
* @param config - The aztec node's configuration variables.
*/
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/aztec.js/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aztec.js

Aztec.js is a library that provides APIs for managing accounts and interacting with contracts on the Aztec network. It communicates with the [Private Execution Environment (PXE)](https://docs.aztec.network/apis/pxe/interfaces/PXE) through a `PXE` implementation, allowing developers to easily register new accounts, deploy contracts, view functions, and send transactions.
Aztec.js is a library that provides APIs for managing accounts and interacting with contracts on the Aztec network. It communicates with the [Private eXecution Environment (PXE)](https://docs.aztec.network/apis/pxe/interfaces/PXE) through a `PXE` implementation, allowing developers to easily register new accounts, deploy contracts, view functions, and send transactions.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions yarn-project/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ These options are:
- `API_KEY` -> `a, --api-key` for `deploy-l1-contracts`.
- `ETHEREUM_RPC_HOST` -> `-u, --rpc-url` for `deploy-l1-contracts`.

So if for example you are running your Private Execution Environment (PXE) remotely you can do:
So if for example you are running your Private eXecution Environment (PXE) remotely you can do:

```shell
export PXE_HOST=http://external.site/rpc:8080
Expand Down Expand Up @@ -352,7 +352,7 @@ Options:
- `'-a, --args [functionArgs...]` (optional): Function arguments. Default: [].
- `-c, --contract-abi <fileLocation>`: The compiled contract's ABI in JSON format. You can also use one of Aztec's example contracts found in (@aztec/noir-contracts)[https://www.npmjs.com/package/@aztec/noir-contracts], e.g. PrivateTokenContractAbi.
- `-ca, --contract-address <address>`: Address of the contract.
- `-f, --from <string>`: Address of the caller. If empty, first account in the Private Execution Environment (PXE) will be used.
- `-f, --from <string>`: Address of the caller. If empty, first account in the Private eXecution Environment (PXE) will be used.
- `-u, --rpc-url <string>`: URL of PXE Service. Default: `http://localhost:8080`.

This command simulates the execution of a view function on a deployed contract without modifying the state. It requires the contract's ABI, address, function name, and optionally, function arguments. The command displays the result of the view function.
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/cli/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export async function createCompatibleClient(rpcUrl: string, logger: DebugLogger
class VersionMismatchError extends Error {}

/**
* Checks that Private Execution Environment (PXE) version matches the expected one by this CLI. Throws if not.
* 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.
*/
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/end-to-end/src/e2e_2_pxes.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ describe('e2e_2_pxes', () => {
expect(storedValue).toBe(newValueToSet);
});

it('private state is "zero" when Private Execution Environment (PXE) does not have the account private key', async () => {
it('private state is "zero" when Private eXecution Environment (PXE) does not have the account private key', async () => {
const userABalance = 100n;
const userBBalance = 150n;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ describe('e2e_multiple_accounts_1_enc_key', () => {
};

/**
* Tests the ability of the Private Execution Environment (PXE) to handle multiple accounts under the same encryption key.
* Tests the ability of the Private eXecution Environment (PXE) to handle multiple accounts under the same encryption key.
*/
it('spends notes from multiple account under the same encryption key', async () => {
const transferAmount1 = 654n; // account 0 -> account 1
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/end-to-end/src/e2e_p2p_network.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ describe('e2e_p2p_network', () => {
return await AztecNodeService.createAndSync(newConfig);
};

// submits a set of transactions to the provided Private Execution Environment (PXE)
// submits a set of transactions to the provided Private eXecution Environment (PXE)
const submitTxsTo = async (pxe: PXEService, account: AztecAddress, numTxs: number, publicKey: PublicKey) => {
const txs: SentTx[] = [];
for (let i = 0; i < numTxs; i++) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ export class CrossChainTestHarness {
constructor(
/** AztecNode. */
public aztecNode: AztecNodeService | undefined,
/** Private Execution Environment (PXE). */
/** Private eXecution Environment (PXE). */
public pxeService: PXE,
/** CheatCodes. */
public cc: CheatCodes,
Expand Down
6 changes: 3 additions & 3 deletions yarn-project/end-to-end/src/fixtures/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,13 +126,13 @@ export const setupL1Contracts = async (
};

/**
* Sets up Private Execution Environment (PXE).
* Sets up Private eXecution Environment (PXE).
* @param numberOfAccounts - The number of new accounts to be created once the PXE is initiated.
* @param aztecNode - The instance of an aztec node, if one is required
* @param firstPrivKey - The private key of the first account to be created.
* @param logger - The logger to be used.
* @param useLogSuffix - Whether to add a randomly generated suffix to the PXE debug logs.
* @returns Private Execution Environment (PXE), accounts, wallets and logger.
* @returns Private eXecution Environment (PXE), accounts, wallets and logger.
*/
export async function setupPXEService(
numberOfAccounts: number,
Expand Down Expand Up @@ -231,7 +231,7 @@ export async function setup(
*/
aztecNode: AztecNodeService | undefined;
/**
* The Private Execution Environment (PXE).
* The Private eXecution Environment (PXE).
*/
pxe: PXE;
/**
Expand Down
2 changes: 2 additions & 0 deletions yarn-project/pxe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@
- [Acir Simulator](../acir-simulator/)
- [Key Store](../key-store/)
- [Account State](./src/account_state/account_state.ts): It coordinates other components to synchronize and decrypt data, simulate transactions, and generate kernel proofs, for a specific account.

![Pixie](./pixie.png)
Binary file added yarn-project/pxe/pixie.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion yarn-project/pxe/src/pxe_http/pxe_http_server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import { EthAddress } from '../index.js';
export const localAnvil = foundry;

/**
* Wraps an instance of Private Execution Environment (PXE) implementation to a JSON RPC HTTP interface.
* Wraps an instance of Private eXecution Environment (PXE) implementation to a JSON RPC HTTP interface.
* @returns A new instance of the HTTP server.
*/
export function createPXERpcServer(pxeService: PXE): JsonRpcServer {
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/pxe/src/pxe_service/pxe_service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ import { getAcirSimulator } from '../simulator/index.js';
import { Synchronizer } from '../synchronizer/index.js';

/**
* A Private Execution Environment (PXE) implementation.
* A Private eXecution Environment (PXE) implementation.
*/
export class PXEService implements PXE {
private synchronizer: Synchronizer;
Expand Down
2 changes: 1 addition & 1 deletion yarn-project/types/src/interfaces/pxe.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import { SyncStatus } from './sync-status.js';

// docs:start:pxe-interface
/**
* Private Execution Environment (PXE) runs locally for each user, providing functionality for all the operations
* Private eXecution Environment (PXE) runs locally for each user, providing functionality for all the operations
* needed to interact with the Aztec network, including account management, private data management,
* transaction local simulation, and access to an Aztec node. This interface, as part of a Wallet,
* is exposed to dapps for interacting with the network on behalf of the user.
Expand Down