Skip to content

Commit 58f828f

Browse files
authored
Merge branch 'main' into patch-2
2 parents df55164 + 2b6797b commit 58f828f

File tree

71 files changed

+159
-15099
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+159
-15099
lines changed

config/menus.js

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,6 @@ const developers = [
6262
url: MARKETPLACE_URL,
6363
id: 'developers.marketplace',
6464
},
65-
{
66-
url: WEBSITE_URL + '/developers/playground/',
67-
id: 'developers.playground',
68-
},
6965
{
7066
url: WEBSITE_URL + '/developers/smart-contracts/',
7167
id: 'developers.smart-contracts',

content/locales/en/menus.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
"developers.docs": "Docs",
1616
"developers.rustdocs": "Rust Docs",
1717
"developers.marketplace": "Marketplace",
18-
"developers.playground": "Playground",
1918
"developers.smart-contracts": "Smart Contracts",
2019
"developers.substrate-connect": "Substrate Connect",
2120
"developers.rococo-network": "Rococo Network",

content/md/en/docs/build/build-process.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));
6161

6262
This code includes the compact WebAssembly binary (`WASM_BINARY`) and the uncompressed WebAssembly binary generated by the compiler (`WASM_BINARY_BLOATY`) in its compilation result, and the final executable binary for the project is generated.
6363

64-
At each stage of the build process, the WebAssembly binary is compressed to a smaller and smaller size.
64+
At each stage of the build process, the WebAssembly binary is compressed to a smaller size than earlier.
6565
For example, you can compare the sizes of each WebAssembly binary artifact for Polkadot:
6666

