docs: pallet-proxy introduction #346
Conversation
gitofdeepanshu
added
the
documentation
|
Visit the preview URL for this PR (updated for commit 4cf142f): https://astar-docs--pr346-pallet-proxy-intro-zut1mz6q.web.app (expires Mon, 05 Jun 2023 08:52:19 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f2f13e9b593d211faae6343d67a88fac3fd7268d |
docs/user-guides/pallet-proxy.md
Outdated
|
|
||
| * **announcements**(AccountId20) - retrieves all announcements made by the specified proxy account. | ||
|
|
||
| * **palletVersion**() - retrieves the current version of the pallet. |
There was a problem hiding this comment.
Doesn't seem relevant for this docs.
docs/user-guides/pallet-proxy.md
Outdated
| **Constants** | ||
| --- | ||
| The proxy pallet provides the following read-only functions to retrieve pallet constants: | ||
|
|
||
| * **announcementDepositBase()** - retrieves the base amount of currency required to reserve when creating an announcement. | ||
|
|
||
| * **announcementDepositFactor()** - retrieves the amount of currency required per announcement made. | ||
|
|
||
| * **maxPending()** - retrieves the maximum number of time-delayed announcements allowed to be pending. | ||
|
|
||
| * **maxProxies()** - retrieves the maximum number of proxies permitted for a single account. | ||
|
|
||
| * **proxyDepositBase()** - retrieves the base amount of currency required to reserve when creating a proxy. | ||
|
|
||
| * **proxyDepositFactor()** - retrieves the amount of currency required per proxy added. |
There was a problem hiding this comment.
If you want to cover these, I'd suggest putting info inside a table with a short explanation.
| @@ -0,0 +1,79 @@ | |||
| --- | |||
| sidebar_position: 16 | |||
| --- | |||
There was a problem hiding this comment.
Overall impression is that you have the text to explain features on a high level, but I'm not sure if this would be sufficient for user to start using proxies.
Some thing should be explained in more depth, and some things should be better visualized.
Comparing it to Polkadot's doc or Moonbeam's doc we are lacking.
You can provide links to the official Polkadot docs to supplement info provided on this page (e.g. for pure proxies).
The guideline should be - if user comes to this page, reads it - will they need to google proxy accounts again and go read about them on Polkadot's or Moonbeam's page, or is the info here sufficient?
| 6. **CancelProxy** - This proxy type allows delegate account to to reject and remove any announced proxy calls. | ||
|
|
||
| 7. **DappsStaking** - This proxy type allows delegate account to perform DappStaking related transactions such as register, unregister contracts, claim rewards etc. | ||
|
|
There was a problem hiding this comment.
What about the dApp staking reward?
There was a problem hiding this comment.
forgot about that, will update.
docs/user-guides/pallet-proxy.md
Outdated
|
|
||
| | Constant | Description | | ||
| |--------------------------|--------------------------------------------------------------------------------------------------------------| | ||
| | announcementDepositBase | Retrieves the base amount of currency required to reserve when creating an announcement. | |
There was a problem hiding this comment.
Strange choice of words with Retrieves. 🤔
docs/user-guides/pallet-proxy.md
Outdated
|
|
||
| **Why Proxy Deposits ?** | ||
| --- | ||
| To create proxies within the network, it is necessary to provide deposits in the native currency (like ASTR or SHD). The deposit is required because adding a proxy requires some storage space on-chain, which must be replicated across every peer in the network. Due to the costly nature of this, these functions could open up the network to a Denial-of-Service attack |
There was a problem hiding this comment.
my bad.
will update.
|
|
||
| **Why use Proxy?** | ||
| --- | ||
| Pallet Proxy enables accounts to grant specific permissions to other accounts, empowering them to make calls on their behalf, thereby safeguarding the security of the underlying accounts. |
There was a problem hiding this comment.
Can we add an introduction block of anonymous (= pure) proxy?
This is for sure more dangerous for non experimented users but it's also the best security since it's the only way to have a proxy that can't be controlled from private keys.
https://wiki.polkadot.network/docs/learn-proxies#anonymous-proxy-pure-proxy
|
|
||
|  | ||
|
|
||
| Congratulations! You've completed the entire process successfully. You have created a proxy account, reviewed all the proxy accounts linked to your primary account, performed a proxy transaction, and even removed a proxy account. Well done! |
There was a problem hiding this comment.
Suggestion: add this video as external resource that covers pure proxy from use case
https://youtu.be/MqY6yU-YLO0
There was a problem hiding this comment.
thanks for the suggestion.
Co-authored-by: midegdugarova <59020389+midegdugarova@users.noreply.github.com>
Pull Request Summary
This PR contains docs regarding pallet-proxy: proxytypes, extrinsics, storage method and constants.