crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add missing @return comments

Browse Source
This commit is contained in:
Michael Zhu
2021-12-01 10:32:14 -08:00
parent b6f118ef32
commit 9651b41264
2 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
contracts/zero-ex/contracts/src/features/ERC721OrdersFeature.sol
View File

@@ -163,6 +163,8 @@ contract ERC721OrdersFeature is
/// @param signatures The order signatures.
/// @param revertIfIncomplete If true, reverts if this
/// function fails to fill any individual order.
/// @return successes An array of booleans corresponding to whether
/// each order in `orders` was successfully filled.
function batchBuyERC721s(
LibERC721Order.ERC721Order[] memory orders,
LibSignature.Signature[] memory signatures,
@@ -214,6 +216,9 @@ contract ERC721OrdersFeature is
/// @param buyOrder Order buying an ERC721 asset.
/// @param sellOrderSignature Signature for the sell order.
/// @param buyOrderSignature Signature for the buy order.
/// @return profit The amount of profit earned by the caller
/// of this function (denominated in the ERC20 token
/// of the matched orders).
function matchERC721Orders(
LibERC721Order.ERC721Order memory sellOrder,
LibERC721Order.ERC721Order memory buyOrder,
@@ -235,6 +240,11 @@ contract ERC721OrdersFeature is
/// @param buyOrders Orders buying ERC721 assets.
/// @param sellOrderSignatures Signatures for the sell orders.
/// @param buyOrderSignatures Signatures for the buy orders.
/// @return profits The amount of profit earned by the caller
/// of this function for each pair of matched orders
/// (denominated in the ERC20 token of the order pair).
/// @return successes An array of booleans corresponding to
/// whether each pair of orders was successfully matched.
function batchMatchERC721Orders(
LibERC721Order.ERC721Order[] memory sellOrders,
LibERC721Order.ERC721Order[] memory buyOrders,

10
contracts/zero-ex/contracts/src/features/interfaces/IERC721OrdersFeature.sol
View File

@@ -99,6 +99,8 @@ interface IERC721OrdersFeature {
/// @param signatures The order signatures.
/// @param revertIfIncomplete If true, reverts if this
/// function fails to fill any individual order.
/// @return successes An array of booleans corresponding to whether
/// each order in `orders` was successfully filled.
function batchBuyERC721s(
LibERC721Order.ERC721Order[] calldata orders,
LibSignature.Signature[] calldata signatures,
@@ -116,6 +118,9 @@ interface IERC721OrdersFeature {
/// @param buyOrder Order buying an ERC721 asset.
/// @param sellOrderSignature Signature for the sell order.
/// @param buyOrderSignature Signature for the buy order.
/// @return profit The amount of profit earned by the caller
/// of this function (denominated in the ERC20 token
/// of the matched orders).
function matchERC721Orders(
LibERC721Order.ERC721Order calldata sellOrder,
LibERC721Order.ERC721Order calldata buyOrder,
@@ -133,6 +138,11 @@ interface IERC721OrdersFeature {
/// @param buyOrders Orders buying ERC721 assets.
/// @param sellOrderSignatures Signatures for the sell orders.
/// @param buyOrderSignatures Signatures for the buy orders.
/// @return profits The amount of profit earned by the caller
/// of this function for each pair of matched orders
/// (denominated in the ERC20 token of the order pair).
/// @return successes An array of booleans corresponding to
/// whether each pair of orders was successfully matched.
function batchMatchERC721Orders(
LibERC721Order.ERC721Order[] calldata sellOrders,
LibERC721Order.ERC721Order[] calldata buyOrders,