Penumbra Web

The Penumbra monorepo for all things web.

This is a monolithic repository of Penumbra web code, a monorepo. Multiple apps, internal packages, and published packages are developed in this repository, to simplify work and make broad cross-package changes more feasible.

To participate in the test network, use a browser extension like Prax from the Chrome Web Store.

You can talk to us on Discord.

You might be looking for examples

@penumbra-zone/client nextjs example

@penumbra-zone/wasm nextjs example

What's in here

Minifront: Dapp to swap, stake, and send on the Penumbra testnet.

Status: Public info dashboard for Penumbra nodes.

Published Packages

All have a @penumbra-zone/ namespace prefix on npm.

🌘 bech32m 🌑 client 🌑 constants 🌑 crypto 🌑 getters 🌑 keys 🌑 perspective 🌑 protobuf 🌑 services 🌑 services-context 🌑 storage 🌑 transport-chrome 🌑 transport-dom 🌑 types 🌑 wasm 🌒

Documentation

General documentation is available in docs/README.md. Package-specific documentation is available in each respective package.

Getting Started

Prerequisites

Make sure you have the following tools installed:

• Rust and Cargo – Recommended via rustup
• wasm-pack – For building WebAssembly components
• cargo-watch – Utility that automatically rebuilds and restarts your project.
• Node.js – Recommended via nvm
• pnpm – Package manager, recommended via corepack
• Google Chrome installation

Building

Install all workspace dependencies:

git clone https://github.com/penumbra-zone/web
cd web
pnpm install

Build shared packages and watch for changes:

pnpm build && pnpm dev:pack

In a new terminal, run the minifront app:

cd apps/minifront
pnpm dev:build && pnpm dev:app

Alternatively, in a new terminal, run the veil app:

cd apps/veil
pnpm install && pnpm dev

You now have a local copy of Minifront available at https://localhost:5173 or Veil available at https://localhost:3000.

Minifront and Veil will hot-reload.

Security

If you believe you've found a security-related issue with Penumbra, please disclose responsibly by contacting the Penumbra Labs team at [email protected].