Skip to content

Commit

Permalink
Update polkadot-sdk repo links (#5260)
Browse files Browse the repository at this point in the history
* edited link

* more edits

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

* Update docs/learn/learn-xcm-pallet.md

Co-authored-by: Radha <[email protected]>

---------

Co-authored-by: Radha <[email protected]>
  • Loading branch information
filippoweb3 and DrW3RK authored Oct 10, 2023
1 parent b6e9da7 commit 268e1f6
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 19 deletions.
4 changes: 2 additions & 2 deletions docs/learn/learn-inflation.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import RPC from "./../../components/RPC-Connection";

{{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} is an inflationary token. On the
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} network, inflation is
{{ polkadot: [set to be 10% annually](https://github.com/paritytech/polkadot/blob/756ccc35e93d1a78e3c71a0e67ae4da5f1d09f69/runtime/polkadot/src/lib.rs#L576), :polkadot }}
{{ kusama: [set to be 10% annually](https://github.com/paritytech/polkadot/blob/756ccc35e93d1a78e3c71a0e67ae4da5f1d09f69/runtime/kusama/src/lib.rs#L535), :kusama }}
{{ polkadot: [set to be 10% annually](https://github.com/paritytech/polkadot-sdk/blob/756ccc35e93d1a78e3c71a0e67ae4da5f1d09f69/runtime/polkadot/src/lib.rs#L576), :polkadot }}
{{ kusama: [set to be 10% annually](https://github.com/paritytech/polkadot-sdk/blob/756ccc35e93d1a78e3c71a0e67ae4da5f1d09f69/runtime/kusama/src/lib.rs#L535), :kusama }}
which is distributed as staking rewards based on the amount staked vs. ideal staking rate, and the
remainder goes to the treasury.

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/learn-proxies.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ transactions.
:::tip Know how to check the calls and pallets accessible by proxies

For the latest information on the calls and pallets that can be fully accessed by proxies, check the
[source code in the runtime folder](https://github.com/paritytech/polkadot/blob/153543b0c8c582e73f520e5c08cbe33bddfb5f69/runtime/polkadot/src/lib.rs#L1158)
on the [Polkadot repository](https://github.com/paritytech/polkadot)
[source code in the runtime folder](https://github.com/paritytech/polkadot-sdk/blob/153543b0c8c582e73f520e5c08cbe33bddfb5f69/runtime/polkadot/src/lib.rs#L1158)
on the [Polkadot repository](https://github.com/paritytech/polkadot-sdk)

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/learn-runtime-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ promptly, especially for high-priority or critical releases.
:::info New Client Releases

The details about the latest client releases can be found in the
[releases section on the Polkadot repository](https://github.com/paritytech/polkadot/releases). A
detailed analysis for client releases can be viewed on the
[releases section on the Polkadot repository](https://github.com/paritytech/polkadot-sdk/releases).
A detailed analysis for client releases can be viewed on the
[Polkadot Forum](https://forum.polkadot.network/tag/release-analysis).

:::
Expand Down
6 changes: 3 additions & 3 deletions docs/learn/learn-staking-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,10 +539,10 @@ pub struct RawSolution<S> {
}
```

A maximum of `pallet::Config::MaxSignedSubmissions` will be stored on-chain and they will be sorted
A maximum of `pallet::Config::SignedMaxSubmissions` will be stored on-chain and they will be sorted
based on score. Higher the score the more optimal the election solution is. On both Polkadot and
Kusama the
['MaxSignedSubmissions'](https://github.com/paritytech/polkadot/blob/master/runtime/polkadot/src/lib.rs#L446)
['SignedMaxSubmissions'](https://github.com/paritytech/polkadot-sdk/blob/f610ffc05876d4b98a14cee245b4cc27bd3c0c15/runtime/polkadot/src/lib.rs#L390)
is set to
{{ polkadot: <RPC network="polkadot" path="consts.electionProviderMultiPhase.signedMaxSubmissions" defaultValue={16}/> :polkadot }}
{{ kusama: <RPC network="kusama" path="consts.electionProviderMultiPhase.signedMaxSubmissions" defaultValue={16}/> :kusama }}
Expand Down Expand Up @@ -619,4 +619,4 @@ resources section below.

- [Staking Miner repository](https://github.com/paritytech/staking-miner-v2)
- [Election Pallet definition](https://crates.parity.io/pallet_election_provider_multi_phase/index.html)
- [Signed phase parameter configuration on Polkadot](https://github.com/paritytech/polkadot/blob/f610ffc05876d4b98a14cee245b4cc27bd3c0c15/runtime/polkadot/src/lib.rs#L389:L397)
- [Signed phase parameter configuration on Polkadot](https://github.com/paritytech/polkadot-sdk/blob/f610ffc05876d4b98a14cee245b4cc27bd3c0c15/runtime/polkadot/src/lib.rs#L389:L397)
19 changes: 10 additions & 9 deletions docs/learn/learn-xcm-pallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ mind that XCM is under active development.

:::

The XCM pallet ([`pallet-xcm`](https://github.com/paritytech/polkadot/tree/master/xcm/pallet-xcm))
The XCM pallet
([`pallet-xcm`](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/xcm/pallet-xcm/src/lib.rs))
provides a set of pre-defined, commonly used XCVM programs in the form of a set of extrinsics using
[FRAME](https://docs.substrate.io/reference/frame-pallets/).

Expand Down Expand Up @@ -42,13 +43,13 @@ handle and execute these programs.
There are two primary primitive extrinsics. These extrinsics handle sending and executing XCVM
programs as dispatchable functions within the pallet.

1. [`execute`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L871) -
1. [`execute`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L902) -
This call contains direct access to the XCM executor. It is the job of the executor to check the
message and ensure that no barrier/filter will block the execution of the XCM. Once it is deemed
valid, the message will then be _locally_ executed, therein returning the outcome as an event.
This operation is executed on behalf of whichever account has signed the extrinsic. It's possible
for only a partial execution to occur.
2. [`send`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L761) -
2. [`send`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L769) -
This call specifies where a message should be sent
([via a transport method](./learn-xcm-transport.md)) externally to a particular destination, i.e.
a parachain, smart contract, or any system which is governed by consensus. In contrast to
Expand All @@ -74,13 +75,13 @@ instructions for sending and executing XCMs. Two variants of these functions are

Otherwise, the fee is taken as needed from the asset being transferred.

1. [`reserve_transfer_assets`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L823) -
1. [`reserve_transfer_assets`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L872) -
Transfer some assets from the local chain to the sovereign account of a destination chain and
forward an XCM containing a
[`ReserveAssetDeposited`](https://github.com/paritytech/xcm-format#reserveassetdeposited)
instruction, which serves as a notification.

2. [`teleport_assets`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L777) -
2. [`teleport_assets`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L827) -
Teleport some assets from the local chain to some destination chain.

### Transfer Reserve vs. Teleport
Expand Down Expand Up @@ -116,16 +117,16 @@ communication between these sovereign accounts that are in other consensus syste
The following extrinsics require root, as they are only used when bypassing XCM version negotiation.
They change any relevant storage aspects that enforce anything to do with XCM version negotiations.

1. [`force_xcm_version`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L908) -
1. [`force_xcm_version`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L934) -
Modifies the `SupportedVersion` storage to change a particular destination's stated XCM version.
2. [`force_default_xcm_version`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L932) -
2. [`force_default_xcm_version`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L957) -
Modifies the `SafeXcmVersion` storage, which stores the default XCM version to use when the
destination's version is unknown.
3. [`force_subscribe_version_notify`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L948) -
3. [`force_subscribe_version_notify`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L972) -
Sends an XCM with a
[`SubscribeVersion`](https://github.com/paritytech/xcm-format#subscribeversion) instruction to a
destination.
4. [`force_unsubscribe_version_notify`](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs#L970) -
4. [`force_unsubscribe_version_notify`](https://github.com/paritytech/polkadot-sdk/blob/a808a3a0918ffbce314dbe00e03761e7a8f8ce79/polkadot/xcm/pallet-xcm/src/lib.rs#L996) -
Sends an XCM with a
[`UnsubscribeVersion`](https://github.com/paritytech/xcm-format#unsubscribeversion) instruction
to a destination.
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/learn-xcm.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ For an updated and complete description of the cross-consensus message format pl
- [XCM: Cross-Consensus Messaging Audit](https://blog.quarkslab.com/resources/2022-02-27-xcmv2-audit/21-12-908-REP.pdf) -
Technical audit report by Quarkslab prepared for Parity.

- [XCM pallet code](https://github.com/paritytech/polkadot/blob/master/xcm/pallet-xcm/src/lib.rs) -
- [XCM pallet code](https://github.com/paritytech/polkadot-sdk/blob/master/polkadot/xcm/pallet-xcm/src/lib.rs) -
The pallet that contains XCM logic from the Polkadot code repository

- [XCM Config & Pallet-XCM | Polkadot Deep Dives](https://www.youtube.com/watch?v=bFMvWmU1pYI) - A
Expand Down

0 comments on commit 268e1f6

Please sign in to comment.