@turnkey/viem

This package contains helpers to use Viem with Turnkey.

We provide a Turnkey Custom Account (signer) which implements the signing APIs expected by Viem clients.

If you need a lower-level, fully typed HTTP client for interacting with Turnkey API, check out @turnkey/http.

Getting started

1$ npm install viem @turnkey/viem

1import { createAccount } from "@turnkey/viem";
2import { TurnkeyClient } from "@turnkey/http";
3import { ApiKeyStamper } from "@turnkey/api-key-stamper";
4import { createWalletClient, http } from "viem";
5import { sepolia } from "viem/chains";
6
7async function main() {
8  // Create a Turnkey HTTP client with API key credentials
9  const httpClient = new TurnkeyClient(
10    {
11      baseUrl: "https://api.turnkey.com",
12    },
13    // This uses API key credentials.
14    // If you're using passkeys, use `@turnkey/webauthn-stamper` to collect webauthn signatures:
15    // new WebauthnStamper({...options...})
16    new ApiKeyStamper({
17      apiPublicKey: "...",
18      apiPrivateKey: "...",
19    }),
20  );
21
22  // Create the Viem custom account
23  const turnkeyAccount = await createAccount({
24    client: httpClient,
25    organizationId: "...",
26    signWith: "...",
27    // optional; will be fetched from Turnkey if not provided
28    ethereumAddress: "...",
29  });
30
31  // Below: standard Viem APIs are used, nothing special!
32
33  const client = createWalletClient({
34    account: turnkeyAccount,
35    chain: sepolia,
36    transport: http(`https://sepolia.infura.io/v3/$(YOUR_INFURA_API_KEY)`),
37  });
38
39  const transactionRequest = {
40    to: "0x08d2b0a37F869FF76BACB5Bab3278E26ab7067B7" as `0x${string}`,
41    value: 1000000000000000n, // 0.001 ETH
42  };
43
44  const txHash = await client.sendTransaction(transactionRequest);
45  console.log(`Success! Transaction broadcast with hash ${txHash}`);
46}
47
48main().catch((error) => {
49  console.error(error);
50  process.exit(1);
51});

Testing (Local)

1. Copy .env.example to .env

   1$ cp .env.example .env

2. Start the Anvil node in one shell:

   • Install Foundry & Anvil if you haven't done so already
   • Add Foundry to your $PATH

     1$ export PATH="$PATH:$HOME/.foundry/bin"

   • Source your env e.g.

     1$ source ~/.zshrc

   • Run foundryup to install Anvil

     1$ foundryup

   • Start Anvil

     $ pnpm anvil
     

3. Run the tests in a new shell:

   $ pnpm test
   

See also

• @turnkey/example-with-viem: example using this package to create, sign, and broadcast a transaction on Sepolia (Ethereum testnet)
• @turnkey/http: lower-level fully typed HTTP client for interacting with Turnkey API
• @turnkey/api-key-stamper: package to authenticate to Turnkey using API key credentials
• @turnkey/webauthn-stamper: package to authenticate to Turnkey using Webauthn/passkeys.

Transaction types supported

• Turnkey's Viem implementation now supports all transaction types: legacy, EIP-2930 (Type 1), EIP-1559 (Type 2), EIP-4844 (Type 3), and EIP-7702 (Type 4). See with-viem for examples of scripts that sign using those various types.