Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FAQ update #192

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

FAQ update #192

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions docs/documentation/FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ slug: /faq

## Authentication and credentials

### What authentication methods does Turnkey provide?

Currently we provide: [email auth](/features/email-auth), [oauth](/features/oauth), [wallet auth](https://www.npmjs.com/package/@turnkey/wallet-stamper) (for Solana and EVM), [passkeys](/passkeys/introduction) and authentication via [API](/api-overview/introduction) keys. We’re on track to release SMS very soon.

### You said that you support Email Authentication but why don't I see it in my dashboard?

New Turnkey organizations are not enabled for email authentication by default, you will have to opt into the feature. To do so, check out the [guide](/features/email-auth#authorization) on how to do this - copy and paste the code snippet from the bottom of the doc into the SDK example’s README to get started.

### What is the OAuth latency?

We’ve observed that at times OAuth can take up to one second to complete. This is due to the fact that establishing and fetching TLS happens twice inside the secure enclave, directly contributing to the latency.

### Can I re-use my passkeys across different domains? Can I transfer passkeys between different rpIds?

- In short: No. Passkeys are domain bound, meaning the passkey you have setup for Turnkey.com (example) will not work for logging into your Turnkey Demo Wallet, these are two different domains.
- As a matter of security, passkeys being non-transferable ensures that they cannot be used in front-end and phishing attacks.
- However, you can use the same passkey type (e.g. YubiKey) across different domains, but this YubiKey will need to be registered as a second passkey on each domain.

### Can I sign up for Turnkey multiple times with the same email?

When you authenticate to the Turnkey dashboard, your email is used to lookup your organization and associated credentials. Currently we do not allow multiple users to be associated with the same email address.
Expand Down Expand Up @@ -121,6 +139,18 @@ We suggest you use blockchain-specific libraries, like Ethers.js for Ethereum, t

You can use any blockchain node provider, like Infura or Alchemy, to broadcast your transactions.

### What is the maximum expiration time for sessions? How long can we persist the users not needing to run email auth again?

Turnkey does not impose a maximum limit on session length. By default the configuration is set to 15 minutes (expressed as 900 seconds). The limits are specified by the client.

### Can I customize my email templates? What about the sender email domain?

Enterprise customers on our Scale plan and above are able to customize email templates. See the guide on how-to [here](/embedded-wallets/sub-organization-auth#email-customization). The ability to change the domain name of the email sender is in beta - reach out to support or (<[email protected]>) if you’re interested in enabling this new feature.

### Can I use Turnkey with Telegram mini apps (HTML5 running in Telegram's browser) to create embedded wallets?

Yes, more support and documentation is coming soon. Stay tuned!

### What does `HASH_FUNCTION_NO_OP` mean?

In the ECDSA context, messages are hashed before signing. Turnkey can perform this hashing for you, as we support two hash functions: `HASH_FUNCTION_KECCAK256` and `HASH_FUNCTION_SHA256` (for Ethereum and Bitcoin ecosystems respectively). If your message had already been hashed, you should use the `HASH_FUNCTION_NO_OP` option to sign the raw hash, in which case Turnkey will sign the payload as is. `HASH_FUNCTION_NO_OP` also has privacy implications: if a raw hashed message is passed in, Turnkey has no knowledge of the underlying pre-image.
Expand All @@ -135,6 +165,10 @@ An example for this case can be found in our [Solana signer](https://github.com/

## Guidance

### Where are the Turnkey servers hosted? Do you have plans to expand?

Today, Turnkey operates out of US-East-1. This is our primary, and only datacenter. While we don’t have plans to diversify the geographic distribution of our servers in the near future, long term we plan to maintain low latency across the globe.git

### Do you have a status page?

Yes, we report critical incidents at [turnkey-status.com](https://www.turnkey-status.com/).
Expand Down