viem/wagmi: rename supERC20 actions and hooks to superchainERC20 (#621)

* supERC20 -> SuperchainERC20

* changeset

* lint

* optimism submodule was missed

.changeset/khaki-mirrors-learn.md

@@ -0,0 +1,6 @@
+---
+"@eth-optimism/wagmi": minor
+"@eth-optimism/viem": minor
+---
+
+rename SupERC20 to SuperchainERC20

packages/viem/docs/README.md

@@ -6,19 +6,19 @@
 
 ## ABI
 
-- [crossL2InboxABI](variables/crossL2InboxABI.md)
-- [l2ToL2CrossDomainMessengerABI](variables/l2ToL2CrossDomainMessengerABI.md)
-- [superchainERC20ABI](variables/superchainERC20ABI.md)
-- [superchainTokenBridgeABI](variables/superchainTokenBridgeABI.md)
-- [superchainWETHABI](variables/superchainWETHABI.md)
+- [crossL2InboxAbi](variables/crossL2InboxAbi.md)
+- [l2ToL2CrossDomainMessengerAbi](variables/l2ToL2CrossDomainMessengerAbi.md)
+- [superchainERC20Abi](variables/superchainERC20Abi.md)
+- [superchainTokenBridgeAbi](variables/superchainTokenBridgeAbi.md)
+- [superchainWETHAbi](variables/superchainWETHAbi.md)
 
 ## L2 Public Actions
 
 - [simulateCrossChainSendETH](functions/simulateCrossChainSendETH.md)
 - [simulateDepositSuperchainWETH](functions/simulateDepositSuperchainWETH.md)
 - [simulateRelayL2ToL2Message](functions/simulateRelayL2ToL2Message.md)
 - [simulateSendL2ToL2Message](functions/simulateSendL2ToL2Message.md)
-- [simulateSendSupERC20](functions/simulateSendSupERC20.md)
+- [simulateSendSuperchainERC20](functions/simulateSendSuperchainERC20.md)
 - [simulateSendSuperchainWETH](functions/simulateSendSuperchainWETH.md)
 - [simulateWithdrawSuperchainWETH](functions/simulateWithdrawSuperchainWETH.md)
 
@@ -30,12 +30,12 @@
 - [estimateDepositSuperchainWETHGas](functions/estimateDepositSuperchainWETHGas.md)
 - [estimateRelayL2ToL2MessageGas](functions/estimateRelayL2ToL2MessageGas.md)
 - [estimateSendL2ToL2MessageGas](functions/estimateSendL2ToL2MessageGas.md)
-- [estimateSendSupERC20Gas](functions/estimateSendSupERC20Gas.md)
+- [estimateSendSuperchainERC20Gas](functions/estimateSendSuperchainERC20Gas.md)
 - [estimateSendSuperchainWETHGas](functions/estimateSendSuperchainWETHGas.md)
 - [estimateWithdrawSuperchainWETHGas](functions/estimateWithdrawSuperchainWETHGas.md)
 - [relayL2ToL2Message](functions/relayL2ToL2Message.md)
 - [sendL2ToL2Message](functions/sendL2ToL2Message.md)
-- [sendSupERC20](functions/sendSupERC20.md)
+- [sendSuperchainERC20](functions/sendSuperchainERC20.md)
 - [sendSuperchainWETH](functions/sendSuperchainWETH.md)
 - [withdrawSuperchainWETH](functions/withdrawSuperchainWETH.md)
 
@@ -56,12 +56,6 @@
 
 - [contracts](variables/contracts.md)
 
-## Supersim
-
-- [supersimL1](variables/supersimL1.md)
-- [supersimL2A](variables/supersimL2A.md)
-- [supersimL2B](variables/supersimL2B.md)
-
 ## Types
 
 - [CrossChainSendETHContractReturnType](type-aliases/CrossChainSendETHContractReturnType.md)
@@ -80,10 +74,10 @@
 - [SendL2ToL2MessageErrorType](type-aliases/SendL2ToL2MessageErrorType.md)
 - [SendL2ToL2MessageParameters](type-aliases/SendL2ToL2MessageParameters.md)
 - [SendL2ToL2MessageReturnType](type-aliases/SendL2ToL2MessageReturnType.md)
-- [SendSupERC20ContractReturnType](type-aliases/SendSupERC20ContractReturnType.md)
-- [SendSupERC20ErrorType](type-aliases/SendSupERC20ErrorType.md)
-- [SendSupERC20Parameters](type-aliases/SendSupERC20Parameters.md)
-- [SendSupERC20ReturnType](type-aliases/SendSupERC20ReturnType.md)
+- [SendSuperchainERC20ContractReturnType](type-aliases/SendSuperchainERC20ContractReturnType.md)
+- [SendSuperchainERC20ErrorType](type-aliases/SendSuperchainERC20ErrorType.md)
+- [SendSuperchainERC20Parameters](type-aliases/SendSuperchainERC20Parameters.md)
+- [SendSuperchainERC20ReturnType](type-aliases/SendSuperchainERC20ReturnType.md)
 - [SendSuperchainWETHParameters](type-aliases/SendSuperchainWETHParameters.md)
 - [WithdrawSuperchainWETHContractReturnType](type-aliases/WithdrawSuperchainWETHContractReturnType.md)
 - [WithdrawSuperchainWETHErrorType](type-aliases/WithdrawSuperchainWETHErrorType.md)

packages/viem/docs/functions/createInteropMessage.md

@@ -1375,4 +1375,4 @@ created interop message Message
 
 ## Defined in
 
-[packages/viem/src/utils/interop.ts:32](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/interop.ts#L32)
+[packages/viem/src/utils/interop.ts:32](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/utils/interop.ts#L32)

packages/viem/docs/functions/createInteropSentL2ToL2Messages.md

@@ -1375,4 +1375,4 @@ Decoded interop messages [CreateInteropSentL2ToL2MessagesReturnType](../type-ali
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:60](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L60)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:60](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L60)

packages/viem/docs/functions/crossChainSendETH.md

@@ -36,4 +36,4 @@ The crosschainSendETH transaction hash. [CrossChainSendETHContractReturnType](..
 
 ## Defined in
 
-[packages/viem/src/actions/crosschainSendETH.ts:67](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/crosschainSendETH.ts#L67)
+[packages/viem/src/actions/crosschainSendETH.ts:67](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/crosschainSendETH.ts#L67)

packages/viem/docs/functions/decodeExecutingMessages.md

@@ -24,4 +24,4 @@ Decoded cross-chain calls [DecodeExecutingMessagesReturnType](../type-aliases/De
 
 ## Defined in
 
-[packages/viem/src/utils/interop.ts:66](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/interop.ts#L66)
+[packages/viem/src/utils/interop.ts:66](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/utils/interop.ts#L66)

packages/viem/docs/functions/decodeRelayedL2ToL2Messages.md

@@ -24,4 +24,4 @@ Identified relayed messages [DecodeRelayedL2ToL2MessagesReturnType](../type-alia
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L106)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L106)

packages/viem/docs/functions/decodeSentL2ToL2Messages.md

@@ -24,4 +24,4 @@ Decoded cross-chain calls [DecodeSentL2ToL2MessagesReturnType](../type-aliases/D
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:85](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L85)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:85](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L85)

packages/viem/docs/functions/depositSuperchainWETH.md

@@ -36,4 +36,4 @@ The depositSuperchainWETH transaction hash. [DepositSuperchainWETHReturnType](..
 
 ## Defined in
 
-[packages/viem/src/actions/depositSuperchainWETH.ts:64](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L64)
+[packages/viem/src/actions/depositSuperchainWETH.ts:64](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/depositSuperchainWETH.ts#L64)

packages/viem/docs/functions/estimateCrossChainSendETHGas.md

@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/crosschainSendETH.ts:96](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/crosschainSendETH.ts#L96)
+[packages/viem/src/actions/crosschainSendETH.ts:96](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/crosschainSendETH.ts#L96)

packages/viem/docs/functions/estimateDepositSuperchainWETHGas.md

@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/depositSuperchainWETH.ts:91](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L91)
+[packages/viem/src/actions/depositSuperchainWETH.ts:91](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/depositSuperchainWETH.ts#L91)

packages/viem/docs/functions/estimateRelayL2ToL2MessageGas.md

@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/relayL2ToL2Message.ts:103](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L103)
+[packages/viem/src/actions/relayL2ToL2Message.ts:103](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L103)

packages/viem/docs/functions/estimateSendL2ToL2MessageGas.md

@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/sendL2ToL2Message.ts:105](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L105)
+[packages/viem/src/actions/sendL2ToL2Message.ts:105](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L105)

packages/viem/docs/functions/estimateSendSuperchainERC20Gas.md

@@ -0,0 +1,39 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / estimateSendSuperchainERC20Gas
+
+# estimateSendSuperchainERC20Gas()
+
+> **estimateSendSuperchainERC20Gas**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<`bigint`\>
+
+Estimates gas for [sendSuperchainERC20](sendSuperchainERC20.md)
+
+## Type Parameters
+
+• **TChain** *extends* `undefined` \| `Chain`
+
+• **TAccount** *extends* `undefined` \| `Account`
+
+• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined`
+
+## Parameters
+
+• **client**: `Client`\<`Transport`, `TChain`, `TAccount`\>
+
+L2 Wallet Client
+
+• **parameters**: [`SendSuperchainERC20Parameters`](../type-aliases/SendSuperchainERC20Parameters.md)\<`TChain`, `TAccount`, `TChainOverride`, `DeriveChain`\<`TChain`, `TChainOverride`\>\>
+
+[SendSuperchainERC20Parameters](../type-aliases/SendSuperchainERC20Parameters.md)
+
+## Returns
+
+`Promise`\<`bigint`\>
+
+The estimated gas value.
+
+## Defined in
+
+[packages/viem/src/actions/sendSuperchainERC20.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L106)

packages/viem/docs/functions/estimateSendSuperchainWETHGas.md

@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/sendSuperchainWETH.ts:74](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSuperchainWETH.ts#L74)
+[packages/viem/src/actions/sendSuperchainWETH.ts:74](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainWETH.ts#L74)

packages/viem/docs/functions/estimateWithdrawSuperchainWETHGas.md

@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/withdrawSuperchainWETH.ts:96](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L96)
+[packages/viem/src/actions/withdrawSuperchainWETH.ts:96](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L96)

packages/viem/docs/functions/relayL2ToL2Message.md

@@ -36,4 +36,4 @@ The relayMessage transaction hash. [RelayL2ToL2MessageReturnType](../type-aliase
 
 ## Defined in
 
-[packages/viem/src/actions/relayL2ToL2Message.ts:74](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L74)
+[packages/viem/src/actions/relayL2ToL2Message.ts:74](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L74)

packages/viem/docs/functions/sendL2ToL2Message.md

@@ -36,4 +36,4 @@ The sendL2ToL2Message transaction hash. [SendL2ToL2MessageReturnType](../type-al
 
 ## Defined in
 
-[packages/viem/src/actions/sendL2ToL2Message.ts:76](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L76)
+[packages/viem/src/actions/sendL2ToL2Message.ts:76](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L76)

packages/viem/docs/functions/sendSuperchainERC20.md

@@ -0,0 +1,39 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / sendSuperchainERC20
+
+# sendSuperchainERC20()
+
+> **sendSuperchainERC20**\<`chain`, `account`, `chainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSuperchainERC20ReturnType`](../type-aliases/SendSuperchainERC20ReturnType.md)\>
+
+Sends tokens to a target address on another chain. Used in the interop flow.
+
+## Type Parameters
+
+• **chain** *extends* `undefined` \| `Chain`
+
+• **account** *extends* `undefined` \| `Account`
+
+• **chainOverride** *extends* `undefined` \| `Chain` = `undefined`
+
+## Parameters
+
+• **client**: `Client`\<`Transport`, `chain`, `account`\>
+
+L2 Wallet Client
+
+• **parameters**: [`SendSuperchainERC20Parameters`](../type-aliases/SendSuperchainERC20Parameters.md)\<`chain`, `account`, `chainOverride`, `DeriveChain`\<`chain`, `chainOverride`\>\>
+
+[SendSuperchainERC20Parameters](../type-aliases/SendSuperchainERC20Parameters.md)
+
+## Returns
+
+`Promise`\<[`SendSuperchainERC20ReturnType`](../type-aliases/SendSuperchainERC20ReturnType.md)\>
+
+The sendSuperchainERC20 transaction hash. [SendSuperchainERC20ReturnType](../type-aliases/SendSuperchainERC20ReturnType.md)
+
+## Defined in
+
+[packages/viem/src/actions/sendSuperchainERC20.ts:77](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L77)

packages/viem/docs/functions/sendSuperchainWETH.md

@@ -6,7 +6,7 @@
 
 # sendSuperchainWETH()
 
-> **sendSuperchainWETH**\<`chain`, `account`, `chainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSupERC20ReturnType`](../type-aliases/SendSupERC20ReturnType.md)\>
+> **sendSuperchainWETH**\<`chain`, `account`, `chainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSuperchainERC20ReturnType`](../type-aliases/SendSuperchainERC20ReturnType.md)\>
 
 Sends SuperchainWETH to a target address on another chain. Used in the interop flow.
 
@@ -30,10 +30,10 @@ L2 Wallet Client
 
 ## Returns
 
-`Promise`\<[`SendSupERC20ReturnType`](../type-aliases/SendSupERC20ReturnType.md)\>
+`Promise`\<[`SendSuperchainERC20ReturnType`](../type-aliases/SendSuperchainERC20ReturnType.md)\>
 
-The sendSuperchainWETH transaction hash. [SendSupERC20ReturnType](../type-aliases/SendSupERC20ReturnType.md)
+The sendSuperchainWETH transaction hash. [SendSuperchainERC20ReturnType](../type-aliases/SendSuperchainERC20ReturnType.md)
 
 ## Defined in
 
-[packages/viem/src/actions/sendSuperchainWETH.ts:53](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSuperchainWETH.ts#L53)
+[packages/viem/src/actions/sendSuperchainWETH.ts:53](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainWETH.ts#L53)

packages/viem/docs/functions/simulateCrossChainSendETH.md

@@ -36,4 +36,4 @@ The contract functions return value. [CrossChainSendETHContractReturnType](../ty
 
 ## Defined in
 
-[packages/viem/src/actions/crosschainSendETH.ts:122](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/crosschainSendETH.ts#L122)
+[packages/viem/src/actions/crosschainSendETH.ts:122](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/crosschainSendETH.ts#L122)

packages/viem/docs/functions/simulateDepositSuperchainWETH.md

@@ -36,4 +36,4 @@ The contract functions return value. depositSuperchainWETHContractReturnType
 
 ## Defined in
 
-[packages/viem/src/actions/depositSuperchainWETH.ts:115](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L115)
+[packages/viem/src/actions/depositSuperchainWETH.ts:115](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/depositSuperchainWETH.ts#L115)

packages/viem/docs/functions/simulateRelayL2ToL2Message.md

@@ -36,4 +36,4 @@ The contract functions return value. [RelayL2ToL2MessageContractReturnType](../t
 
 ## Defined in
 
-[packages/viem/src/actions/relayL2ToL2Message.ts:129](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L129)
+[packages/viem/src/actions/relayL2ToL2Message.ts:129](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L129)

packages/viem/docs/functions/simulateSendL2ToL2Message.md

@@ -36,4 +36,4 @@ The contract functions return value. [SendL2ToL2MessageContractReturnType](../ty
 
 ## Defined in
 
-[packages/viem/src/actions/sendL2ToL2Message.ts:131](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L131)
+[packages/viem/src/actions/sendL2ToL2Message.ts:131](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L131)