README.md

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

• Install Rust and Cargo (probably with rustup)
• Install Wasm-pack
• Install cargo-watch: cargo install cargo-watch
• Install Node.js however you like (at least version 20)
• Install pnpm (probably via corepack)
• Install Google Chrome

Building

Once you have all these tools, you can

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

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

Minifront 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 security@penumbralabs.xyz.