Skip to content

Commit e5545c8

Browse files
committed
fix: add some comments for later fixes
1 parent ae10ad6 commit e5545c8

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

src/contracts/facilitators/gsm/converter/USTBGsmConverter.sol

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,15 @@ contract USTBGsmConverter is Ownable, EIP712, IGsmConverter {
9090
}
9191

9292
/// @inheritdoc IGsmConverter
93+
// TODO: maxAmount should be the amount of GHO to be received, NOT the amount of asset to be sold
9394
function sellAsset(uint256 maxAmount, address receiver) external returns (uint256, uint256) {
9495
require(maxAmount > 0, 'INVALID_MAX_AMOUNT');
9596

9697
return _sellAsset(msg.sender, maxAmount, receiver);
9798
}
9899

99100
/// @inheritdoc IGsmConverter
101+
// TODO: minAmount should be the amount of USDC to be returned to user, NOT the amount of asset to buy
100102
function buyAsset(uint256 minAmount, address receiver) external returns (uint256, uint256) {
101103
require(minAmount > 0, 'INVALID_MIN_AMOUNT');
102104

@@ -167,7 +169,7 @@ contract USTBGsmConverter is Ownable, EIP712, IGsmConverter {
167169

168170
/**
169171
* @notice Buys the GSM underlying asset in exchange for selling GHO, after asset redemption
170-
* @param minAmount The minimum amount of the underlying asset to buy (ie BUIDL)
172+
* @param minAmount The minimum amount of the underlying asset to buy (ie USTB)
171173
* @param receiver Recipient address of the underlying asset being purchased
172174
* @return The amount of underlying asset bought, after asset redemption
173175
* @return The amount of GHO sold by the user

src/contracts/facilitators/gsm/converter/interfaces/IGsmConverter.sol

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ interface IGsmConverter {
6262
* @dev Use `getAssetAmountForBuyAsset` function to calculate the amount based on the GHO amount to sell
6363
* @param originator The signer of the request
6464
* @param minAmount The minimum amount of the underlying asset to buy
65+
TODO: fix this minAmount, it should be final min amount of USDC returned
6566
* @param receiver Recipient address of the underlying asset being purchased
6667
* @param deadline Signature expiration deadline
6768
* @param signature Signature data
@@ -97,7 +98,8 @@ interface IGsmConverter {
9798

9899
/**
99100
* @notice Sells the GSM underlying asset in exchange for buying GHO, after asset conversion
100-
* @param maxAmount The maximum amount of the underlying asset to sell
101+
* @param maxAmount The maximum amount of the underlying asset to sell
102+
TODO: fix this maxAmount, it should be final max amount of GHO amount returned
101103
* @param receiver Recipient address of the GHO being purchased
102104
* @return The amount of underlying asset sold, after asset conversion
103105
* @return The amount of GHO bought by the user

0 commit comments

Comments
 (0)