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.

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

Update Hornet docs to newest 2.0 version #1211

Merged
merged 4 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Once the transaction is confirmed, the `Alias ID` would be assigned and the DID

## Running a private network

In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](/hornet/2.0-rc.6/how_tos/private_tangle) for instructions on how to run a private network.
In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](/hornet/2.0/how_tos/private_tangle) for instructions on how to run a private network.

If your local private network uses different ports than Hornet, modify the API and faucet endpoints in the examples to match your local setup.
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The minimum supported version for node is: `v16`
## NodeJS Usage

The following code creates a new IOTA DID Document suitable for publishing to a locally running private network.
See the [instructions](/hornet/2.0-rc.6/how_tos/private_tangle) on running your own private network.
See the [instructions](/hornet/2.0/how_tos/private_tangle) on running your own private network.

<!--
Test this example using https://github.com/anko/txm: `txm README.md`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,6 @@ Once the transaction is confirmed, the `Alias ID` would be assigned and the DID

## Running a private network

In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](/hornet/2.0-rc.6/how_tos/private_tangle) for instructions on how to run a private network.
In order to run the examples, a private network (sometimes also called a private Tangle) needs to run locally. You can refer to [Hornet wiki](/hornet/2.0/how_tos/private_tangle) for instructions on how to run a private network.

If your local private network uses different ports than Hornet, modify the API and faucet endpoints in the examples to match your local setup.
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The minimum supported version for node is: `v16`
## NodeJS Usage

The following code creates a new IOTA DID Document suitable for publishing to a locally running private network.
See the [instructions](/hornet/2.0-rc.6/how_tos/private_tangle) on running your own private network.
See the [instructions](/hornet/2.0/how_tos/private_tangle) on running your own private network.

<!--
Test this example using https://github.com/anko/txm: `txm README.md`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ A verifier node is a Chrysalis Phase 2 node which upon seeing receipts:
2. Then performs WOTS signature verification of the legacy milestone bundle and all confirmed bundles.
3. Additionally, it also checks that all confirmed funds on the legacy network for the given legacy milestone, are indeed minted with a given batch of receipts (i.e. nothing is left out).

