Reference
The Auth Kit (opens in a new tab) creates or retrieves an Ethereum address and authenticates a blockchain account using an email address, a social media platform or a crypto wallet address.
Install dependencies
To add the Auth Kit to your project, run:
_10yarn add @safe-global/auth-kit @web3auth/safeauth-embed
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, you must ensure the appropriate packages are installed.
How to use a pack
To start working with the packs, instantiate the main class and call the init()
method afterward.
_10const pack = new SafeAuthPack(packConfig)_10await pack.init(packInitOptions)
After the initialization, use the methods in the pack to interact with the chosen provider.
Some common methods (signIn()
, signOut()
, etc.) can be called regardless of the package being used.
The kit creates a common interface that any pack should implement. Check the AuthKitBasePack
abstract class to get more details.