Merge branch 'main' into transfer-helper-cleanup

yueh-github · Jul 6, 2022 · 5fe181d · 5fe181d
2 parents a2afe34 + c30dd90
commit 5fe181d
Show file tree

Hide file tree

Showing 73 changed files with 583 additions and 361 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -1,4 +1,4 @@
-name: Consideration Test CI
+name: Seaport Test CI
 
 on: [push, pull_request]
 
@@ -150,10 +150,10 @@ jobs:
       - run: yarn install
       - run: yarn build
       - run: yarn coverage
-      - uses: VeryGoodOpenSource/very_good_coverage@v1
+      - uses: codecov/codecov-action@v3
         with:
-          path: "./coverage/lcov.info"
-          min_coverage: 100
+          files: ./coverage/lcov.info
+          flags: production
 
   reference-coverage:
     name: Run Reference Coverage Tests
@@ -177,7 +177,7 @@ jobs:
       - run: yarn build
       - run: yarn build:ref
       - run: yarn coverage:ref
-      - uses: VeryGoodOpenSource/very_good_coverage@v1
+      - uses: codecov/codecov-action@v3
         with:
-          path: "./coverage/lcov.info"
-          min_coverage: 100
+          files: ./coverage/lcov.info
+          flags: reference
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -6,6 +6,7 @@ module.exports = {
         tabWidth: 4,
         printWidth: 80,
         bracketSpacing: true,
+        compiler: "0.8.14",
       },
     },
   ],

diff --git a/README.md b/README.md
@@ -1,5 +1,12 @@
 ![Seaport](img/Seaport-banner.png)
 
+[![Version][version-badge]][version-link]
+[![Test CI][ci-badge]][ci-link]
+[![Code Coverage][coverage-badge]][coverage-link]
+[![License][license-badge]][license-link]
+[![Docs][docs-badge]][docs-link]
+[![Discussions][discussions-badge]][discussions-link]
+
 # Seaport
 
 Seaport is a new marketplace protocol for safely and efficiently buying and selling NFTs.
