add optional chain param to viem deploy

[johnpm-12]

see #782

[zoeyTM]

I actually don't think this is needed at all. We have access to the chain ID, either by querying the network or via the custom one configured in hardhat config. All we need to do is pass the existing chain ID into the viem functions as well. No need for a new parameter. @kanej

[alcuadrado]

Agreed with @zoeyTM.

Can you explain the motivation behind a new param? Is it because of a type-level limitation?

[johnpm-12]

I actually don't think this is needed at all. We have access to the chain ID, either by querying the network or via the custom one configured in hardhat config. All we need to do is pass the existing chain ID into the viem functions as well. No need for a new parameter. @kanej

I originally considered defining the custom chain inside the deploy function automatically if the chain id doesn't match a supported viem chain. But you have to make assumptions about native currency name, symbol, and decimals. They're required params when defining a viem chain.

https://viem.sh/docs/chains/introduction#custom-chains

EDIT: also I figured it should support functionality similar to the other viem hardhat functions (getPublicClient, getWalletClients, etc). They solve this problem with an optional chain parameter

[zoeyTM]

I actually don't think this is needed at all. We have access to the chain ID, either by querying the network or via the custom one configured in hardhat config. All we need to do is pass the existing chain ID into the viem functions as well. No need for a new parameter. @kanej

I originally considered defining the custom chain inside the deploy function automatically if the chain id doesn't match a supported viem chain. But you have to make assumptions about native currency name, symbol, and decimals. They're required params when defining a viem chain.

https://viem.sh/docs/chains/introduction#custom-chains

EDIT: also I figured it should support functionality similar to the other viem hardhat functions (getPublicClient, getWalletClients, etc). They solve this problem with an optional chain parameter

I think this functionality would be better served via extending hardhat config, adding the necessary fields to custom chains there, then pulling the info from hre.config inside the ignition helper.

[johnpm-12]

I actually don't think this is needed at all. We have access to the chain ID, either by querying the network or via the custom one configured in hardhat config. All we need to do is pass the existing chain ID into the viem functions as well. No need for a new parameter. @kanej

I originally considered defining the custom chain inside the deploy function automatically if the chain id doesn't match a supported viem chain. But you have to make assumptions about native currency name, symbol, and decimals. They're required params when defining a viem chain.
https://viem.sh/docs/chains/introduction#custom-chains
EDIT: also I figured it should support functionality similar to the other viem hardhat functions (getPublicClient, getWalletClients, etc). They solve this problem with an optional chain parameter

I think this functionality would be better served via extending hardhat config, adding the necessary fields to custom chains there, then pulling the info from hre.config inside the ignition helper.

And generate the custom chain internally if it's defined in the hardhat config?
What if a custom chain is not fully defined in the hardhat config? Throw an error?
I assume getpublicClient, getWalletClients, and the other hardhat viem functions would need to be updated to do this, too?

I can do it this way, I just want to make sure I understand how ya'll want it done before I get started

[kanej]

I am going to close this PR as we are porting Ignition to the Hardhat repo.

We are also reworking the entirety of hardhat.config.{js,ts} for Hardhat 3. I think after the update of Ignition to support Hardhat 3 is the time to tackle configuration options for custom chains in hardhat-plugin-viem.