Affiliates v2

.gitignore

@@ -7,7 +7,9 @@ __pycache__
 build/
 reports/
 node_modules/
+node_modules
 ignore/
+.*
 !.gitignore
 !.gitattributes
 !.solhint.json
@@ -22,7 +24,10 @@ coverage.json
 .vscode
 yarn.lock
 solc-select
+artifacts
+cache
 .idea/
+workspace.code-workspace
 .env
 node_modules
 artifacts/

.solcover.js

@@ -1,3 +1,3 @@
 module.exports = {
-    skipFiles: ['mockup', 'testhelpers', 'openzeppelin']
-};
+    skipFiles: ['mockup', 'testhelpers', 'openzeppelin', 'mixins/EnumerableAddressSet.sol']
+};

.solhint.json

@@ -1,8 +1,13 @@
 {
   "extends": "solhint:default",
-  "plugins": ["prettier"],
+  "plugins": [
+    "prettier"
+  ],
   "rules": {
     "prettier/prettier": "error",
-    "max-line-length": ["warn",140]
+    "max-line-length": [
+      "warn",
+      140
+    ]
   }
-}
+}

contracts/connectors/loantoken/LoanTokenLogicStandard.sol

@@ -9,6 +9,7 @@ pragma experimental ABIEncoderV2;
 import "./LoanTokenSettingsLowerAdmin.sol";
 import "./interfaces/ProtocolLike.sol";
 import "./interfaces/FeedsLike.sol";
