mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 19:17:58 +00:00
Dcompoze
002d9260f9
**Update:** Pushed additional changes based on the review comments. **This pull request fixes various spelling mistakes in this repository.** Most of the changes are contained in the first **3** commits: - `Fix spelling mistakes in comments and docs` - `Fix spelling mistakes in test names` - `Fix spelling mistakes in error messages, panic messages, logs and tracing` Other source code spelling mistakes are separated into individual commits for easier reviewing: - `Fix the spelling of 'authority'` - `Fix the spelling of 'REASONABLE_HEADERS_IN_JUSTIFICATION_ANCESTRY'` - `Fix the spelling of 'prev_enqueud_messages'` - `Fix the spelling of 'endpoint'` - `Fix the spelling of 'children'` - `Fix the spelling of 'PenpalSiblingSovereignAccount'` - `Fix the spelling of 'PenpalSudoAccount'` - `Fix the spelling of 'insufficient'` - `Fix the spelling of 'PalletXcmExtrinsicsBenchmark'` - `Fix the spelling of 'subtracted'` - `Fix the spelling of 'CandidatePendingAvailability'` - `Fix the spelling of 'exclusive'` - `Fix the spelling of 'until'` - `Fix the spelling of 'discriminator'` - `Fix the spelling of 'nonexistent'` - `Fix the spelling of 'subsystem'` - `Fix the spelling of 'indices'` - `Fix the spelling of 'committed'` - `Fix the spelling of 'topology'` - `Fix the spelling of 'response'` - `Fix the spelling of 'beneficiary'` - `Fix the spelling of 'formatted'` - `Fix the spelling of 'UNKNOWN_PROOF_REQUEST'` - `Fix the spelling of 'succeeded'` - `Fix the spelling of 'reopened'` - `Fix the spelling of 'proposer'` - `Fix the spelling of 'InstantiationNonce'` - `Fix the spelling of 'depositor'` - `Fix the spelling of 'expiration'` - `Fix the spelling of 'phantom'` - `Fix the spelling of 'AggregatedKeyValue'` - `Fix the spelling of 'randomness'` - `Fix the spelling of 'defendant'` - `Fix the spelling of 'AquaticMammal'` - `Fix the spelling of 'transactions'` - `Fix the spelling of 'PassingTracingSubscriber'` - `Fix the spelling of 'TxSignaturePayload'` - `Fix the spelling of 'versioning'` - `Fix the spelling of 'descendant'` - `Fix the spelling of 'overridden'` - `Fix the spelling of 'network'` Let me know if this structure is adequate. **Note:** The usage of the words `Merkle`, `Merkelize`, `Merklization`, `Merkelization`, `Merkleization`, is somewhat inconsistent but I left it as it is. ~~**Note:** In some places the term `Receival` is used to refer to message reception, IMO `Reception` is the correct word here, but I left it as it is.~~ ~~**Note:** In some places the term `Overlayed` is used instead of the more acceptable version `Overlaid` but I also left it as it is.~~ ~~**Note:** In some places the term `Applyable` is used instead of the correct version `Applicable` but I also left it as it is.~~ **Note:** Some usage of British vs American english e.g. `judgement` vs `judgment`, `initialise` vs `initialize`, `optimise` vs `optimize` etc. are both present in different places, but I suppose that's understandable given the number of contributors. ~~**Note:** There is a spelling mistake in `.github/CODEOWNERS` but it triggers errors in CI when I make changes to it, so I left it as it is.~~
67 lines
2.8 KiB
Markdown
67 lines
2.8 KiB
Markdown
# Alliance Pallet
|
|
|
|
The Alliance Pallet provides a collective that curates a list of accounts and URLs, deemed by
|
|
the voting members to be unscrupulous actors. The Alliance
|
|
|
|
- provides a set of ethics against bad behavior, and
|
|
- provides recognition and influence for those teams that contribute something back to the
|
|
ecosystem.
|
|
|
|
## Overview
|
|
|
|
The network initializes the Alliance via a Root call. After that, anyone with an approved
|
|
identity and website can join as an Ally. The `MembershipManager` origin can elevate Allies to
|
|
Fellows, giving them voting rights within the Alliance.
|
|
|
|
Voting members of the Alliance maintain a list of accounts and websites. Members can also vote
|
|
to update the Alliance's rule and make announcements.
|
|
|
|
### Terminology
|
|
|
|
- Rule: The IPFS CID (hash) of the Alliance rules for the community to read and the Alliance
|
|
members to enforce. Similar to a Charter or Code of Conduct.
|
|
- Announcement: An IPFS CID of some content that the Alliance want to announce.
|
|
- Member: An account that is already in the group of the Alliance, including three types:
|
|
Fellow, or Ally. A member can also be kicked by the `MembershipManager` origin
|
|
or retire by itself.
|
|
- Fellow: An account who is elevated from Ally by other Fellows.
|
|
- Ally: An account who would like to join the Alliance. To become a voting member (Fellow), it
|
|
will need approval from the `MembershipManager` origin. Any account can join as an Ally either
|
|
by placing a deposit or by nomination from a voting member.
|
|
- Unscrupulous List: A list of bad websites and addresses; items can be added or removed by
|
|
voting members.
|
|
|
|
## Interface
|
|
|
|
### Dispatchable Functions
|
|
|
|
#### For General Users
|
|
|
|
- `join_alliance` - Join the Alliance as an Ally. This requires a slashable deposit.
|
|
|
|
#### For Members (All)
|
|
|
|
- `give_retirement_notice` - Give a retirement notice and start a retirement period required to
|
|
pass in order to retire.
|
|
- `retire` - Retire from the Alliance and release the caller's deposit.
|
|
|
|
#### For Voting Members
|
|
|
|
- `propose` - Propose a motion.
|
|
- `vote` - Vote on a motion.
|
|
- `close` - Close a motion with enough votes or that has expired.
|
|
- `set_rule` - Initialize or update the Alliance's rule by IPFS CID.
|
|
- `announce` - Make announcement by IPFS CID.
|
|
- `nominate_ally` - Nominate a non-member to become an Ally, without deposit.
|
|
- `elevate_ally` - Approve an ally to become a Fellow.
|
|
- `kick_member` - Kick a member and slash its deposit.
|
|
- `add_unscrupulous_items` - Add some items, either accounts or websites, to the list of
|
|
unscrupulous items.
|
|
- `remove_unscrupulous_items` - Remove some items from the list of unscrupulous items.
|
|
- `abdicate_fellow_status` - Abdicate one's voting rights, demoting themselves to Ally.
|
|
|
|
#### Root Calls
|
|
|
|
- `init_members` - Initialize the Alliance, onboard fellows and allies.
|
|
- `disband` - Disband the Alliance, remove all active members and unreserve deposits.
|