diff --git a/docs/docs/reference/developer_references/common_errors/sandbox-errors.md b/docs/docs/reference/developer_references/common_errors/sandbox-errors.md index 0190ea28585e..41414eda80d2 100644 --- a/docs/docs/reference/developer_references/common_errors/sandbox-errors.md +++ b/docs/docs/reference/developer_references/common_errors/sandbox-errors.md @@ -38,7 +38,7 @@ You cannot execute a public Aztec.nr function in the private kernel #### 2011 - PRIVATE_KERNEL\_\_UNSUPPORTED_OP -You are trying to do something that is currently unsupported in the private kernel. If this is a blocker feel free to open up an issue on our monorepo [aztec-packages (GitHub link)](https://github.com/AztecProtocol/aztec3-packages/tree/master) or reach out to us on discord +You are trying to do something that is currently unsupported in the private kernel. If this is a blocker feel free to open up an issue on our monorepo [aztec-packages (GitHub link)](https://github.com/AztecProtocol/aztec-packages/tree/master) or reach out to us on discord Note that certain operations are unsupported on certain versions of the private kernel. Eg static calls are allowed for all but the initial iteration of the private kernel (which initializes the kernel for subsequent function calls). @@ -80,7 +80,7 @@ But for non transient reads, we do a merkle membership check. Reads are done at #### 3001 - PUBLIC_KERNEL\_\_UNSUPPORTED_OP -You are trying to do something that is currently unsupported in the public kernel. If this is a blocker feel free to open up an issue on our monorepo [aztec-packages (GitHub link)](https://github.com/AztecProtocol/aztec3-packages/tree/master) or reach out to us on discord +You are trying to do something that is currently unsupported in the public kernel. If this is a blocker feel free to open up an issue on our monorepo [aztec-packages (GitHub link)](https://github.com/AztecProtocol/aztec-packages/tree/master) or reach out to us on discord #### 3002 - PUBLIC_KERNEL\_\_PRIVATE_FUNCTION_NOT_ALLOWED diff --git a/docs/internal_notes/dev_docs/sandbox/components.md b/docs/internal_notes/dev_docs/sandbox/components.md index c46dcf3a3559..fb8e6bfa1162 100644 --- a/docs/internal_notes/dev_docs/sandbox/components.md +++ b/docs/internal_notes/dev_docs/sandbox/components.md @@ -12,7 +12,7 @@ import Disclaimer from '../../src/components/Disclaimers/\_wip_disclaimer.mdx'; -You can track the development of these components in the [aztec3-packages repo](https://github.com/AztecProtocol/aztec3-packages/tree/master). +You can track the development of these components in the [aztec-packages repo](https://github.com/AztecProtocol/aztec-packages/tree/master). ### KeyStore @@ -137,6 +137,7 @@ Implementation notes for this milestone: - Can be used as both the spending and decryption key for early development. ### Private Execution Environment (PXE) + ![](https://hackmd.io/_uploads/ryS0sOLyh.png) Implements: diff --git a/yarn-project/README.md b/yarn-project/README.md index a9bda140bdfe..7239116c2a86 100644 --- a/yarn-project/README.md +++ b/yarn-project/README.md @@ -1,28 +1,37 @@ # Aztec Typescript Packages -All the Typescript packages that make up [Aztec](https://docs.aztec.network/aztec3/overview). +All the Typescript packages that make up [Aztec](https://docs.aztec.network). ## Development All scripts are run in the `yarn-project` workspace root: - To install dependencies run + ``` yarn ``` + - To compile all packages on file changes run + ``` yarn build:dev ``` + - To update `tsconfig.json` and `build_manifest.json` references run + ``` yarn prepare ``` + - To prettify all files run + ``` yarn format ``` + - To check prettier and eslint rules on each package (slow) run + ``` yarn formatting ``` @@ -69,11 +78,13 @@ To add a new package, make sure to add it to the `build_manifest.json`, to the ` You may also need to modify the [Dockerfile](yarn-project/yarn-project-base/Dockerfile) to copy your new `package.json` into the container to get CI to pass. ## Deploying npm packages + `deploy-npm` script handles the releases of npm packages within yarn-project. But the initial release is a manual process: 1. Ensure relevant folders are copied in by docker in `yarn-project/yarn-project-base/Dockerfile` and `yarn-project/Dockerfile` 2. SSH into the CI 3. Run the following: + ```sh cd project ./build-system/scripts/setup_env "$(git rev-parse HEAD)" "" "" "" @@ -81,11 +92,12 @@ source /tmp/.bash_env* BUILD_SYSTEM_DEBUG=1 COMMIT_TAG= ``` + 4. Follow the [`deploy-npm` script](./deploy_npm.sh). - - Best to run the `deploy_package()` method line by line by manually setting `REPOSITORY` var. - - Extract `VERSION` as the script shows (in the eg it should be 0.8.8) - - Skip the version existing checks like `if [ "$VERSION" == "$PUBLISHED_VERSION" ]` and `if [ "$VERSION" != "$HIGHER_VERSION" ]`. Since this is our first time deploying the package, `PUBLISHED_VERSION` and `HIGHER_VERSION` will be empty and hence these checks would fail. These checks are necessary in the CI for continual releases. - - Locally update the package version in package.json using `jq` as shown in the script. - - Do a dry-run - - If dry run succeeds, publish the package! + - Best to run the `deploy_package()` method line by line by manually setting `REPOSITORY` var. + - Extract `VERSION` as the script shows (in the eg it should be 0.8.8) + - Skip the version existing checks like `if [ "$VERSION" == "$PUBLISHED_VERSION" ]` and `if [ "$VERSION" != "$HIGHER_VERSION" ]`. Since this is our first time deploying the package, `PUBLISHED_VERSION` and `HIGHER_VERSION` will be empty and hence these checks would fail. These checks are necessary in the CI for continual releases. + - Locally update the package version in package.json using `jq` as shown in the script. + - Do a dry-run + - If dry run succeeds, publish the package! 5. Create a PR by adding your package into the `deploy-npm` script so next release onwards, CI can cut releases for your package.