Skip to content

Commit

Permalink
guide: remove many (not all) outdated references to testnets/testnet …
Browse files Browse the repository at this point in the history
…tokens (#15)
  • Loading branch information
aubrika authored Jul 26, 2024
1 parent eb9ffb9 commit aca2220
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 71 deletions.
2 changes: 1 addition & 1 deletion pages/dev/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Once you have installed the above packages, you can clone the repository:
git clone https://github.com/penumbra-zone/penumbra
```

To build the versions of `pcli`, `pd`, etc. compatible with the current testnet,
To build the versions of `pcli`, `pd`, etc. compatible with the current network,
navigate to the `penumbra/` folder, fetch the latest from the repository, and check out the
latest tag from the [releases page](https://github.com/penumbra-zone/penumbra/releases).
Currently, that tag is <code>{PENUMBRA_VERSION}</code>. Substitute that value for `<TAG>`
Expand Down
13 changes: 1 addition & 12 deletions pages/dev/rpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,7 @@ building software that interoperates with Penumbra.

## Using gRPC UI

The Penumbra Labs team runs [gRPC UI] instances for testnet deployments:

* For the current testnet: [https://grpcui.testnet.penumbra.zone](https://grpcui.testnet.penumbra.zone)
* For rapid-release preview: [https://grpcui.testnet-preview.penumbra.zone](https://grpcui.testnet-preview.penumbra.zone)

You can use this interface to perform queries against the relevant chain.
You can use the [gRPC UI] interface to perform queries against a node's gRPC endpoint.
It's also possible to run gRPC UI locally on your machine, to connect
to a local devnet.

Expand All @@ -23,12 +18,6 @@ and [comprehensive documentation](https://buf.build/docs/bsr/studio). However,
a significant limitation for use with Penumbra is that it lacks
support for streaming requests, such as [`penumbra.core.component.compact_block.v1.CompactBlockRangeRequest`](https://buf.build/penumbra-zone/penumbra/docs/main:penumbra.core.component.compact_block.v1#penumbra.core.component.compact_block.v1.CompactBlockRangeRequest).

To get started with Buf Studio, you can use the publicly available gRPC endpoint
from the testnet deployments run by Penumbra Labs:

* For the current testnet, use `https://grpc.testnet.penumbra.zone`
* For ephemeral devnets, use `https://grpc.testnet-preview.penumbra.zone`

Set the request type to **gRPC-web** at the bottom of the screen.
You can then select a **Method** and explore the associated services.
Click **Send** to submit the request and view response data in the right-hand pane.
Expand Down
2 changes: 1 addition & 1 deletion pages/node/pd/chain-upgrade.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ so that your node state is recoverable.
1. Stop both `pd` and `cometbft`. Depending on how you run Penumbra, this could mean `sudo systemctl stop penumbra cometbft`.
2. Download the latest version of `pd` and install it. Run `pd --version` and confirm you see "{PENUMBRA_VERSION}" before proceeding.
3. Optionally, use `pd export` to create a snapshot of the `pd` state.
4. Apply the migration with `pd migrate --home PD_HOME --comet-home COMETBFT_HOME`. If using the default home locations (from `pd testnet join`), you can omit the paths and just run `pd migrate`.
4. Apply the migration with `pd migrate --home PD_HOME --comet-home COMETBFT_HOME`. If using the default home locations (from `pd network join`), you can omit the paths and just run `pd migrate`.

Finally, restart the node, e.g. `sudo systemctl restart penumbra cometbft`. Check the logs, and you should see the chain progressing
past the halt height `n`.
2 changes: 1 addition & 1 deletion pages/node/pd/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ There's also a one-liner install script available on the release page, which wil

### Installing CometBFT

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.
You'll need to have [CometBFT installed](https://docs.cometbft.com/v0.37/guides/install) on your system to join your node to the network.
You must use a compatible version of CometBFT. Any version in the `v0.37.x` series will work, such as <code>{COMETBFT_VERSION}</code>,
which you can download [from the CometBFT releases page](https://github.com/cometbft/cometbft/releases/).
If you prefer to compile from source instead, make sure you are compiling the correct version by checking out its tag
Expand Down
3 changes: 1 addition & 2 deletions pages/node/pd/join-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ what a fullnode is, see the [CometBFT
documentation](https://docs.cometbft.com/v0.37/core/using-cometbft#adding-a-non-validator).

A regular validator will participate in voting and rewards, if it becomes part
of the consensus set. Of course, these rewards, like all other testnet tokens,
have no value.
of the consensus set.

## Generating configs

Expand Down
7 changes: 3 additions & 4 deletions pages/pcli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
This section describes how to use `pcli`, the command line client for Penumbra:

- [Installation](./pcli/install.md) describes how to compile and run `pcli`;
- [Generating a Wallet](./pcli/wallet.md) describes how to generate a wallet and use the testnet faucet;
- [Updating pcli](./pcli/update.md) describes how to update to a newly released testnet from a previous testnet;
- [Generating a Wallet](./pcli/wallet.md) describes how to generate a wallet;
- [Viewing Balances](./pcli/balance.md) describes how to view balances;
- [Sending Transactions](./pcli/transaction.md) describes how to send funds.

Expand All @@ -15,11 +14,11 @@ synchronizes with the chain and scans with a viewing key.
### Please submit any feedback and bug reports

Thank you for helping us test the Penumbra network! If you have any feedback, please let us know in
the `#testnet-feedback` channel on our [Discord](https://discord.gg/hKvkrqa3zC). We would love to know about bugs, crashes,
the `#general` channel on our [Discord](https://discord.gg/hKvkrqa3zC). We would love to know about bugs, crashes,
confusing error messages, or any of the many other things that inevitably won't quite work yet. Have
fun! :)

### Diagnostics and Warnings

By default, `pcli` prints a warning message to the terminal, to be sure that people understand that this is *unstable, unfinished, pre-release software*.
By default, `pcli` prints a warning message to the terminal, to be sure that people understand that this is _unstable, unfinished, pre-release software_.
To disable this warning, export the `PCLI_UNLEASH_DANGER` environment variable.
2 changes: 1 addition & 1 deletion pages/pcli/balance.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Syncing is performed automatically, but running the `sync` subcommand will
ensure that the client state is synced to a recent state, so that future
invocations of `pcli` commands don't need to wait.

If someone sent you testnet assets, you should be able to see them now by running:
If someone sent you assets, you should be able to see them now by running:

```bash
pcli view balance
Expand Down
4 changes: 2 additions & 2 deletions pages/pcli/transaction.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sending Transactions

Now, for the fun part: sending transactions. If you have someone else's testnet address, you can
Now, for the fun part: sending transactions. If you have someone else's address, you can
send them any amount of any asset you have.

First, use balance to find the amount of assets you have:
Expand Down Expand Up @@ -154,7 +154,7 @@ enough liquidity available to perform the swap.

## Replicating a UniswapV2 (`x*y=k`) pool

Penumbra's constant-price pool is a versatile market primitive, allowing users extensive control over their trading strategies. It's not solely for active DEX quoters; with our AMM replication tool, users can emulate any passive AMM of their choice. The testnet comes with a built-in UniswapV2 replicator that is utilized as such:
Penumbra's constant-price pool is a versatile market primitive, allowing users extensive control over their trading strategies. It's not solely for active DEX quoters; with our AMM replication tool, users can emulate any passive AMM of their choice. The protocol comes with a built-in UniswapV2 replicator that is utilized as such:

```bash
pcli tx lp replicate xyk <TRADING_PAIR> <QUANTITY> [--current-price AMT] [--fee-bps AMT]
Expand Down
11 changes: 0 additions & 11 deletions pages/pcli/wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,6 @@ Address is viewable with this full viewing key. Account index is 0.
Addresses are opaque and do not reveal account information. Only you, or someone
who has your viewing key, can decrypt the account information from the address.

## Getting testnet tokens on Discord in the `#testnet-faucet` channel

In order to use the testnet, it's first necessary for you to get some testnet tokens. The current
way to do this is to join our [Discord](https://discord.gg/hKvkrqa3zC) and post your address in the `#testnet-faucet` channel.
We'll send your address some tokens on the testnet for you to send to your friends! :)

Just keep in mind: **testnet tokens do not have monetary value**, and in order to keep the
signal-to-noise ratio high on the server, requests for tokens in other channels will be deleted
without response. Please do not DM Penumbra Labs employees asking for testnet tokens; the correct
venue is the dedicated channel.

## Validator custody

Validators need to custody more kinds of key material than ordinary users. A validator operator has
Expand Down
37 changes: 1 addition & 36 deletions pages/web.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ on a different machine. Make sure to store both the passphrase and the recovery
securely, for example in a password manager.

Re-enter portions of the recovery phrase when prompted, to confirm that you've saved it properly.
Then you'll be taken to a screen that shows an initial synchronization process with the most
recent testnet:
Then you'll be taken to a screen that shows an initial synchronization process with the selected network:

<!--
Do we want to maintain screenshots inside the web extension docs?
Expand All @@ -39,24 +38,6 @@ The image files will become out of data quickly, requiring maintenance, and bloa
<img src="images/web-extension-sync-progress.png" />
</picture>

## Obtaining funds

In order to use the testnet, it's first necessary for you to get some testnet
tokens. To obtain your address, click on the extension icon. The drop-down
should display your wallet address and a button to copy it to the clipboard.
Next, join our [Discord](https://discord.gg/hKvkrqa3zC) and post your address in
the `#testnet-faucet` channel. We'll send your address some tokens on the
testnet for you to send to your friends! :)

In addition, addresses posted to the testnet faucet are periodically rolled into
the testnet genesis file, so that in future testnets your address will have
testnet tokens pre-loaded.

Just keep in mind: **testnet tokens do not have monetary value**, and in order
to keep the signal-to-noise ratio high on the server, requests for tokens in
other channels will be deleted without response. Please do not DM Penumbra Labs
employees asking for testnet tokens; the correct venue is the dedicated channel.

## Creating transactions

Now that you've got the web wallet configured, let's use it to send a
Expand All @@ -66,22 +47,6 @@ click **Connect**, then authorize the extension to work with the site. After
doing so, you'll see buttons for actions such as **Receive**, **Send**, and
**Exchange**.

## Upgrading to a new testnet

When a new testnet is released, you'll need to clear the existing state
from the extension, much like running `pcli view reset` is required
on the command-line. To synchronize with a new testnet:

1. Click the *Penumbra Wallet* option in the extensions drop-down menu,
next to the URL bar.
2. Unlock the wallet by providing your passphrase, if prompted.
3. Click the gear icon in the top right corner of the overlay.
4. Choose **Advanced -> Clear Cache -> Confirm**.

Then navigate to [https://app.testnet.penumbra.zone/](https://app.testnet.penumbra.zone/)
again and reauthorize the connection. The extension will automatically sync
with the new chain.

## Updating to a new version of the extension

The extension should be automatically updated every time a new version is released.
Expand Down

0 comments on commit aca2220

Please sign in to comment.