From ea8669439fb65481c168700382b875e6d93c8d76 Mon Sep 17 00:00:00 2001 From: Amir Bandeali Date: Mon, 2 Sep 2019 23:35:15 -0700 Subject: [PATCH] Minor styling and naming changes --- .../contracts/src/LibZeroExTransaction.sol | 2 +- .../contracts/src/MixinAssetProxyDispatcher.sol | 4 ++-- .../exchange/contracts/src/MixinExchangeCore.sol | 6 +++++- .../exchange/contracts/src/MixinMatchOrders.sol | 12 ++++++++++-- .../contracts/src/interfaces/IEIP1271Wallet.sol | 6 +++--- .../contracts/src/interfaces/ISignatureValidator.sol | 2 +- contracts/exchange/test/signature_validator.ts | 4 ++-- contracts/exchange/test/transactions.ts | 4 ++-- 8 files changed, 26 insertions(+), 14 deletions(-) diff --git a/contracts/exchange-libs/contracts/src/LibZeroExTransaction.sol b/contracts/exchange-libs/contracts/src/LibZeroExTransaction.sol index a2e381d1e9..6694d78d3b 100644 --- a/contracts/exchange-libs/contracts/src/LibZeroExTransaction.sol +++ b/contracts/exchange-libs/contracts/src/LibZeroExTransaction.sol @@ -41,7 +41,7 @@ library LibZeroExTransaction { struct ZeroExTransaction { uint256 salt; // Arbitrary number to ensure uniqueness of transaction hash. uint256 expirationTimeSeconds; // Timestamp in seconds at which transaction expires. - uint256 gasPrice; // gasPrice at which transaction is required to be executed with. + uint256 gasPrice; // gasPrice that transaction is required to be executed with. address signerAddress; // Address of transaction signer. bytes data; // AbiV2 encoded calldata. } diff --git a/contracts/exchange/contracts/src/MixinAssetProxyDispatcher.sol b/contracts/exchange/contracts/src/MixinAssetProxyDispatcher.sol index 980325edb2..e0cc5aa15e 100644 --- a/contracts/exchange/contracts/src/MixinAssetProxyDispatcher.sol +++ b/contracts/exchange/contracts/src/MixinAssetProxyDispatcher.sol @@ -120,14 +120,14 @@ contract MixinAssetProxyDispatcher is ); // Call the asset proxy's transferFrom function with the constructed calldata. - (bool didSucceed, bytes memory revertData) = assetProxy.call(proxyCalldata); + (bool didSucceed, bytes memory returnData) = assetProxy.call(proxyCalldata); // If the transaction did not succeed, revert with the returned data. if (!didSucceed) { LibRichErrors.rrevert(LibExchangeRichErrors.AssetProxyTransferError( orderHash, assetData, - revertData + returnData )); } } diff --git a/contracts/exchange/contracts/src/MixinExchangeCore.sol b/contracts/exchange/contracts/src/MixinExchangeCore.sol index 2d64fe4f0a..bc219e7fa0 100644 --- a/contracts/exchange/contracts/src/MixinExchangeCore.sol +++ b/contracts/exchange/contracts/src/MixinExchangeCore.sol @@ -483,7 +483,11 @@ contract MixinExchangeCore is if (address(this).balance >= protocolFee) { valuePaid = protocolFee; } - IStaking(feeCollector).payProtocolFee.value(valuePaid)(order.makerAddress, takerAddress, protocolFee); + IStaking(feeCollector).payProtocolFee.value(valuePaid)( + order.makerAddress, + takerAddress, + protocolFee + ); } else { fillResults.protocolFeePaid = 0; } diff --git a/contracts/exchange/contracts/src/MixinMatchOrders.sol b/contracts/exchange/contracts/src/MixinMatchOrders.sol index ec49eacd9e..55e3ebe6bc 100644 --- a/contracts/exchange/contracts/src/MixinMatchOrders.sol +++ b/contracts/exchange/contracts/src/MixinMatchOrders.sol @@ -513,7 +513,11 @@ contract MixinMatchOrders is if (balance >= protocolFee) { valuePaid = protocolFee; } - IStaking(feeCollector).payProtocolFee.value(valuePaid)(leftOrder.makerAddress, takerAddress, protocolFee); + IStaking(feeCollector).payProtocolFee.value(valuePaid)( + leftOrder.makerAddress, + takerAddress, + protocolFee + ); // Pay the right order's protocol fee. if (balance - valuePaid >= protocolFee) { @@ -521,7 +525,11 @@ contract MixinMatchOrders is } else { valuePaid = 0; } - IStaking(feeCollector).payProtocolFee.value(valuePaid)(rightOrder.makerAddress, takerAddress, protocolFee); + IStaking(feeCollector).payProtocolFee.value(valuePaid)( + rightOrder.makerAddress, + takerAddress, + protocolFee + ); } else { matchedFillResults.left.protocolFeePaid = 0; matchedFillResults.right.protocolFeePaid = 0; diff --git a/contracts/exchange/contracts/src/interfaces/IEIP1271Wallet.sol b/contracts/exchange/contracts/src/interfaces/IEIP1271Wallet.sol index 0c1bb63712..729e6ce5a5 100644 --- a/contracts/exchange/contracts/src/interfaces/IEIP1271Wallet.sol +++ b/contracts/exchange/contracts/src/interfaces/IEIP1271Wallet.sol @@ -25,9 +25,9 @@ contract IEIP1271Wallet is LibEIP1271 { /// @dev Verifies that a signature is valid. - /// @param data Arbitrary data. - /// @param signature Signature of `data`. - /// @return magicValue . + /// @param data Arbitrary signed data. + /// @param signature Proof that data has been signed. + /// @return magicValue bytes4(0x20c13b0b) if the signature check succeeds. function isValidSignature( bytes calldata data, bytes calldata signature diff --git a/contracts/exchange/contracts/src/interfaces/ISignatureValidator.sol b/contracts/exchange/contracts/src/interfaces/ISignatureValidator.sol index 653e2efd2a..d664aad851 100644 --- a/contracts/exchange/contracts/src/interfaces/ISignatureValidator.sol +++ b/contracts/exchange/contracts/src/interfaces/ISignatureValidator.sol @@ -41,7 +41,7 @@ contract ISignatureValidator { event SignatureValidatorApproval( address indexed signerAddress, // Address that approves or disapproves a contract to verify signatures. address indexed validatorAddress, // Address of signature validator contract. - bool approved // Approval or disapproval of validator contract. + bool isApproved // Approval or disapproval of validator contract. ); /// @dev Approves a hash on-chain. diff --git a/contracts/exchange/test/signature_validator.ts b/contracts/exchange/test/signature_validator.ts index 7ba9dcde48..0c9f41b7d9 100644 --- a/contracts/exchange/test/signature_validator.ts +++ b/contracts/exchange/test/signature_validator.ts @@ -1152,7 +1152,7 @@ blockchainTests.resets('MixinSignatureValidator', env => { const logArgs = log.args; expect(logArgs.signerAddress).to.equal(signerAddress); expect(logArgs.validatorAddress).to.equal(validatorWallet.address); - expect(logArgs.approved).to.equal(approval); + expect(logArgs.isApproved).to.equal(approval); }); it('should emit a SignatureValidatorApprovalSet with correct args when a validator is disapproved', async () => { const approval = false; @@ -1170,7 +1170,7 @@ blockchainTests.resets('MixinSignatureValidator', env => { const logArgs = log.args; expect(logArgs.signerAddress).to.equal(signerAddress); expect(logArgs.validatorAddress).to.equal(validatorWallet.address); - expect(logArgs.approved).to.equal(approval); + expect(logArgs.isApproved).to.equal(approval); }); }); }); diff --git a/contracts/exchange/test/transactions.ts b/contracts/exchange/test/transactions.ts index f085012458..1fe9b852ab 100644 --- a/contracts/exchange/test/transactions.ts +++ b/contracts/exchange/test/transactions.ts @@ -611,7 +611,7 @@ blockchainTests.resets('Exchange transactions', env => { >).args; expect(validatorApprovalLogArgs.signerAddress).to.eq(takerAddress); expect(validatorApprovalLogArgs.validatorAddress).to.eq(validatorAddress); - expect(validatorApprovalLogArgs.approved).to.eq(shouldApprove); + expect(validatorApprovalLogArgs.isApproved).to.eq(shouldApprove); }); it('should approve a validator for the caller if called with no signature', async () => { const shouldApprove = true; @@ -633,7 +633,7 @@ blockchainTests.resets('Exchange transactions', env => { >).args; expect(validatorApprovalLogArgs.signerAddress).to.eq(takerAddress); expect(validatorApprovalLogArgs.validatorAddress).to.eq(validatorAddress); - expect(validatorApprovalLogArgs.approved).to.eq(shouldApprove); + expect(validatorApprovalLogArgs.isApproved).to.eq(shouldApprove); }); }); describe('batchExecuteTransactions', () => {