op-wagmi / Exports

op-wagmi

Table of contents

Type Aliases

• UseSimulateDepositERC20Parameters
• UseSimulateDepositETHParameters
• UseSimulateFinalizeWithdrawalTransactionParameters
• UseSimulateProveWithdrawalTransactionParameters
• UseSimulateWithdrawERC20Parameters
• UseSimulateWithdrawETHParameters
• UseWriteDepositERC20Parameters
• UseWriteDepositETHParameters
• UseWriteFinalizeWithdrawalTransactionParameters
• UseWriteProveWithdrawalTransactionParameters
• UseWriteWithdrawERC20Parameters
• UseWriteWithdrawETHParameters
• WriteDepositERC20Parameters
• WriteDepositETHParameters
• WriteFinalizeWithdrawalTransactionParameters
• WriteProveWithdrawalTransactionParameters
• WriteWithdrawERC20Parameters
• WriteWithdrawETHParameters

Functions

• useSimulateDepositERC20
• useSimulateDepositETH
• useSimulateFinalizeWithdrawalTransaction
• useSimulateProveWithdrawalTransaction
• useSimulateWithdrawERC20
• useSimulateWithdrawETH
• useWriteDepositERC20
• useWriteDepositETH
• useWriteFinalizeWithdrawalTransaction
• useWriteProveWithdrawalTransaction
• useWriteWithdrawERC20
• useWriteWithdrawETH

Type Aliases

UseSimulateDepositERC20Parameters

Ƭ UseSimulateDepositERC20Parameters<config, chainId>: UseSimulateOPActionBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<SimulateDepositERC20Parameters, "args">["args"], "minGasLimit"> & { minGasLimit?: number } } & { l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] | undefined = undefined

Defined in

hooks/L1/useSimulateDepositERC20.ts:14

---

UseSimulateDepositETHParameters

Ƭ UseSimulateDepositETHParameters<config, chainId>: UseSimulateOPActionBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<SimulateDepositETHParameters, "args">["args"], "gasLimit"> & { gasLimit?: number } } & { l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] | undefined = undefined

Defined in

hooks/L1/useSimulateDepositETH.ts:14

---

UseSimulateFinalizeWithdrawalTransactionParameters

Ƭ UseSimulateFinalizeWithdrawalTransactionParameters<config, chainId>: UseSimulateOPActionBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: { withdrawalTxHash: Hash } ; l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] | undefined = undefined

Defined in

hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts:17

---

UseSimulateProveWithdrawalTransactionParameters

Ƭ UseSimulateProveWithdrawalTransactionParameters<config, chainId>: UseSimulateOPActionBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: { withdrawalTxHash: Hash } ; l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] | undefined = undefined

Defined in

hooks/L1/useSimulateProveWithdrawalTransaction.ts:23

---

UseSimulateWithdrawERC20Parameters

Ƭ UseSimulateWithdrawERC20Parameters<config, chainId>: UseSimulateOPActionBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<SimulateWithdrawERC20Parameters, "args">["args"], "minGasLimit"> & { minGasLimit?: number } } & { chainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] | undefined = undefined

Defined in

hooks/L2/useSimulateWithdrawERC20.ts:15

---

UseSimulateWithdrawETHParameters

Ƭ UseSimulateWithdrawETHParameters<config, chainId>: UseSimulateOPActionBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<SimulateWithdrawETHParameters, "args">["args"], "minGasLimit"> & { minGasLimit?: number } } & { chainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] | undefined = undefined

Defined in

hooks/L2/useSimulateWithdrawETH.ts:16

---

UseWriteDepositERC20Parameters

Ƭ UseWriteDepositERC20Parameters<config, context>: UseWriteOPActionBaseParameters<config, context>

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Defined in

hooks/L1/useWriteDepositERC20.ts:23

---

UseWriteDepositETHParameters

Ƭ UseWriteDepositETHParameters<config, context>: UseWriteOPActionBaseParameters<config, context>

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Defined in

hooks/L1/useWriteDepositETH.ts:27

---

UseWriteFinalizeWithdrawalTransactionParameters

Ƭ UseWriteFinalizeWithdrawalTransactionParameters<config, context>: UseWriteOPActionBaseParameters<config, context>

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Defined in

hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:30

---

UseWriteProveWithdrawalTransactionParameters

Ƭ UseWriteProveWithdrawalTransactionParameters<config, context>: UseWriteOPActionBaseParameters<config, context>

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Defined in

hooks/L1/useWriteProveWithdrawalTransaction.ts:33

---

UseWriteWithdrawERC20Parameters

Ƭ UseWriteWithdrawERC20Parameters<config, context>: UseWriteOPActionBaseParameters<config, context>

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Defined in

hooks/L2/useWriteWithdrawERC20.ts:23

---

