marc
    • Create new note
    • Create a note from template
      • Sharing URL Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Customize slides
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Engagement control Commenting, Suggest edit, Emoji Reply
    • Invite by email
      Invitee

      This note has no invitees

    • Publish Note

      Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

      Your note will be visible on your profile and discoverable by anyone.
      Your note is now live.
      This note is visible on your profile and discoverable online.
      Everyone on the web can find and read all notes of this public team.
      See published notes
      Unpublish note
      Please check the box to agree to the Community Guidelines.
      View profile
    • Commenting
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
      • Everyone
    • Suggest edit
      Permission
      Disabled Forbidden Owners Signed-in users Everyone
    • Enable
    • Permission
      • Forbidden
      • Owners
      • Signed-in users
    • Emoji Reply
    • Enable
    • Versions and GitHub Sync
    • Note settings
    • Note Insights
    • Engagement control
    • Transfer ownership
    • Delete this note
    • Save as template
    • Insert from template
    • Import from
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
    • Export to
      • Dropbox
      • Google Drive
      • Gist
    • Download
      • Markdown
      • HTML
      • Raw HTML
Menu Note settings Versions and GitHub Sync Note Insights Sharing URL Create Help
Create Create new note Create a note from template
Menu
Options
Engagement control Transfer ownership Delete this note
Import from
Dropbox Google Drive Gist Clipboard
Export to
Dropbox Google Drive Gist
Download
Markdown HTML Raw HTML
Back
Sharing URL Link copied
/edit
View mode
  • Edit mode
  • View mode
  • Book mode
  • Slide mode
Edit mode View mode Book mode Slide mode
Customize slides
Note Permission
Read
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Write
Only me
  • Only me
  • Signed-in users
  • Everyone
