diff --git a/docs/AcrossFacet.md b/docs/AcrossFacet.md index 85fd32db4..89bb89a9c 100644 --- a/docs/AcrossFacet.md +++ b/docs/AcrossFacet.md @@ -38,7 +38,7 @@ struct AcrossData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/AllBridgeFacet.md b/docs/AllBridgeFacet.md index dcf4be3fc..6dbebabe0 100644 --- a/docs/AllBridgeFacet.md +++ b/docs/AllBridgeFacet.md @@ -4,7 +4,7 @@ The AllBridge bridge facet works by forwarding calls to the AllBridge core contract on the source chain. It is possible to find the core contract addresses and token pools by curling [token-info endpoint](https://core.api.allbridgecoreapi.net/token-info). -One feature that makes AllBridge different from other bridges is that it uses pools on either side of the bridge. This allows them to no having to have canonical representation on the destination chain. Thus for EVM based chain this means that the pool needs to be approved to spend the bridged tokens. +One feature that makes AllBridge different from other bridges is that it uses pools on either side of the bridge. This allows them to avoid the need for a canonical representation on the destination chain. Thus for EVM based chain this means that the pool needs to be approved to spend the bridged tokens. Underneath, AllBridge can use different message protocols to transfer tokens. These are represented in an enum like @@ -66,7 +66,7 @@ The `fees` field is the sum of two fees charged by AllBridge, namely Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/AmarokFacet.md b/docs/AmarokFacet.md index 628098d41..dc1c11690 100644 --- a/docs/AmarokFacet.md +++ b/docs/AmarokFacet.md @@ -46,7 +46,7 @@ struct AmarokData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/ArbitrumBridgeFacet.md b/docs/ArbitrumBridgeFacet.md index a459ce787..532ab64dd 100644 --- a/docs/ArbitrumBridgeFacet.md +++ b/docs/ArbitrumBridgeFacet.md @@ -25,7 +25,7 @@ To populate `_arbitrumData` you will need to get the `gatewayRouter` and `tokenR - `maxSubmissionCost` Maximum amount of ETH allocated to pay for the base submission fee. The base submission fee is a parameter unique to retryable transactions; the user is charged the base submission fee to cover the storage costs of keeping their ticket’s calldata in the retry buffer. - Base submission fee is querable via `ArbRetryableTx.getSubmissionPrice`. + Base submission fee is queryable via `ArbRetryableTx.getSubmissionPrice`. Base submission fee should be increased by specific percentage to get max submission cost. Currently, the increment percentage is 340%. `ArbRetryableTx` contract address and function abi can be found in configuration. - `maxGas` @@ -57,7 +57,7 @@ struct ArbitrumData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/CircleBridgeFacet.md b/docs/CircleBridgeFacet.md index 68d6c6b53..18a21879d 100644 --- a/docs/CircleBridgeFacet.md +++ b/docs/CircleBridgeFacet.md @@ -34,7 +34,7 @@ struct CircleBridgeData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/DeBridgeDlnFacet.md b/docs/DeBridgeDlnFacet.md index 95f28b395..e51253098 100644 --- a/docs/DeBridgeDlnFacet.md +++ b/docs/DeBridgeDlnFacet.md @@ -41,7 +41,7 @@ struct DeBridgeDlnData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/DeBridgeFacet.md b/docs/DeBridgeFacet.md index 1ae0d8842..77b2169d7 100644 --- a/docs/DeBridgeFacet.md +++ b/docs/DeBridgeFacet.md @@ -63,7 +63,7 @@ struct DeBridgeData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/Deploy.md b/docs/Deploy.md index b28254f69..9f45916e1 100644 --- a/docs/Deploy.md +++ b/docs/Deploy.md @@ -83,7 +83,7 @@ When releasing a new version of the immutable diamond, some scripts and files ne ## Upgrade using SAFE wallet - [ ] Make sure you have deployed a new diamond contract (see above) -- [ ] Make sure the diamond contract is owned by the SAFE wallet your will use for the upgrade +- [ ] Make sure the diamond contract is owned by the SAFE wallet you will use for the upgrade - [ ] Ensure that you have granted access to a secondary wallet to add dexs/sigs - [ ] Make sure the facet you wish to upgrade is deployed but not added to the diamond yet - [ ] Run this script `./scripts/scriptMaster.sh`, select `11) Propose upgrade TX to Gnosis SAFE` diff --git a/docs/GenericSwapFacet.md b/docs/GenericSwapFacet.md index b53894815..81b53889e 100644 --- a/docs/GenericSwapFacet.md +++ b/docs/GenericSwapFacet.md @@ -23,7 +23,7 @@ graph LR; Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/GnosisBridgeFacet.md b/docs/GnosisBridgeFacet.md index cce649851..0ee3929af 100644 --- a/docs/GnosisBridgeFacet.md +++ b/docs/GnosisBridgeFacet.md @@ -21,7 +21,7 @@ graph LR; Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/HopFacet.md b/docs/HopFacet.md index f294634e8..aef00b448 100644 --- a/docs/HopFacet.md +++ b/docs/HopFacet.md @@ -51,7 +51,7 @@ struct HopData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/HyphenFacet.md b/docs/HyphenFacet.md index 9a87ff913..a5d719157 100644 --- a/docs/HyphenFacet.md +++ b/docs/HyphenFacet.md @@ -21,7 +21,7 @@ graph LR; Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/MakerTeleportFacet.md b/docs/MakerTeleportFacet.md index da5626ee1..e0701d729 100644 --- a/docs/MakerTeleportFacet.md +++ b/docs/MakerTeleportFacet.md @@ -21,7 +21,7 @@ graph LR; Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/MultichainFacet.md b/docs/MultichainFacet.md index 739f6990f..eeca2c4a5 100644 --- a/docs/MultichainFacet.md +++ b/docs/MultichainFacet.md @@ -42,7 +42,7 @@ struct MultichainData { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/OmniBridgeFacet.md b/docs/OmniBridgeFacet.md index 6c5d2d7e2..0ad10dafb 100644 --- a/docs/OmniBridgeFacet.md +++ b/docs/OmniBridgeFacet.md @@ -21,7 +21,7 @@ graph LR; Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/OptimismBridgeFacet.md b/docs/OptimismBridgeFacet.md index cee37ed9e..24397ce95 100644 --- a/docs/OptimismBridgeFacet.md +++ b/docs/OptimismBridgeFacet.md @@ -52,7 +52,7 @@ Please make sure to pass enough gas if the Optimism facet is used directly. Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/docs/PolygonBridgeFacet.md b/docs/PolygonBridgeFacet.md index c97fbf06c..daa23bf69 100644 --- a/docs/PolygonBridgeFacet.md +++ b/docs/PolygonBridgeFacet.md @@ -22,7 +22,7 @@ graph LR; Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol). diff --git a/templates/facetDoc.template.hbs b/templates/facetDoc.template.hbs index 14fcbee17..4ae472edc 100644 --- a/templates/facetDoc.template.hbs +++ b/templates/facetDoc.template.hbs @@ -32,7 +32,7 @@ struct {{camelCase name}}Data { Some methods accept a `SwapData _swapData` parameter. -Swapping is performed by a swap specific library that expects an array of calldata to can be run on variaous DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. +Swapping is performed by a swap specific library that expects an array of calldata to can be run on various DEXs (i.e. Uniswap) to make one or multiple swaps before performing another action. The swap library can be found [here](../src/Libraries/LibSwap.sol).