6767
```bash
@@ -118,7 +118,7 @@ For example, you might want to use the native runtime for initial synchronizatio
118118
To use the native runtime for synchronizing blocks, you can start the node using the `--execution-syncing native` or `--execution-syncing native-else-wasm` command-line option.
119119

120120
For information about using the command-line options to specify an execution strategy for all or specific operations, see [node-template](/reference/command-line-tools/node-template).
121-
For information about the execution strategy variant, see [ExecutionStrategy](https://paritytech.github.io/substrate/master/sp_state_machine/enum.ExecutionStrategy.html)
121+
For information about the execution strategy variant, see [ExecutionStrategy](https://paritytech.github.io/substrate/master/sc_cli/arg_enums/enum.ExecutionStrategy.html)
122122

123123
## Building WebAssembly without a native runtime
124124

@@ -127,7 +127,7 @@ After an initial WebAssembly runtime is provided, the blob that represents the W
127127
In some rare cases, you might want to compile the WebAssembly target without the native runtime.
128128
For example, if you're testing a WebAssembly runtime to prepare for a forkless upgrade, you might want to compile just the new WebAssembly binary.
129129

130-
Although it's a rare use case, you can use the [build-only-wasm.sh](https://github.com/paritytech/substrate/blob/master/.maintain/build-only-wasm.sh) script to build the `no_std` WebAssembly binary without compiling the native runtime.
130+
Although it's a rare use case, you can use the [build-only-wasm.sh](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/.maintain/build-only-wasm.sh) script to build the `no_std` WebAssembly binary without compiling the native runtime.
131131

132132
You can also use the `wasm-runtime-overrides` command-line option to load the WebAssembly from the file system.
133133

@@ -138,6 +138,6 @@ This option is primarily used for faster compile time when you don't need to upd
138138

139139
## Where to go next
140140

141-
- [Wasm-builder README](https://github.com/paritytech/substrate/blob/master/utils/wasm-builder/README.md)
141+
- [Wasm-builder README](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/utils/wasm-builder/README.md)
142142
- [Rust compilation options](https://doc.rust-lang.org/cargo/commands/cargo-build.html#compilation-options)
143143
- [Discussion: Removing the native runtime](https://github.com/paritytech/substrate/issues/10579)

content/md/en/docs/build/genesis-configuration.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description:
44
keywords:
55
---
66

7+
<div class="warning">
8+
<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.
9+
</div>
10+
11+
712
The first block produced by any blockchain is referred to as the genesis block.
813
The hash associated with this block is the top-level parent of all blocks produced after that first block.
914

@@ -193,7 +198,7 @@ pub struct RuntimeGenesisConfig {
193198

194199
Ultimately, the `RuntimeGenesisConfig` is exposed by way of the [`ChainSpec`](https://paritytech.github.io/substrate/master/sc_chain_spec/trait.ChainSpec.html) trait.
195200

196-
For a more complete example of genesis storage configuration for Substrate, see the [chain specification that ships with the Substrate code base](https://github.com/paritytech/substrate/blob/master/bin/node/cli/src/chain_spec.rs).
201+
For a more complete example of genesis storage configuration for Substrate, see the [chain specification that ships with the Substrate code base](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/bin/node/cli/src/chain_spec.rs).
197202

198203
## Initialize storage items within a pallet
199204

content/md/en/docs/build/origins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can look at the source code of the [Sudo module](https://paritytech.github.i
5050
In addition to the three core origin types, runtime developers are also able to define custom origins.
5151
These can be used as authorization checks inside functions from specific modules in your runtime, or to define custom access-control logic around the sources of runtime requests.
5252

53-
Customizing origins allows runtime developers to specify valid origins depending on their runtime logic. For example, it may be desirable to restrict access of certain functions to special custom origins and authorize dispatch calls only from members of a [collective](https://github.com/paritytech/substrate/tree/master/frame/collective). The advantage of using custom origins is that it provides runtime developers a way to configure privileged access over dispatch calls to the runtime.
53+
Customizing origins allows runtime developers to specify valid origins depending on their runtime logic. For example, it may be desirable to restrict access of certain functions to special custom origins and authorize dispatch calls only from members of a [collective](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/collective). The advantage of using custom origins is that it provides runtime developers a way to configure privileged access over dispatch calls to the runtime.
5454

5555
## Next steps
5656

@@ -60,11 +60,11 @@ Customizing origins allows runtime developers to specify valid origins depending
6060

6161
### Examples
6262

63-
- View the [Sudo pallet](https://github.com/paritytech/substrate/tree/master/frame/sudo) to see how it allows a user to call with `Root` and `Signed` origin.
63+
- View the [Sudo pallet](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/sudo) to see how it allows a user to call with `Root` and `Signed` origin.
6464

65-
- View the [Timestamp pallet](https://github.com/paritytech/substrate/tree/master/frame/timestamp) to see how it validates an a call with `None` origin.
65+
- View the [Timestamp pallet](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/timestamp) to see how it validates an a call with `None` origin.
6666

67-
- View the [Collective pallet](https://github.com/paritytech/substrate/tree/master/frame/collective) to see how it constructs a custom `Member` origin.
67+
- View the [Collective pallet](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/collective) to see how it constructs a custom `Member` origin.
6868

6969
- View our recipe for creating and using a custom origin.
7070

content/md/en/docs/build/pallet-coupling.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ In general, loose coupling provides more flexibility than tight coupling and is
104104
It guarantees better maintainability, reusability, and extensibility of your code.
105105
However, tight coupling can be useful for pallets that are less complex or that have more overlap in methods and types than differences.
106106

107-
In FRAME, there are two pallets that are tightly coupled to [`pallet_treasury`](https://github.com/paritytech/substrate/tree/master/frame/treasury):
107+
In FRAME, there are two pallets that are tightly coupled to [`pallet_treasury`](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/treasury):
108108

109-
- [Bounties pallet](https://github.com/paritytech/substrate/tree/master/frame/bounties)
110-
- [Tipping pallet](https://github.com/paritytech/substrate/tree/master/frame/tips)
109+
- [Bounties pallet](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/bounties)
110+
- [Tipping pallet](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/tips)
111111

112112
As a general rule, the more complex a pallet is, the less desirable it is to tightly couple it.
113113
This evokes a concept in computer science called [cohesion](<https://en.wikipedia.org/wiki/Cohesion_(computer_science)>), a metric used to examine the overall quality of a software system.

content/md/en/docs/build/remote-procedure-calls.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The way to do it is through a [JSON-RPC](/reference/glossary#json-rpc) proxy tha
5555

5656
## RPCs for remote_externalities
5757

58-
Substrate also provides some specialized RPC methods to call [`remote_externalities`](https://github.com/paritytech/substrate/blob/master/utils/frame/remote-externalities/src/lib.rs#L320-#L764) for a node.
58+
Substrate also provides some specialized RPC methods to call [`remote_externalities`](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/utils/frame/remote-externalities/src/lib.rs#L347-#L746) for a node.
5959
These specialized methods for remote externalities enable you to make one-off RPC calls to a Substrate node to get information about blocks and headers.
6060
The information returned by these calls can be useful for testing purposes with tools like [`try-runtime`](/reference/command-line-tools/try-runtime/).
6161

content/md/en/docs/build/tx-weights-fees.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ To account for this variability, the Transaction Payment pallet provides the [`F
107107
The default update function is inspired by the Polkadot network and implements a targeted adjustment in which a target saturation level of block weight is defined.
108108
If the previous block is more saturated, then the fees are slightly increased.
109109
Similarly, if the previous block has fewer transactions than the target, fees are decreased by a small amount.
110-
For more information about fee multiplier adjustments, see the [Web3 research page](https://w3f-research.readthedocs.io/en/latest/polkadot/overview/2-token-economics.html#relay-chain-transaction-fees-and-per-block-transaction-limits).
110+
For more information about fee multiplier adjustments, see the [Web3 research page](https://research.web3.foundation/Polkadot/overview/token-economics#relay-chain-transaction-fees-and-per-block-transaction-limits).
111111

112112
## Transactions with special requirements
113113

@@ -397,7 +397,7 @@ You can use Substrate **benchmarking functions** and `frame-benchmarking` calls
397397

398398
- [Benchmark](/test/benchmark/)
399399
- [SignedExtension](https://paritytech.github.io/substrate/master/sp_runtime/traits/trait.SignedExtension.html)
400-
- [Custom weights for the Example pallet](https://github.com/paritytech/substrate/blob/master/frame/examples/basic/src/weights.rs)
401-
- [Web3 Foundation Research](https://w3f-research.readthedocs.io/en/latest/polkadot/overview/2-token-economics.html#relay-chain-transaction-fees-and-per-block-transaction-limits)
400+
- [Custom weights for the Example pallet](https://github.com/paritytech/polkadot-sdk/blob/master/substrate/frame/examples/basic/src/weights.rs)
401+
- [Web3 Foundation Research](https://research.web3.foundation/Polkadot/overview/token-economics#relay-chain-transaction-fees-and-per-block-transaction-limits)
402402

403403
<!-- - [Calculate weight](/reference/how-to-guides/weights/) -->

content/md/en/docs/deploy/deployment-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,7 @@ ENTRYPOINT ["/usr/local/bin/node-template"]
412412

413413
### Automated build pipeline
414414

415-
The following sample [GitHub action](https://github.com/substrate-developer-hub/substrate-node-template/blob/main/.github/workflows/build-publish-image.yml) builds and publishes a Docker image to DockerHub.
415+
The following sample [GitHub action](https://github.com/substrate-developer-hub/substrate-node-template/blob/main/.github/workflows/release.yml) builds and publishes a Docker image to DockerHub.
416416
In most cases, you trigger this action using a manual workflow or when a new release is published.
417417

418418
Note that you must add secrets to your GitHub repository or organization as described in [Encrypted secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) to publish images securely.

content/md/en/docs/design/substrate-empowers-builders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For example, you can build a Substrate runtime:
4141
- Using smart contracts and predefined FRAME pallets.
4242
- With a combination of predefined and custom pallets and smart contracts.
4343

44-
As part of your design process, you can explore the predefined [FRAME pallets](https://github.com/paritytech/substrate/tree/master/frame) to see if they provide features that you want to use or customize and identify any custom pallets you might need.
44+
As part of your design process, you can explore the predefined [FRAME pallets](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame) to see if they provide features that you want to use or customize and identify any custom pallets you might need.
4545

4646
## Where to go next
4747

content/md/en/docs/learn/accounts-addresses-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Polkadot enables you to restrict transactions for a proxy account using the foll
128128
- CancelProxy
129129
- Auction
130130

131-
The enumerated list of proxy types and the logic for matching proxy types to transaction is defined in the [Polkadot runtime](https://github.com/paritytech/polkadot/blob/master/runtime/polkadot/src/lib.rs).
131+
The enumerated list of proxy types and the logic for matching proxy types to transaction is defined in the [Polkadot runtime](https://github.com/polkadot-fellows/runtimes/blob/main/relay/polkadot/src/lib.rs).
132132

133133
#### Anonymous proxy account
134134

content/md/en/docs/learn/blockchain-basics.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,5 +108,3 @@ You can explore the following resources to learn more.
108108
- [Build a local blockchain](/tutorials/build-a-blockchain/build-local-blockchain/)
109109
- [Simulate a network](/tutorials/build-a-blockchain/simulate-network/)
110110
- [Add trusted nodes](/tutorials/build-a-blockchain/add-trusted-nodes/)
111-
112-
If you prefer to explore code directly, you can start building in the [Substrate Playground](/playground/) or consult the API reference to get details about the Rust crates you use.

content/md/en/docs/learn/consensus.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,5 +133,5 @@ See [AlephBFT](https://github.com/aleph-zero-foundation/aleph-node) for such an
133133

134134
## Where to go next
135135

136-
- [BABE research](https://research.web3.foundation/en/latest/polkadot/block-production/Babe.html)
137-
- [GRANDPA research](https://research.web3.foundation/en/latest/polkadot/finality.html)
136+
- [BABE research](https://research.web3.foundation/Polkadot/protocols/block-production/Babe)
137+
- [GRANDPA research](https://research.web3.foundation/Polkadot/protocols/finality)

content/md/en/docs/learn/cryptography.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,12 +92,12 @@ It is carefully engineered at several levels of design and implementation to ach
9292

9393
#### SR25519
9494

95-
[SR25519](https://research.web3.foundation/en/latest/polkadot/keys/1-accounts-more.html) is based on the same underlying curve as [Ed25519](#ed25519).
95+
[SR25519](https://research.web3.foundation/Polkadot/security/keys/accounts-more) is based on the same underlying curve as [Ed25519](#ed25519).
9696
However, it uses Schnorr signatures instead of the EdDSA scheme.
9797

9898
## Where to go next
9999

100100
- [Cryptography on Polkadot](https://wiki.polkadot.network/docs/en/learn-cryptography).
101-
- [Research at W3F: Cryptography](https://research.web3.foundation/en/latest/crypto.html).
101+
- [Research at W3F: Cryptography](https://research.web3.foundation/crypto).
102102
- [`Hash`](https://paritytech.github.io/substrate/master/sp_runtime/traits/trait.Hash.html) trait for implementing new hashing algorithms.
103103
- [`Pair`](https://paritytech.github.io/substrate/master/sp_core/crypto/trait.Pair.html) trait for implementing new cryptographic schemes.

content/md/en/docs/learn/light-clients-in-substrate-connect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ A few of the key benefits include:
4343

4444
You can use Substrate Connect to connect to any Substrate-based blockchain.
4545
However, you must specify the correct name of the chain that you want to connect to.
46-
There are a few well-known chain names that are defined for the [`WellKnownChain`](https://paritytech.github.io/substrate-connect/api/enums/connect_src.WellKnownChain.html) enumeration type.
46+
There are a few well-known chain names that are defined for the [`WellKnownChain`](https://paritytech.github.io/substrate-connect/api/enums/_substrate_connect.WellKnownChain.html) enumeration type.
4747

4848
You can connect to the following public blockchain networks using the name listed:
4949

content/md/en/docs/learn/offchain-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ By populating the data at every block, offchain indexing ensures that the data i
8787

8888
Now that you are familiar with how offchain workers, offchain storage, and offchain indexing enable you to work with data not stored on-chain, you might want to explore the following examples of offchain workers and how to use them in runtime development:
8989

90-
- [Example: Offchain worker](https://github.com/paritytech/substrate/tree/master/frame/examples/offchain-worker)
90+
- [Example: Offchain worker](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/examples/offchain-worker)
9191
- [Example: Submit transactions](https://github.com/JoshOrndorff/recipes/blob/master/text/off-chain-workers/transactions.md)
9292
- [Example: Use HTTP requests to fetch data](https://github.com/JoshOrndorff/recipes/blob/master/text/off-chain-workers/http-json.md)
9393
- [Example: Offchain storage](https://github.com/JoshOrndorff/recipes/blob/master/text/off-chain-workers/storage.md)

content/md/en/docs/learn/runtime-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ In addition to the library of pre-built FRAME pallets, you can use the FRAME lib
113113
With custom pallets, you have the flexibility to define the runtime behavior that best suits your purposes.
114114
Because each pallet has its own discrete logic, you can combine pre-built and custom pallets to control the features and functionality your blockchain provides and achieve the results you want.
115115

116-
For example, you might include the [Balances pallet](https://github.com/paritytech/substrate/tree/master/frame/balances) in your runtime to use its cryptocurrency-related storage items and functions for managing tokens, but add custom logic to call a pallet you write when an account balance changes.
116+
For example, you might include the [Balances pallet](https://github.com/paritytech/polkadot-sdk/tree/master/substrate/frame/balances) in your runtime to use its cryptocurrency-related storage items and functions for managing tokens, but add custom logic to call a pallet you write when an account balance changes.
117117

118118
Most pallets are composed with some combination of the following sections:
119119

content/md/en/docs/quick-start/explore-the-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,11 @@ Before you start to customize the runtime for your own project, you should spend
8888
You've already seen how the default manifest for the runtime lists the default dependencies and features for the runtime in lines similar to the following:
8989

9090
```rust
91-
pallet-balances = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-vX.Y.Z" }
91+
pallet-balances = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", branch = "polkadot-vX.Y.Z" }
9292

93-
pallet-sudo = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-vX.Y.Z" }
93+
pallet-sudo = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", branch = "polkadot-vX.Y.Z" }
9494

95-
pallet-transaction-payment = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-vX.Y.Z" }
95+
pallet-transaction-payment = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", branch = "polkadot-vX.Y.Z" }
9696
```
9797

9898
There are also dependencies on core packages—such as `frame-system`, `frame-support`, and `frame-executive`.

content/md/en/docs/quick-start/modify-the-runtime.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ To add the Utility pallet:
6969
For example, you should add a single line similar to the following.
7070

7171
```toml
72-
pallet-utility = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-vX.Y.Z" }
72+
pallet-utility = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/polkadot-sdk.git", branch = "polkadot-vX.Y.Z" }
7373
```
7474

7575
Be sure to replace `branch = "polkadot-vX.Y.Z"` with the Polkadot branch used for other pallets.

0 commit comments

Comments
 (0)