-
Notifications
You must be signed in to change notification settings - Fork 305
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
64 additions
and
1 deletion.
There are no files selected for viewing
49 changes: 49 additions & 0 deletions
49
docs/docs/concepts/advanced/private_execution_environment.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--- | ||
title: How to write a custom oracle | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters