@diwantanushh/rapiddex-contracts 1.0.0

package/lib/v3-core-main/.github/workflows/tests.yml

@@ -0,0 +1,38 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  unit-tests:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+
+      - uses: actions/cache@v1
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            yarn-
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      # This is required separately from yarn test because it generates the typechain definitions
+      - name: Compile
+        run: yarn compile
+
+      - name: Run unit tests
+        run: yarn test

package/lib/v3-core-main/.prettierrc

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 120
+}

package/lib/v3-core-main/.solhint.json

@@ -0,0 +1,6 @@
+{
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": "error"
+  }
+}

package/lib/v3-core-main/.yarnrc

@@ -0,0 +1 @@
+ignore-scripts true

package/lib/v3-core-main/LICENSE

@@ -0,0 +1,100 @@
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Parameters
+
+Licensor:             Uniswap Labs
+
+Licensed Work:        Uniswap V3 Core
+                      The Licensed Work is (c) 2021 Uniswap Labs
+
+Additional Use Grant: Any uses listed and defined at
+                      v3-core-license-grants.uniswap.eth
+
+Change Date:          The earlier of 2023-04-01 or a date specified at
+                      v3-core-license-date.uniswap.eth
+
+Change License:       GNU General Public License v2.0 or later
+
+-----------------------------------------------------------------------------
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor below.
+
+-----------------------------------------------------------------------------
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the "Business
+Source License" name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where "compatible" means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text "None".
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.
+
+-----------------------------------------------------------------------------
+
+Notice
+
+The Business Source License (this document, or the "License") is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.

package/lib/v3-core-main/README.md

