@solidstate/abdk-math-extensions 1.0.0

package/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2022 Nick Barry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,61 @@
+# SolidState Extensions for ABDK Libraries
+
+SolidState extensions for the `abdk-libraries-solidity` [package](https://www.npmjs.com/package/abdk-libraries-solidity). Developed as a part of the [Premia Finance smart contracts](https://github.com/Premian-Labs/premia-contracts). SolidState, Premia, and this package are not affiliated with ABDK.
+
+## Installation
+
+Install the package as well as the required ABDK package as development dependencies:
+
+```bash
+yarn add --dev @solidstate/abdk-math-extensions abdk-libraries-solidity
+```
+
+## Development
+
+Install dependencies via Yarn:
+
+```bash
+yarn install
+```
+
+Setup Husky to format code on commit:
+
+```bash
+yarn prepare
+```
+
+Compile contracts via Hardhat:
+
+```bash
+yarn run hardhat compile
+```
+
+The Hardhat environment relies on the following environment variables. The `dotenv` package will attempt to read them from the `.env` file, if it is present.
+
+| Key          | Description                                                   |
+| ------------ | ------------------------------------------------------------- |
+| `REPORT_GAS` | if `true`, a gas report will be generated after running tests |
+
+### Networks
+
+By default, Hardhat uses the Hardhat Network in-process. Two additional networks, `mainnet` and `testnet` are available, and their behavior is determined by the configuration of environment variables.
+
+### Testing
+
+Test contracts via Hardhat:
+
+```bash
+yarn run hardhat test
+```
+
+Activate gas usage reporting by setting the `REPORT_GAS` environment variable to `"true"`:
+
+```bash
+REPORT_GAS=true yarn run hardhat test
+```
+
+Generate a code coverage report using `solidity-coverage`:
+
+```bash
+yarn run hardhat coverage
+```

package/contracts/ABDKMath64x64Token.sol

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import { ABDKMath64x64 } from 'abdk-libraries-solidity/ABDKMath64x64.sol';
+
+/**
+ * @title SolidState token extensions for ABDKMath64x64 library
+ */
+library ABDKMath64x64Token {
+    using ABDKMath64x64 for int128;
+
+    /**
+     * @notice convert 64x64 fixed point representation of token amount to decimal
+     * @param value64x64 64x64 fixed point representation of token amount
+     * @param decimals token display decimals
+     * @return value decimal representation of token amount
+     */
+    function toDecimals(int128 value64x64, uint8 decimals)
+        internal
+        pure
+        returns (uint256 value)
+    {
+        value = value64x64.mulu(10**decimals);
+    }
+
+    /**
+     * @notice convert decimal representation of token amount to 64x64 fixed point
+     * @param value decimal representation of token amount
+     * @param decimals token display decimals
+     * @return value64x64 64x64 fixed point representation of token amount
+     */
+    function fromDecimals(uint256 value, uint8 decimals)
+        internal
+        pure
+        returns (int128 value64x64)
+    {
+        value64x64 = ABDKMath64x64.divu(value, 10**decimals);
+    }
+
+    /**
+     * @notice convert 64x64 fixed point representation of token amount to wei (18 decimals)
+     * @param value64x64 64x64 fixed point representation of token amount
+     * @return value wei representation of token amount
+     */
+    function toWei(int128 value64x64) internal pure returns (uint256 value) {
+        value = toDecimals(value64x64, 18);
+    }
+
+    /**
+     * @notice convert wei representation (18 decimals) of token amount to 64x64 fixed point
+     * @param value wei representation of token amount
+     * @return value64x64 64x64 fixed point representation of token amount
+     */
+    function fromWei(uint256 value) internal pure returns (int128 value64x64) {
+        value64x64 = fromDecimals(value, 18);
+    }
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@solidstate/abdk-math-extensions",
+  "version": "1.0.0",
+  "author": "Nick Barry",
+  "license": "MIT",
+  "description": "SolidState extensions for the ABDK Solidity libraries",
+  "repository": "github:solidstate-network/abdk-math-extensions",
+  "keywords": [
+    "solidity",
+    "smart-contracts",
+    "abdk",
+    "math",
+    "fixed-point",
+    "ethereum",
+    "ether",
+    "eth",
+    "cryptocurrency",
+    "crypto",
+    "wow",
+    "library",
+    "hardhat",
+    "buidler"
+  ],
+  "scripts": {
+    "prepare": "husky install",
+    "prettier": "prettier --write --ignore-path .gitignore ."
+  },
+  "devDependencies": {
+    "@nomiclabs/hardhat-ethers": "^2.0.5",
+    "@nomiclabs/hardhat-waffle": "^2.0.3",
+    "@typechain/ethers-v5": "^10.0.0",
+    "@typechain/hardhat": "^6.0.0",
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^17.0.31",
+    "abdk-libraries-solidity": "^3.0.0",
+    "chai": "^4.3.6",
+    "dotenv": "^16.0.0",
+    "ethereum-waffle": "^3.4.4",
+    "ethers": "5.6.0",
+    "hardhat": "2.9.2",
+    "hardhat-exposed": "^0.2.3",
+    "hardhat-gas-reporter": "^1.0.8",
+    "hardhat-spdx-license-identifier": "^2.0.3",
+    "husky": "^7.0.4",
+    "lint-staged": "^12.4.1",
+    "prettier": "^2.6.2",
+    "prettier-plugin-solidity": "^1.0.0-beta.19",
+    "solidity-coverage": "^0.7.21",
+    "ts-node": "^10.7.0",
+    "typechain": "^8.0.0",
+    "typescript": "^4.6.4"
+  },
+  "peerDependencies": {
+    "abdk-libraries-solidity": "^3.0.0"
+  },
+  "files": [
+    "contracts/*.sol"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}