Skip to content

Commit

Permalink
Edit Polkadot JS sections Pt. 1 (#5340)
Browse files Browse the repository at this point in the history
* removed duplicated delegation dashboard section

* major edits

- Polkadot-JS guides
- descriptions, etc

* moved vault guides

* moved JS guides

* modified keywords

* rm js stuff from gov apps page

* rm js from crowdloan page

* minor removals

* created js guides page for ledger

* moved ledger derivation to advanced

- deleted js mention (not necessary)

* rm js mentions

* rm js content from vault page

* rm js from staking dashboard

* added links

* Update docs/general/how-to-dyor.md

Co-authored-by: Bill Laboon <[email protected]>

---------

Co-authored-by: Bill Laboon <[email protected]>
  • Loading branch information
filippoweb3 and laboon authored Nov 9, 2023
1 parent 0d02282 commit aba6f18
Show file tree
Hide file tree
Showing 21 changed files with 324 additions and 343 deletions.
8 changes: 8 additions & 0 deletions docs/general/governance-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,16 @@ Anyone interested in being listed as a delegate can add their details on the

:::

To make OpenGov multi-role delegation easy and intuitive,
[Delegation Dashboard](https://delegation.polkadot.network/) provides an interactive interface that
displays the list of delegates and their details. The video tutorial below walks through the
features of the Delegation Dashboard and shows how to perform multi-role delegation.

[![Delegation Dashboard Tutorial](https://img.youtube.com/vi/RapBYZc5ZPo/0.jpg)](https://www.youtube.com/watch?v=RapBYZc5ZPo)

For detailed instructions on how to delegate your voting power using dashboard, check
[this support guide.](https://support.polkadot.network/support/solutions/articles/65000184123-polkadot-opengov-how-to-delegate-your-voting-power).

## Polkassembly

![Polkassembly](https://github.com/w3f/polkadot-wiki/assets/874046/f2fc1032-ba81-465a-896c-51bd35efd435)
Expand Down
23 changes: 9 additions & 14 deletions docs/general/how-to-dyor.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,20 +317,15 @@ likely also surface. So, crowdloans require their own section to ensure particip
First of all, only projects that aim to become a parachain should have a crowdloan. If a project is
not a parachain candidate, there should not be a crowdloan associated with it.

The optimal way to participate in a parachain crowdloan is natively through the
[Crowdloan module](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fkusama-rpc.polkadot.io#/parachains/crowdloan)
on Polkadot-JS Apps. This issues a special extrinsic that locks your funds until the parachain slot
lease period ends and guarantees that your stake will be returned afterwards. You can learn more
about crowdloans through the link above and [here](https://kusama.network/auctions) for Kusama.

Many parachain candidates offer a way to participate through their site as well. However, you should
ensure that they are using the crowdloan pallet in the background and that they are simply wrapping
that in a nicer, more user-friendly interface. If their crowdloan interface _transfers_ funds to an
account instead, these funds will be totally under their control, and this means you need to fully
trust that the team will use the funds for the crowdloan, will return your share to you when the
lease period ends or if they do not win a slot, and will secure the funds properly. If their
crowdloan involves this kind of mechanism, it should be explicitly mentioned in their site and
documentation.
The optimal way to participate in a parachain crowdloan is through
on-chain, via one of the available [wallets or extensions](./wallets-and-extensions.md). Many parachain candidates offer a way to
participate through their site as well. However, you should ensure that they are using the crowdloan
pallet in the background and that they are simply wrapping that in a nicer, more user-friendly
interface. If their crowdloan interface _transfers_ funds to an account instead, these funds will be
totally under their control, and this means you need to fully trust that the team will use the funds
for the crowdloan, will return your share to you when the lease period ends or if they do not win a
slot, and will secure the funds properly. If their crowdloan involves this kind of mechanism, it
should be explicitly mentioned in their site and documentation.

That being said, some teams have been doing token sales or swaps in an attempt to get a head start
in raising funds for the auctions, but these are **not crowdloans** and still require full trust in
Expand Down
149 changes: 10 additions & 139 deletions docs/general/ledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,10 @@ functionalities.
If you do use a Nano S with the XL version you will not be able to:

- Install any other Ledger application on your device
- Add Polkadot accounts to the Ledger Live App, but you will be able to add them to
[**treasury-funded wallets**](./wallets-and-extensions.md) who support ledger devices or to the
[**browser extension**](./polkadotjs.md#polkadot-js-extension) and the
[**Polkadot-JS UI**](./polkadotjs-ui.md).
- Add Polkadot accounts to the Ledger Live App.

But you will be able to add them to [**wallets and extensions**](./wallets-and-extensions.md) that
support Ledger devices.

:::

Expand All @@ -82,142 +82,15 @@ Here is a list of what you will need before using
- The latest firmware of the {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} Ledger
App installed (always check for updates in Ledger Live under the "Manager" tab, you will need to
allow access with your nano).
- Ledger Live is installed and at version 2.1 or newer (see settings -> about to find out if you're
up to date).
- A Chromium-based web browser is installed that you can use to access the
[Polkadot-JS UI](https://www.ledger.com/).
- Ledger Live is installed and up-to-date.
- A Chromium-based web browser if you use a browser extension.

## Using Ledger Live

Check
See
[this support article](https://support.polkadot.network/support/solutions/articles/65000175822-how-to-use-polkadot-and-stake-with-ledger-live)
to learn how to use {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} with ledger live.

:::info

Ledger Live will only show the main account with BIP44 path 44'/354'/0'/0'/0'. This means that if
you import a [derived account using Polkadot-JS](#using-on-polkadot-js-apps) with a derivation path
44'/354'/0'/0'/1', it will not be displayed on the Ledger Live App. Consequently, it is not possible
to transact with derived accounts using the Ledger Live App, but it is possible to do so using
Polkadot-JS. Check [the accounts page](../learn/learn-accounts.md) for more information about
derived accounts and derivation paths.

:::

{{ kusama: Note that you cannot import Kusama Ledger accounts in Ledger Live. To see Kusama account balances, you must import your ledger account into a [**wallet**](./wallets). :kusama }}

## Using on Polkadot-JS Apps

### Loading Your Account

:::info

Ledger Live should be off while using Ledger with Polkadot-JS UI as it can interfere with normal
operation.

:::

You can import your Ledger account to [Polkadot Extension](https://polkadot.js.org/extension/) or to
the [Polkadot-JS UI](https://polkadot.js.org/apps/#/explorer). For instructions on how to import
Ledger accounts to the Polkadot Extension read through
[this support article](https://support.polkadot.network/support/solutions/articles/65000175387-how-to-add-your-ledger-through-the-polkadot-extension),
while if you want to import Ledger accounts to the Polkadot-JS UI you can consult
[this other article](https://support.polkadot.network/support/solutions/articles/65000170812-how-to-add-ledger-account-through-the-polkadot-js-ui).

#### Derivation paths

When adding a Ledger account using the extension or the UI, you will be asked to select an
`account type` and an `account index`. The first lets you select an account, while the second lets
you pick a derivation path from that account - think of it like a formula from which child accounts
are generated. When you are creating a
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} ledger account for the first time on
Ledger Live with name {{ polkadot: `Polkadot 1` :polkadot }}{{ kusama: `Kusama 1` :kusama }}, this
can be added to Polkadot-JS using the 0/0 derivation path (i.e. account type = 0 and account index =
0). If you add a second account called
{{ polkadot: `Polkadot 2` :polkadot }}{{ kusama: `Kusama 2` :kusama }}, this will correspond to the
1/0 derivation path, and so on. We thus have multiple parent accounts that can be viewed and used in
both Ledger Live and Polkadot-JS. Additionally, we can use Polkadot-JS UI to create multiple
children accounts from each parent account. For example,
{{ polkadot: `Polkadot 1` :polkadot }}{{ kusama: `Kusama 1` :kusama }} with 0/0 derivation path can
have child 0/1, 0/2, etc. that can be used within the UI. However, such children accounts cannot be
used in Ledger Live, as it only scans through the parent accounts. So, remember that the balances on
the children accounts cannot be viewed, and you will not be able to transact with those accounts on
Ledger Live.

#### Connecting your ledger device

While using a ledger device to sign transactions, depending on your browser and its security
settings, you might need to confirm the USB connection through a popup like the one below:

![Display the device connection popup](../assets/ledger/query-device.png)

If you are adding your Ledger Nano for the first time, click on the "Unknown device" line and the
"Connect" button will become available.

:::info Signature error message

If you have already connected your device, but an error message appears before signing a
transaction, make sure you have opened the
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} application on your Ledger Nano
device. Visit
[this support page](https://support.polkadot.network/support/solutions/articles/65000181994) for
more information about signing transactions using your ledger.

:::

### Confirming the Address on your Device

To display your {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} ledger account
address on your Ledger Nano, you can follow the guidelines on
[this support article](https://support.polkadot.network/support/solutions/articles/65000181854-how-to-confirm-your-account-address-on-your-ledger-device).
Here you can scroll through and make sure the address matches what is displayed on
[Polkadot-JS UI](https://polkadot.js.org/apps/#/explorer).

### Checking the Balance of Your Account

There are a few methods to check the balance of your account. Check out
[this support article](https://support.polkadot.network/support/solutions/articles/65000169332-where-can-i-see-the-balance-of-my-account-)
for information.

### Sending a Transfer

General instructions to send a transfer can be found on
[this support page](https://support.polkadot.network/support/solutions/articles/65000170304-how-to-send-transfer-funds-out-of-your-dot-account-on-the-polkadot-js-ui).
To sign transactions with your Ledger nano check
[this support article](https://support.polkadot.network/support/solutions/articles/65000181994).

### Receiving a Transfer

To receive a transfer on the accounts stored on your Ledger device, you must provide the sender
(i.e. the payer) with your address. To do so, follow the instructions on
[this support page](https://support.polkadot.network/support/solutions/articles/65000181866-how-to-receive-dot-to-my-account-on-polkadot-js-ui).

:::warning

Before giving anyone your address, ensure it matches what's on the Ledger by
[confirming the address on your device](#confirming-the-address-on-your-device). Some malware will
intercept clicks and clipboard requests and can change your copied value in-flight, so being extra
vigilant around copy-paste operations makes sense.

:::

### Staking

For staking using Ledger devices, check the section "How to stake using your Ledger" on
[this support article](https://support.polkadot.network/support/solutions/articles/65000168057-how-do-i-stake-nominate-on-polkadot-).

### Removing Expired Democracy Locks

Check out
[this support page](https://support.polkadot.network/support/solutions/articles/65000181870-how-to-remove-expired-democracy-locks)
the learn how to remove democracy locks after the end of a Governance referendum.

**Please be advised**: Despite the Polkadot ledger application being compatible with both the Ledger
Nano S and the Ledger Nano X, none of the [Democracy](../maintain/maintain-guides-democracy.md)
extrinsics are available in the light version. The following
[repository by Zondax](https://github.com/Zondax/ledger-polkadot) lists the currently supported
Democracy extrinsics on the full ledger.

## Ledger Developer Release

:::warning
Expand All @@ -235,11 +108,9 @@ they are made available on a developer release for testing purposes. After a suc
review, the apps would be available for download and installation using
[Ledger Live](https://www.ledger.com/ledger-live). As it takes some time for Ledger to audit and
review the release, the app upgrade option may not be available on Ledger Live when the new runtime
is deployed on the network. If this happens, users cannot use Ledger devices with the Polkadot-JS
UI, and while signing for a transaction, will most likely incur the error message "txn version not
supported". Please do not panic if this happens, as there are solutions to this problem. Suppose you
cannot wait a few days until the app passes the Ledger audit, you can install the developer release
from the shell using the latest version published on
is deployed on the network. If this happens, users cannot use Ledger devices to sign transactions.
Suppose you cannot wait a few days until the app passes the Ledger audit, you can install the
developer release from the shell using the latest version published on
[the Zondax GitHub repository](https://github.com/Zondax/ledger-polkadot/releases).

### Install the Developer Release
Expand Down
2 changes: 1 addition & 1 deletion docs/general/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ slug: ../metadata
import Metadata from "./../../components/Metadata";

The `Metadata Explorer` tool helps visualize the metadata of various parachains by retrieving the
latest data directly from the chain using the [polkadot-js api](https://github.com/polkadot-js/api).
latest data directly from the chain using the [polkadot-js api](./polkadotjs.md#polkadot-js-api).
The dropdown below allows you to update the chain selection to visualize. You can search all
sub-categories using the provided search field. The information is categorized by the chains
`Pallets`, `RPC` and `Runtime` information.
Expand Down
2 changes: 1 addition & 1 deletion docs/general/multisig-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ for more information about using [Multix](https://multix.chainsafe.io/) for mult
The [Multix tool](https://multix.chainsafe.io/) is an easy-to-use interface to manage complex
multisigs. The tool is part of
[the open-source Polkadot/Kusama Tech Stack](https://wiki.polkadot.network/docs/build-open-source#user-interface).
Besides being user-friendly, Multix provides several benefits compared to the Polkadot-JS UI:
Besides being user-friendly, Multix provides several benefits:

- When one person creates the multisig account, all the signatories see the multisig account on
their interface.
Expand Down
13 changes: 3 additions & 10 deletions docs/general/polkadot-vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,9 @@ example, you can have an air-gapped laptop with the Subkey tool installed and ge
there. The seed phrase of that account can be imported into the Vault App (Add Key Set > Recover Key
Set).

We recommend importing a Vault account into the
[Polkadot-JS Browser Extension](./polkadotjs.md#polkadot-js-extension) or
[Parity Signer Companion](https://chrome.google.com/webstore/detail/parity-signer-companion/damllfnhhcbmclmjilomenbhkappdjgb).
Alternatively, you can import a Vault account directly into the Polkadot-JS UI but keep in mind that
clearing the cache of your browser will remove those accounts (this will not happen for accounts
imported into an extension). See the instructions in
[this article](https://support.polkadot.network/support/solutions/articles/65000184076-polkadot-vault-how-to-create-an-account)
to learn more about creating Vault accounts, and
[this article](https://support.polkadot.network/support/solutions/articles/65000184118-polkadot-vault-how-to-add-your-account-on-polkadot-js-ui)
on how to import them to the Polkadot extension or Polkadot-JS UI.
See the instructions in
[this support article](https://support.polkadot.network/support/solutions/articles/65000184076-polkadot-vault-how-to-create-an-account)
to learn more about creating Vault accounts.

:::info

Expand Down
2 changes: 1 addition & 1 deletion docs/general/polkadotjs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: polkadotjs
title: Polkadot-JS
title: Polkadot-JS Tooling
sidebar_label: Polkadot-JS Tooling
description: The Polkadot-JS Tool Collection.
keywords: [polkadotjs, polkadotjs apps, apps UI, extension]
Expand Down
7 changes: 5 additions & 2 deletions docs/general/staking-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,11 @@ Users can also create their nomination pools. The dashboard supports [Ledger](..
PolkaGate, and Enkrypt. The dashboard also supports
[staking proxies](../learn/learn-proxies.md#staking-proxy).

You can find more information about the Polkadot staking dashboard on the
[dedicated page](./staking-dashboard.md).
You can find more information about the Polkadot staking dashboard on the dedicated
[wiki page](./staking-dashboard.md) and
[support articles](https://support.polkadot.network/support/solutions/folders/65000157523).

Below a list of video tutorial about the Polkadot Staking Dashboard.

<tr class="cards-container">
<td>
Expand Down
13 changes: 6 additions & 7 deletions docs/general/staking-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ extension or a wallet to use it; you just need your Ledger device.
only need to keep your Ledger apps up-to-date.

Before using the dashboard, make sure you have a
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} account in a Ledger device with the
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} Ledger app installed, or a browser
extension such as the [Polkadot-JS Extension](./polkadotjs.md#polkadot-js-extension) or
[other third-party extensions](./wallets-and-extensions.md#browser-extensions) with a funded
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} account.
[wallet or extension](./wallets-and-extensions.md#browser-extensions) with a funded
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} account. Note that accounts on
wallets or extensions can be imported from [Ledger](./ledger.md) or
[Polkadot Vault](./polkadot-vault.md).

On top of the [existential deposit](../learn/learn-accounts.md#existential-deposit-and-reaping), you
need some free balance to pay for [transaction fees](../learn/learn-transaction-fees.md) and the
Expand All @@ -47,8 +46,8 @@ dedicated to [staking](../learn/learn-staking.md) on Polkadot,
[Westend](../maintain/maintain-networks.md#westend-test-network) (Polkadot's test network).

The dashboard is not a wallet, meaning that you cannot transfer funds between accounts. To fund
accounts, you can use [supported wallets](./wallets) or the [Polkadot-JS UI](./polkadotjs-ui.md).
You can participate in staking by being a [nominator](../learn/learn-nominator.md) or a member of a
accounts, you can use [wallets and extension](./wallets-and-extensions.md). You can participate in
staking by being a [nominator](../learn/learn-nominator.md) or a member of a
[nomination pool](../learn/learn-nomination-pools.md). Once you have a funded account, you need to
connect it to the dashboard (connect button on the top-right corner), this will allow you to
interact with {{ polkadot: Polkadot's :polkadot }}{{ kusama: Kusama's :kusama }} native staking.
Expand Down
Loading

0 comments on commit aba6f18

Please sign in to comment.