Skip to content

Commit

Permalink
Merge pull request #41 from NillionNetwork/june-release
Browse files Browse the repository at this point in the history
add testnet guides for June 3 testnet release
  • Loading branch information
oceans404 authored Jun 3, 2024
2 parents 3f7f97c + 87ff5f1 commit e1e8853
Show file tree
Hide file tree
Showing 22 changed files with 282 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/_quickstart-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ Start building on Nillion. The quickstart walks you through

1. Installing the [Nillion SDK](/nillion-sdk-and-tools)
2. Setting up a developer environment
3. Running [nillion-devnet](/nillion-devnet), a local Nillion network
3. Running and connecting to [nillion-devnet](/nillion-devnet), a local Nillion network
4. Writing your first [Nada](/nada-lang) program, `tiny_secret_addition.py`
5. Connecting to the network with the [NillionClient](nillion-client) to store programs, store secrets, and compute on programs with stored secrets.
2 changes: 2 additions & 0 deletions docs/_testnet_block_explorers.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [explorers.guru](https://testnet.nillion.explorers.guru/)
- [ping.pub](https://testnet.ping.pub/nillion/)
2 changes: 2 additions & 0 deletions docs/_testnet_supported_wallets.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [Keplr](https://www.keplr.app/)
- [Leap](https://www.leapwallet.io/)
2 changes: 1 addition & 1 deletion docs/data-wars.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data Wars: Community Ranks

This is not the allowlist you are looking you're looking for.
This is not the allowlist you are looking you're looking for. Join the multi-week [Nillion bootcamp](https://zealy.io/cw/nillion) to be fully onboarded into the Nil Army. Every week you will have the potential to be whitelisted for the upcoming Nillion Blindfolded PFP NFT release.

![An image from the static](/img/data-wars.png)

Expand Down
8 changes: 6 additions & 2 deletions docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Masked factors are the protect factors in the Sum of Products. Masked factors ar

The one-time mask is the multiplicative mask that protects a factor. 

#### Privacy-enhancing technologies (PETs)

Privacy-enhancing technologies (PETs) are technologies that embody fundamental data protection principles by minimizing personal data use, maximizing data security, and empowering individuals.

#### Share

The share is the result that a node obtains by multiplying all the masked factors, and adding up all the products of those masked factors using the sum-of-products expression shape.
Expand All @@ -55,5 +59,5 @@ x^2 + 2xy + y^2

#### Sum of Products (SoP) - **Factors and Terms** <a href="#factors-and-terms" id="factors-and-terms"></a>

* **Terms**: In SoP, a term is a product of factors that are multiplied together. In the example SoP, the terms are (a \* b) and (c \* d). Each term represents a multiplication operation between its factors.
* **Factor:** Factors are the individual elements that are multiplied together within a term. In the example SoP, a and b are factors in the (a\*b) term. c and d are factors in the (c\*d) term. They are the basic building blocks of a term.
- **Terms**: In SoP, a term is a product of factors that are multiplied together. In the example SoP, the terms are (a \* b) and (c \* d). Each term represents a multiplication operation between its factors.
- **Factor:** Factors are the individual elements that are multiplied together within a term. In the example SoP, a and b are factors in the (a\*b) term. c and d are factors in the (c\*d) term. They are the basic building blocks of a term.
73 changes: 73 additions & 0 deletions docs/guide-testnet-connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import IframeVideo from '@site/src/components/IframeVideo/index';
import SupportedWallets from './\_testnet_supported_wallets.mdx';

# Creating a Nillion Wallet

Create a Nillion wallet to connect to the [Nillion Testnet](/network#nillion-testnet-coordination-layer) and access your assets.

## Supported Wallets

<SupportedWallets/>

## How to create a Nillion wallet and connect to the Nillion Testnet

This guide walks you through downloading a wallet, setting up your wallet, and adding the Nillion Testnet.

### 1. Download Keplr

Visit the [Keplr download page](https://www.keplr.app/download) and select your browser to download the Keplr browser extension. We recommend Chrome.

![Download Keplr](/img/download-wallet.png)

### 2. Install the Keplr browser extension

Click "Add to Chrome" to install the Keplr Chrome extension.

![Add extension](/img/add-extension.png)

### 3. Create a new wallet

After Keplr is installed, it will pop open in a new tab. Click "Create a new wallet."

![Create wallet](/img/create-wallet.png)

### 4. Create a recovery phrase

Create a wallet using a recovery phrase. Click "Create new recovery phrase."

![Create a wallet with a new recovery phrase](/img/recovery-phrase.png)

### 5. Secure your recovery phrase

Follow the steps to show your recovery phrase. Make sure to store your secret recovery phrase securely.
![Secure phrase](/img/secure-phrase.png)

### 6. Set a wallet password

Verify your recovery phrase by filling in ordered words. Then name your wallet and set a password. You'll use this password to log into Keplr on this device. To import this wallet for use on another device, you'll need the recovery phrase.
![Verify](/img/verify-wallet.png)

### 7. Add Nillion Testnet

1. Toggle open the "Extensions" button in your browser and pin the Keplr extension so that the browser has access to it.

2. Open the [Keplr Chains page](https://chains.keplr.app/) and search for "Nillion." Click "Add to Keplr."

3. "Approve" adding the Nillion Testnet within Keplr.

4. In the Keplr extension, click the hamburger menu and click "Manage Chain Visibility." This opens the Select Chains page in a new tab. Search for "NIL" and click the checkmark to make the Nillion Testnet visible from within Keplr. Click "Save."

5. Verify setup by toggling Keplr back open. Scroll down to the bottom of the "Home" tab, where you should see a new NIL token balance of 0 NIL.

### 8. Find your new Nillion wallet address

1. From your Keplr extension, click the "Copy address" button.

2. Now you'll see addresses for all enabled chains. Filter for "NIL"

3. Click to copy your Nillion wallet address to your clipboard. Your Nillion wallet address is safe to share with others; they'll need your wallet address to send you NIL.

<IframeVideo videoSrc="https://www.loom.com/embed/3b243bee264d4ca992381ef131e5a625?sid=17c8f87a-a468-41e3-88f1-7ca287063d29"/>

<br/>
Nice! You've set up your Nillion wallet and have a Nillion wallet address. Next, [use the Faucet](/guide-testnet-faucet) to get some Testnet NIL.
46 changes: 46 additions & 0 deletions docs/guide-testnet-faucet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import IframeVideo from '@site/src/components/IframeVideo/index';

# Using the Faucet

The [Nillion Testnet Faucet](https://faucet.testnet.nillion.com/) distributes Nillion Testnet NIL tokens. You can use the faucet to request tokens once every 24 hours.

## How to use the Nillion Testnet Faucet

This guide walks you through how to get NIL from the Nillion Testnet Faucet.

### 0. Set up a wallet

Follow the [Creating a Nillion Wallet](/guide-testnet-connect) guide to set up a connected wallet.

### 1. Go to the [Nillion Faucet](https://faucet.testnet.nillion.com/) page.

Click the "Start" button.

![faucet](/img/faucet-start.png)

### 2. Add your Nillion Testnet wallet address.

1. Open the Keplr extension and click "Copy address."

2. Search for "Nillion Testnet"

3. Click the copy icon next to "Nillion Testnet" to copy your Nillion Testnet wallet address.

4. Paste your Nillion Testnet wallet address into the faucet.

5. Click "Continue."

<IframeVideo videoSrc="https://www.loom.com/embed/d47a393e87544095a4bbf5531aac79f2?sid=3d0b8ee1-7c74-4c71-82f8-41ecb463e838"/>

### 3. Complete the verification challenge.

Complete the verification challenge and then click "Continue." The faucet will send testnet NIL to your Nillion Testnet wallet address.

### 4. Check your wallet for a NIL balance

Open your wallet to see the NIL in your Nillion Testnet wallet.

<IframeVideo videoSrc="https://www.loom.com/embed/93703c126ae74c8a9ff55e5d33063395?sid=aa08c50f-0aff-4d4f-9eca-70cb774736b4"/>

<br/>
Great work! Your Nillion Testnet wallet is funded with some Testnet NIL. Next make a transaction on the Nillion Testnet by [sending some Testnet NIL](/guide-testnet-tx) to a friend's Nillion Testnet wallet.
62 changes: 62 additions & 0 deletions docs/guide-testnet-tx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
import IframeVideo from '@site/src/components/IframeVideo/index';
import BlockExplorers from './\_testnet_block_explorers.mdx';

# Sending NIL tokens

Send a transaction on the Nillion Testnet and find the onchain record of the transaction on a block explorer.

## How to send NIL

This guide walks you through how to send NIL testnet tokens from one Nillion Testnet wallet to another Nillion Testnet wallet and find the transaction on a block explorer.

### 0. Set up a wallet and get NIL

Follow the [Creating a Nillion Wallet](/guide-testnet-connect) guide to set up a connected wallet.

Follow the [Using the Faucet](/guide-testnet-faucet) guide to request NIL testnet tokens.

### 1. Open Keplr and check your NIL balance

1. Open Keplr and find the "Search for asset or chain" searchbar on the Home tab.

2. Type in "NIL" to filter for your available balance of NIL.

3. Click "NIL" to open the NIL on Nillion Testnet view.

### 2. Send NIL to another Nillion wallet

1. Click "Send"

2. Under "Wallet address" paste in a valid Nillion wallet address - this address should start with `nillion1`

3. Under "Amount" type in the amount of NIL to send or click "Max" to send all your NIL minus the transaction fee (Tx Fee) shown at the bottom of Keplr.

4. Under "Memo", optionally add a note to be sent with the transaction.

5. Click "Next."

6. Confirm transaction by reviewing details to make sure the receipient's wallet address, amount, and memo are correct.

7. Click "Approve" to send the transaction, and wait for a success message to appear.

<IframeVideo videoSrc="https://www.loom.com/embed/bb37a3c363424e4385636a4b9cbf779e?sid=32c65c3e-247f-441a-af95-b879c4dbff1c"/>

### 3. Look for the transaction on a Nillion block explorer

There are multiple Nillion Testnet block explorers you can use to see your transaction.

<BlockExplorers/>

Use an explorer to find your transaction:

1. Open a Nillion Testnet block explorer and paste your Nillion wallet address into the search bar.

2. Find "Transactions" and click into the latest transaction.

3. Look at the transaction details to see the onchain record of the NIL you just sent.

<IframeVideo videoSrc="https://www.loom.com/embed/6f9023f29ad547f4b3a4f92bc852c11c?sid=cd8061b7-6ccf-4523-b0c9-094193e084d6"/>

<br/>

Well done! You just sent your first transaction on the Nillion Testnet!
54 changes: 54 additions & 0 deletions docs/network.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SupportedWallets from './\_testnet_supported_wallets.mdx';
import BlockExplorers from './\_testnet_block_explorers.mdx';

# Nillion Network

![Nillion's dual network architecture diagram](/img/dual-architecture.png)

## Dual Network Architecture

The Nillion Network has a Dual Network Architecture: **the Coordination Layer and the Petnet.**

[NilChain](https://github.com/NillionNetwork/nilchain) is the Coordination Layer for the Nillion Network. It coordinates payments for blind computations and storage operations performed on the network.

The Petnet harnesses privacy-enhancing technologies (PETs) including [Nillion's MPC Protocol](/nillions-mpc-protocol) to secure distributed secrets and perform blind computation. It operates without a global shared state or consensus on order, focusing instead on decentralizing trust for high value data across the network using clusters of nodes.

## Testnet

### Nillion Testnet (Coordination Layer)

The Nillion Testnet is live! Follow our [Testnet Guides](/testnet-guides) to create a wallet connected to the Nillion Testnet, use the Nillion Testnet Faucet, and send Testnet NIL tokens.

<Tabs>
<TabItem value="wallets" label="Supported wallets" default>

<SupportedWallets/>

Wallet Guide: [Creating a Nillion Wallet](guide-testnet-connect)

</TabItem>
<TabItem value="explorers" label="Block explorers">

<BlockExplorers/>

Transaction Guide: [Sending NIL and Using a Block Explorer](/guide-testnet-tx#3-look-for-the-transaction-on-a-nillion-block-explorer)

</TabItem>

<TabItem value="chaininfo" label="chain-info.json" default>

Nillion Testnet chain info

```json reference showGithubLink
https://github.com/chainapsis/keplr-chain-registry/blob/main/cosmos/nillion-chain-testnet.json

```

</TabItem>
</Tabs>

### 🔜 Petnet Testnet

The Petnet Testnet is in private beta. Today builders can use the [Nillion SDK](/nillion-sdk-and-tools) to connect their blind applications to a local [nillion-devnet](/nillion-devnet). Upon Petnet Testnet integration with the Coordination Layer in [Phase 2 of Nillion Network deployment](https://nillion.com/news/589/), builders will be able to connect their blind applications to the Nillion Network Testnet, making them accessible to the whole community.
9 changes: 9 additions & 0 deletions docs/testnet-guides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import DocCardList from '@theme/DocCardList';

# Testnet Guides

Nillion has [four-phase strategy](https://nillion.com/news/589/) for deploying the [Nillion Network](/network). We're currently in [Phase 1, the Genesis Sprint](https://nillion.com/news/589/). During Phase 1, you can interact with the Nillion Testnet, aka the [Coordination Layer](/network#nillion-testnet-coordination-layer), using Testnet NIL tokens.

Follow our Testnet Guides to create a wallet connected to the Nillion Testnet, use the Nillion Testnet Faucet, and send Testnet NIL tokens.

<DocCardList/>
13 changes: 7 additions & 6 deletions docs/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,23 @@
slug: /
---

import LinkButton from '@site/src/components/LinkButton/index';

# Welcome to Nillion's Docs

Nillion is a secure computation network that decentralizes trust for high value data in the same way that blockchains decentralized transactions.

**What if privacy was an enabler of use cases rather than a constraint?**

Developers can use Nillion to build secure, [high value data](high-value-data.md) focused applications. Nillion empowers developers to
Developers can use Nillion to build secure, [high value data](high-value-data.md) focused blind applications. Nillion empowers developers to

- write programs in Nada, our language for defining MPC programs
- write programs in Nada, our language for defining blind computation programs
- compile programs with the Nada compiler
- upload programs to the Nillion Network
- store permissioned secrets (high value data) on the Nillion Network
- run programs to perform blind computation on secrets on the Nillion Network

### Nillion Network access

The Nillion Network is in private beta for now, with network access gated by a [peer_id](/concepts#peer-id) allowlist. Builders can [fill out this DeForm](https://app.deform.cc/form/51a162ff-4ffb-4d9b-86ec-249f087a332f/) to apply for Nillion Network access through our [Nucleus Builders Program](nucleus-builders-program.md).
<br/>
<LinkButton text="Learn about Nillion" link="/what-is-nillion"/>

Today you can build with the [Nillion SDK](/nillion-sdk-and-tools#nillion-sdk-tools) and [Nillion Clients](/nillion-client), running against [nillion-devnet](/nillion-devnet), a cluster of Nillion network nodes running locally within your computer. Follow our [Developer Quickstart](/quickstart) to start building!
<LinkButton text="Start building"link="/quickstart"/>
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const config = {
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// 'https://github.com/NillionNetwork/nillion-docs/',
// 'https://github.com/NillionNetwork/nillion-docs/tree/main/',
},
blog: false,
theme: {
Expand Down
15 changes: 14 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const sidebars = {
'high-value-data',
'multi-party-computation',
'nillions-mpc-protocol',

'network',
{
type: 'html',
className: 'sidebar-title',
Expand Down Expand Up @@ -241,6 +241,19 @@ const sidebars = {
value: 'Resources',
defaultStyle: true,
},
{
type: 'category',
label: 'Testnet Guides',
link: {
type: 'doc',
id: 'testnet-guides',
},
items: [
'guide-testnet-connect',
'guide-testnet-faucet',
'guide-testnet-tx',
],
},
'showcase',
'community-and-support',
'data-wars',
Expand Down
4 changes: 4 additions & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,7 @@ h4 {
.navbar .navbar__item {
color: white !important;
}

.navbar__title {
font-size: 30px;
}
Binary file added static/img/add-extension.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/create-wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/download-wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/dual-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/faucet-start.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/recovery-phrase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/secure-phrase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/verify-wallet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e1e8853

Please sign in to comment.