Skip to content

Commit

Permalink
Fix linting
Browse files Browse the repository at this point in the history
  • Loading branch information
hopr-version-bot committed Oct 16, 2020
1 parent e5cf2e1 commit 4ce9c61
Show file tree
Hide file tree
Showing 48 changed files with 193 additions and 235 deletions.
1 change: 0 additions & 1 deletion docs/hopr-documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ HOPR provides privacy by relaying messages through multiple “hops” via diffe
The HOPR network relies on multiple individuals running HOPR nodes over publicly available infrastructure. HOPR nodes can run in multiple devices and operating systems over the Internet.

Nodes participating in the HOPR network get paid for their services via blockchain payment channels in the form of HOPR tokens. Every time a message hops through a different node, its maintainer is rewarded with a ticket with a certain probability of being redeemed on-chain for HOPR tokens. These HOPR tokens can be used within the HOPR network as a means of payment for requesting services from other HOPR nodes.

87 changes: 43 additions & 44 deletions docs/hopr-documentation/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,69 +1,68 @@
# Table of contents

* [HOPR](README.md)
- [HOPR](README.md)

## Getting started

---

* [First Time Users: Start Here](start-here.md)
- [First Time Users: Start Here](start-here.md)

## HOPR AVADO Node Tutorial

* [Setting Up Your AVADO Node](hopr-avado-node-tutorial/setting-up-your-avado-node.md)
* [Funding Your AVADO Node](hopr-avado-node-tutorial/funding-your-avado-node.md)
* [Exploring The Network](hopr-avado-node-tutorial/finding-your-address.md)
* [Messaging Randobot](hopr-avado-node-tutorial/talking-with-randobot.md)
* [Changing Your Routing Settings](hopr-avado-node-tutorial/changing-your-routing-settings.md)
* [Sending A Multi-hop Message Using A Payment Channel](hopr-avado-node-tutorial/sending-a-multi-hop-message.md)
* [Earning and Redeeming Tickets](hopr-avado-node-tutorial/redeeming-tickets.md)
* [Withdrawing Funds](hopr-avado-node-tutorial/withdrawing-funds.md)
- [Setting Up Your AVADO Node](hopr-avado-node-tutorial/setting-up-your-avado-node.md)
- [Funding Your AVADO Node](hopr-avado-node-tutorial/funding-your-avado-node.md)
- [Exploring The Network](hopr-avado-node-tutorial/finding-your-address.md)
- [Messaging Randobot](hopr-avado-node-tutorial/talking-with-randobot.md)
- [Changing Your Routing Settings](hopr-avado-node-tutorial/changing-your-routing-settings.md)
- [Sending A Multi-hop Message Using A Payment Channel](hopr-avado-node-tutorial/sending-a-multi-hop-message.md)
- [Earning and Redeeming Tickets](hopr-avado-node-tutorial/redeeming-tickets.md)
- [Withdrawing Funds](hopr-avado-node-tutorial/withdrawing-funds.md)

## HOPR Chat Tutorial

* [First Time Setup](hopr-chat-tutorial/quickstart.md)
* [Previous Users](hopr-chat-tutorial/getting-started.md)
* [Funding Your Node](hopr-chat-tutorial/funding-your-node.md)
* [Exploring The Network](hopr-chat-tutorial/exploring-the-network.md)
* [Messaging RandoBot](hopr-chat-tutorial/randobot.md)
* [Changing Your Routing Settings](hopr-chat-tutorial/changing-your-routing-settings.md)
* [Sending a Multi-Hop Message Using a Payment Channel](hopr-chat-tutorial/opening-and-closing-payment-channels.md)
* [Earning and Redeeming Tickets](hopr-chat-tutorial/redeeming-tickets.md)
* [Withdrawing Funds](hopr-chat-tutorial/withdrawing-funds.md)
* [Advanced Setup](hopr-chat-tutorial/setup.md)
* [Troubleshooting](hopr-chat-tutorial/troubleshooting.md)
- [First Time Setup](hopr-chat-tutorial/quickstart.md)
- [Previous Users](hopr-chat-tutorial/getting-started.md)
- [Funding Your Node](hopr-chat-tutorial/funding-your-node.md)
- [Exploring The Network](hopr-chat-tutorial/exploring-the-network.md)
- [Messaging RandoBot](hopr-chat-tutorial/randobot.md)
- [Changing Your Routing Settings](hopr-chat-tutorial/changing-your-routing-settings.md)
- [Sending a Multi-Hop Message Using a Payment Channel](hopr-chat-tutorial/opening-and-closing-payment-channels.md)
- [Earning and Redeeming Tickets](hopr-chat-tutorial/redeeming-tickets.md)
- [Withdrawing Funds](hopr-chat-tutorial/withdrawing-funds.md)
- [Advanced Setup](hopr-chat-tutorial/setup.md)
- [Troubleshooting](hopr-chat-tutorial/troubleshooting.md)

