Merge pull request #149 from lidofinance/feature/si-1559-apr-percent-in-rewards

apr percent in rewards

Author: Jeday

packages/sdk/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 3.4.0
+
+## SDK
+
+### Fixed
+
+- `apr` in `getRewardsFromChain` and `getRewardsFromSubgraph` is now in percents e.g 3.14 and not 0.314
+- package is build with ts@5.4.5 with changes in bundle
+- `LidoSDKApr.calculateAprFromRebaseEvent` has increased precision
+
+## Playground
+
+### Fixed
+
+- updated version of `reef-knot` package with `wagmi@2`
+
+# 3.3.0
+
+No changes
+
 # 3.2.2
 
 ## SDK
@@ -7,8 +27,6 @@
 - fixed edge-case in `withdraw.views.findCheckpointHints` where last finalized request would fail assertion with `Cannot find hints for unfinalized request...`
 - subsequently fixed same error in `withdraw.request-info`, `withdraw.claim` modules
 
-# 3.2.0
-
 # 3.2.1
 
 ## SDK

packages/sdk/src/rewards/__tests__/__snapshots__/rewards.test.ts.snap

@@ -228,7 +228,7 @@ export class LidoSDKRewards extends LidoSDKModule {
         return {
           type: 'rebase',
           change,
-          apr: LidoSDKApr.calculateAprFromRebaseEvent(event.args) / 100,
+          apr: LidoSDKApr.calculateAprFromRebaseEvent(event.args),
           changeShares: 0n,
           balance: newBalance,
           balanceShares: prevSharesBalance,
@@ -442,7 +442,6 @@ export class LidoSDKRewards extends LidoSDKModule {
         const totalEther = BigInt(totalPooledEtherAfter);
         const totalShares = BigInt(totalSharesAfter);
 
-        const apr = Number(eventApr) / 100;
         const newBalance = sharesToSteth(
           prevBalanceShares,
           totalEther,
@@ -456,7 +455,7 @@ export class LidoSDKRewards extends LidoSDKModule {
         return {
           type: 'rebase',
           change,
-          apr,
+          apr: Number(eventApr),
           changeShares: 0n,
           balance: newBalance,
           balanceShares: prevBalanceShares,

packages/sdk/src/rewards/rewards.ts

@@ -21,7 +21,7 @@ const APR_SPEC: Array<[AprRebaseEvent, number]> = [
       postTotalShares: 380434280124073199943710n,
       postTotalEther: 381570076199165808306368n,
     },
-    1.7,
+    1.7497,
   ],
   [
     {
@@ -31,7 +31,7 @@ const APR_SPEC: Array<[AprRebaseEvent, number]> = [
       postTotalShares: 380434280124073199943710n,
       timeElapsed: 96768n,
     },
-    1.7,
+    1.7918,
   ],
   [
     {
@@ -41,7 +41,7 @@ const APR_SPEC: Array<[AprRebaseEvent, number]> = [
       postTotalShares: 380434280124073199943710n,
       timeElapsed: 188928n,
     },
-    1.7,
+    1.7613,
   ],
   [
     {
@@ -51,7 +51,7 @@ const APR_SPEC: Array<[AprRebaseEvent, number]> = [
       preTotalShares: 8066681860242338824295513n,
       timeElapsed: 950400n,
     },
-    3.8,
+    3.8393,
   ],
   [
     {
@@ -61,7 +61,7 @@ const APR_SPEC: Array<[AprRebaseEvent, number]> = [
       preTotalShares: 7381214257921691114069196n,
       timeElapsed: 9244800n,
     },
-    3.7,
+    3.7196,
   ],
   [
     {
@@ -71,37 +71,37 @@ const APR_SPEC: Array<[AprRebaseEvent, number]> = [
       preTotalShares: 352884611916239405037988n,
       timeElapsed: 12009600n,
     },
-    4.5,
+    4.5775,
   ],
 ];
 
 const APR_SPEC_BLOCK: Record<string, { block: bigint; apr: number }[]> = {
   '17000': [
     {
       block: 500726n,
-      apr: 1.7,
+      apr: 1.7265,
     },
     {
       block: 493967n,
-      apr: 1.9,
+      apr: 1.9044,
     },
     {
       block: 491753n,
-      apr: 1.5,
+      apr: 1.5673,
     },
     {
       block: 94120n,
-      apr: 1.3,
+      apr: 1.3987,
     },
 
     {
       block: 103607n,
-      apr: 6.3,
+      apr: 6.3928,
     },
 
     {
       block: 77212n,
-      apr: 1.3,
+      apr: 1.3269,
     },
   ],
 };

packages/sdk/src/statistics/__tests__/stats.test.ts

@@ -24,7 +24,7 @@ export class LidoSDKApr extends LidoSDKModule {
   }: AprRebaseEvent): number {
     const preShareRate = (preTotalEther * BigInt(10 ** 27)) / preTotalShares;
     const postShareRate = (postTotalEther * BigInt(10 ** 27)) / postTotalShares;
-    const mulForPrecision = 1000;
+    const mulForPrecision = 1000000;
 
     const secondsInYear = 31536000n;
     const userAPR =