Alchemy Logo

RNAlchemySigner

function RNAlchemySigner(params): RNAlchemySignerSingleton;

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

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

import { RNAlchemySigner } from "@account-kit/react-native-signer";
 
const signer = RNAlchemySigner({
  client: {
    connection: {
      apiKey: "YOUR_API_KEY",
    },
  },
  // optional config to override default session manager configs
  sessionConfig: {
    expirationTimeMs: 1000 * 60 * 60, // 60 minutes
  },
});

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

RNAlchemySignerSingleton

The singleton instance of RNAlchemySigner configured with the provided parameters.

Was this page helpful?