UseWriteWithdrawETHParameters

Ƭ UseWriteWithdrawETHParameters<config, context>: UseWriteOPActionBaseParameters<config, context>

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Defined in

hooks/L2/useWriteWithdrawETH.ts:24

---

WriteDepositERC20Parameters

Ƭ WriteDepositERC20Parameters<config, chainId>: WriteOPContractBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<WriteDepositERC20ActionParameters, "args">["args"], "minGasLimit"> & { minGasLimit?: number } } & { l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] = number

Defined in

hooks/L1/useWriteDepositERC20.ts:14

---

WriteDepositETHParameters

Ƭ WriteDepositETHParameters<config, chainId>: WriteOPContractBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<WriteDepositETHActionParameters, "args">["args"], "gasLimit"> & { gasLimit?: number } } & { l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] = number

Defined in

hooks/L1/useWriteDepositETH.ts:18

---

WriteFinalizeWithdrawalTransactionParameters

Ƭ WriteFinalizeWithdrawalTransactionParameters<config, chainId>: WriteOPContractBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: { withdrawalTxHash: Hash } ; l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] = number

Defined in

hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:20

---

WriteProveWithdrawalTransactionParameters

Ƭ WriteProveWithdrawalTransactionParameters<config, chainId>: WriteOPContractBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: { withdrawalTxHash: Hash } ; l2ChainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] = number

Defined in

hooks/L1/useWriteProveWithdrawalTransaction.ts:23

---

WriteWithdrawERC20Parameters

Ƭ WriteWithdrawERC20Parameters<config, chainId>: WriteOPContractBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<WriteWithdrawERC20ActionParameters, "args">["args"], "minGasLimit"> & { minGasLimit?: number } } & { chainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] = number

Defined in

hooks/L2/useWriteWithdrawERC20.ts:14

---

WriteWithdrawETHParameters

Ƭ WriteWithdrawETHParameters<config, chainId>: WriteOPContractBaseParameters<typeof ABI, typeof FUNCTION, config, chainId> & { args: Omit<Pick<WriteWithdrawETHActionParameters, "args">["args"], "minGasLimit"> & { minGasLimit?: number } } & { chainId: number }

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends config["chains"][number]["id"] = number

Defined in

hooks/L2/useWriteWithdrawETH.ts:15

Functions

useSimulateDepositERC20

▸ useSimulateDepositERC20<config, chainId>(parameters): UseSimulateDepositERC20ReturnType<config, chainId>

Simulates a deposit of ERC20 tokens to L2

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends undefined | number = undefined

Parameters

Name	Type	Description
parameters	UseSimulateDepositERC20Parameters<config, chainId>	UseSimulateDepositERC20Parameters

Returns

UseSimulateDepositERC20ReturnType<config, chainId>

wagmi useSimulateContract return type. UseSimulateDepositERC20ReturnType

Defined in

hooks/L1/useSimulateDepositERC20.ts:33

---

useSimulateDepositETH

▸ useSimulateDepositETH<config, chainId>(parameters): UseSimulateDepositETHReturnType<config, chainId>

Simulates a deposit of ETH to L2

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends undefined | number = undefined

Parameters

Name	Type	Description
parameters	UseSimulateDepositETHParameters<config, chainId>	UseSimulateDepositETHParameters

Returns

UseSimulateDepositETHReturnType<config, chainId>

wagmi useSimulateContract return type. UseSimulateDepositETHReturnType

Defined in

hooks/L1/useSimulateDepositETH.ts:33

---

useSimulateFinalizeWithdrawalTransaction

▸ useSimulateFinalizeWithdrawalTransaction<config, chainId>(parameters): UseSimulateFinalizeWithdrawalTransactionReturnType<config, chainId>

Simulates finalizing a withdrawal transaction.

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends undefined | number = undefined

Parameters

Name	Type	Description
parameters	UseSimulateFinalizeWithdrawalTransactionParameters<config, chainId>	UseSimulateFinalizeWithdrawalTransactionParameters

Returns

UseSimulateFinalizeWithdrawalTransactionReturnType<config, chainId>

wagmi useSimulateContract return type. UseSimulateFinalizeWithdrawalTransactionReturnType

Defined in

hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts:39

---

useSimulateProveWithdrawalTransaction

▸ useSimulateProveWithdrawalTransaction<config, chainId>(parameters): UseSimulateProveWithdrawalTransactionReturnType<config, chainId>

Simulates proving a withdrawal transaction.

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends undefined | number = undefined

Parameters

Name	Type	Description
parameters	UseSimulateProveWithdrawalTransactionParameters<config, chainId>	UseSimulateProveWithdrawalTransactionParameters

Returns

UseSimulateProveWithdrawalTransactionReturnType<config, chainId>

