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

fix all docs.substrate.io links to use new site #3437

Merged
merged 1 commit into from Jun 27, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/build/build-index.md
Expand Up @@ -28,7 +28,7 @@ This section of the wiki is divided into the following parts:
## Tools & Resources

- [Tools](build-tools-index.md) - Maintained list of tools.
- [Subkey](https://docs.substrate.io/v3/tools/subkey/) - Command line utility for
- [Subkey](https://docs.substrate.io/reference/command-line-tools/subkey/) - Command line utility for
generating and inspecting key pairs.
- [JS tools](https://github.com/polkadot-js/tools) - TypeScript tools for offline signing of
transactions, RPC calls, and more.
Expand Down
6 changes: 3 additions & 3 deletions docs/build/build-node-interaction.md
Expand Up @@ -11,7 +11,7 @@ This page will guide you through some basic interactions with your node. This gu
seen as canonical reference. Always refer to the proper
documentation for the tool you are using:

- [Substrate RPC API](https://docs.substrate.io/rustdocs/latest/sc_rpc_api/index.html)
- [Substrate RPC API](https://paritytech.github.io/substrate/master/sc_rpc_api/index.html)
nuke-web3 marked this conversation as resolved.
Show resolved Hide resolved
- [Polkadot-JS RPC](https://polkadot.js.org/docs/substrate/rpc)
- [Substrate API Sidecar](https://github.com/paritytech/substrate-api-sidecar)

Expand Down Expand Up @@ -46,9 +46,9 @@ $ curl -H "Content-Type: application/json" -d '{"id":1, "jsonrpc":"2.0", "method
```

Some return values may not appear meaningful at first glance. Polkadot uses
[SCALE encoding](https://docs.substrate.io/v3/advanced/scale-codec/) as a format that is
[SCALE encoding](https://docs.substrate.io/reference/scale-codec/) as a format that is
suitable for resource-constrained execution environments. You will need to decode the information
and use the chain [metadata](https://docs.substrate.io/v3/runtime/metadata/)
and use the chain [metadata](https://docs.substrate.io/reference/command-line-tools/subxt/#metadata)
(`state_getMetadata`) to obtain human-readable information.

### Tracking the Chain Head
Expand Down
4 changes: 2 additions & 2 deletions docs/build/build-node-management.md
Expand Up @@ -89,7 +89,7 @@ can set a custom path with `--base-path <path>`.
The keystore stores session keys, which are important for validator operations.

- [Polkadot documentation](../learn/learn-keys.md/#session-keys)
- [Substrate documentation](https://docs.substrate.io/v3/concepts/session-keys/)
- [Substrate documentation](https://docs.substrate.io/main-docs/fundamentals/accounts-addresses-keys/#specialized-accounts)

**`db`**

Expand Down Expand Up @@ -170,5 +170,5 @@ puts your node at higher risk of attack. You can run your own, private

The node also exposes a Prometheus endpoint by default (disable with `--no-prometheus`). Substrate
has a
[vizualizing node metrics tutorial](https://docs.substrate.io/tutorials/v3/node-metrics/)
[monitor node metrics tutorial](https://docs.substrate.io/tutorials/get-started/node-metrics/)
which uses this endpoint.
8 changes: 4 additions & 4 deletions docs/build/build-parachains.md
Expand Up @@ -241,7 +241,7 @@ finalize, and treat as correct.

See the [Cumulus overview](https://github.com/paritytech/cumulus/blob/master/docs/overview.md) for a
more detailed description of Cumulus, and for those with experience in Substrate, give the
[Cumulus tutorial](https://docs.substrate.io/tutorials/v3/cumulus/start-relay/) a try.
[parachain tutorials](https://docs.substrate.io/tutorials/connect-other-chains/relay-chain/) a try.

Cumulus is still in development, but the idea is that it should be simple
to take a Substrate chain and add the parachain code by importing the crates and adding a single line
Expand Down Expand Up @@ -366,7 +366,7 @@ Once the executable is built, launch collators for your parachain:
```

If you are interested in running and launching your own parathread or parachain, Parity Technologies
has created a [Cumulus tutorial](https://docs.substrate.io/tutorials/v3/cumulus/start-relay/) to show you how.
has created [parachain tutorials](https://docs.substrate.io/tutorials/connect-other-chains/relay-chain/) to show you how.
Get stuck or need support along the way? Join the
[Parachain Technical matrix chat channel](https://matrix.to/#/#parachain-technical:matrix.parity.io)
and connect with other builders there.
Expand Down Expand Up @@ -444,7 +444,7 @@ 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
[Cumulus tutorial](https://docs.substrate.io/tutorials/v3/cumulus/start-relay/).
[parachain tutorials](https://docs.substrate.io/tutorials/connect-other-chains/relay-chain/).

### Parachain Playground

Expand Down Expand Up @@ -492,7 +492,7 @@ For more information on how parathread per-block auctions work, see the more det

## Resources

- [Parachains Guide Overview](https://docs.substrate.io/how-to-guides/v3/parachains/connect/)
- [Parachain tutorials](https://docs.substrate.io/tutorials/connect-other-chains/relay-chain/)
- [Common Good Parachains](https://polkadot.network/blog/common-good-parachains-an-introduction-to-governance-allocated-parachain-slots/)
- [The Launch of Parachains](https://polkadot.network/blog/the-launch-of-parachains/)
- [Parathreads: Pay-as-you-go Parachains](https://medium.com/polkadot-network/parathreads-pay-as-you-go-parachains-7440d23dde06)
Expand Down
19 changes: 9 additions & 10 deletions docs/build/build-protocol-info.md
Expand Up @@ -41,16 +41,15 @@ Polkadot (and Substrate) use the SS58 address format. This is a broad "meta-form
handle many different cryptographic schemes and chains. It has much in common with Bitcoin's
Base58Check format such as a version prefix, a hash-based checksum suffix, and base-58 encoding.

See the [SS58 page](https://docs.substrate.io/v3/advanced/ss58/) in the Substrate documentation for
See the [SS58 page](https://docs.substrate.io/main-docs/fundamentals/accounts-addresses-keys/#address-encoding-and-chain-specific-addresses) in the Substrate documentation for
encoding information and a more comprehensive list of network prefixes.

:::warning Do not use regular expressions (regex) to validate addresses

Always verify using the
prefix and checksum of the address. Substrate API Sidecar provides an
`accounts/{accountId}/validate` path that returns a boolean `isValid` response for a provided
address. If you want to validate addresses in another way, see the
[validation documentation](https://docs.substrate.io/v3/advanced/ss58/#validating-addresses).
DrW3RK marked this conversation as resolved.
Show resolved Hide resolved
address.

:::

Expand Down Expand Up @@ -109,7 +108,7 @@ transfers on Statemint. Statemint integration is discussed in the next page of t
## Free vs. Reserved vs. Locked vs. Vesting Balance

Account balance information is stored in
[`AccountData`](https://docs.substrate.io/rustdocs/latest/pallet_balances/struct.AccountData.html).
[`AccountData`](https://paritytech.github.io/substrate/master/pallet_balances/struct.AccountData.html).
Polkadot primarily deals with two types of balances: free and reserved.

For most operations, free balance is what you are interested in. It is the "power" of an account in
Expand All @@ -131,9 +130,9 @@ over time until all the funds are transferable.

More info:

- [Lockable Currency](https://docs.substrate.io/rustdocs/latest/frame_support/traits/trait.LockableCurrency.html)
- [Lock Withdraw Reasons](https://docs.substrate.io/rustdocs/latest/frame_support/traits/enum.WithdrawReason.html)
- [Vesting](https://docs.substrate.io/rustdocs/latest/pallet_vesting/struct.Vesting.html)
- [Lockable Currency](https://paritytech.github.io/substrate/master/frame_support/traits/trait.LockableCurrency.html)
- [Lock Withdraw Reasons](https://paritytech.github.io/substrate/master/frame_support/traits/struct.WithdrawReasons.html)
- [Vesting Info](https://paritytech.github.io/substrate/master/pallet_vesting/struct.VestingInfo.html)

## Extrinsics and Events

Expand All @@ -147,7 +146,7 @@ Extrinsics constitute information from the outside world and take on three forms

As an infrastructure provider, you will deal almost exclusively with signed transactions. You will,
however, see other extrinsics within the blocks that you decode. Find more information in the
[Substrate documentation](https://docs.substrate.io/v3/concepts/extrinsics/).
[Substrate documentation](https://docs.substrate.io/main-docs/build/tx-weights-fees/).

Inherents contain information that is not provably true, but validators agree on based on some
measure of reasonability. For example, a timestamp cannot be proved, but validators can agree that
Expand Down Expand Up @@ -223,7 +222,7 @@ The correct way to uniquely identify an extrinsic on a Substrate-based chain is
(height or hash) and the extrinsic's index. Substrate defines a block as a header and an array of
extrinsics; therefore, an index in the array at a canonical height will always uniquely identify a
transaction. This methodology is reflected in the Substrate codebase itself, for example to
[reference a previous transaction](https://docs.substrate.io/rustdocs/latest/pallet_multisig/struct.Timepoint.html)
[reference a previous transaction](https://paritytech.github.io/substrate/master/pallet_multisig/struct.Timepoint.html)
from the Multisig pallet.

### Events
Expand All @@ -248,7 +247,7 @@ Polkadot uses weight-based fees that, unlike gas, are charged _pre-dispatch._ Us

Parity's integration tools should allow you to deal with decoded data. If you'd like to bypass them
and interact directly with the chain data or implement your own codec, Polkadot encodes block and
transaction data using the [SCALE codec](https://docs.substrate.io/v3/advanced/scale-codec/).
transaction data using the [SCALE codec](https://docs.substrate.io/reference/scale-codec/).

## Runtime Upgrades

Expand Down
6 changes: 3 additions & 3 deletions docs/build/build-smart-contracts.md
Expand Up @@ -70,10 +70,10 @@ can also be mapped directly to and from Substrate's SS58 scheme from existing ac
### Substrate Contracts

Substrate offers a built-in
[contract pallet](https://docs.substrate.io/rustdocs/latest/pallet_contracts/index.html);
[contract pallet](https://paritytech.github.io/substrate/master/pallet_contracts/index.html);
as time goes on, more parachains will support [WebAssembly](../learn/learn-wasm.md) smart contracts.
Additionally, there is the
[EVM Pallet](https://docs.substrate.io/v3/runtime/smart-contracts/#evm-pallet), which allows
[EVM Pallet](https://github.com/paritytech/frontier/tree/master/frame/evm#evm-module), which allows
a parachain to implement the Ethereum Virtual Machine, thereby supporting almost direct ports of
Ethereum contracts.

Expand All @@ -90,7 +90,7 @@ Here is the list of current resources available to developers who want to get st
contracts to deploy on parachains based on Substrate.

- [ink!](https://github.com/paritytech/ink) - Parity's ink to write smart contracts.
- [Substrate ink! Workshop](https://docs.substrate.io/tutorials/v3/ink-workshop/pt1/) - Walks you
- [Substrate ink! Workshop](https://docs.substrate.io/tutorials/smart-contracts/develop-contract/) - Walks you
through the basics of writing and deploying an ERC-20 token using `ink!`.

### Contracts Pallet
Expand Down
2 changes: 1 addition & 1 deletion docs/build/build-ss58-registry.md
Expand Up @@ -6,7 +6,7 @@ description: Information about SS58 encoding.
slug: ../build-ss58-registry
---

:::note Substrate-based chains use an [SS58 encoding](https://docs.substrate.io/v3/advanced/ss58/) for their address formats.
:::note Substrate-based chains use an SS58 encoding for their address formats.
DrW3RK marked this conversation as resolved.
Show resolved Hide resolved

Please see the
[SS58 registry](https://github.com/paritytech/ss58-registry/) to see which
Expand Down
14 changes: 7 additions & 7 deletions docs/build/build-storage.md
Expand Up @@ -57,7 +57,7 @@ experimental [Parity database](https://github.com/paritytech/parity-db).
The database is used for components that require persistent storage
These are components like Substrate clients, Substrate light-clients & off-chain workers.
For more information, check out
Substrate Developer Hub's [Storage Page](https://docs.substrate.io/v3/advanced/storage/).
Substrate documentation [Storage Page](https://docs.substrate.io/main-docs/build/runtime-storage/).

:::

Expand All @@ -66,23 +66,23 @@ which gives access to Substrate's storage APIs. These storage items support valu
Parity's `SCALE (Simple Concatenated Aggregate Little-Endian) Codec`.

There is a
[`Storage Value`](https://docs.substrate.io/rustdocs/latest/frame_support/storage/trait.StorageValue.html) API
[`Storage Value`](https://paritytech.github.io/substrate/master/frame_support/storage/trait.StorageValue.html) API
that is used to store single values,
a [`Storage Map`](https://docs.substrate.io/rustdocs/latest/frame_support/storage/trait.StorageMap.html) API
a [`Storage Map`](https://paritytech.github.io/substrate/master/frame_support/storage/trait.StorageMap.html) API
that is used to a key-value hash map,
a [`Storage Double Map`](https://docs.substrate.io/rustdocs/latest/frame_support/storage/trait.StorageDoubleMap.html) API
a [`Storage Double Map`](https://paritytech.github.io/substrate/master/frame_support/storage/trait.StorageDoubleMap.html) API
that creates a `storage map` with two keys to provide the ability to efficiently remove all entries that have
a common first key, and a [`Storage N Map`](https://crates.parity.io/frame_support/storage/trait.StorageNMap.html)
a common first key, and a [`Storage N Map`](https://paritytech.github.io/substrate/master/frame_support/storage/trait.StorageNMap.html)
API that can be used to store a hash map with any arbitrary number of keys.

These layered APIs act as runtime storage that allows you to store data in your blockchain. More information can
be found at the [`Runtime Storage Page`](https://docs.substrate.io/v3/runtime/storage/) on Substrate Developer Hub.
be found at the [`Runtime Storage Page`](https://docs.substrate.io/main-docs/build/runtime-storage/) on Substrate Developer Hub.

### Crust Storage

[Crust Network](https://crust.network) provides a Web3.0 decentralized storage network for the Metaverse. It is designed to realize core values of decentralization, privacy, and assurance. Crust supports multiple storage-layer protocols such as [IPFS](#ipfs-interplanetary-file-system), and exposes instant accessible on-chain storage functions to users. Crustʼs technical stack is also capable of supporting data manipulating and computing.

Crust provides a native cross-chain communnication communication pallet based on [XCMP](https://wiki.polkadot.network/docs/learn-crosschain), called [xStorage](https://github.com/crustio/crust/tree/parachain/shadow/crust-collator/pallets/xstorage).
Crust provides a native cross-chain communication communication pallet based on [XCMP](https://wiki.polkadot.network/docs/learn-crosschain), called [xStorage](https://github.com/crustio/crust/tree/parachain/shadow/crust-collator/pallets/xstorage).

The protocol also supports most smart contract platforms, including Ethereum, with its [cross-chain dStorage solution](https://wiki.crust.network/docs/en/buildCrossChainSolution).

Expand Down
3 changes: 1 addition & 2 deletions docs/build/build-substrate.md
Expand Up @@ -21,7 +21,7 @@ this is done through two main approaches:
and insecure.

There is now a new paradigm: instead of specifying a centralized RPC node, developers just need to
define the blockchain's [chain specification](https://docs.substrate.io/v3/runtime/chain-specs/) for
define the blockchain's [chain specification](https://docs.substrate.io/main-docs/build/chain-spec/) for
their application to synchronize with the chain. This is possible with Substrate connect.

## What is Substrate Connect?
Expand Down Expand Up @@ -93,5 +93,4 @@ will be created in-page for them.
- [What is a light client and why you should care?](https://www.parity.io/blog/what-is-a-light-client/)
- [Introducing Substrate Connect: Browser-Based Light Clients for Connecting to Substrate Chains](https://www.parity.io/blog/introducing-substrate-connect)
- [Substrate connect GitHub Repo](https://github.com/paritytech/substrate-connect/tree/master/projects/extension)
- [Substrate connect Docs](https://docs.substrate.io/v3/integration/substrate-connect/)

14 changes: 3 additions & 11 deletions docs/build/build-tools-index.md
Expand Up @@ -120,7 +120,7 @@ usage instructions are provided at
Tool to construct, sign, and broadcast transactions. Signing can be done offline.
- [Polkadot API Cpp](https://github.com/usetech-llc/polkadot_api_cpp) - A С++ API for Polkadot, can
build `clip`, a command line tool.
- [Subkey](https://docs.substrate.io/v3/tools/subkey/) - Command line utility for
- [Subkey](https://docs.substrate.io/reference/command-line-tools/subkey/) - Command line utility for
generating and inspecting key pairs.

### WASM
Expand Down Expand Up @@ -159,7 +159,7 @@ WebAssembly related tools and projects.

### SCALE Codec

The [SCALE](https://docs.substrate.io/v3/advanced/scale-codec/) (Simple Concatenated
The SCALE (Simple Concatenated
Aggregate Little-Endian) Codec is a lightweight, efficient, binary serialization and deserialization
codec.

Expand All @@ -170,15 +170,7 @@ the decoding context has all type knowledge about the encoded data.
It is used in almost all communication to/from Substrate nodes, so implementations in different
languages exist:

- [Ruby](https://github.com/itering/scale.rb)
- [Rust](https://github.com/paritytech/parity-scale-codec)
- [Go](https://github.com/itering/scale.go)
- [C++](https://github.com/soramitsu/kagome/tree/master/core/scale)
- [TypeScript](https://github.com/polkadot-js/api)
- [AssemblyScript](https://github.com/LimeChain/as-scale-codec)
- [Haskell](https://github.com/airalab/hs-web3/tree/master/src/Codec)
- [Java](https://github.com/emeraldpay/polkaj)
- [Python](https://github.com/polkascan/py-scale-codec)
- [Substrate Awesome](https://github.com/substrate-developer-hub/awesome-substrate#scale-codec) maintains a list of SCALE codex implementations.

## Data Crawling and Conversion

Expand Down
4 changes: 2 additions & 2 deletions docs/build/build-transaction-construction.md
Expand Up @@ -73,7 +73,7 @@ in general the serialization format can be described as follows:

The metadata provides you with all of the information required to know how to construct the serialized call data
specific to your transaction. You can read more about the metadata, its format and how to get it in the
[Substrate documentation](https://docs.substrate.io/v3/runtime/metadata/).
[Substrate documentation](https://docs.substrate.io/reference/command-line-tools/subxt/#metadata).

\* Polkadot supports sr25519, ed25519, and ECDSA as signing schemes.

Expand Down Expand Up @@ -245,7 +245,7 @@ There are several ways to submit a signed payload:
## Notes

Some addresses to use in the examples. See
[Subkey documentation](https://docs.substrate.io/v3/tools/subkey/).
[Subkey documentation](https://docs.substrate.io/reference/command-line-tools/subkey/).

```bash
$ subkey --network polkadot generate
Expand Down
4 changes: 2 additions & 2 deletions docs/general/faq.md
Expand Up @@ -277,7 +277,7 @@ Of the protocols that are custom to Substrate, there are the legacy Substrate st
request-response for getting information on blocks (sync), a light client protocol, a notification
protocol for transactions, and block announcement. For detailed information on how Substrate uses
libp2p and the standard and custom protocols, please see the
[networking documentation](https://docs.substrate.io/rustdocs/latest/sc_network/index.html).
[networking documentation](https://paritytech.github.io/substrate/master/sc_network/index.html).

### How does libp2p differ from IPFS?

Expand Down Expand Up @@ -305,7 +305,7 @@ follows the following formula:
base_fee + (tx_length * length_fee) + WeightToFee(weight)
```

Please see the [fee calculation](https://docs.substrate.io/v3/runtime/weights-and-fees/) page in
Please see the [fee calculation](https://docs.substrate.io/reference/how-to-guides/weights/calculate-fees/) page in
the Substrate documentation for more detailed information.

## Answered by Gav series
Expand Down
2 changes: 1 addition & 1 deletion docs/general/glossary.md
Expand Up @@ -486,7 +486,7 @@ The [testnet](#testnet) set aside for testing parachains, cumulus, and related t

A system-level origin in [Substrate](#Substrate). This is the highest privilege level and can be
thought of as the superuser of the runtime origin. To learn about more raw origins in Substrate,
visit [Substrate Docs](https://docs.substrate.io/v3/runtime/origins/)
visit [Substrate Docs](https://docs.substrate.io/main-docs/build/origins/)

## Runtime

Expand Down