@thirdweb-dev/wallets
Version:
<p align="center"> <br /> <a href="https://thirdweb.com"><img src="https://github.com/thirdweb-dev/js/blob/main/legacy_packages/sdk/logo.svg?raw=true" width="200" alt=""/></a> <br /> </p> <h1 align="center">thirdweb Wallet SDK</h1> <p align="center"> <a h
438 lines (417 loc) • 12.7 kB
JavaScript
;
Object.defineProperty(exports, '__esModule', { value: true });
var defineProperty = require('../../../../dist/defineProperty-9051a5d3.cjs.dev.js');
var chains = require('@thirdweb-dev/chains');
var walletIds = require('../../../../dist/walletIds-a0be5020.cjs.dev.js');
var evm_wallets_base_dist_thirdwebDevWalletsEvmWalletsBase = require('../../../../dist/base-23fd36a9.cjs.dev.js');
var supportedSmsCountries = require('../../../../dist/supported-sms-countries-0545c8a6.cjs.dev.js');
require('../../abstract/dist/thirdweb-dev-wallets-evm-wallets-abstract.cjs.dev.js');
require('ethers');
require('eventemitter3');
require('@thirdweb-dev/sdk');
require('../../../../dist/headers-2be346e5.cjs.dev.js');
/**
* Wallet interface to connect [Embedded Wallet](https://portal.thirdweb.com/wallets/embedded-wallet/overview) which allows developers to implement seamless onboarding and login flows for their users.
*
* @example
* ```javascript
* import { EmbeddedWallet } from "@thirdweb-dev/wallets";
* import { Ethereum } from "@thirdweb-dev/chains";
*
* const wallet = new EmbeddedWallet({
* chain: Ethereum, // chain to connect to
* clientId: "YOUR_CLIENT_ID", // client ID
* });
*
* const authResult = await wallet.authenticate({
* strategy: "google",
* });
*
* const walletAddress = await wallet.connect({ authResult });
* console.log("Connected as", walletAddress);
* ```
* @wallet
*/
class EmbeddedWallet extends evm_wallets_base_dist_thirdwebDevWalletsEvmWalletsBase.AbstractClientWallet {
/**
* Sends a verification email to the provided email address.
*
* @param email - The email address to which the verification email will be sent.
* @param clientId - Your thirdweb client ID
* @returns Information on the user's status and whether they are a new user.
*
* @example
* ```typescript
* EmbeddedWallet.sendVerificationEmail({ email: 'test@example.com', clientId: 'yourClientId' })
* .then(() => console.log('Verification email sent successfully.'))
* .catch(error => console.error('Failed to send verification email:', error));
* ```
*/
static async sendVerificationEmail(options) {
const wallet = new EmbeddedWallet({
chain: chains.Ethereum,
clientId: options.clientId
});
return wallet.sendVerificationEmail({
email: options.email
});
}
/**
* Sends a verification sms to the provider phone number.
*
* @param phoneNumber - The phone number to which the verification sms will be sent. The phone number must contain the country code.
* @param clientId - Your thirdweb client ID
* @returns Information on the user's status and whether they are a new user.
*
* @example
* ```typescript
* const result = await EmbeddedWallet.sendVerificationEmail({
* phoneNumber: '+1234567890',
* clientId: 'yourClientId'
* });
* ```
*/
static async sendVerificationSms(options) {
const wallet = new EmbeddedWallet({
chain: chains.Ethereum,
clientId: options.clientId
});
return wallet.sendVerificationSms({
phoneNumber: options.phoneNumber
});
}
/**
* @internal
*/
get walletName() {
return "Embedded Wallet";
}
/**
* @internal
*/
/**
* The options for instantiating an `EmbeddedWallet`
*
* @param options -
* The options object contains the following properties:
*
* ### clientId (required)
* The chain to connect to by default.
*
* Must be a `Chain` object, from the [`@thirdweb-dev/chains`](https://www.npmjs.com/package/\@thirdweb-dev/chains) package.
*
* ### chain (required)
* The chain to connect to by default.
*
* Must be a `Chain` object, from the [`@thirdweb-dev/chains`](https://www.npmjs.com/package/\@thirdweb-dev/chains) package.
*
*
* ### chains (optional)
* Provide an array of chains you want to support.
*
* Must be an array of `Chain` objects, from the [`@thirdweb-dev/chains`](https://www.npmjs.com/package/\@thirdweb-dev/chains) package.
*/
constructor(options) {
super(EmbeddedWallet.id, {
...options
});
try {
this.chain = {
...options.chain,
rpc: chains.getValidChainRPCs(options.chain, options.clientId)
};
} catch {
this.chain = options.chain;
}
}
async getConnector() {
if (!this.connector) {
// import the connector dynamically
const {
EmbeddedWalletConnector
} = await Promise.resolve().then(function () { return require('../../../connectors/embedded-wallet/dist/thirdweb-dev-wallets-evm-connectors-embedded-wallet.cjs.dev.js'); });
this.connector = new EmbeddedWalletConnector({
clientId: this.options?.clientId ?? "",
chain: this.chain,
chains: this.chains,
onAuthSuccess: this.options?.onAuthSuccess
});
}
return this.connector;
}
/**
* auto connect the wallet if the wallet was previously connected and session is still valid
*/
autoConnect(connectOptions) {
if (!connectOptions) {
throw new Error("Can't autoconnect embedded wallet");
}
// override auto-connect logic for embedded wallet
// can just call connect since we should have the authResult persisted already
return this.connect(connectOptions);
}
/**
* @internal
*/
getConnectParams() {
const connectParams = super.getConnectParams();
if (!connectParams) {
return undefined;
}
// TODO (ews) omit non serializable/autoconnect-able
return {
chainId: connectParams.chainId,
authResult: {
user: connectParams.authResult.user
}
};
}
/**
* Get the email associated with the currently connected wallet.
* @example
* ```ts
* ```javascript
* const email = await wallet.getEmail();
* ```
*/
async getEmail() {
const connector = await this.getConnector();
return connector.getEmail();
}
/**
* Get the phone number associated with the currently connected wallet.
* @example
* ```ts
* ```javascript
* const email = await wallet.getPhoneNumber();
* ```
*/
async getPhoneNumber() {
const connector = await this.getConnector();
return connector.getPhoneNumber();
}
/**
* Get the instance of `EmbeddedWalletSdk` used by the wallet.
*/
async getEmbeddedWalletSDK() {
const connector = await this.getConnector();
return connector.getEmbeddedWalletSDK();
}
// TODO move to connect/auth callback
async getRecoveryInformation() {
const connector = await this.getConnector();
return connector.getRecoveryInformation();
}
/**
* Send a verification code to the user's email for verification.
* Use this as a prestep before calling `authenticate` with the `email_verification` strategy.
*
* ```javascript
* const result = await wallet.sendVerificationEmail({
* email: "alice@example.com",
* });
* ```
*
* This method is also available as a static method on the `EmbeddedWallet` class.
* ```javascript
* const result = await EmbeddedWallet.sendVerificationEmail({
* email: "alice@example.com",
* })
* ```
*
* @param options - The `options` object contains the following properties:
* ### email (required)
* The email address to send verification email to.
*
* @returns object containing below properties:
*
* ```ts
* {
* isNewDevice: boolean;
* isNewUser: boolean;
* recoveryShareManagement: "USER_MANAGED" | "AWS_MANAGED";
* }
* ```
*
* ### isNewDevice
* If user has not logged in from this device before, this will be true.
*
* ### isNewUser
* If user is logging in for the first time, this will be true.
*
* ### recoveryShareManagement
* Recovery share management type. Can be either `USER_MANAGED` or `AWS_MANAGED`.
*
*/
async sendVerificationEmail(options) {
const {
email
} = options;
const connector = await this.getConnector();
return connector.sendVerificationEmail({
email
});
}
/**
* Send a verification code to the user's phone number for verification. The phone number must contain the country code.
* Use this as a pre-step before calling `authenticate` with the `phone_number_verification` strategy.
*
* ```js
* const result = await wallet.sendVerificationSms({
* phoneNumber: "+1234567890",
* });
* ```
*
* This method is also available as a static method on the `EmbeddedWallet` class.
* ```javascript
* const result = await EmbeddedWallet.sendVerificationSms({
* phoneNumber: "+1234567890",
* });
* ```
*
* @param options - The `options` object contains the following properties:
* ### phoneNumber (required)
* The phone number to send verification SMS to. The phone number must contain the country code.
*
* @returns object containing below properties:
*
* ```ts
* {
* isNewDevice: boolean;
* isNewUser: boolean;
* recoveryShareManagement: "USER_MANAGED" | "AWS_MANAGED";
* }
* ```
*
* ### isNewDevice
* If user has not logged in from this device before, this will be true.
*
* ### isNewUser
* If user is logging in for the first time, this will be true.
*
* ### recoveryShareManagement
* Recovery share management type. Can be either `USER_MANAGED` or `AWS_MANAGED`.
*/
async sendVerificationSms(options) {
const {
phoneNumber
} = options;
const connector = await this.getConnector();
return connector.sendVerificationSms({
phoneNumber
});
}
/**
* Authenticate the user with any of the available auth strategies.
*
* @example
* ```javascript
* const authResult = await wallet.authenticate({
* strategy: "google",
* });
* ```
*
* @param params -
* Choose one of the available auth strategy, which comes with different required arguments.
* ```ts
* // email verification
* type EmailVerificationAuthParams = {
* strategy: "email_verification";
* email: string;
* verificationCode: string;
* recoveryCode?: string;
* };
*
* export type EmbeddedWalletOauthStrategy = "google" | "apple" | "facebook";
*
* type OauthAuthParams = {
* strategy: EmbeddedWalletOauthStrategy;
* openedWindow?: Window;
* closeOpenedWindow?: (window: Window) => void;
* };
*
* // bring your own authentication
* type JwtAuthParams = {
* strategy: "jwt";
* jwt: string;
* encryptionKey?: string;
* };
*
* // open iframe to send and input the verification code only
* type IframeOtpAuthParams = {
* strategy: "iframe_email_verification";
* email: string;
* };
*
* // open iframe to enter email and verification code
* type IframeAuthParams = {
* strategy: "iframe";
* };
* ```
*
* @returns
* The `authResult` object - which you can pass to the `connect` method to connect to the wallet.
*
* ```ts
* const authResult = await wallet.authenticate(authOptions);
* await wallet.connect({ authResult });
* ```
*/
async authenticate(params) {
const connector = await this.getConnector();
const authResult = connector.authenticate(params);
try {
await this.walletStorage.setItem(LAST_USED_AUTH_STRATEGY, params.strategy);
} catch {
// noop
}
return authResult;
}
/**
* @internal
*/
async getLastUsedAuthStrategy() {
try {
return await this.walletStorage.getItem(LAST_USED_AUTH_STRATEGY);
} catch {
return null;
}
}
/**
* After authenticating, you can connect to the wallet by passing the `authResult` to the `connect` method.
*
* ```ts
* const authResult = await wallet.authenticate(authOptions);
*
* await wallet.connect({ authResult });
* ```
*
* @param connectOptions - The `connectOptions` object contains the following properties:
*
* ### authResult (required)
*
* The `authResult` object is returned from the `authenticate` method.
*
* @returns The address of the connected wallet.
*/
connect(connectOptions) {
return super.connect(connectOptions);
}
}
/**
* @internal
*/
/**
* @internal
*/
defineProperty._defineProperty(EmbeddedWallet, "id", walletIds.walletIds.embeddedWallet);
/**
* @internal
*/
defineProperty._defineProperty(EmbeddedWallet, "meta", {
name: "Embedded Wallet",
iconURL: "ipfs://QmNx2evQa6tcQs9VTd3YaDm31ckfStvgRGKFGELahUmrbV/emailIcon.svg"
});
const LAST_USED_AUTH_STRATEGY = "lastUsedAuthStrategy";
exports.supportedSmsCountries = supportedSmsCountries.supportedSmsCountries;
exports.EmbeddedWallet = EmbeddedWallet;