Skip to content

Commit

Permalink
chore: fix typos (#633)
Browse files Browse the repository at this point in the history
* fix typo

* fix typos

* fix typos

* fix typo

* fix typo

* fix typo
  • Loading branch information
omahs authored Apr 25, 2024
1 parent b00b08c commit 7a0aa91
Show file tree
Hide file tree
Showing 18 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/AcrossFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions docs/AllBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/AmarokFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
4 changes: 2 additions & 2 deletions docs/ArbitrumBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/CircleBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/DeBridgeDlnFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/DeBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/Deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ When releasing a new version of the immutable diamond, some scripts and files ne
## <a name="upgrade-using-safe"></a>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`
Expand Down
2 changes: 1 addition & 1 deletion docs/GenericSwapFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

2 changes: 1 addition & 1 deletion docs/GnosisBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/HopFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/HyphenFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/MakerTeleportFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/MultichainFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/OmniBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/OptimismBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/PolygonBridgeFacet.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion templates/facetDoc.template.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 7a0aa91

Please sign in to comment.