feat(viem): add depositSuperchainWETH (#539)

feat: add depositSuperchainWETH
ethereum-optimism · Oct 28, 2024 · e50cf9b · e50cf9b
1 parent 6209e63
commit e50cf9b
Show file tree

Hide file tree

Showing 67 changed files with 494 additions and 65 deletions.
diff --git a/.changeset/gorgeous-steaks-clean.md b/.changeset/gorgeous-steaks-clean.md
@@ -0,0 +1,5 @@
+---
+"@eth-optimism/viem": patch
+---
+
+add depositSuperchainWETH
diff --git a/packages/viem/docs/README.md b/packages/viem/docs/README.md
@@ -14,13 +14,16 @@
 
 ## L2 Public Actions
 
+- [simulateDepositSuperchainWETH](functions/simulateDepositSuperchainWETH.md)
 - [simulateRelayL2ToL2Message](functions/simulateRelayL2ToL2Message.md)
 - [simulateSendL2ToL2Message](functions/simulateSendL2ToL2Message.md)
 - [simulateSendSupERC20](functions/simulateSendSupERC20.md)
 - [simulateSendSuperchainWETH](functions/simulateSendSuperchainWETH.md)
 
 ## L2 Wallet Actions
 
+- [depositSuperchainWETH](functions/depositSuperchainWETH.md)
+- [estimateDepositSuperchainWETHGas](functions/estimateDepositSuperchainWETHGas.md)
 - [estimateRelayL2ToL2MessageGas](functions/estimateRelayL2ToL2MessageGas.md)
 - [estimateSendL2ToL2MessageGas](functions/estimateSendL2ToL2MessageGas.md)
 - [estimateSendSupERC20Gas](functions/estimateSendSupERC20Gas.md)
@@ -55,6 +58,10 @@
 
 ## Types
 
+- [DepositSuperchainWETHContractReturnType](type-aliases/DepositSuperchainWETHContractReturnType.md)
+- [DepositSuperchainWETHErrorType](type-aliases/DepositSuperchainWETHErrorType.md)
+- [DepositSuperchainWETHParameters](type-aliases/DepositSuperchainWETHParameters.md)
+- [DepositSuperchainWETHReturnType](type-aliases/DepositSuperchainWETHReturnType.md)
 - [MessageIdentifier](type-aliases/MessageIdentifier.md)
 - [RelayL2ToL2MessageContractReturnType](type-aliases/RelayL2ToL2MessageContractReturnType.md)
 - [RelayL2ToL2MessageErrorType](type-aliases/RelayL2ToL2MessageErrorType.md)

diff --git a/packages/viem/docs/functions/createInteropMessage.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/interop.ts#L32)
+[packages/viem/src/utils/interop.ts:32](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/interop.ts#L32)
diff --git a/packages/viem/docs/functions/createInteropSentL2ToL2Messages.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L60)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:60](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L60)
diff --git a/packages/viem/docs/functions/decodeExecutingMessages.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/interop.ts#L66)
+[packages/viem/src/utils/interop.ts:66](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/interop.ts#L66)
diff --git a/packages/viem/docs/functions/decodeRelayedL2ToL2Messages.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L106)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L106)
diff --git a/packages/viem/docs/functions/decodeSentL2ToL2Messages.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L85)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:85](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L85)
diff --git a/packages/viem/docs/functions/depositSuperchainWETH.md b/packages/viem/docs/functions/depositSuperchainWETH.md
@@ -0,0 +1,39 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / depositSuperchainWETH
+
+# depositSuperchainWETH()
+
+> **depositSuperchainWETH**\<`chain`, `account`, `chainOverride`\>(`client`, `parameters`): `Promise`\<[`DepositSuperchainWETHReturnType`](../type-aliases/DepositSuperchainWETHReturnType.md)\>
+
+Deposits ETH to the SuperchainWETH contract.
+
+## 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**: [`DepositSuperchainWETHParameters`](../type-aliases/DepositSuperchainWETHParameters.md)\<`chain`, `account`, `chainOverride`, `DeriveChain`\<`chain`, `chainOverride`\>\>
+
+[DepositSuperchainWETHParameters](../type-aliases/DepositSuperchainWETHParameters.md)
+
+## Returns
+
+`Promise`\<[`DepositSuperchainWETHReturnType`](../type-aliases/DepositSuperchainWETHReturnType.md)\>
+
+The depositSuperchainWETH transaction hash. [DepositSuperchainWETHReturnType](../type-aliases/DepositSuperchainWETHReturnType.md)
+
+## Defined in
+
+[packages/viem/src/actions/depositSuperchainWETH.ts:64](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/depositSuperchainWETH.ts#L64)
diff --git a/packages/viem/docs/functions/estimateDepositSuperchainWETHGas.md b/packages/viem/docs/functions/estimateDepositSuperchainWETHGas.md
@@ -0,0 +1,39 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / estimateDepositSuperchainWETHGas
+
+# estimateDepositSuperchainWETHGas()
+
+> **estimateDepositSuperchainWETHGas**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<`bigint`\>
+
+Estimates gas for [depositSuperchainWETH](depositSuperchainWETH.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**: [`DepositSuperchainWETHParameters`](../type-aliases/DepositSuperchainWETHParameters.md)\<`TChain`, `TAccount`, `TChainOverride`, `DeriveChain`\<`TChain`, `TChainOverride`\>\>
+
+[DepositSuperchainWETHParameters](../type-aliases/DepositSuperchainWETHParameters.md)
+
+## Returns
+
+`Promise`\<`bigint`\>
+
+The estimated gas value.
+
+## Defined in
+
+[packages/viem/src/actions/depositSuperchainWETH.ts:91](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/depositSuperchainWETH.ts#L91)
diff --git a/packages/viem/docs/functions/estimateRelayL2ToL2MessageGas.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/relayL2ToL2Message.ts#L103)
+[packages/viem/src/actions/relayL2ToL2Message.ts:103](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/relayL2ToL2Message.ts#L103)
diff --git a/packages/viem/docs/functions/estimateSendL2ToL2MessageGas.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendL2ToL2Message.ts#L105)
+[packages/viem/src/actions/sendL2ToL2Message.ts:105](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendL2ToL2Message.ts#L105)
diff --git a/packages/viem/docs/functions/estimateSendSupERC20Gas.md b/packages/viem/docs/functions/estimateSendSupERC20Gas.md
@@ -36,4 +36,4 @@ The estimated gas value.
 
 ## Defined in
 
-[packages/viem/src/actions/sendSupERC20.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendSupERC20.ts#L106)
+[packages/viem/src/actions/sendSupERC20.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendSupERC20.ts#L106)
diff --git a/packages/viem/docs/functions/estimateSendSuperchainWETHGas.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendSuperchainWETH.ts#L74)
+[packages/viem/src/actions/sendSuperchainWETH.ts:74](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendSuperchainWETH.ts#L74)
diff --git a/packages/viem/docs/functions/relayL2ToL2Message.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/relayL2ToL2Message.ts#L74)
+[packages/viem/src/actions/relayL2ToL2Message.ts:74](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/relayL2ToL2Message.ts#L74)
diff --git a/packages/viem/docs/functions/sendL2ToL2Message.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendL2ToL2Message.ts#L76)
+[packages/viem/src/actions/sendL2ToL2Message.ts:76](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendL2ToL2Message.ts#L76)
diff --git a/packages/viem/docs/functions/sendSupERC20.md b/packages/viem/docs/functions/sendSupERC20.md
@@ -36,4 +36,4 @@ The sendSupERC20 transaction hash. [SendSupERC20ReturnType](../type-aliases/Send
 
 ## Defined in
 
-[packages/viem/src/actions/sendSupERC20.ts:77](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendSupERC20.ts#L77)
+[packages/viem/src/actions/sendSupERC20.ts:77](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendSupERC20.ts#L77)
diff --git a/packages/viem/docs/functions/sendSuperchainWETH.md b/packages/viem/docs/functions/sendSuperchainWETH.md
@@ -36,4 +36,4 @@ The sendSuperchainWETH transaction hash. [SendSupERC20ReturnType](../type-aliase
 
 ## Defined in
 
-[packages/viem/src/actions/sendSuperchainWETH.ts:53](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendSuperchainWETH.ts#L53)
+[packages/viem/src/actions/sendSuperchainWETH.ts:53](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendSuperchainWETH.ts#L53)
diff --git a/packages/viem/docs/functions/simulateDepositSuperchainWETH.md b/packages/viem/docs/functions/simulateDepositSuperchainWETH.md
@@ -0,0 +1,39 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / simulateDepositSuperchainWETH
+
+# simulateDepositSuperchainWETH()
+
+> **simulateDepositSuperchainWETH**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<[`DepositSuperchainWETHContractReturnType`](../type-aliases/DepositSuperchainWETHContractReturnType.md)\>
+
+Simulate contract call for [depositSuperchainWETH](depositSuperchainWETH.md)
+
+## Type Parameters
+
+• **TChain** *extends* `undefined` \| `Chain`
+
+• **TAccount** *extends* `undefined` \| `Account`
+
+• **TChainOverride** *extends* `undefined` \| `Chain` = `undefined`
+
+## Parameters
+
+• **client**: `Client`\<`Transport`, `TChain`, `TAccount`\>
+
+L2 Public Client
+
+• **parameters**: [`DepositSuperchainWETHParameters`](../type-aliases/DepositSuperchainWETHParameters.md)\<`TChain`, `TAccount`, `TChainOverride`, `DeriveChain`\<`TChain`, `TChainOverride`\>\>
+
+[DepositSuperchainWETHParameters](../type-aliases/DepositSuperchainWETHParameters.md)
+
+## Returns
+
+`Promise`\<[`DepositSuperchainWETHContractReturnType`](../type-aliases/DepositSuperchainWETHContractReturnType.md)\>
+
+The contract functions return value. depositSuperchainWETHContractReturnType
+
+## Defined in
+
+[packages/viem/src/actions/depositSuperchainWETH.ts:115](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/depositSuperchainWETH.ts#L115)
diff --git a/packages/viem/docs/functions/simulateRelayL2ToL2Message.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/relayL2ToL2Message.ts#L129)
+[packages/viem/src/actions/relayL2ToL2Message.ts:129](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/relayL2ToL2Message.ts#L129)
diff --git a/packages/viem/docs/functions/simulateSendL2ToL2Message.md b/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/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendL2ToL2Message.ts#L131)
+[packages/viem/src/actions/sendL2ToL2Message.ts:131](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendL2ToL2Message.ts#L131)
diff --git a/packages/viem/docs/functions/simulateSendSupERC20.md b/packages/viem/docs/functions/simulateSendSupERC20.md
@@ -36,4 +36,4 @@ The contract functions return value. [SendSupERC20ContractReturnType](../type-al
 
 ## Defined in
 
-[packages/viem/src/actions/sendSupERC20.ts:132](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendSupERC20.ts#L132)
+[packages/viem/src/actions/sendSupERC20.ts:132](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendSupERC20.ts#L132)
diff --git a/packages/viem/docs/functions/simulateSendSuperchainWETH.md b/packages/viem/docs/functions/simulateSendSuperchainWETH.md
@@ -36,4 +36,4 @@ The contract functions return value. [SendSupERC20ContractReturnType](../type-al
 
 ## Defined in
 
-[packages/viem/src/actions/sendSuperchainWETH.ts:95](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/actions/sendSuperchainWETH.ts#L95)
+[packages/viem/src/actions/sendSuperchainWETH.ts:95](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/sendSuperchainWETH.ts#L95)
diff --git a/packages/viem/docs/type-aliases/CreateInteropMessageParameters.md b/packages/viem/docs/type-aliases/CreateInteropMessageParameters.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/interop.ts:15](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/interop.ts#L15)
+[packages/viem/src/utils/interop.ts:15](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/interop.ts#L15)
diff --git a/packages/viem/docs/type-aliases/CreateInteropMessageReturnType.md b/packages/viem/docs/type-aliases/CreateInteropMessageReturnType.md
@@ -20,4 +20,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/interop.ts:16](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/interop.ts#L16)
+[packages/viem/src/utils/interop.ts:16](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/interop.ts#L16)
diff --git a/packages/viem/docs/type-aliases/CreateInteropSentL2ToL2MessagesParameters.md b/packages/viem/docs/type-aliases/CreateInteropSentL2ToL2MessagesParameters.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:24](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L24)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:24](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L24)
diff --git a/packages/viem/docs/type-aliases/CreateInteropSentL2ToL2MessagesReturnType.md b/packages/viem/docs/type-aliases/CreateInteropSentL2ToL2MessagesReturnType.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L27)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L27)
diff --git a/packages/viem/docs/type-aliases/DecodeExecutingMessagesParameters.md b/packages/viem/docs/type-aliases/DecodeExecutingMessagesParameters.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/interop.ts:21](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/interop.ts#L21)
+[packages/viem/src/utils/interop.ts:21](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/interop.ts#L21)
diff --git a/packages/viem/docs/type-aliases/DecodeExecutingMessagesReturnType.md b/packages/viem/docs/type-aliases/DecodeExecutingMessagesReturnType.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/interop.ts:22](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/interop.ts#L22)
+[packages/viem/src/utils/interop.ts:22](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/interop.ts#L22)
diff --git a/packages/viem/docs/type-aliases/DecodeRelayedL2ToL2MessagesParameters.md b/packages/viem/docs/type-aliases/DecodeRelayedL2ToL2MessagesParameters.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:43](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L43)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:43](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L43)
diff --git a/packages/viem/docs/type-aliases/DecodeRelayedL2ToL2MessagesReturnType.md b/packages/viem/docs/type-aliases/DecodeRelayedL2ToL2MessagesReturnType.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L46)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L46)
diff --git a/packages/viem/docs/type-aliases/DecodeSentL2ToL2MessagesParameters.md b/packages/viem/docs/type-aliases/DecodeSentL2ToL2MessagesParameters.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:31](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L31)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:31](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L31)
diff --git a/packages/viem/docs/type-aliases/DecodeSentL2ToL2MessagesReturnType.md b/packages/viem/docs/type-aliases/DecodeSentL2ToL2MessagesReturnType.md
@@ -16,4 +16,4 @@
 
 ## Defined in
 
-[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:32](https://github.com/ethereum-optimism/ecosystem/blob/2fda6aba11612b1bd271ada62170b607e878a916/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L32)
+[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:32](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L32)
diff --git a/packages/viem/docs/type-aliases/DepositSuperchainWETHContractReturnType.md b/packages/viem/docs/type-aliases/DepositSuperchainWETHContractReturnType.md
@@ -0,0 +1,13 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / DepositSuperchainWETHContractReturnType
+
+# DepositSuperchainWETHContractReturnType
+
+> **DepositSuperchainWETHContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainWETHABI`](../variables/superchainWETHABI.md), `"payable"`, `"deposit"`\>
+
+## Defined in
+
+[packages/viem/src/actions/depositSuperchainWETH.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/depositSuperchainWETH.ts#L46)
diff --git a/packages/viem/docs/type-aliases/DepositSuperchainWETHErrorType.md b/packages/viem/docs/type-aliases/DepositSuperchainWETHErrorType.md
@@ -0,0 +1,13 @@
+[**@eth-optimism/viem**](../README.md) • **Docs**
+
+***
+
+[@eth-optimism/viem](../README.md) / DepositSuperchainWETHErrorType
+
+# DepositSuperchainWETHErrorType
+
+> **DepositSuperchainWETHErrorType**: `EstimateContractGasErrorType` \| `WriteContractErrorType` \| `ErrorType`
+
+## Defined in
+
+[packages/viem/src/actions/depositSuperchainWETH.ts:52](https://github.com/ethereum-optimism/ecosystem/blob/13a9597363979821622ee318a8281c7048f1a00b/packages/viem/src/actions/depositSuperchainWETH.ts#L52)