Skip to content
Alchemy Logo

RNSignerClient

Defined in: account-kit/rn-signer/src/client.ts:67

new RNSignerClient(params): RNSignerClient;

Defined in: account-kit/rn-signer/src/client.ts:79

Parameters

ParameterType

params

Object

Returns

RNSignerClient

Overrides

BaseSignerClient<
  ExportWalletParams,
  string
>.constructor

PropertyType

oauthCallbackUrl

string

rpId

undefined | string

completeAuthWithBundle(params): Promise<User>;

Defined in: account-kit/rn-signer/src/client.ts:182

Parameters

ParameterType

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

Returns

Promise<User>

Overrides

BaseSignerClient.completeAuthWithBundle;

disconnect(): Promise<void>;

Defined in: account-kit/rn-signer/src/client.ts:296

Returns

Promise<void>

Overrides

BaseSignerClient.disconnect;

exportWallet(params?): Promise<string>;

Defined in: account-kit/rn-signer/src/client.ts:309

Exports the wallet and returns the decrypted private key or seed phrase.

Parameters

ParameterTypeDescription

params?

ExportWalletParams

exportWallet parameters

Returns

Promise<string>

The decrypted private key or seed phrase

Throws

If the user is not authenticated or export fails

Overrides

BaseSignerClient.exportWallet;

protected getOauthConfig(): Promise<OauthConfig>;

Defined in: account-kit/rn-signer/src/client.ts:464

Returns

Promise<OauthConfig>

Overrides

BaseSignerClient.getOauthConfig;

protected getWebAuthnAttestation(options?, userDetails?): Promise<GetWebAuthnAttestationResult & object>;

Defined in: account-kit/rn-signer/src/client.ts:433

Parameters

ParameterType

options?

CredentialCreationOptionOverrides

userDetails?

{ username: string; }

userDetails.username?

string

Returns

Promise<GetWebAuthnAttestationResult & object>

Overrides

BaseSignerClient.getWebAuthnAttestation;

initEmailAuth(params): Promise<{
  multiFactors?: MfaFactor[];
  orgId: string;
  otpId?: string;
}>;

Defined in: account-kit/rn-signer/src/client.ts:130

Parameters

ParameterType

params

Omit<EmailAuthParams, "targetPublicKey">

Returns

Promise<{ multiFactors?: MfaFactor[]; orgId: string; otpId?: string; }>

Overrides

BaseSignerClient.initEmailAuth;

protected initSessionStamper(): Promise<string>;

Defined in: account-kit/rn-signer/src/client.ts:476

Initializes the session stamper and returns its public key.

Returns

Promise<string>

Overrides

BaseSignerClient.initSessionStamper;

initSmsAuth(params): Promise<{
  orgId: string;
  otpId?: string;
}>;

Defined in: account-kit/rn-signer/src/client.ts:155

Parameters

ParameterType

params

Omit<SmsAuthParams, "targetPublicKey">

Returns

Promise<{ orgId: string; otpId?: string; }>

Overrides

BaseSignerClient.initSmsAuth;

protected initWebauthnStamper(user, options?): Promise<void>;

Defined in: account-kit/rn-signer/src/client.ts:495

Parameters

ParameterType

user

undefined | User

options?

CredentialCreationOptionOverrides

Returns

Promise<void>

Overrides

BaseSignerClient.initWebauthnStamper;

oauthWithPopup(_args): Promise<User>;

Defined in: account-kit/rn-signer/src/client.ts:290

Parameters

ParameterType

_args

any

Returns

Promise<User>

Overrides

BaseSignerClient.oauthWithPopup;

oauthWithRedirect(args): Promise<User | IdTokenOnly>;

Defined in: account-kit/rn-signer/src/client.ts:216

Parameters

ParameterType

args

any

Returns

Promise<User | IdTokenOnly>

Overrides

BaseSignerClient.oauthWithRedirect;

submitJwt(args): Promise<JwtResponse>;

Defined in: account-kit/rn-signer/src/client.ts:168

Parameters

ParameterType

args

Omit<JwtParams, "targetPublicKey">

Returns

Promise<JwtResponse>

Overrides

BaseSignerClient.submitJwt;

submitOtpCode(args): Promise<SubmitOtpCodeResponse>;

Defined in: account-kit/rn-signer/src/client.ts:93

Parameters

ParameterType

args

Omit<OtpParams, "targetPublicKey">

Returns

Promise<SubmitOtpCodeResponse>

Overrides

BaseSignerClient.submitOtpCode;

targetPublicKey(): Promise<string>;

Defined in: account-kit/rn-signer/src/client.ts:429

Returns

Promise<string>

Overrides

BaseSignerClient.targetPublicKey;
Was this page helpful?