Typescript issue when publishing library that takes a PublicClient as an argument, if we don't cast the chain argument as Chain

[oveddan]

In our library @zoralabs/protocol-sdk we publish some client creation methods that take a PublicClient as an argument.

When trying to integrate with this package externally, we get typescript errors when passing a PublicClient as an argument. Here is some example code:

import { createPublicClient, http } from 'viem'
import { zora } from "viem/chains";
import { create1155CreatorClient } from "@zoralabs/protocol-sdk";

const publicClient = createPublicClient({
  chain: zora,
  transport: http(),
});

const client = create1155CreatorClient({
  publicClient
});

This gives us typescript error: "The types returned by 'getBlock(...)' are incompatible between these types."

See this error in the typescript playground

However, if we append as Chain to the chain argument, the error goes away.

import { createPublicClient, http, Chain } from 'viem'
import { zora } from "viem/chains";
import { create1155CreatorClient } from "@zoralabs/protocol-sdk";

const publicClient = createPublicClient({
  chain: zora as Chain,
  transport: http(),
});

const client = create1155CreatorClient({
  publicClient
});

Is there a way types can be better defined without requiring us to use this as Chain argument?

[jxom]

Yes. You will need to properly hook up the generics in the library code. Here you go:

https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAbzgYygUwIYzQBQK4BGANsMgMIloB2MANHABYwxj1kMbBVuU30AqUDFQDOkWHAC+cAGZQIIOACIAbsDQglAbgBQocfCQAvaBimz5i1epAB6ZBy4jtOnQBM0yIhnSy8VZBhgCCoUdCw0AEZIgFYYsnCYaAp1GgAeB05QtAAPbCo3ETh2LIA+AAoEHTg4MEIScl46HUkALkRq2vrSFOoYdt70wWExaDoURypS3UkASnaVCGA3XR1kEJF4OuIeprgAXjDMbHwdxtSYSs7MrnaTIVpOmCFRA3amFnLZx7nV9dF4F4LgcjhFonEEsdkk0rjVtg1Bs1fjogA

[oveddan]

thanks that seemed to fix it!