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

Add return natspec to all MixinTransaction functions

Browse Source
This commit is contained in:
Amir Bandeali
2019-04-29 09:13:32 -07:00
parent f1a78682aa
commit e42a0979bc
3 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
contracts/exchange/contracts/src/MixinTransactions.sol
View File

@@ -42,6 +42,7 @@ contract MixinTransactions is
/// @dev Executes an Exchange method call in the context of signer. /// @dev Executes an Exchange method call in the context of signer.
/// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param transaction 0x transaction containing salt, signerAddress, and data.
/// @param signature Proof that transaction has been signed by signer. /// @param signature Proof that transaction has been signed by signer.
/// @return ABI encoded return data of the underlying Exchange function call.
function executeTransaction( function executeTransaction(
ZeroExTransaction memory transaction, ZeroExTransaction memory transaction,
bytes memory signature bytes memory signature
@@ -55,6 +56,7 @@ contract MixinTransactions is
/// @dev Executes a batch of Exchange method calls in the context of signer(s). /// @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 transactions Array of 0x transactions containing salt, signerAddress, and data.
/// @param signatures Array of proofs that transactions have been signed by signer(s). /// @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( function batchExecuteTransactions(
ZeroExTransaction[] memory transactions, ZeroExTransaction[] memory transactions,
bytes[] memory signatures bytes[] memory signatures
@@ -73,6 +75,7 @@ contract MixinTransactions is
/// @dev Executes an Exchange method call in the context of signer. /// @dev Executes an Exchange method call in the context of signer.
/// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param transaction 0x transaction containing salt, signerAddress, and data.
/// @param signature Proof that transaction has been signed by signer. /// @param signature Proof that transaction has been signed by signer.
/// @return ABI encoded return data of the underlying Exchange function call.
function _executeTransaction( function _executeTransaction(
ZeroExTransaction memory transaction, ZeroExTransaction memory transaction,
bytes memory signature bytes memory signature

2
contracts/exchange/contracts/src/interfaces/ITransactions.sol
View File

@@ -27,6 +27,7 @@ contract ITransactions {
/// @dev Executes an Exchange method call in the context of signer. /// @dev Executes an Exchange method call in the context of signer.
/// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param transaction 0x transaction containing salt, signerAddress, and data.
/// @param signature Proof that transaction has been signed by signer. /// @param signature Proof that transaction has been signed by signer.
/// @return ABI encoded return data of the underlying Exchange function call.
function executeTransaction( function executeTransaction(
LibZeroExTransaction.ZeroExTransaction memory transaction, LibZeroExTransaction.ZeroExTransaction memory transaction,
bytes memory signature bytes memory signature
@@ -37,6 +38,7 @@ contract ITransactions {
/// @dev Executes a batch of Exchange method calls in the context of signer(s). /// @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 transactions Array of 0x transactions containing salt, signerAddress, and data.
/// @param signatures Array of proofs that transactions have been signed by signer(s). /// @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( function batchExecuteTransactions(
LibZeroExTransaction.ZeroExTransaction[] memory transactions, LibZeroExTransaction.ZeroExTransaction[] memory transactions,
bytes[] memory signatures bytes[] memory signatures

1
contracts/exchange/contracts/src/mixins/MTransactions.sol
View File

@@ -29,6 +29,7 @@ contract MTransactions is
/// @dev Executes an Exchange method call in the context of signer. /// @dev Executes an Exchange method call in the context of signer.
/// @param transaction 0x transaction containing salt, signerAddress, and data. /// @param transaction 0x transaction containing salt, signerAddress, and data.
/// @param signature Proof that transaction has been signed by signer. /// @param signature Proof that transaction has been signed by signer.
/// @return ABI encoded return data of the underlying Exchange function call.
function _executeTransaction( function _executeTransaction(
LibZeroExTransaction.ZeroExTransaction memory transaction, LibZeroExTransaction.ZeroExTransaction memory transaction,
bytes memory signature bytes memory signature