Skip to content

Commit

Permalink
remove _extended methods:
Browse files Browse the repository at this point in the history
  • Loading branch information
@bout3fiddy
bout3fiddy committed Jul 28, 2023
1 parent 346c49b commit 43fd62e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 197 deletions.
123 changes: 4 additions & 119 deletions contracts/main/CurveStableSwapMetaNG.vy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,17 @@
1. Adds oracles based on AMM State Price (and _not_ last traded price).
State prices are calculated _after_ liquidity operations, using bonding
curve math.
2. Adds exchanging tokens with callbacks that allows for:
a. reduced ERC20 token transfers in zap contracts
b. swaps without transferFrom (no need for token approvals)
3. `exchange_received`: swaps that expect an ERC20 transfer to have occurred
2. `exchange_received`: swaps that expect an ERC20 transfer to have occurred
prior to executing the swap.
Note: a. If pool contains rebasing tokens and one of the `asset_types` is 2 (Rebasing)
then calling `exchange_received` will REVERT.
b. If pool contains rebasing token and `asset_types` does not contain 2 (Rebasing)
then this is an incorrect implementation and rebases can be
stolen.
4. Adds `get_dx`, `get_dx_underlying`: Similar to `get_dy` which returns an expected output
3. Adds `get_dx`, `get_dx_underlying`: Similar to `get_dy` which returns an expected output
of coin[j] for given `dx` amount of coin[i], `get_dx` returns expected
input of coin[i] for an output amount of coin[j].
5. Fees are dynamic: AMM will charge a higher fee if pool depegs.
4. Fees are dynamic: AMM will charge a higher fee if pool depegs.
"""

from vyper.interfaces import ERC20
Expand Down Expand Up @@ -367,28 +364,15 @@ def _transfer_in(
coin_basepool_idx: int128,
dx: uint256,
dy: uint256,
callbacker: address,
callback_sig: bytes32,
sender: address,
receiver: address,
expect_optimistic_transfer: bool,
) -> uint256:
"""
@notice Contains all logic to handle ERC20 or native token transfers
@dev The callback sig must have the following args:
sender: address
receiver: address
coin: address
dx: uint256
dy: uint256
The `dy` that the pool enforces is actually min_dy.
Callback only occurs for `exchange_extended`.
@dev If callback_sig is empty, `_transfer_in` does a transferFrom.
@notice Contains all logic to handle ERC20 token transfers.
@params _coin address of the coin to transfer in.
@params dx amount of `_coin` to transfer into the pool.
@params dy amount of `_coin` to transfer out of the pool.
@params callbacker address to call `callback_sig` on.
@params callback_sig signature of the callback function.
@params sender address to transfer `_coin` from.
@params receiver address to transfer `_coin` to.
@params expect_optimistic_transfer True if contract expects an optimistic coin transfer
Expand All @@ -412,18 +396,6 @@ def _transfer_in(
assert _incoming_coin_asset_type != 2 # dev: rebasing coins not supported
_dx -= _stored_balance # <--- for base_pool coins, stored balance is 0.

elif callback_sig != empty(bytes32):

raw_call(
callbacker,
concat(
slice(callback_sig, 0, 4),
_abi_encode(sender, receiver, _input_coin.address, dx, dy)
)
)

_dx = _input_coin.balanceOf(self) - _dx

else:

assert _input_coin.transferFrom(sender, self, dx, default_return_value=True)
Expand Down Expand Up @@ -550,44 +522,6 @@ def exchange(
_dx,
_min_dy,
_receiver,
empty(address),
empty(bytes32),
False
)


@external
@nonreentrant('lock')
def exchange_extended(
i: int128,
j: int128,
_dx: uint256,
_min_dy: uint256,
_sender: address,
_receiver: address,
_cb: bytes32
) -> uint256:
"""
@notice Perform an exchange between two coins after a callback
@dev Index values can be found via the `coins` public getter method
Users of this method are dex aggregators,arbitrageurs, or other
users who do not wish to grant approvals to the contract.
@param i Index value for the coin to send
@param j Index valie of the coin to recieve
@param _dx Amount of `i` being exchanged
@param _min_dy Minimum amount of `j` to receive
@return Actual amount of `j` received
"""
assert _cb != empty(bytes32) # dev: No callback specified
return self._exchange(
_sender,
i,
j,
_dx,
_min_dy,
_receiver,
msg.sender, # <---------------------------- callbacker is msg.sender.
_cb,
False
)

Expand Down Expand Up @@ -622,8 +556,6 @@ def exchange_received(
_dx,
_min_dy,
_receiver,
empty(address),
empty(bytes32),
True, # <--------------------------------------- swap optimistically.
)

Expand Down Expand Up @@ -653,41 +585,6 @@ def exchange_underlying(
_dx,
_min_dy,
_receiver,
empty(address),
empty(bytes32),
False
)


@external
@nonreentrant('lock')
def exchange_underlying_extended(
i: int128,
j: int128,
_dx: uint256,
_min_dy: uint256,
_receiver: address,
_cb: bytes32
) -> uint256:
"""
@notice Perform an exchange between two underlying coins
@param i Index value for the underlying coin to send
@param j Index value of the underlying coin to receive
@param _dx Amount of `i` being exchanged
@param _min_dy Minimum amount of `j` to receive
@param _receiver Address that receives `j`
@return Actual amount of `j` received
"""
assert _cb != empty(bytes32) # dev: no callback specified
return self._exchange_underlying(
msg.sender,
i,
j,
_dx,
_min_dy,
_receiver,
msg.sender,
_cb,
False
)

Expand Down Expand Up @@ -717,8 +614,6 @@ def exchange_underlying_received(
_dx,
_min_dy,
_receiver,
empty(address),
empty(bytes32),
True
)

Expand Down Expand Up @@ -758,8 +653,6 @@ def add_liquidity(
-1, # <--- we're not handling underlying coins here
_amounts[i],
0,
empty(address),
empty(bytes32),
msg.sender,
empty(address),
False, # expect_optimistic_transfer
Expand Down Expand Up @@ -1058,8 +951,6 @@ def _exchange(
_dx: uint256,
_min_dy: uint256,
receiver: address,
callbacker: address,
callback_sig: bytes32,
expect_optimistic_transfer: bool
) -> uint256:

Expand All @@ -1078,8 +969,6 @@ def _exchange(
-1, # <----- we're not handling underlying coins here.
_dx,
_min_dy,
callbacker,
callback_sig,
sender,
receiver,
expect_optimistic_transfer
Expand Down Expand Up @@ -1111,8 +1000,6 @@ def _exchange_underlying(
_dx: uint256,
_min_dy: uint256,
receiver: address,
callbacker: address,
callback_sig: bytes32,
expect_optimistic_transfer: bool = False
) -> uint256:

Expand Down Expand Up @@ -1153,8 +1040,6 @@ def _exchange_underlying(
base_i,
_dx,
_min_dy,
callbacker,
callback_sig,
sender,
receiver,
expect_optimistic_transfer,
Expand Down
82 changes: 4 additions & 78 deletions contracts/main/CurveStableSwapNG.vy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,17 @@
Note: Oracle precision _must_ be 10**18.
Additional features include:
1. Adds oracles based on AMM State Price (and _not_ last traded price).
2. Adds exchanging tokens with callbacks that allows for:
a. reduced ERC20 token transfers in zap contracts
b. swaps without transferFrom (no need for token approvals)
3. `exchange_received`: swaps that expect an ERC20 transfer to have occurred
2. `exchange_received`: swaps that expect an ERC20 transfer to have occurred
prior to executing the swap.
Note: a. If pool contains rebasing tokens and one of the `asset_types` is 2 (Rebasing)
then calling `exchange_received` will REVERT.
b. If pool contains rebasing token and `asset_types` does not contain 2 (Rebasing)
then this is an incorrect implementation and rebases can be
stolen.
4. Adds `get_dx`: Similar to `get_dy` which returns an expected output
3. Adds `get_dx`: Similar to `get_dy` which returns an expected output
of coin[j] for given `dx` amount of coin[i], `get_dx` returns expected
input of coin[i] for an output amount of coin[j].
5. Fees are dynamic: AMM will charge a higher fee if pool depegs.
4. Fees are dynamic: AMM will charge a higher fee if pool depegs.
"""

from vyper.interfaces import ERC20
Expand Down Expand Up @@ -314,29 +311,16 @@ def _transfer_in(
coin_idx: int128,
dx: uint256,
dy: uint256,
callbacker: address,
callback_sig: bytes32,
sender: address,
receiver: address,
expect_optimistic_transfer: bool,
) -> uint256:
"""
@notice Contains all logic to handle ERC20 or native token transfers
@dev The callback sig must have the following args:
sender: address
receiver: address
coin: address
dx: uint256
dy: uint256
The `dy` that the pool enforces is actually min_dy.
Callback only occurs for `exchange_extended`.
@dev If callback_sig is empty, `_transfer_in` does a transferFrom.
@notice Contains all logic to handle ERC20 token transfers.
@params _coin address of the coin to transfer in.
@params dx amount of `_coin` to transfer into the pool.
@params dy amount of `_coin` to transfer out of the pool.
@params mvalue msg.value if the transfer is ETH, 0 otherwise.
@params callbacker address to call `callback_sig` on.
@params callback_sig signature of the callback function.
@params sender address to transfer `_coin` from.
@params receiver address to transfer `_coin` to.
@params expect_optimistic_transfer True if contract expects an optimistic coin transfer
Expand All @@ -351,18 +335,6 @@ def _transfer_in(
assert _incoming_coin_asset_type != 2 # dev: rebasing coins not supported
_dx = ERC20(coins[coin_idx]).balanceOf(self) - self.stored_balances[coin_idx]

elif callback_sig != empty(bytes32):

raw_call(
callbacker,
concat(
slice(callback_sig, 0, 4),
_abi_encode(sender, receiver, coins[coin_idx], dx, dy)
)
)

_dx = ERC20(coins[coin_idx]).balanceOf(self) - _dx

else:

assert ERC20(coins[coin_idx]).transferFrom(
Expand Down Expand Up @@ -493,44 +465,6 @@ def exchange(
_dx,
_min_dy,
_receiver,
empty(address),
empty(bytes32),
False
)


@external
@nonreentrant('lock')
def exchange_extended(
i: int128,
j: int128,
_dx: uint256,
_min_dy: uint256,
_sender: address,
_receiver: address,
_cb: bytes32
) -> uint256:
"""
@notice Perform an exchange between two coins after a callback
@dev Index values can be found via the `coins` public getter method
Not payable (does not accept eth). Users of this method are dex aggregators,
arbitrageurs, or other users who do not wish to grant approvals to the contract.
@param i Index value for the coin to send
@param j Index valie of the coin to recieve
@param _dx Amount of `i` being exchanged
@param _min_dy Minimum amount of `j` to receive
@return Actual amount of `j` received
"""
assert _cb != empty(bytes32) # dev: No callback specified
return self._exchange(
_sender,
i,
j,
_dx,
_min_dy,
_receiver,
msg.sender, # <---------------------------- callbacker is msg.sender.
_cb,
False
)

Expand Down Expand Up @@ -565,8 +499,6 @@ def exchange_received(
_dx,
_min_dy,
_receiver,
empty(address),
empty(bytes32),
True, # <--------------------------------------- swap optimistically.
)

Expand Down Expand Up @@ -608,8 +540,6 @@ def add_liquidity(
i,
_amounts[i],
0,
empty(address),
empty(bytes32),
msg.sender,
empty(address),
False, # expect_optimistic_transfer
Expand Down Expand Up @@ -908,8 +838,6 @@ def _exchange(
_dx: uint256,
_min_dy: uint256,
receiver: address,
callbacker: address,
callback_sig: bytes32,
expect_optimistic_transfer: bool
) -> uint256:

Expand All @@ -927,8 +855,6 @@ def _exchange(
i,
_dx,
_min_dy,
callbacker,
callback_sig,
sender,
receiver,
expect_optimistic_transfer
Expand Down

0 comments on commit 43fd62e

Please sign in to comment.