From 9c3b85550dcff0bab2de217762ba5b3c7ca9ef55 Mon Sep 17 00:00:00 2001 From: Hamdi Allam Date: Thu, 16 Jan 2025 19:11:19 -0500 Subject: [PATCH 1/5] supERC20 -> SuperchainERC20 --- ...20.spec.ts => sendSuperchainERC20.spec.ts} | 18 ++++---- ...sendSupERC20.ts => sendSuperchainERC20.ts} | 42 +++++++++---------- .../src/actions/sendSuperchainWETH.spec.ts | 10 ++--- .../viem/src/actions/sendSuperchainWETH.ts | 28 ++++++------- packages/viem/src/decorators/publicL2.ts | 28 ++++++------- packages/viem/src/decorators/walletL2.ts | 18 ++++---- packages/viem/src/index.ts | 18 ++++---- packages/viem/src/test/e2e/interop.spec.ts | 2 +- ...dSupERC20.ts => useSendSuperchainERC20.ts} | 10 ++--- .../wagmi/src/hooks/useSendSuperchainWETH.ts | 14 +++---- packages/wagmi/src/index.ts | 2 +- 11 files changed, 91 insertions(+), 99 deletions(-) rename packages/viem/src/actions/{sendSupERC20.spec.ts => sendSuperchainERC20.spec.ts} (85%) rename packages/viem/src/actions/{sendSupERC20.ts => sendSuperchainERC20.ts} (73%) rename packages/wagmi/src/hooks/{useSendSupERC20.ts => useSendSuperchainERC20.ts} (69%) diff --git a/packages/viem/src/actions/sendSupERC20.spec.ts b/packages/viem/src/actions/sendSuperchainERC20.spec.ts similarity index 85% rename from packages/viem/src/actions/sendSupERC20.spec.ts rename to packages/viem/src/actions/sendSuperchainERC20.spec.ts index 45aef5bf..0c276a7b 100644 --- a/packages/viem/src/actions/sendSupERC20.spec.ts +++ b/packages/viem/src/actions/sendSuperchainERC20.spec.ts @@ -1,4 +1,4 @@ -import { parseAbi } from 'viem' +import { parseAbi, erc20Abi } from 'viem' import { beforeAll, describe, expect, it } from 'vitest' import { supersimL2B } from '@/chains/supersim.js' @@ -6,13 +6,9 @@ import { publicClientA, testAccount, walletClientA } from '@/test/clients.js' import { SUPERSIM_SUPERC20_ADDRESS } from '@/test/supERC20.js' import { createInteropSentL2ToL2Messages } from '@/utils/l2ToL2CrossDomainMessenger.js' -const balanceOfAbi = parseAbi([ - 'function balanceOf(address account) view returns (uint256)', -]) - const AMOUNT_TO_SEND = 10n -describe('sendSupERC20', () => { +describe('sendSuperchainERC20', () => { beforeAll(async () => { const hash = await walletClientA.writeContract({ address: SUPERSIM_SUPERC20_ADDRESS, @@ -28,12 +24,12 @@ describe('sendSupERC20', () => { it('should return expected request', async () => { const startingBalance = await publicClientA.readContract({ address: SUPERSIM_SUPERC20_ADDRESS, - abi: balanceOfAbi, + abi: erc20Abi, functionName: 'balanceOf', args: [testAccount.address], }) - const hash = await walletClientA.sendSupERC20({ + const hash = await walletClientA.sendSuperchainERC20({ tokenAddress: SUPERSIM_SUPERC20_ADDRESS, to: testAccount.address, amount: AMOUNT_TO_SEND, @@ -50,7 +46,7 @@ describe('sendSupERC20', () => { const endingBalance = await publicClientA.readContract({ address: SUPERSIM_SUPERC20_ADDRESS, - abi: balanceOfAbi, + abi: erc20Abi, functionName: 'balanceOf', args: [testAccount.address], }) @@ -61,7 +57,7 @@ describe('sendSupERC20', () => { describe('estimate gas', () => { it('should estimate gas', async () => { - const gas = await publicClientA.estimateSendSupERC20Gas({ + const gas = await publicClientA.estimateSendSuperchainERC20Gas({ account: testAccount.address, tokenAddress: SUPERSIM_SUPERC20_ADDRESS, to: testAccount.address, @@ -76,7 +72,7 @@ describe('sendSupERC20', () => { describe('simulate', () => { it('should simulate', async () => { expect(() => - publicClientA.simulateSendSupERC20({ + publicClientA.simulateSendSuperchainERC20({ account: testAccount.address, tokenAddress: SUPERSIM_SUPERC20_ADDRESS, to: testAccount.address, diff --git a/packages/viem/src/actions/sendSupERC20.ts b/packages/viem/src/actions/sendSuperchainERC20.ts similarity index 73% rename from packages/viem/src/actions/sendSupERC20.ts rename to packages/viem/src/actions/sendSuperchainERC20.ts index bf46b76c..89bb9c13 100644 --- a/packages/viem/src/actions/sendSupERC20.ts +++ b/packages/viem/src/actions/sendSuperchainERC20.ts @@ -1,4 +1,4 @@ -/** @module sendSupERC20 */ +/** @module sendSuperchainERC20 */ import type { Account, Address, @@ -24,7 +24,7 @@ import type { ErrorType } from '@/types/utils.js' /** * @category Types */ -export type SendSupERC20Parameters< +export type SendSuperchainERC20Parameters< TChain extends Chain | undefined = Chain | undefined, TAccount extends Account | undefined = Account | undefined, TChainOverride extends Chain | undefined = Chain | undefined, @@ -48,12 +48,12 @@ export type SendSupERC20Parameters< /** * @category Types */ -export type SendSupERC20ReturnType = Hash +export type SendSuperchainERC20ReturnType = Hash /** * @category Types */ -export type SendSupERC20ContractReturnType = ContractFunctionReturnType< +export type SendSuperchainERC20ContractReturnType = ContractFunctionReturnType< typeof superchainTokenBridgeAbi, 'nonpayable', 'sendERC20' @@ -62,7 +62,7 @@ export type SendSupERC20ContractReturnType = ContractFunctionReturnType< /** * @category Types */ -export type SendSupERC20ErrorType = +export type SendSuperchainERC20ErrorType = | EstimateContractGasErrorType | WriteContractErrorType | ErrorType @@ -71,17 +71,17 @@ export type SendSupERC20ErrorType = * Sends tokens to a target address on another chain. Used in the interop flow. * @category L2 Wallet Actions * @param client - L2 Wallet Client - * @param parameters - {@link SendSupERC20Parameters} - * @returns The sendSupERC20 transaction hash. {@link SendSupERC20ReturnType} + * @param parameters - {@link SendSuperchainERC20Parameters} + * @returns The sendSuperchainERC20 transaction hash. {@link SendSuperchainERC20ReturnType} */ -export async function sendSupERC20< +export async function sendSuperchainERC20< chain extends Chain | undefined, account extends Account | undefined, chainOverride extends Chain | undefined = undefined, >( client: Client, - parameters: SendSupERC20Parameters, -): Promise { + parameters: SendSuperchainERC20Parameters, +): Promise { const { tokenAddress, to, amount, chainId, ...txParameters } = parameters return baseWriteAction( @@ -97,19 +97,19 @@ export async function sendSupERC20< } /** - * Estimates gas for {@link sendSupERC20} + * Estimates gas for {@link sendSuperchainERC20} * @category L2 Wallet Actions * @param client - L2 Wallet Client - * @param parameters - {@link SendSupERC20Parameters} + * @param parameters - {@link SendSuperchainERC20Parameters} * @returns The estimated gas value. */ -export async function estimateSendSupERC20Gas< +export async function estimateSendSuperchainERC20Gas< TChain extends Chain | undefined, TAccount extends Account | undefined, TChainOverride extends Chain | undefined = undefined, >( client: Client, - parameters: SendSupERC20Parameters, + parameters: SendSuperchainERC20Parameters, ): Promise { const { tokenAddress, to, amount, chainId, ...txParameters } = parameters @@ -123,20 +123,20 @@ export async function estimateSendSupERC20Gas< } /** - * Simulate contract call for {@link sendSupERC20} + * Simulate contract call for {@link sendSuperchainERC20} * @category L2 Public Actions * @param client - L2 Public Client - * @param parameters - {@link SendSupERC20Parameters} - * @returns The contract functions return value. {@link SendSupERC20ContractReturnType} + * @param parameters - {@link SendSuperchainERC20Parameters} + * @returns The contract functions return value. {@link SendSuperchainERC20ContractReturnType} */ -export async function simulateSendSupERC20< +export async function simulateSendSuperchainERC20< TChain extends Chain | undefined, TAccount extends Account | undefined, TChainOverride extends Chain | undefined = undefined, >( client: Client, - parameters: SendSupERC20Parameters, -): Promise { + parameters: SendSuperchainERC20Parameters, +): Promise { const { account, tokenAddress, to, amount, chainId } = parameters const res = await simulateContract(client, { @@ -148,5 +148,5 @@ export async function simulateSendSupERC20< args: [tokenAddress, to, amount, BigInt(chainId)], } as SimulateContractParameters) - return res.result as SendSupERC20ContractReturnType + return res.result as SendSuperchainERC20ContractReturnType } diff --git a/packages/viem/src/actions/sendSuperchainWETH.spec.ts b/packages/viem/src/actions/sendSuperchainWETH.spec.ts index 8d157e7e..b6494d52 100644 --- a/packages/viem/src/actions/sendSuperchainWETH.spec.ts +++ b/packages/viem/src/actions/sendSuperchainWETH.spec.ts @@ -1,4 +1,4 @@ -import { parseAbi } from 'viem' +import { parseAbi, erc20Abi } from 'viem' import { beforeAll, describe, expect, it } from 'vitest' import { supersimL2B } from '@/chains/supersim.js' @@ -6,10 +6,6 @@ import { contracts } from '@/contracts.js' import { publicClientA, testAccount, walletClientA } from '@/test/clients.js' import { createInteropSentL2ToL2Messages } from '@/utils/l2ToL2CrossDomainMessenger.js' -const balanceOfAbi = parseAbi([ - 'function balanceOf(address account) view returns (uint256)', -]) - const AMOUNT_TO_SEND = 10n describe('sendSuperchainWETH', () => { @@ -25,7 +21,7 @@ describe('sendSuperchainWETH', () => { it('should return expected request', async () => { const startingBalance = await publicClientA.readContract({ address: contracts.superchainWETH.address, - abi: balanceOfAbi, + abi: erc20Abi, functionName: 'balanceOf', args: [testAccount.address], }) @@ -46,7 +42,7 @@ describe('sendSuperchainWETH', () => { const endingBalance = await publicClientA.readContract({ address: contracts.superchainWETH.address, - abi: balanceOfAbi, + abi: erc20Abi, functionName: 'balanceOf', args: [testAccount.address], }) diff --git a/packages/viem/src/actions/sendSuperchainWETH.ts b/packages/viem/src/actions/sendSuperchainWETH.ts index 6cc871db..7f30743d 100644 --- a/packages/viem/src/actions/sendSuperchainWETH.ts +++ b/packages/viem/src/actions/sendSuperchainWETH.ts @@ -12,14 +12,14 @@ import { contracts } from '@/contracts.js' import type { BaseWriteContractActionParameters } from '@/core/baseWriteAction.js' import type { - SendSupERC20ContractReturnType, - SendSupERC20ReturnType, -} from './sendSupERC20.js' + SendSuperchainERC20ContractReturnType, + SendSuperchainERC20ReturnType, +} from './sendSuperchainERC20.js' import { - estimateSendSupERC20Gas, - sendSupERC20, - simulateSendSupERC20, -} from './sendSupERC20.js' + estimateSendSuperchainERC20Gas, + sendSuperchainERC20, + simulateSendSuperchainERC20, +} from './sendSuperchainERC20.js' /** * @category Types @@ -48,7 +48,7 @@ export type SendSuperchainWETHParameters< * @category L2 Wallet Actions * @param client - L2 Wallet Client * @param parameters - {@link SendSuperchainWETHParameters} - * @returns The sendSuperchainWETH transaction hash. {@link SendSupERC20ReturnType} + * @returns The sendSuperchainWETH transaction hash. {@link SendSuperchainERC20ReturnType} */ export async function sendSuperchainWETH< chain extends Chain | undefined, @@ -57,8 +57,8 @@ export async function sendSuperchainWETH< >( client: Client, parameters: SendSuperchainWETHParameters, -): Promise { - return sendSupERC20(client, { +): Promise { + return sendSuperchainERC20(client, { ...parameters, tokenAddress: contracts.superchainWETH.address, }) @@ -79,7 +79,7 @@ export async function estimateSendSuperchainWETHGas< client: Client, parameters: SendSuperchainWETHParameters, ): Promise { - return estimateSendSupERC20Gas(client, { + return estimateSendSuperchainERC20Gas(client, { ...parameters, tokenAddress: contracts.superchainWETH.address, }) @@ -90,7 +90,7 @@ export async function estimateSendSuperchainWETHGas< * @category L2 Public Actions * @param client - L2 Public Client * @param parameters - {@link SendSuperchainWETHParameters} - * @returns The contract functions return value. {@link SendSupERC20ContractReturnType} + * @returns The contract functions return value. {@link SendSuperchainERC20ContractReturnType} */ export async function simulateSendSuperchainWETH< TChain extends Chain | undefined, @@ -99,8 +99,8 @@ export async function simulateSendSuperchainWETH< >( client: Client, parameters: SendSuperchainWETHParameters, -): Promise { - return simulateSendSupERC20(client, { +): Promise { + return simulateSendSuperchainERC20(client, { ...parameters, tokenAddress: contracts.superchainWETH.address, }) diff --git a/packages/viem/src/decorators/publicL2.ts b/packages/viem/src/decorators/publicL2.ts index db9fef55..f543446b 100644 --- a/packages/viem/src/decorators/publicL2.ts +++ b/packages/viem/src/decorators/publicL2.ts @@ -35,13 +35,13 @@ import { simulateSendL2ToL2Message, } from '@/actions/sendL2ToL2Message.js' import type { - SendSupERC20ContractReturnType, - SendSupERC20Parameters, -} from '@/actions/sendSupERC20.js' + SendSuperchainERC20ContractReturnType, + SendSuperchainERC20Parameters, +} from '@/actions/sendSuperchainERC20.js' import { - estimateSendSupERC20Gas, - simulateSendSupERC20, -} from '@/actions/sendSupERC20.js' + estimateSendSuperchainERC20Gas, + simulateSendSuperchainERC20, +} from '@/actions/sendSuperchainERC20.js' import type { SendSuperchainWETHParameters } from '@/actions/sendSuperchainWETH.js' import { estimateSendSuperchainWETHGas, @@ -70,10 +70,10 @@ export type PublicActionsL2< parameters: RelayL2ToL2MessageParameters, ) => Promise - estimateSendSupERC20Gas: < + estimateSendSuperchainERC20Gas: < TChainOverride extends Chain | undefined = undefined, >( - parameters: SendSupERC20Parameters, + parameters: SendSuperchainERC20Parameters, ) => Promise estimateDepositSuperchainWETHGas: < @@ -120,9 +120,9 @@ export type PublicActionsL2< parameters: RelayL2ToL2MessageParameters, ) => Promise - simulateSendSupERC20: ( - parameters: SendSupERC20Parameters, - ) => Promise + simulateSendSuperchainERC20: ( + parameters: SendSuperchainERC20Parameters, + ) => Promise simulateDepositSuperchainWETH: < TChainOverride extends Chain | undefined = undefined, @@ -154,7 +154,7 @@ export type PublicActionsL2< TChainOverride extends Chain | undefined = undefined, >( parameters: SendSuperchainWETHParameters, - ) => Promise + ) => Promise } export function publicActionsL2() { @@ -171,7 +171,7 @@ export function publicActionsL2() { estimateSendL2ToL2MessageGas(client, args), estimateRelayL2ToL2MessageGas: (args) => estimateRelayL2ToL2MessageGas(client, args), - estimateSendSupERC20Gas: (args) => estimateSendSupERC20Gas(client, args), + estimateSendSuperchainERC20Gas: (args) => estimateSendSuperchainERC20Gas(client, args), estimateSendSuperchainWETHGas: (args) => estimateSendSuperchainWETHGas(client, args), estimateDepositSuperchainWETHGas: (args) => @@ -184,7 +184,7 @@ export function publicActionsL2() { simulateSendL2ToL2Message(client, args), simulateRelayL2ToL2Message: (args) => simulateRelayL2ToL2Message(client, args), - simulateSendSupERC20: (args) => simulateSendSupERC20(client, args), + simulateSendSuperchainERC20: (args) => simulateSendSuperchainERC20(client, args), simulateDepositSuperchainWETH: (args) => simulateDepositSuperchainWETH(client, args), simulateWithdrawSuperchainWETH: (args) => diff --git a/packages/viem/src/decorators/walletL2.ts b/packages/viem/src/decorators/walletL2.ts index 7c73f6b7..eac7abf4 100644 --- a/packages/viem/src/decorators/walletL2.ts +++ b/packages/viem/src/decorators/walletL2.ts @@ -23,10 +23,10 @@ import type { } from '@/actions/sendL2ToL2Message.js' import { sendL2ToL2Message } from '@/actions/sendL2ToL2Message.js' import type { - SendSupERC20Parameters, - SendSupERC20ReturnType, -} from '@/actions/sendSupERC20.js' -import { sendSupERC20 } from '@/actions/sendSupERC20.js' + SendSuperchainERC20Parameters, + SendSuperchainERC20ReturnType, +} from '@/actions/sendSuperchainERC20.js' +import { sendSuperchainERC20 } from '@/actions/sendSuperchainERC20.js' import type { SendSuperchainWETHParameters } from '@/actions/sendSuperchainWETH.js' import { sendSuperchainWETH } from '@/actions/sendSuperchainWETH.js' import { @@ -45,12 +45,12 @@ export type WalletActionsL2< relayL2ToL2Message: ( parameters: RelayL2ToL2MessageParameters, ) => Promise - sendSupERC20: ( - parameters: SendSupERC20Parameters, - ) => Promise + sendSuperchainERC20: ( + parameters: SendSuperchainERC20Parameters, + ) => Promise sendSuperchainWETH: ( parameters: SendSuperchainWETHParameters, - ) => Promise + ) => Promise depositSuperchainWETH: ( parameters: DepositSuperchainWETHParameters, ) => Promise @@ -74,7 +74,7 @@ export function walletActionsL2() { ...upstreamWalletActionsL2(), sendL2ToL2Message: (args) => sendL2ToL2Message(client, args), relayL2ToL2Message: (args) => relayL2ToL2Message(client, args), - sendSupERC20: (args) => sendSupERC20(client, args), + sendSuperchainERC20: (args) => sendSuperchainERC20(client, args), sendSuperchainWETH: (args) => sendSuperchainWETH(client, args), depositSuperchainWETH: (args) => depositSuperchainWETH(client, args), withdrawSuperchainWETH: (args) => withdrawSuperchainWETH(client, args), diff --git a/packages/viem/src/index.ts b/packages/viem/src/index.ts index b6d272d4..e02a6068 100644 --- a/packages/viem/src/index.ts +++ b/packages/viem/src/index.ts @@ -52,16 +52,16 @@ export { simulateSendL2ToL2Message, } from '@/actions/sendL2ToL2Message.js' export type { - SendSupERC20ContractReturnType, - SendSupERC20ErrorType, - SendSupERC20Parameters, - SendSupERC20ReturnType, -} from '@/actions/sendSupERC20.js' + SendSuperchainERC20ContractReturnType, + SendSuperchainERC20ErrorType, + SendSuperchainERC20Parameters, + SendSuperchainERC20ReturnType, +} from '@/actions/sendSuperchainERC20.js' export { - estimateSendSupERC20Gas, - sendSupERC20, - simulateSendSupERC20, -} from '@/actions/sendSupERC20.js' + estimateSendSuperchainERC20Gas, + sendSuperchainERC20, + simulateSendSuperchainERC20, +} from '@/actions/sendSuperchainERC20.js' export type { SendSuperchainWETHParameters } from '@/actions/sendSuperchainWETH.js' export { estimateSendSuperchainWETHGas, diff --git a/packages/viem/src/test/e2e/interop.spec.ts b/packages/viem/src/test/e2e/interop.spec.ts index e594207e..46a65339 100644 --- a/packages/viem/src/test/e2e/interop.spec.ts +++ b/packages/viem/src/test/e2e/interop.spec.ts @@ -84,7 +84,7 @@ describe('SuperchainERC20 Flow', () => { args: [testAccount.address], }) - const hash = await walletClientA.sendSupERC20({ + const hash = await walletClientA.sendSuperchainERC20({ tokenAddress: SUPERSIM_SUPERC20_ADDRESS, to: testAccount.address, amount: 10n, diff --git a/packages/wagmi/src/hooks/useSendSupERC20.ts b/packages/wagmi/src/hooks/useSendSuperchainERC20.ts similarity index 69% rename from packages/wagmi/src/hooks/useSendSupERC20.ts rename to packages/wagmi/src/hooks/useSendSuperchainERC20.ts index fc512479..de2a5474 100644 --- a/packages/wagmi/src/hooks/useSendSupERC20.ts +++ b/packages/wagmi/src/hooks/useSendSuperchainERC20.ts @@ -1,16 +1,16 @@ -import type { SendSupERC20Parameters } from '@eth-optimism/viem' +import type { SendSuperchainERC20Parameters } from '@eth-optimism/viem' import { contracts, superchainTokenBridgeAbi } from '@eth-optimism/viem' import { useCallback } from 'react' import { useConfig, useWriteContract } from 'wagmi' -export const useSendSupERC20 = () => { +export const useSendSuperchainERC20 = () => { const config = useConfig() const { writeContractAsync, isError, isPending, isSuccess } = useWriteContract({ config }) - const sendSupERC20 = useCallback( - (params: SendSupERC20Parameters) => { + const sendSuperchainERC20 = useCallback( + (params: SendSuperchainERC20Parameters) => { const { tokenAddress, to, amount, chainId } = params return writeContractAsync({ @@ -23,5 +23,5 @@ export const useSendSupERC20 = () => { [writeContractAsync], ) - return { sendSupERC20, isError, isPending, isSuccess } + return { sendSuperchainERC20, isError, isPending, isSuccess } } diff --git a/packages/wagmi/src/hooks/useSendSuperchainWETH.ts b/packages/wagmi/src/hooks/useSendSuperchainWETH.ts index 59abfb05..ceb01306 100644 --- a/packages/wagmi/src/hooks/useSendSuperchainWETH.ts +++ b/packages/wagmi/src/hooks/useSendSuperchainWETH.ts @@ -1,29 +1,29 @@ import { contracts, - type SendSupERC20Parameters, + type SendSuperchainERC20Parameters, type SendSuperchainWETHParameters, } from '@eth-optimism/viem' import { useCallback } from 'react' -import { useSendSupERC20 } from './useSendSupERC20.js' +import { useSendSuperchainERC20 } from './useSendSuperchainERC20.js' export const useSendSuperchainWETH = () => { - const { sendSupERC20, isError, isPending, isSuccess } = useSendSupERC20() + const { sendSuperchainERC20, isError, isPending, isSuccess } = useSendSuperchainERC20() const sendSuperchainWETH = useCallback( (params: SendSuperchainWETHParameters) => { const { to, amount, chainId } = params - const sendSupERC20Params = { + const sendSuperchainERC20Params = { tokenAddress: contracts.superchainWETH.address, to, amount, chainId, - } as unknown as SendSupERC20Parameters + } as unknown as SendSuperchainERC20Parameters - return sendSupERC20(sendSupERC20Params) + return sendSuperchainERC20(sendSuperchainERC20Params) }, - [sendSupERC20], + [sendSuperchainERC20], ) return { sendSuperchainWETH, isError, isPending, isSuccess } diff --git a/packages/wagmi/src/index.ts b/packages/wagmi/src/index.ts index 487888aa..804f0526 100644 --- a/packages/wagmi/src/index.ts +++ b/packages/wagmi/src/index.ts @@ -2,5 +2,5 @@ export { useCrossChainSendETH } from '@/hooks/useCrossChainSendETH.js' export { useRelayL2ToL2Message } from '@/hooks/useRelayL2ToL2Message.js' export { useSendL2ToL2Message } from '@/hooks/useSendL2ToL2Message.js' -export { useSendSupERC20 } from '@/hooks/useSendSupERC20.js' +export { useSendSuperchainERC20 } from '@/hooks/useSendSuperchainERC20.js' export { useSendSuperchainWETH } from '@/hooks/useSendSuperchainWETH.js' From fc361c1d77d8cf7d454d6b32e8c1a5be79248032 Mon Sep 17 00:00:00 2001 From: Hamdi Allam Date: Thu, 16 Jan 2025 19:13:59 -0500 Subject: [PATCH 2/5] changeset --- .changeset/khaki-mirrors-learn.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/khaki-mirrors-learn.md diff --git a/.changeset/khaki-mirrors-learn.md b/.changeset/khaki-mirrors-learn.md new file mode 100644 index 00000000..37b03415 --- /dev/null +++ b/.changeset/khaki-mirrors-learn.md @@ -0,0 +1,6 @@ +--- +"@eth-optimism/wagmi": minor +"@eth-optimism/viem": minor +--- + +rename SupERC20 to SuperchainERC20 From 10ecaca99b3b5dfe1adcbd9d7e566f6086d9ab45 Mon Sep 17 00:00:00 2001 From: Hamdi Allam Date: Thu, 16 Jan 2025 19:22:07 -0500 Subject: [PATCH 3/5] lint --- packages/viem/src/actions/sendSuperchainERC20.spec.ts | 2 +- packages/viem/src/actions/sendSuperchainWETH.spec.ts | 2 +- packages/viem/src/decorators/publicL2.ts | 10 +++++++--- packages/wagmi/src/hooks/useSendSuperchainWETH.ts | 3 ++- 4 files changed, 11 insertions(+), 6 deletions(-) diff --git a/packages/viem/src/actions/sendSuperchainERC20.spec.ts b/packages/viem/src/actions/sendSuperchainERC20.spec.ts index 0c276a7b..d8087d61 100644 --- a/packages/viem/src/actions/sendSuperchainERC20.spec.ts +++ b/packages/viem/src/actions/sendSuperchainERC20.spec.ts @@ -1,4 +1,4 @@ -import { parseAbi, erc20Abi } from 'viem' +import { erc20Abi, parseAbi } from 'viem' import { beforeAll, describe, expect, it } from 'vitest' import { supersimL2B } from '@/chains/supersim.js' diff --git a/packages/viem/src/actions/sendSuperchainWETH.spec.ts b/packages/viem/src/actions/sendSuperchainWETH.spec.ts index b6494d52..25d097e5 100644 --- a/packages/viem/src/actions/sendSuperchainWETH.spec.ts +++ b/packages/viem/src/actions/sendSuperchainWETH.spec.ts @@ -1,4 +1,4 @@ -import { parseAbi, erc20Abi } from 'viem' +import { erc20Abi } from 'viem' import { beforeAll, describe, expect, it } from 'vitest' import { supersimL2B } from '@/chains/supersim.js' diff --git a/packages/viem/src/decorators/publicL2.ts b/packages/viem/src/decorators/publicL2.ts index f543446b..3b404522 100644 --- a/packages/viem/src/decorators/publicL2.ts +++ b/packages/viem/src/decorators/publicL2.ts @@ -120,7 +120,9 @@ export type PublicActionsL2< parameters: RelayL2ToL2MessageParameters, ) => Promise - simulateSendSuperchainERC20: ( + simulateSendSuperchainERC20: < + TChainOverride extends Chain | undefined = undefined, + >( parameters: SendSuperchainERC20Parameters, ) => Promise @@ -171,7 +173,8 @@ export function publicActionsL2() { estimateSendL2ToL2MessageGas(client, args), estimateRelayL2ToL2MessageGas: (args) => estimateRelayL2ToL2MessageGas(client, args), - estimateSendSuperchainERC20Gas: (args) => estimateSendSuperchainERC20Gas(client, args), + estimateSendSuperchainERC20Gas: (args) => + estimateSendSuperchainERC20Gas(client, args), estimateSendSuperchainWETHGas: (args) => estimateSendSuperchainWETHGas(client, args), estimateDepositSuperchainWETHGas: (args) => @@ -184,7 +187,8 @@ export function publicActionsL2() { simulateSendL2ToL2Message(client, args), simulateRelayL2ToL2Message: (args) => simulateRelayL2ToL2Message(client, args), - simulateSendSuperchainERC20: (args) => simulateSendSuperchainERC20(client, args), + simulateSendSuperchainERC20: (args) => + simulateSendSuperchainERC20(client, args), simulateDepositSuperchainWETH: (args) => simulateDepositSuperchainWETH(client, args), simulateWithdrawSuperchainWETH: (args) => diff --git a/packages/wagmi/src/hooks/useSendSuperchainWETH.ts b/packages/wagmi/src/hooks/useSendSuperchainWETH.ts index ceb01306..0e2d7e75 100644 --- a/packages/wagmi/src/hooks/useSendSuperchainWETH.ts +++ b/packages/wagmi/src/hooks/useSendSuperchainWETH.ts @@ -8,7 +8,8 @@ import { useCallback } from 'react' import { useSendSuperchainERC20 } from './useSendSuperchainERC20.js' export const useSendSuperchainWETH = () => { - const { sendSuperchainERC20, isError, isPending, isSuccess } = useSendSuperchainERC20() + const { sendSuperchainERC20, isError, isPending, isSuccess } = + useSendSuperchainERC20() const sendSuperchainWETH = useCallback( (params: SendSuperchainWETHParameters) => { From 6d6302cd415cfc874f1d86fa22a309bdd9314531 Mon Sep 17 00:00:00 2001 From: Hamdi Allam Date: Thu, 16 Jan 2025 19:30:05 -0500 Subject: [PATCH 4/5] optimism submodule was missed --- lib/optimism | 1 + 1 file changed, 1 insertion(+) create mode 160000 lib/optimism diff --git a/lib/optimism b/lib/optimism new file mode 160000 index 00000000..43b4e77c --- /dev/null +++ b/lib/optimism @@ -0,0 +1 @@ +Subproject commit 43b4e77c8b206c2518a2748e0b8e36bb73eab1bd From b22c17e900ed005256863040fbe1a248842c1995 Mon Sep 17 00:00:00 2001 From: Hamdi Allam Date: Fri, 17 Jan 2025 11:07:29 -0500 Subject: [PATCH 5/5] docs --- packages/viem/docs/README.md | 30 +- .../docs/functions/createInteropMessage.md | 2 +- .../createInteropSentL2ToL2Messages.md | 2 +- .../viem/docs/functions/crossChainSendETH.md | 2 +- .../docs/functions/decodeExecutingMessages.md | 2 +- .../functions/decodeRelayedL2ToL2Messages.md | 2 +- .../functions/decodeSentL2ToL2Messages.md | 2 +- .../docs/functions/depositSuperchainWETH.md | 2 +- .../functions/estimateCrossChainSendETHGas.md | 2 +- .../estimateDepositSuperchainWETHGas.md | 2 +- .../estimateRelayL2ToL2MessageGas.md | 2 +- .../functions/estimateSendL2ToL2MessageGas.md | 2 +- .../docs/functions/estimateSendSupERC20Gas.md | 39 -- .../estimateSendSuperchainERC20Gas.md | 39 ++ .../estimateSendSuperchainWETHGas.md | 2 +- .../estimateWithdrawSuperchainWETHGas.md | 2 +- .../viem/docs/functions/relayL2ToL2Message.md | 2 +- .../viem/docs/functions/sendL2ToL2Message.md | 2 +- packages/viem/docs/functions/sendSupERC20.md | 39 -- .../docs/functions/sendSuperchainERC20.md | 39 ++ .../viem/docs/functions/sendSuperchainWETH.md | 8 +- .../functions/simulateCrossChainSendETH.md | 2 +- .../simulateDepositSuperchainWETH.md | 2 +- .../functions/simulateRelayL2ToL2Message.md | 2 +- .../functions/simulateSendL2ToL2Message.md | 2 +- .../docs/functions/simulateSendSupERC20.md | 39 -- .../functions/simulateSendSuperchainERC20.md | 39 ++ .../functions/simulateSendSuperchainWETH.md | 8 +- .../simulateWithdrawSuperchainWETH.md | 2 +- .../docs/functions/withdrawSuperchainWETH.md | 2 +- .../CreateInteropMessageParameters.md | 2 +- .../CreateInteropMessageReturnType.md | 2 +- ...eateInteropSentL2ToL2MessagesParameters.md | 2 +- ...eateInteropSentL2ToL2MessagesReturnType.md | 2 +- .../CrossChainSendETHContractReturnType.md | 4 +- .../CrossChainSendETHErrorType.md | 2 +- .../CrossChainSendETHParameters.md | 2 +- .../DecodeExecutingMessagesParameters.md | 2 +- .../DecodeExecutingMessagesReturnType.md | 2 +- .../DecodeRelayedL2ToL2MessagesParameters.md | 2 +- .../DecodeRelayedL2ToL2MessagesReturnType.md | 2 +- .../DecodeSentL2ToL2MessagesParameters.md | 2 +- .../DecodeSentL2ToL2MessagesReturnType.md | 2 +- ...DepositSuperchainWETHContractReturnType.md | 4 +- .../DepositSuperchainWETHErrorType.md | 2 +- .../DepositSuperchainWETHParameters.md | 2 +- .../DepositSuperchainWETHReturnType.md | 2 +- .../docs/type-aliases/MessageIdentifier.md | 2 +- .../RelayL2ToL2MessageContractReturnType.md | 4 +- .../RelayL2ToL2MessageErrorType.md | 2 +- .../RelayL2ToL2MessageParameters.md | 2 +- .../RelayL2ToL2MessageReturnType.md | 2 +- .../SendL2ToL2MessageContractReturnType.md | 4 +- .../SendL2ToL2MessageErrorType.md | 2 +- .../SendL2ToL2MessageParameters.md | 2 +- .../SendL2ToL2MessageReturnType.md | 2 +- .../SendSupERC20ContractReturnType.md | 13 - .../type-aliases/SendSupERC20ErrorType.md | 13 - .../type-aliases/SendSupERC20ReturnType.md | 13 - .../SendSuperchainERC20ContractReturnType.md | 13 + .../SendSuperchainERC20ErrorType.md | 13 + ...rs.md => SendSuperchainERC20Parameters.md} | 8 +- .../SendSuperchainERC20ReturnType.md | 13 + .../SendSuperchainWETHParameters.md | 2 +- ...ithdrawSuperchainWETHContractReturnType.md | 4 +- .../WithdrawSuperchainWETHErrorType.md | 2 +- .../WithdrawSuperchainWETHParameters.md | 2 +- .../WithdrawSuperchainWETHReturnType.md | 2 +- packages/viem/docs/variables/contracts.md | 2 +- .../viem/docs/variables/crossL2InboxABI.md | 8 +- .../l2ToL2CrossDomainMessengerABI.md | 8 +- .../viem/docs/variables/superchainERC20ABI.md | 8 +- .../variables/superchainTokenBridgeABI.md | 8 +- .../viem/docs/variables/superchainWETHABI.md | 8 +- packages/viem/docs/variables/supersimL1.md | 155 ------ packages/viem/docs/variables/supersimL2A.md | 507 ------------------ packages/viem/docs/variables/supersimL2B.md | 507 ------------------ 77 files changed, 258 insertions(+), 1433 deletions(-) delete mode 100644 packages/viem/docs/functions/estimateSendSupERC20Gas.md create mode 100644 packages/viem/docs/functions/estimateSendSuperchainERC20Gas.md delete mode 100644 packages/viem/docs/functions/sendSupERC20.md create mode 100644 packages/viem/docs/functions/sendSuperchainERC20.md delete mode 100644 packages/viem/docs/functions/simulateSendSupERC20.md create mode 100644 packages/viem/docs/functions/simulateSendSuperchainERC20.md delete mode 100644 packages/viem/docs/type-aliases/SendSupERC20ContractReturnType.md delete mode 100644 packages/viem/docs/type-aliases/SendSupERC20ErrorType.md delete mode 100644 packages/viem/docs/type-aliases/SendSupERC20ReturnType.md create mode 100644 packages/viem/docs/type-aliases/SendSuperchainERC20ContractReturnType.md create mode 100644 packages/viem/docs/type-aliases/SendSuperchainERC20ErrorType.md rename packages/viem/docs/type-aliases/{SendSupERC20Parameters.md => SendSuperchainERC20Parameters.md} (56%) create mode 100644 packages/viem/docs/type-aliases/SendSuperchainERC20ReturnType.md delete mode 100644 packages/viem/docs/variables/supersimL1.md delete mode 100644 packages/viem/docs/variables/supersimL2A.md delete mode 100644 packages/viem/docs/variables/supersimL2B.md diff --git a/packages/viem/docs/README.md b/packages/viem/docs/README.md index d12dc873..2f15ba09 100644 --- a/packages/viem/docs/README.md +++ b/packages/viem/docs/README.md @@ -6,11 +6,11 @@ ## 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 @@ -18,7 +18,7 @@ - [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) diff --git a/packages/viem/docs/functions/createInteropMessage.md b/packages/viem/docs/functions/createInteropMessage.md index fee721d0..5f7bb042 100644 --- 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/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) diff --git a/packages/viem/docs/functions/createInteropSentL2ToL2Messages.md b/packages/viem/docs/functions/createInteropSentL2ToL2Messages.md index 3de4613c..2a1c0985 100644 --- 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/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) diff --git a/packages/viem/docs/functions/crossChainSendETH.md b/packages/viem/docs/functions/crossChainSendETH.md index b08759b3..700a4d69 100644 --- a/packages/viem/docs/functions/crossChainSendETH.md +++ b/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) diff --git a/packages/viem/docs/functions/decodeExecutingMessages.md b/packages/viem/docs/functions/decodeExecutingMessages.md index e7c8da03..b075de80 100644 --- 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/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) diff --git a/packages/viem/docs/functions/decodeRelayedL2ToL2Messages.md b/packages/viem/docs/functions/decodeRelayedL2ToL2Messages.md index 9553d35e..1476c6cc 100644 --- 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/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) diff --git a/packages/viem/docs/functions/decodeSentL2ToL2Messages.md b/packages/viem/docs/functions/decodeSentL2ToL2Messages.md index 8b6faaac..038a201f 100644 --- 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/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) diff --git a/packages/viem/docs/functions/depositSuperchainWETH.md b/packages/viem/docs/functions/depositSuperchainWETH.md index e7fd1379..2ab9e612 100644 --- a/packages/viem/docs/functions/depositSuperchainWETH.md +++ b/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) diff --git a/packages/viem/docs/functions/estimateCrossChainSendETHGas.md b/packages/viem/docs/functions/estimateCrossChainSendETHGas.md index 3145fb97..f85175b8 100644 --- a/packages/viem/docs/functions/estimateCrossChainSendETHGas.md +++ b/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) diff --git a/packages/viem/docs/functions/estimateDepositSuperchainWETHGas.md b/packages/viem/docs/functions/estimateDepositSuperchainWETHGas.md index ad0304e7..fed5ae29 100644 --- a/packages/viem/docs/functions/estimateDepositSuperchainWETHGas.md +++ b/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) diff --git a/packages/viem/docs/functions/estimateRelayL2ToL2MessageGas.md b/packages/viem/docs/functions/estimateRelayL2ToL2MessageGas.md index 4ed09051..75abb28d 100644 --- 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/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) diff --git a/packages/viem/docs/functions/estimateSendL2ToL2MessageGas.md b/packages/viem/docs/functions/estimateSendL2ToL2MessageGas.md index 09394f84..6d21e001 100644 --- 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/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) diff --git a/packages/viem/docs/functions/estimateSendSupERC20Gas.md b/packages/viem/docs/functions/estimateSendSupERC20Gas.md deleted file mode 100644 index 9774973e..00000000 --- a/packages/viem/docs/functions/estimateSendSupERC20Gas.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / estimateSendSupERC20Gas - -# estimateSendSupERC20Gas() - -> **estimateSendSupERC20Gas**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<`bigint`\> - -Estimates gas for [sendSupERC20](sendSupERC20.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**: [`SendSupERC20Parameters`](../type-aliases/SendSupERC20Parameters.md)\<`TChain`, `TAccount`, `TChainOverride`, `DeriveChain`\<`TChain`, `TChainOverride`\>\> - -[SendSupERC20Parameters](../type-aliases/SendSupERC20Parameters.md) - -## Returns - -`Promise`\<`bigint`\> - -The estimated gas value. - -## Defined in - -[packages/viem/src/actions/sendSupERC20.ts:106](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L106) diff --git a/packages/viem/docs/functions/estimateSendSuperchainERC20Gas.md b/packages/viem/docs/functions/estimateSendSuperchainERC20Gas.md new file mode 100644 index 00000000..a48d128c --- /dev/null +++ b/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) diff --git a/packages/viem/docs/functions/estimateSendSuperchainWETHGas.md b/packages/viem/docs/functions/estimateSendSuperchainWETHGas.md index e64c85ee..23952a24 100644 --- 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/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) diff --git a/packages/viem/docs/functions/estimateWithdrawSuperchainWETHGas.md b/packages/viem/docs/functions/estimateWithdrawSuperchainWETHGas.md index 401c33a8..4398bc04 100644 --- a/packages/viem/docs/functions/estimateWithdrawSuperchainWETHGas.md +++ b/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) diff --git a/packages/viem/docs/functions/relayL2ToL2Message.md b/packages/viem/docs/functions/relayL2ToL2Message.md index 3d670334..7b5e7c1b 100644 --- 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/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) diff --git a/packages/viem/docs/functions/sendL2ToL2Message.md b/packages/viem/docs/functions/sendL2ToL2Message.md index aa30e0cb..7f5c3d1c 100644 --- 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/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) diff --git a/packages/viem/docs/functions/sendSupERC20.md b/packages/viem/docs/functions/sendSupERC20.md deleted file mode 100644 index fcf92890..00000000 --- a/packages/viem/docs/functions/sendSupERC20.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / sendSupERC20 - -# sendSupERC20() - -> **sendSupERC20**\<`chain`, `account`, `chainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSupERC20ReturnType`](../type-aliases/SendSupERC20ReturnType.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**: [`SendSupERC20Parameters`](../type-aliases/SendSupERC20Parameters.md)\<`chain`, `account`, `chainOverride`, `DeriveChain`\<`chain`, `chainOverride`\>\> - -[SendSupERC20Parameters](../type-aliases/SendSupERC20Parameters.md) - -## Returns - -`Promise`\<[`SendSupERC20ReturnType`](../type-aliases/SendSupERC20ReturnType.md)\> - -The sendSupERC20 transaction hash. [SendSupERC20ReturnType](../type-aliases/SendSupERC20ReturnType.md) - -## Defined in - -[packages/viem/src/actions/sendSupERC20.ts:77](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L77) diff --git a/packages/viem/docs/functions/sendSuperchainERC20.md b/packages/viem/docs/functions/sendSuperchainERC20.md new file mode 100644 index 00000000..b6a4642d --- /dev/null +++ b/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) diff --git a/packages/viem/docs/functions/sendSuperchainWETH.md b/packages/viem/docs/functions/sendSuperchainWETH.md index d2693b3f..10efdbc3 100644 --- a/packages/viem/docs/functions/sendSuperchainWETH.md +++ b/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) diff --git a/packages/viem/docs/functions/simulateCrossChainSendETH.md b/packages/viem/docs/functions/simulateCrossChainSendETH.md index 12279099..496eafa9 100644 --- a/packages/viem/docs/functions/simulateCrossChainSendETH.md +++ b/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) diff --git a/packages/viem/docs/functions/simulateDepositSuperchainWETH.md b/packages/viem/docs/functions/simulateDepositSuperchainWETH.md index 9b7de315..5292e04c 100644 --- a/packages/viem/docs/functions/simulateDepositSuperchainWETH.md +++ b/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) diff --git a/packages/viem/docs/functions/simulateRelayL2ToL2Message.md b/packages/viem/docs/functions/simulateRelayL2ToL2Message.md index 4a0cf8b6..f9f71bec 100644 --- 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/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) diff --git a/packages/viem/docs/functions/simulateSendL2ToL2Message.md b/packages/viem/docs/functions/simulateSendL2ToL2Message.md index ababfe05..04f1f3ed 100644 --- 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/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) diff --git a/packages/viem/docs/functions/simulateSendSupERC20.md b/packages/viem/docs/functions/simulateSendSupERC20.md deleted file mode 100644 index ae063cb5..00000000 --- a/packages/viem/docs/functions/simulateSendSupERC20.md +++ /dev/null @@ -1,39 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / simulateSendSupERC20 - -# simulateSendSupERC20() - -> **simulateSendSupERC20**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSupERC20ContractReturnType`](../type-aliases/SendSupERC20ContractReturnType.md)\> - -Simulate contract call for [sendSupERC20](sendSupERC20.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**: [`SendSupERC20Parameters`](../type-aliases/SendSupERC20Parameters.md)\<`TChain`, `TAccount`, `TChainOverride`, `DeriveChain`\<`TChain`, `TChainOverride`\>\> - -[SendSupERC20Parameters](../type-aliases/SendSupERC20Parameters.md) - -## Returns - -`Promise`\<[`SendSupERC20ContractReturnType`](../type-aliases/SendSupERC20ContractReturnType.md)\> - -The contract functions return value. [SendSupERC20ContractReturnType](../type-aliases/SendSupERC20ContractReturnType.md) - -## Defined in - -[packages/viem/src/actions/sendSupERC20.ts:132](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L132) diff --git a/packages/viem/docs/functions/simulateSendSuperchainERC20.md b/packages/viem/docs/functions/simulateSendSuperchainERC20.md new file mode 100644 index 00000000..3cbebffb --- /dev/null +++ b/packages/viem/docs/functions/simulateSendSuperchainERC20.md @@ -0,0 +1,39 @@ +[**@eth-optimism/viem**](../README.md) • **Docs** + +*** + +[@eth-optimism/viem](../README.md) / simulateSendSuperchainERC20 + +# simulateSendSuperchainERC20() + +> **simulateSendSuperchainERC20**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSuperchainERC20ContractReturnType`](../type-aliases/SendSuperchainERC20ContractReturnType.md)\> + +Simulate contract call 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 Public Client + +• **parameters**: [`SendSuperchainERC20Parameters`](../type-aliases/SendSuperchainERC20Parameters.md)\<`TChain`, `TAccount`, `TChainOverride`, `DeriveChain`\<`TChain`, `TChainOverride`\>\> + +[SendSuperchainERC20Parameters](../type-aliases/SendSuperchainERC20Parameters.md) + +## Returns + +`Promise`\<[`SendSuperchainERC20ContractReturnType`](../type-aliases/SendSuperchainERC20ContractReturnType.md)\> + +The contract functions return value. [SendSuperchainERC20ContractReturnType](../type-aliases/SendSuperchainERC20ContractReturnType.md) + +## Defined in + +[packages/viem/src/actions/sendSuperchainERC20.ts:132](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L132) diff --git a/packages/viem/docs/functions/simulateSendSuperchainWETH.md b/packages/viem/docs/functions/simulateSendSuperchainWETH.md index d67e37e3..2ff5deab 100644 --- a/packages/viem/docs/functions/simulateSendSuperchainWETH.md +++ b/packages/viem/docs/functions/simulateSendSuperchainWETH.md @@ -6,7 +6,7 @@ # simulateSendSuperchainWETH() -> **simulateSendSuperchainWETH**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSupERC20ContractReturnType`](../type-aliases/SendSupERC20ContractReturnType.md)\> +> **simulateSendSuperchainWETH**\<`TChain`, `TAccount`, `TChainOverride`\>(`client`, `parameters`): `Promise`\<[`SendSuperchainERC20ContractReturnType`](../type-aliases/SendSuperchainERC20ContractReturnType.md)\> Simulate contract call for [sendSuperchainWETH](sendSuperchainWETH.md) @@ -30,10 +30,10 @@ L2 Public Client ## Returns -`Promise`\<[`SendSupERC20ContractReturnType`](../type-aliases/SendSupERC20ContractReturnType.md)\> +`Promise`\<[`SendSuperchainERC20ContractReturnType`](../type-aliases/SendSuperchainERC20ContractReturnType.md)\> -The contract functions return value. [SendSupERC20ContractReturnType](../type-aliases/SendSupERC20ContractReturnType.md) +The contract functions return value. [SendSuperchainERC20ContractReturnType](../type-aliases/SendSuperchainERC20ContractReturnType.md) ## Defined in -[packages/viem/src/actions/sendSuperchainWETH.ts:95](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSuperchainWETH.ts#L95) +[packages/viem/src/actions/sendSuperchainWETH.ts:95](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainWETH.ts#L95) diff --git a/packages/viem/docs/functions/simulateWithdrawSuperchainWETH.md b/packages/viem/docs/functions/simulateWithdrawSuperchainWETH.md index be7ed9f1..93ff88c0 100644 --- a/packages/viem/docs/functions/simulateWithdrawSuperchainWETH.md +++ b/packages/viem/docs/functions/simulateWithdrawSuperchainWETH.md @@ -36,4 +36,4 @@ The contract functions return value. withdrawSuperchainWETHContractReturnType ## Defined in -[packages/viem/src/actions/withdrawSuperchainWETH.ts:126](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L126) +[packages/viem/src/actions/withdrawSuperchainWETH.ts:126](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L126) diff --git a/packages/viem/docs/functions/withdrawSuperchainWETH.md b/packages/viem/docs/functions/withdrawSuperchainWETH.md index f5a45ee6..64b84ecb 100644 --- a/packages/viem/docs/functions/withdrawSuperchainWETH.md +++ b/packages/viem/docs/functions/withdrawSuperchainWETH.md @@ -36,4 +36,4 @@ The withdrawSuperchainWETH transaction hash. [WithdrawSuperchainWETHReturnType]( ## Defined in -[packages/viem/src/actions/withdrawSuperchainWETH.ts:67](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L67) +[packages/viem/src/actions/withdrawSuperchainWETH.ts:67](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L67) diff --git a/packages/viem/docs/type-aliases/CreateInteropMessageParameters.md b/packages/viem/docs/type-aliases/CreateInteropMessageParameters.md index 814b60a1..00b507b5 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/interop.ts#L15) +[packages/viem/src/utils/interop.ts:15](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index 8feba1c0..a15729c6 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/interop.ts#L16) +[packages/viem/src/utils/interop.ts:16](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index f205950c..5da9ca51 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L24) +[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:24](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index cc105066..7dab8a05 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L27) +[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L27) diff --git a/packages/viem/docs/type-aliases/CrossChainSendETHContractReturnType.md b/packages/viem/docs/type-aliases/CrossChainSendETHContractReturnType.md index 089b6c53..443aac29 100644 --- a/packages/viem/docs/type-aliases/CrossChainSendETHContractReturnType.md +++ b/packages/viem/docs/type-aliases/CrossChainSendETHContractReturnType.md @@ -6,8 +6,8 @@ # CrossChainSendETHContractReturnType -> **CrossChainSendETHContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainWETHABI`](../variables/superchainWETHABI.md), `"payable"`, `"sendETH"`\> +> **CrossChainSendETHContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainWETHAbi`](../variables/superchainWETHAbi.md), `"payable"`, `"sendETH"`\> ## Defined in -[packages/viem/src/actions/crosschainSendETH.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/crosschainSendETH.ts#L46) +[packages/viem/src/actions/crosschainSendETH.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/crosschainSendETH.ts#L46) diff --git a/packages/viem/docs/type-aliases/CrossChainSendETHErrorType.md b/packages/viem/docs/type-aliases/CrossChainSendETHErrorType.md index b56570e2..be4a4811 100644 --- a/packages/viem/docs/type-aliases/CrossChainSendETHErrorType.md +++ b/packages/viem/docs/type-aliases/CrossChainSendETHErrorType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/crosschainSendETH.ts:55](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/crosschainSendETH.ts#L55) +[packages/viem/src/actions/crosschainSendETH.ts:55](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/crosschainSendETH.ts#L55) diff --git a/packages/viem/docs/type-aliases/CrossChainSendETHParameters.md b/packages/viem/docs/type-aliases/CrossChainSendETHParameters.md index aac74b93..c738dc15 100644 --- a/packages/viem/docs/type-aliases/CrossChainSendETHParameters.md +++ b/packages/viem/docs/type-aliases/CrossChainSendETHParameters.md @@ -34,4 +34,4 @@ Address to send ETH to. ## Defined in -[packages/viem/src/actions/crosschainSendETH.ts:26](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/crosschainSendETH.ts#L26) +[packages/viem/src/actions/crosschainSendETH.ts:26](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/crosschainSendETH.ts#L26) diff --git a/packages/viem/docs/type-aliases/DecodeExecutingMessagesParameters.md b/packages/viem/docs/type-aliases/DecodeExecutingMessagesParameters.md index 74458d60..d6cebf22 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/interop.ts#L21) +[packages/viem/src/utils/interop.ts:21](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index 8c2c4370..c100468b 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/interop.ts#L22) +[packages/viem/src/utils/interop.ts:22](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index 364662ab..53609e23 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L43) +[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:43](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index fd262613..8bbebac1 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L46) +[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index a7c7a993..9f5bc524 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L31) +[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:31](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index e43f62ad..f5bea91e 100644 --- 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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts#L32) +[packages/viem/src/utils/l2ToL2CrossDomainMessenger.ts:32](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index 7be07ed6..76d3931e 100644 --- a/packages/viem/docs/type-aliases/DepositSuperchainWETHContractReturnType.md +++ b/packages/viem/docs/type-aliases/DepositSuperchainWETHContractReturnType.md @@ -6,8 +6,8 @@ # DepositSuperchainWETHContractReturnType -> **DepositSuperchainWETHContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainWETHABI`](../variables/superchainWETHABI.md), `"payable"`, `"deposit"`\> +> **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/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L46) +[packages/viem/src/actions/depositSuperchainWETH.ts:46](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/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 index fcc106bb..532a1864 100644 --- a/packages/viem/docs/type-aliases/DepositSuperchainWETHErrorType.md +++ b/packages/viem/docs/type-aliases/DepositSuperchainWETHErrorType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/depositSuperchainWETH.ts:52](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L52) +[packages/viem/src/actions/depositSuperchainWETH.ts:52](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/depositSuperchainWETH.ts#L52) diff --git a/packages/viem/docs/type-aliases/DepositSuperchainWETHParameters.md b/packages/viem/docs/type-aliases/DepositSuperchainWETHParameters.md index 0ee162f2..60897d4e 100644 --- a/packages/viem/docs/type-aliases/DepositSuperchainWETHParameters.md +++ b/packages/viem/docs/type-aliases/DepositSuperchainWETHParameters.md @@ -20,4 +20,4 @@ ## Defined in -[packages/viem/src/actions/depositSuperchainWETH.ts:26](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L26) +[packages/viem/src/actions/depositSuperchainWETH.ts:26](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/depositSuperchainWETH.ts#L26) diff --git a/packages/viem/docs/type-aliases/DepositSuperchainWETHReturnType.md b/packages/viem/docs/type-aliases/DepositSuperchainWETHReturnType.md index 831351d9..33fdc231 100644 --- a/packages/viem/docs/type-aliases/DepositSuperchainWETHReturnType.md +++ b/packages/viem/docs/type-aliases/DepositSuperchainWETHReturnType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/depositSuperchainWETH.ts:41](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/depositSuperchainWETH.ts#L41) +[packages/viem/src/actions/depositSuperchainWETH.ts:41](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/depositSuperchainWETH.ts#L41) diff --git a/packages/viem/docs/type-aliases/MessageIdentifier.md b/packages/viem/docs/type-aliases/MessageIdentifier.md index 8544c142..91193af9 100644 --- a/packages/viem/docs/type-aliases/MessageIdentifier.md +++ b/packages/viem/docs/type-aliases/MessageIdentifier.md @@ -44,4 +44,4 @@ The timestamp that the log was emitted. Used to enforce the timestamp invariant ## Defined in -[packages/viem/src/types/interop.ts:7](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/types/interop.ts#L7) +[packages/viem/src/types/interop.ts:7](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/types/interop.ts#L7) diff --git a/packages/viem/docs/type-aliases/RelayL2ToL2MessageContractReturnType.md b/packages/viem/docs/type-aliases/RelayL2ToL2MessageContractReturnType.md index 2cf35ada..03c79429 100644 --- a/packages/viem/docs/type-aliases/RelayL2ToL2MessageContractReturnType.md +++ b/packages/viem/docs/type-aliases/RelayL2ToL2MessageContractReturnType.md @@ -6,8 +6,8 @@ # RelayL2ToL2MessageContractReturnType -> **RelayL2ToL2MessageContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`l2ToL2CrossDomainMessengerABI`](../variables/l2ToL2CrossDomainMessengerABI.md), `"payable"`, `"relayMessage"`\> +> **RelayL2ToL2MessageContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`l2ToL2CrossDomainMessengerAbi`](../variables/l2ToL2CrossDomainMessengerAbi.md), `"payable"`, `"relayMessage"`\> ## Defined in -[packages/viem/src/actions/relayL2ToL2Message.ts:53](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L53) +[packages/viem/src/actions/relayL2ToL2Message.ts:53](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L53) diff --git a/packages/viem/docs/type-aliases/RelayL2ToL2MessageErrorType.md b/packages/viem/docs/type-aliases/RelayL2ToL2MessageErrorType.md index b997e610..22a133a2 100644 --- a/packages/viem/docs/type-aliases/RelayL2ToL2MessageErrorType.md +++ b/packages/viem/docs/type-aliases/RelayL2ToL2MessageErrorType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/relayL2ToL2Message.ts:62](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L62) +[packages/viem/src/actions/relayL2ToL2Message.ts:62](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L62) diff --git a/packages/viem/docs/type-aliases/RelayL2ToL2MessageParameters.md b/packages/viem/docs/type-aliases/RelayL2ToL2MessageParameters.md index 979e468d..58193a4e 100644 --- a/packages/viem/docs/type-aliases/RelayL2ToL2MessageParameters.md +++ b/packages/viem/docs/type-aliases/RelayL2ToL2MessageParameters.md @@ -34,4 +34,4 @@ MessagePayload of the SentMessage event * ## Defined in -[packages/viem/src/actions/relayL2ToL2Message.ts:28](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L28) +[packages/viem/src/actions/relayL2ToL2Message.ts:28](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L28) diff --git a/packages/viem/docs/type-aliases/RelayL2ToL2MessageReturnType.md b/packages/viem/docs/type-aliases/RelayL2ToL2MessageReturnType.md index 04eb2f28..4c55302e 100644 --- a/packages/viem/docs/type-aliases/RelayL2ToL2MessageReturnType.md +++ b/packages/viem/docs/type-aliases/RelayL2ToL2MessageReturnType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/relayL2ToL2Message.ts:48](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/relayL2ToL2Message.ts#L48) +[packages/viem/src/actions/relayL2ToL2Message.ts:48](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/relayL2ToL2Message.ts#L48) diff --git a/packages/viem/docs/type-aliases/SendL2ToL2MessageContractReturnType.md b/packages/viem/docs/type-aliases/SendL2ToL2MessageContractReturnType.md index c18034a3..faf15b41 100644 --- a/packages/viem/docs/type-aliases/SendL2ToL2MessageContractReturnType.md +++ b/packages/viem/docs/type-aliases/SendL2ToL2MessageContractReturnType.md @@ -6,8 +6,8 @@ # SendL2ToL2MessageContractReturnType -> **SendL2ToL2MessageContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`l2ToL2CrossDomainMessengerABI`](../variables/l2ToL2CrossDomainMessengerABI.md), `"nonpayable"`, `"sendMessage"`\> +> **SendL2ToL2MessageContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`l2ToL2CrossDomainMessengerAbi`](../variables/l2ToL2CrossDomainMessengerAbi.md), `"nonpayable"`, `"sendMessage"`\> ## Defined in -[packages/viem/src/actions/sendL2ToL2Message.ts:55](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L55) +[packages/viem/src/actions/sendL2ToL2Message.ts:55](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L55) diff --git a/packages/viem/docs/type-aliases/SendL2ToL2MessageErrorType.md b/packages/viem/docs/type-aliases/SendL2ToL2MessageErrorType.md index c33a332b..74af9316 100644 --- a/packages/viem/docs/type-aliases/SendL2ToL2MessageErrorType.md +++ b/packages/viem/docs/type-aliases/SendL2ToL2MessageErrorType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/sendL2ToL2Message.ts:64](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L64) +[packages/viem/src/actions/sendL2ToL2Message.ts:64](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L64) diff --git a/packages/viem/docs/type-aliases/SendL2ToL2MessageParameters.md b/packages/viem/docs/type-aliases/SendL2ToL2MessageParameters.md index 7c3cbf55..e3226296 100644 --- a/packages/viem/docs/type-aliases/SendL2ToL2MessageParameters.md +++ b/packages/viem/docs/type-aliases/SendL2ToL2MessageParameters.md @@ -40,4 +40,4 @@ Target contract or wallet address. ## Defined in -[packages/viem/src/actions/sendL2ToL2Message.ts:28](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L28) +[packages/viem/src/actions/sendL2ToL2Message.ts:28](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L28) diff --git a/packages/viem/docs/type-aliases/SendL2ToL2MessageReturnType.md b/packages/viem/docs/type-aliases/SendL2ToL2MessageReturnType.md index b3c3f8b5..b7b95bc2 100644 --- a/packages/viem/docs/type-aliases/SendL2ToL2MessageReturnType.md +++ b/packages/viem/docs/type-aliases/SendL2ToL2MessageReturnType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/sendL2ToL2Message.ts:50](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendL2ToL2Message.ts#L50) +[packages/viem/src/actions/sendL2ToL2Message.ts:50](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendL2ToL2Message.ts#L50) diff --git a/packages/viem/docs/type-aliases/SendSupERC20ContractReturnType.md b/packages/viem/docs/type-aliases/SendSupERC20ContractReturnType.md deleted file mode 100644 index 10b655bd..00000000 --- a/packages/viem/docs/type-aliases/SendSupERC20ContractReturnType.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / SendSupERC20ContractReturnType - -# SendSupERC20ContractReturnType - -> **SendSupERC20ContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainTokenBridgeABI`](../variables/superchainTokenBridgeABI.md), `"nonpayable"`, `"sendERC20"`\> - -## Defined in - -[packages/viem/src/actions/sendSupERC20.ts:56](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L56) diff --git a/packages/viem/docs/type-aliases/SendSupERC20ErrorType.md b/packages/viem/docs/type-aliases/SendSupERC20ErrorType.md deleted file mode 100644 index ab37498f..00000000 --- a/packages/viem/docs/type-aliases/SendSupERC20ErrorType.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / SendSupERC20ErrorType - -# SendSupERC20ErrorType - -> **SendSupERC20ErrorType**: `EstimateContractGasErrorType` \| `WriteContractErrorType` \| `ErrorType` - -## Defined in - -[packages/viem/src/actions/sendSupERC20.ts:65](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L65) diff --git a/packages/viem/docs/type-aliases/SendSupERC20ReturnType.md b/packages/viem/docs/type-aliases/SendSupERC20ReturnType.md deleted file mode 100644 index 2517618e..00000000 --- a/packages/viem/docs/type-aliases/SendSupERC20ReturnType.md +++ /dev/null @@ -1,13 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / SendSupERC20ReturnType - -# SendSupERC20ReturnType - -> **SendSupERC20ReturnType**: `Hash` - -## Defined in - -[packages/viem/src/actions/sendSupERC20.ts:51](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L51) diff --git a/packages/viem/docs/type-aliases/SendSuperchainERC20ContractReturnType.md b/packages/viem/docs/type-aliases/SendSuperchainERC20ContractReturnType.md new file mode 100644 index 00000000..99559216 --- /dev/null +++ b/packages/viem/docs/type-aliases/SendSuperchainERC20ContractReturnType.md @@ -0,0 +1,13 @@ +[**@eth-optimism/viem**](../README.md) • **Docs** + +*** + +[@eth-optimism/viem](../README.md) / SendSuperchainERC20ContractReturnType + +# SendSuperchainERC20ContractReturnType + +> **SendSuperchainERC20ContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainTokenBridgeAbi`](../variables/superchainTokenBridgeAbi.md), `"nonpayable"`, `"sendERC20"`\> + +## Defined in + +[packages/viem/src/actions/sendSuperchainERC20.ts:56](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L56) diff --git a/packages/viem/docs/type-aliases/SendSuperchainERC20ErrorType.md b/packages/viem/docs/type-aliases/SendSuperchainERC20ErrorType.md new file mode 100644 index 00000000..a982d520 --- /dev/null +++ b/packages/viem/docs/type-aliases/SendSuperchainERC20ErrorType.md @@ -0,0 +1,13 @@ +[**@eth-optimism/viem**](../README.md) • **Docs** + +*** + +[@eth-optimism/viem](../README.md) / SendSuperchainERC20ErrorType + +# SendSuperchainERC20ErrorType + +> **SendSuperchainERC20ErrorType**: `EstimateContractGasErrorType` \| `WriteContractErrorType` \| `ErrorType` + +## Defined in + +[packages/viem/src/actions/sendSuperchainERC20.ts:65](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L65) diff --git a/packages/viem/docs/type-aliases/SendSupERC20Parameters.md b/packages/viem/docs/type-aliases/SendSuperchainERC20Parameters.md similarity index 56% rename from packages/viem/docs/type-aliases/SendSupERC20Parameters.md rename to packages/viem/docs/type-aliases/SendSuperchainERC20Parameters.md index 8fda46a6..81c6d21b 100644 --- a/packages/viem/docs/type-aliases/SendSupERC20Parameters.md +++ b/packages/viem/docs/type-aliases/SendSuperchainERC20Parameters.md @@ -2,11 +2,11 @@ *** -[@eth-optimism/viem](../README.md) / SendSupERC20Parameters +[@eth-optimism/viem](../README.md) / SendSuperchainERC20Parameters -# SendSupERC20Parameters\ +# SendSuperchainERC20Parameters\ -> **SendSupERC20Parameters**\<`TChain`, `TAccount`, `TChainOverride`, `TDerivedChain`\>: `BaseWriteContractActionParameters`\<`TChain`, `TAccount`, `TChainOverride`, `TDerivedChain`\> & `object` +> **SendSuperchainERC20Parameters**\<`TChain`, `TAccount`, `TChainOverride`, `TDerivedChain`\>: `BaseWriteContractActionParameters`\<`TChain`, `TAccount`, `TChainOverride`, `TDerivedChain`\> & `object` ## Type declaration @@ -46,4 +46,4 @@ Token to send. ## Defined in -[packages/viem/src/actions/sendSupERC20.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSupERC20.ts#L27) +[packages/viem/src/actions/sendSuperchainERC20.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L27) diff --git a/packages/viem/docs/type-aliases/SendSuperchainERC20ReturnType.md b/packages/viem/docs/type-aliases/SendSuperchainERC20ReturnType.md new file mode 100644 index 00000000..6b9e785e --- /dev/null +++ b/packages/viem/docs/type-aliases/SendSuperchainERC20ReturnType.md @@ -0,0 +1,13 @@ +[**@eth-optimism/viem**](../README.md) • **Docs** + +*** + +[@eth-optimism/viem](../README.md) / SendSuperchainERC20ReturnType + +# SendSuperchainERC20ReturnType + +> **SendSuperchainERC20ReturnType**: `Hash` + +## Defined in + +[packages/viem/src/actions/sendSuperchainERC20.ts:51](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainERC20.ts#L51) diff --git a/packages/viem/docs/type-aliases/SendSuperchainWETHParameters.md b/packages/viem/docs/type-aliases/SendSuperchainWETHParameters.md index ad4ae887..a473b3e4 100644 --- a/packages/viem/docs/type-aliases/SendSuperchainWETHParameters.md +++ b/packages/viem/docs/type-aliases/SendSuperchainWETHParameters.md @@ -40,4 +40,4 @@ Address to send tokens to. ## Defined in -[packages/viem/src/actions/sendSuperchainWETH.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/sendSuperchainWETH.ts#L27) +[packages/viem/src/actions/sendSuperchainWETH.ts:27](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/sendSuperchainWETH.ts#L27) diff --git a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHContractReturnType.md b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHContractReturnType.md index 8ef58c16..b3214026 100644 --- a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHContractReturnType.md +++ b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHContractReturnType.md @@ -6,8 +6,8 @@ # WithdrawSuperchainWETHContractReturnType -> **WithdrawSuperchainWETHContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainWETHABI`](../variables/superchainWETHABI.md), `"nonpayable"`, `"withdraw"`\> +> **WithdrawSuperchainWETHContractReturnType**: `ContractFunctionReturnType`\<*typeof* [`superchainWETHAbi`](../variables/superchainWETHAbi.md), `"nonpayable"`, `"withdraw"`\> ## Defined in -[packages/viem/src/actions/withdrawSuperchainWETH.ts:49](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L49) +[packages/viem/src/actions/withdrawSuperchainWETH.ts:49](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L49) diff --git a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHErrorType.md b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHErrorType.md index 180b2a52..aa9d467c 100644 --- a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHErrorType.md +++ b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHErrorType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/withdrawSuperchainWETH.ts:55](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L55) +[packages/viem/src/actions/withdrawSuperchainWETH.ts:55](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L55) diff --git a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHParameters.md b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHParameters.md index 1d406514..0b02ad89 100644 --- a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHParameters.md +++ b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHParameters.md @@ -28,4 +28,4 @@ Amount of SuperchainWETH to withdraw. ## Defined in -[packages/viem/src/actions/withdrawSuperchainWETH.ts:26](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L26) +[packages/viem/src/actions/withdrawSuperchainWETH.ts:26](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L26) diff --git a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHReturnType.md b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHReturnType.md index c2733903..f085e54e 100644 --- a/packages/viem/docs/type-aliases/WithdrawSuperchainWETHReturnType.md +++ b/packages/viem/docs/type-aliases/WithdrawSuperchainWETHReturnType.md @@ -10,4 +10,4 @@ ## Defined in -[packages/viem/src/actions/withdrawSuperchainWETH.ts:44](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/actions/withdrawSuperchainWETH.ts#L44) +[packages/viem/src/actions/withdrawSuperchainWETH.ts:44](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/actions/withdrawSuperchainWETH.ts#L44) diff --git a/packages/viem/docs/variables/contracts.md b/packages/viem/docs/variables/contracts.md index 885d9788..8eadc4d0 100644 --- a/packages/viem/docs/variables/contracts.md +++ b/packages/viem/docs/variables/contracts.md @@ -94,4 +94,4 @@ OP Stack Predeploy Addresses ## Defined in -[packages/viem/src/contracts.ts:8](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/contracts.ts#L8) +[packages/viem/src/contracts.ts:8](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/contracts.ts#L8) diff --git a/packages/viem/docs/variables/crossL2InboxABI.md b/packages/viem/docs/variables/crossL2InboxABI.md index d67b863d..53549f5c 100644 --- a/packages/viem/docs/variables/crossL2InboxABI.md +++ b/packages/viem/docs/variables/crossL2InboxABI.md @@ -2,14 +2,14 @@ *** -[@eth-optimism/viem](../README.md) / crossL2InboxABI +[@eth-optimism/viem](../README.md) / crossL2InboxAbi -# crossL2InboxABI +# crossL2InboxAbi -> `const` **crossL2InboxABI**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] +> `const` **crossL2InboxAbi**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] ABI for the OP Stack contract `CrossL2Inbox` ## Defined in -[packages/viem/src/abis.ts:7](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/abis.ts#L7) +[packages/viem/src/abis.ts:7](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/abis.ts#L7) diff --git a/packages/viem/docs/variables/l2ToL2CrossDomainMessengerABI.md b/packages/viem/docs/variables/l2ToL2CrossDomainMessengerABI.md index eada3c98..5f482263 100644 --- a/packages/viem/docs/variables/l2ToL2CrossDomainMessengerABI.md +++ b/packages/viem/docs/variables/l2ToL2CrossDomainMessengerABI.md @@ -2,14 +2,14 @@ *** -[@eth-optimism/viem](../README.md) / l2ToL2CrossDomainMessengerABI +[@eth-optimism/viem](../README.md) / l2ToL2CrossDomainMessengerAbi -# l2ToL2CrossDomainMessengerABI +# l2ToL2CrossDomainMessengerAbi -> `const` **l2ToL2CrossDomainMessengerABI**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] +> `const` **l2ToL2CrossDomainMessengerAbi**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] ABI for the OP Stack contract `L2ToL2CrossDomainMessenger` ## Defined in -[packages/viem/src/abis.ts:293](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/abis.ts#L293) +[packages/viem/src/abis.ts:228](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/abis.ts#L228) diff --git a/packages/viem/docs/variables/superchainERC20ABI.md b/packages/viem/docs/variables/superchainERC20ABI.md index e6635a8e..53d4a82d 100644 --- a/packages/viem/docs/variables/superchainERC20ABI.md +++ b/packages/viem/docs/variables/superchainERC20ABI.md @@ -2,14 +2,14 @@ *** -[@eth-optimism/viem](../README.md) / superchainERC20ABI +[@eth-optimism/viem](../README.md) / superchainERC20Abi -# superchainERC20ABI +# superchainERC20Abi -> `const` **superchainERC20ABI**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] +> `const` **superchainERC20Abi**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] ABI for the OP Stack contract `SuperchainERC20` ## Defined in -[packages/viem/src/abis.ts:1135](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/abis.ts#L1135) +[packages/viem/src/abis.ts:528](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/abis.ts#L528) diff --git a/packages/viem/docs/variables/superchainTokenBridgeABI.md b/packages/viem/docs/variables/superchainTokenBridgeABI.md index 6e7d2c2d..4cb0cef7 100644 --- a/packages/viem/docs/variables/superchainTokenBridgeABI.md +++ b/packages/viem/docs/variables/superchainTokenBridgeABI.md @@ -2,14 +2,14 @@ *** -[@eth-optimism/viem](../README.md) / superchainTokenBridgeABI +[@eth-optimism/viem](../README.md) / superchainTokenBridgeAbi -# superchainTokenBridgeABI +# superchainTokenBridgeAbi -> `const` **superchainTokenBridgeABI**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] +> `const` **superchainTokenBridgeAbi**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] ABI for the OP Stack contract `SuperchainTokenBridge` ## Defined in -[packages/viem/src/abis.ts:1602](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/abis.ts#L1602) +[packages/viem/src/abis.ts:1537](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/abis.ts#L1537) diff --git a/packages/viem/docs/variables/superchainWETHABI.md b/packages/viem/docs/variables/superchainWETHABI.md index baeba840..11ad62e0 100644 --- a/packages/viem/docs/variables/superchainWETHABI.md +++ b/packages/viem/docs/variables/superchainWETHABI.md @@ -2,14 +2,14 @@ *** -[@eth-optimism/viem](../README.md) / superchainWETHABI +[@eth-optimism/viem](../README.md) / superchainWETHAbi -# superchainWETHABI +# superchainWETHAbi -> `const` **superchainWETHABI**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] +> `const` **superchainWETHAbi**: readonly [`object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`] ABI for the OP Stack contract `SuperchainWETH` ## Defined in -[packages/viem/src/abis.ts:593](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/abis.ts#L593) +[packages/viem/src/abis.ts:995](https://github.com/ethereum-optimism/ecosystem/blob/6d6302cd415cfc874f1d86fa22a309bdd9314531/packages/viem/src/abis.ts#L995) diff --git a/packages/viem/docs/variables/supersimL1.md b/packages/viem/docs/variables/supersimL1.md deleted file mode 100644 index f3524a8a..00000000 --- a/packages/viem/docs/variables/supersimL1.md +++ /dev/null @@ -1,155 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / supersimL1 - -# supersimL1 - -> `const` **supersimL1**: `object` - -L1 chain definition for supersim in non-forked mode - -## Type declaration - -### blockExplorers - -> **blockExplorers**: `object` - -Collection of block explorers - -### blockExplorers.default - -> `readonly` **default**: `object` - -### blockExplorers.default.apiUrl - -> `readonly` **apiUrl**: `"https://api.etherscan.io/api"` - -### blockExplorers.default.name - -> `readonly` **name**: `"Etherscan"` - -### blockExplorers.default.url - -> `readonly` **url**: `"https://etherscan.io"` - -### contracts - -> **contracts**: `object` - -Collection of contracts - -### contracts.ensRegistry - -> `readonly` **ensRegistry**: `object` - -### contracts.ensRegistry.address - -> `readonly` **address**: `"0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"` - -### contracts.ensUniversalResolver - -> `readonly` **ensUniversalResolver**: `object` - -### contracts.ensUniversalResolver.address - -> `readonly` **address**: `"0xce01f8eee7E479C928F8919abD53E553a36CeF67"` - -### contracts.ensUniversalResolver.blockCreated - -> `readonly` **blockCreated**: `19258213` - -### contracts.multicall3 - -> `readonly` **multicall3**: `object` - -### contracts.multicall3.address - -> `readonly` **address**: `"0xca11bde05977b3631167028862be2a173976ca11"` - -### contracts.multicall3.blockCreated - -> `readonly` **blockCreated**: `14353601` - -### custom? - -> `optional` **custom**: `Record`\<`string`, `unknown`\> - -Custom chain data. - -### fees? - -> `optional` **fees**: `ChainFees`\<`undefined`\> - -Modifies how fees are derived. - -### formatters? - -> `readonly` `optional` **formatters**: `undefined` - -### id - -> **id**: `900` - -ID in number form - -### name - -> **name**: `"Supersim L1"` - -Human-readable name - -### nativeCurrency - -> **nativeCurrency**: `object` - -Currency used by chain - -### nativeCurrency.decimals - -> `readonly` **decimals**: `18` - -### nativeCurrency.name - -> `readonly` **name**: `"Ether"` - -### nativeCurrency.symbol - -> `readonly` **symbol**: `"ETH"` - -### rpcUrls - -> **rpcUrls**: `object` - -Collection of RPC endpoints - -### rpcUrls.default - -> `readonly` **default**: `object` - -### rpcUrls.default.http - -> `readonly` **http**: readonly [`"http://127.0.0.1:8545"`] - -### serializers? - -> `optional` **serializers**: `ChainSerializers`\<`undefined`, `TransactionSerializable`\<`bigint`, `number`\>\> - -Modifies how data is serialized (e.g. transactions). - -### sourceId? - -> `optional` **sourceId**: `number` - -Source Chain ID (ie. the L1 chain) - -### testnet - -> **testnet**: `true` - -Flag for test networks - -## Defined in - -[packages/viem/src/chains/supersim.ts:8](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/chains/supersim.ts#L8) diff --git a/packages/viem/docs/variables/supersimL2A.md b/packages/viem/docs/variables/supersimL2A.md deleted file mode 100644 index 12462add..00000000 --- a/packages/viem/docs/variables/supersimL2A.md +++ /dev/null @@ -1,507 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / supersimL2A - -# supersimL2A - -> `const` **supersimL2A**: `object` - -L2 chain A definition for supersim in non-forked mode. Interop Enabled - -## Type declaration - -### blockExplorers - -> **blockExplorers**: `object` - -Collection of block explorers - -### blockExplorers.default - -> `readonly` **default**: `object` - -### blockExplorers.default.apiUrl - -> `readonly` **apiUrl**: `"https://api-optimistic.etherscan.io/api"` - -### blockExplorers.default.name - -> `readonly` **name**: `"Optimism Explorer"` - -### blockExplorers.default.url - -> `readonly` **url**: `"https://optimistic.etherscan.io"` - -### contracts - -> **contracts**: `object` - -Collection of contracts - -### contracts.disputeGameFactory - -> `readonly` **disputeGameFactory**: `object` - -### contracts.disputeGameFactory.1 - -> `readonly` **1**: `object` - -### contracts.disputeGameFactory.1.address - -> `readonly` **address**: `"0xe5965Ab5962eDc7477C8520243A95517CD252fA9"` - -### contracts.gasPriceOracle - -> `readonly` **gasPriceOracle**: `object` - -### contracts.gasPriceOracle.address - -> `readonly` **address**: `"0x420000000000000000000000000000000000000F"` - -### contracts.l1Block - -> `readonly` **l1Block**: `object` - -### contracts.l1Block.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000015"` - -### contracts.l1StandardBridge - -> `readonly` **l1StandardBridge**: `object` - -### contracts.l1StandardBridge.1 - -> `readonly` **1**: `object` - -### contracts.l1StandardBridge.1.address - -> `readonly` **address**: `"0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1"` - -### contracts.l2CrossDomainMessenger - -> `readonly` **l2CrossDomainMessenger**: `object` - -### contracts.l2CrossDomainMessenger.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000007"` - -### contracts.l2Erc721Bridge - -> `readonly` **l2Erc721Bridge**: `object` - -### contracts.l2Erc721Bridge.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000014"` - -### contracts.l2OutputOracle - -> `readonly` **l2OutputOracle**: `object` - -### contracts.l2OutputOracle.1 - -> `readonly` **1**: `object` - -### contracts.l2OutputOracle.1.address - -> `readonly` **address**: `"0xdfe97868233d1aa22e815a266982f2cf17685a27"` - -### contracts.l2StandardBridge - -> `readonly` **l2StandardBridge**: `object` - -### contracts.l2StandardBridge.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000010"` - -### contracts.l2ToL1MessagePasser - -> `readonly` **l2ToL1MessagePasser**: `object` - -### contracts.l2ToL1MessagePasser.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000016"` - -### contracts.multicall3 - -> `readonly` **multicall3**: `object` - -### contracts.multicall3.address - -> `readonly` **address**: `"0xca11bde05977b3631167028862be2a173976ca11"` - -### contracts.multicall3.blockCreated - -> `readonly` **blockCreated**: `4286263` - -### contracts.portal - -> `readonly` **portal**: `object` - -### contracts.portal.1 - -> `readonly` **1**: `object` - -### contracts.portal.1.address - -> `readonly` **address**: `"0xbEb5Fc579115071764c7423A4f12eDde41f106Ed"` - -### custom? - -> `optional` **custom**: `Record`\<`string`, `unknown`\> - -Custom chain data. - -### fees? - -> `optional` **fees**: `ChainFees`\<`undefined`\> - -Modifies how fees are derived. - -### formatters - -> **formatters**: `object` - -Modifies how data is formatted and typed (e.g. blocks and transactions) - -### formatters.block - -> `readonly` **block**: `object` - -### formatters.block.exclude - -> **exclude**: `undefined` \| [] - -### formatters.block.format() - -> **format**: (`args`) => `object` - -#### Parameters - -• **args**: `OpStackRpcBlock`\<`BlockTag`, `boolean`\> - -#### Returns - -`object` - -##### baseFeePerGas - -> **baseFeePerGas**: `null` \| `bigint` - -##### blobGasUsed - -> **blobGasUsed**: `bigint` - -##### difficulty - -> **difficulty**: `bigint` - -##### excessBlobGas - -> **excessBlobGas**: `bigint` - -##### extraData - -> **extraData**: \`0x$\{string\}\` - -##### gasLimit - -> **gasLimit**: `bigint` - -##### gasUsed - -> **gasUsed**: `bigint` - -##### hash - -> **hash**: `null` \| \`0x$\{string\}\` - -##### logsBloom - -> **logsBloom**: `null` \| \`0x$\{string\}\` - -##### miner - -> **miner**: \`0x$\{string\}\` - -##### mixHash - -> **mixHash**: \`0x$\{string\}\` - -##### nonce - -> **nonce**: `null` \| \`0x$\{string\}\` - -##### number - -> **number**: `null` \| `bigint` - -##### parentHash - -> **parentHash**: \`0x$\{string\}\` - -##### receiptsRoot - -> **receiptsRoot**: \`0x$\{string\}\` - -##### sealFields - -> **sealFields**: \`0x$\{string\}\`[] - -##### sha3Uncles - -> **sha3Uncles**: \`0x$\{string\}\` - -##### size - -> **size**: `bigint` - -##### stateRoot - -> **stateRoot**: \`0x$\{string\}\` - -##### timestamp - -> **timestamp**: `bigint` - -##### totalDifficulty - -> **totalDifficulty**: `null` \| `bigint` - -##### transactions - -> **transactions**: \`0x$\{string\}\`[] \| `OpStackTransaction`\<`boolean`\>[] - -##### transactionsRoot - -> **transactionsRoot**: \`0x$\{string\}\` - -##### uncles - -> **uncles**: \`0x$\{string\}\`[] - -##### withdrawals? - -> `optional` **withdrawals**: `Withdrawal`[] - -##### withdrawalsRoot? - -> `optional` **withdrawalsRoot**: \`0x$\{string\}\` - -### formatters.block.type - -> **type**: `"block"` - -### formatters.transaction - -> `readonly` **transaction**: `object` - -### formatters.transaction.exclude - -> **exclude**: `undefined` \| [] - -### formatters.transaction.format() - -> **format**: (`args`) => `object` \| `object` \| `object` \| `object` \| `object` - -#### Parameters - -• **args**: `OpStackRpcTransaction`\<`boolean`\> - -#### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### formatters.transaction.type - -> **type**: `"transaction"` - -### formatters.transactionReceipt - -> `readonly` **transactionReceipt**: `object` - -### formatters.transactionReceipt.exclude - -> **exclude**: `undefined` \| [] - -### formatters.transactionReceipt.format() - -> **format**: (`args`) => `object` - -#### Parameters - -• **args**: `OpStackRpcTransactionReceipt` - -#### Returns - -`object` - -##### blobGasPrice? - -> `optional` **blobGasPrice**: `bigint` - -##### blobGasUsed? - -> `optional` **blobGasUsed**: `bigint` - -##### blockHash - -> **blockHash**: \`0x$\{string\}\` - -##### blockNumber - -> **blockNumber**: `bigint` - -##### contractAddress - -> **contractAddress**: `undefined` \| `null` \| \`0x$\{string\}\` - -##### cumulativeGasUsed - -> **cumulativeGasUsed**: `bigint` - -##### effectiveGasPrice - -> **effectiveGasPrice**: `bigint` - -##### from - -> **from**: \`0x$\{string\}\` - -##### gasUsed - -> **gasUsed**: `bigint` - -##### l1Fee - -> **l1Fee**: `null` \| `bigint` - -##### l1FeeScalar - -> **l1FeeScalar**: `null` \| `number` - -##### l1GasPrice - -> **l1GasPrice**: `null` \| `bigint` - -##### l1GasUsed - -> **l1GasUsed**: `null` \| `bigint` - -##### logs - -> **logs**: `Log`\<`bigint`, `number`, `false`, `undefined`, `undefined`, `undefined`, `undefined`\>[] - -##### logsBloom - -> **logsBloom**: \`0x$\{string\}\` - -##### root? - -> `optional` **root**: \`0x$\{string\}\` - -##### status - -> **status**: `"success"` \| `"reverted"` - -##### to - -> **to**: `null` \| \`0x$\{string\}\` - -##### transactionHash - -> **transactionHash**: \`0x$\{string\}\` - -##### transactionIndex - -> **transactionIndex**: `number` - -##### type - -> **type**: `TransactionType` - -### formatters.transactionReceipt.type - -> **type**: `"transactionReceipt"` - -### id - -> **id**: `901` - -ID in number form - -### name - -> **name**: `"Supersim L2 A"` - -Human-readable name - -### nativeCurrency - -> **nativeCurrency**: `object` - -Currency used by chain - -### nativeCurrency.decimals - -> `readonly` **decimals**: `18` - -### nativeCurrency.name - -> `readonly` **name**: `"Ether"` - -### nativeCurrency.symbol - -> `readonly` **symbol**: `"ETH"` - -### rpcUrls - -> **rpcUrls**: `object` - -Collection of RPC endpoints - -### rpcUrls.default - -> `readonly` **default**: `object` - -### rpcUrls.default.http - -> `readonly` **http**: readonly [`"http://127.0.0.1:9545"`] - -### serializers - -> **serializers**: `object` - -Modifies how data is serialized (e.g. transactions). - -### serializers.transaction() - -> `readonly` **transaction**: (`transaction`, `signature`?) => \`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy` \| \`0x7e$\{string\}\` - -#### Parameters - -• **transaction**: `OpStackTransactionSerializable` - -• **signature?**: `Signature` - -#### Returns - -\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy` \| \`0x7e$\{string\}\` - -### sourceId - -> **sourceId**: `900` - -Source Chain ID (ie. the L1 chain) - -### testnet - -> **testnet**: `true` - -Flag for test networks - -## Defined in - -[packages/viem/src/chains/supersim.ts:24](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/chains/supersim.ts#L24) diff --git a/packages/viem/docs/variables/supersimL2B.md b/packages/viem/docs/variables/supersimL2B.md deleted file mode 100644 index efc3d3a7..00000000 --- a/packages/viem/docs/variables/supersimL2B.md +++ /dev/null @@ -1,507 +0,0 @@ -[**@eth-optimism/viem**](../README.md) • **Docs** - -*** - -[@eth-optimism/viem](../README.md) / supersimL2B - -# supersimL2B - -> `const` **supersimL2B**: `object` - -L2 chain B definition for supersim in non-forked mode. Interop Enabled - -## Type declaration - -### blockExplorers - -> **blockExplorers**: `object` - -Collection of block explorers - -### blockExplorers.default - -> `readonly` **default**: `object` - -### blockExplorers.default.apiUrl - -> `readonly` **apiUrl**: `"https://api-optimistic.etherscan.io/api"` - -### blockExplorers.default.name - -> `readonly` **name**: `"Optimism Explorer"` - -### blockExplorers.default.url - -> `readonly` **url**: `"https://optimistic.etherscan.io"` - -### contracts - -> **contracts**: `object` - -Collection of contracts - -### contracts.disputeGameFactory - -> `readonly` **disputeGameFactory**: `object` - -### contracts.disputeGameFactory.1 - -> `readonly` **1**: `object` - -### contracts.disputeGameFactory.1.address - -> `readonly` **address**: `"0xe5965Ab5962eDc7477C8520243A95517CD252fA9"` - -### contracts.gasPriceOracle - -> `readonly` **gasPriceOracle**: `object` - -### contracts.gasPriceOracle.address - -> `readonly` **address**: `"0x420000000000000000000000000000000000000F"` - -### contracts.l1Block - -> `readonly` **l1Block**: `object` - -### contracts.l1Block.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000015"` - -### contracts.l1StandardBridge - -> `readonly` **l1StandardBridge**: `object` - -### contracts.l1StandardBridge.1 - -> `readonly` **1**: `object` - -### contracts.l1StandardBridge.1.address - -> `readonly` **address**: `"0x99C9fc46f92E8a1c0deC1b1747d010903E884bE1"` - -### contracts.l2CrossDomainMessenger - -> `readonly` **l2CrossDomainMessenger**: `object` - -### contracts.l2CrossDomainMessenger.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000007"` - -### contracts.l2Erc721Bridge - -> `readonly` **l2Erc721Bridge**: `object` - -### contracts.l2Erc721Bridge.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000014"` - -### contracts.l2OutputOracle - -> `readonly` **l2OutputOracle**: `object` - -### contracts.l2OutputOracle.1 - -> `readonly` **1**: `object` - -### contracts.l2OutputOracle.1.address - -> `readonly` **address**: `"0xdfe97868233d1aa22e815a266982f2cf17685a27"` - -### contracts.l2StandardBridge - -> `readonly` **l2StandardBridge**: `object` - -### contracts.l2StandardBridge.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000010"` - -### contracts.l2ToL1MessagePasser - -> `readonly` **l2ToL1MessagePasser**: `object` - -### contracts.l2ToL1MessagePasser.address - -> `readonly` **address**: `"0x4200000000000000000000000000000000000016"` - -### contracts.multicall3 - -> `readonly` **multicall3**: `object` - -### contracts.multicall3.address - -> `readonly` **address**: `"0xca11bde05977b3631167028862be2a173976ca11"` - -### contracts.multicall3.blockCreated - -> `readonly` **blockCreated**: `4286263` - -### contracts.portal - -> `readonly` **portal**: `object` - -### contracts.portal.1 - -> `readonly` **1**: `object` - -### contracts.portal.1.address - -> `readonly` **address**: `"0xbEb5Fc579115071764c7423A4f12eDde41f106Ed"` - -### custom? - -> `optional` **custom**: `Record`\<`string`, `unknown`\> - -Custom chain data. - -### fees? - -> `optional` **fees**: `ChainFees`\<`undefined`\> - -Modifies how fees are derived. - -### formatters - -> **formatters**: `object` - -Modifies how data is formatted and typed (e.g. blocks and transactions) - -### formatters.block - -> `readonly` **block**: `object` - -### formatters.block.exclude - -> **exclude**: `undefined` \| [] - -### formatters.block.format() - -> **format**: (`args`) => `object` - -#### Parameters - -• **args**: `OpStackRpcBlock`\<`BlockTag`, `boolean`\> - -#### Returns - -`object` - -##### baseFeePerGas - -> **baseFeePerGas**: `null` \| `bigint` - -##### blobGasUsed - -> **blobGasUsed**: `bigint` - -##### difficulty - -> **difficulty**: `bigint` - -##### excessBlobGas - -> **excessBlobGas**: `bigint` - -##### extraData - -> **extraData**: \`0x$\{string\}\` - -##### gasLimit - -> **gasLimit**: `bigint` - -##### gasUsed - -> **gasUsed**: `bigint` - -##### hash - -> **hash**: `null` \| \`0x$\{string\}\` - -##### logsBloom - -> **logsBloom**: `null` \| \`0x$\{string\}\` - -##### miner - -> **miner**: \`0x$\{string\}\` - -##### mixHash - -> **mixHash**: \`0x$\{string\}\` - -##### nonce - -> **nonce**: `null` \| \`0x$\{string\}\` - -##### number - -> **number**: `null` \| `bigint` - -##### parentHash - -> **parentHash**: \`0x$\{string\}\` - -##### receiptsRoot - -> **receiptsRoot**: \`0x$\{string\}\` - -##### sealFields - -> **sealFields**: \`0x$\{string\}\`[] - -##### sha3Uncles - -> **sha3Uncles**: \`0x$\{string\}\` - -##### size - -> **size**: `bigint` - -##### stateRoot - -> **stateRoot**: \`0x$\{string\}\` - -##### timestamp - -> **timestamp**: `bigint` - -##### totalDifficulty - -> **totalDifficulty**: `null` \| `bigint` - -##### transactions - -> **transactions**: \`0x$\{string\}\`[] \| `OpStackTransaction`\<`boolean`\>[] - -##### transactionsRoot - -> **transactionsRoot**: \`0x$\{string\}\` - -##### uncles - -> **uncles**: \`0x$\{string\}\`[] - -##### withdrawals? - -> `optional` **withdrawals**: `Withdrawal`[] - -##### withdrawalsRoot? - -> `optional` **withdrawalsRoot**: \`0x$\{string\}\` - -### formatters.block.type - -> **type**: `"block"` - -### formatters.transaction - -> `readonly` **transaction**: `object` - -### formatters.transaction.exclude - -> **exclude**: `undefined` \| [] - -### formatters.transaction.format() - -> **format**: (`args`) => `object` \| `object` \| `object` \| `object` \| `object` - -#### Parameters - -• **args**: `OpStackRpcTransaction`\<`boolean`\> - -#### Returns - -`object` \| `object` \| `object` \| `object` \| `object` - -### formatters.transaction.type - -> **type**: `"transaction"` - -### formatters.transactionReceipt - -> `readonly` **transactionReceipt**: `object` - -### formatters.transactionReceipt.exclude - -> **exclude**: `undefined` \| [] - -### formatters.transactionReceipt.format() - -> **format**: (`args`) => `object` - -#### Parameters - -• **args**: `OpStackRpcTransactionReceipt` - -#### Returns - -`object` - -##### blobGasPrice? - -> `optional` **blobGasPrice**: `bigint` - -##### blobGasUsed? - -> `optional` **blobGasUsed**: `bigint` - -##### blockHash - -> **blockHash**: \`0x$\{string\}\` - -##### blockNumber - -> **blockNumber**: `bigint` - -##### contractAddress - -> **contractAddress**: `undefined` \| `null` \| \`0x$\{string\}\` - -##### cumulativeGasUsed - -> **cumulativeGasUsed**: `bigint` - -##### effectiveGasPrice - -> **effectiveGasPrice**: `bigint` - -##### from - -> **from**: \`0x$\{string\}\` - -##### gasUsed - -> **gasUsed**: `bigint` - -##### l1Fee - -> **l1Fee**: `null` \| `bigint` - -##### l1FeeScalar - -> **l1FeeScalar**: `null` \| `number` - -##### l1GasPrice - -> **l1GasPrice**: `null` \| `bigint` - -##### l1GasUsed - -> **l1GasUsed**: `null` \| `bigint` - -##### logs - -> **logs**: `Log`\<`bigint`, `number`, `false`, `undefined`, `undefined`, `undefined`, `undefined`\>[] - -##### logsBloom - -> **logsBloom**: \`0x$\{string\}\` - -##### root? - -> `optional` **root**: \`0x$\{string\}\` - -##### status - -> **status**: `"success"` \| `"reverted"` - -##### to - -> **to**: `null` \| \`0x$\{string\}\` - -##### transactionHash - -> **transactionHash**: \`0x$\{string\}\` - -##### transactionIndex - -> **transactionIndex**: `number` - -##### type - -> **type**: `TransactionType` - -### formatters.transactionReceipt.type - -> **type**: `"transactionReceipt"` - -### id - -> **id**: `902` - -ID in number form - -### name - -> **name**: `"Supersim L2 B"` - -Human-readable name - -### nativeCurrency - -> **nativeCurrency**: `object` - -Currency used by chain - -### nativeCurrency.decimals - -> `readonly` **decimals**: `18` - -### nativeCurrency.name - -> `readonly` **name**: `"Ether"` - -### nativeCurrency.symbol - -> `readonly` **symbol**: `"ETH"` - -### rpcUrls - -> **rpcUrls**: `object` - -Collection of RPC endpoints - -### rpcUrls.default - -> `readonly` **default**: `object` - -### rpcUrls.default.http - -> `readonly` **http**: readonly [`"http://127.0.0.1:9546"`] - -### serializers - -> **serializers**: `object` - -Modifies how data is serialized (e.g. transactions). - -### serializers.transaction() - -> `readonly` **transaction**: (`transaction`, `signature`?) => \`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy` \| \`0x7e$\{string\}\` - -#### Parameters - -• **transaction**: `OpStackTransactionSerializable` - -• **signature?**: `Signature` - -#### Returns - -\`0x02$\{string\}\` \| \`0x01$\{string\}\` \| \`0x03$\{string\}\` \| `TransactionSerializedLegacy` \| \`0x7e$\{string\}\` - -### sourceId - -> **sourceId**: `900` - -Source Chain ID (ie. the L1 chain) - -### testnet - -> **testnet**: `true` - -Flag for test networks - -## Defined in - -[packages/viem/src/chains/supersim.ts:41](https://github.com/ethereum-optimism/ecosystem/blob/1d855f26d1024617b154d28d909dbc33a421f5de/packages/viem/src/chains/supersim.ts#L41)