PrivateKeyAccount is not assignable to type 'never'

[chrisco512]

Hey guys, maybe I'm doing something wrong, but been banging my head trying to get a very basic script together following the docs as closely as possible.

I've set up a private key in my .env file as PRIVATE_KEY. I'm importing that into my script.

I've got a local Arbitrum stack running on my machine which has both an L1 and and L2 at localhost:8545 and localhost:8547 respectively.

I'm able to read contracts just fine using viem, but I can't get my code to compile to make a writeContract or simulateContract call to work.

The following is my code:

// skipping imports here
const PRIVATE_KEY = process.env.PRIVATE_KEY;

const transportL1 = http(process.env.LOCAL_L1_RPC_URL);
const transportL2 = http(process.env.LOCAL_L2_RPC_URL);

const clientL1 = createPublicClient({
  name: 'L1',
  transport: transportL1,
  chain: localhost,
});

const clientL2 = createPublicClient({
  name: 'L2',
  transport: transportL2,
  chain: localhost,
});

const account = privateKeyToAccount(PRIVATE_KEY as Hex);

const walletClientL1 = createWalletClient({
  account,
  name: 'L1_Wallet',
  transport: transportL1,
  chain: localhost,
});

const walletClientL2 = createWalletClient({
  account,
  name: 'L2_Wallet',
  transport: transportL2,
  chain: localhost,
});

// SCRIPT
(async () => {
  const [l1BlockNumber, l2BlockNumber] = await Promise.all([
    await clientL1.getBlockNumber(),
    await clientL2.getBlockNumber(),
  ]);

  console.log(`l1BlockNumber: ${l1BlockNumber}`);
  console.log(`l2BlockNumber: ${l2BlockNumber}`);

  const [count] = await Promise.all([
    clientL1.readContract({
      ...counterContract,
      functionName: 'number',
      args: [],
    })
  ]);

  console.log(`Counter count: ${count}`);
  
  // This fails to compile
  // client1.simulateContract will also fail for the same reason
  await walletClientL1.writeContract({
    ...counterContract,
    functionName: 'increment',
    chain: localhost,
    account, // It will tell me 'PrivateKeyAccount is not assignable to 'never' here
  });
  
})();

As mentioned, the readContract call works fine. Just writes are giving me trouble. The private key is defined, and when logging out the account to the console, it looks like this:

{"address":"0x3f1Eae7D46d88F08fc2F8ed27FCb2AB183EB2d0E","source":"privateKey","type":"local","publicKey":"0x0426cc24348fbe0c2912fbb0aa4408e089bb0ae488a88ac46bb13290629a737646830322f4df4a83753ccf603688708109a75e57dd1a48938ff28edc69236b9744"}

[jxom]

If you have an account defined on the Client, you don't need to pass account to the Action, so you can remove that line.

[chrisco512]

Likewise for writeContract (vs simulateContract above):

TSError: ⨯ Unable to compile TypeScript:
script/viem/test.ts:70:38 - error TS2345: Argument of type '{ functionName: "increment"; address: "0xC2C0c3398915A2d2E9C33C186AbFEF3192Ee25E8"; abi: ({ inputs: any[]; name: string; outputs: { internalType: string; name: string; type: string; }[]; stateMutability: string; type: string; } | { ...; })[]; }' is not assignable to parameter of type 'WriteContractParameters<({ inputs: any[]; name: string; outputs: { internalType: string; name: string; type: string; }[]; stateMutability: string; type: string; } | { inputs: { internalType: string; name: string; type: string; }[]; name: string; outputs: any[]; stateMutability: string; type: string; })[], "increment...'.
  Property 'account' is missing in type '{ functionName: "increment"; address: "0xC2C0c3398915A2d2E9C33C186AbFEF3192Ee25E8"; abi: ({ inputs: any[]; name: string; outputs: { internalType: string; name: string; type: string; }[]; stateMutability: string; type: string; } | { ...; })[]; }' but required in type 'Omit<SendTransactionParameters<{ readonly id: 1337; readonly name: "Localhost"; readonly network: "localhost"; readonly nativeCurrency: { readonly decimals: 18; readonly name: "Ether"; readonly symbol: "ETH"; }; readonly rpcUrls: { ...; }; }, PrivateKeyAccount, Chain>, "chain" | ... 2 more ... | "value">'.

70   await walletClientL1.writeContract({
                                        ~
71     ...counterContract,
   ~~~~~~~~~~~~~~~~~~~~~~~
72     functionName: 'increment',
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
73   });
   ~~~

  node_modules/viem/dist/types/types/account.d.ts:6:5
    6     account: Account | Address;
          ~~~~~~~
    'account' is declared here.

    at createTSError (/Users/rai/.npm/_npx/1bf7c3c15bf47d04/node_modules/ts-node/src/index.ts:859:12)
    at reportTSError (/Users/rai/.npm/_npx/1bf7c3c15bf47d04/node_modules/ts-node/src/index.ts:863:19)
    at getOutput (/Users/rai/.npm/_npx/1bf7c3c15bf47d04/node_modules/ts-node/src/index.ts:1077:36)
    at Object.compile (/Users/rai/.npm/_npx/1bf7c3c15bf47d04/node_modules/ts-node/src/index.ts:1433:41)
    at Module.m._compile (/Users/rai/.npm/_npx/1bf7c3c15bf47d04/node_modules/ts-node/src/index.ts:1617:30)
    at Module._extensions..js (node:internal/modules/cjs/loader:1174:10)
    at Object.require.extensions.<computed> [as .ts] (/Users/rai/.npm/_npx/1bf7c3c15bf47d04/node_modules/ts-node/src/index.ts:1621:12)
    at Module.load (node:internal/modules/cjs/loader:998:32)
    at Function.Module._load (node:internal/modules/cjs/loader:839:12)
    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12) {
  diagnosticCodes: [ 2345 ]

[jxom]

Where is your counterContract coming from? Is it cast to as const?

const counterContract = {
  address: '0x...',
  abi: [...]
+ } as const

[chrisco512]

Yes:

import { abi } from '../../out/Counter.sol/Counter.json';

const address = '0xC2C0c3398915A2d2E9C33C186AbFEF3192Ee25E8';

export const counterContract = {
  address,
  abi,
} as const;

The contract works fine for the readContract call.

[chrisco512]

Note the code seems to work when I change the file to JS and strip out the types so this is some kind of type definition error.

[tmm]

This TypeScript Playground works fine.