Skip to content

Commit 5ce0de6

Browse files
committed
Fix: #AR-5919 review fixes
1 parent 4d183f4 commit 5ce0de6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+616
-564
lines changed

an_dictionary.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ HDWallet
200200
HTML
201201
Hashicorp
202202
HighwayHash
203+
IAM
203204
IBFT
204205
ID1
205206
IPFS
@@ -256,6 +257,7 @@ OAuth2
256257
OTP
257258
Okta
258259
Onboarding
260+
OpenID
259261
OpenSea
260262
OtpLoginResponse
261263
P1
@@ -271,13 +273,15 @@ Polyfill
271273
Polygon_Mainnet
272274
Polygon_Mumbai_Testnet
273275
Pre
276+
Pre-configured
274277
Programmatically
275278
ProviderEngine
276279
PublicKeyOutput
277280
PvtBetaGHBranchText
278281
Pwdless
279282
PwdlessAuthConfigText
280283
QoS
284+
README
281285
RFP
282286
RHS
283287
RPC
@@ -426,6 +430,7 @@ Vn
426430
Vue
427431
Vue-CLI
428432
Wagmi
433+
WagmiConfig
429434
WalletConfigWarningText
430435
WalletConnect
431436
WalletConnectProvider
@@ -594,6 +599,7 @@ faq_nftviewer
594599
faq_storage
595600
faq_validator
596601
fb
602+
fedidmauth
597603
fontawesome-brands-aws
598604
fontawesome-brands-discord
599605
fontawesome-brands-github
@@ -723,6 +729,7 @@ idfaqgen
723729
idfaqnftviewer
724730
idfaqstorage
725731
idfaqvalidator
732+
idfedidmauth
726733
idgeneratedelegatekey
727734
idgithuboauth
728735
idgoogleoauth

docs/concepts/anwallet/walletuimodes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Once the user takes action, the request disappears and the user cannot access th
3333

3434
## Summary
3535

36-
The table below summarizes how `alwaysVisible` parameter specified during Auth SDK initialization in the application code controls the user experience. For step-by-step instructions see [how to configure Arcana wallet visibility mode]({{page.meta.arcana.root_rel_path}}/howto/arcana_wallet/config_wallet_modes.md) guide.
36+
The table below summarizes how `alwaysVisible` parameter specified during Auth SDK initialization in the application code controls the user experience. For step-by-step instructions see [how to configure Arcana wallet visibility mode]({{page.meta.arcana.root_rel_path}}/howto/arcana_wallet/config_walletvisibility.md) guide.
3737

3838
| Wallet UI Mode | Flag | User Experience|
3939
| :------ | :----- | :----------- |

docs/concepts/authtype/arcanaauth.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,22 @@ arcana:
1010

1111
# Authentication
1212

13-
Authentication in the Web3 ecosystem is more complex than in traditional Web2 applications. Users must have a private key to interact with blockchain and cryptographic systems. This can be cumbersome for users, as generating and managing private keys can be difficult and there is no central authority for recovery if a key is lost. Web3 wallets can make this process easier, but they are a new concept for many Web2 users and managing secrets for the wallet can be an additional burden. This can make it difficult for new users to onboard Web3 applications and the onboarding experience is different from that of Web2 applications.
13+
Authentication in the Web3 ecosystem is more complex than in traditional Web2 applications. Users must have a private key to interact with the blockchain networks and cryptographic systems. This can be cumbersome for users, as generating and managing private keys can be difficult and there is no central authority for recovery if a key is lost. Web3 wallets can make this process easier, but they are a new concept for many Web2 users and managing secrets for the wallet can be an additional burden. This can make it difficult for new users to onboard Web3 applications and the onboarding experience is different from that of Web2 applications.
1414

15-
**Arcana's [Auth SDK]({{page.meta.arcana.root_rel_path}}/concepts/authsdk.md) significantly reduces the barriers to user authentication and simplifies the process of signing blockchain transactions by eliminating the need for key management.**
15+
**The [{{config.extra.arcana.sdk_name}}]({{page.meta.arcana.root_rel_path}}/concepts/authsdk.md) significantly reduces the barriers to Web3 user onboarding and enables authenticated app users to easily sign blockchain transactions by eliminating the need for complex key management without sacrificing security and privacy.**
1616

1717
## Authentication Mechanisms
1818

