Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 7.38 KB

README.md

File metadata and controls

56 lines (41 loc) · 7.38 KB

Turnkey SDK

js-build

API Docs: https://docs.turnkey.com/

Packages

Package NPM Description Changelog
@turnkey/ethers npm Turnkey Signer for Ethers CHANGELOG
@turnkey/viem npm (Experimental) Turnkey Helpers to work with Viem CHANGELOG
@turnkey/cosmjs npm (Experimental) Turnkey Cosmos Signer for CosmJS CHANGELOG
@turnkey/http npm Lower-level, fully typed HTTP client for interacting with Turnkey API CHANGELOG
@turnkey/api-key-stamper npm Provide API key signatures over Turnkey requests CHANGELOG
@turnkey/webauthn-stamper npm Provide Webauthn signatures over Turnkey requests CHANGELOG

Code Examples

Example Description
with-ethers Create a new Ethereum address, then sign and broadcast a transaction using the Ethers signer with Infura
with-viem Sign and broadcast a transaction using the Turnkey Custom Account and Infura
with-cosmjs Create a new Cosmos address, then sign and broadcast a transaction on Celestia testnet using the CosmJS signer
with-solana Create a new Solana address, then sign and broadcast a transaction on Solana's devnet
with-gnosis Create new Ethereum addresses, configure a 3/3 Gnosis safe, and create + execute a transaction from it
with-uniswap Sign and broadcast a Uniswap v3 trade using the Ethers signer with Infura
with-nonce-manager Create a new Ethereum address, then sign and broadcast multiple transactions in a sequential or optimistic manner
with-offline Sign a Turnkey request in offline context
with-federated-passkeys A NextJS app that demonstrates how to use Turnkey to build a federated, webauthn powered authentication flow
with-ethers-and-passkeys A NextJS app that demonstrates how to use @turnkey/ethers to build a passkey-powered application
with-viem-and-passkeys A NextJS app that demonstrates how to use @turnkey/viem to build a passkey-powered application
demo-consumer-wallet A minimal consumer wallet app powered by Turnkey and WalletConnect
deployer Compile and deploy a smart contract
rebalancer A demo application which showcases an example of how to use Turnkey for managing multiple types of keys & users
sweeper Sweep funds from one address to a different address
trading-runner A sample application demonstrating a trading operation, using various private keys, users, and policies, powered by Uniswap

Demos built with Turnkey

Demo Consumer Wallet (code)

A minimal consumer wallet app powered by Turnkey. Behind the scenes, it uses @turnkey/ethers for signing and WalletConnect (v1) for accessing dapps.

with-uniswap.mp4

See https://github.com/tkhq/demo-consumer-wallet for the code.

Demo Passkey Wallet (code, live link)

A wallet application showing how users can register and authenticate using passkeys. This demo uses the Turnkey API to create a new Turnkey Sub-Organization for each user, create a testnet Ethereum address and send a transaction on Sepolia (ETH testnet).

homepage screenshot

See https://wallet.tx.xyz (and https://github.com/tkhq/demo-passkey-wallet for the code)