For further reference, you can read the [Hornet as a verifier node](/hornet/how_tos/run_as_a_verifier) page.
For further reference, you can read the [Hornet as a verifier node](/hornet/1.2/how_tos/run_as_a_verifier) page.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ performant implementation, furthermore its [IOTA Node Extension (INX)](https://T
for Stardust eases the development of application specific node extensions.

- [Official GitHub Repository](https://github.com/iotaledger/hornet)
- [Documentation](/hornet/2.0-rc.6/welcome)
- [Documentation](/hornet/2.0/welcome)

## Node API Specification

Expand Down
2 changes: 1 addition & 1 deletion docs/build/iota.js/2.0-rc.1/docs/how_tos/transaction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Once you have [generated a seed](#generate-a-seed), you can create a wallet usin
### Request Funds

Before you can send the transaction, you will need to request funds. If you are on the alphanet, you can request test
funds from the [faucet](https://faucet.alphanet.iotaledger.net/api/enqueue). If you are running a [private tangle](/hornet/2.0-rc.6/how_tos/private_tangle),
funds from the [faucet](https://faucet.alphanet.iotaledger.net/api/enqueue). If you are running a [private tangle](/hornet/2.0/how_tos/private_tangle),
you can use the '/enqueue' endpoint.

## Send the Transaction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ const stateControllerPrivateKey = '0xa060ff...';

## Query Alias Output

You will first need to find the Alias Output of your Alias. The easiest way to do so is through a query to the [indexation plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference) by Alias ID. Observe that you need to obtain the full output details as we need to use them as input for the transaction.
You will first need to find the Alias Output of your Alias. The easiest way to do so is through a query to the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference) by Alias ID. Observe that you need to obtain the full output details as we need to use them as input for the transaction.

```typescript
const indexerPlugin = new IndexerPluginClient(client);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ This tutorial assumes that the newly minted Alias ID holds enough funds (protoco

### Obtain the Current Alias Output

Once you have your Alias ID, you will need to get its current unspent Alias Output through the [Indexer Plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference). The Alias Output will participate in a transaction that will create a new Foundry Output and mint native tokens.
Once you have your Alias ID, you will need to get its current unspent Alias Output through the [Indexer Plugin](/hornet/2.0/inx-plugins/indexer/api_reference). The Alias Output will participate in a transaction that will create a new Foundry Output and mint native tokens.

```typescript
const aliasId = '0x8c81...';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const destAddress = '0xc8413...';

## Query Native Tokens Output to be Spent

The first thing you need to do is to find the Basic Output that holds the native tokens. The easiest way to do it is through a query to the [indexation plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference), as shown below. You will need to obtain the full Output details, as you will need to use it as Input for your following transaction.
The first thing you need to do is to find the Basic Output that holds the native tokens. The easiest way to do it is through a query to the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference), as shown below. You will need to obtain the full Output details, as you will need to use it as Input for your following transaction.

```typescript
const indexerPlugin = new IndexerPluginClient(client);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ In this step, you need to transition the Alias Address to a new state, as one of

### Query for the Alias Output

First, you need to find the unspent Alias Output of your Alias Address through a query to the [indexing plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference) using the Alias ID. You need to obtain the full Output details, as you will need to use it as Input for your transaction.
First, you need to find the unspent Alias Output of your Alias Address through a query to the [indexing plugin](/hornet/2.0/inx-plugins/indexer/api_reference) using the Alias ID. You need to obtain the full Output details, as you will need to use it as Input for your transaction.

```typescript
const indexerPlugin = new IndexerPluginClient(client);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ const nftBuyerAddr = '0x57d3...';
## Query For the NFT Output

You will first need to query for the NFT Output of your NFT. The easiest way to do so is through a query to
the [indexation plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference) by NFT ID. You need to obtain the full
the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference) by NFT ID. You need to obtain the full
Output details as you need to use them as input for the transaction.

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ const nftOwnerPrivateKey = '0xc2be...';
## Query For the NFT Output

You will first need to retrieve the NFT Output of your NFT from the network. The easiest way to do so is through a query
to the [indexation plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference) by NFT ID. You need to obtain the full
to the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference) by NFT ID. You need to obtain the full
Output details as you need to use them as Input for the transaction.

```typescript
Expand Down Expand Up @@ -204,7 +204,7 @@ At the end of this sub-step you know the total cost that should be covered by yo
### Find an Output With Enough Funds

You can find the right Basic Output by querying
the [indexation plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference). You should check that the Output has not
the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference). You should check that the Output has not
been spent yet.

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ keywords:

You can try executing all the steps described in this tutorial again but using a new output ID corresponding to the
value `999.95 SMR` in the origin address. This time, instead of hard-coding the output ID, you can obtain the output
ID through the [indexation plugin](/hornet/2.0-rc.6/inx-plugins/indexer/api_reference). The indexation plugin keeps the
ID through the [indexation plugin](/hornet/2.0/inx-plugins/indexer/api_reference). The indexation plugin keeps the
correspondence between addresses and their associated outputs, so it is easy to obtain the balance of an address.

```typescript
Expand Down
2 changes: 1 addition & 1 deletion docs/build/wallet.rs/1.0-rc.6/docs/how_tos/run_how_tos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Most of the examples require a [Hornet Node](/hornet/welcome) running the
[Stardust](/introduction/stardust/welcome) upgrade. You can connect to the
[Shimmer Testnet](#shimmer-testnet), a node you trust,
[run your own node](/hornet/how_tos/using_docker) or
[run a local private tangle](/hornet/2.0-rc.6/how_tos/private_tangle).
[run a local private tangle](/hornet/2.0/how_tos/private_tangle).

#### Shimmer Testnet

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/governance/governance-tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If you plan to send, mint, or receive tokens, native assets, or NFTs during the

Because every node in the SMR network knows the status of every UTXO in the Tangle, they can observe and register changes to these UTXOs.
As soon as a vote transaction is issued and confirmed, the UTXO will hold a piece of attached metadata information.
Hornet nodes with activated [INX participation plugin](/hornet/2.0-rc.6/inx-plugins/participation/welcome) monitor the ledger for UTXOs that contain this specific metadata.
Hornet nodes with activated [INX participation plugin](/hornet/2.0/inx-plugins/participation/welcome) monitor the ledger for UTXOs that contain this specific metadata.
They count all UTXOs that have this metadata for every new milestone in the Tangle and create a database for the counted votes of this event.

This database includes the following information for every milestone:
Expand Down Expand Up @@ -113,7 +113,7 @@ Shimmer's voting system builds upon IOTA's [first governance vote in 2022](https
In contrast to the earlier voting system developed for the IOTA network, this Shimmer version does not rely on the IOTA Foundation to add governance events to the Firefly wallet. Every community member can:

- Create a governance event following the [specifications for participation events](https://github.com/iota-community/treasury/blob/main/specifications/hornet-participation-plugin.md)
- Add this governance event to a Hornet node with the [INX Participation Plugin](/hornet/2.0-rc.6/inx-plugins/participation/welcome)
- Add this governance event to a Hornet node with the [INX Participation Plugin](/hornet/2.0/inx-plugins/participation/welcome)
- Add this governance event to the Shimmer Firefly wallet by connecting Shimmer Firefly to a node that carries this event and use the [“add event”](./shimmer-firefly-governance-guide.md#6-adding-custom-community-proposals-to-firefly) function in the Governance section
- Vote on this event with SMR tokens

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/governance/shimmer-governance-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The Shimmer community, supported by the IOTA Foundation, has developed a Governa

**2. The official IOTA/Shimmer [Governance Forum](https://govern.iota.org)**is the place for specific proposal discussions. It is the first stage of reaching community consensus on proposed changes through soft consensus polling in the forum.

**3. Fully utilized decentralized and immutable On-Chain Governance [voting functionality](./governance-tech.md)** integrated into the [Firefly Shimmer Wallet](https://firefly.iota.org/) and the [Hornet Nodes](/hornet/2.0-rc.6/welcome). This allows every SMR Token holder to make decisions in the SMR network based on proposals passed through the forum's governance process. Voting is a protocol feature of L1, so no Smart Contracts are needed for this type of voting.
**3. Fully utilized decentralized and immutable On-Chain Governance [voting functionality](./governance-tech.md)** integrated into the [Firefly Shimmer Wallet](https://firefly.iota.org/) and the [Hornet Nodes](/hornet/2.0/welcome). This allows every SMR Token holder to make decisions in the SMR network based on proposals passed through the forum's governance process. Voting is a protocol feature of L1, so no Smart Contracts are needed for this type of voting.

Governance processes in SMR are defined in the **[Shimmer Governance Framework](./the-shimmer-governance-framework.md)**. This framework has been developed by the Community Governance working group in many months of discussions and is the foundational building block of how Governance in SMR works.
It mainly defines:
Expand Down Expand Up @@ -50,7 +50,7 @@ This feature consists of 2 components:

#### The Hornet - INX participation Plugin

- This feature can be activated as a [plugin](/hornet/2.0-rc.6/inx-plugins/participation/welcome) in every Hornet Shimmer node and enables node operators to participate in the decentralized counting and verification of on-chain Governance votes.
- This feature can be activated as a [plugin](/hornet/2.0/inx-plugins/participation/welcome) in every Hornet Shimmer node and enables node operators to participate in the decentralized counting and verification of on-chain Governance votes.
- Node operators can add proposals that are due for an on-chain vote through an easy interface by uploading the unique proposal ID to their node.
- Counting of votes is based on a time-based accumulation. Each milestone (every 5 seconds) that a node finds a vote on a UTXO Output, the SMR tokens sitting on that output and the vote statement (proposal ID, question, and answer) are registered by the nodes and added to the count for that output in an internal database. This leads to a time-based growth of casted votes, meaning the longer a voter participates with SMR tokens in a vote, the more votes are counted for the voter.
- Node operators are always able to access this counting data and verify the correct counting of votes by comparing their count to other node operators counts.
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/governance/the-shimmer-governance-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The [Governance forum](https://govern.iota.org), [introduced by the IOTA Foundat
- Phase 2 - Temperature check
- Phase 3 - Voting

Once an idea successfully passes phase 2, a vote is initiated in phase 3 using the Firefly voting mechanism based on Shimmer token ownership. This method uses the functionalities of the already developed Firefly Governance and the Hornet [INX participation plugin](/hornet/2.0-rc.6/inx-plugins/participation/welcome) developed and used first in the [Build vs. Burn](https://blog.iota.org/iota-treasury-vote-how-to-take-part/) vote that happened in June 2022.
Once an idea successfully passes phase 2, a vote is initiated in phase 3 using the Firefly voting mechanism based on Shimmer token ownership. This method uses the functionalities of the already developed Firefly Governance and the Hornet [INX participation plugin](/hornet/2.0/inx-plugins/participation/welcome) developed and used first in the [Build vs. Burn](https://blog.iota.org/iota-treasury-vote-how-to-take-part/) vote that happened in June 2022.

**To be accepted and implemented as a vote in Firefly, a governance proposal must successfully pass through the first two phases of the framework that work as a filter mechanism to only allow proposals that fulfill specific criteria to be implemented as a Firefly vote.**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ the [`config.json`](../how_tos/post_installation.md) file.
## Operating System

HORNET is written in Go and can be deployed on all major platforms.
The [recommended setup](../how_tos/using_docker.md) uses Docker to run HORNET together with some [INX](/hornet/2.0-rc.6/inx-plugins) extensions secured behind a [Traefik](https://traefik.io) SSL reverse proxy.
The [recommended setup](../how_tos/using_docker.md) uses Docker to run HORNET together with some [INX](../inx-plugins) extensions secured behind a [Traefik](https://traefik.io) SSL reverse proxy.

## Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Once you have completed all the installation [requirements](#requirements), you
```sh
mkdir hornet
cd hornet
curl -L -O "https://github.com/iotaledger/node-docker-setup/releases/download/v1.0.0-rc.16/node-docker-setup_stardust-v1.0.0-rc.16.tar.gz"
tar -zxf node-docker-setup_stardust-v1.0.0-rc.16.tar.gz
curl -L -O "https://github.com/iotaledger/node-docker-setup/releases/download/v1.0.1/node-docker-setup_stardust-v1.0.1.tar.gz"
tar -zxf node-docker-setup_stardust-v1.0.1.tar.gz
```

## Prepare
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ It's task is to issue milestones at a constant rate. Validation of the issued mi

## Setup

There is only one coordinator needed in a network. If you want to run your own private network with it's own coordinator, have a look at our [Run a Private Tangle](/hornet/2.0-rc.6/how_tos/private_tangle) guide.
There is only one coordinator needed in a network. If you want to run your own private network with it's own coordinator, have a look at our [Run a Private Tangle](/hornet/2.0/how_tos/private_tangle) guide.

## Configuration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Faucets are useful in test and private networks to distribute test tokens to dev

The recommended setup is to use the provided [Docker images](https://hub.docker.com/r/iotaledger/inx-faucet).

If you want to run your own private network with it's own faucet, have a look at our [Run a Private Tangle](/hornet/2.0-rc.6/how_tos/private_tangle) guide.
If you want to run your own private network with it's own faucet, have a look at our [Run a Private Tangle](/hornet/2.0/how_tos/private_tangle) guide.

To run your own faucet you need to provide a private key containing funds to the faucet. To do this you start `inx-faucet` by passing a `FAUCET_PRV_KEY` environment variable containing the private key.

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ module.exports = async () => {
},
{
from: '/shimmer/hornet',
to: '/hornet/2.0-rc.6',
to: '/hornet/2.0',
},
{
from: '/shimmer/identity.rs',
Expand Down
8 changes: 4 additions & 4 deletions versionedConfig.js
Original file line number Diff line number Diff line change
Expand Up @@ -223,12 +223,12 @@ exports.maintainPluginsConfig = [
subsection: 'maintain-layer-1',
versions: [
{
label: '1.2',
badges: ['IOTA'],
label: '2.0',
badges: ['IOTA/Shimmer'],
},
{
label: '2.0-rc.6',
badges: ['Shimmer'],
label: '1.2',
badges: ['Deprecated'],
},
],
},
Expand Down