aboutsummaryrefslogtreecommitdiffstats
path: root/packages/contracts/src
diff options
context:
space:
mode:
authorGreg Hysen <greg.hysen@gmail.com>2018-04-17 00:51:10 +0800
committerAmir Bandeali <abandeali1@gmail.com>2018-04-21 04:56:18 +0800
commit436a6605fb990d4c7aaea5688aefad73dee4d748 (patch)
tree8e5928c04666395cf83b9ca0092ffa8ce19a3ce8 /packages/contracts/src
parent84eddc3d949e42b2ba1e2b4e4a0994bb58c9566e (diff)
downloaddexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.tar
dexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.tar.gz
dexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.tar.bz2
dexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.tar.lz
dexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.tar.xz
dexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.tar.zst
dexon-sol-tools-436a6605fb990d4c7aaea5688aefad73dee4d748.zip
Updated commenting. Noted that transferFrom succeeds or throws on all transferFrom implementations.
Diffstat (limited to 'packages/contracts/src')
-rw-r--r--packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy.sol2
-rw-r--r--packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy_v1.sol2
-rw-r--r--packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC721Proxy.sol2
-rw-r--r--packages/contracts/src/contracts/current/utils/LibBytes/LibBytes.sol8
4 files changed, 7 insertions, 7 deletions
diff --git a/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy.sol b/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy.sol
index 922d300c7..b327eb7b6 100644
--- a/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy.sol
+++ b/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy.sol
@@ -29,7 +29,7 @@ contract ERC20Proxy is
IAssetProxy
{
- /// @dev Transfers ERC20 tokens.
+ /// @dev Transfers ERC20 tokens. Either succeeds or throws.
/// @param assetMetadata ERC20-encoded byte array.
/// @param from Address to transfer token from.
/// @param to Address to transfer token to.
diff --git a/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy_v1.sol b/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy_v1.sol
index 3bcbe3fd0..161362edb 100644
--- a/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy_v1.sol
+++ b/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC20Proxy_v1.sol
@@ -39,7 +39,7 @@ contract ERC20Proxy_v1 is
TRANSFER_PROXY = tokenTransferProxyContract;
}
- /// @dev Transfers ERC20 tokens.
+ /// @dev Transfers ERC20 tokens via the v1 TokenTransferProxy. Either succeeds or throws.
/// @param assetMetadata Byte array encoded for the respective asset proxy.
/// @param from Address to transfer token from.
/// @param to Address to transfer token to.
diff --git a/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC721Proxy.sol b/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC721Proxy.sol
index c2069d129..41c05e222 100644
--- a/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC721Proxy.sol
+++ b/packages/contracts/src/contracts/current/protocol/AssetProxyDispatcher/proxies/ERC721Proxy.sol
@@ -29,7 +29,7 @@ contract ERC721Proxy is
IAssetProxy
{
- /// @dev Transfers ERC20 tokens.
+ /// @dev Transfers ERC721 tokens. Either succeeds or throws.
/// @param assetMetadata ERC721-encoded byte array
/// @param from Address to transfer token from.
/// @param to Address to transfer token to.
diff --git a/packages/contracts/src/contracts/current/utils/LibBytes/LibBytes.sol b/packages/contracts/src/contracts/current/utils/LibBytes/LibBytes.sol
index 106536572..90f3b32d7 100644
--- a/packages/contracts/src/contracts/current/utils/LibBytes/LibBytes.sol
+++ b/packages/contracts/src/contracts/current/utils/LibBytes/LibBytes.sol
@@ -20,10 +20,10 @@ pragma solidity ^0.4.21;
contract LibBytes {
- /// @dev Compares two byte arrays.
+ /// @dev Tests equality of two byte arrays.
/// @param lhs First byte array to compare.
- /// @param rhs Second byte array.
- /// @return True if arrays are the same.
+ /// @param rhs Second byte array to compare.
+ /// @return True if arrays are the same. False otherwise.
function areBytesEqual(bytes memory lhs, bytes memory rhs)
public
returns (bool equal)
@@ -35,7 +35,7 @@ contract LibBytes {
// Add 1 to the number of words, to account for the length field
lenFullWords := add(lenFullWords, 0x1)
- // Verify equality word-by-word.
+ // Test equality word-by-word.
// Terminates early if there is a mismatch.
for {let i := 0} lt(i, lenFullWords) {i := add(i, 1)} {
let lhsWord := mload(add(lhs, mul(i, 0x20)))