diff --git a/README.md b/README.md index 2dd3b5c..a402c40 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ [![GitHub commit activity](https://img.shields.io/github/commit-activity/w/base-org/op-wagmi)](https://github.com/base-org/op-wagmi/graphs/contributors) [![GitHub Stars](https://img.shields.io/github/stars/base-org/op-wagmi.svg)](https://github.com/base-org/op-wagmi/stargazers) ![GitHub repo size](https://img.shields.io/github/repo-size/base-org/op-wagmi) -[![GitHub](https://img.shields.io/github/license/base-org/op-wagmi?color=blue)](https://github.com/base-org/op-wagmi/blob/main/LICENSE) +[![GitHub](https://img.shields.io/github/license/base-org/op-wagmi?color=blue)](/LICENSE) diff --git a/docs/index.md b/docs/index.md index fd374be..e532d69 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,4 +57,4 @@ return ( ) ``` -Check out the [example Superchain Bridge](https://github.com/base-org/op-wagmi/tree/master/example) for more. +Check out the [example Superchain Bridge](/example) for more. diff --git a/docs/reference/README.md b/docs/reference/README.md index 32d686e..f671e46 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -10,7 +10,7 @@ Wagmi hooks for OP Stack Chains [![GitHub commit activity](https://img.shields.io/github/commit-activity/w/base-org/op-wagmi)](https://github.com/base-org/op-wagmi/graphs/contributors) [![GitHub Stars](https://img.shields.io/github/stars/base-org/op-wagmi.svg)](https://github.com/base-org/op-wagmi/stargazers) ![GitHub repo size](https://img.shields.io/github/repo-size/base-org/op-wagmi) -[![GitHub](https://img.shields.io/github/license/base-org/op-wagmi?color=blue)](https://github.com/base-org/op-wagmi/blob/main/LICENSE) +[![GitHub](https://img.shields.io/github/license/base-org/op-wagmi?color=blue)](/LICENSE) diff --git a/docs/reference/modules.md b/docs/reference/modules.md index 80a9e62..3fa3660 100644 --- a/docs/reference/modules.md +++ b/docs/reference/modules.md @@ -55,7 +55,7 @@ #### Defined in -[hooks/L1/useSimulateDepositERC20.ts:14](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateDepositERC20.ts#L14) +[hooks/L1/useSimulateDepositERC20.ts:14](/src/hooks/L1/useSimulateDepositERC20.ts#L14) --- @@ -72,7 +72,7 @@ #### Defined in -[hooks/L1/useSimulateDepositETH.ts:14](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateDepositETH.ts#L14) +[hooks/L1/useSimulateDepositETH.ts:14](/src/hooks/L1/useSimulateDepositETH.ts#L14) --- @@ -89,7 +89,7 @@ #### Defined in -[hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts:17](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts#L17) +[hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts:17](/src/hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts#L17) --- @@ -106,7 +106,7 @@ #### Defined in -[hooks/L1/useSimulateProveWithdrawalTransaction.ts:23](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateProveWithdrawalTransaction.ts#L23) +[hooks/L1/useSimulateProveWithdrawalTransaction.ts:23](/src/hooks/L1/useSimulateProveWithdrawalTransaction.ts#L23) --- @@ -123,7 +123,7 @@ #### Defined in -[hooks/L2/useSimulateWithdrawERC20.ts:15](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useSimulateWithdrawERC20.ts#L15) +[hooks/L2/useSimulateWithdrawERC20.ts:15](/src/hooks/L2/useSimulateWithdrawERC20.ts#L15) --- @@ -140,7 +140,7 @@ #### Defined in -[hooks/L2/useSimulateWithdrawETH.ts:16](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useSimulateWithdrawETH.ts#L16) +[hooks/L2/useSimulateWithdrawETH.ts:16](/src/hooks/L2/useSimulateWithdrawETH.ts#L16) --- @@ -157,7 +157,7 @@ #### Defined in -[hooks/L1/useWriteDepositERC20.ts:23](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteDepositERC20.ts#L23) +[hooks/L1/useWriteDepositERC20.ts:23](/src/hooks/L1/useWriteDepositERC20.ts#L23) --- @@ -174,7 +174,7 @@ #### Defined in -[hooks/L1/useWriteDepositETH.ts:27](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteDepositETH.ts#L27) +[hooks/L1/useWriteDepositETH.ts:27](/src/hooks/L1/useWriteDepositETH.ts#L27) --- @@ -191,7 +191,7 @@ #### Defined in -[hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:30](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteFinalizeWithdrawalTransaction.ts#L30) +[hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:30](/src/hooks/L1/useWriteFinalizeWithdrawalTransaction.ts#L30) --- @@ -208,7 +208,7 @@ #### Defined in -[hooks/L1/useWriteProveWithdrawalTransaction.ts:33](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteProveWithdrawalTransaction.ts#L33) +[hooks/L1/useWriteProveWithdrawalTransaction.ts:33](/src/hooks/L1/useWriteProveWithdrawalTransaction.ts#L33) --- @@ -225,7 +225,7 @@ #### Defined in -[hooks/L2/useWriteWithdrawERC20.ts:23](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useWriteWithdrawERC20.ts#L23) +[hooks/L2/useWriteWithdrawERC20.ts:23](/src/hooks/L2/useWriteWithdrawERC20.ts#L23) --- @@ -242,7 +242,7 @@ #### Defined in -[hooks/L2/useWriteWithdrawETH.ts:24](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useWriteWithdrawETH.ts#L24) +[hooks/L2/useWriteWithdrawETH.ts:24](/src/hooks/L2/useWriteWithdrawETH.ts#L24) --- @@ -259,7 +259,7 @@ #### Defined in -[hooks/L1/useWriteDepositERC20.ts:14](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteDepositERC20.ts#L14) +[hooks/L1/useWriteDepositERC20.ts:14](/src/hooks/L1/useWriteDepositERC20.ts#L14) --- @@ -276,7 +276,7 @@ #### Defined in -[hooks/L1/useWriteDepositETH.ts:18](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteDepositETH.ts#L18) +[hooks/L1/useWriteDepositETH.ts:18](/src/hooks/L1/useWriteDepositETH.ts#L18) --- @@ -293,7 +293,7 @@ #### Defined in -[hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:20](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteFinalizeWithdrawalTransaction.ts#L20) +[hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:20](/src/hooks/L1/useWriteFinalizeWithdrawalTransaction.ts#L20) --- @@ -310,7 +310,7 @@ #### Defined in -[hooks/L1/useWriteProveWithdrawalTransaction.ts:23](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteProveWithdrawalTransaction.ts#L23) +[hooks/L1/useWriteProveWithdrawalTransaction.ts:23](/src/hooks/L1/useWriteProveWithdrawalTransaction.ts#L23) --- @@ -327,7 +327,7 @@ #### Defined in -[hooks/L2/useWriteWithdrawERC20.ts:14](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useWriteWithdrawERC20.ts#L14) +[hooks/L2/useWriteWithdrawERC20.ts:14](/src/hooks/L2/useWriteWithdrawERC20.ts#L14) --- @@ -344,7 +344,7 @@ #### Defined in -[hooks/L2/useWriteWithdrawETH.ts:15](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useWriteWithdrawETH.ts#L15) +[hooks/L2/useWriteWithdrawETH.ts:15](/src/hooks/L2/useWriteWithdrawETH.ts#L15) ## Functions @@ -375,7 +375,7 @@ wagmi [useSimulateContract return type](https://alpha.wagmi.sh/react/api/hooks/u #### Defined in -[hooks/L1/useSimulateDepositERC20.ts:33](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateDepositERC20.ts#L33) +[hooks/L1/useSimulateDepositERC20.ts:33](/src/hooks/L1/useSimulateDepositERC20.ts#L33) --- @@ -406,7 +406,7 @@ wagmi [useSimulateContract return type](https://alpha.wagmi.sh/react/api/hooks/u #### Defined in -[hooks/L1/useSimulateDepositETH.ts:33](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateDepositETH.ts#L33) +[hooks/L1/useSimulateDepositETH.ts:33](/src/hooks/L1/useSimulateDepositETH.ts#L33) --- @@ -437,7 +437,7 @@ wagmi [useSimulateContract return type](https://alpha.wagmi.sh/react/api/hooks/u #### Defined in -[hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts:39](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts#L39) +[hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts:39](/src/hooks/L1/useSimulateFinalizeWithdrawalTransaction.ts#L39) --- @@ -468,7 +468,7 @@ wagmi [useSimulateContract return type](https://alpha.wagmi.sh/react/api/hooks/u #### Defined in -[hooks/L1/useSimulateProveWithdrawalTransaction.ts:45](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useSimulateProveWithdrawalTransaction.ts#L45) +[hooks/L1/useSimulateProveWithdrawalTransaction.ts:45](/src/hooks/L1/useSimulateProveWithdrawalTransaction.ts#L45) --- @@ -499,7 +499,7 @@ wagmi [useSimulateContract return type](https://alpha.wagmi.sh/react/api/hooks/u #### Defined in -[hooks/L2/useSimulateWithdrawERC20.ts:34](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useSimulateWithdrawERC20.ts#L34) +[hooks/L2/useSimulateWithdrawERC20.ts:34](/src/hooks/L2/useSimulateWithdrawERC20.ts#L34) --- @@ -530,7 +530,7 @@ wagmi [useSimulateContract return type](https://alpha.wagmi.sh/react/api/hooks/u #### Defined in -[hooks/L2/useSimulateWithdrawETH.ts:35](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useSimulateWithdrawETH.ts#L35) +[hooks/L2/useSimulateWithdrawETH.ts:35](/src/hooks/L2/useSimulateWithdrawETH.ts#L35) --- @@ -561,7 +561,7 @@ wagmi [useWriteContract return type](https://alpha.wagmi.sh/react/api/hooks/useW #### Defined in -[hooks/L1/useWriteDepositERC20.ts:42](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteDepositERC20.ts#L42) +[hooks/L1/useWriteDepositERC20.ts:42](/src/hooks/L1/useWriteDepositERC20.ts#L42) --- @@ -592,7 +592,7 @@ wagmi [useWriteContract return type](https://alpha.wagmi.sh/react/api/hooks/useW #### Defined in -[hooks/L1/useWriteDepositETH.ts:83](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteDepositETH.ts#L83) +[hooks/L1/useWriteDepositETH.ts:83](/src/hooks/L1/useWriteDepositETH.ts#L83) --- @@ -623,7 +623,7 @@ wagmi [useWriteContract return type](https://alpha.wagmi.sh/react/api/hooks/useW #### Defined in -[hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:87](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteFinalizeWithdrawalTransaction.ts#L87) +[hooks/L1/useWriteFinalizeWithdrawalTransaction.ts:87](/src/hooks/L1/useWriteFinalizeWithdrawalTransaction.ts#L87) --- @@ -654,7 +654,7 @@ wagmi [useWriteContract return type](https://alpha.wagmi.sh/react/api/hooks/useW #### Defined in -[hooks/L1/useWriteProveWithdrawalTransaction.ts:104](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L1/useWriteProveWithdrawalTransaction.ts#L104) +[hooks/L1/useWriteProveWithdrawalTransaction.ts:104](/src/hooks/L1/useWriteProveWithdrawalTransaction.ts#L104) --- @@ -685,7 +685,7 @@ wagmi [useWriteContract return type](https://alpha.wagmi.sh/react/api/hooks/useW #### Defined in -[hooks/L2/useWriteWithdrawERC20.ts:42](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useWriteWithdrawERC20.ts#L42) +[hooks/L2/useWriteWithdrawERC20.ts:42](/src/hooks/L2/useWriteWithdrawERC20.ts#L42) --- @@ -716,4 +716,4 @@ wagmi [useWriteContract return type](https://alpha.wagmi.sh/react/api/hooks/useW #### Defined in -[hooks/L2/useWriteWithdrawETH.ts:43](https://github.com/base-org/op-wagmi/blob/master/src/hooks/L2/useWriteWithdrawETH.ts#L43) +[hooks/L2/useWriteWithdrawETH.ts:43](/src/hooks/L2/useWriteWithdrawETH.ts#L43)