pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-14 16:51:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Markdown linter (#1309)

Browse Source 
* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
This commit is contained in:
Chevdor
2023-09-04 11:02:32 +02:00
committed by GitHub
parent 830fde2a60
commit a30092ab42
271 changed files with 6289 additions and 4450 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/recovery/README.md
+14 -14
View File
@@ -16,11 +16,11 @@ friends are needed to give another account access to the recoverable account.
The recovery process for each recoverable account can be configured by the account owner.
They are able to choose:
* `friends` - The list of friends that the account owner trusts to protect the
- `friends` - The list of friends that the account owner trusts to protect the
recovery process for their account.
* `threshold` - The number of friends that need to approve a recovery process for
- `threshold` - The number of friends that need to approve a recovery process for
the account to be successfully recovered.
* `delay_period` - The minimum number of blocks after the beginning of the recovery
- `delay_period` - The minimum number of blocks after the beginning of the recovery
process that need to pass before the account can be successfully recovered.
There is a configurable deposit that all users need to pay to create a recovery
@@ -84,20 +84,20 @@ It is important to note that this is a powerful pallet that can compromise the
security of an account if used incorrectly. Some recommended practices for users
of this pallet are:
* Configure a significant `delay_period` for your recovery process: As long as you
- Configure a significant `delay_period` for your recovery process: As long as you
have access to your recoverable account, you need only check the blockchain once
every `delay_period` blocks to ensure that no recovery attempt is successful
against your account. Using off-chain notification systems can help with this,
but ultimately, setting a large `delay_period` means that even the most skilled
attacker will need to wait this long before they can access your account.
* Use a high threshold of approvals: Setting a value of 1 for the threshold means
- Use a high threshold of approvals: Setting a value of 1 for the threshold means
that any of your friends would be able to recover your account. They would
simply need to start a recovery process and approve their own process. Similarly,
a threshold of 2 would mean that any 2 friends could work together to gain
access to your account. The only way to prevent against these kinds of attacks
is to choose a high threshold of approvals and select from a diverse friend
group that would not be able to reasonably coordinate with one another.
* Reset your configuration over time: Since the entire deposit of creating a
- Reset your configuration over time: Since the entire deposit of creating a
recovery configuration is returned to the user, the only cost of updating
your recovery configuration is the transaction fees for the calls. Thus,
it is strongly encouraged to regularly update your recovery configuration
@@ -110,25 +110,25 @@ of this pallet are:
#### For General Users
* `create_recovery` - Create a recovery configuration for your account and make it recoverable.
* `initiate_recovery` - Start the recovery process for a recoverable account.
- `create_recovery` - Create a recovery configuration for your account and make it recoverable.
- `initiate_recovery` - Start the recovery process for a recoverable account.
#### For Friends of a Recoverable Account
* `vouch_recovery` - As a `friend` of a recoverable account, vouch for a recovery attempt on the account.
- `vouch_recovery` - As a `friend` of a recoverable account, vouch for a recovery attempt on the account.
#### For a User Who Successfully Recovered an Account
* `claim_recovery` - Claim access to the account that you have successfully completed the recovery process for.
* `as_recovered` - Send a transaction as an account that you have recovered. See other functions below.
- `claim_recovery` - Claim access to the account that you have successfully completed the recovery process for.
- `as_recovered` - Send a transaction as an account that you have recovered. See other functions below.
#### For the Recoverable Account
* `close_recovery` - Close an active recovery process for your account and reclaim the recovery deposit.
* `remove_recovery` - Remove the recovery configuration from the account, making it un-recoverable.
- `close_recovery` - Close an active recovery process for your account and reclaim the recovery deposit.
- `remove_recovery` - Remove the recovery configuration from the account, making it un-recoverable.
#### For Super Users
* `set_recovered` - The ROOT origin is able to skip the recovery process and directly allow
- `set_recovered` - The ROOT origin is able to skip the recovery process and directly allow
one account to access another.
License: Apache-2.0