From e851cb1cbcdda3dde53d423e85745aaea11e28a2 Mon Sep 17 00:00:00 2001 From: Lawrence Forman Date: Wed, 19 Feb 2020 16:19:38 -0500 Subject: [PATCH] `@0x/contracts-dev-utils`: Move `D18` out to `@0x/contracts-utils`. --- contracts/dev-utils/CHANGELOG.json | 17 +- contracts/dev-utils/contracts/src/D18.sol | 248 ------------------ .../contracts/src/LibDydxBalance.sol | 2 +- contracts/dev-utils/package.json | 2 +- contracts/dev-utils/test/artifacts.ts | 2 - contracts/dev-utils/test/wrappers.ts | 1 - contracts/dev-utils/tsconfig.json | 1 - 7 files changed, 11 insertions(+), 262 deletions(-) delete mode 100644 contracts/dev-utils/contracts/src/D18.sol diff --git a/contracts/dev-utils/CHANGELOG.json b/contracts/dev-utils/CHANGELOG.json index 03fa998383..a97f1cfe02 100644 --- a/contracts/dev-utils/CHANGELOG.json +++ b/contracts/dev-utils/CHANGELOG.json @@ -1,4 +1,13 @@ [ + { + "version": "1.2.0", + "changes": [ + { + "note": "Add `DydxBridge` order validation", + "pr": 2466 + } + ] + }, { "timestamp": 1581748629, "version": "1.1.1", @@ -18,14 +27,6 @@ { "note": "Remove `LibTransactionDecoder` export", "pr": 2464 - }, - { - "note": "Add `DydxBridge` order validation", - "pr": 2466 - }, - { - "note": "Add `D18` library for working with base-10, 18-precision decimals", - "pr": 2466 } ], "timestamp": 1581204851 diff --git a/contracts/dev-utils/contracts/src/D18.sol b/contracts/dev-utils/contracts/src/D18.sol deleted file mode 100644 index d6fde12b0f..0000000000 --- a/contracts/dev-utils/contracts/src/D18.sol +++ /dev/null @@ -1,248 +0,0 @@ -/* - - Copyright 2019 ZeroEx Intl. - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -*/ - -pragma solidity ^0.5.16; - - -/// @dev A library for working with 18 digit, base 10 decimals. -library D18 { - - /// @dev Decimal places for dydx value quantities. - uint256 private constant PRECISION = 18; - /// @dev 1.0 in base-18 decimal. - int256 private constant DECIMAL_ONE = int256(10 ** PRECISION); - /// @dev Minimum signed integer value. - int256 private constant MIN_INT256_VALUE = int256(0x8000000000000000000000000000000000000000000000000000000000000000); - - /// @dev Return `1.0` - function one() - internal - pure - returns (int256 r) - { - r = DECIMAL_ONE; - } - - /// @dev Add two decimals. - function add(int256 a, int256 b) - internal - pure - returns (int256 r) - { - r = _add(a, b); - } - - /// @dev Add two decimals. - function add(uint256 a, int256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _add(int256(a), b); - } - - /// @dev Add two decimals. - function add(int256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _add(a, int256(b)); - } - - /// @dev Add two decimals. - function add(uint256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _add(int256(a), int256(b)); - } - - /// @dev Subract two decimals. - function sub(int256 a, int256 b) - internal - pure - returns (int256 r) - { - r = _add(a, -b); - } - - /// @dev Subract two decimals. - function sub(uint256 a, int256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _add(int256(a), -b); - } - - /// @dev Subract two decimals. - function sub(uint256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _add(int256(a), -int256(b)); - } - - /// @dev Multiply two decimals. - function mul(int256 a, int256 b) - internal - pure - returns (int256 r) - { - r = _div(_mul(a, b), DECIMAL_ONE); - } - - /// @dev Multiply two decimals. - function mul(uint256 a, int256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _div(_mul(int256(a), b), DECIMAL_ONE); - } - - /// @dev Multiply two decimals. - function mul(int256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _div(_mul(a, int256(b)), DECIMAL_ONE); - } - - /// @dev Multiply two decimals. - function mul(uint256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _div(_mul(int256(a), int256(b)), DECIMAL_ONE); - } - - /// @dev Divide two decimals. - function div(int256 a, int256 b) - internal - pure - returns (int256 r) - { - r = _div(_mul(a, DECIMAL_ONE), b); - } - - /// @dev Divide two decimals. - function div(uint256 a, int256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _div(_mul(int256(a), DECIMAL_ONE), b); - } - - /// @dev Divide two decimals. - function div(int256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _div(_mul(a, DECIMAL_ONE), int256(b)); - } - - /// @dev Divide two decimals. - function div(uint256 a, uint256 b) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - require(int256(b) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = _div(_mul(int256(a), DECIMAL_ONE), int256(b)); - } - - /// @dev Safely convert an unsigned integer into a signed integer. - function toSigned(uint256 a) - internal - pure - returns (int256 r) - { - require(int256(a) >= 0, "D18/DECIMAL_VALUE_TOO_BIG"); - r = int256(a); - } - - /// @dev Clip a signed value to be positive. - function clip(int256 a) - internal - pure - returns (int256 r) - { - r = a < 0 ? 0 : a; - } - - /// @dev Safely multiply two signed integers. - function _mul(int256 a, int256 b) - private - pure - returns (int256 r) - { - if (a == 0 || b == 0) { - return 0; - } - r = a * b; - require(r / a == b && r / b == a, "D18/DECIMAL_MUL_OVERFLOW"); - return r; - } - - /// @dev Safely divide two signed integers. - function _div(int256 a, int256 b) - private - pure - returns (int256 r) - { - require(b != 0, "D18/DECIMAL_DIV_BY_ZERO"); - require(a != MIN_INT256_VALUE || b != -1, "D18/DECIMAL_DIV_OVERFLOW"); - r = a / b; - } - - /// @dev Safely add two signed integers. - function _add(int256 a, int256 b) - private - pure - returns (int256 r) - { - r = a + b; - require( - !((a < 0 && b < 0 && r > a) || (a > 0 && b > 0 && r < a)), - "D18/DECIMAL_ADD_OVERFLOW" - ); - } - -} diff --git a/contracts/dev-utils/contracts/src/LibDydxBalance.sol b/contracts/dev-utils/contracts/src/LibDydxBalance.sol index 8718f5368c..4ca815e4b8 100644 --- a/contracts/dev-utils/contracts/src/LibDydxBalance.sol +++ b/contracts/dev-utils/contracts/src/LibDydxBalance.sol @@ -26,8 +26,8 @@ import "@0x/contracts-erc20/contracts/src/LibERC20Token.sol"; import "@0x/contracts-exchange-libs/contracts/src/LibOrder.sol"; import "@0x/contracts-utils/contracts/src/LibBytes.sol"; import "@0x/contracts-utils/contracts/src/LibSafeMath.sol"; +import "@0x/contracts-utils/contracts/src/D18.sol"; import "./LibAssetData.sol"; -import "./D18.sol"; library LibDydxBalance { diff --git a/contracts/dev-utils/package.json b/contracts/dev-utils/package.json index 3dd5b99b23..b3cf58b3ee 100644 --- a/contracts/dev-utils/package.json +++ b/contracts/dev-utils/package.json @@ -28,7 +28,7 @@ }, "config": { "publicInterfaceContracts": "DevUtils,LibAssetData,LibDydxBalance,LibOrderTransferSimulation,LibTransactionDecoder", - "abis": "./test/generated-artifacts/@(Addresses|AssetBalance|D18|DevUtils|EthBalanceChecker|ExternalFunctions|LibAssetData|LibDydxBalance|LibOrderTransferSimulation|LibTransactionDecoder|OrderTransferSimulationUtils|OrderValidationUtils|TestDydx|TestLibDydxBalance).json", + "abis": "./test/generated-artifacts/@(Addresses|AssetBalance|DevUtils|EthBalanceChecker|ExternalFunctions|LibAssetData|LibDydxBalance|LibOrderTransferSimulation|LibTransactionDecoder|OrderTransferSimulationUtils|OrderValidationUtils|TestDydx|TestLibDydxBalance).json", "abis:comment": "This list is auto-generated by contracts-gen. Don't edit manually." }, "repository": { diff --git a/contracts/dev-utils/test/artifacts.ts b/contracts/dev-utils/test/artifacts.ts index a4ff20758e..e4c1802bc0 100644 --- a/contracts/dev-utils/test/artifacts.ts +++ b/contracts/dev-utils/test/artifacts.ts @@ -7,7 +7,6 @@ import { ContractArtifact } from 'ethereum-types'; import * as Addresses from '../test/generated-artifacts/Addresses.json'; import * as AssetBalance from '../test/generated-artifacts/AssetBalance.json'; -import * as D18 from '../test/generated-artifacts/D18.json'; import * as DevUtils from '../test/generated-artifacts/DevUtils.json'; import * as EthBalanceChecker from '../test/generated-artifacts/EthBalanceChecker.json'; import * as ExternalFunctions from '../test/generated-artifacts/ExternalFunctions.json'; @@ -22,7 +21,6 @@ import * as TestLibDydxBalance from '../test/generated-artifacts/TestLibDydxBala export const artifacts = { Addresses: Addresses as ContractArtifact, AssetBalance: AssetBalance as ContractArtifact, - D18: D18 as ContractArtifact, DevUtils: DevUtils as ContractArtifact, EthBalanceChecker: EthBalanceChecker as ContractArtifact, ExternalFunctions: ExternalFunctions as ContractArtifact, diff --git a/contracts/dev-utils/test/wrappers.ts b/contracts/dev-utils/test/wrappers.ts index 587e4c6281..01f291fa09 100644 --- a/contracts/dev-utils/test/wrappers.ts +++ b/contracts/dev-utils/test/wrappers.ts @@ -5,7 +5,6 @@ */ export * from '../test/generated-wrappers/addresses'; export * from '../test/generated-wrappers/asset_balance'; -export * from '../test/generated-wrappers/d18'; export * from '../test/generated-wrappers/dev_utils'; export * from '../test/generated-wrappers/eth_balance_checker'; export * from '../test/generated-wrappers/external_functions'; diff --git a/contracts/dev-utils/tsconfig.json b/contracts/dev-utils/tsconfig.json index b2b229e0c7..eccc9bf633 100644 --- a/contracts/dev-utils/tsconfig.json +++ b/contracts/dev-utils/tsconfig.json @@ -10,7 +10,6 @@ "generated-artifacts/LibTransactionDecoder.json", "test/generated-artifacts/Addresses.json", "test/generated-artifacts/AssetBalance.json", - "test/generated-artifacts/D18.json", "test/generated-artifacts/DevUtils.json", "test/generated-artifacts/EthBalanceChecker.json", "test/generated-artifacts/ExternalFunctions.json",