Skip to content

Latest commit

 

History

History
106 lines (86 loc) · 4.13 KB

README.md

File metadata and controls

106 lines (86 loc) · 4.13 KB
Raw

Docs

First read Getting Started

These handy scripts may be executed directly in an app or package directory, in which case they only execute that package's script, or in the top level of the repo, in which case they use turbo or the monorepo configuration.

  • pnpm clean: remove build outputs.
  • pnpm compile: compile rust into wasm.
  • pnpm build: transform and bundle all packages and apps.
  • pnpm dev: build all, serve local apps. watch and rebuild continuously.
  • pnpm test: run vitest only. cargo tests are omitted.
  • pnpm test:wasm: run rust tests only.
  • pnpm format, pnpm lint
  • pnpm all-check: check all!

Subject documents

Tools used

  • pnpm: a package manger
    • pnpm's workspace feature is the foundation of the monorepo
  • turborepo: a monorepo scripting tool
    • parallelize script execution
    • manage execution dependency
    • cache outputs to accelerate execution
  • syncpack: a monorepo dependency manager
    • synchronize package dependencies
    • validate dependency version ranges with configurable rules
    • format and lint package json
  • changeset: a monorepo version manager
    • increment semver in a topological way
    • progressively compile release notes as PRs merge
  • vite: a bundler/dev server
    • vite bundles monorepo apps for deployment
    • vite's lib mode also builds and bundles some packages
  • vitest: a testing framework
    • vitest is workspace-aware
    • testing and bundling can use the same vite config
    • vitest provides in-browser testing via playwright

The Basics

Local, compact chain state

Minifront is a webapp blob which stores no state, and executes locally on the user's browser. Prax is a browser extension on the user's local machine, where it manages keys, configuration, and an abbreviated chain representing only the user's activity.

Simplified architecture

Minifront (and eventually other dapps) connect to services hosted by Prax (and eventually other providers) for information on the user's chain state, and to conduct new activity.

Prax queries a remote 'full node' pd endpoint to scan the compact chain, download full block details when interested, and broadcast new chain activity. Omitting the remote endpoint, it looks something like this:

Penumbra web architecture chart

Some critical details

Prax and Minifront share React components and some other reuseable dependencies.

Both Prax and Minifront manage running state with Zustand. For storage, Prax uses extension storage and idb. Minifront does not store anything.

Prax parallelizes WASM during transaction builds by launching individual web workers for each chunk of work. Chrome extension workers can't launch web workers, so this is managed via the 'Offscreen' feature of the chrome extension API which provides full DOM compatibility.

WASM directly accesses IDB for some operations, outside of the typical interface.