🥢 Edit SafeTransferLib comments (#485)

Vectorized · Jun 21, 2023 · 0bf309c · 0bf309c
1 parent e89c4f5
commit 0bf309c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/.gas-snapshot b/.gas-snapshot
@@ -212,7 +212,7 @@ ERC2981Test:testSetAndGetRoyaltyInfo(uint256) (runs: 256, μ: 107226, ~: 104801)
 ERC2981Test:test__codesize() (gas: 8419)
 ERC4626Test:testDepositWithNoApprovalReverts() (gas: 16371)
 ERC4626Test:testDepositWithNotEnoughApprovalReverts() (gas: 89884)
-ERC4626Test:testDifferentialFullMulDiv(uint256,uint256,uint256) (runs: 256, μ: 3347, ~: 3201)
+ERC4626Test:testDifferentialFullMulDiv(uint256,uint256,uint256) (runs: 256, μ: 3350, ~: 3201)
 ERC4626Test:testMetadata() (gas: 15439)
 ERC4626Test:testMintWithNoApprovalReverts() (gas: 16345)
 ERC4626Test:testMintZero() (gas: 54317)
@@ -412,13 +412,13 @@ LibBitmapTest:test__codesize() (gas: 8161)
 LibCloneTest:testClone() (gas: 52963)
 LibCloneTest:testClone(uint256) (runs: 256, μ: 71288, ~: 72921)
 LibCloneTest:testCloneDeteministicWithImmutableArgs() (gas: 803713)
-LibCloneTest:testCloneDeteministicWithImmutableArgs(address,uint256,uint256[],bytes,uint64,uint8,uint256) (runs: 256, μ: 1812111, ~: 1782776)
+LibCloneTest:testCloneDeteministicWithImmutableArgs(address,uint256,uint256[],bytes,uint64,uint8,uint256) (runs: 256, μ: 1844064, ~: 1772988)
 LibCloneTest:testCloneDeterministic() (gas: 76781)
-LibCloneTest:testCloneDeterministic(uint256,bytes32) (runs: 256, μ: 95349, ~: 96670)
+LibCloneTest:testCloneDeterministic(uint256,bytes32) (runs: 256, μ: 95271, ~: 96670)
 LibCloneTest:testCloneDeterministicRevertsIfAddressAlreadyUsed() (gas: 96882220)
 LibCloneTest:testCloneWithImmutableArgs() (gas: 711204)
-LibCloneTest:testCloneWithImmutableArgs(uint256,address,uint256,uint256[],uint64,uint8) (runs: 256, μ: 1761375, ~: 1689727)
-LibCloneTest:testStartsWithCaller(uint256) (runs: 256, μ: 28188, ~: 28404)
+LibCloneTest:testCloneWithImmutableArgs(uint256,address,uint256,uint256[],uint64,uint8) (runs: 256, μ: 1757928, ~: 1694071)
+LibCloneTest:testStartsWithCaller(uint256) (runs: 256, μ: 28189, ~: 28404)
 LibCloneTest:test__codesize() (gas: 15496)
 LibMapTest:testMapGetFromBigArray() (gas: 3264)
 LibMapTest:testMapGetUint8() (gas: 3357)
@@ -816,15 +816,15 @@ SignatureCheckerLibTest:testSignatureCheckerOnWalletWithZeroAddressSigner() (gas
 SignatureCheckerLibTest:test__codesize() (gas: 9054)
 SoladyTest:test__codesize() (gas: 1102)
 TestPlus:test__codesize() (gas: 406)
-WETHInvariants:invariantTotalSupplyEqualsBalance() (runs: 256, calls: 3840, reverts: 1862)
+WETHInvariants:invariantTotalSupplyEqualsBalance() (runs: 256, calls: 3840, reverts: 2019)
 WETHInvariants:test__codesize() (gas: 6297)
 WETHTest:testDeposit() (gas: 68090)
-WETHTest:testDeposit(uint256) (runs: 256, μ: 65537, ~: 68384)
+WETHTest:testDeposit(uint256) (runs: 256, μ: 65717, ~: 68384)
 WETHTest:testFallbackDeposit() (gas: 67798)
-WETHTest:testFallbackDeposit(uint256) (runs: 256, μ: 65200, ~: 68047)
+WETHTest:testFallbackDeposit(uint256) (runs: 256, μ: 65380, ~: 68047)
 WETHTest:testMetadata() (gas: 10070)
 WETHTest:testPartialWithdraw() (gas: 79546)
 WETHTest:testWithdraw() (gas: 59316)
-WETHTest:testWithdraw(uint256,uint256) (runs: 256, μ: 75881, ~: 80306)
+WETHTest:testWithdraw(uint256,uint256) (runs: 256, μ: 76988, ~: 80306)
 WETHTest:testWithdrawToContractWithoutReceiveReverts() (gas: 93907)
 WETHTest:test__codesize() (gas: 11369)
diff --git a/src/utils/SafeTransferLib.sol b/src/utils/SafeTransferLib.sol
@@ -87,7 +87,7 @@ library SafeTransferLib {
                 // We can directly use `SELFDESTRUCT` in the contract creation.
                 // Compatible with `SENDALL`: https://eips.ethereum.org/EIPS/eip-4758
                 if iszero(create(amount, 0x0b, 0x16)) {
-                    // For better gas estimation.
+                    // To coerce gas estimation to provide enough gas for the `create` above.
                     if iszero(gt(gas(), 1000000)) { revert(0, 0) }
                 }
             }
@@ -122,7 +122,7 @@ library SafeTransferLib {
                 // We can directly use `SELFDESTRUCT` in the contract creation.
                 // Compatible with `SENDALL`: https://eips.ethereum.org/EIPS/eip-4758
                 if iszero(create(amount, 0x0b, 0x16)) {
-                    // For better gas estimation.
+                    // To coerce gas estimation to provide enough gas for the `create` above.
                     if iszero(gt(gas(), 1000000)) { revert(0, 0) }
                 }
             }
@@ -190,7 +190,7 @@ library SafeTransferLib {
     /// @dev Sends all of ERC20 `token` from `from` to `to`.
     /// Reverts upon failure.
     ///
-    /// The `from` account must have at least `amount` approved for
+    /// The `from` account must have their entire balance approved for
     /// the current contract to manage.
     function safeTransferAllFrom(address token, address from, address to)
         internal