Skip to content

Commit

Permalink
Merge branch 'main' into patch-3
Browse files Browse the repository at this point in the history
  • Loading branch information
shawntabrizi authored Aug 28, 2024
2 parents b380f7b + d40fcba commit ef55e9d
Show file tree
Hide file tree
Showing 39 changed files with 310 additions and 151 deletions.
2 changes: 1 addition & 1 deletion .netlify/_redirects
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Redirects from what the browser requests to what we serve

/rustdocs https://paritytech.github.io/substrate/master/sc_service/ 301!
/rustdocs https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html 301!

/how-to-guides /reference/ 301!

Expand Down
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ Default localhost port configuration:
```env
GATSBY_WEBSITE_URL=http://localhost:8100
GATSBY_DOCS_URL=http://localhost:8200
GATSBY_MARKETPLACE_URL=http://localhost:8300
GATSBY_CAREERS_URL=https://careers.substrate.io
```

**Start development server**
Expand Down
10 changes: 1 addition & 9 deletions config/menus.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const { MARKETPLACE_URL, WEBSITE_URL, CAREERS_URL } = require('./webConsts.js');
const { WEBSITE_URL } = require('./webConsts.js');

/* the main menu, ids of items must match
the submenu's key of this js object */
Expand Down Expand Up @@ -58,10 +58,6 @@ const developers = [
url: 'https://paritytech.github.io/substrate/master/sc_service/',
id: 'developers.rustdocs',
},
{
url: MARKETPLACE_URL,
id: 'developers.marketplace',
},
{
url: WEBSITE_URL + '/developers/smart-contracts/',
id: 'developers.smart-contracts',
Expand Down Expand Up @@ -128,10 +124,6 @@ const opportunities = [
url: WEBSITE_URL + '/ecosystem/opportunities/grants',
id: 'ecosystem.opportunities.grants',
},
{
url: CAREERS_URL,
id: 'ecosystem.opportunities.careers',
},
];

