add in the acquireTokens method along with stargate interface /w test…

…s - move from absolute paths to relative for starport-core in src (#81) * add in the acquireTokens method along with stargate interface /w tests - move from absolute paths to relative for starport-core in src * feat: bump forge-std version --------- Co-authored-by: Joseph Delong <[email protected]>
AstariaXYZ · Dec 3, 2023 · 5731b5f · 5731b5f
1 parent 8ac5598
commit 5731b5f
Show file tree

Hide file tree

Showing 24 changed files with 228 additions and 181 deletions.
diff --git a/.gas-snapshot b/.gas-snapshot
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/src/Starport.sol b/src/Starport.sol
@@ -40,6 +40,10 @@ import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
 import {SafeTransferLib} from "solady/src/utils/SafeTransferLib.sol";
 import {SignatureCheckerLib} from "solady/src/utils/SignatureCheckerLib.sol";
 
+interface Stargate {
+    function getOwner(address) external returns (address);
+}
+
 contract Starport is PausableNonReentrant {
     using FixedPointMathLib for uint256;
     using {StarportLib.getId} for Starport.Loan;
@@ -85,6 +89,7 @@ contract Starport is PausableNonReentrant {
     bytes32 private constant _INVALID_LOAN = 0x045f33d100000000000000000000000000000000000000000000000000000000;
     bytes32 private constant _LOAN_EXISTS = 0x14ec57fc00000000000000000000000000000000000000000000000000000000;
 
+    Stargate public immutable SG;
     address public immutable defaultCustodian;
     bytes32 public immutable DEFAULT_CUSTODIAN_CODE_HASH;
 
@@ -154,7 +159,8 @@ contract Starport is PausableNonReentrant {
     /*                        CONSTRUCTOR                         */
     /*.•°:°.´+˚.*°.˚:*.´•*.+°.•°:´*.´•*.•°.•°:°.´:•˚°.*°.˚:*.´+°.•*/
 
-    constructor(address seaport_) {
+    constructor(address seaport_, Stargate stargate_) {
+        SG = stargate_;
         address custodian = address(new Custodian(this, seaport_));
 
         bytes32 defaultCustodianCodeHash;
@@ -628,6 +634,10 @@ contract Starport is PausableNonReentrant {
         }
     }
 
+    function acquireTokens(SpentItem[] memory items) external {
+        StarportLib.transferSpentItems(items, SG.getOwner(msg.sender), msg.sender, false);
+    }
+
     /**
      * @dev Issues a LM token if needed, only owner can call
      * @param loan The loan to issue

diff --git a/src/enforcers/BorrowerEnforcer.sol b/src/enforcers/BorrowerEnforcer.sol
@@ -27,9 +27,9 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {CaveatEnforcer} from "starport-core/enforcers/CaveatEnforcer.sol";
-import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {CaveatEnforcer} from "../enforcers/CaveatEnforcer.sol";
+import {AdditionalTransfer} from "../lib/StarportLib.sol";
 
 import {ConsiderationInterface} from "seaport-types/src/interfaces/ConsiderationInterface.sol";
 

diff --git a/src/enforcers/BorrowerEnforcerBNPL.sol b/src/enforcers/BorrowerEnforcerBNPL.sol
@@ -27,9 +27,9 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {CaveatEnforcer} from "starport-core/enforcers/CaveatEnforcer.sol";
-import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {CaveatEnforcer} from "../enforcers/CaveatEnforcer.sol";
+import {AdditionalTransfer} from "../lib/StarportLib.sol";
 
 import {ConsiderationInterface} from "seaport-types/src/interfaces/ConsiderationInterface.sol";
 

diff --git a/src/enforcers/CaveatEnforcer.sol b/src/enforcers/CaveatEnforcer.sol
@@ -27,8 +27,8 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {AdditionalTransfer} from "../lib/StarportLib.sol";
 
 abstract contract CaveatEnforcer {
     /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/

diff --git a/src/enforcers/LenderEnforcer.sol b/src/enforcers/LenderEnforcer.sol
@@ -27,9 +27,9 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {CaveatEnforcer} from "starport-core/enforcers/CaveatEnforcer.sol";
-import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {CaveatEnforcer} from "../enforcers/CaveatEnforcer.sol";
+import {AdditionalTransfer} from "../lib/StarportLib.sol";
 
 contract LenderEnforcer is CaveatEnforcer {
     error LenderOnlyEnforcer();

diff --git a/src/lib/RefStarportLib.sol b/src/lib/RefStarportLib.sol
@@ -27,7 +27,7 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
+import {Starport} from "../Starport.sol";
 
 import {ItemType, ReceivedItem, SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 

diff --git a/src/lib/StarportLib.sol b/src/lib/StarportLib.sol
@@ -27,7 +27,7 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
+import {Starport} from "../Starport.sol";
 
 import {ItemType, ReceivedItem, SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 

diff --git a/src/lib/Validation.sol b/src/lib/Validation.sol
@@ -27,7 +27,7 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
+import {Starport} from "../Starport.sol";
 
 abstract contract Validation {
     /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/

diff --git a/src/originators/Originator.sol b/src/originators/Originator.sol
@@ -27,8 +27,8 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {CaveatEnforcer} from "starport-core/enforcers/CaveatEnforcer.sol";
+import {Starport} from "../Starport.sol";
+import {CaveatEnforcer} from "../enforcers/CaveatEnforcer.sol";
 
 import {SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 

diff --git a/src/originators/StrategistOriginator.sol b/src/originators/StrategistOriginator.sol
@@ -27,10 +27,10 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {CaveatEnforcer} from "starport-core/enforcers/CaveatEnforcer.sol";
-import {Originator} from "starport-core/originators/Originator.sol";
-import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {CaveatEnforcer} from "../enforcers/CaveatEnforcer.sol";
+import {Originator} from "../originators/Originator.sol";
+import {AdditionalTransfer} from "../lib/StarportLib.sol";
 
 import {ConduitControllerInterface} from "seaport-types/src/interfaces/ConduitControllerInterface.sol";
 import {ConduitInterface} from "seaport-types/src/interfaces/ConduitInterface.sol";

diff --git a/src/pricing/BasePricing.sol b/src/pricing/BasePricing.sol
@@ -27,11 +27,11 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {Pricing} from "starport-core/pricing/Pricing.sol";
-import {Status} from "starport-core/status/Status.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
-import {StarportLib} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {Pricing} from "../pricing/Pricing.sol";
+import {Status} from "../status/Status.sol";
+import {Validation} from "../lib/Validation.sol";
+import {StarportLib} from "../lib/StarportLib.sol";
 
 import {ReceivedItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";

diff --git a/src/pricing/Pricing.sol b/src/pricing/Pricing.sol
@@ -27,9 +27,9 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
+import {Starport} from "../Starport.sol";
+import {AdditionalTransfer} from "../lib/StarportLib.sol";
+import {Validation} from "../lib/Validation.sol";
 
 import {SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 

diff --git a/src/pricing/SimpleInterestPricing.sol b/src/pricing/SimpleInterestPricing.sol
@@ -27,11 +27,11 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {ReceivedItem, BasePricing} from "starport-core/pricing/BasePricing.sol";
-import {Pricing} from "starport-core/pricing/Pricing.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
-import {StarportLib, AdditionalTransfer} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {ReceivedItem, BasePricing} from "../pricing/BasePricing.sol";
+import {Pricing} from "../pricing/Pricing.sol";
+import {Validation} from "../lib/Validation.sol";
+import {StarportLib, AdditionalTransfer} from "../lib/StarportLib.sol";
 
 import {SpentItem, ReceivedItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";

diff --git a/src/settlement/DutchAuctionSettlement.sol b/src/settlement/DutchAuctionSettlement.sol
@@ -35,13 +35,13 @@ import {
     OrderParameters
 } from "seaport-types/src/lib/ConsiderationStructs.sol";
 
-import {Pricing} from "starport-core/pricing/Pricing.sol";
+import {Pricing} from "../pricing/Pricing.sol";
 import {AmountDeriver} from "seaport-core/src/lib/AmountDeriver.sol";
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
-import {Starport, Settlement} from "starport-core/settlement/Settlement.sol";
+import {Starport, Settlement} from "../settlement/Settlement.sol";
 
-import {BasePricing} from "starport-core/pricing/BasePricing.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
+import {BasePricing} from "../pricing/BasePricing.sol";
+import {Validation} from "../lib/Validation.sol";
 
 abstract contract DutchAuctionSettlement is Settlement, AmountDeriver {
     using FixedPointMathLib for uint256;

diff --git a/src/settlement/FixedTermDutchAuctionSettlement.sol b/src/settlement/FixedTermDutchAuctionSettlement.sol
@@ -27,11 +27,11 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {DutchAuctionSettlement} from "starport-core/settlement/DutchAuctionSettlement.sol";
-import {FixedTermStatus} from "starport-core/status/FixedTermStatus.sol";
-import {Settlement} from "starport-core/settlement/Settlement.sol";
-import {StarportLib} from "starport-core/lib/StarportLib.sol";
+import {Starport} from "../Starport.sol";
+import {DutchAuctionSettlement} from "../settlement/DutchAuctionSettlement.sol";
+import {FixedTermStatus} from "../status/FixedTermStatus.sol";
+import {Settlement} from "../settlement/Settlement.sol";
+import {StarportLib} from "../lib/StarportLib.sol";
 
 import {FixedPointMathLib} from "solady/src/utils/FixedPointMathLib.sol";
 import {SpentItem} from "seaport-types/src/lib/ConsiderationStructs.sol";

diff --git a/src/settlement/Settlement.sol b/src/settlement/Settlement.sol
@@ -27,8 +27,8 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
+import {Starport} from "../Starport.sol";
+import {Validation} from "../lib/Validation.sol";
 
 import {ReceivedItem} from "seaport-types/src/lib/ConsiderationStructs.sol";
 

diff --git a/src/status/FixedTermStatus.sol b/src/status/FixedTermStatus.sol
@@ -27,9 +27,9 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {Status} from "starport-core/status/Status.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
+import {Starport} from "../Starport.sol";
+import {Status} from "../status/Status.sol";
+import {Validation} from "../lib/Validation.sol";
 
 contract FixedTermStatus is Status {
     /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/

diff --git a/src/status/Status.sol b/src/status/Status.sol
@@ -27,8 +27,8 @@
 
 pragma solidity ^0.8.17;
 
-import {Starport} from "starport-core/Starport.sol";
-import {Validation} from "starport-core/lib/Validation.sol";
+import {Starport} from "../Starport.sol";
+import {Validation} from "../lib/Validation.sol";
 
 abstract contract Status is Validation {
     /*´:°•.°+.*•´.*:˚.°*.˚•´.°:°•.°•.*•´.*:˚.°*.˚•´.°:°•.°+.*•´.*:*/

diff --git a/test/StarportTest.sol b/test/StarportTest.sol
@@ -2,7 +2,7 @@ pragma solidity ^0.8.17;
 
 import "forge-std/Test.sol";
 import {Vm} from "forge-std/Vm.sol";
-import {Starport} from "starport-core/Starport.sol";
+import {Starport, Stargate} from "starport-core/Starport.sol";
 import {Pricing} from "starport-core/pricing/Pricing.sol";
 import {StrategistOriginator} from "starport-core/originators/StrategistOriginator.sol";
 import {
@@ -56,7 +56,7 @@ import {ERC20} from "solady/src/tokens/ERC20.sol";
 import {ERC721} from "solady/src/tokens/ERC721.sol";
 import {ERC1155} from "solady/src/tokens/ERC1155.sol";
 import {ContractOffererInterface} from "seaport-types/src/interfaces/ContractOffererInterface.sol";
-import {TokenReceiverInterface} from "starport-core/interfaces/TokenReceiverInterface.sol";
+import {TokenReceiverInterface} from "./interfaces/TokenReceiverInterface.sol";
 import {Actions} from "starport-core/lib/StarportLib.sol";
 
 import {CaveatEnforcer} from "starport-core/enforcers/CaveatEnforcer.sol";
@@ -96,7 +96,7 @@ contract MockIssuer is TokenReceiverInterface {
     }
 }
 
-contract StarportTest is BaseOrderTest {
+contract StarportTest is BaseOrderTest, Stargate {
     using Cast for *;
     using FixedPointMathLib for uint256;
 
@@ -142,6 +142,11 @@ contract StarportTest is BaseOrderTest {
 
     LenderEnforcer lenderEnforcer;
 
+    //mock the test harness as stargate
+    function getOwner(address) external view returns (address) {
+        return borrower.addr;
+    }
+
     function _deployAndConfigureConsideration() public {
         conduitController = new ConduitController();
 
@@ -179,7 +184,7 @@ contract StarportTest is BaseOrderTest {
         refinancer = makeAndAllocateAccount("refinancer");
         fulfiller = makeAndAllocateAccount("fulfiller");
 
-        SP = new Starport(address(consideration));
+        SP = new Starport(address(consideration), Stargate(address(this)));
         custodian = Custodian(payable(SP.defaultCustodian()));
         SO = new StrategistOriginator(SP, strategist.addr, 1e16, address(this));
         pricing = new SimpleInterestPricing(SP);
@@ -553,9 +558,7 @@ contract StarportTest is BaseOrderTest {
         pure
         returns (ConsiderationItem[] memory)
     {
-        ConsiderationItem[] memory considerationItems = new ConsiderationItem[](
-            _receivedItems.length
-        );
+        ConsiderationItem[] memory considerationItems = new ConsiderationItem[](_receivedItems.length);
         for (uint256 i = 0; i < _receivedItems.length; ++i) {
             considerationItems[i] = ConsiderationItem(
                 _receivedItems[i].itemType,

diff --git a/test/integration-testing/TestNewLoan.sol b/test/integration-testing/TestNewLoan.sol
@@ -386,9 +386,7 @@ contract TestNewLoan is StarportTest {
         (ReceivedItem[] memory settlementConsideration, address authorized) =
             Settlement(activeLoan.terms.settlement).getSettlementConsideration(activeLoan);
         settlementConsideration = StarportLib.removeZeroAmountItems(settlementConsideration);
-        ConsiderationItem[] memory consider = new ConsiderationItem[](
-               settlementConsideration.length
-             );
+        ConsiderationItem[] memory consider = new ConsiderationItem[](settlementConsideration.length);
         uint256 i = 0;
         for (; i < settlementConsideration.length;) {
             consider[i].token = settlementConsideration[i].token;
@@ -401,9 +399,7 @@ contract TestNewLoan is StarportTest {
                 ++i;
             }
         }
-        OfferItem[] memory repayOffering = new OfferItem[](
-           activeLoan.collateral.length
-         );
+        OfferItem[] memory repayOffering = new OfferItem[](activeLoan.collateral.length);
         i = 0;
         for (; i < activeLoan.collateral.length;) {
             repayOffering[i] = OfferItem({

diff --git a/src/interfaces/TokenReceiverInterface.sol → test/interfaces/TokenReceiverInterface.sol b/src/interfaces/TokenReceiverInterface.sol → test/interfaces/TokenReceiverInterface.sol
diff --git a/test/unit-testing/TestStarport.sol b/test/unit-testing/TestStarport.sol
@@ -282,6 +282,41 @@ contract TestStarport is StarportTest, DeepEq {
         loan.toStorage(activeLoan);
     }
 
+    function testStargateGetOwner() public {
+        assertEq(address(borrower.addr), SP.SG().getOwner(address(this)));
+    }
+
+    function testAcquireTokensSuccess() public {
+        vm.startPrank(borrower.addr);
+        erc20s[1].approve(address(SP), 100);
+        erc721s[0].approve(address(SP), 2);
+        erc1155s[0].setApprovalForAll(address(SP), true);
+        vm.stopPrank();
+        uint256 balanceBefore = erc20s[1].balanceOf(address(this));
+        SpentItem[] memory items = new SpentItem[](3);
+        items[0] = SpentItem({token: address(erc721s[0]), amount: 1, identifier: 2, itemType: ItemType.ERC721});
+        items[1] = SpentItem({token: address(erc20s[1]), amount: 100, identifier: 0, itemType: ItemType.ERC20});
+        items[2] = SpentItem({token: address(erc1155s[0]), amount: 1, identifier: 1, itemType: ItemType.ERC1155});
+        SP.acquireTokens(items);
+        assert(erc721s[0].ownerOf(2) == address(this));
+        assert(erc20s[1].balanceOf(address(this)) == balanceBefore + 100);
+        assert(erc1155s[0].balanceOf(address(this), 1) == 1);
+    }
+
+    function testAcquireTokensFail() public {
+        uint256 balanceBefore = erc20s[0].balanceOf(address(this));
+        vm.mockCall(address(this), abi.encodeWithSelector(Stargate.getOwner.selector, address(this)), abi.encode(0));
+        SpentItem[] memory items = new SpentItem[](3);
+        items[0] = SpentItem({token: address(erc721s[0]), amount: 1, identifier: 2, itemType: ItemType.ERC721});
+        items[1] = SpentItem({token: address(erc20s[1]), amount: 100, identifier: 0, itemType: ItemType.ERC20});
+        items[2] = SpentItem({token: address(erc1155s[0]), amount: 1, identifier: 1, itemType: ItemType.ERC1155});
+        vm.expectRevert();
+        SP.acquireTokens(items);
+        assert(erc721s[0].ownerOf(2) == address(borrower.addr));
+        assert(erc20s[1].balanceOf(address(this)) == balanceBefore);
+        assert(erc1155s[0].balanceOf(address(this), 1) == 0);
+    }
+
     function testIncrementCaveatNonce() public {
         vm.roll(5);
         uint256 newNonce = SP.caveatNonces(address(this)) + uint256(blockhash(block.number - 1) << 0x80);
+48 −6		.github/workflows/ci.yml
+1 −1		package.json
+4 −3		src/Script.sol
+7 −2		src/StdChains.sol
+156 −15		src/StdCheats.sol
+16 −1		src/StdInvariant.sol
+18 −14		src/StdJson.sol
+54 −3		src/StdStorage.sol
+2 −2		src/StdStyle.sol
+1 −1		src/StdUtils.sol
+4 −3		src/Test.sol
+480 −239		src/Vm.sol
+93 −77		test/StdAssertions.t.sol
+91 −31		test/StdChains.t.sol
+167 −64		test/StdCheats.t.sol
+10 −10		test/StdError.t.sol
+27 −12		test/StdMath.t.sol
+66 −34		test/StdStorage.t.sol
+4 −4		test/StdStyle.t.sol
+66 −36		test/StdUtils.t.sol
+15 −0		test/Vm.t.sol