docs(auth-kit): Update docs for the new `SafeAuthPack` #273

yagopv · 2023-11-06T10:56:10Z

This PR updates the docs for the auth-kit:

tanay1337

The docs structure has changed, so the location of the files and the placement in the sidebar will also need to be updated.

tanay1337 · 2023-11-27T08:16:51Z

reference/safe-core-sdk/auth-kit/AuthKitBasePack.md

 - `address`: The Ethereum address extracted from the provider.

 ### `getSafes(txServiceUrl): safes[]`

-Returns the list of Safes associated with the signer address by calling  the `getAddress()` method internally.
+Returns the list of Safes associated with the signer address by calling the `getAddress()` method internally.


Suggested change

Returns the list of Safes associated with the signer address by calling the `getAddress()` method internally.

Returns the list of Safes associated with the signer address by internally calling the `getAddress()` method.

tanay1337 · 2023-11-27T08:17:25Z

reference/safe-core-sdk/auth-kit/README.md

 ```

 The Auth Kit can integrate several providers in the form of **"packs"**. A pack is a piece of code that works with the chosen provider to give Safe users access to new services.

-To use each pack, the right package needs to be installed:
+To use each pack, you need to ensure that the appropriate packages are installed.


Suggested change

To use each pack, you need to ensure that the appropriate packages are installed.

To use each pack, you must ensure the appropriate packages are installed.

tanay1337 · 2023-11-27T08:18:26Z

reference/safe-core-sdk/auth-kit/SafeAuthPack.md

@@ -0,0 +1,216 @@
+# SafeAuthPack
+
+SafeAuth is a pluggable authentication infrastructure for Web3 wallets and applications. It simplifies onboarding for both mainstream and crypto native users, offering experiences tailored to their preferences. It supports all social logins, web and mobile native platforms, wallets, and other key management methods, creating a cryptographic key provider specific to the user and application.


Suggested change

SafeAuth is a pluggable authentication infrastructure for Web3 wallets and applications. It simplifies onboarding for both mainstream and crypto native users, offering experiences tailored to their preferences. It supports all social logins, web and mobile native platforms, wallets, and other key management methods, creating a cryptographic key provider specific to the user and application.

SafeAuth is a pluggable authentication infrastructure for Web3 wallets and applications. It simplifies onboarding for mainstream and crypto native users, offering experiences tailored to their preferences. It supports all social logins, web and mobile native platforms, wallets, and other key management methods, creating a cryptographic key provider specific to the user and application.

tanay1337 · 2023-11-27T08:18:56Z

reference/safe-core-sdk/auth-kit/SafeAuthPack.md

+
+SafeAuth is a pluggable authentication infrastructure for Web3 wallets and applications. It simplifies onboarding for both mainstream and crypto native users, offering experiences tailored to their preferences. It supports all social logins, web and mobile native platforms, wallets, and other key management methods, creating a cryptographic key provider specific to the user and application.
+
+The `SafeAuthPack` enables the use of the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.


Suggested change

The `SafeAuthPack` enables the use of the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.

The `SafeAuthPack` enables using the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.

tanay1337 · 2023-11-27T08:19:51Z

reference/safe-core-sdk/auth-kit/SafeAuthPack.md

+
+The `SafeAuthPack` enables the use of the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.
+
+The pack helps with the onboarding of web2 users and provides a ethereum signer address that can be used across any dApp using the different Ethereum chains.


Suggested change

The pack helps with the onboarding of web2 users and provides a ethereum signer address that can be used across any dApp using the different Ethereum chains.

The pack helps onboard web2 users and provides an Ethereum signer address that can be used across any dApp using different Ethereum chains.

tanay1337 · 2023-11-27T09:18:08Z

reference/safe-core-sdk/auth-kit/SafeAuthPack.md

+
+## Usage
+
+Calling `init()` when your page loads or component renders is all it takes to use the Auth Kit with the `SafeAuthPack`. To start the authentication process, simply call `signIn()` afterwards. This method returns the EOA and associated Safe addresses.


Suggested change

Calling `init()` when your page loads or component renders is all it takes to use the Auth Kit with the `SafeAuthPack`. To start the authentication process, simply call `signIn()` afterwards. This method returns the EOA and associated Safe addresses.

Calling `init()` when your page loads or component renders is all it takes to use the Auth Kit with the `SafeAuthPack`. To start the authentication process, call `signIn()` afterward. This method returns the EOA and associated Safe addresses.

tanay1337 · 2023-11-27T09:20:37Z

safe-core-sdk/auth-kit/safe-auth.md

@@ -0,0 +1,179 @@
+# Integration with SafeAuth
+
+This guide demonstrate how to create an externally-owned account using your email or social media account. Once authenticated, you can sign transactions and interact with any Safe accounts you own.


Suggested change

This guide demonstrate how to create an externally-owned account using your email or social media account. Once authenticated, you can sign transactions and interact with any Safe accounts you own.

This guide demonstrates creating an externally-owned account using your email or social media account. Once authenticated, you can sign transactions and interact with your Safe accounts.

tanay1337 · 2023-11-27T09:21:20Z

safe-core-sdk/auth-kit/safe-auth.md

+
+## Create a SafeAuthPack instance
+
+We are going to use the provided `SafeAuthPack` exported in the `@safe-global/auth-kit` package.


Suggested change

We are going to use the provided `SafeAuthPack` exported in the `@safe-global/auth-kit` package.

We will use the provided `SafeAuthPack` exported in the `@safe-global/auth-kit` package.

tanay1337 · 2023-11-27T09:22:12Z

safe-core-sdk/auth-kit/safe-auth.md

+
+## Sign in to an Ethereum account
+
+After creating your `SafeAuthPack` instance, initiate the authentication process by calling the `signIn()` method. Typically, this method is called when the user clicks on a "Sign In" button on the web page.


Suggested change

After creating your `SafeAuthPack` instance, initiate the authentication process by calling the `signIn()` method. Typically, this method is called when the user clicks on a "Sign In" button on the web page.

After creating your `SafeAuthPack` instance, initiate the authentication process by calling the `signIn()` method. Typically, this method is called when the user clicks a "Sign In" button on the web page.

tanay1337 · 2023-11-27T09:23:25Z

safe-core-sdk/auth-kit/safe-auth.md

+
+## Signing and executing transactions using the SafeAuthPack and Protocol Kit
+
+The `SafeAuthPack` can be used in conjunction with the [Protocol Kit](../protocol-kit/README.md) to establish a connection to a Safe. This connection is made using the `provider` and `signer` associated with the authenticated account.


Suggested change

The `SafeAuthPack` can be used in conjunction with the [Protocol Kit](../protocol-kit/README.md) to establish a connection to a Safe. This connection is made using the `provider` and `signer` associated with the authenticated account.

The `SafeAuthPack` can be used with the [Protocol Kit](../protocol-kit/README.md) to establish a connection to a Safe. This connection is made using the `provider` and `signer` associated with the authenticated account.

dasanra · 2023-11-27T16:22:13Z

@tanay1337 thank you for your review! I took all the suggestions and adapted the PR to match the current Safe docs structure. We can continue here:

#289

yagopv added 3 commits November 2, 2023 12:21

Update docs

4e40edb

Update docs

f1921bf

Update naming

6ae94f1

yagopv added the don't merge label Nov 6, 2023

yagopv self-assigned this Nov 6, 2023

This was linked to issues Nov 6, 2023

[Web3Auth Safe Signer] Update safe-docs reference section #262

Closed

[Web3Auth Safe Signer] Update safe-docs integration section #263

Closed

yagopv changed the title ~~Feat/update auth kit docs~~ docs(auth-kit): Update docs for the new SafeAuthPack Nov 6, 2023

yagopv marked this pull request as ready for review November 8, 2023 10:38

yagopv requested review from germartinez and dasanra November 8, 2023 10:38

yagopv added 6 commits November 8, 2023 11:38

Some improvements

5789a54

Add examples

6782167

Remove signTransaction

8ad76eb

Add supported networks

22ea1aa

Add login_hint description

5761431

Add web3auth package

e58014c

tanay1337 requested changes Nov 27, 2023

View reviewed changes

tanay1337 removed the request for review from germartinez November 27, 2023 09:26

dasanra mentioned this pull request Nov 27, 2023

docs(auth-kit): Update docs for the new SafeAuthPack #289

Merged

dasanra closed this Nov 27, 2023

This was unlinked from issues Nov 30, 2023

[Web3Auth Safe Signer] Update safe-docs reference section #262

Closed

[Web3Auth Safe Signer] Update safe-docs integration section #263

Closed

dasanra deleted the feat/update-auth-kit-docs branch December 4, 2023 11:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(auth-kit): Update docs for the new `SafeAuthPack` #273

docs(auth-kit): Update docs for the new `SafeAuthPack` #273

yagopv commented Nov 6, 2023 •

edited

Loading

tanay1337 left a comment

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

tanay1337 Nov 27, 2023

dasanra commented Nov 27, 2023

	Returns the list of Safes associated with the signer address by calling the `getAddress()` method internally.
	Returns the list of Safes associated with the signer address by internally calling the `getAddress()` method.

	To use each pack, you need to ensure that the appropriate packages are installed.
	To use each pack, you must ensure the appropriate packages are installed.

		@@ -0,0 +1,216 @@
		# SafeAuthPack

		SafeAuth is a pluggable authentication infrastructure for Web3 wallets and applications. It simplifies onboarding for both mainstream and crypto native users, offering experiences tailored to their preferences. It supports all social logins, web and mobile native platforms, wallets, and other key management methods, creating a cryptographic key provider specific to the user and application.


		SafeAuth is a pluggable authentication infrastructure for Web3 wallets and applications. It simplifies onboarding for both mainstream and crypto native users, offering experiences tailored to their preferences. It supports all social logins, web and mobile native platforms, wallets, and other key management methods, creating a cryptographic key provider specific to the user and application.

		The `SafeAuthPack` enables the use of the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.

	The `SafeAuthPack` enables the use of the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.
	The `SafeAuthPack` enables using the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.


		The `SafeAuthPack` enables the use of the [Web3Auth infrastructure](https://web3auth.io) with added Safe capabilities, such as retrieving the related Safe addresses for a given externally-owned account created using SafeAuth services.

		The pack helps with the onboarding of web2 users and provides a ethereum signer address that can be used across any dApp using the different Ethereum chains.

	The pack helps with the onboarding of web2 users and provides a ethereum signer address that can be used across any dApp using the different Ethereum chains.
	The pack helps onboard web2 users and provides an Ethereum signer address that can be used across any dApp using different Ethereum chains.


		## Usage

		Calling `init()` when your page loads or component renders is all it takes to use the Auth Kit with the `SafeAuthPack`. To start the authentication process, simply call `signIn()` afterwards. This method returns the EOA and associated Safe addresses.

		@@ -0,0 +1,179 @@
		# Integration with SafeAuth

		This guide demonstrate how to create an externally-owned account using your email or social media account. Once authenticated, you can sign transactions and interact with any Safe accounts you own.

	This guide demonstrate how to create an externally-owned account using your email or social media account. Once authenticated, you can sign transactions and interact with any Safe accounts you own.
	This guide demonstrates creating an externally-owned account using your email or social media account. Once authenticated, you can sign transactions and interact with your Safe accounts.


		## Create a SafeAuthPack instance

		We are going to use the provided `SafeAuthPack` exported in the `@safe-global/auth-kit` package.

	We are going to use the provided `SafeAuthPack` exported in the `@safe-global/auth-kit` package.
	We will use the provided `SafeAuthPack` exported in the `@safe-global/auth-kit` package.


		## Sign in to an Ethereum account

		After creating your `SafeAuthPack` instance, initiate the authentication process by calling the `signIn()` method. Typically, this method is called when the user clicks on a "Sign In" button on the web page.


		## Signing and executing transactions using the SafeAuthPack and Protocol Kit

		The `SafeAuthPack` can be used in conjunction with the [Protocol Kit](../protocol-kit/README.md) to establish a connection to a Safe. This connection is made using the `provider` and `signer` associated with the authenticated account.

	The `SafeAuthPack` can be used in conjunction with the [Protocol Kit](../protocol-kit/README.md) to establish a connection to a Safe. This connection is made using the `provider` and `signer` associated with the authenticated account.
	The `SafeAuthPack` can be used with the [Protocol Kit](../protocol-kit/README.md) to establish a connection to a Safe. This connection is made using the `provider` and `signer` associated with the authenticated account.

docs(auth-kit): Update docs for the new SafeAuthPack #273

docs(auth-kit): Update docs for the new SafeAuthPack #273

Conversation

yagopv commented Nov 6, 2023 • edited Loading

tanay1337 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dasanra commented Nov 27, 2023

docs(auth-kit): Update docs for the new `SafeAuthPack` #273

docs(auth-kit): Update docs for the new `SafeAuthPack` #273

yagopv commented Nov 6, 2023 •

edited

Loading