Class CapsuleWeb

constructor

• new CapsuleWeb(env, apiKey?, opts?): CapsuleWeb

• Constructs a new CoreCapsule instance.

  Parameters

  • env: Environment

    Environment to use.

  • Optional apiKey: string

    API key to use.

  • Optional opts: ConstructorOpts

    Additional constructor options; see ConstructorOpts.

  Returns CapsuleWeb

  • A new CoreCapsule instance.

ctx

Optional loginEncryptionKeyPair

Optional portalBackgroundColor

Optional portalPrimaryButtonColor

Optional portalTextColor

check2FAStatus

• check2FAStatus(): Promise<{
      isSetup: boolean;
  }>

• Determines if 2FA has been set up.

  Returns Promise<{
      isSetup: boolean;
  }>

  • true if 2FA is setup, false otherwise

checkIfUserExists

• checkIfUserExists(email): Promise<boolean>

• Checks if a user exists.

  Parameters

  • email: string

  Returns Promise<boolean>

  • true if user exists, false otherwise.

clearStorage

• clearStorage(): Promise<void>

• Remove all local storage and prefixed session storage.

  Returns Promise<void>

createUser

• createUser(email): Promise<void>

• Creates a new user.

  Parameters

  • email: string

    email to use for creating the user.

  Returns Promise<void>

createWallet

• createWallet(skipDistribute?, customFunction): Promise<[Wallet, string]>

• Creates a new wallet.

  Parameters

  • skipDistribute: boolean = false

    if true, recovery share will not be distributed.

  • customFunction: ((params?) => void)

    method called when createWallet is done.

    • • (params?): void

      • Parameters

        • Optional params: any

        Returns void

  Returns Promise<[Wallet, string]>

  [wallet, recoveryShare]

distributeNewWalletShare

• distributeNewWalletShare(walletId, userShare): Promise<string>

• Distributes a new wallet recovery share.

  Parameters

  • walletId: string

    the wallet to distribute the recovery share for.

  • userShare: string

    the user share generate the recovery share from.

  Returns Promise<string>

  • recovery share.

enable2FA

• enable2FA(verificationCode): Promise<void>

• Enables 2FA.

  Parameters

  • verificationCode: string

    verification code received via 2FA.

  Returns Promise<void>

exportSession

• exportSession(): string

• Returns string

fetchWallets

• fetchWallets(): Promise<any[]>

• Fetches the wallets associated with the user.

  Returns Promise<any[]>

  • wallets that were fetched.

getEmail

• getEmail(): string

• Gets the email associated with the CoreCapsule instance.

  Returns string

  • email associated with the CoreCapsule instance.

getPortalURL

• getPortalURL(partnerId?): Promise<string>

• URL of the portal, which can be associated with a partner id

  Parameters

  • Optional partnerId: string

    id of the partner to get the portal URL for

  Returns Promise<string>

  • portal URL

getSetUpBiometricsURL

• getSetUpBiometricsURL(isForNewDevice): Promise<string>

• Parameters

  • isForNewDevice: boolean

  Returns Promise<string>

getTransmissionKeyShares

• getTransmissionKeyShares(isForNewDevice?): Promise<any>

• Get transmission shares associated with session.

  Parameters

  • Optional isForNewDevice: boolean

    true if this device is registering.

  Returns Promise<any>

  • transmission keyshares.

getWallets

• getWallets(): Record<string, Wallet>

• Gets the wallets associated with the CoreCapsule instance.

  Returns Record<string, Wallet>

  • wallets associated with the CoreCapsule instance.

getWebAuthURLForLogin

• getWebAuthURLForLogin(sessionId, loginEncryptionPublicKey, partnerId?, newDeviceSessionId?, newDeviceEncryptionKey?): Promise<string>

• Generates a URL that can be used to perform web auth for creating a new credential.

  Parameters

  • sessionId: string

    id of the session to use for web auth

  • loginEncryptionPublicKey: string

    public key to use for encrypting the login encryption key

  • Optional partnerId: string

    id of the partner to get the portal URL for

  • Optional newDeviceSessionId: string

    id of the session to use for web auth for a new device

  • Optional newDeviceEncryptionKey: string

    public key to use for encrypting the login encryption key for a new device

  Returns Promise<string>

  • web auth url

importSession

• importSession(serializedInstanceBase64): Promise<void>

• Parameters

  • serializedInstanceBase64: string

  Returns Promise<void>

init

• init(): Promise<void>

• Initialize storage relating to a CoreCapsule instance.

  Init only needs to be called for storage that is async.

  Returns Promise<void>

initiateUserLogin

• initiateUserLogin(email, useShortURL?): Promise<string>

• Initiates a login.

  Parameters

  • email: string

    the email to login with

  • Optional useShortURL: boolean

    whether to shorten the link

  Returns Promise<string>

  • web auth url for logging in

isFullyLoggedIn

• isFullyLoggedIn(): Promise<boolean>

