Update READMEs, fix links (#7176)

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Revert stuff that shouldn't have been committed

* Revert stuff that shouldn't have been committed

* Fix parent relative link generation

* Manually remove this incorrect link for now.
This commit is contained in:
Steve Degosserie
2020-09-22 15:38:23 +02:00
committed by GitHub
parent f70ef87a0c
commit 22632efc5f
174 changed files with 319 additions and 121 deletions
+49 -3
View File
@@ -3,8 +3,8 @@
The Treasury module provides a "pot" of funds that can be managed by stakeholders in the
system and a structure for making spending proposals from this pot.
- [`treasury::Trait`](./trait.Trait.html)
- [`Call`](./enum.Call.html)
- [`treasury::Trait`](https://docs.rs/pallet-treasury/latest/pallet_treasury/trait.Trait.html)
- [`Call`](https://docs.rs/pallet-treasury/latest/pallet_treasury/enum.Call.html)
## Overview
@@ -27,6 +27,23 @@ entered where any remaining members can declare their tip amounts also. After th
countdown period, the median of all declared tips is paid to the reported beneficiary, along
with any finders fee, in case of a public (and bonded) original report.
### Bounty
A Bounty Spending is a reward for a specified body of work - or specified set of objectives - that
needs to be executed for a predefined Treasury amount to be paid out. A curator is assigned after
the bounty is approved and funded by Council, to be delegated
with the responsibility of assigning a payout address once the specified set of objectives is completed.
After the Council has activated a bounty, it delegates the work that requires expertise to a curator
in exchange of a deposit. Once the curator accepts the bounty, they
get to close the Active bounty. Closing the Active bounty enacts a delayed payout to the payout
address, the curator fee and the return of the curator deposit. The
delay allows for intervention through regular democracy. The Council gets to unassign the curator,
resulting in a new curator election. The Council also gets to cancel
the bounty if deemed necessary before assigning a curator or once the bounty is active or payout
is pending, resulting in the slash of the curator's deposit.
### Terminology
- **Proposal:** A suggestion to allocate funds from the pot to a beneficiary.
@@ -47,6 +64,22 @@ Tipping protocol:
- **Finders Fee:** Some proportion of the tip amount that is paid to the reporter of the tip,
rather than the main beneficiary.
Bounty:
- **Bounty spending proposal:** A proposal to reward a predefined body of work upon completion by
the Treasury.
- **Proposer:** An account proposing a bounty spending.
- **Curator:** An account managing the bounty and assigning a payout address receiving the reward
for the completion of work.
- **Deposit:** The amount held on deposit for placing a bounty proposal plus the amount held on
deposit per byte within the bounty description.
- **Curator deposit:** The payment from a candidate willing to curate an approved bounty. The deposit
is returned when/if the bounty is completed.
- **Bounty value:** The total amount that should be paid to the Payout Address if the bounty is
rewarded.
- **Payout address:** The account to which the total or part of the bounty is assigned to.
- **Payout Delay:** The delay period for which a bounty beneficiary needs to wait before claiming.
- **Curator fee:** The reserved upfront payment for a curator for work related to the bounty.
## Interface
### Dispatchable Functions
@@ -65,8 +98,21 @@ Tipping protocol:
- `tip` - Declare or redeclare an amount to tip for a particular reason.
- `close_tip` - Close and pay out a tip.
Bounty protocol:
- `propose_bounty` - Propose a specific treasury amount to be earmarked for a predefined set of
tasks and stake the required deposit.
- `approve_bounty` - Accept a specific treasury amount to be earmarked for a predefined body of work.
- `propose_curator` - Assign an account to a bounty as candidate curator.
- `accept_curator` - Accept a bounty assignment from the Council, setting a curator deposit.
- `extend_bounty_expiry` - Extend the expiry block number of the bounty and stay active.
- `award_bounty` - Close and pay out the specified amount for the completed work.
- `claim_bounty` - Claim a specific bounty amount from the Payout Address.
- `unassign_curator` - Unassign an accepted curator from a specific earmark.
- `close_bounty` - Cancel the earmark for a specific treasury amount and close the bounty.
## GenesisConfig
The Treasury module depends on the [`GenesisConfig`](./struct.GenesisConfig.html).
The Treasury module depends on the [`GenesisConfig`](https://docs.rs/pallet-treasury/latest/pallet_treasury/struct.GenesisConfig.html).
License: Apache-2.0