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

update identities docs #801

Merged
merged 2 commits into from
Jan 17, 2024
Merged

update identities docs #801

merged 2 commits into from
Jan 17, 2024

Conversation

bogdan-rosianu
Copy link
Contributor

Description of the pull request (what is new / what has changed)

Document new validators/staking providers mechanism for branding through MultiversX Assets

Did you test the changes locally ?

  • yes
  • no

Which category (categories) does this pull request belong to?

  • document new feature
  • update documentation that is not relevant anymore
  • add examples or more information about a component
  • fix grammar issues
  • other

@bogdan-rosianu bogdan-rosianu self-assigned this Jan 16, 2024
@iulianpascalau iulianpascalau self-requested a review January 16, 2024 14:12
Copy link
Contributor

@iulianpascalau iulianpascalau left a comment

Choose a reason for hiding this comment

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

good stuff, congrats 🎉 👍

:::caution
As of March 2023, keybase.pub is no longer available. As a consequence, the identity verification mechanism has been switched to GitHub, including the profile information fetched from keybase.io.
As of January 2024, the only accepted way to customize the information of a delegation contract is via MultiversX Assets.
Provisioning of information from keybase or your Github repository is no longer accepted and you should migrate to the new approach is you still use those.
Copy link
Contributor

Choose a reason for hiding this comment

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

if you still ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

refactored

"name": "New identity",
"website": "http://newidentity.com",
"twitter": "https://twitter.com/newidentity",
"location": "France",
Copy link
Contributor

Choose a reason for hiding this comment

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

👌
Or could have been Country_37

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed

"twitter": "https://twitter.com/newidentity",
"location": "France",
"owners": [
"erd1qqqqqqqqqqqqqqqpqqqqqqqqqqqqqqqqqqqqqqqqqqqqqz8llllsh6u4jp", // staking provider address
Copy link
Contributor

Choose a reason for hiding this comment

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

this is the Arc Stake SP :D

Copy link
Contributor Author

Choose a reason for hiding this comment

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

only on mainnet. On testnet/devnet it might not even exist. However, will put a dummy sc address

- if you want to define the same identity for both a Staking Provider and simple nodes, set both the address of the Staking Provider and of the owner of the nodes

_Step 4: Open PR and validate the ownership_
After opening the PR, you also have to validate the ownership. Refer to the --- section
Copy link
Contributor

Choose a reason for hiding this comment

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

what is --- section?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, forgot to put the link

:::important
To also connect the validators themselves to a specific GitHub staking pool identity, two additional steps have to be completed:
:::note
Before MultiversX Assets, nodes owners needed to update the `Identity` field inside the `prefs.toml` file of each node. This is not required anymore now.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we remove this field in our next releases? cc @tanghel

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, it can be removed

:::caution
As of March 2023, keybase.pub is no longer available. As a consequence, the identity verification mechanism has been switched to GitHub, including the profile information fetched from keybase.io.
As of January 2024, the only accepted way to customize the information of a delegation contract is via MultiversX Assets.
Provisioning of information from keybase or your Github repository is no longer accepted and you should migrate to the new approach is you still use those.
Copy link
Contributor

Choose a reason for hiding this comment

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

"
Provisioning of information from keybase or your Github repository is no longer accepted.
The only accepted changes are on mx-assets identities.
You can safely delete the keybase profile and also the multiversx repository inside your organization's github.
"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

:::important
To also connect the validators themselves to a specific GitHub staking pool identity, two additional steps have to be completed:
:::note
Before MultiversX Assets, nodes owners needed to update the `Identity` field inside the `prefs.toml` file of each node. This is not required anymore now.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe you can also add " and you can safely leave the identity empty on your node configuration" to make it more clearer

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@bogdan-rosianu bogdan-rosianu merged commit bbbf1c5 into development Jan 17, 2024
1 check passed
@tanghel tanghel deleted the update-identities-docs branch January 17, 2024 08:56
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.

3 participants