RNSignerClient

params

{ connection: | { apiKey: string; jwt?: undefined; rpcUrl?: undefined; } | { apiKey?: undefined; jwt: string; rpcUrl?: undefined; } | { apiKey?: undefined; jwt?: undefined; rpcUrl: string; } | { apiKey?: undefined; jwt: string; rpcUrl: string; } & object; oauthCallbackUrl?: string; rootOrgId?: string; rpId?: string; }

params.connection

| { apiKey: string; jwt?: undefined; rpcUrl?: undefined; } | { apiKey?: undefined; jwt: string; rpcUrl?: undefined; } | { apiKey?: undefined; jwt?: undefined; rpcUrl: string; } | { apiKey?: undefined; jwt: string; rpcUrl: string; } & object

params.oauthCallbackUrl?

string

params.rootOrgId?

string

params.rpId?

string

addMfa

(params) => Promise<AddMfaResult>

Initiates the setup of a new MFA factor for the current user. Mfa will need to be verified before it is active.

Throws

If no user is authenticated

Throws

If an unsupported factor type is provided

addOauthProvider

(params) => Promise<OauthProviderInfo>

Adds an OAuth provider for the authenticated user using the provided parameters. Throws an error if the user is not authenticated.

Throws

Throws if the user is not authenticated.

addPasskey

(options) => Promise<string[]>

Handles the creation of authenticators using WebAuthn attestation and the provided options. Requires the user to be authenticated.

Throws

If the user is not authenticated

eventEmitter

EventEmitter<AlchemySignerClientEvents>

‐

experimental_addToMultiOwner

(orgId, members) => Promise<void>

This will add additional members to an existing multi-sig account

experimental_createApiKey

(params) => Promise<void>

Creates an API key that can take any action on behalf of the current user. (Note that this method is currently experimental and is subject to change.)

Throws

If there is no authenticated user or the API key creation fails.

experimental_createMultiOwner

(additionalMembers) => Promise<{ evmSignerAddress: `0x${string}`; members: object[]; orgId: string; }>

This will create a multi-owner account with the current user and additional specified signers

experimental_deleteFromMultiOwner

(orgId, members) => Promise<void>

This will remove members from an existing multi-sig account

experimental_multiOwnerSignRawMessage

(msg, orgId, orgAddress) => Promise<`0x${string}`>

This will sign on behalf of the multi-owner org, without doing any transformations on the message. For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass that result here.

getMfaFactors

() => Promise<{ multiFactors: MfaFactor[]; }>

Retrieves the list of MFA factors configured for the current user.

Throws

If no user is authenticated

getOauthNonce

(turnkeyPublicKey) => string

Turnkey requires the nonce in the id token to be in this format.

getOauthProviderUrl

(args) => Promise<string>

Returns the authentication url for the selected OAuth Proivder

Example

 
cosnt oauthParams = {
 authProviderId: "google",
 isCustomProvider: false,
 auth0Connection: undefined,
 scope: undefined,
 claims: undefined,
 mode: "redirect",
 redirectUrl: "https://your-url-path/oauth-return",
 expirationSeconds: 3000
};
 
const turnkeyPublicKey = await this.initIframeStamper();
const oauthCallbackUrl = this.oauthCallbackUrl;
const oauthConfig = this.getOauthConfig() // Optional value for OauthConfig()
const usesRelativeUrl = true // Optional value to determine if we use a relative (or absolute) url for the `redirect_url`
 
const oauthProviderUrl = getOauthProviderUrl({
 oauthParams,
 turnkeyPublicKey,
 oauthCallbackUrl
})
 

getPasskeyStatus

() => Promise<{ isPasskeyAdded: boolean; }>

Retrieves the status of the passkey for the current user. Requires the user to be authenticated.

Throws

If the user is not authenticated

getUser

() => null | User

Returns the current user or null if no user is set.

initOauth

() => Promise<OauthConfig>

Asynchronously fetches and sets the OAuth configuration.

initOtp

(type, contact) => Promise<{ otpId: string; }>

Initiates an OTP (One-Time Password) verification process for a user contact.

Throws

When no user is currently authenticated

listAuthMethods

() => Promise<AuthMethods>

Retrieves the list of authentication methods for the current user.

Throws

If the user is not authenticated

lookupUserByAccessKey

(params) => Promise<{ orgId: null | string; }>

Looks up information based on an access key.

lookupUserByEmail

(email) => Promise<{ orgId: null | string; }>

Looks up information based on an email address.

