Skip to content

Commit 720cc3a

Browse files
authored
Update comments for quoteIn and quoteOut functions
1 parent 56e84bf commit 720cc3a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

cadence/contracts/interfaces/DeFiActions.cdc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -347,15 +347,15 @@ access(all) contract DeFiActions {
347347
/// Provides a quote for how many input tokens can be swapped for `forDesired` output tokens.
348348
/// The reverse flag simply inverts inType/outType and inAmount/outAmount in the quote.
349349
/// Interpretation:
350-
/// - reverse=false -> I want to provide `quote.inAmount` input tokens and receive `forDesired` output tokens.
351-
/// - reverse=true -> I want to provide `forDesired` output tokens and receive `quote.inAmount` input tokens.
350+
/// - reverse=false -> I want to provide `quote.inAmount` `swapper.inType()` tokens and receive `forDesired` `swapper.outType()` tokens.
351+
/// - reverse=true -> I want to provide `quote.inAmount` `swapper.outType()` tokens and receive `forDesired` `swapper.inType()` tokens.
352352
access(all) fun quoteIn(forDesired: UFix64, reverse: Bool): {Quote}
353353
/// The estimated amount delivered out for a provided input balance
354354
/// Provides a quote for how many output tokens can be swapped for `forProvided` input tokens.
355355
/// The reverse flag simply inverts inType/outType and inAmount/outAmount in the quote.
356356
/// Interpretation:
357-
/// - reverse=false -> I want to provide `forProvided` input tokens and receive `quote.outAmount` output tokens.
358-
/// - reverse=true -> I want to provide `quote.outAmount` output tokens and receive `forProvided` input tokens.
357+
/// - reverse=false -> I want to provide `forProvided` `swapper.inType()` tokens and receive `quote.outAmount` `swapper.outType()` tokens.
358+
/// - reverse=true -> I want to provide `forProvided` `swapper.outType()` tokens and receive `quote.outAmount` `swapper.inType()` tokens.
359359
access(all) fun quoteOut(forProvided: UFix64, reverse: Bool): {Quote}
360360
/// Performs a swap taking a Vault of type inVault, outputting a resulting outVault. Implementations may choose
361361
/// to swap along a pre-set path or an optimal path of a set of paths or even set of contained Swappers adapted

0 commit comments

Comments
 (0)