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

xAlias - overview, integration examples #797

Merged
merged 9 commits into from
Jan 17, 2024
Merged

xAlias - overview, integration examples #797

merged 9 commits into from
Jan 17, 2024

Conversation

andreibancioiu
Copy link
Contributor

@andreibancioiu andreibancioiu commented Jan 14, 2024

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

Document xAlias. Add integration notes.

Related to: multiversx/mx-sdk-js-examples#29.

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

@andreibancioiu andreibancioiu self-assigned this Jan 14, 2024
@andreibancioiu andreibancioiu changed the title xAlias - integration docs xAlias - overview, integration examples Jan 14, 2024
@andreibancioiu andreibancioiu marked this pull request as ready for review January 15, 2024 12:55
radumojic
radumojic previously approved these changes Jan 15, 2024

[comment]: # (mx-context-auto)

## The Web Wallet Provider
## The web wallet & xAlias provider
Copy link
Contributor

Choose a reason for hiding this comment

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

this will break the link to this section. might add a redirect on docusaurus.config.js or leave the section title as it is

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch, thanks 🙌

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Left the section title as it was.


Generally speaking, a signing provider is a component that supports the following use-cases:

- **Login (trivial flow, not recommended)**: the user of a dApp is asked her MultiversX identity. The user reaches the wallet, unlocks it, and confirms the login. The flow continues back to the dApp, which is now informed about the user's blockchain address. Note, though, that this piece of information is not authenticated: the dApp receives a _hint_ about the user's address, not a _guarantee_ (proof). Sometimes (though rarely), this is enough. If in doubt, always have your users login using the **native authentication** flow (see below).
Copy link
Contributor

Choose a reason for hiding this comment

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

login->log in and logout->log out where needed
login/logout are nouns (for example: the login page)
log in/log out are actions (for example: please log in)

@andreibancioiu andreibancioiu merged commit 015a81f into main Jan 17, 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.

3 participants