## Core Concepts

* [Overview](core-concepts/overview.md)
* [Protocol, Network and Token](core-concepts/protocol-network-token.md)
* [HOPR Chat](core-concepts/hopr-chat/README.md)
* [Troubleshooting](core-concepts/hopr-chat/troubleshooting.md)
* [Proof of Relay](core-concepts/proof-of-relay/README.md)
* [Routing Settings](core-concepts/proof-of-relay/routing-settings.md)
* [Bootstrap Nodes](core-concepts/bootstrap-nodes.md)
* [Cover Traffic](core-concepts/cover-traffic/README.md)
* [Registering with CoverBot](core-concepts/cover-traffic/coverbot.md)
* [Tokens](core-concepts/tokens/README.md)
* [Native Tokens](core-concepts/tokens/native-tokens.md)
* [xHOPR Tokens](core-concepts/tokens/xhopr-tokens.md)
* [Payment Channels](core-concepts/payment-channels.md)
* [Tickets](core-concepts/tickets.md)
- [Overview](core-concepts/overview.md)
- [Protocol, Network and Token](core-concepts/protocol-network-token.md)
- [HOPR Chat](core-concepts/hopr-chat/README.md)
- [Troubleshooting](core-concepts/hopr-chat/troubleshooting.md)
- [Proof of Relay](core-concepts/proof-of-relay/README.md)
- [Routing Settings](core-concepts/proof-of-relay/routing-settings.md)
- [Bootstrap Nodes](core-concepts/bootstrap-nodes.md)
- [Cover Traffic](core-concepts/cover-traffic/README.md)
- [Registering with CoverBot](core-concepts/cover-traffic/coverbot.md)
- [Tokens](core-concepts/tokens/README.md)
- [Native Tokens](core-concepts/tokens/native-tokens.md)
- [xHOPR Tokens](core-concepts/tokens/xhopr-tokens.md)
- [Payment Channels](core-concepts/payment-channels.md)
- [Tickets](core-concepts/tickets.md)

## Resources

* [Glossary](resources/glossary.md)
* [Releases](resources/releases.md)
- [Glossary](resources/glossary.md)
- [Releases](resources/releases.md)

## Community

* [HOPR Games \(On Hiatus\)](community/hopr-games/README.md)
* [Bounties](community/hopr-games/bounties/README.md)
* [Bouncer Bot](community/hopr-games/bounties/bouncer-bot.md)
* [Säntis Testnet \(Ended 06 Oct 2020\)](community/saentis-testnet.md)
- [HOPR Games \(On Hiatus\)](community/hopr-games/README.md)
- [Bounties](community/hopr-games/bounties/README.md)
- [Bouncer Bot](community/hopr-games/bounties/bouncer-bot.md)
- [Säntis Testnet \(Ended 06 Oct 2020\)](community/saentis-testnet.md)

## QA

* [Testing HOPR](qa/testing-hopr/README.md)
* [Filling a QA checklist](qa/testing-hopr/filling-a-qa-checklist.md)

- [Testing HOPR](qa/testing-hopr/README.md)
- [Filling a QA checklist](qa/testing-hopr/filling-a-qa-checklist.md)
13 changes: 6 additions & 7 deletions docs/hopr-documentation/community/hopr-games/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@ In order to showcase the usage of the HOPR Protocol, the HOPR Association has cr

