constructor() - Turnkey

Package: core

Defined in: clients/core.ts:180

Parameters

TurnkeySDKClientConfig

required

Show config details

config.apiBaseUrl

string

base URL for the Turnkey API.

config.authProxyConfigId

string

ID for the auth proxy configuration.

config.authProxyUrl

string

URL for the auth proxy.

config.defaultStamperType

StamperType

default stamper to be used for all requests

config.organizationId

string

required

ID of the organization.

config.passkeyConfig

TPasskeyStamperConfig

configuration for the passkey stamper.

Show passkeyConfig details

config.passkeyConfig.allowCredentials

PublicKeyCredentialDescriptor[]

list of credentials to pass. Defaults to empty.

config.passkeyConfig.extensions

Record<string, unknown>

optional extensions. Defaults to empty.

config.passkeyConfig.rpId

string

The RPID (“Relying Party ID”) for your app. This is automatically determined in web environments based on the current hostname. See https://github.com/f-23/react-native-passkey?tab=readme-ov-file#configuration to set this up for react-native.

config.passkeyConfig.rpName

string

name for the Relying Party (RP). This is used in the passkey creation flow on mobile.

config.passkeyConfig.timeout

number

timeout value in milliseconds. Defaults to 5 minutes.

config.passkeyConfig.userVerification

UserVerificationRequirement

override for UV flag. Defaults to “preferred”.

config.passkeyConfig.withPlatformKey

boolean

option to force platform passkeys on native platforms.

config.passkeyConfig.withSecurityKey

boolean

option to force security passkeys on native platforms.

config.walletConfig

TWalletManagerConfig

configuration for the wallet manager.

Show walletConfig details

config.walletConfig.chains

object

required

chains to support in the wallet manager.

Show chains details

config.walletConfig.chains.ethereum

object

Show ethereum details

config.walletConfig.chains.ethereum.native

boolean

config.walletConfig.chains.ethereum.walletConnectNamespaces

unknown[]

config.walletConfig.chains.solana

object

Show solana details

config.walletConfig.chains.solana.native

boolean

config.walletConfig.chains.solana.walletConnectNamespaces

unknown[]

config.walletConfig.features

object

features to enable in the wallet manager.

Show features details

config.walletConfig.features.auth

boolean

config.walletConfig.features.connecting

boolean

config.walletConfig.walletConnect

object

configuration for WalletConnect.

Show walletConnect details

config.walletConfig.walletConnect.appMetadata

object

required

Show appMetadata details

config.walletConfig.walletConnect.appMetadata.description

string

required

config.walletConfig.walletConnect.appMetadata.icons

string[]

required

config.walletConfig.walletConnect.appMetadata.name

string

required

config.walletConfig.walletConnect.appMetadata.url

string

required

config.walletConfig.walletConnect.projectId

string

required

CrossPlatformApiKeyStamper

CrossPlatformPasskeyStamper

WalletManagerBase

Response

A successful response returns the following fields:

TurnkeyClient

required

connectWalletAccount()createApiKeyPair()

⌘I