19-
Web3 application developers can [plug in default UI]({{page.meta.arcana.root_rel_path}}/concepts/plugnplayauth.md) for user login or build their own UI and call Auth SDK functions to enable one or more authentication mechanisms:
19+
Web3 app developers can use {{config.extra.arcana.sdk_name}} [plug-and-play login UI]({{page.meta.arcana.root_rel_path}}/concepts/plugnplayauth.md) to add user onboarding code in the app. Or they can also build a custom UI for user login and call the {{config.extra.arcana.sdk_name}} user onboarding functions to enable user authentication.
2020

21-
* [Social authentication]({{page.meta.arcana.root_rel_path}}/concepts/authtype/socialauth.md)
22-
* [Passwordless authentication]({{page.meta.arcana.root_rel_path}}/concepts/authtype/pwdless.md)
21+
The {{config.extra.arcana.sdk_name}} allows developers to configure multiple user authentication providers and onboard users. The following authentication mechanisms are supported:
2322

24-
!!! note
23+
* [Passwordless Login]({{page.meta.arcana.root_rel_path}}/concepts/authtype/pwdless.md)
24+
* [Social Providers]({{page.meta.arcana.root_rel_path}}/concepts/authtype/socialauth.md)
25+
* [Custom IAM Providers]({{page.meta.arcana.root_rel_path}}/concepts/authtype/customauth.md)
2526

26-
Arcana's [Auth SDK]({{page.meta.arcana.root_rel_path}}/concepts/authsdk.md) allows developers to enable authenticated users to sign blockchain transactions.
27+
!!! note "Associating Web3 Keys with Authenticated Users"
28+
29+
The {{config.extra.arcana.sdk_name}} allows developers to plug in user onboarding in the Web3 apps and enable authenticated users to sign blockchain transactions.
2730
28-
It includes the [Arcana wallet]({{page.meta.arcana.root_rel_path}}/concepts/anwallet/index.md), which provides a standard Ethereum provider interface for securely enabling blockchain transactions. Arcana's `AuthProvider` encapsulates a decentralized key generated by Arcana's asynchronous, distributed key generation ([DKG]({{page.meta.arcana.root_rel_path}}/concepts/dkg/index.md)) protocol. After users are authenticated through social or passwordless login mechanisms, developers can use the provider to enable them to securely sign blockchain transactions.
31+
The [{{config.extra.arcana.wallet_name}}]({{page.meta.arcana.root_rel_path}}/concepts/anwallet/index.md), is part of the {{config.extra.arcana.sdk_name}} and available to all authenticated users. It is a non-custodial wallet that provides a standard Ethereum provider interface for securely enabling blockchain transactions. The `{{config.extra.arcana.auth_sdk_pkg_name}}` provides `AuthProvider` that abstracts decentralized keys generated by the asynchronous, distributed key generation ([ADKG]({{page.meta.arcana.root_rel_path}}/concepts/dkg/index.md)) protocol in the Arcana Network.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
slug: /fedidmauth
3+
id: idfedidmauth
4+
title: Custom IAM Providers
5+
sidebar_custom_props:
6+
cardIcon: ▶️
7+
arcana:
8+
root_rel_path: ../..
9+
---
10+
11+
# Custom IAM Providers
12+
13+
Custom IAM providers allow various user authentication mechanisms including authentication via social providers and authentication standards such as OpenID. The {{config.extra.arcana.sdk_name}} supports the following Custom IAM providers for user authentication:
14+
15+
{% include "./text-snippets/custom_idm_supported.md" %}

docs/concepts/authtype/index.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
1+
---
2+
arcana:
3+
root_rel_path: ../..
4+
---
5+
16
# Authentication Types
27

3-
The Arcana Auth SDK supports the following authentication types:
8+
The {{config.extra.arcana.sdk_name}} supports the following authentication providers:
9+
10+
[Social Providers :fontawesome-solid-users-gear:](./socialauth.md){ .md-button }
11+
12+
[Custom IAM Providers :fontawesome-solid-users-gear:](./customauth.md){ .md-button }
13+
14+
[Passwordless Login :material-card-account-mail:](./pwdless.md){ .md-button }
15+
16+
!!! info "Aggregate Logins"
417

5-
[Social Authentication :fontawesome-solid-users-gear:](./socialauth.md){ .md-button }
18+
The {{config.extra.arcana.sdk_name}} supports [aggregate login]({{page.meta.arcana.root_rel_path}}/concepts/authtype/aggregatelogin.md) feature. With aggregate login, application users can be identified even if they use multiple authentication mechanisms to onboard an app. An authenticated user is identified and associated with the same key shares and does not have to juggle multiple wallet addresses. Aggregate login ensures there are no duplicate user identities or {{config.extra.arcana.wallet_name}} addresses assigned to the same user.
619

7-
[Passwordless Login :material-card-account-mail:](./pwdless.md){ .md-button }
20+
The aggregate login feature works **only if** the user specifies the **same** email ID to register with different authentication providers or via the passwordless login option.

docs/concepts/authtype/pwdless.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,18 @@
11
---
22
slug: /pwdless
33
id: idpwdless
4-
title: passwordless Login
4+
title: Passwordless Login
55
sidebar_custom_props:
66
cardIcon: ▶️
7+
arcana:
8+
root_rel_path: ../..
79
---
810

9-
# Passwordless Authentication
11+
# Passwordless Login
1012

1113
<img src="/img/icons/i_an_pwdless_light.png#only-light" width="50"/>
1214
<img src="/img/icons/i_an_pwdless_dark.png#only-dark" width="50"/>
1315

14-
With Arcana Auth, users can easily onboard any Web3 application with passwordless authentication simply by providing an email ID.
16+
With the {{config.extra.arcana.sdk_name}}, users can easily onboard any Web3 app in a passwordless manner by simply providing an email ID.
1517

16-
Application users receive an email verification link or a time-sensitive OTP that can be used to log in to the application. This passwordless approach eliminates the need to remember passwords or share social account identifiers with the application provider, making the onboarding process completely friction-free.
17-
18-
!!! note
19-
20-
After passwordless authentication, developers can enable users access the embedded Web3 Arcana wallet included with the Auth SDK to sign blockchain transactions.
18+
App users receive an email verification link or a time-sensitive OTP that can be used to log in to the application. This passwordless approach eliminates the need to remember passwords or share social account identifiers to onboard an app, making the onboarding process completely frictionless.
Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,24 @@
11
---
22
slug: /socialauth
33
id: idsocialauth
4-
title: Social Authentication
4+
title: Social Providers
55
sidebar_custom_props:
66
cardIcon: ▶️
77
arcana:
88
root_rel_path: ../..
99
---
1010

11-
# Social Authentication
11+
# Social Providers
1212

1313
<img src="/img/icons/i_an_socialauth_light.png#only-light" width="50"/>
1414
<img src="/img/icons/i_an_socialauth_dark.png#only-dark" width="50"/>
1515

16-
Social authentication allows applications to onboard users and validate their identity through popular Web2 authentication provider. Arcana Auth SDK supports social authentication in Web3 applications for the following providers:
16+
Social providers are popular Web2 identity providers that allow apps to onboard users and validate the user identity. The {{config.extra.arcana.sdk_name}} supports user authentication in Web3 applications via the following social providers:
1717

1818
{% include "./text-snippets/auth_supported.md" %}
1919

20-
In Web2 applications, social authentication is typically triggered by a pop-up or redirect to a provider chosen by the user. This is a familiar and easy way for users to onboard new applications without managing multiple identities. However, a centralized system with a few organizations controls user authentication.
20+
In Web2 applications, user authentication is typically triggered by a pop-up or via a redirect to a selected provider's web page. This is a familiar and comfortable way for users to onboard a new application without bothering to manage multiple identities. However, this is a centralized authentication system controlled by the social provider.
2121

22-
In the Web3 ecosystem, decentralized systems of actors use trustless protocols and cryptography to verify user identity in a decentralized manner. These systems use encrypted, sharded keys that are not stored with any single entity, but users must manage their own secret keys, which can be a barrier to entry for Web3 applications.
22+
In the Web3 ecosystem, distributed systems of actors use trustless protocols and cryptography to verify user identity in a decentralized manner. These systems use encrypted, key shares that are not stored with any single entity, but users are required to generate, manage and secure their secret keys. This complexity is a big barrier to entry into the Web3 app ecosystem.
2323

24-
Auth SDK lowers this barrier by providing a convenient and secure way for users to onboard Web3 applications in a decentralized manner.
25-
26-
!!! info "Aggregate Logins"
27-
28-
Arcana supports the [aggregate login]({{page.meta.arcana.root_rel_path}}/concepts/authtype/aggregatelogin.md) feature that can identify application users even if they use different authentication mechanisms to log in. Aggregate login ensures there are no duplicate user identities or Arcana Web3 wallet addresses assigned to the same user.
29-
30-
Aggregate login feature works **only if** the user specifies the **same** email ID to register with different social authentication providers and passwordless login.
24+
The {{config.extra.arcana.sdk_name}} lowers this barrier to entry into the Web3 app ecosystem by providing a convenient yet fully secure and privacy-preserving way for users to onboard Web3 apps and sign blockchain transactions.

docs/howto/arcana_wallet/config_wallet.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

docs/howto/arcana_wallet/config_wallet_modes.md

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)