The HOPR Games are meant to help grow and develop HOPR as a project by interacting with our community and learning about their experience with the product. The following are the goals the HOPR Association has in mind when organising HOPR Games sessions:

* **Teach and learn \(α\)**. We want to educate our community about HOPR, its technology and benefits. At the same time, we want to learn from the community about any drawbacks or challenges they encounter.
* **Media awareness \(β\).** We want to increase our reach and network connections by leveraging on social media platforms. We are looking to get HOPR exposed to multiple outlets as much as possible to increase our exposure.
* **Recruit members \(γ\).** We want to add new users to our community — from traders, developers, miners to curious-minded people. We are creating an environment where like-minded people can rally behind our goal and all benefit from our mission.
* **Enhance the project \(δ\).** We want to expand the functionality of the protocol, its applications and use cases around it. By listening to our users, we can find organic features which solve problems for both experienced and novice users.
* **Test protocol \(ε\).** We want to push the limits of our technology beyond our shared understanding of what it can and cannot do. To ensure HOPR can withstand a production load, we need to challenge it at every step.
- **Teach and learn \(α\)**. We want to educate our community about HOPR, its technology and benefits. At the same time, we want to learn from the community about any drawbacks or challenges they encounter.
- **Media awareness \(β\).** We want to increase our reach and network connections by leveraging on social media platforms. We are looking to get HOPR exposed to multiple outlets as much as possible to increase our exposure.
- **Recruit members \(γ\).** We want to add new users to our community — from traders, developers, miners to curious-minded people. We are creating an environment where like-minded people can rally behind our goal and all benefit from our mission.
- **Enhance the project \(δ\).** We want to expand the functionality of the protocol, its applications and use cases around it. By listening to our users, we can find organic features which solve problems for both experienced and novice users.
- **Test protocol \(ε\).** We want to push the limits of our technology beyond our shared understanding of what it can and cannot do. To ensure HOPR can withstand a production load, we need to challenge it at every step.

## Activities

Activities are actions or events community members can participate in during HOPR Games to earn rewards from the HOPR Association. In exchange for completing an activity, a community member will be rewarded with native digital tokens \(e.g. xDAI\).

{% hint style="info" %}
We'll soon release the capability to issue non-transferable $HOPR tokens as rewards to community members that complete some of our activities.
We'll soon release the capability to issue non-transferable \$HOPR tokens as rewards to community members that complete some of our activities.
{% endhint %}

Activities are split into three categories: **bounties**, **games**, and **experiments**. Activities in each category help the HOPR Association to target specific individuals and achieve different goals:
Expand All @@ -41,4 +41,3 @@ Games are **short-lived**, **synchronous**, **open-ended** and can have unexpect
### Experiments

Experiments are **long-lived**, **asynchronous**, **open-ended** and can have **unexpected** results. Experiments are **monthly** or **quarterly**, have little notice, and are meant to test our project.

17 changes: 8 additions & 9 deletions docs/hopr-documentation/community/hopr-games/bounties/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ To get started with **HOPR Chat**, please visit our quick start \***\*page to do

Completing the HOPR Games bounties will always require you the following:

* Run a **HOPR Node** \(either via **HOPR Chat** or else\)
* Engage with HOPR‘s social media presence
- Run a **HOPR Node** \(either via **HOPR Chat** or else\)
- Engage with HOPR‘s social media presence

Not only this will help us avoid Sybil Attacks \(i.e. bots or individuals just trying to solve the Bounties via spam attacks\), but also helps us showcase use-cases for the **HOPR Protocol** across social media.

Expand All @@ -50,10 +50,9 @@ Upon successfully complete a HOPR Games bounty, you will receive a URL with pre-

Bounties are usually launched on a **bi-weekly basis**, and we try to support multiple timezones whenever possible. All our bounties will be shared over our social media channels, and you can reach the HOPR Association team members via these same channels to get some support.

