Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Polkadot Wiki Migration] Identity section #11

Closed
wants to merge 9 commits into from

Conversation

nhussein11
Copy link
Collaborator

DO NOT MERGE - WIP 🚧

The "Identity" section was migrated from the existing Polkadot Wiki page:https://wiki.polkadot.network/docs/learn-guides-identity

@nhussein11 nhussein11 changed the title [Polkadot Wiki Migration] Multisigs section [Polkadot Wiki Migration] Identity section Sep 4, 2024
For further information about the setting and clearing of identity, refer to the [How to Set and Clear an Identity](https://support.polkadot.network/support/solutions/articles/65000181981-how-to-set-and-clear-an-identity){target=\_blank} guide on the Polkadot support page.

!!! note
Note the following caveat: because the fields support different formats, from raw bytes to various hashes, a UI has no way of telling how to encode a given field it encounters. The Polkadot.Js UI currently encodes the raw bytes it encounters as UTF-8 strings, which makes these values readable on-screen. However, given that there are no restrictions on the values that can be placed into these fields, a different UI may interpret them as, for example, IPFS hashes or encoded bitmaps. This means any field stored as raw bytes will become unreadable by that specific UI. As field standards crystallize, things will become easier to use, but for now, every custom implementation of displaying user information will likely have to make a conscious decision on the approach to take or support multiple formats and then attempt multiple encodings until the output makes sense.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 't.J' should have one space.

For further information about the setting and clearing of identity, refer to the [How to Set and Clear an Identity](https://support.polkadot.network/support/solutions/articles/65000181981-how-to-set-and-clear-an-identity){target=\_blank} guide on the Polkadot support page.

!!! note
Note the following caveat: because the fields support different formats, from raw bytes to various hashes, a UI has no way of telling how to encode a given field it encounters. The Polkadot.Js UI currently encodes the raw bytes it encounters as UTF-8 strings, which makes these values readable on-screen. However, given that there are no restrictions on the values that can be placed into these fields, a different UI may interpret them as, for example, IPFS hashes or encoded bitmaps. This means any field stored as raw bytes will become unreadable by that specific UI. As field standards crystallize, things will become easier to use, but for now, every custom implementation of displaying user information will likely have to make a conscious decision on the approach to take or support multiple formats and then attempt multiple encodings until the output makes sense.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[Papermoon.Acronyms] Spell out 'IPFS', if it's unfamiliar to the audience.


To request judgement, follow these steps:

1. In the Extrinsic section of the Polkadot.Js user interface, make the judgement request:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Google.Spacing] 't.J' should have one space.


1. In the Extrinsic section of the Polkadot.Js user interface, make the judgement request:
1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'requestJudgement'?


1. In the Extrinsic section of the Polkadot.Js user interface, make the judgement request:
1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'requestJudgement'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'registrarIndex'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'registrarIndex'?

2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
2. **maxFee**: The maximum fee the user is willing to pay for the judgement request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'maxFee'?

2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
2. **maxFee**: The maximum fee the user is willing to pay for the judgement request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'maxFee'?


## Clearing and Killing an Identity

The identity pallet allows users to clear and kill their identity.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Papermoon.WordSwapList] Use 'stop', 'exit', 'cancel', or 'end' instead of 'kill'.

The identity pallet allows users to clear and kill their identity.

- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose.
- Killing - it is is possible to kill an identity that you deem erroneous. This results in a slash of the deposit. To kill an identity, the `killIdentity` call is used.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Repetition] 'is' is repeated!

The identity pallet allows users to clear and kill their identity.

- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose.
- Killing - it is is possible to kill an identity that you deem erroneous. This results in a slash of the deposit. To kill an identity, the `killIdentity` call is used.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Papermoon.WordSwapList] Use 'stop', 'exit', 'cancel', or 'end' instead of 'kill'.

The identity pallet allows users to clear and kill their identity.

- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose.
- Killing - it is is possible to kill an identity that you deem erroneous. This results in a slash of the deposit. To kill an identity, the `killIdentity` call is used.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[Papermoon.WordSwapList] Use 'stop', 'exit', 'cancel', or 'end' instead of 'kill'.

@nhussein11 nhussein11 requested a review from 0xLucca September 4, 2024 14:55
@nhussein11 nhussein11 added B0 - Needs Review Pull request is ready for review and removed In Progress labels Sep 4, 2024
@@ -0,0 +1,56 @@
---
title: Identity
description: This section contains guides that explain how to manage identity on the Polkadot network. Learn how to interact with the Polkadot network by doing different operations with your identity.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Has more than 160 characters


## Request Judgement

In the Polkadot network, users can request judgement on their identity. This process involves submitting a judgement request to the registrar, who will then decide whether to accept or reject the request.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link to what a registrar is, or explain it


To request judgement, follow these steps:

1. In the Extrinsic section of the Polkadot.Js user interface, make the judgement request:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if it makes sense to have the 1. because there is only one step

The identity pallet allows users to clear and kill their identity.

- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose.
- Killing - it is is possible to kill an identity that you deem erroneous. This results in a slash of the deposit. To kill an identity, the `killIdentity` call is used.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Killing - it is is possible to kill an identity that you deem erroneous. This results in a slash of the deposit. To kill an identity, the `killIdentity` call is used.
- Killing - it is is possible to kill an identity that is deemed erroneous. This results in a slash of the deposit. To kill an identity, the `killIdentity` call is used


The identity pallet allows users to clear and kill their identity.

- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose.
- Clearing - users can clear their identity information and have their deposit returned. Clearing an identity also clears all sub-accounts and returns their deposits. The `clearIdentity` call is used for this purpose

nhussein11 and others added 3 commits September 5, 2024 14:55
Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com>
Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com>
Co-authored-by: 0xLucca <95830307+0xLucca@users.noreply.github.com>
1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'registrarIndex'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'registrarIndex'?

2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
2. **maxFee**: The maximum fee the user is willing to pay for the judgement request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'maxFee'?

2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
2. **maxFee**: The maximum fee the user is willing to pay for the judgement request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'maxFee'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'registrarIndex'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'registrarIndex'?

2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
2. **maxFee** - the maximum fee the user is willing to pay for the judgement request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'maxFee'?

2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex**: The index of the registrar to whom the judgement request is being made
2. **maxFee** - the maximum fee the user is willing to pay for the judgement request
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'maxFee'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex** - the index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Papermoon.CustomDictionary] Did you really mean 'registrarIndex'?

1. Select the **identity** pallet
2. Choose the **requestJudgement** extrinsic
3. Fill in the required fields
1. **registrarIndex** - the index of the registrar to whom the judgement request is being made
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'registrarIndex'?

@nhussein11 nhussein11 removed the B0 - Needs Review Pull request is ready for review label Sep 6, 2024
@nhussein11 nhussein11 closed this Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants