Skip to content

Commit 4a561ec

Browse files
Merge pull request #308 from vtjl10/master
Docs: Minor Improvements and Typo Fixes in Swapper Contract Documentation
2 parents 5e8dc25 + 0642e27 commit 4a561ec

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/swaps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The general steps to use the `Swapper` contract are following:
3434

3535
The `Swapper` contract should implement the `ISwapper` interface. This ensures, that users could potentially provide their own implementations of the swapper contract in the UI, without needing to modify the FE code.
3636

37-
The main function is `swap()`, which takes a swap definition in a `SwapParams` struct. The params define a handler to use, swapping mode, bought and sold tokens, the amounts etc. See [ISwapper natspec](../src/Swaps/ISwapper.sol) for details. Note, that some parameters might be ignored in certain modes or by certain handlers, while others (`amountOut`) might have differrent semantics in certain modes.
37+
The main function is `swap()`, which takes a swap definition in a `SwapParams` struct. The params define a handler to use, swapping mode, bought and sold tokens, the amounts etc. See [ISwapper natspec](../src/Swaps/ISwapper.sol) for details. Note, that some parameters might be ignored in certain modes or by certain handlers, while others (`amountOut`) might have different semantics in certain modes.
3838

3939
The interface also defines helper functions like `sweep`, `deposit`, `repay` and `repayAndDeposit` which allow consuming the contract's balance.
4040

@@ -111,7 +111,7 @@ F2. Swap deposits from one EVault (A) to exact amount of another (B)
111111
- `A.withdraw` to the swapper contract. The amount must cover all of the estimated swap costs with some extra, to account for slippage
112112
- `swapper.multicall` with the following items:
113113
- `Swapper.swap` - `exact input` on the generic handler with the off-chain payload
114-
- `Swapper.swap` - `exact output` on one of the supportin handlers (Uni V2/V3) with the user specified `amountOut`. The receiver can be either the swapper contract or B vault.
114+
- `Swapper.swap` - `exact output` on one of the supporting handlers (Uni V2/V3) with the user specified `amountOut`. The receiver can be either the swapper contract or B vault.
115115
- `Swapper.sweep` the output token, into the B vault
116116
- `SwapVerifier.verifyAmountMinAndSkim` check a minimum required amount was bought and claim the funds for the user. Because exact output swaps are not guaranteed to be exact always, a small slippage could be allowed.
117117

0 commit comments

Comments
 (0)