• Checks if a session is active and a wallet exists.

  Returns Promise<boolean>

  • true if session is active and a wallet exists.

isProviderModalDisabled

• isProviderModalDisabled(): boolean

• Returns boolean

isSessionActive

• isSessionActive(): Promise<boolean>

• Returns Promise<boolean>

logout

• logout(): Promise<void>

• Logs the user out.

  Returns Promise<void>

refreshSession

• refreshSession(shouldOpenPopup): Promise<string>

• Updates the session with the user management server, possibly opening a popup to refresh the session.

  Parameters

  • shouldOpenPopup: boolean

    true if you want to open the popup automatically

  Returns Promise<string>

  • web auth url for refreshing session

resendVerificationCode

• resendVerificationCode(): Promise<void>

• Returns Promise<void>

sendTransaction

• sendTransaction(walletId, rlpEncodedTxBase64, chainId): Promise<FullSignatureRes>

• Sends a transaction.

  Parameters

  • walletId: string

    id of the wallet to send the transaction from.

  • rlpEncodedTxBase64: string

    rlp encoded tx as base64 string

  • chainId: string

    chain id of the chain the transaction is being sent on.

  Returns Promise<FullSignatureRes>

setEmail

• setEmail(email): Promise<void>

• Sets the email associated with the CoreCapsule instance.

  Parameters

  • email: string

    Email to set.

  Returns Promise<void>

setLoginEncryptionKeyPair

• setLoginEncryptionKeyPair(keyPair): Promise<void>

• Sets the login encryption key pair associated with the CoreCapsule instance.

  Parameters

  • keyPair: KeyPair

    Encryption key pair generated from loginEncryptionKey.

  Returns Promise<void>

setUserId

• setUserId(userId): Promise<void>

• Sets the user id associated with the CoreCapsule instance.

  Parameters

  • userId: string

    User id to set.

  Returns Promise<void>

setWallets

• setWallets(wallets): Promise<void>

• Sets the wallets associated with the CoreCapsule instance.

  Parameters

  • wallets: Record<string, Wallet>

    Wallets to set.

  Returns Promise<void>

setup2FA

• setup2FA(): Promise<{
      uri?: string;
  }>

• Sets up 2FA.

  Returns Promise<{
      uri?: string;
  }>

  uri - uri to use for setting up 2FA

setupAfterLogin

• setupAfterLogin(temporaryShares?): Promise<void>

• Call this method after login to perform setup.

  Parameters

  • Optional temporaryShares: any[]

    optional temporary shares to use for decryption.

  Returns Promise<void>

shortenLoginLink

• shortenLoginLink(link): Promise<string>

• Parameters

  • link: string

  Returns Promise<string>

signMessage

• signMessage(walletId, messageBase64): Promise<FullSignatureRes>

• Signs a message.

  If you want to sign the keccak256 hash of a message, hash the message first and then pass in the base64 encoded hash.

  Parameters

  • walletId: string

    id of the wallet to sign with.

  • messageBase64: string

    base64 encoding of exact message that should be signed

  Returns Promise<FullSignatureRes>

signTransaction

• signTransaction(walletId, rlpEncodedTxBase64, chainId): Promise<FullSignatureRes>

• Signs a transaction.

  Parameters

  • walletId: string

    id of the wallet to sign the transaction from.

  • rlpEncodedTxBase64: string

    rlp encoded tx as base64 string

  • chainId: string

    chain id of the chain the transaction is being sent on.

  Returns Promise<FullSignatureRes>

toString

• toString(): string

• Converts to a string, removing sensitive data when logging this class.

  Doesn't work for all types of logging.

  Returns string

userSetupAfterLogin

• userSetupAfterLogin(): Promise<void>

• Call this method after login to ensure that the user ID is set internally.

  Returns Promise<void>

verify2FA

• verify2FA(email, verificationCode): Promise<{
      address?: string;
      initiatedAt?: Date;
      status?: RecoveryStatus;
      userId: string;
      walletId: string;
  }>

• Performs 2FA verification.

  Parameters

  • email: string

    email to use for performing a 2FA verification.

  • verificationCode: string

    verification code to received via 2FA.

  Returns Promise<{
      address?: string;
      initiatedAt?: Date;
      status?: RecoveryStatus;
      userId: string;
      walletId: string;
  }>

verifyEmail

• verifyEmail(verificationCode): Promise<string>

• Passes the email code obtained from the user for verification.

  Parameters

  • verificationCode: string

  Returns Promise<string>

  • web auth url for creating a new credential

waitForAccountCreation

• waitForAccountCreation(): Promise<void>

• Waits for the session to be active.

  Returns Promise<void>

waitForLoginAndSetup

• waitForLoginAndSetup(): Promise<{
      needsWallet: boolean;
  }>

• Waits for the session to be active and sets up the user.

  Returns Promise<{
      needsWallet: boolean;
  }>

  • whether a wallet needs to be created