Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Testnet Documentation #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: Testnet Documentation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 86 additions & 0 deletions testnets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<div>
<img src="https://avatars.githubusercontent.com/u/99333377?s=48&v=4" align="left" width="35" style="margin-right: 15px"/>
<h1>
Nillion Testnets
</h1>
<p> This repository contains information on Nillion public testnets and devnets </p>
<br>
</div>

| Chain ID | Type | Status | Version | Notes |
|---------------------------------------|-----------|------------|---------------|---------------------------|
| [nillion-testnet-1](./testnets/nillion-testnet-1) | `testnet` | **Inactive** | `v0.1.0` | Testnet |
| [devnet](./devnets/) | `devnet` | **Beta** | `v0.1.0` | Devnet with mainnet state |

## Testnets

Testnets are a type of blockchain used exclusively for testing purposes. They function as a sandbox environment, allowing developers to test new code and functionalities without worrying about affecting the live blockchain (mainnet). They are persistent environments, meaning that they remain active for extended periods of time.

Testnets come with a range of integrated services, including relayers to other testnets, frontends, explorers, and snapshot services.

### nillion-testnet-1

| Chain ID | `nillion-testnet-1` |
|------------------|----------------------------------------------------|
| Nilliond version | `v0.1.0` |
| Genesis | <http://genesis.testnet.nillion.com/genesis.json> |
| RPC | <https://rpc.testnet.nillion.com> |
| gRPC | <https://grpc.testnet.nillion.com> |
| REST | <https://lcd.testnet.nillion.com> |
| Faucet | <https://faucet.testnet.nillion.com> |
| Explorer | <https://explorer.testnet.nillion.com> |
| Snapshots | <https://snapshots.testnet.nillion.com> |
| Frontend | <https://testnet.nillion.com> |

#### Join the testnet

Join the testnet following the instructions on the [nillion-testnet-1 page](./testnets/nillion-testnet-1/README.md).

## Devnets

Devnets, short for development networks, are also used for testing new functionalities and code. However, unlike testnets, devnets are temporary environments.

Devnets are ephemeral, which means they do not persist state long term and are recreated on an ongoing basis. This ensures that the testing environment closely mirrors the current state of the latest nillion codebase. Devnets are minimal environments, consisting only of a validator. Unlike testnets, devnets do not feature frontends or relayers to other testnets.

### devnet

| Chain ID | `devnet` |
|------------------|--------------------------------------------------------------------------|
| Nilliond version | `v0.1.0` |
| Genesis | <https://nillion.com/devnet/genesis.json> |
| Starting Height | <https://nillion.com/devnet/height> |
| RPC | <https://rpc.devnet.nillion.com> |
| REST | <https://lcd.devnet.nillion.com> |
| gRPC | `grpc.devnet.nillion.com:30090` |
| websocket | `wss://rpc.devnet.nillion.com:443/websocket` |
| Faucet | <https://faucet.devnet.nillion.com> |
| Seed Node | `[email protected]:30056` |

## 🆘 Issues and support

If you encounter any issues while joining the Nillion network or have questions about the process, please don't hesitate to reach out for support.

- For general questions and community support, join the [Nillion Discord](https://discord.com/) and ask in the `#testnet` channel.

- For technical issues or bugs related to the testnet, submit a detailed issue report on this repository with a clear description of the problem and any relevant error messages or logs.

## 🙋‍♀️ FAQ

**1) I need some funds on the `nillion-testnet-1` testnet, how can I get them?**

You can request testnet tokens for the `nillion-testnet-1` testnet from the faucet available at <https://faucet.testnet.nillion.com>. Please note that the faucet currently dispenses up to 500 NILLION per day per address.

**2) I am an integrator on the `nillion-testnet-1` testnet. How can I request more funds?**

If you are an integrator needing additional testnet tokens for development or testing purposes, you can request them via [this form](https://form-integrators.testnet.nillion.com). Please provide detailed information about your project and the number of tokens you require, and our team will review your request as soon as possible.

**3) What are the differences between testnets and devnets?**

| **Features** | **Testnets** | **Devnets** |
|--------------|--------------------------|--------------------------------------------------|
| Persistent | ✅ | ❌ |
| State | Maintains its own state. | Forks of the mainnet, mimicking its state. |
| Faucet | ✅ | ✅ |
| Explorer | ✅ | ❌ |
| Frontend | ✅ | ❌ |
| Relayers | ✅ | ❌ |
33 changes: 33 additions & 0 deletions testnets/devnets/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# devnet

> This page is a work in progress. Please check back later for more information.

## Details

| Chain ID | `devnet` |
|------------------|-----------------------------------------------------------------------|
| Nilliond version | `v0.1.0` |
| Genesis | <https://nillion.com/devnet/genesis.json> |
| Starting Height | <https://nillion.com/devnet/height> |

### Public Nodes

| Protocol | Url |
|-----------|-----------------------------------------------|
| RPC | <https://rpc.devnet.nillion.com> |
| REST | <https://lcd.devnet.nillion.com> |
| gRPC | `grpc.devnet.nillion.com:30090` |
| websocket | `wss://rpc.devnet.nillion.com:443/websocket` |

### 🌱 Seed

| Node | ID |
|-----------|--------------------------------------------------------------------------|
| Seed Node | `[email protected]:30056` |

### 🚰 Faucet

The `devnet` testnet faucet is available at <https://faucet.devnet.nillion.com>

Given that this devnet is a state export, your mainnet funds would be available on the `devnet` as testnet tokens.
Please be extremely careful about explicitly checking the `chain-id` before signing any transactions.
23 changes: 23 additions & 0 deletions testnets/testnets/nillion-testnet-1/IBC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# IBC Resources

## 📺 IBC Channels

| src-chain-id | dst-chain-id | src-channel | dst-channel | Note |
|---------------|---------------------------|---------------|----------------|---------------------|
| `nillion-testnet-1` | `test-chain` | `channel-0` | `channel-0` | Example channel |

## 🫰 IBC Assets

The following are all the assets currently supported by `nillion-testnet-1` along with their corresponding IBC denomination.

When assets are transferred through IBC, they lose their base denomination (i.e `akt`) and obtain a new IBC denomination (e.g. `ibc/7153C8C55DB988805FAC69E449B680A8BAAC15944B87CF210ADCD1A3A9542857`).

| Token | Base Denom | IBC Denom |
|-------------|------------|------------------------------------------------------------------------|
| EXAMPLE-TOKEN | `amazingcoin` | `ibc/A8C2D23A1E6F95DA4E48BA349667E322BD7A6C996D8A4AAE8BA72E190F3D1477` |

## 🧑‍💻 IBC Development

### 🇰 Add chains to keplr wallet

You can add the nillion-testchain-1 chain to your Keplr wallet, as well as all other connected chains, at: <https://keplr.testnet.nillion.com/>
78 changes: 78 additions & 0 deletions testnets/testnets/nillion-testnet-1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# nillion-testnet-1 testnet

## Details

| Chain ID | `nillion-testnet-1` |
|-------------------|---------------------------------------------------------------------------------|
| Launch Date | 20th May 2024 |
| Nilliond version | `v0.1.0` |
| Genesis | <https://github.com/NillionNetwork/networks/raw/main/nillion-testnet-1/genesis.tar.bz2> |
| Genesis SHA256SUM | `7f84b50c0ad65582c9c52126cd33443c9f2541436ea4c525106ed9b58f7c9ef4` |

## Endpoints

Summary of the `nillion-testnet-1` endpoints:

| Service | Url |
|-------------|----------------------------------------------------------------------------------------------------------------------------------------|
| Public RPC | <https://rpc.nilliontest1.nillion.com> |
| Public LCD | <https://grpc.nilliontest1.nillion.com> |
| Public gRPC | <https://lcd.nilliontest1.nillion.com> |
| Faucet | <https://facet.nilliontest1.nillion.com> |
| Seed Node | `[email protected]:26656` |
| Peers | `[email protected]:26656` <br/> `[email protected]:26656` |
| Explorer | <https://testnet.mintscan.io/nillion-testnet> |
| Frontend | <https://app.nillion.com> |

### Public Nodes

| Protocol | Url |
|----------|-------------------------------------|
| RPC | <https://rpc.testnet1.nillion.com> |
| gRPC | <https://grpc.testnet1.nillion.com> |
| REST | <https://lcd.testnet1.nillion.com> |

### 🌱 Seed

| Node | ID |
|------|------------------------------------------------------------------|
| Seed | `[email protected]:26656` |

Add the Node ID in your `p2p.seeds` section of you `config.toml`:

```toml
#######################################################
### P2P Configuration Options ###
#######################################################
[p2p]

# ...

# Comma separated list of seed nodes to connect to
seeds = "[email protected]:26656"
```

### 🚰 Faucet

The `nillion-testnet-1` testnet faucet is available at <https://faucet.testnet1.nillion>

## Join the network

Before joining the network, ensure that your system meets the following minimum requirements:

- 4 CPU
- 8GB RAM
- 100GB free disk space

To join the Nillion network, there are various options available. Choose the option that works best for you based on your preferences and technical requirements.

1. (Manual) Manual setup

### Option: Manual setup

1. Download the `nilliond` binary:
2. Initialize the node:
3. Download genesis
4. Download the latest snapshot:
5. Set the seed node in the `config.toml`:
6. Start the node:
3 changes: 3 additions & 0 deletions testnets/testnets/nillion-testnet-1/genesis/genesis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"genesis": "empty"
}
19 changes: 19 additions & 0 deletions testnets/testnets/previous/incident-reports.md/template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# $date $testnet-id $title

| &nbsp; | &nbsp; |
|----------|--------------------------------------------------|
| Incident | $REASON |
| Chain-id | $CHAIN-ID |
| Date | $DATE |
| Block | $BLOCKHEIGHT |
| Authors | $FIRSTNAME-LASTNAME |

## Overview

## Incident Details

## Root Cause

## Impact

## Remediation Measures
Loading