+import "../../modules/interfaces/ProtocolAffiliatesInterface.sol";
 
 /**
  * @title Loan Token Logic Standard contract.
@@ -369,6 +370,28 @@ contract LoanTokenLogicStandard is LoanTokenSettingsLowerAdmin {
 			);
 	}
 
+	function marginTradeAffiliate(
+		bytes32 loanId, // 0 if new loan
+		uint256 leverageAmount, // expected in x * 10**18 where x is the actual leverage (2, 3, 4, or 5)
+		uint256 loanTokenSent,
+		uint256 collateralTokenSent,
+		address collateralTokenAddress,
+		address trader,
+		address affiliateReferrer, // the user was brought by the affiliate (referrer)
+		bytes calldata loanDataBytes // arbitrary order data
+	)
+		external
+		payable
+		returns (
+			uint256,
+			uint256 // returns new principal and new collateral added to trade
+		)
+	{
+		if (affiliateReferrer != address(0))
+			ProtocolAffiliatesInterface(sovrynContractAddress).setAffiliatesReferrer(trader, affiliateReferrer);
+		return marginTrade(loanId, leverageAmount, loanTokenSent, collateralTokenSent, collateralTokenAddress, trader, loanDataBytes);
+	}
+
 	/**
 	 * @notice Transfer tokens wrapper.
 	 * Sets token owner the msg.sender.
@@ -1027,7 +1050,10 @@ contract LoanTokenLogicStandard is LoanTokenSettingsLowerAdmin {
 		);
 		require(sentAmounts[1] != 0, "25");
 
-		return (sentAmounts[1], sentAmounts[4]); /// newPrincipal, newCollateral
+		//REFACTOR: move to a general interface: ProtocolSettingsLike?
+		ProtocolAffiliatesInterface(sovrynContractAddress).setUserNotFirstTradeFlag(sentAddresses[1]);
+
+		return (sentAmounts[1], sentAmounts[4]); // newPrincipal, newCollateral
 	}
 
 	/// sentAddresses[0]: lender

contracts/core/State.sol

@@ -6,6 +6,7 @@
 pragma solidity 0.5.17;
 
 import "./Objects.sol";
+import "../mixins/EnumerableAddressSet.sol";
 import "../mixins/EnumerableBytes32Set.sol";
 import "../openzeppelin/ReentrancyGuard.sol";
 import "../openzeppelin/Ownable.sol";
@@ -21,7 +22,8 @@ import "../interfaces/IWrbtcERC20.sol";
  * */
 contract State is Objects, ReentrancyGuard, Ownable {
 	using SafeMath for uint256;
-	using EnumerableBytes32Set for EnumerableBytes32Set.Bytes32Set;
+	using EnumerableAddressSet for EnumerableAddressSet.AddressSet; // enumerable map of addresses
+	using EnumerableBytes32Set for EnumerableBytes32Set.Bytes32Set; // enumerable map of bytes32 or addresses
 
 	/// Handles asset reference price lookups.
 	address public priceFeeds;
@@ -118,8 +120,8 @@ contract State is Objects, ReentrancyGuard, Ownable {
 	/// Lifetime total payout of protocol token.
 	uint256 public protocolTokenPaid;
 
-	/// 30% fee share /// Fee share for affiliate program.
-	uint256 public affiliateFeePercent = 30 * 10**18;
+	/// 5% fee share in form of SOV /// Fee share for affiliate program.
+	uint256 public affiliateFeePercent = 5 * 10**18;
 
 	/// 5% collateral discount /// Discount on collateral for liquidators.
 	uint256 public liquidationIncentivePercent = 5 * 10**18;
@@ -160,6 +162,24 @@ contract State is Objects, ReentrancyGuard, Ownable {
 
 	address public admin;
 
+	address public protocolAddress; // for modules interaction
+
+	mapping(address => bool) public userNotFirstTradeFlag; // The flag is set on the user's first trade or borrowing
+
+	mapping(address => address) public affiliatesUserReferrer; // User => referrer (affiliate)
+	mapping(address => EnumerableAddressSet.AddressSet) internal referralsList; // list of referral addresses that owned by the referrer
+
+	uint256 public minReferralsToPayout = 3;
+	mapping(address => uint256) public affiliateRewardsHeld; // Total affiliate SOV rewards that held in the protocol (Because the minimum referrals is less than the rule)
+	address public sovTokenAddress; // For affiliates SOV Bonus proccess
+	address public lockedSOVAddress;
+
+	/// 20% fee share of trading token fee /// Fee share of trading token fee for affiliate program.
+	uint256 public affiliateTradingTokenFeePercent = 20 * 10**18;
+
+	mapping(address => EnumerableAddressSet.AddressSet) internal affiliatesReferrerTokensList; // addresses of tokens in which commissions were paid to referrers
+	mapping(address => mapping(address => uint256)) public affiliatesReferrerBalances; // [referrerAddress][tokenAddress] is a referrer's token balance of accrued fees
+
 	/**
 	 * @notice Add signature and target to storage.
 	 * */

contracts/events/AffiliatesEvents.sol

@@ -0,0 +1,40 @@
+/**
+ * Copyright 2017-2020, bZeroX, LLC. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0.
+ */
+
+pragma solidity 0.5.17;
+
+contract AffiliatesEvents {
+	event SetAffiliatesReferrer(address indexed user, address indexed referrer);
+
+	event SetAffiliatesReferrerFail(address indexed user, address indexed referrer, bool alreadySet, bool userNotFirstTrade);
+
+	event SetUserNotFirstTradeFlag(address indexed user);
+
+	event PayTradingFeeToAffiliate(
+		address indexed referrer,
+		address indexed token,
+		bool indexed isHeld,
+		uint256 tradingFeeTokenAmount,
+		uint256 tokenBonusAmount,
+		uint256 sovBonusAmount,
+		uint256 sovBonusAmountPaid
+	);
+
+	event PayTradingFeeToAffiliateFail(
+		address indexed referrer,
+		address indexed token,
+		uint256 tradingFeeTokenAmount,
+		uint256 tokenBonusAmount,
+		uint256 sovBonusAmount,
+		uint256 sovBonusAmountTryingToPaid
+	);
+
+	event WithdrawAffiliatesReferrerTokenFees(
+		address indexed referrer,
+		address indexed receiver,
+		address indexed tokenAddress,
+		uint256 amount
+	);
+}

contracts/events/ProtocolSettingsEvents.sol

@@ -29,6 +29,8 @@ contract ProtocolSettingsEvents {
 
 	event SetAffiliateFeePercent(address indexed sender, uint256 oldValue, uint256 newValue);
 
+	event SetAffiliateTradingTokenFeePercent(address indexed sender, uint256 oldValue, uint256 newValue);
+
 	event SetLiquidationIncentivePercent(address indexed sender, uint256 oldValue, uint256 newValue);
 
 	event SetMaxSwapSize(address indexed sender, uint256 oldValue, uint256 newValue);
@@ -63,4 +65,12 @@ contract ProtocolSettingsEvents {
 	event SetRolloverBaseReward(address indexed sender, uint256 oldValue, uint256 newValue);
 
 	event SetRebatePercent(address indexed sender, uint256 oldRebatePercent, uint256 newRebatePercent);
+
+	event SetProtocolAddress(address indexed sender, address indexed oldProtocol, address indexed newProtocol);
+
+	event SetMinReferralsToPayoutAffiliates(address indexed sender, uint256 oldMinReferrals, uint256 newMinReferrals);
+
+	event SetSOVTokenAddress(address indexed sender, address indexed oldTokenAddress, address indexed newTokenAddress);
+
+	event SetLockedSOVAddress(address indexed sender, address indexed oldAddress, address indexed newAddress);
 }

contracts/interfaces/ISovryn.sol

@@ -5,6 +5,8 @@
 
 pragma solidity >=0.5.0 <0.6.0;
 pragma experimental ABIEncoderV2;
+//TODO: stored in ./interfaces only while brownie isn't removed
+//TODO: move to contracts/interfaces after with brownie is removed
 
 import "../core/State.sol";
 import "../events/ProtocolSettingsEvents.sol";
@@ -14,6 +16,8 @@ import "../events/LoanMaintenanceEvents.sol";
 import "../events/LoanClosingsEvents.sol";
 import "../events/FeesEvents.sol";
 import "../events/SwapsEvents.sol";
+import "../events/AffiliatesEvents.sol";
+import "../events/FeesEvents.sol";
 
 contract ISovryn is
 	State,
@@ -22,7 +26,9 @@ contract ISovryn is
 	LoanOpeningsEvents,
 	LoanMaintenanceEvents,
 	LoanClosingsEvents,
-	SwapsEvents
+	SwapsEvents,
+	AffiliatesEvents,
+	FeesEvents
 {
 	////// Protocol //////
 
@@ -34,6 +40,14 @@ contract ISovryn is
 
 	////// Protocol Settings //////
 
+	function setSovrynProtocolAddress(address newProtocolAddress) external;
+
+	function setSOVTokenAddress(address newSovTokenAddress) external;
+
+	function setLockedSOVAddress(address newSOVLockedAddress) external;
+
+	function setMinReferralsToPayoutAffiliates(uint256 newMinReferrals) external;
+
 	function setPriceFeedContract(address newContract) external;
 
 	function setSwapsImplContract(address newContract) external;
@@ -50,6 +64,8 @@ contract ISovryn is
 
 	function setAffiliateFeePercent(uint256 newValue) external;
 
+	function setAffiliateTradingTokenFeePercent(uint256 newValue) external;
+
 	function setLiquidationIncentivePercent(uint256 newAmount) external;
 
 	function setMaxDisagreement(uint256 newAmount) external;
@@ -60,8 +76,6 @@ contract ISovryn is
 
 	function setFeesController(address newController) external;
 
-	function withdrawFees(address token, address receiver) external returns (uint256);
-
 	function withdrawLendingFees(
 		address token,
 		address receiver,
@@ -302,4 +316,51 @@ contract ISovryn is
 	function setLegacyOracles(address[] calldata refs, address[] calldata oracles) external;
 
 	function getLegacyOracle(address ref) external view returns (address);
+
+	////// Affiliates Module //////
+
+	function getUserNotFirstTradeFlag(address user) external view returns (bool);
+
+	function setUserNotFirstTradeFlag(address user) external view returns (bool);
+
+	function payTradingFeeToAffiliatesReferrer(
+		address referrer,
+		address token,
+		uint256 tradingFeeTokenBaseAmount
+	) external returns (uint256 affiliatesBonusSOVAmount, uint256 affiliatesBonusTokenAmount);
+
+	function setAffiliatesReferrer(address user, address referrer) external; //onlyCallableByLoanPools
+
+	function getReferralsList(address referrer) external view returns (address[] memory refList);
+
+	function getAffiliatesReferrerBalances(address referrer)
+		external
+		view
+		returns (address[] memory referrerTokensList, uint256[] memory referrerTokensBalances);
+
+	function getAffiliatesReferrerTokensList(address referrer) external view returns (address[] memory tokensList);
+
+	function getAffiliatesReferrerTokenBalance(address referrer, address token) external view returns (uint256);
+
+	function withdrawAffiliatesReferrerTokenFees(
+		address token,
+		address receiver,
+		uint256 amount
+	) external returns (uint256 withdrawAmount);
+
+	function withdrawAllAffiliatesReferrerTokenFees(address receiver) external;
+
+	function getProtocolAddress() external view returns (address);
+
+	function getSovTokenAddress() external view returns (address);
+
+	function getLockedSOVAddress() external view returns (address);
+
+	function getMinReferralsToPayout() external view returns (uint256);
+
+	function getAffiliatesUserReferrer(address user) external view returns (address referrer);
+
+	function getAffiliateRewardsHeld(address referrer) external view returns (uint256);
+
+	function getAffiliateTradingTokenFeePercent() external view returns (uint256 affiliateTradingTokenFeePercent);
 }