Skip to content

Commit 4ba9c7f

Browse files
committedJul 23, 2024
clean up
1 parent fc49988 commit 4ba9c7f

11 files changed

+39
-68
lines changed
 

‎pages/SUMMARY.md

-38
This file was deleted.

‎pages/_meta.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
2-
"index": "Penumbra Guide",
2+
"index": "Overview",
33
"web": "Using Penumbra on the web",
44
"pcli": "Using Penumbra from the command line",
55
"node": "Running a node",
6+
"frontend": "Running a frontend",
67
"dev": "Development",
7-
"resources": "Resources",
8-
"tutorials": "Tutorials"
9-
}
8+
"resources": "Resources"
9+
}

‎pages/frontend.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Penumbra's web tooling is designed to support a decentralized ecosystem of
2+
frontends. This allows different frontend codebases to focus on different user
3+
profiles and ensures that no single frontend deployment or codebase has control
4+
over users' access to the protocol.
5+
6+
Penumbra wallets like [Prax] sync, scan, decrypt, and locally index user data. When users connect to a frontend, the wallet acts as a "personal RPC", granting that frontend access to the user's private data.
7+
8+
This chapter has information about deploying a Penumbra frontend, for users who do not wish to rely on existing third-party frontends:
9+
10+
- [**Minifront**](./frontend/minifront.md): the minimal, embeddable static-site
11+
frontend that runs entirely on the end-user device. A (possibly outdated) copy of Minifront is embedded in every single Penumbra fullnode and served on the RPC endpoint, but it can also be hosted standalone.
12+
13+
[Prax]: https://chromewebstore.google.com/detail/prax-wallet/lkpmkhpnhknhmibgnmmhdhgdilepfghe

‎pages/frontend/_meta.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"minifront": "Minifront"
3+
}

‎pages/tutorials/running-frontend.md ‎pages/frontend/minifront.md

+6-15
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,13 @@
1-
# Running a frontend
2-
3-
In order to use the [Prax] wallet web extension, users must visit a trusted
4-
website that leverages the web extension in order to interact with the [Penumbra] network.
5-
While users can choose to grant access to website run by a party they trust,
6-
this guide demonstrates how a user can self-host a frontend for use by themselves and others.
7-
8-
## About minifront
9-
101
[Minifront] is minimal frontend for interacting with the [Penumbra] chain.
112
A number of technical decisions were made to ensure minifront is maximally client side and does not leak
123
information unnecessarily:
134

14-
- Client-side biased js framework ✅ Hash routing
15-
- Pre-load all static assets ⚠️ (in progress...)
16-
- Server rendering
17-
- Route-based code splitting
18-
- Idiomatic urls & query params
19-
- Build-time pre-rendering
5+
- Client-side biased js framework with hash routing
6+
- Pre-load all static assets (in progress...)
7+
- Server rendering
8+
- Route-based code splitting
9+
- Idiomatic urls & query params
10+
- Build-time pre-rendering
2011

2112
[Read more](https://x.com/grod220/status/1760217326245285923) about how this frontend embraces censorship resistance and
2213
privacy.

‎pages/index.mdx

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
# Penumbra Guide
2-
3-
[Penumbra] is a fully private, cross-chain proof-of-stake network and
1+
Penumbra is a fully private, cross-chain proof-of-stake network and
42
decentralized exchange for the Cosmos and beyond. Penumbra brings privacy to
53
IBC, allowing anyone to shield any IBC asset just by transferring it into
64
Penumbra's multi-asset shielded pool. Within Penumbra, users can transact,
75
stake, swap, or marketmake without broadcasting their personal information to
86
the world.
97

108
<picture>
11-
<img src="./assets/interchain-shielded-pool.jpg" />
9+
<img src="./images/interchain-shielded-pool.jpg" />
1210
</picture>
1311

1412
Unlike a transparent chain, where all information is public, Penumbra is

‎pages/node/_meta.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"pd": "Full node: `pd`",
3-
"pclientd": "Ultralight node: `pclientd`"
4-
}
2+
"pd": "Full node: pd",
3+
"pclientd": "Ultralight node: pclientd"
4+
}

‎pages/node/pd/install.md ‎pages/node/pd/install.mdx

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import { PENUMBRA_VERSION, COMETBFT_VERSION } from '../../../versions.js';
2+
13
# Installing pd
24
There are many ways to configure and run Penumbra. The easiest is to download
35
binaries for `pd` and `cometbft` on a Linux system. For alternatives, see
@@ -12,7 +14,7 @@ match the software currently running on the network, to choose the correct platf
1214
After downloading the `.tar.gz` file, extract it, and copy its contents to your `$PATH`. For example:
1315

1416
```
15-
curl -sSfL -O https://github.com/penumbra-zone/penumbra/releases/download/{{ #include ../../penumbra_version.md }}/pd-x86_64-unknown-linux-gnu.tar.gz
17+
curl -sSfL -O https://github.com/penumbra-zone/penumbra/releases/download/v0.79.2/pd-x86_64-unknown-linux-gnu.tar.gz
1618
tar -xf pd-x86_64-unknown-linux-gnu.tar.gz
1719
sudo mv pd-x86_64-unknown-linux-gnu/pd /usr/local/bin/
1820
@@ -25,7 +27,7 @@ There's also a one-liner install script available on the release page, which wil
2527
### Installing CometBFT
2628

2729
You'll need to have [CometBFT installed](https://docs.cometbft.com/v0.37/guides/install) on your system to join your node to the testnet.
28-
You must use a compatible version of CometBFT. Any version in the `v0.37.x` series will work, such as `{{ #include ../../cometbft_version.md }}`,
29-
which you can download [from the CometBFT releases page](https://github.com/cometbft/cometbft/releases/tag/{{ #include ../../cometbft_version.md }}).
30+
You must use a compatible version of CometBFT. Any version in the `v0.37.x` series will work, such as `v0.37.9`,
31+
which you can download [from the CometBFT releases page](https://github.com/cometbft/cometbft/releases/tag/v0.37.9).
3032
If you prefer to compile from source instead, make sure you are compiling the correct version by checking out its tag
3133
in the CometBFT repo before building.

‎pages/pcli/_meta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"install": "Installing `pcli`",
2+
"install": "Installing pcli",
33
"wallet": "Generating a Wallet",
44
"update": "Updating to the latest testnet",
55
"balance": "Viewing Balances",
998 KB
Loading

‎versions.js

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export const PENUMBRA_VERSION = 'v0.79.1';
2+
export const COMETBFT_VERSION = 'v0.37.9';

0 commit comments

Comments
 (0)
Please sign in to comment.