@@ -52,11 +59,23 @@ See the [documentation](docs/SeaportDocumentation.md), the [interface](contracts
 <tr><td>Optimistic Kovan</td></tr>
 <tr><td>Arbitrum</td></tr>
 <tr><td>Arbitrum Rinkeby</td></tr>
+<tr><td>Avalanche Fuji</td></tr>
+<tr><td>Avalanche C-Chain</td></tr>
 <tr><td>Gnosis Chain</td></tr>
-<tr><td>Klaytn</td></tr>
-<tr><td>Baobab</td></tr>
 </table>
 
+To be deployed on other EVM chains, such as:
+
+- Klaytn
+- Baobab
+- Skale
+- Celo
+- BSC
+- Fantom
+- RSK
+
+To deploy to a new EVM chain, follow the [steps outlined here](docs/Deployment.md).
+
 ## Diagram
 
 ```mermaid
@@ -223,3 +242,16 @@ When making a pull request, ensure that:
 ## License
 
 [MIT](LICENSE) Copyright 2022 Ozone Networks, Inc.
+
+[version-badge]: https://img.shields.io/github/package-json/v/ProjectOpenSea/seaport
+[version-link]: https://github.com/ProjectOpenSea/seaport/releases
+[ci-badge]: https://github.com/ProjectOpenSea/seaport/actions/workflows/test.yml/badge.svg
+[ci-link]: https://github.com/ProjectOpenSea/seaport/actions/workflows/test.yml
+[coverage-badge]: https://codecov.io/gh/ProjectOpenSea/seaport/branch/main/graph/badge.svg
+[coverage-link]: https://codecov.io/gh/ProjectOpenSea/seaport
+[license-badge]: https://img.shields.io/github/license/ProjectOpenSea/seaport
+[license-link]: https://github.com/ProjectOpenSea/seaport/blob/main/LICENSE
+[docs-badge]: https://img.shields.io/badge/Seaport-documentation-informational
+[docs-link]: https://github.com/ProjectOpenSea/seaport/tree/main/docs
+[discussions-badge]: https://img.shields.io/badge/Seaport-discussions-blueviolet
+[discussions-link]: https://github.com/ProjectOpenSea/seaport/discussions
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,11 @@
+coverage:
+  range: 100..100
+  round: down
+  precision: 2
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 0%
+        base: auto
+        if_ci_failed: error
diff --git a/contracts/conduit/Conduit.sol b/contracts/conduit/Conduit.sol
@@ -7,7 +7,6 @@ import { ConduitItemType } from "./lib/ConduitEnums.sol";
 
 import { TokenTransferrer } from "../lib/TokenTransferrer.sol";
 
-// prettier-ignore
 import {
     ConduitTransfer,
     ConduitBatch1155Transfer

diff --git a/contracts/conduit/ConduitController.sol b/contracts/conduit/ConduitController.sol
@@ -1,9 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
-	ConduitControllerInterface
+    ConduitControllerInterface
 } from "../interfaces/ConduitControllerInterface.sol";
 
 import { ConduitInterface } from "../interfaces/ConduitInterface.sol";

diff --git a/contracts/helpers/TransferHelper.sol b/contracts/helpers/TransferHelper.sol
@@ -12,7 +12,6 @@ import {
 
 import { ConduitInterface } from "../interfaces/ConduitInterface.sol";
 
-// prettier-ignore
 import {
     ConduitControllerInterface
 } from "../interfaces/ConduitControllerInterface.sol";
@@ -21,7 +20,6 @@ import { Conduit } from "../conduit/Conduit.sol";
 
 import { ConduitTransfer } from "../conduit/lib/ConduitStructs.sol";
 
-// prettier-ignore
 import {
     TransferHelperInterface
 } from "../interfaces/TransferHelperInterface.sol";

diff --git a/contracts/interfaces/ConduitInterface.sol b/contracts/interfaces/ConduitInterface.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
     ConduitTransfer,
     ConduitBatch1155Transfer

diff --git a/contracts/interfaces/ConsiderationInterface.sol b/contracts/interfaces/ConsiderationInterface.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
     BasicOrderParameters,
     OrderComponents,

diff --git a/contracts/interfaces/SeaportInterface.sol b/contracts/interfaces/SeaportInterface.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
     BasicOrderParameters,
     OrderComponents,

diff --git a/contracts/interfaces/ZoneInterface.sol b/contracts/interfaces/ZoneInterface.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
     AdvancedOrder,
     CriteriaResolver

diff --git a/contracts/lib/AmountDeriver.sol b/contracts/lib/AmountDeriver.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
-// prettier-ignore
 import {
     AmountDerivationErrors
 } from "../interfaces/AmountDerivationErrors.sol";

diff --git a/contracts/lib/Assertions.sol b/contracts/lib/Assertions.sol
@@ -5,7 +5,6 @@ import { OrderParameters } from "./ConsiderationStructs.sol";
 
 import { GettersAndDerivers } from "./GettersAndDerivers.sol";
 
-// prettier-ignore
 import {
     TokenTransferrerErrors
 } from "../interfaces/TokenTransferrerErrors.sol";

diff --git a/contracts/lib/BasicOrderFulfiller.sol b/contracts/lib/BasicOrderFulfiller.sol
@@ -3,14 +3,12 @@ pragma solidity ^0.8.13;
 
 import { ConduitInterface } from "../interfaces/ConduitInterface.sol";
 
-// prettier-ignore
 import {
     OrderType,
     ItemType,
     BasicOrderRouteType
 } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import {
     AdditionalRecipient,
     BasicOrderParameters,

diff --git a/contracts/lib/Consideration.sol b/contracts/lib/Consideration.sol
@@ -1,12 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
-// prettier-ignore
 import {
     ConsiderationInterface
 } from "../interfaces/ConsiderationInterface.sol";
 
-// prettier-ignore
 import {
     OrderComponents,
     BasicOrderParameters,

diff --git a/contracts/lib/ConsiderationBase.sol b/contracts/lib/ConsiderationBase.sol
@@ -1,12 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
-// prettier-ignore
 import {
     ConduitControllerInterface
 } from "../interfaces/ConduitControllerInterface.sol";
 
-// prettier-ignore
 import {
     ConsiderationEventsAndErrors
 } from "../interfaces/ConsiderationEventsAndErrors.sol";

diff --git a/contracts/lib/ConsiderationStructs.sol b/contracts/lib/ConsiderationStructs.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
     OrderType,
     BasicOrderType,

diff --git a/contracts/lib/CounterManager.sol b/contracts/lib/CounterManager.sol
@@ -1,7 +1,6 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.13;
 
-// prettier-ignore
 import {
     ConsiderationEventsAndErrors
 } from "../interfaces/ConsiderationEventsAndErrors.sol";

diff --git a/contracts/lib/CriteriaResolution.sol b/contracts/lib/CriteriaResolution.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.13;
 
 import { ItemType, Side } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import {
     OfferItem,
     ConsiderationItem,
@@ -14,7 +13,6 @@ import {
 
 import "./ConsiderationConstants.sol";
 
-// prettier-ignore
 import {
     CriteriaResolutionErrors
 } from "../interfaces/CriteriaResolutionErrors.sol";

diff --git a/contracts/lib/FulfillmentApplier.sol b/contracts/lib/FulfillmentApplier.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.13;
 
 import { ItemType, Side } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import {
     OfferItem,
     ConsiderationItem,
@@ -16,7 +15,6 @@ import {
 
 import "./ConsiderationConstants.sol";
 
-// prettier-ignore
 import {
     FulfillmentApplicationErrors
 } from "../interfaces/FulfillmentApplicationErrors.sol";

diff --git a/contracts/lib/OrderCombiner.sol b/contracts/lib/OrderCombiner.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.13;
 
 import { Side, ItemType } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import {
     OfferItem,
     ConsiderationItem,

diff --git a/contracts/lib/OrderFulfiller.sol b/contracts/lib/OrderFulfiller.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.13;
 
 import { ItemType } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import {
     OfferItem,
     ConsiderationItem,

diff --git a/contracts/lib/OrderValidator.sol b/contracts/lib/OrderValidator.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.13;
 
 import { OrderType } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import {
     OrderParameters,
     Order,

diff --git a/contracts/lib/SignatureVerification.sol b/contracts/lib/SignatureVerification.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.13;
 
 import { EIP1271Interface } from "../interfaces/EIP1271Interface.sol";
 
-// prettier-ignore
 import {
     SignatureVerificationErrors
 } from "../interfaces/SignatureVerificationErrors.sol";

diff --git a/contracts/lib/TokenTransferrer.sol b/contracts/lib/TokenTransferrer.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.7;
 
 import "./TokenTransferrerConstants.sol";
 
-// prettier-ignore
 import {
     TokenTransferrerErrors
 } from "../interfaces/TokenTransferrerErrors.sol";

diff --git a/contracts/lib/ZoneInteraction.sol b/contracts/lib/ZoneInteraction.sol
@@ -5,15 +5,11 @@ import { ZoneInterface } from "../interfaces/ZoneInterface.sol";
 
 import { OrderType } from "./ConsiderationEnums.sol";
 
-// prettier-ignore
 import { AdvancedOrder, CriteriaResolver } from "./ConsiderationStructs.sol";
 
 import "./ConsiderationConstants.sol";
 
-// prettier-ignore
-import {
-    ZoneInteractionErrors
-} from "../interfaces/ZoneInteractionErrors.sol";
+import { ZoneInteractionErrors } from "../interfaces/ZoneInteractionErrors.sol";
 
 import { LowLevelHelpers } from "./LowLevelHelpers.sol";
 

diff --git a/contracts/test/TestZone.sol b/contracts/test/TestZone.sol
@@ -3,7 +3,6 @@ pragma solidity ^0.8.7;
 
 import { ZoneInterface } from "../interfaces/ZoneInterface.sol";
 
-// prettier-ignore
 import {
     AdvancedOrder,
     CriteriaResolver

diff --git a/package.json b/package.json
@@ -51,9 +51,11 @@
   "resolutions": {
     "async": ">=2.6.4",
     "cross-fetch": ">=3.1.5",
+    "got": ">=11.8.5",
     "lodash": ">=4.17.21",
     "node-fetch": ">=2.6.7",
     "underscore": ">=1.12.1",
+    "undici": ">=5.5.1",
     "yargs-parser": ">=5.0.1"
   },
   "scripts": {

diff --git a/reference/ReferenceConsideration.sol b/reference/ReferenceConsideration.sol
@@ -1,12 +1,10 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.7;
 
-// prettier-ignore
 import {
     ConsiderationInterface
 } from "contracts/interfaces/ConsiderationInterface.sol";
 
-// prettier-ignore
 import {
     OrderComponents,
     BasicOrderParameters,
@@ -22,7 +20,10 @@ import {
 
 import { ReferenceOrderCombiner } from "./lib/ReferenceOrderCombiner.sol";
 
-import { OrderToExecute, AccumulatorStruct } from "./lib/ReferenceConsiderationStructs.sol";
+import {
+    OrderToExecute,
+    AccumulatorStruct
+} from "./lib/ReferenceConsiderationStructs.sol";
 
 /**
  * @title ReferenceConsideration

diff --git a/reference/conduit/ReferenceConduit.sol b/reference/conduit/ReferenceConduit.sol
@@ -5,12 +5,10 @@ import { ConduitInterface } from "contracts/interfaces/ConduitInterface.sol";
 
 import { ConduitItemType } from "contracts/conduit/lib/ConduitEnums.sol";
 
-// prettier-ignore
 import {
     ReferenceTokenTransferrer
 } from "../lib/ReferenceTokenTransferrer.sol";
 
-// prettier-ignore
 import {
     ConduitTransfer,
     ConduitBatch1155Transfer