Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 3.07 KB

README.md

File metadata and controls

96 lines (61 loc) · 3.07 KB

Aztec Typescript Packages

All the Typescript packages that make up Aztec.

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

Tests

To run tests for a specific package, in its folder just run:

yarn test

Note that end-to-end tests require anvil to be running, which is installed as part of the Foundry toolchain.

Useful extensions

Consider installing the Prettier and ESLint extensions if using VSCode. Configure Prettier to format the code on save, and ensure that ESLint errors are shown in your IDE.

Typescript config

  • yarn-project/tsconfig.json: Base tsconfig file, extended by all packages. Used directly by vscode and eslint, where it functions to include the whole project without listing project references.
  • yarn-project/[package]/tsconfig.json: Each package has its own file that specifies its project reference dependencies. This allows them to be built independently.

Package.json inheritance

To simplify the management of all package.json files, we have a custom script that injects the contents of package.common.json into all packages that reference it via the inherits custom field. To run the script, just run:

yarn prepare

To override any of the fields from package.common.json, declare a package.local.json local to the package and add it to the inherits field.

Adding a new package

To add a new package, make sure to add it to the build_manifest.json, to the workspaces entry in the root package.json, and to the .circleci/config. Then, copy the structure from another existing package, including:

  • .eslintrc.cjs
  • Dockerfile
  • package.json
  • README.md
  • tsconfig.json

Deploying npm packages

Run DRY_RUN=1 ./bootstrap.sh release to see the release workflow that runs in CI. You must have checked out a valid semver tag.

Profiling

There is an instrumenting profiler available with e.g. ./bootstrap.sh instrumented_profile "cd end-to-end; LOG_LEVEL=info yarn test e2e_prover/client" Note that it actually rewrites source code so you need a clean git state. This command will restore the state afterwards and print the command to print the benchmark results. You can use --min-ms flags. You can also pass multiple --exclude regex patterns to not print certain names (similar to if they were lower than --min-ms, we will still consider their children).

NOTE: Due to this using async functions, a child can have >100% of parent time. This is normal as not all functions await their async calls.

Full example:

cd yarn-project
./bootstrap.sh instrumented_profile "cd end-to-end; LOG_LEVEL=info yarn test e2e_prover/client"
scripts/instrumenting-profiler/print.mjs end-to-end/profile-0.json --min-ms 100 --exclude anon