Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Change reference trait to config #9224

Merged
merged 1 commit into from
Jun 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions frame/assets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ with a fixed supply, including:
* Asset Transfer
* Asset Destruction

To use it in your runtime, you need to implement the assets [`assets::Trait`](https://docs.rs/pallet-assets/latest/pallet_assets/trait.Trait.html).
To use it in your runtime, you need to implement the assets [`assets::Config`](https://docs.rs/pallet-assets/latest/pallet_assets/pallet/trait.Config.html).

The supported dispatchable functions are documented in the [`assets::Call`](https://docs.rs/pallet-assets/latest/pallet_assets/enum.Call.html) enum.
The supported dispatchable functions are documented in the [`assets::Call`](https://docs.rs/pallet-assets/latest/pallet_assets/pallet/enum.Call.html) enum.

### Terminology

Expand Down
2 changes: 1 addition & 1 deletion frame/atomic-swap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A module for atomically sending funds.

- [`atomic_swap::Trait`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Trait.html)
- [`atomic_swap::Config`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/trait.Config.html)
- [`Call`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/enum.Call.html)
- [`Module`](https://docs.rs/pallet-atomic-swap/latest/pallet_atomic_swap/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/aura/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aura Module

- [`aura::Trait`](https://docs.rs/pallet-aura/latest/pallet_aura/trait.Trait.html)
- [`aura::Config`](https://docs.rs/pallet-aura/latest/pallet_aura/pallet/trait.Config.html)
- [`Module`](https://docs.rs/pallet-aura/latest/pallet_aura/struct.Module.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/democracy/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Democracy Pallet

- [`democracy::Trait`](https://docs.rs/pallet-democracy/latest/pallet_democracy/trait.Trait.html)
- [`democracy::Config`](https://docs.rs/pallet-democracy/latest/pallet_democracy/trait.Config.html)
- [`Call`](https://docs.rs/pallet-democracy/latest/pallet_democracy/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/elections-phragmen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ being re-elected at the end of each round.

### Module Information

- [`election_sp_phragmen::Trait`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/trait.Trait.html)
- [`election_sp_phragmen::Config`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/trait.Config.html)
- [`Call`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/enum.Call.html)
- [`Module`](https://docs.rs/pallet-elections-phragmen/latest/pallet_elections_phragmen/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Copy and paste this template from frame/example/src/lib.rs into file
// Include the following links that shows what trait needs to be implemented to use the pallet
// and the supported dispatchables that are documented in the Call enum.

- \[`<INSERT_CUSTOM_PALLET_NAME>::Trait`](https://docs.rs/pallet-example/latest/pallet_example/trait.Trait.html)
- \[`<INSERT_CUSTOM_PALLET_NAME>::Config`](https://docs.rs/pallet-example/latest/pallet_example/trait.Config.html)
- \[`Call`](https://docs.rs/pallet-example/latest/pallet_example/enum.Call.html)
- \[`Module`](https://docs.rs/pallet-example/latest/pallet_example/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/identity/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Identity Module

- [`identity::Trait`](https://docs.rs/pallet-identity/latest/pallet_identity/trait.Trait.html)
- [`identity::Config`](https://docs.rs/pallet-identity/latest/pallet_identity/trait.Config.html)
- [`Call`](https://docs.rs/pallet-identity/latest/pallet_identity/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/im-online/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and includes the recent best block number of the local validators chain as well
as the `NetworkState`.
It is submitted as an Unsigned Transaction via off-chain workers.

- [`im_online::Trait`](https://docs.rs/pallet-im-online/latest/pallet_im_online/trait.Trait.html)
- [`im_online::Config`](https://docs.rs/pallet-im-online/latest/pallet_im_online/trait.Config.html)
- [`Call`](https://docs.rs/pallet-im-online/latest/pallet_im_online/enum.Call.html)
- [`Module`](https://docs.rs/pallet-im-online/latest/pallet_im_online/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/multisig/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Multisig Module
A module for doing multisig dispatch.

- [`multisig::Trait`](https://docs.rs/pallet-multisig/latest/pallet_multisig/trait.Trait.html)
- [`multisig::Config`](https://docs.rs/pallet-multisig/latest/pallet_multisig/trait.Config.html)
- [`Call`](https://docs.rs/pallet-multisig/latest/pallet_multisig/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/nicks/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Nicks Module

- [`nicks::Trait`](https://docs.rs/pallet-nicks/latest/pallet_nicks/trait.Trait.html)
- [`nicks::Config`](https://docs.rs/pallet-nicks/latest/pallet_nicks/trait.Config.html)
- [`Call`](https://docs.rs/pallet-nicks/latest/pallet_nicks/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/proxy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The accounts to which permission is delegated may be requied to announce the act
wish to execute some duration prior to execution happens. In this case, the target account may
reject the announcement and in doing so, veto the execution.

- [`proxy::Trait`](https://docs.rs/pallet-proxy/latest/pallet_proxy/trait.Trait.html)
- [`proxy::Config`](https://docs.rs/pallet-proxy/latest/pallet_proxy/trait.Config.html)
- [`Call`](https://docs.rs/pallet-proxy/latest/pallet_proxy/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/recovery/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Recovery Pallet

- [`recovery::Trait`](https://docs.rs/pallet-recovery/latest/pallet_recovery/trait.Trait.html)
- [`recovery::Config`](https://docs.rs/pallet-recovery/latest/pallet_recovery/trait.Config.html)
- [`Call`](https://docs.rs/pallet-recovery/latest/pallet_recovery/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/scheduler/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Scheduler
A module for scheduling dispatches.

- [`scheduler::Trait`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/trait.Trait.html)
- [`scheduler::Config`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/trait.Config.html)
- [`Call`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/enum.Call.html)
- [`Module`](https://docs.rs/pallet-scheduler/latest/pallet_scheduler/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/scored-pool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ time. If an entity is currently a member, this results in removal
from the `Pool` and `Members`; the entity is immediately replaced
by the next highest scoring candidate in the pool, if available.

- [`scored_pool::Trait`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/trait.Trait.html)
- [`scored_pool::Trait`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/trait.Config.html)
- [`Call`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/enum.Call.html)
- [`Module`](https://docs.rs/pallet-scored-pool/latest/pallet_scored_pool/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/session/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Session module allows validators to manage their session keys, provides a function for changing
the session length, and handles session rotation.

- [`session::Trait`](https://docs.rs/pallet-session/latest/pallet_session/trait.Trait.html)
- [`session::Trait`](https://docs.rs/pallet-session/latest/pallet_session/trait.Config.html)
- [`Call`](https://docs.rs/pallet-session/latest/pallet_session/enum.Call.html)
- [`Module`](https://docs.rs/pallet-session/latest/pallet_session/struct.Module.html)

Expand Down
2 changes: 1 addition & 1 deletion frame/society/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Society Module

- [`society::Trait`](https://docs.rs/pallet-society/latest/pallet_society/trait.Trait.html)
- [`society::Config`](https://docs.rs/pallet-society/latest/pallet_society/trait.Config.html)
- [`Call`](https://docs.rs/pallet-society/latest/pallet_society/enum.Call.html)

## Overview
Expand Down
8 changes: 4 additions & 4 deletions frame/staking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Staking module is used to manage funds at stake by network maintainers.

- [`staking::Trait`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html)
- [`staking::Config`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html)
- [`Call`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html)
- [`Module`](https://docs.rs/pallet-staking/latest/pallet_staking/struct.Module.html)

Expand Down Expand Up @@ -157,7 +157,7 @@ decl_module! {
### Era payout

The era payout is computed using yearly inflation curve defined at
[`T::RewardCurve`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.RewardCurve) as such:
[`T::RewardCurve`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html#associatedtype.RewardCurve) as such:

```nocompile
staker_payout = yearly_inflation(npos_token_staked / total_tokens) * total_tokens / era_per_year
Expand All @@ -168,7 +168,7 @@ This payout is used to reward stakers as defined in next section
remaining_payout = max_yearly_inflation * total_tokens / era_per_year - staker_payout
```
The remaining reward is send to the configurable end-point
[`T::RewardRemainder`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.RewardRemainder).
[`T::RewardRemainder`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html#associatedtype.RewardRemainder).

### Reward Calculation

Expand Down Expand Up @@ -214,7 +214,7 @@ Any funds already placed into stash can be the target of the following operation

The controller account can free a portion (or all) of the funds using the
[`unbond`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.unbond) call. Note that the funds are not immediately
accessible. Instead, a duration denoted by [`BondingDuration`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Trait.html#associatedtype.BondingDuration)
accessible. Instead, a duration denoted by [`BondingDuration`](https://docs.rs/pallet-staking/latest/pallet_staking/trait.Config.html#associatedtype.BondingDuration)
(in number of eras) must pass until the funds can actually be removed. Once the
`BondingDuration` is over, the [`withdraw_unbonded`](https://docs.rs/pallet-staking/latest/pallet_staking/enum.Call.html#variant.withdraw_unbonded)
call can be used to actually withdraw the funds.
Expand Down
2 changes: 1 addition & 1 deletion frame/sudo/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sudo Module

- [`sudo::Trait`](https://docs.rs/pallet-sudo/latest/pallet_sudo/trait.Trait.html)
- [`sudo::Config`](https://docs.rs/pallet-sudo/latest/pallet_sudo/trait.Config.html)
- [`Call`](https://docs.rs/pallet-sudo/latest/pallet_sudo/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/system/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The System module provides low-level access to core types and cross-cutting utilities.
It acts as the base layer for other pallets to interact with the Substrate framework components.

- [`system::Trait`](https://docs.rs/frame-system/latest/frame_system/trait.Trait.html)
- [`system::Config`](https://docs.rs/frame-system/latest/frame_system/pallet/trait.Config.html)

## Overview

Expand Down
6 changes: 3 additions & 3 deletions frame/timestamp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

The Timestamp module provides functionality to get and set the on-chain time.

- [`timestamp::Trait`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/enum.Call.html)
- [`Module`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/struct.Module.html)
- [`timestamp::Config`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/pallet/trait.Config.html)
- [`Call`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/pallet/enum.Call.html)
- [`Pallet`](https://docs.rs/pallet-timestamp/latest/pallet_timestamp/pallet/struct.Pallet.html)

## Overview

Expand Down
2 changes: 1 addition & 1 deletion frame/utility/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Utility Module
A stateless module with helpers for dispatch management which does no re-authentication.

- [`utility::Trait`](https://docs.rs/pallet-utility/latest/pallet_utility/trait.Trait.html)
- [`utility::Config`](https://docs.rs/pallet-utility/latest/pallet_utility/trait.Config.html)
- [`Call`](https://docs.rs/pallet-utility/latest/pallet_utility/enum.Call.html)

## Overview
Expand Down
2 changes: 1 addition & 1 deletion frame/vesting/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Vesting Module

- [`vesting::Trait`](https://docs.rs/pallet-vesting/latest/pallet_vesting/trait.Trait.html)
- [`vesting::Config`](https://docs.rs/pallet-vesting/latest/pallet_vesting/trait.Config.html)
- [`Call`](https://docs.rs/pallet-vesting/latest/pallet_vesting/enum.Call.html)

## Overview
Expand Down