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 Pages to address Stales #2371

Merged
merged 3 commits into from
Jul 22, 2021
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
Binary file modified docs/assets/accounts/create-multisig.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 modified docs/assets/accounts/send-from-multi.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 modified docs/assets/accounts/sign-from-multi-1.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 modified docs/assets/polkadotjs_network_parachains.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 18 additions & 13 deletions docs/build-parachains-rococo.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,27 @@ sidebar_label: Rococo Parachain Test Network
---

[Rococo](https://github.com/paritytech/cumulus#rococo-crown) is a Polkadot testnet built for testing
parachains. Rococo utilizes Cumulus and HRMP (Horizontal Relay-routed Message Passing) in order to
send transfers and messages between parachains and the Relay Chain. Every message is sent to the
Relay Chain, then from the Relay Chain to the desired parachain. Rococo currently runs four test
system parachains (Statemint, Tick, Trick, and Track), as well as several externally developed
parachains. Unlike other testnets, Rococo allows parachains to interact with the [Relay Chain](glossary.md##relay-chain)
rather than running in isolation. Rococo utilizes [Cumulus](build-cumulus.md) and HRMP (Horizontal Relay-routed Message
Passing), which is also known as [XCMP-lite](learn-crosschain.md##xcmp-lite(hrmp)), in order to send transfers and messages
between parachains and the Relay Chain.

Messages are sent to the Relay Chain -> then from the Relay Chain to the desired parachain. Rococo
currently runs three test system parachains: Tick, Trick, and Track, as well as several externally developed
parachains.

## What Parachains are on Rococo Now?

You can see the list of included parachains
[here](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/parachains). A list of
proposed parachains is available
[here](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/parachains/proposals).
You can view the list of included parachains on
[Polkadot-JS Apps](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/parachains),
and a list of
[proposed parachains](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/parachains/proposals).

## Obtaining ROC

ROC are available in the [Rococo Faucet](https://app.element.io/#/room/#rococo-faucet:matrix.org)
channel on Matrix. To receive ROC tokens, use the command:
ROC is the native testnet token on the Rococo testnet, and are available in the
[Rococo Faucet](https://app.element.io/#/room/#rococo-faucet:matrix.org) channel on Matrix.
To receive ROC tokens, send the following command on the channel:

```
!drip YOUR_ROCOCO_ADDRESS
Expand All @@ -34,14 +38,15 @@ parachains.

If you are interested in running and launching your own parathread or parachain, Parity Technologies
has created a [cumulus parachain workshop](https://substrate.dev/cumulus-workshop/) to show you how.

Get stuck or need support along the way? Join the
[Rococo matrix chat channel](https://matrix.to/#/#rococo:matrix.parity.io) and connect with other
builders there.

## How to connect to a Parachain

If you would like to connect to a parachain via [Polkadot-JS Apps](https://polkadot.js.org/apps/),
you may do so by clicking on the network selection at the top left hand corner of the navigation and
you may do so by clicking on the network selection at the top-left hand corner of the navigation and
selecting any parachain of choice. For the purpose of these following examples, we will be using the
Rococo testnet "Custom Node" underneath "Development", following the
[parachain workshop](https://substrate.dev/cumulus-workshop/).
Expand Down Expand Up @@ -85,11 +90,11 @@ another parachain.

### Lateral Transfers

This type of transfer is only possible with at least two different registered parachains. In true
Lateral transfers are only possible with at least two different registered parachains. In true
XCMP, lateral transfers would allow for messages to be sent directly from one parachain to another.
However, this is not yet implemented, so the Relay Chain is helping us deliver messages for the time
being. Lateral transfers work through the depository model, which means that in order to transfer
tokens from chain 200 to chain 300, there must already be tokens owned by chain 200 deposited on
tokens from chain 200 to chain 300, tokens must already be owned by chain 200 deposited on
chain 300. Lateral transfers are called HRMP, Horizontal Relay-Chain Message Passing.

Before we can actually send funds from one parachain to another, we must ensure that the chain's
Expand Down
27 changes: 2 additions & 25 deletions docs/kusama-endpoints.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ When interacting with the [Kusama network][] via [Polkadot-JS Apps][] or other U
methods, you'd ideally be running your own node ([text guide](maintain-sync.md),
[video guide](https://www.youtube.com/watch?v=31DdfcxbAVs)). Granted, that's not something everyone
wants to do, so convenience trumps ideals in most cases. To facilitate this convenience, Kusama has
several public endpoints you can use for your apps.
several public endpoints you can use for your apps provided by infrastructure and
API services providers in the ecosystem.

## Parity Archive Node

Expand All @@ -30,27 +31,3 @@ or in Polkadot-JS Apps by clicking the top-left corner of the screen and selecti
option:

<img src={require('./assets/endpoints/kusama_endpoint_parity.png').default} width="40%" />

## Web3 Foundation Archive Node

The Web3 Foundation maintains an archive node at endpoint `wss://cc3-5.kusama.network/`.

To connect to this node, use the endpoint in your JavaScript apps like so:

```javascript
const{ ApiPromise, WsProvider } = require('@polkadot/api')

(async () => {
const provider = new WsProvider('wss://cc3-5.kusama.network/')
const api = await ApiPromise.create({ provider })
// ...
```

Connect to it in Polkadot Apps UI by clicking the top-left corner of the screen and selecting the
appropriate option:

<img src={require('./assets/endpoints/kusama_endpoint_web3.png').default} width="40%" />

[kusama network]: https://kusama.network
[parity]: https://parity.io
[polkadot-js apps]: https://polkadot.js.org/apps
36 changes: 18 additions & 18 deletions docs/learn-account-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Step-by-step guides on generating a Polkadot account.
---

An address is the public part of a Polkadot account. The private part is the key used to access this
address. The public and private part together make up a Polkadot account.
address. The public and private parts together make up a Polkadot account.

There are several ways to generate a Polkadot account:

Expand All @@ -28,7 +28,7 @@ anyone they will have full access to your account, including all of your funds.
a target for hackers and others with bad intentions - see also
[How to Recognize Scams](learn-scams.md).

On this page we recommend a variety of account generation methods that have various convienience and
On this page, we recommend a variety of account generation methods that have various convenience and
security tradeoffs. Please review this page carefully before making your account so that you
understand the risks of the account generation method you choose and how to properly mitigate them
in order to keep your funds safe.
Expand All @@ -49,15 +49,15 @@ by storing in a sealed plastic bag to prevent water damage, storing it in a fire
it in metal, etc.) It is recommended that you store multiple copies of the seed in geographically
separate locations (e.g., one in your home safe and one in a safety deposit box at your bank).

You should definitely not store your seed on any kind of computer that has or may have access to the
internet in the future.
You should
**not store your seed on any kind of computer that has or may have access to the internet in the future.**

### Storing your account's JSON file

The JSON file is encrypted with a password, which means you can import it into any wallet which
supports JSON imports, but to then use it, you need the password. You don't have to be as careful
with your JSON file's storage as you would with your seed (i.e. it can be on a USB drive near you),
but remember that in this case your account is only as secure as the password you used to encrypt
but remember that in this case, your account is only as secure as the password you used to encrypt
it. Do not use easy to guess or hard to remember passwords. It is good practice to use a
[mnemonic password of four to five words](https://xkcd.com/936/). These are nearly impossible for
computers to guess due to the number of combinations possible, but much easier for humans to
Expand All @@ -69,17 +69,17 @@ The Polkadot{.js} plugin provides a reasonable balance of security and usability
separate local mechanism to generate your address and interact with Polkadot.

This method involves installing the Polkadot{.js} plugin and using it as a “virtual vault," separate
from your browser, to store your private keys. It also allows signing of transactions and similar
from your browser, to store your private keys. It also allows the signing of transactions and similar
functionality.

It is still running on the same computer you use to connected to the internet with and thus is less
It is still running on the same computer you use to connect to the internet with and thus is less
secure than using Parity Signer or other air-gapped approaches.

### Install the Browser Plugin

The browser plugin is available for both
[Google Chrome](https://chrome.google.com/webstore/detail/polkadot%7Bjs%7D-extension/mopnmbcafieddcagagdcbnhejhlodfdd?hl=en)
(and Chromium based browsers like Brave) and
(and Chromium-based browsers like Brave) and
[FireFox](https://addons.mozilla.org/en-US/firefox/addon/polkadot-js-extension).

If you would like to know more or review the code of the plugin yourself, you can visit the
Expand All @@ -94,7 +94,7 @@ of your browser.
### Create Account

Open the Polkadot{.js} browser extension by clicking the logo on the top bar of your browser. You
will see a browser popup not unlike the one below.
will see a browser popup, not unlike the one below.

![Initial PolkadotJS popup](assets/accounts/polkadot_plugin_js_new_01.png)

Expand Down Expand Up @@ -189,7 +189,7 @@ Click on the "Add Account" button. You should see a pop-up similar to the proces
using the [Polkadot JS Extension method](#polkadotjs-browser-plugin) above. Follow the same
instructions and remember to [store your seed safely](#storing-your-key-safely)!

### Create and Back Up Account
### Create and Back-Up Account

Click “Save” and your account will be created. It will also generate a
[backup JSON file](#storing-your-accounts-json-file) that you should safely store, ideally on a USB
Expand All @@ -206,7 +206,7 @@ multi-sig accounts). For a full explanation, please see the

On the [Accounts](https://polkadot.js.org/apps/#/accounts) tab, click the `Multisig` button. Enter
the threshold and add signatories. The threshold must be less than or equal to the number of
signatories. The threshold indicates how many members must be in agreement for an extrinsic
signatories. The threshold indicates how many members must agree for an extrinsic
submission to be successful. Click `Create` when done.

![Multi-sig account creation](assets/accounts/create-multisig.png)
Expand Down Expand Up @@ -235,7 +235,7 @@ second signatory must **repeat the call in full** in order to sign it. In other
- because the threshold is 2/3, Charlie can now finalize either or both of these by repeating the
desired transaction.

Other calls work exactly the same - if a multi-sig wants to become a Council member, the candidacy
Other calls work the same - if a multi-sig wants to become a Council member, the candidacy
request has to come from the multi-sig, but be signed (re-requested) from each signatory until the
threshold is reached.

Expand All @@ -245,9 +245,9 @@ communication lines on-chain.
> The bigger the multisig, the more of a deposit an account needs to put down when initiating a
> multi-sig call. This is to prevent chain storage spam with pending but never-resolved multi-sig
> transactions. Once a call is resolved (canceled or executed) the deposit is returned to the
> initiator. The deposit is not taken from the multi-sig's balance, but from the initiator.
> initiator. The deposit is not taken from the multi-sig's balance but from the initiator.

For a more in-depth introduction into multi signature accounts on Polkadot, please see
For a more in-depth introduction into multi-signature accounts on Polkadot, please see
[the accounts page section on Multi-sigs](learn-accounts.md#multi-signature-accounts).

## Parity Signer
Expand Down Expand Up @@ -286,7 +286,7 @@ You should write down this recovery phrase on paper and

After confirming that you have backed up your seed, a new textbox will appear in which you can set a
PIN. The PIN code should contain at least 6 digits. If the PIN codes do not match, it will not allow
you to create an account. The PIN code will be used for when signing any transaction, or to protect
you to create an account. The PIN code will be used when signing any transaction, or to protect
sensitive operations such as deleting an identity or revealing the recovery phrase.

Note that if someone knows the 12/24 words in your recovery phrase, they will still have control
Expand All @@ -302,7 +302,7 @@ identity.

![Parity Signer Create Account 5](assets/accounts/ps-create-5.jpg)

There is currently no way to copy your address from Parity signer in plain-text in order to send it
There is currently no way to copy your address from Parity signer in plain text in order to send it
via text or email. You must use the QR method.

### Your Address
Expand All @@ -312,7 +312,7 @@ to the [Accounts](https://polkadot.js.org/apps/#/accounts) page on an Internet-c
and click "Add via QR", and following the instructions to add the account. An account created this
way will always require you to sign messages with your Parity Signer device. It will do this only by
scanning and displaying QR codes, leaving even someone with total control of your internet-connected
computer a very small and limited scope for interacting with the Parity Signer device, which can
computer has a very small and limited scope for interacting with the Parity Signer device, which can
continue to keep your key safe.

![Parity Signer Create Account 6](assets/accounts/ps-create-6.jpg)
Expand All @@ -326,7 +326,7 @@ the instructions on our [Ledger hardware wallet guide page](learn-ledger.md).
## Vanity Generator

The vanity generator is a tool on [Polkadot-JS UI](https://polkadot.js.org/apps/#/accounts/vanity)
that lets you generate addresses which contain a specific substring.
that lets you generate addresses that contain a specific substring.

![Vanity Generator page](assets/polkadot_vanity_generator_page.png)

Expand Down