@0x/contracts-asset-proxy: Rename ERC20BridgeTransfer event args to be less ambiguous.

This commit is contained in:
Lawrence Forman 2020-03-13 20:57:41 -04:00
parent b7fb5394a7
commit ce96e35d7d
2 changed files with 18 additions and 14 deletions

View File

@ -9,6 +9,10 @@
{ {
"note": "Emit `ERC20BridgeTransfer` events in bridges.", "note": "Emit `ERC20BridgeTransfer` events in bridges.",
"pr": 2512 "pr": 2512
},
{
"note": "Change names of `ERC20BridgeTransfer` args to be less ambiguous.",
"pr": 2524
} }
] ]
}, },

View File

@ -21,25 +21,25 @@ pragma solidity ^0.5.9;
contract IERC20Bridge { contract IERC20Bridge {
/// @dev Emitted when a bridge transfer is completed. /// @dev Result of a successful bridge call.
/// @param fromToken The address of the "from" token. bytes4 constant internal BRIDGE_SUCCESS = 0xdc1600f3;
/// @param toToken The address of the "to" token.
/// @param fromTokenAmount The "from" token amount consumed. /// @dev Emitted when a trade occurs.
/// @param toTokenAmount The "to" token amount transferred. /// @param inputToken The token the bridge is converting from.
/// @param from Supplier of "fromToken". /// @param outputToken The token the bridge is converting to.
/// @param to Receiver of "toToken". /// @param inputTokenAmount Amount of input token.
/// @param outputTokenAmount Amount of output token.
/// @param from The `from` address in `bridgeTransferFrom()`
/// @param to The `to` address in `bridgeTransferFrom()`
event ERC20BridgeTransfer( event ERC20BridgeTransfer(
address fromToken, address inputToken,
address toToken, address outputToken,
uint256 fromTokenAmount, uint256 inputTokenAmount,
uint256 toTokenAmount, uint256 outputTokenAmount,
address from, address from,
address to address to
); );
/// @dev Result of a successful bridge call.
bytes4 constant internal BRIDGE_SUCCESS = 0xdc1600f3;
/// @dev Transfers `amount` of the ERC20 `tokenAddress` from `from` to `to`. /// @dev Transfers `amount` of the ERC20 `tokenAddress` from `from` to `to`.
/// @param tokenAddress The address of the ERC20 token to transfer. /// @param tokenAddress The address of the ERC20 token to transfer.
/// @param from Address to transfer asset from. /// @param from Address to transfer asset from.