wagmi useSimulateContract return type. UseSimulateProveWithdrawalTransactionReturnType

Defined in

hooks/L1/useSimulateProveWithdrawalTransaction.ts:45

---

useSimulateWithdrawERC20

▸ useSimulateWithdrawERC20<config, chainId>(parameters): UseSimulateWithdrawERC20ReturnType<config, chainId>

Simulates a withdrawal of ERC20 tokens to an L1 address.

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends undefined | number = undefined

Parameters

Name	Type	Description
parameters	UseSimulateWithdrawERC20Parameters<config, chainId>	UseSimulateWithdrawERC20Parameters

Returns

UseSimulateWithdrawERC20ReturnType<config, chainId>

wagmi useSimulateContract return type. UseSimulateWithdrawERC20ReturnType

Defined in

hooks/L2/useSimulateWithdrawERC20.ts:34

---

useSimulateWithdrawETH

▸ useSimulateWithdrawETH<config, chainId>(parameters): UseSimulateWithdrawETHReturnType<config, chainId>

Simulates a withdrawal of ETH to an L1 address.

Type parameters

Name	Type
config	extends Config = OpConfig
chainId	extends undefined | number = undefined

Parameters

Name	Type	Description
parameters	UseSimulateWithdrawETHParameters<config, chainId>	UseSimulateWithdrawETHParameters

Returns

UseSimulateWithdrawETHReturnType<config, chainId>

wagmi useSimulateContract return type. UseSimulateWithdrawETHReturnType

Defined in

hooks/L2/useSimulateWithdrawETH.ts:35

---

useWriteDepositERC20

▸ useWriteDepositERC20<config, context>(args?): UseWriteDepositERC20ReturnType<config, context>

Deposits ERC20 tokens to L2 using the standard bridge

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Parameters

Name	Type
args	UseWriteDepositERC20Parameters<config, context>

Returns

UseWriteDepositERC20ReturnType<config, context>

wagmi useWriteContract return type. UseWriteDepositERC20ReturnType

Defined in

hooks/L1/useWriteDepositERC20.ts:42

---

useWriteDepositETH

▸ useWriteDepositETH<config, context>(args?): UseWriteDepositETHReturnType<config, context>

Deposits ETH to L2 using the OptimismPortal contract

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Parameters

Name	Type
args	UseWriteDepositETHParameters<config, context>

Returns

UseWriteDepositETHReturnType<config, context>

wagmi useWriteContract return type. UseWriteDepositETHReturnType

Defined in

hooks/L1/useWriteDepositETH.ts:83

---

useWriteFinalizeWithdrawalTransaction

▸ useWriteFinalizeWithdrawalTransaction<config, context>(args?): UseWriteFinalizeWithdrawalTransactionReturnType<config, context>

Deposits ETH to L2 using the OptimismPortal contract

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Parameters

Name	Type
args	UseWriteFinalizeWithdrawalTransactionParameters<config, context>

Returns

UseWriteFinalizeWithdrawalTransactionReturnType<config, context>

wagmi useWriteContract return type. UseWriteFinalizeWithdrawalTransactionReturnType

Defined in

hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:87

---

useWriteProveWithdrawalTransaction

▸ useWriteProveWithdrawalTransaction<config, context>(args?): UseWriteProveWithdrawalTransactionReturnType<config, context>

Deposits ETH to L2 using the OptimismPortal contract

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Parameters

Name	Type
args	UseWriteProveWithdrawalTransactionParameters<config, context>

Returns

UseWriteProveWithdrawalTransactionReturnType<config, context>

wagmi useWriteContract return type. UseWriteProveWithdrawalTransactionReturnType

Defined in

hooks/L1/useWriteProveWithdrawalTransaction.ts:104

---

useWriteWithdrawERC20

▸ useWriteWithdrawERC20<config, context>(args?): UseWriteWithdrawERC20ReturnType<config, context>

Withdraws ERC20 tokens to an L1 address.

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Parameters

Name	Type
args	UseWriteWithdrawERC20Parameters<config, context>

Returns

UseWriteWithdrawERC20ReturnType<config, context>

wagmi useWriteContract return type. UseWriteWithdrawERC20ReturnType

Defined in

hooks/L2/useWriteWithdrawERC20.ts:42

---

useWriteWithdrawETH

▸ useWriteWithdrawETH<config, context>(args?): UseWriteWithdrawETHReturnType<config, context>

Withdraws ETH to an L1 address.

Type parameters

Name	Type
config	extends Config = OpConfig
context	unknown

Parameters

Name	Type
args	UseWriteWithdrawETHParameters<config, context>

Returns

UseWriteWithdrawETHReturnType<config, context>

wagmi useWriteContract return type. UseWriteWithdrawETHReturnType

Defined in

hooks/L2/useWriteWithdrawETH.ts:43