Skip to content

Commit

Permalink
Sketch xAlias page.
Browse files Browse the repository at this point in the history
  • Loading branch information
@andreibancioiu
andreibancioiu committed Jan 14, 2024
1 parent 2ffd05d commit 23e62d4
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/sdk-and-tools/sdk-js/sdk-js-signing-providers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Note that for most purposes, **we recommend using [sdk-dapp](https://github.com/
Generally speaking, a signing provider is a component that supports the following use-cases:

- **Login**: 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).
- **Login using Native Authentication**: once the user decides to login, the dApp crafts a special piece of data called _the native authentication initial part_ - a shortly-lived artifact that contains, among others, a marker of the originating dApp and a marker of the target Network. The user is given this piece of data and is asked to sign it in order to prove her MultiversX identity. The user reaches the wallet, which unwraps and (partly) displays the payload of _the native authentication initial part_. The user unlocks the wallet and confirms the login - under the hood, the _part_ is signed with the user's secret key. The flow continues back to the dApp, which now receives the user's blockchain address, along with a proof (signature). Then, the dApp (e.g. maybe a server-side component) can verify the signature to make sure that the user is indeed the owner of the address.
- **Login using Native Authentication**: once the user decides to login, the dApp crafts a special piece of data called _the native authentication initial part_ - a shortly-lived artifact that contains, among others, a marker of the originating dApp and a marker of the target Network. The user is given this piece of data and is asked to sign it, to prove her MultiversX identity. The user then reaches the wallet, which unwraps and (partly) displays the payload of _the native authentication initial part_. The user unlocks the wallet and confirms the login - under the hood, the _part_ is signed with the user's secret key. The flow continues back to the dApp, which now receives the user's blockchain address, along with a proof (signature). Then, the dApp (e.g. maybe a server-side component) can verify the signature to make sure that the user is indeed the owner of the address.
- **Logout**: ...
- **Sign transactions**:
- **Sign messages**:
Expand Down
9 changes: 5 additions & 4 deletions docs/wallet/overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ There are multiple ways you can store your funds. This page will present some of

| Name | Description |
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| [xPortal App](https://xportal.com/) | Digital wallet and global payments app that allows you to exchange and securely store money on your mobile phone. |
| [xPortal App](https://xportal.com/) | Digital wallet and global payments app that allows you to exchange and securely store money on your mobile phone. |
| [Web Wallet](/wallet/web-wallet) | MultiversX Web Wallet |
| [Web Wallet - tokens operations](/wallet/create-a-fungible-token) | Learn how to perform tokens operation inside Web Wallet |
| [MultiversX DeFi Wallet](/wallet/wallet-extension/) | MultiversX DeFi Wallet Extension |
| [xAlias](/wallet/xalias) | Single sign-on solution for Web3, powered by Web2 (Google Sign-In). |
| [Web Wallet - tokens operations](/wallet/create-a-fungible-token) | Learn how to perform tokens operation inside Web Wallet. |
| [MultiversX DeFi Wallet](/wallet/wallet-extension/) | MultiversX DeFi Wallet Extension |
| [Ledger](/wallet/ledger) | Ledger Hardware Wallet |
| [Keystore](/wallet/keystore) | Learn more about how to use the **keystore** file |
| [Keystore](/wallet/keystore) | Learn more about how to use the **keystore** file. |
15 changes: 15 additions & 0 deletions docs/wallet/xalias.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: xalias
title: xAlias
---

[comment]: # (mx-abstract)

**xAlias** is a _single sign-on_ solution for Web3, powered by Google Sign-In (Web2). It allows new users (not yet proficient in blockchain technologies) to quickly and easily create blockchain wallets (without the need of seed phrases), then start right away and interact with MultiversX dApps.

It's a _self-custody_ wallet, and it's _convertible_ to a conventional Web3 wallet at a later point.

:::important
**For dApp developers:** xAlias exposes **the same [URL hooks and callbacks](/wallet/webhooks)** as the [Web Wallet](/wallet/web-wallet). Therefore, integrating xAlias is **identical to integrating the Web Wallet** (with one trivial exception: the configuration of the URL base). See [Signing Providers for dApps](/sdk-and-tools/sdk-js/sdk-js-signing-providers).
:::

1 change: 1 addition & 0 deletions sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,7 @@ const sidebars = {
Wallet: [
"wallet/overview",
"wallet/web-wallet",
"wallet/xalias",
"wallet/wallet-extension",
"wallet/webhooks",
"wallet/ledger",
Expand Down

0 comments on commit 23e62d4

Please sign in to comment.