penumbra-zone / web

Apache License 2.0
15 stars 16 forks source link

Penumbra Web

The Penumbra monorepo for all things web.

ci status

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

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.