Skip to content

Commit

Permalink
edits (#6244)
Browse files Browse the repository at this point in the history
  • Loading branch information
filippoweb3 committed Sep 19, 2024
1 parent 5ccf42d commit 7a493a0
Show file tree
Hide file tree
Showing 45 changed files with 233 additions and 233 deletions.
4 changes: 2 additions & 2 deletions docs/build/build-client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ As with any blockchain, building decentralized applications (dApps) is a signifi
developer can build on Polkadot.

As an application developer, you can compose your front-end apps in a few different ways. Because
the Relay Chain and its parachains are all built using the Polkadot SDK. You can often use the same
SDK to communicate with the Relay Chain, a parachain, or any other Substrate-based chain.
the relay chain and its parachains are all built using the Polkadot SDK. You can often use the same
SDK to communicate with the relay chain, a parachain, or any other Substrate-based chain.

:::note Substrate-based chains use an SS58 encoding for their address formats.

Expand Down
8 changes: 4 additions & 4 deletions docs/build/build-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ in order to gain context about the application you could make.

## Building Parachains

Polkadot is canonically referred to as the Relay Chain. It is also considered a _layer zero_
Polkadot is canonically referred to as the relay chain. It is also considered a _layer zero_
protocol, as it enables the interoperability and shared security of multiple
[parachains](../learn/learn-parachains.md), which are _layer one_ protocols. Parachains currently
connect to a relay chain using the [Parachains Protocol](../learn/learn-parachains-protocol.md).
Expand Down Expand Up @@ -140,8 +140,8 @@ benchmarks.
:::info What is an on-demand parachain?

On-demand parachains use a "pay-as-you-go" model enabled by Agile Coretime to interact with the
Relay Chain. On-demand parachains will only produce a block when needed, unlike full parachains,
which have access to bulk coretime to produce a block at every block of the Relay Chain. When
relay chain. On-demand parachains will only produce a block when needed, unlike full parachains,
which have access to bulk coretime to produce a block at every block of the relay chain. When
building an on-demand parachain, you will use the same tools (like PDKs) and get all the benefits of
building a parachain without the cost drawback of purchasing bulk coretime.

Expand Down Expand Up @@ -221,7 +221,7 @@ get started on building and deploying a parachain.
#### Parachains Benefits

Parachains contain their own runtime/STF logic and benefit from the shared security and the
cross-consensus messaging provided by the Relay Chain. Parachains permit high flexibility and
cross-consensus messaging provided by the relay chain. Parachains permit high flexibility and
customization but require more effort to create and maintain over time. A production-grade parachain
is typically more involved to create due to the complexity involved in blockchain networks'
technical and economic aspects.
Expand Down
8 changes: 4 additions & 4 deletions docs/build/build-hrmp-channels.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ slug: ../build-hrmp-channels
---

In order to communicate over [HRMP](../learn/learn-xcm-transport.md#hrmp-xcmp-lite), parachains must
establish channels by registering them on the Relay Chain. Like
establish channels by registering them on the relay chain. Like
[XCMP](../learn/learn-xcm-transport.md#xcmp-cross-chain-message-passing), HRMP is a message
transport protocol, but passes all messages via the Relay Chain. When XCMP is implemented on
transport protocol, but passes all messages via the relay chain. When XCMP is implemented on
Polkadot, HRMP is planned to be deprecated and phased out.

HRMP channels are uni-directional. Bi-directional communication between two parachains will require
Expand All @@ -23,7 +23,7 @@ channel request and then the second chain accepting it. When neither chain is a
[system chain](../learn/learn-system-chains.md), they will use the `hrmpInitOpenChannel` and
`hrmpAcceptOpenChannel` calls, respectively.

Each chain must dispatch the following calls on the Relay Chain from its parachain origin.
Each chain must dispatch the following calls on the relay chain from its parachain origin.

1. `hrmp > hrmpInitOpenChannel(recipient, proposedMaxCapacity, proposedMaxMessageSize)`: Initiates
channel establishment by creating a channel request with a given configuration. Note that the max
Expand All @@ -32,7 +32,7 @@ Each chain must dispatch the following calls on the Relay Chain from its paracha
2. `hrmp > hrmpAcceptOpenChannel(sender)`: Accept the channel open request from the given sender.

In order to dispatch a call from its sovereign origin, a parachain may use governance to send the
encoded call in a `Transact` instruction to the Relay Chain, but it may also execute this logic
encoded call in a `Transact` instruction to the relay chain, but it may also execute this logic
autonomously (e.g. on the notification that a channel was requested).

### Examples of HRMP Channel Management
Expand Down
30 changes: 15 additions & 15 deletions docs/build/build-integrate-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [assets, integration, api, operations]
slug: ../build-integrate-assets
---

The Relay Chain does not natively support assets beyond its native token. This functionality exists
The relay chain does not natively support assets beyond its native token. This functionality exists
in parachains. On both Polkadot and Kusama, this parachain is called Asset Hub.

The Asset Hub provides a first-class interface for creating, managing, and using fungible and
Expand All @@ -19,18 +19,18 @@ Beyond merely supporting assets, integrating an Asset Hub into your systems has
infrastructure providers and users:

- Support for on-chain assets.
- Significantly lower transaction fees (about 1/10) than the Relay Chain.
- Significantly lower deposits (1/100) than the Relay Chain. This includes the existential deposit
- Significantly lower transaction fees (about 1/10) than the relay chain.
- Significantly lower deposits (1/100) than the relay chain. This includes the existential deposit
and deposits for proxy/multisig operations.
- Ability to pay transaction fees in certain assets. As in, accounts would **not** need DOT to exist
on-chain or pay fees.

The Asset Hub will use DOT as its native currency. Users can transfer DOT from the Relay Chain into
the Asset Hub and use it natively. The Relay Chain will also accept DOT transfers from the Asset Hub
back to the Relay Chain for staking, governance, or any other activity.
The Asset Hub will use DOT as its native currency. Users can transfer DOT from the relay chain into
the Asset Hub and use it natively. The relay chain will also accept DOT transfers from the Asset Hub
back to the relay chain for staking, governance, or any other activity.

Using the Asset Hub for DOT/KSM balance transfers will be much more efficient than the Relay Chain
and is highly recommended. Until domain-specific parachains are built, the Relay Chain will still
Using the Asset Hub for DOT/KSM balance transfers will be much more efficient than the relay chain
and is highly recommended. Until domain-specific parachains are built, the relay chain will still
need to be used for staking and governance.

## Assets Basics
Expand Down Expand Up @@ -71,7 +71,7 @@ transfers.

Note that you can use the same addresses (except
[pure proxies](../learn/learn-proxies-pure.md#anonymous-proxy-pure-proxy)!) on the Asset Hub that
you use on the Relay Chain. The SS58 encodings are the same; only the chain information (genesis
you use on the relay chain. The SS58 encodings are the same; only the chain information (genesis
hash, etc.) will change on transaction construction.

#### Paying Transaction Fees in Another Asset
Expand Down Expand Up @@ -138,7 +138,7 @@ issue so a developer can help.
### Parachain Node

Using the Asset Hub will require running a parachain node to sync the chain. This is very similar to
running a Relay Chain node, with the addition of some extra flags. You can follow
running a relay chain node, with the addition of some extra flags. You can follow
[these guidelines](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus#asset-hub-) to set
up an Asset Hub node.

Expand All @@ -154,7 +154,7 @@ the complete documentation, including installation guide and usage examples.

### Sidecar

API Sidecar is a REST service for Relay Chain and parachain nodes. It comes with endpoints to query
API Sidecar is a REST service for relay chain and parachain nodes. It comes with endpoints to query
information about assets and asset balances on the Asset Hub.

- Asset lookups always use the `AssetId` to refer to an asset class. On-chain metadata is subject to
Expand Down Expand Up @@ -182,19 +182,19 @@ or any other critical purpose.

TxWrapper Polkadot is a library designed to facilitate transaction construction and signing in
offline environments. It comes with asset-specific functions to use on the Asset Hub. When
constructing parachain transactions, you can use `txwrapper-polkadot` exactly as on the Relay Chain,
constructing parachain transactions, you can use `txwrapper-polkadot` exactly as on the relay chain,
but construct transactions with the appropriate parachain metadata like genesis hash, spec version,
and type registry.

### XCM Transfer Monitoring

#### Monitoring of XCM deposits

Thanks to XCM and a growing number of parachains, the Relay Chain native token can exist across
Thanks to XCM and a growing number of parachains, the relay chain native token can exist across
several blockchains, which means the providers need to monitor cross-chain transfers on top of local
transfers and corresponding `balances.transfer` events.

Currently, DOT can be sent and received in the Relay Chain and in the Asset Hub either with a
Currently, DOT can be sent and received in the relay chain and in the Asset Hub either with a
[Teleport](https://wiki.polkadot.network/docs/learn-teleport) from
[system parachains](https://wiki.polkadot.network/docs/learn-system-chains) or with a
[Reserve Backed Transfer](https://wiki.polkadot.network/docs/learn-xcm-pallet#transfer-reserve-vs-teleport)
Expand All @@ -212,7 +212,7 @@ that emitted the relevant `balances.minted` event. This can be done as follows:
1. Query the relevant chain `at` the block the `balances.minted` event was emitted.
2. Filter for a `messageQueue(Processed)` event, also emitted during block initialization. This
event has a parameter `Id`. The value of `Id` identifies the cross-chain message received in the
Relay Chain or in the Asset Hub. It can be used to track back the message in the origin parachain
relay chain or in the Asset Hub. It can be used to track back the message in the origin parachain
if needed. Note that a block may contain several `messageQueue(Processed)` events corresponding
to several cross-chain messages processed for this block.

Expand Down
32 changes: 16 additions & 16 deletions docs/build/build-parachains.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [build, parachain, develop, implement, PDK]
slug: ../build-pdk
---

Parachains are connected to and secured by the Relay Chain. They benefit from the _pooled security_,
Parachains are connected to and secured by the relay chain. They benefit from the _pooled security_,
_thought-through governance_, and overall _scalability_ of the heterogeneous sharding approach of
the network. Creating a parachain can be seen as creating a **Layer-1 blockchain**, which has its
own logic and runs in parallel within the Polkadot ecosystem.
Expand Down Expand Up @@ -66,7 +66,7 @@ faced with the network constraint of processing transactions in sequence, causin
#### Interoperability

Any decentralised application or chain that wants to enable trustless messaging to other parachains
already connected to the Relay Chain would want to become a parachain. Interoperability between
already connected to the relay chain would want to become a parachain. Interoperability between
sovereign chains involves certain constraints and complex protocols to enable across a wide breadth
of chains.

Expand Down Expand Up @@ -125,7 +125,7 @@ parachain. They can be incentivized with a native token payout from:

### Para-objects

:::info The Relay Chain can host arbitrary state machines, not just blockchains.
:::info The relay chain can host arbitrary state machines, not just blockchains.

The Polkadot network will encourage the connection and interoperability between different
_para-objects_.
Expand All @@ -139,12 +139,12 @@ These could be in the form of:

- System level chains (permanent chains): [leased slots](../learn/learn-auction.md)
- [Bridge](../learn/learn-bridges.md) Hubs
- Nested Relay Chains
- Nested relay chains

### Migration

Projects that are already functioning as "solochains" or in isolated environments may be interested
in migrating onto the Relay Chain as a para-object. While the parachain model has its benefits, it
in migrating onto the relay chain as a para-object. While the parachain model has its benefits, it
may not be the go-to strategy for some projects.

As a path for migration onto Polkadot, it may be more viable to migrate to one of the chains in one
Expand Down Expand Up @@ -196,7 +196,7 @@ Currently, the only PDK is
**[Substrate](https://substrate.io/)** is a blockchain framework that provides the basic building
blocks of a blockchain (things like the networking layer, consensus, a Wasm interpreter) while
providing an intuitive way to construct your runtime. Substrate is made to ease the process of
creating a new chain, but it does not provide support for Relay Chain compatibility directly. For
creating a new chain, but it does not provide support for relay chain compatibility directly. For
this reason, `Cumulus`, an added _library_ contains all of the Polkadot compatibility glue code.

:::note Get started with Substrate
Expand All @@ -220,7 +220,7 @@ beautiful and functional.
Substrate that makes it easy to make any Substrate-built runtime into a Polkadot-compatible
parachain.

Cumulus Consensus is a consensus engine for Substrate that follows a Relay Chain. This runs a Relay
Cumulus Consensus is a consensus engine for Substrate that follows a relay chain. This runs a Relay
Chain node internally, and dictates to the client and synchronization algorithms which chain to
follow, finalize, and treat as correct.

Expand All @@ -243,11 +243,11 @@ Everything else is up to the implementer of the PDK.
:::

Cumulus handles the network compatibility overhead that any parachain would need to implement to be
connected to the Relay Chain. This includes:
connected to the relay chain. This includes:

- Cross-chain message passing (XCMP)
- Out-of-the-box Collator node setup
- An embedded full client of the Relay Chain
- An embedded full client of the relay chain
- Block authorship compatibility

Are you interested in building a PDK? See the [future PDKs](#future-pdks) section for details.
Expand All @@ -256,21 +256,21 @@ Are you interested in building a PDK? See the [future PDKs](#future-pdks) sectio

After creating your chain runtime logic with Substrate, you will be able to compile it down to a
Wasm executable. This Wasm code blob will contain the entire state transition function of your
chain, and is what you will need to deploy your project to the Relay Chain as a parachain.
chain, and is what you will need to deploy your project to the relay chain as a parachain.

Validators on the Relay Chain will use the submitted Wasm code to validate the state transitions of
Validators on the relay chain will use the submitted Wasm code to validate the state transitions of
your chain or thread, but doing this requires some additional infrastructure. A validator needs some
way to stay up to date with the most recent state transitions, since Relay Chain nodes will not be
way to stay up to date with the most recent state transitions, since relay chain nodes will not be
required to also be nodes of your chain.

This is where the collator node comes into play. A collator is a maintainer of your parachain and
performs the critical action of producing new block candidates for your chain and passing them to
Relay Chain validators for inclusion in the Relay Chain.
relay chain validators for inclusion in the relay chain.

Substrate comes with its own networking layer built-in but unfortunately only supports solo chains
(that is, chains that do not connect to the relay chain). However, there is the Cumulus extension
that includes a collator node and allows for your Substrate-built logic to be compatible with the
Relay Chain as a parachain.
relay chain as a parachain.

### Future PDKs

Expand All @@ -290,7 +290,7 @@ updates** into a single on-chain update. It should be straightforward to see how
this to the parachain terms. The state transition function for a roll-up-like parachain would be
updating the state (in practice, most likely a Merkle tree, which would be easily verifiable) from
the user inputs. The operator would act as the collator node, which would aggregate the state and
create the zk-SNARK proof that it would hand to a Relay Chain's validators for verification.
create the zk-SNARK proof that it would hand to a relay chain's validators for verification.

If you or your team are interested in developing a PDK feel free to apply for a grant on the
[W3F Grants Program repository](https://github.com/w3f/Grants-Program). There may be grants
Expand Down Expand Up @@ -355,7 +355,7 @@ Then, connect your local node with Polkadot-JS Apps.

## Deploy

Substrate-based chains, including the Polkadot and Kusama Relay Chains, use an
Substrate-based chains, including the Polkadot and Kusama relay chains, use an
[SS58 encoding](../learn/learn-account-advanced.md#address-format) for their address formats.
[This page](https://github.com/paritytech/ss58-registry/blob/main/ss58-registry.json) serves as the
canonical registry for teams to see which chain corresponds to a given prefix, and which prefixes
Expand Down
2 changes: 1 addition & 1 deletion docs/build/build-protocol-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ interface is broken/not compatible.

## Smart Contracts

The Polkadot Relay Chain does not support smart contracts, but a number of its parachains do,
The Polkadot relay chain does not support smart contracts, but a number of its parachains do,
[see here for more.](./build-smart-contracts.md)

## Other F.A.Q.
Expand Down
10 changes: 5 additions & 5 deletions docs/build/build-smart-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [build, smart contract, evm, wasm]
slug: ../build-smart-contracts
---

The Relay Chain which is a layer 0 blockchain, does not support smart contracts natively. However,
The relay chain which is a layer 0 blockchain, does not support smart contracts natively. However,
parachains which are layer 1 blockchains are equipped with the functionality to support smart
contracts.

Expand Down Expand Up @@ -51,12 +51,12 @@ Leaving certain logic, such as complex loops that could run indefinitely, to a n
layer, or even trying to eliminate it, will often be a wiser choice. Parachains try to be proactive,
while smart contract platforms are event-driven.

Relay Chain and parachians typically use the _weight-fee model_ and not a _gas-metering model_.
relay chain and parachians typically use the _weight-fee model_ and not a _gas-metering model_.

## Building a Smart Contract

The Relay Chain does not natively support smart contracts. However, since the parachains that
connect to the Relay Chain can support arbitrary state transitions, they support smart contracts.
The relay chain does not natively support smart contracts. However, since the parachains that
connect to the relay chain can support arbitrary state transitions, they support smart contracts.

Substrate presently supports smart contracts out-of-the-box in several ways:

Expand Down Expand Up @@ -168,7 +168,7 @@ smart contract example? Ask us to add it to this page!**

## Smart Contract Environments

It is still early for smart contracts on the Relay Chain and the development is only now
It is still early for smart contracts on the relay chain and the development is only now
stabilizing. We are actively producing content to help developers get up to speed and will maintain
the Wiki with the latest resources. You should also keep up to date with the following links:

Expand Down
2 changes: 1 addition & 1 deletion docs/build/build-transaction-construction.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ the `metadataHash` field is empty/None.
**Serialized transactions and metadata**

Before being submitted, transactions are serialized. Serialized transactions are hex encoded
SCALE-encoded bytes. The Relay Chain runtimes are upgradable and therefore any interfaces are
SCALE-encoded bytes. The relay chain runtimes are upgradable and therefore any interfaces are
subject to change, the metadata allows developers to structure any extrinsics or storage entries
accordingly. 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
Expand Down
Loading

0 comments on commit 7a493a0

Please sign in to comment.