Skip to main content

Using XRPL embed SDK

login​

Prompts the user to login if they are not logged in. If an OAuth verifier is not provided, a modal selector will be shown.

await torus.login(params);

Parameters

NameTypeDescriptionMandatory
loginProvider?LOGIN_PROVIDER_TYPEThe login provider to use. If not provided, a modal selector will be shown.No
login_hint?stringThe login hint (user's email address) to be passed for email_passwordless login.No

Returns

  • Promise<string[]> : Returns a promise which resolves to the XRPL addresses associated with the user.
Example
await torus.login();

logout​

In order to log out of the Torus XRPL Wallet, you must first have an active login session.

await torus.logout();

Returns

  • Promise<void> : This function returns a promise that resolves to void. It will reject if the user is not logged in.
Example
await torus.logout();

getUserInfo​

Returns the logged-in user's info including name, email, and imageUrl. Only works if the user is logged in.

const userInfo = await torus.getUserInfo();

Returns

  • Promise<UserInfo> : Returns a promise which resolves to UserInfo object.

Reference

export interface UserInfo {
  /**
   * Email of the logged in user
   */
  email: string;
  /**
   * Full name of the logged in user
   */
  name: string;
  /**
   * Profile image of the logged in user
   */
  profileImage: string;
  /**
   * verifier of the logged in user (google, facebook etc)
   */
  verifier: string;
  /**
   * Verifier Id of the logged in user
   *
   * email for google,
   * id for facebook,
   * username for reddit,
   * id for twitch,
   * id for discord
   */
  verifierId: string;
}
Example
const userInfo = await torus.getUserInfo();