Skip to content

Commit

Permalink
pages
Browse files Browse the repository at this point in the history
  • Loading branch information
catmcgee committed Jan 15, 2024
1 parent fd1f619 commit cedebdf
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 1 deletion.
49 changes: 49 additions & 0 deletions docs/docs/concepts/advanced/private_execution_environment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Private Execution Environment (PXE)
---

The Private Execution Environment (or PXE, pronounced 'pixie') is a client-side library for the execution of private operations. It is a TypeScript library and can be run within Node, such as when you run the sandbox, within the browser, or any other environment in which TypeScript can run. For example, in future it could be run inside wallet software.

The PXE generates proofs of private function execution, and sends these proofs along with public function requests to the sequencer. Private inputs never leave the client-side PXE.

```mermaid
graph TD;
subgraph client[Client]
subgraph pxe [PXE]
acirSim[ACIR Simulator]
db[Database]
keyStore[KeyStore]
end
end
subgraph server[Server]
subgraph pxeService [PXE Service]
acctMgmt[Account Management]
contractTxInteract[Contract & Transaction Interactions]
noteMgmt[Note Management]
end
end
pxe -->|interfaces| server
```

## PXE Service

The PXE is a client-side interface of the PXE Service, which is a set of server-side APIs for interacting with the network. It provides functions for account management, contract and transaction interactions, note management, and more. For a more extensive list of operations, refer to the [PXE reference](../../apis/pxe/index.md).


## Components

### ACIR simulator

### Database

### Note discovery

### Key store

## Oracles


3 changes: 3 additions & 0 deletions docs/docs/dev_docs/pxe/custom_oracles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: How to write a custom oracle
---
3 changes: 3 additions & 0 deletions docs/docs/dev_docs/pxe/run_more_than_one_pxe_sandbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: How to run more than one PXE in the sandbox
---
10 changes: 9 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ const sidebars = {
},
"concepts/advanced/public_vm",
"concepts/advanced/contract_creation",
"concepts/advanced/private_execution_environment",
"concepts/advanced/sequencer_selection",
"concepts/advanced/acir_simulator",
],
Expand Down Expand Up @@ -421,7 +422,14 @@ const sidebars = {
},
items: ["dev_docs/testing/cheat_codes"],
},

{
label: "Private Execution Environment (PXE)",
type: "category",
items: [
"dev_docs/pxe/custom_oracles",
"dev_docs/pxe/run_more_than_one_pxe_sandbox",
],
},
{
label: "Wallets",
type: "category",
Expand Down

0 comments on commit cedebdf

Please sign in to comment.