lookupUserByPhone

(phone) => Promise<{ orgId: null | string; }>

Looks up information based on a phone number.

lookupUserWithPasskey

(user?) => Promise<User>

Asynchronously handles the authentication process using WebAuthn Stamper. If a user is provided, sets the user and returns it. Otherwise, retrieves the current user and initializes the WebAuthn stamper.

oauthCallbackUrl

string

‐

oauthConfig

undefined | OauthConfig

‐

on

<E>(event, listener) => () => EventEmitter<AlchemySignerClientEvents, any>

Listen to events emitted by the client

pollActivityCompletion

<T>(activity, organizationId, resultKey) => Promise<NonNullable<object[T]>>

‐

removeEmail

() => Promise<void>

Removes the email for the authenticated user, disallowing them from login with that email.

Throws

If the user is not authenticated

removeMfa

(params) => Promise<{ multiFactors: MfaFactor[]; }>

Removes existing MFA factors by ID.

Throws

If no user is authenticated

removeOauthProvider

(providerId) => Promise<void>

Deletes a specified OAuth provider for the authenticated user.

Throws

If the user is not authenticated

removePasskey

(authenticatorId) => Promise<void>

Removes a passkey authenticator from the user's account.

Throws

If the user is not authenticated.

removePhoneNumber

() => Promise<void>

Removes the phone number for the authenticated user, disallowing them from login with that phone number.

Throws

If the user is not authenticated

request

<R>(route, body) => Promise<SignerResponse<R>>

Sends a POST request to the given signer route with the specified body and returns the response. Not intended to be used directly, use the specific methods instead on the client instead.

rootOrg

string

‐

rpId

undefined | string

‐

setPhoneNumber

(otp) => Promise<void>

Updates the phone number for the authenticated user, allowing them to login with that phone number. Must be called after calling initOtp with the phone number.

Throws

If the user is not authenticated

signRawMessage

(msg, mode?) => Promise<`0x${string}`>

This will sign a message with the user's private key, without doing any transformations on the message. For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass that result here.

stampGetOrganization

() => Promise<TSignedRequest>

Generates a stamped getOrganization request for the current user.

Throws

if no user is authenticated

stampWhoami

() => Promise<TSignedRequest>

Generates a stamped whoami request for the current user. This request can then be used to call /signer/v1/whoami to get the user information. This is useful if you want to get the user information in a different context like a server. You can pass the stamped request to the server and then call our API to get the user information. Using this stamp is the most trusted way to get the user information since a stamp can only belong to the user who created it.

Throws

if no organization ID is provided

turnkeyClient

TurnkeyClient

‐

validateMultiFactors

(params) => Promise<{ bundle: string; }>

Validates multiple MFA factors using the provided encrypted payload and MFA codes.

Throws

If no credential bundle is returned from the server

verifyMfa

(params) => Promise<{ multiFactors: MfaFactor[]; }>

Verifies a newly created MFA factor to complete the setup process.

Throws

If no user is authenticated

whoami

(orgId?, idToken?, accessToken?) => Promise<User>

Retrieves the current user or fetches the user information if not already available.

Throws

if no organization ID is provided when there is no current user

user

undefined | User

params

{ accessToken?: string; authenticatingType: "email" | "otp" | "sms" | "passkey" | "oauth" | "otpVerify" | "custom-jwt"; bundle: string; connectedEventName: keyof AlchemySignerClientEvents; idToken?: string; orgId: string; }

params.accessToken?

string

params.authenticatingType

"email" | "otp" | "sms" | "passkey" | "oauth" | "otpVerify" | "custom-jwt"

params.bundle

string

params.connectedEventName

keyof AlchemySignerClientEvents

params.idToken?

string

params.orgId

string

params

CreateAccountParams

The parameters for creating an account, including the type (email or passkey) and additional details.

params?

ExportWalletParams

exportWallet parameters

options?

CredentialCreationOptionOverrides

userDetails?

{ username: string; }

userDetails.username?

string

params

Omit<EmailAuthParams, "targetPublicKey">

params

Omit<SmsAuthParams, "targetPublicKey">

user

undefined | User

options?

CredentialCreationOptionOverrides

_args

any

args

any

email

string

The email to set for the user

otp

VerificationOtp

The OTP verification object including the OTP ID and OTP code

stamper

TStamper

the stamper function to set for the TurnkeyClient

args

Omit<JwtParams, "targetPublicKey">

args

Omit<OtpParams, "targetPublicKey">