README
¶
Examples
This directory contains example code for using the Turnkey Go SDK.
Each subdirectory contains a self-contained example with its own README and .env file for configuration. The examples demonstrate various authentication flows and features of the Turnkey platform.
Policies
Some examples require specific Turnkey policies to be configured on your organization before they will work. Refer to the Turnkey policy overview for details on how to create and manage policies.
Set up
[!NOTE] Please refer to the main README for getting started with setting up your Turnkey environment.
All examples are run from the repo root. For each example:
- Copy
.env.exampleto.envin the example's directory and fill in the values. - Run using
set -a && source examples/<example>/.env && set +a && go run ./examples/<example>
Refer to each example's README for the exact commands.
Available Examples
-
apikey: Demonstrates how to authenticate using an API key.
-
delegated_access: Shows how to set up delegated access for a sub-organization.
-
otp: Example of using one-time password (OTP) flows for authentication.
-
signing: Demonstrates how to sign messages and transactions using the SDK.
- sign_raw_payload: Example of signing a raw payload.
- sign_transaction: Example of signing a blockchain transaction.
-
wallets: Shows how to manage wallets and sign transactions with them.
- create_wallet: Example of creating a new wallet.
- create_wallet_accounts: Example of creating accounts within a wallet.
- export_wallet: Example of exporting a wallet's mnemonic phrase.
- export_wallet_account: Example of exporting a wallet account.
- import_wallet: Example of importing a wallet using a mnemonic phrase.
-
whoami: Example of using the
WhoAmIendpoint to retrieve the current user's ID.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main demonstrates the delegated access setup.
|
Package main demonstrates the delegated access setup. |
|
Package main demonstrates the OTP enclave authentication flow.
|
Package main demonstrates the OTP enclave authentication flow. |
|
signing
|
|
|
sign_raw_payload
command
|
|
|
sign_transaction
command
|
|
|
wallets
|
|
|
create_wallet
command
Package main demonstrates an API client which creates a new wallet with a wallet account.
|
Package main demonstrates an API client which creates a new wallet with a wallet account. |
|
create_wallet_accounts
command
Package main demonstrates an API client which creates new wallet accounts.
|
Package main demonstrates an API client which creates new wallet accounts. |
|
export_wallet
command
Package main demonstrates exporting a wallet mnemonic via the Turnkey enclave export flow.
|
Package main demonstrates exporting a wallet mnemonic via the Turnkey enclave export flow. |
|
export_wallet_account
command
Package main demonstrates exporting a wallet account's private key via the Turnkey enclave export flow.
|
Package main demonstrates exporting a wallet account's private key via the Turnkey enclave export flow. |
|
import_wallet
command
Package main demonstrates importing a wallet from a mnemonic phrase.
|
Package main demonstrates importing a wallet from a mnemonic phrase. |
|
Package main demonstrates an API client which returns the UserID of its API key.
|
Package main demonstrates an API client which returns the UserID of its API key. |