diff --git a/src/strategies/forte-staking/README.md b/src/strategies/forte-staking/README.md index 50923f6ad..13391de46 100644 --- a/src/strategies/forte-staking/README.md +++ b/src/strategies/forte-staking/README.md @@ -34,28 +34,26 @@ The equation of the voting power is: $votingPower(snapshot) = \sum_{i=1}^n amountStaked(i) * (daysStaked(i) + daysOffset) * \frac{multiplierNumerator}{ multiplierDenominator} * [externalMultiplier]$ -where _n_ is the number of batches of staked tokens by the user. +where _n_ is the number of batches of staked tokens by the user, and _daystStaked_ is an integer rounded down that represents the number of days since the batch was created. -Notice that the multiplier is a function of a range due to the ceiling parameter: +Notice that the external multiplier is a function of a range due to the ceiling parameter: $externalMultiplier = \begin{cases} - externalMultiplier > externalMultiplierCeiling & \quad externalMultiplierCeiling\\ + externalMultiplier > externalMultiplierCeiling & \quad externalMultiplierCeiling\\ externalMultiplier ≤ externalMultiplierCeiling & \quad externalMultiplier - \end{cases} -$ + \end{cases}$ ## Examples ### Using KYC as an external multiplier -In this example, the external multiplier is the KYC level of the user in an external contract. The KYC level itself can be any positive number. However, any value greater than 2 will be treated as 2 due to the ceiling parameter: +In this example, the external multiplier is the KYC level of the user stored in an external contract. The KYC level itself can be any positive number. However, any value greater than 2 will be treated as 2 due to the ceiling parameter: ```json { "stakingAddress": "0x249E662fe228Eff1e7dCE7cF3E78dFD481C7Ba3E", "externalMultiplierAddress": "0x86f53212865b6fddb99633dc002a7f7aacaaa8db", - "symbol": "FORTE", "externalMultiplierABI": "function getAccessLevel(address _account) external view returns (uint8)", "externalMultiplierFunction": "getAccessLevel", "multiplierNumerator": 4, @@ -72,7 +70,6 @@ This is the same example as the one above but without the external multiplier wh ```json { "stakingAddress": "0x249E662fe228Eff1e7dCE7cF3E78dFD481C7Ba3E", - "symbol": "FORTE", "multiplierNumerator": 4, "multiplierDenominator": 1461, "daysOffset": -1 diff --git a/src/strategies/forte-staking/examples.json b/src/strategies/forte-staking/examples.json index 7c3c1dfe3..73260abf6 100644 --- a/src/strategies/forte-staking/examples.json +++ b/src/strategies/forte-staking/examples.json @@ -6,7 +6,6 @@ "params": { "stakingAddress": "0x249E662fe228Eff1e7dCE7cF3E78dFD481C7Ba3E", "externalMultiplierAddress": "0x86f53212865b6fddb99633dc002a7f7aacaaa8db", - "symbol": "FORTE", "externalMultiplierABI": "function getAccessLevel(address _account) external view returns (uint8)", "externalMultiplierFunction": "getAccessLevel", "multiplierNumerator": 4, diff --git a/src/strategies/forte-staking/schema.json b/src/strategies/forte-staking/schema.json index 4704b48f0..ac33a333b 100644 --- a/src/strategies/forte-staking/schema.json +++ b/src/strategies/forte-staking/schema.json @@ -6,15 +6,9 @@ "title": "Strategy", "type": "object", "properties": { - "symbol": { - "type": "string", - "title": "Symbol", - "examples": ["e.g. FOR"], - "maxLength": 16 - }, "stakingAddress": { "type": "string", - "title": "Contract address", + "title": "Staking contract address", "examples": ["e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984"], "pattern": "^0x[a-fA-F0-9]{40}$", "minLength": 42, @@ -22,7 +16,7 @@ }, "externalMultiplierAddress": { "type": "string", - "title": "External multiplier address", + "title": "External-multiplier contract address", "examples": ["e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984"], "pattern": "^0x[a-fA-F0-9]{40}$", "minLength": 42, @@ -30,14 +24,14 @@ }, "externalMultiplierABI": { "type": "string", - "title": "External multiplier ABI", + "title": "External multiplier ABI (string version)", "examples": [ "e.g. function getAccessLevel(address _account) external view returns (uint8)" ] }, "externalMultiplierFunction": { "type": "string", - "title": "External multiplier ABI", + "title": "External-multiplier function name", "examples": ["e.g. getAccessLevel"] }, "multiplierNumerator": { @@ -52,7 +46,7 @@ }, "daysOffset": { "type": "number", - "title": "offset", + "title": "Days offset", "examples": ["e.g. -1"] }, "externalMultiplierCeiling": {