@@ -0,0 +1,66 @@
+# Uniswap V3
+
+[![Lint](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/lint.yml/badge.svg)](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/lint.yml)
+[![Tests](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/tests.yml/badge.svg)](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/tests.yml)
+[![Fuzz Testing](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/fuzz-testing.yml/badge.svg)](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/fuzz-testing.yml)
+[![Mythx](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/mythx.yml/badge.svg)](https://github.com/Uniswap/uniswap-v3-core/actions/workflows/mythx.yml)
+[![npm version](https://img.shields.io/npm/v/@uniswap/v3-core/latest.svg)](https://www.npmjs.com/package/@uniswap/v3-core/v/latest)
+
+This repository contains the core smart contracts for the Uniswap V3 Protocol.
+For higher level contracts, see the [uniswap-v3-periphery](https://github.com/Uniswap/uniswap-v3-periphery)
+repository.
+
+## Bug bounty
+
+This repository is subject to the Uniswap V3 bug bounty program, per the terms defined [here](./bug-bounty.md).
+
+## Local deployment
+
+In order to deploy this code to a local testnet, you should install the npm package
+`@uniswap/v3-core`
+and import the factory bytecode located at
+`@uniswap/v3-core/artifacts/contracts/UniswapV3Factory.sol/UniswapV3Factory.json`.
+For example:
+
+```typescript
+import {
+  abi as FACTORY_ABI,
+  bytecode as FACTORY_BYTECODE,
+} from '@uniswap/v3-core/artifacts/contracts/UniswapV3Factory.sol/UniswapV3Factory.json'
+
+// deploy the bytecode
+```
+
+This will ensure that you are testing against the same bytecode that is deployed to
+mainnet and public testnets, and all Uniswap code will correctly interoperate with
+your local deployment.
+
+## Using solidity interfaces
+
+The Uniswap v3 interfaces are available for import into solidity smart contracts
+via the npm artifact `@uniswap/v3-core`, e.g.:
+
+```solidity
+import '@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol';
+
+contract MyContract {
+  IUniswapV3Pool pool;
+
+  function doSomethingWithPool() {
+    // pool.swap(...);
+  }
+}
+
+```
+
+## Licensing
+
+The primary license for Uniswap V3 Core is the Business Source License 1.1 (`BUSL-1.1`), see [`LICENSE`](./LICENSE). However, some files are dual licensed under `GPL-2.0-or-later`:
+
+- All files in `contracts/interfaces/` may also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers), see [`contracts/interfaces/LICENSE`](./contracts/interfaces/LICENSE)
+- Several files in `contracts/libraries/` may also be licensed under `GPL-2.0-or-later` (as indicated in their SPDX headers), see [`contracts/libraries/LICENSE`](contracts/libraries/LICENSE)
+
+### Other Exceptions
+
+- `contracts/libraries/FullMath.sol` is licensed under `MIT` (as indicated in its SPDX header), see [`contracts/libraries/LICENSE_MIT`](contracts/libraries/LICENSE_MIT)
+- All files in `contracts/test` remain unlicensed (as indicated in their SPDX headers).

package/lib/v3-core-main/audits/tob/README.md

@@ -0,0 +1,166 @@
+The following contains the properties written by Trail of Bits.
+
+- [End to End testing with Echidna](#end-to-end-testing-with-echidna)
+- [Verification with Manticore](#verification-with-manticore)
+
+# End to End testing with Echidna
+
+We've implemented end-to-end properties for the Uniswap V3 Core pool contract.
+
+## Installation
+
+In order to run this, you need to install [echidna 1.7.0](https://github.com/crytic/echidna/releases/tag/v1.7.0).
+
+## Run
+
+Assuming you're in the root of the repo
+
+```
+echidna-test contracts/crytic/echidna/E2E_swap.sol --config contracts/crytic/echidna/E2E_swap.config.yaml --contract E2E_swap
+
+echidna-test contracts/crytic/echidna/E2E_mint_burn.sol --config contracts/crytic/echidna/E2E_mint_burn.config.yaml --contract E2E_mint_burn
+
+echidna-test contracts/crytic/echidna/Other.sol --config contracts/crytic/echidna/Other.config.yaml --contract Other
+```
+
+## Random but valid pool initialisation, created positions, and priceLimits
+
+To help Echidna to get good coverage we've used multiple helper functions to:
+
+- create random but valid pool initialization params (fee, tickSpacing, initial price) before doing swaps or mint/burn [link](./E2E_mint_burn.sol#L303-L337) [link](./E2E_swap.sol#L196-L230)
+- create a random number of random but valid positions before testing swaps [link](./E2E_swap.sol#L233-L283)
+- create a random but valid priceLimit when doing swap [link](./E2E_swap.sol#L68-L80)
+- create random but valid position params when doing mint [link](./E2E_mint_burn.sol#L102-L130)
+
+By doing the above Echidna will be able to test the actual properties we want to test instead of bashing it's head against using an invalid priceLimit or invalid position params. The above also allows the creation of a dynamic number of random positions before executing swaps instead of using a static list.
+
+To achieve the above random but valid outcomes we use the `uint128 _amount` of swap/mint/burn as a seed to create randomness in the helper functions. This also means that retrieving the exact used params is not very straightforward. However, through a combination of hardhat `console.sol` and writing a small js unit test it's possible to retrieve the exact used params of every (list of) call(s).
+
+## Adjust hardhat.config.ts
+
+The Echidna contracts cost too much gas to deploy due to all the calls inside the constructor.
+
+Adjust the `hardhat.config.ts` to:
+
+```json
+hardhat: {
+    allowUnlimitedContractSize: true,
+    gas: 950000000,
+    blockGasLimit: 950000000,
+    gasPrice: 1,
+},
+```
+
+### E2E_swap: retrieving the pool initialisation params and created positions
+
+The pool initialisation and created positions is deterministic and there is a `view` function that will return whatever a specific `_amount` (used as `_seed`) will create.
+
+Write a js unit test:
+
+```js
+console.log(await E2E_swap.viewRandomInit('<the _amount of the first swap call>'))
+```
+
+### E2E_swap: retrieving the used priceLimit of a swap
+
+The priceLimit depends on the state of the pool contract, it is therefore easiest to retrieve by using hardhat's `console.sol`.
+
+Uncomment the following lines:
+
+- at the top of `E2E_swap.sol`: `// import 'hardhat/console.sol';`
+- inside the swap functions: `// console.log('sqrtPriceLimitX96 = %s', sqrtPriceLimitX96); `
+
+Instead of just one swap call, imagine Echidna reports two swap calls, and the second one causes an assertion failure.
+
+```js
+// to get pool params + created positions
+console.log(await E2E_swap.viewRandomInit('<the _amount of the first swap call>'))
+
+// execute the swap, which will create the above and log the used priceLimit to the console
+await E2E_swap.test_swap_exactOut_oneForZero('<the _amount of the first swap call>')
+
+// execute the swap, logs the used priceLimit to the console
+await E2E_swap.test_swap_exactIn_oneForZero('<the _amount of the second swap call>')
+```
+
+### E2E_mint_burn: retrieving the pool initialisation params
+
+The pool initialisation params creation is deterministic and there is a `view` function that will return whatever a specific `_amount` (used as `_seed`) will create.
+
+Write a js unit test:
+
+```js
+console.log(await E2E_mint_burn.viewInitRandomPoolParams('<the _amount of the first mint call>'))
+```
+
+### E2E_mint_burn: retrieving a mint's created random position
+
+```js
+const poolInitParams = await E2E_mint_burn.viewInitRandomPoolParams('<the _amount of the first mint call>')
+
+const positionParams = await E2E_mint_burn.viewMintRandomNewPosition(
+  '<the _amount of the first mint call>',
+  poolInitParams.tickSpacing,
+  poolInitParams.tickCount,
+  poolInitParams.maxTick
+)
+
+console.log(positionParams)
+```
+
+### E2E_mint_burn: retrieving a burn's used position
+
+Uncomment the following lines:
+
+- at the top of `E2E_mint_burn.sol`: `// import 'hardhat/console.sol';`
+- inside the particular burn function: `// console.log('burn posIdx = %s', posIdx);`
+- if this is a partial burn, also want to see the burned amount. inside the `test_burn_partial` function: `// console.log('burn amount = %s', burnAmount);`
+
+Then execute the burn in a js test.
+
+```js
+// show pool init params
+const poolInitParams = await E2E_mint_burn.viewInitRandomPoolParams('<the _amount of the first mint call>')
+console.log(positionParams)
+
+// show pool mint position params
+const positionParams = await E2E_mint_burn.viewMintRandomNewPosition(
+  '<the _amount of the first mint call>',
+  poolInitParams.tickSpacing,
+  poolInitParams.tickCount,
+  poolInitParams.maxTick
+)
+console.log(positionParams)
+
+// execute the first mint
+await E2E_mint_burn.test_mint('<the _amount of the first mint call>')
+
+// execute the burn
+await E2E_mint_burn.test_burn_partial('<the _amount of the first test_burn_partial call>')
+// this should log the index of the position that was burned to the console
+// as well as the amount that was burned.
+// together with the above output this should make it clear which exact position
+// was burned and how much
+```
+
+# Verification with Manticore
+
+The verification was performed with the experimental branch [dev-evm-experiments](https://github.com/trailofbits/manticore/tree/dev-evm-experiments), which contains new optimizations and is a work in progress. Trail of Bits will ensure that the following properties hold once the branch has stabilized and been included in a Manticore release.
+
+For conveniance, we followed the pattern "if there is reacheable path, there is a bug".
+
+To verify a property, run:
+
+```
+manticore . --contract CONTRACT_NAME --txlimit 1 --smt.solver all --quick-mode --lazy-evaluation --core.procs 1
+```
+
+> The command might change once `dev-evm-experiments` has stabilized
+
+Manticore will create a `mcore_X` directory. If no `X.tx` file is generated, it means that Manticore did not find a path violating the property.
+
+| ID  | Description                                                                                          | Contract                                                              | Status   |
+| --- | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------- |
+| 01  | `BitMath.mostSignificantBit returns a value in x >= 2**msb && (msb == 255 or x < 2**(msb+1)).`       | [`VerifyBitMathMsb`](./contracts/crytic/manticore/001.sol)            | Verified |
+| 02  | `BitMath.leastSignificantBit returns a value in ((x & 2** lsb) != 0) && ((x & (2**(lsb -1))) == 0).` | [`VerifyBitMathLsb`](./contracts/crytic/manticore/002.sol)            | Verified |
+| 03  | `If LiquidityMath.addDelta returns, the value will be equal to x + uint128(y).`                      | [`VerifyLiquidityMathAddDelta`](./contracts/crytic/manticore/003.sol) | Verified |

package/lib/v3-core-main/audits/tob/contracts/crytic/echidna/E2E_mint_burn.config.yaml

@@ -0,0 +1,16 @@
+checkAsserts: true
+coverage: true
+codeSize: 0x60000
+corpusDir: echidna_e2e_mint_burn_corpus
+seqLen: 10
+testLimit: 100000
+timeout: 600 # 10 minutes
+
+# blacklist
+filterFunctions:
+  [
+    'E2E_mint_burn.viewInitRandomPoolParams(uint128)',
+    'E2E_mint_burn.viewMintRandomNewPosition(uint128,int24,uint24,int24)',
+    'E2E_mint_burn.viewBurnRandomPositionIdx(uint128,uint128)',
+    'E2E_mint_burn.viewBurnRandomPositionBurnAmount(uint128,uint128)',
+  ]