From e42a0979bcc92bf34b16fba9548b8c1995af522e Mon Sep 17 00:00:00 2001 From: Amir Bandeali Date: Mon, 29 Apr 2019 09:13:32 -0700 Subject: [PATCH] Add return natspec to all MixinTransaction functions --- contracts/exchange/contracts/src/MixinTransactions.sol | 3 +++ contracts/exchange/contracts/src/interfaces/ITransactions.sol | 2 ++ contracts/exchange/contracts/src/mixins/MTransactions.sol | 1 + 3 files changed, 6 insertions(+) diff --git a/contracts/exchange/contracts/src/MixinTransactions.sol b/contracts/exchange/contracts/src/MixinTransactions.sol index b72f5fb859..a59c17a067 100644 --- a/contracts/exchange/contracts/src/MixinTransactions.sol +++ b/contracts/exchange/contracts/src/MixinTransactions.sol @@ -42,6 +42,7 @@ contract MixinTransactions is /// @dev Executes an Exchange method call in the context of signer. /// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param signature Proof that transaction has been signed by signer. + /// @return ABI encoded return data of the underlying Exchange function call. function executeTransaction( ZeroExTransaction memory transaction, bytes memory signature @@ -55,6 +56,7 @@ contract MixinTransactions is /// @dev Executes a batch of Exchange method calls in the context of signer(s). /// @param transactions Array of 0x transactions containing salt, signerAddress, and data. /// @param signatures Array of proofs that transactions have been signed by signer(s). + /// @return Array containing ABI encoded return data for each of the underlying Exchange function calls. function batchExecuteTransactions( ZeroExTransaction[] memory transactions, bytes[] memory signatures @@ -73,6 +75,7 @@ contract MixinTransactions is /// @dev Executes an Exchange method call in the context of signer. /// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param signature Proof that transaction has been signed by signer. + /// @return ABI encoded return data of the underlying Exchange function call. function _executeTransaction( ZeroExTransaction memory transaction, bytes memory signature diff --git a/contracts/exchange/contracts/src/interfaces/ITransactions.sol b/contracts/exchange/contracts/src/interfaces/ITransactions.sol index c622b0ddb4..b6b687fb18 100644 --- a/contracts/exchange/contracts/src/interfaces/ITransactions.sol +++ b/contracts/exchange/contracts/src/interfaces/ITransactions.sol @@ -27,6 +27,7 @@ contract ITransactions { /// @dev Executes an Exchange method call in the context of signer. /// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param signature Proof that transaction has been signed by signer. + /// @return ABI encoded return data of the underlying Exchange function call. function executeTransaction( LibZeroExTransaction.ZeroExTransaction memory transaction, bytes memory signature @@ -37,6 +38,7 @@ contract ITransactions { /// @dev Executes a batch of Exchange method calls in the context of signer(s). /// @param transactions Array of 0x transactions containing salt, signerAddress, and data. /// @param signatures Array of proofs that transactions have been signed by signer(s). + /// @return Array containing ABI encoded return data for each of the underlying Exchange function calls. function batchExecuteTransactions( LibZeroExTransaction.ZeroExTransaction[] memory transactions, bytes[] memory signatures diff --git a/contracts/exchange/contracts/src/mixins/MTransactions.sol b/contracts/exchange/contracts/src/mixins/MTransactions.sol index 4fd4dbd002..d0d492a954 100644 --- a/contracts/exchange/contracts/src/mixins/MTransactions.sol +++ b/contracts/exchange/contracts/src/mixins/MTransactions.sol @@ -29,6 +29,7 @@ contract MTransactions is /// @dev Executes an Exchange method call in the context of signer. /// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param signature Proof that transaction has been signed by signer. + /// @return ABI encoded return data of the underlying Exchange function call. function _executeTransaction( LibZeroExTransaction.ZeroExTransaction memory transaction, bytes memory signature