Skip to content

Commit

Permalink
Move + Remove Rococo from Coretime Guides (#6313)
Browse files Browse the repository at this point in the history
* Move coretime guides

* Update rococo refs -> paseo
  • Loading branch information
CrackTheCode016 authored Oct 18, 2024
1 parent 92065cd commit 640e5a0
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 54 deletions.
15 changes: 3 additions & 12 deletions docs/build/build-guides-coretime-troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,24 +13,15 @@ problems when using the Polkadot SDK or deploying on a core.

## FAQ / Troubleshooting

### Why do I have to sync Rococo locally? Can't I just use a remote, trusted node and connect to that?
### Why do I have to sync Paseo locally? Can't I just use a remote, trusted node and connect to that?

**A:** You can remotely connect to Rococo network via the --relay-chain-rpc-urls flag, which can be
**A:** You can remotely connect to Paseo network via the --relay-chain-rpc-urls flag, which can be
passed to your node. Unfortunately, the caveat is you can't use this node for collation at this
time - meaning if you intend on being a collator/validator for your blockchain and intend to create
blocks, you need to sync the chain locally.

---

### Is there a faster way to sync Rococo? Why not warp sync?

**A:** Warp sync is currently not possible on Rococo or Westend.
[See this answer for more context.](https://substrate.stackexchange.com/questions/9730/rococo-cant-warp-sync-stuck-at-16mb-finality-proof-download).
However, `--chain=rococo—-sync fast-unsafe` should provide a faster way to sync with the relay chain
by skipping downloading state proofs and just verifying the block headers.

---

### My collator is not producing blocks

**A:** Check these sanity checklists:
Expand All @@ -44,7 +35,7 @@ by skipping downloading state proofs and just verifying the block headers.

**A:** Ideally, you would want to run these on separate machines/servers, but you could as long as
you ensure you can provide different RPC/WebSocket and P2P ports for each collator. You also may
need to sync a separate instance of Rococo for each collator on the same machine. You also will need
need to sync a separate instance of Paseo for each collator on the same machine. You also will need
to choose the block production mechanism like
[Aura](https://substrate.stackexchange.com/questions/5572/production-like-parachain-setup-and-launch).

Expand Down
26 changes: 13 additions & 13 deletions docs/build/build-guides-template-basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ slug: ../build-guides-template-basic

:::warning Not a production ready guide.

This guide is considered a moving document and currently uses the **Rococo** testnet. This guide is
This guide is considered a moving document and currently uses the **Paseo** testnet. This guide is
also applicable to the parachains on the Kusama relay chain, as coretime is also enabled there.
Polkadot will enable agile coretime after it has been thoroughly tested on Kusama.

Expand All @@ -36,8 +36,8 @@ to upload our parachain's code:
2. Create a wallet, and get some [ROC via the faucet.](https://faucet.polkadot.io/) with your new
address.
3. Go to the [Polkadot.js Web App](https://polkadot.js.org/apps/#), and make sure you select
**Rococo** as your network via the tabs on the side
[or visit this link to get to Rococo directly](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frococo-rpc.polkadot.io#/explorer)
**Paseo** as your network via the tabs on the side
[or visit this link to get to Paseo directly](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fpaseo.dotters.network#/explorer)
4. Head to
[Network > Parachains > Parathreads (the tab)](https://polkadot.js.org/apps/#/parachains/parathreads)
5. [Follow these instructions to reserve a ParaId.](../learn/learn-guides-coretime-parachains.md#reserve-paraid)
Expand Down Expand Up @@ -111,7 +111,7 @@ cargo build --release
```

For the sake of this example, we won't go into adding or modifying any pallets. However, this is
definitely a next step after you get used to deploying your parachain on Rococo!
definitely a next step after you get used to deploying your parachain.

### Customizing our chain specification's patch file

Expand Down Expand Up @@ -222,7 +222,7 @@ to make it parachain-ready. Once again, make sure you set `para_id` to the one y
"tokenSymbol": "UNIT"
},
"para_id": PARA_ID_HERE,
"relay_chain": "rococo",
"relay_chain": "paseo",
```

Once you finish modifying the file, it should look like this:
Expand All @@ -241,7 +241,7 @@ Once you finish modifying the file, it should look like this:
"tokenSymbol": "UNIT"
},
"para_id": YOUR_PARA_ID_HERE,
"relay_chain": "rococo",
"relay_chain": "paseo",
"codeSubstitutes": {},
"genesis": { ... }
}
Expand All @@ -253,7 +253,7 @@ other fields.
Now you should open your `chain_spec.json`, and use this checklist to ensure all the necessary
fields are in place:

1. **Make** sure that `relay_chain` is set to the target relay chain (`rococo`, in our case)
1. **Make** sure that `relay_chain` is set to the target relay chain (`paseo`, in our case)
2. **Make** sure that `para_id` (right below `relay_chain`) is set to your reserved ParaId
3. **Make** sure that our `chain_type` is set to `Live`
4. **Optionally**, change the name, id, and token symbol of your chain.
Expand Down Expand Up @@ -315,8 +315,8 @@ polkadot-parachain --collator \
--force-authoring \
--base-path <your-base-path-here> \
-- \
--chain=rococo \
--sync fast-unsafe \
--chain=paseo \
--sync warp \
--blocks-pruning 256 \
--state-pruning 256
```
Expand Down Expand Up @@ -360,12 +360,12 @@ them, and purchase a core!
We have two options:

1. [**Bulk**](../learn/learn-agile-coretime.md#bulk-coretime) - obtain a set amount of coretime in
bulk (for Rococo, 7 days).
bulk.
2. [**On-demand**](../learn/learn-agile-coretime.md#on-demand-coretime) - pay as we go for our block
production.

With bulk coretime, we assign a core to our ParaId, and as long as that core is valid, our parachain
will produce blocks and finalize them via Rococo until we have to renew the core.
will produce blocks and finalize them via the relay chain until we have to renew the core.

It's worth noting that you can easily experiment using on-demand extrinsics, then later switch to a
bulk coretime model. For now, let's start with on-demand coretime to get our first blocks going.
Expand All @@ -388,7 +388,7 @@ Provided your collator is synced, you can create a block using an on-demand extr

If everything is working as intended, you can now choose to assign bulk coretime to your parachain
for persistent block generation. For this assignment,
[RegionX's CoreHub](https://app.regionx.tech/regions?network=rococo) will be used to purchase and
[RegionX's CoreHub](https://app.regionx.tech/regions?network=paseo) will be used to purchase and
assign cores.

:::info Getting Coretime ROC
Expand All @@ -408,7 +408,7 @@ for doing so:

:::

1. Connect your wallet and make sure you select **Rococo** as your network:
1. Connect your wallet and make sure you select **Paseo** as your network:

![Connect your wallet to RegionX](../assets/coretime/coretime-regionx-connect-wallet.png)

Expand Down
24 changes: 10 additions & 14 deletions docs/build/build-parachains.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,22 +191,15 @@ chain. For more on collator nodes, see the [collator page](../learn/learn-collat
#### What PDKs Exist?

Currently, the only PDK is
[Parity Substrate](https://github.com/paritytech/polkadot-sdk/tree/master/substrate) and
[the Polkadot SDK](https://github.com/paritytech/polkadot-sdk/tree/master/substrate) and
[Cumulus](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus).

**[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
this reason, `Cumulus`, an added _library_ contains all of the Polkadot compatibility glue code.

:::note Get started with Substrate

The best way to get started with Substrate is to explore the
[Substrate Documentation](https://docs.substrate.io/) maintained by
[Parity Technologies](https://parity.io).

:::

#### Cumulus

:::info
Expand Down Expand Up @@ -307,27 +300,30 @@ Passing) in order to send transfers and messages between parachains.
Paseo runs a few test [system parachains](../learn/learn-system-chains.md) and externally developed
parachains.

If you would like to start deploying a parachain and trying out Coretime on Paseo, refer to the
[Coretime Guides](../build/build-guides-coretime-start.md).

### What Parachains are on Paseo Now?

You can see the list of included parachains
[here](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fpaseo-rpc.dwellir.com#/parachains).

### Obtaining PAS

Follow the instructions [here](../learn/learn-DOT.md#getting-tokens-on-the-rococo-testnet) to get
ROCs tokens.
Follow the instructions [here](../learn/learn-DOT.md#getting-tokens-on-the-paseo-testnet) to get PAS
tokens.

### 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
selecting any parachain of choice.

![rococo parachains](../assets/paseo-chains.png)
![paseo parachains](../assets/paseo-chains.png)

For the purpose of these following examples, we will be using the Paseo testnet "Custom Node"
underneath "Development", following the
[parachain tutorials](https://docs.substrate.io/reference/how-to-guides/parachains/connect-to-a-relay-chain/).
[parachain and coretime tutorials](../build/build-guides-coretime-start.md).

### Parachain Playground

Expand Down Expand Up @@ -364,7 +360,7 @@ benefiting from Polkadot's security. See

## Resources

- [Parachain tutorials](https://docs.substrate.io/reference/how-to-guides/parachains/)
- [Getting started with the Polkadot SDK for parachain development](../build/build-guides-coretime-start.md)
- [Polkadot Bridges](../learn/learn-bridges.md)
- [The Path of a Parachain Block](https://polkadot.network/blog/the-path-of-a-parachain-block/)
- [The Path of a Parachain Block (Parachain Protocol page)](../learn/learn-parachains-protocol.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/learn-guides-coretime-parachains.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ While the parachain is onboarding, start syncing the [collator](./learn-collator
following command to rapidly sync with the specified relay chain.

```
./target/release/adder-collator --parachain-id= $ParaID --chain=rococo --sync fast-unsafe
./target/release/adder-collator --parachain-id= $ParaID --chain=paseo --sync warp
```

## Run a Parachain with Bulk Coretime
Expand Down
28 changes: 14 additions & 14 deletions polkadot-wiki/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -557,20 +557,6 @@ module.exports = {
"learn/learn-agile-coretime",
"learn/learn-guides-coretime-marketplaces",
"learn/learn-guides-coretime-parachains",
{
type: "category",
label: "Coretime Guides",
description: "Technical Coretime Guides",
link: {
type: 'doc',
id: 'build/build-guides-coretime-start',
},
items: [
"build/build-guides-install-deps",
"build/build-guides-template-basic",
"build/build-guides-coretime-troubleshoot"
]
}
],
},
{
Expand Down Expand Up @@ -860,6 +846,20 @@ module.exports = {
slug: '/build-protocol-index',
},
items: [
{
type: "category",
label: "Coretime Guides",
description: "Technical Coretime Guides",
link: {
type: 'doc',
id: 'build/build-guides-coretime-start',
},
items: [
"build/build-guides-install-deps",
"build/build-guides-template-basic",
"build/build-guides-coretime-troubleshoot"
]
},
"build/build-protocol-info",
"build/build-integrate-assets",
"build/build-hrmp-channels"
Expand Down

0 comments on commit 640e5a0

Please sign in to comment.