const resources = [
Expand Down
4 changes: 1 addition & 3 deletions config/siteMetadata.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const menus = require('./menus.js');
const { WEBSITE_URL, DOCS_URL, MARKETPLACE_URL, CAREERS_URL } = require('./webConsts.js');
const { WEBSITE_URL, DOCS_URL } = require('./webConsts.js');

module.exports = {
menus,
Expand All @@ -10,8 +10,6 @@ module.exports = {
siteUrl: DOCS_URL,
websiteUrl: WEBSITE_URL,
docsUrl: DOCS_URL,
marketplaceUrl: MARKETPLACE_URL,
careersUrl: CAREERS_URL,
author: 'Parity WebDev/W3F WebOps',
pressEmail: '[email protected]',
email: '[email protected]',
Expand Down
4 changes: 0 additions & 4 deletions config/webConsts.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
const WEBSITE_URL = process.env.GATSBY_WEBSITE_URL;
const DOCS_URL = process.env.GATSBY_DOCS_URL;
const MARKETPLACE_URL = process.env.GATSBY_MARKETPLACE_URL;
const CAREERS_URL = process.env.GATSBY_CAREERS_URL;

module.exports = {
WEBSITE_URL,
DOCS_URL,
MARKETPLACE_URL,
CAREERS_URL,
};
9 changes: 7 additions & 2 deletions content/config/nav.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
menu:
- polkadot-sdk
- quick-start
- learn
- install
Expand All @@ -10,6 +11,10 @@ menu:
- reference
- community

polkadot-sdk:
title: Substrate to Polkadot SDK
url: /polkadot-sdk/

quick-start:
title: Quick start
url: /quick-start/
Expand Down Expand Up @@ -84,7 +89,7 @@ install:
url: /install/developer-tools/
- title: Troubleshoot Rust issues
url: /install/troubleshoot-rust-issues/

#design:
# title: Design
# url: /design/
Expand Down Expand Up @@ -156,7 +161,7 @@ test:
url: /test/simulate-parachains/
- title: Check runtime
url: /test/check-runtime/

deploy:
title: Deploy
url: /deploy/
Expand Down
2 changes: 0 additions & 2 deletions content/locales/en/menus.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"developers.home": "Home",
"developers.docs": "Docs",
"developers.rustdocs": "Rust Docs",
"developers.marketplace": "Marketplace",
"developers.smart-contracts": "Smart Contracts",
"developers.substrate-connect": "Substrate Connect",
"developers.rococo-network": "Rococo Network",
Expand All @@ -31,7 +30,6 @@

"ecosystem.opportunities.hackathons": "Hackathons",
"ecosystem.opportunities.grants": "Grants",
"ecosystem.opportunities.careers": "Careers",

"ecosystem.resources.seminar": "Substrate Seminar",
"ecosystem.resources.past-seminars": "Past Seminars",
Expand Down
21 changes: 13 additions & 8 deletions content/md/en/docs/build/genesis-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ keywords:
---

<div class="warning">
<strong>⚠️ WARNING:</strong> This page contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.genesis_build.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/pallet_macros/attr.genesis_build.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>


Expand All @@ -19,7 +19,7 @@ As you learned in [Chain specification](/build/chain-spec/), the chain specifica
However, the chain specification doesn't create the storage items that get initialized when you start a node.
Instead, the storage items are defined in the pallets included in the runtime as described in [Runtime storage](/build/runtime-storage/).

After you create storage items for the runtime, you can choose whether they should be set to some initial value as part of the genesis configuration and included in the genesis block.
After you create storage items for the runtime, you can choose whether they should be set to some initial value as part of the genesis configuration and included in the genesis block.
To specify the storage items that you want to set an initial state for, Substrate provides two specialized FRAME attribute macros.

The macros you can use to initialize storage items as part of the genesis configuration for a chain are:
Expand Down Expand Up @@ -120,12 +120,17 @@ All of the `GenesisConfig` types for the pallets that included in the constructi
The aggregated `RuntimeGenesisConfig` implements the [`BuildStorage`](https://paritytech.github.io/substrate/master/sp_runtime/trait.BuildStorage.html) trait to build all of the initial storage items for the runtime.
For example, the node template runtime builds storage items for the following pallets that have a `RuntimeGenesisConfig` specified by default:

- [System pallet](#system-pallet)
- [Aura pallet](#aura-pallet)
- [Grandpa pallet](#grandpa-pallet)
- [Balances pallet](#balances-pallet)
- [TransactionPayment pallet](#transactionpayment-pallet)
- [Sudo pallet](#sudo-pallet)
- [Configure a simple storage value](#configure-a-simple-storage-value)
- [Configure macros in the pallet](#configure-macros-in-the-pallet)
- [Configure the chain specification](#configure-the-chain-specification)
- [Adding genesis configuration to the runtime](#adding-genesis-configuration-to-the-runtime)
- [System pallet](#system-pallet)
- [Aura pallet](#aura-pallet)
- [Grandpa pallet](#grandpa-pallet)
- [Balances pallet](#balances-pallet)
- [TransactionPayment pallet](#transactionpayment-pallet)
- [Sudo pallet](#sudo-pallet)
- [Initialize storage items within a pallet](#initialize-storage-items-within-a-pallet)

### System pallet

Expand Down
2 changes: 1 addition & 1 deletion content/md/en/docs/build/origins.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ keywords:
---

<div class="warning">
<strong>⚠️ WARNING:</strong> This page contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_origin/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_origin/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>

The runtime origin is used by dispatchable functions to check where a call has come from.
Expand Down
7 changes: 1 addition & 6 deletions content/md/en/docs/build/pallet-coupling.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_pallet_coupling/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

The term **coupling** is often used to describe the degree to which two software modules depend on each other.
Expand Down
2 changes: 1 addition & 1 deletion content/md/en/docs/build/randomness.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Substrate includes two examples of how to implement the `Randomness` trait in pa
You should only use this pallet in applications with low security requirements or when testing randomness-consuming applications.
You shouldn't use this pallet in a production environment.

= The [BABE pallet](https://paritytech.github.io/substrate/master/pallet_babe/index.html) provides randomness by using verifiable random functions.
- The [BABE pallet](https://paritytech.github.io/substrate/master/pallet_babe/index.html) provides randomness by using verifiable random functions.

This pallet provides production-grade randomness, and is used in Polkadot.
If you select this pallet as the source of randomness your blockchain must use the blind assignment of blockchain extension ([BABE](/reference/glossary/#blind-assignment-of-blockchain-extension-babe)) slot-based consensus for producing blocks.
Expand Down
4 changes: 4 additions & 0 deletions content/md/en/docs/build/remote-procedure-calls.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ keywords:
- frontend
---

<div class="warning">
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/custom_runtime_api_rpc/index.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>

Remote procedure calls, or RPC methods, are a way for an external program—for example, a browser or front-end application—to communicate with a Substrate node.
In general, these methods enable an RPC client to connect to an RPC server endpoint to request some type of service.
For example, you might use an RPC method to read a stored value, submit a transaction, or request information about the chain a node is connected to.
Expand Down
18 changes: 9 additions & 9 deletions content/md/en/docs/examples/quickstart/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,36 @@
}
</style>
</head>

<body>
<main role="main" class="container">
<h1 style="font-family: sans-serif; font-weight: 500;">Display an account balance</h1>
<p style="font-family: sans-serif;">Enter a development account address, then click <b>Get Balance</b>.</p>

<input type="text" size="58" id="account_address"/>
<input type="button" onclick="GetBalance()" value="Get Balance">
<p class="output">Balance: <span id="polkadot-balance">Not Connected</span></p>
</main>

<script src="https://unpkg.com/@polkadot/util/bundle-polkadot-util.js"></script>
<script src="https://unpkg.com/@polkadot/util-crypto/bundle-polkadot-util-crypto.js"></script>
<script src="https://unpkg.com/@polkadot/types/bundle-polkadot-types.js"></script>
<script src="https://unpkg.com/@polkadot/api/bundle-polkadot-api.js"></script>

<script>
async function GetBalance() {
const ADDR = '5Gb6Zfe8K8NSKrkFLCgqs8LUdk7wKweXM5pN296jVqDpdziR';

const { WsProvider, ApiPromise } = polkadotApi;
const wsProvider = new WsProvider('ws://127.0.0.1:9944');
const polkadot = await ApiPromise.create({ provider: wsProvider });

let polkadotBalance = document.getElementById("polkadot-balance");
const x = document.getElementById("account_address").value;
const { data: balance } = await polkadot.query.system.account(x);

polkadotBalance.innerText = balance.free;
}
}
</script>
</body>
</html>
</html>
7 changes: 1 addition & 6 deletions content/md/en/docs/learn/offchain-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

There are many use cases where you might want to query data from an offchain source or process data without using on-chain resources before updating the on-chain state.
Expand Down
1 change: 0 additions & 1 deletion content/md/en/docs/learn/runtime-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@ pub mod pallet {
// Declare the pallet type
// This is a placeholder to implement traits and methods.
#[pallet::pallet]
#[pallet::generate_store(pub(super) trait Store)]
pub struct Pallet<T>(_);

// Add the runtime configuration trait
Expand Down
2 changes: 1 addition & 1 deletion content/md/en/docs/learn/state-transitions-and-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Substrate's [runtime storage APIs](/build/runtime-storage) expose a number of st

### Storage value keys

To calculate the key for a simple [Storage Value](/build/runtime-storage#storage-value), take the [TwoX 128 hash](https://github.com/Cyan4973/xxHash) of the name of the pallet that contains the Storage Value and append to it the TwoX 128 hash of the name of the Storage Value itself.
To calculate the key for a simple [Storage Value](/build/runtime-storage#storage-value), take the [TwoX 128 hash](https://github.com/Cyan4973/xxHash) of the name of the pallet that contains the Storage Value and prepend to it the TwoX 128 hash of the name of the Storage Value itself.
For example, the [Sudo](https://paritytech.github.io/substrate/master/pallet_sudo/index.html) pallet exposes a Storage Value item named `Key`:

```rust
Expand Down
39 changes: 39 additions & 0 deletions content/md/en/docs/polkadot-sdk/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Polkadot SDK
description:
keywords:
- polkadot-sdk
---


## Substrate to Polkadot SDK

In [May
2023](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883),
Parity Technologies started moving the three repositories that contained
[`substrate`](https://github.com/paritytech/substrate),
[`polkadot`](https://github.com/paritytech/polkadot), and
[`cumulus`](https://github.com/paritytech/cumulus), formerly independent in development and
branding, under one new mono-repo called
[`polkadot-sdk`](https://github.com/paritytech/polkadot-sdk). Consequently, the [runtimes of the
Polkadot and Kusama relay chains, and their system chains](https://github.com/polkadot-fellows/runtimes) were moved to be maintained by the [Polkadot fellowship](polkadot-fellows.github.io/dashboard/).

This transition gave birth to a new vision in which these tools are seen from the lens of being part of `polkadot-sdk` while still being independently useful.

Most impacted in this transition is **Substrate**, and part of this impact is the gradual deprecation of
this website. The content on this website is no longer maintained and will be gradually moved to a
new home. Consider the [resources below](#alternative-resources) as primary sources of information.

> You may still access the old content of this website in the navbar, but be aware of the fact that some content might not be up to date.
Note that **this does not impact the development of Substrate as a framework**. Substrate, as a framework, is still being maintained with full steam as a part of `polkadot-sdk`, and retains its full ability to be used to build both [standalone blockchains](https://github.com/paritytech/polkadot-sdk-solochain-template), or [Polkadot powered parachains](https://github.com/paritytech/polkadot-sdk-parachain-template).

## Alternative Resources

Below, you can find a number of replacement resources to learn more about Polkadot SDK:

- [Polkadot Wiki](https://wiki.polkadot.network/docs/build-guide)
- [Polkadot Developers](https://github.com/polkadot-developers/)
- [Polkadot Blockchain Academy](https://polkadot.com/blockchain-academy)
- [Polkadot SDK Rust Docs](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/index.html)
- Polkadot Ecosystem Documentation by Papermoon (Work in progress, see progress [here](https://forum.polkadot.network/t/decentralized-futures-papermoon-first-updates/9265))
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ You can use the following options with the `node-template` command.
| `--wasm-execution <method>` | Specifies the method for executing Wasm runtime code. Valid values are `interpreted`, or `compiled`. The default is `Compiled`.
| `--wasm-runtime-overrides <path>` | Specifies the path where local WASM runtimes are stored. These runtimes override on-chain runtimes when the version matches.
| `--ws-max-connections <count>` | Specifies the maximum number of WS RPC server connections.
| `--rpc-port <port>` | Specifies the TCP port to use for the WebSockets RPC server.
| `--ws-port <port>` | Specifies the TCP port to use for the WebSockets RPC server.

### Subcommands

Expand Down
12 changes: 1 addition & 11 deletions content/md/en/docs/reference/frame-macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description:
keywords:
---
<div class="warning">
<strong>⚠️ WARNING:</strong> This section contains outdated information. Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.pallet.html">Rust docs</a> for the most up-to-date documentation on this topic.
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.pallet.html">Rust docs</a> for the most up-to-date documentation on this topic.
</div>

Substrate uses customized [Rust macros](https://doc.rust-lang.org/book/ch19-06-macros.html) to generate code and aggregate the logic from the pallets you implement for a runtime.
Expand Down Expand Up @@ -256,15 +256,6 @@ For example:
pub struct Pallet<T>(_);
```

This macro can generate the `Store` trait to contain an associated type for each storage item if you provide the `#[pallet::generate_store($vis trait Store)]` attribute macro.

For example:

```rust
#[pallet::pallet]
pub struct Pallet<T>(_);
```

For more information about working with storage and this macro, see the [macro expansion](https://paritytech.github.io/substrate/master/frame_support/attr.pallet.html#macro-expansion-1) added to the `struct Pallet<T>` definition.

### #[pallet::without\_storage\_info]
Expand All @@ -279,7 +270,6 @@ To use it, add the `#[pallet::without_storage_info]` attribute to the pallet str

```rust
#[pallet::pallet]
#[pallet::generate_store(pub(super) trait Store)]
#[pallet::without_storage_info]
pub struct Pallet<T>(_);
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

The _How-to_ guides in the _Offchain workers_ category illustrate common use cases for offchain operations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,7 @@ keywords:
---

<div class="warning">
<p>
<strong>⚠️ WARNING:</strong> This page contains potentially outdated information. Reading it might still be useful, yet we suggest taking it with a grain of salt.
</p>
<p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">`polkadot-sdk-docs` crate</a> for the most up-to-date documentation on this topic.
</p>
Please refer to the <a href="https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/frame_offchain_workers/index.html">Rust Docs</a> for the most up-to-date documentation on this topic.
</div>

Because most blockchains can't access data that's hosted on servers outside of their own network, they typically use external third-party services—**oracles**—to pull information in from or push information out to locations that are outside of the network.
Expand Down
Loading

0 comments on commit ef55e9d

Please sign in to comment.