RNAlchemySigner

1function RNAlchemySigner(params): RNAlchemySignerSingleton;

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

Factory function to create or retrieve a singleton instance of RNAlchemySigner.

Example

import { 
function RNAlchemySigner(params: RNAlchemySignerParams): RNAlchemySignerSingleton

Factory function to create or retrieve a singleton instance of RNAlchemySigner.

RNAlchemySigner
} from "@account-kit/react-native-signer";
const
const signer: RNAlchemySignerSingleton
signer
=
function RNAlchemySigner(params: RNAlchemySignerParams): RNAlchemySignerSingleton

Factory function to create or retrieve a singleton instance of RNAlchemySigner.

RNAlchemySigner
({
client: { connection: ({ apiKey: string; rpcUrl?: undefined; jwt?: undefined; } | { jwt: string; rpcUrl?: undefined; apiKey?: undefined; } | { rpcUrl: string; apiKey?: undefined; jwt?: undefined; } | { rpcUrl: string; jwt: string; apiKey?: undefined; }) & { chainAgnosticUrl?: string | undefined; }; rootOrgId?: string | undefined; oauthCallbackUrl?: string | undefined; rpId?: string | undefined; } | RNSignerClient
client
: {
connection: ({ apiKey: string; rpcUrl?: undefined; jwt?: undefined; } | { jwt: string; rpcUrl?: undefined; apiKey?: undefined; } | { rpcUrl: string; apiKey?: undefined; jwt?: undefined; } | { rpcUrl: string; jwt: string; apiKey?: undefined; }) & { chainAgnosticUrl?: string | undefined; }
connection
: {
apiKey: string
apiKey
: "YOUR_API_KEY",
}, }, // optional config to override default session manager configs
sessionConfig?: { sessionKey?: string | undefined; expirationTimeMs?: number | undefined; } | undefined
sessionConfig
: {
expirationTimeMs?: number | undefined
expirationTimeMs
: 1000 * 60 * 60, // 60 minutes
}, });

Parameters

ParameterTypeDescription

params

{ client: | RNSignerClient | { 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; }; sessionConfig?: { expirationTimeMs?: number; sessionKey?: string; }; }

The parameters required to configure the RNAlchemySigner instance.

params.client

| RNSignerClient | { 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.sessionConfig?

{ expirationTimeMs?: number; sessionKey?: string; }

params.sessionConfig.expirationTimeMs?

number

params.sessionConfig.sessionKey?

string

Returns

RNAlchemySignerSingleton

The singleton instance of RNAlchemySigner configured with the provided parameters.