* Twitter - [https://twitter.com/hoprnet](https://twitter.com/hoprnet)
* Telegram - [https://t.me/hoprnet](https://t.me/hoprnet)
* Medium - [https://medium.com/hoprnet](https://medium.com/hoprnet)
* Reddit - [https://www.reddit.com/r/HOPR/](https://www.reddit.com/r/HOPR/)
* Email - [contact@hoprnet.org](mailto:contact@hoprnet.org)
* Discord - [https://discord.gg/5FWSfq7](https://discord.gg/5FWSfq7)

- Twitter - [https://twitter.com/hoprnet](https://twitter.com/hoprnet)
- Telegram - [https://t.me/hoprnet](https://t.me/hoprnet)
- Medium - [https://medium.com/hoprnet](https://medium.com/hoprnet)
- Reddit - [https://www.reddit.com/r/HOPR/](https://www.reddit.com/r/HOPR/)
- Email - [contact@hoprnet.org](mailto:contact@hoprnet.org)
- Discord - [https://discord.gg/5FWSfq7](https://discord.gg/5FWSfq7)
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ You are ready to go!

### Additional Requirements

* Twitter Account with >25 followers.
* xDAI wallet \(e.g. Metamask w/xDAI RPC, [https://xdai.io/](https://xdai.io/)\)
- Twitter Account with >25 followers.
- xDAI wallet \(e.g. Metamask w/xDAI RPC, [https://xdai.io/](https://xdai.io/)\)

## Sessions

* 21st of August at 4pm CEST
* 23rd of August at 12pm CEST
- 21st of August at 4pm CEST
- 23rd of August at 12pm CEST

## Prices

* 1st Session - 150 xDAI pool, 10 xDAI per participant
* 2nd Session - 150 xDAI pool, 10 xDAI per participant
- 1st Session - 150 xDAI pool, 10 xDAI per participant
- 2nd Session - 150 xDAI pool, 10 xDAI per participant

## Bot Address

Expand Down Expand Up @@ -94,4 +94,3 @@ Now, you can send messages to `bouncerbot` just by typing `send bouncerbot`.
Time to get into the party! Message `bouncerbot` to try and enter the party. It might take multiple tries before you can get in. Good luck!

![](https://media.giphy.com/media/xT5LMWSMSsE5lji9LW/giphy.gif)

3 changes: 1 addition & 2 deletions docs/hopr-documentation/community/saentis-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,8 @@ HOPR Säntis has ended. Thank you to everyone who participated. We'll be launchi

Säntis was an incentivized HOPR testnet which ran on [xDAI Chain](https://www.xdaichain.com/) from 5pm CEST on Wednesday 16th September 2020 until 5pm CEST on Tuesday 6th October 2020. You can find a list of winners [here](https://medium.com/hoprnet/oh-my-hopness-100-000-more-hopr-tokens-for-s%C3%A4ntis-63ef8efa6c68).

![The Säntis web interface](../.gitbook/assets/saentis-ui%20%281%29%20%282%29%20%281%29%20%281%29.png)
![The Säntis web interface](../.gitbook/assets/saentis-ui%20%281%29%20%282%29%20%281%29%20%281%29.png)

{% hint style="info" %}
Like all of our builds, Säntis was named after a mountain in HOPR's home country of Switzerland. On a clear day, you can see six different countries from the summit!
{% endhint %}

1 change: 0 additions & 1 deletion docs/hopr-documentation/core-concepts/bootstrap-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@ To run **HOPR Chat** as a bootstrap node, pass a `-b` flag to the run command.
## Available Bootstrap Nodes

Feel free to use any \(or all\) of the following URLs as your `BOOTSTRAP_SERVERS` parameter in your **HOPR Chat** Docker image. Each of our **Bootstrap Nodes** are located in different countries and serve a specific environment. You can find our Bootstrap Nodes by querying our `TXT` records from our `hoprnet.org` `_dnsaddr.bootstrap` subdomain. Quickly see those in [https://www.whatsmydns.net/\#TXT/\_dnsaddr.bootstrap.testnet.hoprnet.org](https://www.whatsmydns.net/#TXT/_dnsaddr.bootstrap.testnet.hoprnet.org).

Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,3 @@ With this layer of extra data constantly moving through the network, outside obs
CoverBot will be providing cover traffic to this testnet and rewarding you for helping to relay it. Along the way, we’ll be stress testing the limits of our network and trying to find inventive ways to break it. Finding these issues and fixing them in a safe environment will help us to ensure the network is secure when it launches for real later in the year.

Eventually this cover traffic will need to be fully decentralized, but for now we’re just testing whether the mechanism works. For three weeks, CoverBot will transmit data randomly through the network and back to itself. We’d like your help relaying this data, and in exchange you'll receive points on the scoreboard for a share of the 100,000 HOPR prize fund.

Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,3 @@ If the CoverBot selects your address, you'll receive a ticket which can be redee
{% hint style="info" %}
The more your node is online, the greater your chance of earning tickets, so try to maximize your node uptime.
{% endhint %}

5 changes: 2 additions & 3 deletions docs/hopr-documentation/core-concepts/hopr-chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ To get started with HOPR, we'll use the **HOPR Chat node app**, a [REPL](https:/

To use **HOPR Chat**, your workstation or device running it requires one of the following pieces of software:

* [Node.js](https://nodejs.org/en/), a JavaScript runtime built on Chrome's V8 JavaScript engine.
* [Docker](https://www.docker.com/), a containerisation engine able to virtualise any application.
- [Node.js](https://nodejs.org/en/), a JavaScript runtime built on Chrome's V8 JavaScript engine.
- [Docker](https://www.docker.com/), a containerisation engine able to virtualise any application.

{% hint style="info" %}
Please bear in mind that to run **HOPR Chat** using **Docker** in your computer, you need some minimal hardware virtualization requirements. For most users, we recommend running **HOPR Chat** using Node.js.
Expand All @@ -18,4 +18,3 @@ Please bear in mind that to run **HOPR Chat** using **Docker** in your computer,
Follow our quick start guide to learn how to install and use **HOPR Chat** on your system.

![](../../.gitbook/assets/hopr-chat-testnet%20%284%29%20%281%29%20%281%29.gif)

Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,3 @@ Since the version **HOPR Chat** that uses Nodejs to work has additional precompi
![Windows prompting access to write to your current directory](../../.gitbook/assets/image%20%282%29%20%282%29%20%281%29%20%281%29.png)

Clicking “Share It” will allow you to run **HOPR Chat** successfully.

1 change: 0 additions & 1 deletion docs/hopr-documentation/core-concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ To achieve this, a **HOPR node** implements a connector interface that communica
Although the first instantiation of the **HOPR network** is on the Ethereum blockchain, HOPR is _chain agnostic_**,** which means that **HOPR nodes** can eventually implement different payment channels in different blockchains.

At the time of writing, HOPR is also able to implement a [Polkadot-enabled payment gateway.](https://github.com/hoprnet/hopr-polkadot)

5 changes: 2 additions & 3 deletions docs/hopr-documentation/core-concepts/payment-channels.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Payment Channels

* **OPEN -** The channel is currently open and funded, so data can be relayed between your node and the target node.
* **PENDING** - A request has been placed to close the channel. After the cool-off period \(currently 2 minutes\), the channel is able to be closed.
- **OPEN -** The channel is currently open and funded, so data can be relayed between your node and the target node.
- **PENDING** - A request has been placed to close the channel. After the cool-off period \(currently 2 minutes\), the channel is able to be closed.

You will then be shown a list of open channels, along with their status. The two status options are:

Expand Down Expand Up @@ -100,4 +100,3 @@ You can verify any of the receipts you get on an xDAI block explorer. For exampl
Type `balance`, and you'll see that your xHOPR balance has reduced by the amount you funded the channel with. Your xDAI balance will also have slightly decreased. This is the fee for opening the payment channel.

Once a payment channel is closed, any unspent HOPR tokens in the channel will be returned to your balance. You can check this by typing `balance`.

0 comments on commit 4ce9c61

Please sign in to comment.