Skip to content

Commit

Permalink
some more changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ihsraham committed Oct 4, 2023
1 parent d9eda53 commit 283ec75
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/sdk/core-kit/sfa-node/sfa-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ displayed_sidebar: sdk
description: "Web3Auth Core Kit Single Factor Auth Node.js SDK | Documentation - Web3Auth"
---

Web3Auth's `@web3auth/node-sdk` SDK is a simple and easy to use SDK in your Node.js backend to get the same experience of Web3Auth frontend SDKs.
Web3Auth's `@web3auth/node-sdk` SDK is a simple and easy-to-use SDK in your Node.js backend to get the same experience as Web3Auth frontend SDKs.

:::info This SDK gives you semi custodial keys
:::info This SDK gives you semi-custodial keys

The `@web3auth/node` SDK gives you the simplest flow for onboarding a user with Web3Auth. The user just needs to click on the login button, connect to
their favourite social account (OAuth) or any passwordless flow, like email passwordless, biometric authentication etc., and a private key is
generated for them. This flow has a 1/1 Key Share setup and the whole key via Web3Auth Auth Network key shares is provided directly to your app, and
their favorite social account (OAuth) or any passwordless flow, like email passwordless, biometric authentication etc., and a private key is generated
for them. This flow has a 1/1 Key Share setup and the whole key via Web3Auth Auth Network key shares is provided directly to your app, and
reconstructed within it.

This flow is still non custodial since the nodes in the Web3Auth network have a 5/9 consensus mechanism to generate the key shares. However, one can
claim that this flow is custodial to the OAuth Login provider, since this is directly generated using credentials provided by them.
This flow is still non-custodial since the nodes in the Web3Auth network have a 5/9 consensus mechanism to generate the key shares. However, one can
claim that this flow is custodial to the OAuth Login provider since this is directly generated using credentials provided by them.

Hence we can call this flow a semi-custodial flow, and encourage users to enable MFA to have a 2/3 Key Share setup, which is a fully non custodial.
Hence we can call this flow a semi-custodial flow, and encourage users to enable MFA to have a 2/3 Key Share setup, which is fully non-custodial.

:::

#### This Documentation is based on `2.0.1` SDK Version.
#### This Documentation is based on `3.0.0` SDK Version.

## Requirements

- This is a backend SDK and can in any node environment
- This is a backend SDK and can be used in any node environment
- Basic knowledge of NodeJS

## Resources
Expand Down
2 changes: 2 additions & 0 deletions docs/sdk/pnp/react-native/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ You can pass extra options to the `login` function to configure the login flow f
| `prompt` | `Prompt?` | No | Prompt |
| `max_age` | `String?` | No | max_age |
| `ui_locales` | `String?` | No | ui_locales to be shown on the modal |
| `id_token` | `String?` | No | JWT token passed to authenticate with web3auth |
| `login_hint` | `String?` | No | Email used for EMAIL_PASSWORDLESS |
| `acr_values` | `String?` | No | acc_values |
| `scope` | `String?` | No | scope |
Expand Down Expand Up @@ -237,6 +238,7 @@ export interface BaseLoginOptions {
* This currently only affects the classic Lock experience.
*/
login_hint?: string;
id_token?: string;
acr_values?: string;
/**
* The default scope to be used on authentication requests.
Expand Down

0 comments on commit 283ec75

Please sign in to comment.