https://github.com/penumbra-zone/web
https://github.com/penumbra-zone/web
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/penumbra-zone/web
- Owner: penumbra-zone
- License: apache-2.0
- Created: 2023-08-04T19:38:12.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-04T10:04:56.000Z (12 months ago)
- Last Synced: 2025-08-28T19:03:16.045Z (11 months ago)
- Language: TypeScript
- Homepage:
- Size: 74.9 MB
- Stars: 20
- Watchers: 7
- Forks: 30
- Open Issues: 191
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
- awesome-ccamel - penumbra-zone/web - (TypeScript)
README
# Penumbra Web
The [Penumbra](https://penumbra.zone/) 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](https://chrome.google.com/webstore/detail/penumbra-wallet/lkpmkhpnhknhmibgnmmhdhgdilepfghe)
from the Chrome Web Store.
You can talk to us on [Discord](https://discord.gg/hKvkrqa3zC).
## You might be looking for examples
### [`@penumbra-zone/client` nextjs example](https://github.com/penumbra-zone/nextjs-penumbra-client-example)
### [`@penumbra-zone/wasm` nextjs example](https://github.com/penumbra-zone/nextjs-penumbra-wasm-example)
## What's in here
### [Minifront](./apps/minifront): Dapp to swap, stake, and send on the Penumbra testnet.
### [Status](./apps/node-status): Public info dashboard for Penumbra nodes.
### Published Packages
All have a `@penumbra-zone/` namespace prefix on npm.
**🌘
[bech32m](https://www.npmjs.com/package/@penumbra-zone/bech32m) 🌑
[client](https://www.npmjs.com/package/@penumbra-zone/client) 🌑
[constants](https://www.npmjs.com/package/@penumbra-zone/constants) 🌑
[crypto](https://www.npmjs.com/package/@penumbra-zone/crypto) 🌑
[getters](https://www.npmjs.com/package/@penumbra-zone/getters) 🌑
[keys](https://www.npmjs.com/package/@penumbra-zone/keys) 🌑
[perspective](https://www.npmjs.com/package/@penumbra-zone/perspective) 🌑
[protobuf](https://www.npmjs.com/package/@penumbra-zone/protobuf) 🌑
[services](https://www.npmjs.com/package/@penumbra-zone/services) 🌑
[services-context](https://www.npmjs.com/package/@penumbra-zone/services-context) 🌑
[storage](https://www.npmjs.com/package/@penumbra-zone/storage) 🌑
[transport-chrome](https://www.npmjs.com/package/@penumbra-zone/transport-chrome) 🌑
[transport-dom](https://www.npmjs.com/package/@penumbra-zone/transport-dom) 🌑
[types](https://www.npmjs.com/package/@penumbra-zone/types) 🌑
[wasm](https://www.npmjs.com/package/@penumbra-zone/wasm)
🌒**
## Documentation
General documentation is available in [docs/README.md](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](https://doc.rust-lang.org/cargo/getting-started/installation.html) – Recommended via [rustup](https://rustup.rs/)
- [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) – For building WebAssembly components
- [cargo-watch](https://crates.io/crates/cargo-watch) – Utility that automatically rebuilds and restarts your project.
- [Node.js](https://nodejs.org/en/download/package-manager) – Recommended via [nvm](https://github.com/nvm-sh/nvm)
- [pnpm](https://pnpm.io/installation) – Package manager, recommended via [corepack](https://pnpm.io/installation#using-corepack)
- Google Chrome installation
### Building
#### Install all workspace dependencies:
```sh
git clone https://github.com/penumbra-zone/web
cd web
pnpm install
```
#### Build shared packages and watch for changes:
```sh
pnpm build && pnpm dev:pack
```
#### In a new terminal, run the minifront app:
```sh
cd apps/minifront
pnpm dev:build && pnpm dev:app
```
#### Alternatively, in a new terminal, run the veil app:
```sh
cd apps/veil
pnpm install && pnpm dev
```
You now have a local copy of Minifront available at
[`https://localhost:5173`](https://localhost:5173) or Veil available at [`https://localhost:3000`](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
security@penumbralabs.xyz.