Only me Signed-in users Everyone
Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       owned this note    owned this note      
    Published Linked with GitHub
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    --- title: Add a Google Account as Safe Recovery Method using Lit description: Learn how to offer a recovery option for your users using Lit and AbstractinKit image: /img/posters/abstractionkit-meta.png keywords: [mpc,hosted-wallets,social-login, passkeys, biometrics] --- # Add a Google Account as Safe Recovery Method using Lit (Guide 1/2) This is the first of the two guides on how to add a google account as a recovery method for a Safe. In the second guide, we show the steps to execute the recovery. ## What is Lit Protocol? [Lit](https://litprotocol.com) is a decentralized network for signing and encryption. One of their usecases is to enable users to login using various authentication methods like Social Logins and Email OTP. To leverage the full potential of Account Abstraction, you can combine Lit with AbstractionKit to enable email / social recovery experience, while using a Smart Account as the smart wallet to sponsor gas for users, batch transactions, and more. ### Relevant links For additional information during this guide: - [How on-chain guardian recovery works](https://docs.candide.dev/wallet/plugins/recovery-with-guardians/) - [Guardian Recovery SDK Reference](https://docs.candide.dev/blog/making-accounts-recoverable/) - [Simple Recovery example on GitHub](https://github.com/candidelabs/abstractionkit/tree/experimental/examples/SafeAccountExamples/SocialRecovery) - [Lit Documentation Website](https://developer.litprotocol.com/) ## Installation ### Install required dependencies ```bash npm i abstractionkit@0.1.12 && @lit-protocol/lit-auth-client ``` ### Configure .env file Configure the values you created from Lit dashboard in an .env file ```ts // Lit LIT_API_KEY=Request Relay Server API Key from Lit at https://forms.gle/RNZYtGYTY9BcD9MEA // Candide BUNDLER_URL="Visit https://docs.candide.dev/wallet/bundler/rpc-endpoints/" PAYMASTER_URL="Request an API key from Candide on Discord" // Owner Public/Private Keys OWNER_PUBLIC_ADDRESS= OWNER_PRIVATE_KEY= // Network Info VITE_CHAIN_ID= JSON_RPC_NODE_PROVIDER="From Node provider" ``` ## Setup Guardian ### Initialize the Lit client and provider - Connect to the Lit Network using LitNodeClient. - Set up the LitAuthClient for authentication. - Initialize a GoogleProvider for Google sign-in. ```ts import { LitNodeClient } from "@lit-protocol/lit-node-client"; import { LitAuthClient, GoogleProvider } from "@lit-protocol/lit-auth-client"; import { ProviderType } from "@lit-protocol/constants"; const initalizeClientsAndProvider = async () => { const litNodeClient = new LitNodeClient({ litNetwork: "datil-dev", debug: true, }); await litNodeClient.connect(); const litAuthClient = new LitAuthClient({ litRelayConfig: { relayApiKey: "Anything", }, litNodeClient, }); console.log("Connected to Lit Node and Lit Auth Clients ✔️"); const provider = litAuthClient.initProvider<GoogleProvider>( ProviderType.Google, { //redirectUri: VITE_REDIRECT_URI, } ); return { litNodeClient, litAuthClient, provider }; }; ``` ### Authentication with Gmail - Generate Authentication Method - Check if the user is already authenticated. If not, redirect to Google sign-in ```ts import { AuthMethod } from "@lit-protocol/types"; const generateAuthMethod = async () => { const url = new URL(window.location.href); if (!url.searchParams.get("provider")) { console.log("Signing in with Google..."); provider.signIn((url) => { window.location.href = url; }); } else if (url.searchParams.get("provider") === "google") { const authMethod = await provider.authenticate(); return authMethod; } }; const authMethod = await generateAuthMethod(); if (!authMethod) { return; } ``` ### Mint PKP (Programmable Key Pair) ```ts import { LitAuthClient } from "@lit-protocol/lit-auth-client"; const mintWithGoogle = async (authMethod) => { const pkp = await litAuthClient.mintPKPWithAuthMethods([authMethod], { addPkpEthAddressAsPermittedAddress: true }); console.log("Fetched PKP", pkp); return pkp; }; const pkp = await mintWithGoogle(authMethod); console.log("Minted PKP ✔️"); ``` #### Setup the Email Guardian Signer ```ts import { PKPEthersWallet } from "@lit-protocol/pkp-ethers"; import { LitAbility, LitPKPResource } from "@lit-protocol/auth-helpers"; import { AuthCallbackParams } from "@lit-protocol/types"; const authNeededCallback = async (params: AuthCallbackParams) => { console.log(`auth needed callback params`, JSON.stringify(params, null, 2)); const response = await litNodeClient.signSessionKey({ statement: params.statement, authMethods: [authMethod], resourceAbilityRequests: [ { resource: new LitPKPResource("*"), ability: LitAbility.PKPSigning, }, ], expiration: params.expiration, resources: params.resources, chainId: 1, pkpPublicKey: pkp.pkpPublicKey, }); console.log("AUTHSIG", response); return response.authSig; }; const guardianSigner = new PKPEthersWallet({ litNodeClient, authContext: { getSessionSigsProps: { chain: "ethereum", expiration: new Date(Date.now() + 60_000 * 60).toISOString(), resourceAbilityRequests: [ { resource: new LitPKPResource("*"), ability: LitAbility.PKPSigning, }, ], authNeededCallback: authNeededCallback, }, }, pkpPubKey: pkp.pkpPublicKey, rpc: "https://yellowstone-rpc.litprotocol.com", }); console.log("Created PKPEthersWallet using the PKP ✔️"); ``` ## Add The Email Guardian to the Smart Account ### Initilize a Smart Account ```ts import { SafeAccountV0_2_0 as SafeAccount } from "abstractionkit"; const smartAccount = SafeAccount.initializeNewAccount([ownerPublicAddress]); console.log("Initialized Smart Account using ownerPublicAddress ✔️", smartAccount.accountAddress); ``` ### Enable The Recovery Module and Add the Guardian ```ts import { SocialRecoveryModule } from "abstractionkit"; const srm = new SocialRecoveryModule(); const enableModuleTx = srm.createEnableModuleMetaTransaction( smartAccount.accountAddress ); // Note that the Guardian added is also a Smart Account const guardianOwnerAddress = await guardianSigner.getAddress(); const guardianSmartAccount = SafeAccount.initializeNewAccount([guardianOwnerAddress]); const addGuardianTx = srm.createAddGuardianWithThresholdMetaTransaction( smartAccount.accountAddress, guardianSmartAccount.accountAddress, 1n ); ``` ### Sign and submit the UserOperation ```ts import { CandidePaymaster } from "abstractionkit"; let userOperation = await smartAccount.createUserOperation( [enableModuleTx, addGuardianTx], jsonRpcNodeProvider, process.env.BUNDLER_URL ); const paymasterUrl = process.env.PAYMASTER_URL; const paymaster = new CandidePaymaster(paymasterUrl); userOperation = await paymaster.createSponsorPaymasterUserOperation( userOperation, process.env.BUNDLER_URL ); userOperation.signature = smartAccount.signUserOperation( userOperation, [process.env.OWNER_PRIVATE_KEY], process.env.CHAIN_ID ); const sendUserOperationResponse = await smartAccount.sendUserOperation( userOperation, process.env.BUNDLER_URL ); console.log("User operation sent. Waiting to be included..."); const userOperationReceiptResult = await sendUserOperationResponse.included(); if (userOperationReceiptResult.success) { console.log( "Successful User operation. Transaction hash: " + userOperationReceiptResult.receipt.transactionHash ); const isGuardian = await srm.isGuardian( jsonRpcNodeProvider, smartAccount.accountAddress, guardianSmartAccount.accountAddress ); if (isGuardian) { console.log("Guardian added confirmed ✔️. Guardian address: " + guardianSmartAccount.accountAddress); } else { console.log("Adding guardian failed."); } } else { console.log("User operation execution failed"); } ``` --- That's it! You've successfully added a Guardian capable of recovering an account with an Email using Lit. If you're interested in learning more about how the recovery process works, you can explore further details in the [full repository](#), the [generic guide for recovery](#), and the [SDK documentation](#). These resources provide in-depth explanations and examples to help you understand the underlying concepts and implementation. ---

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully