Feat/apy adjustments #6

anyxem · 2025-02-06T22:45:46Z

No description provided.

azarovh

I'd also unit test the functions because the math is tricky. But in general treat my comments as suggestions.

azarovh · 2025-02-10T14:08:19Z

src/app/api/pool/summary/route.ts

+];
+
+/*
+  This code calculates the annual reward based on block height.


Technically it's not a reward but subsidy. Reward = subsidy + tx fees.

azarovh · 2025-02-10T14:09:26Z

src/app/api/pool/summary/route.ts

@@ -34,6 +34,89 @@ async function getPoolsRecursive(offset: number, pools: any = []): Promise<any>
  }, []);
 }

+const rewards = [


We call it "emission table" which is more precise term.

I see 2 more duplicates of this table.

azarovh · 2025-02-10T14:13:33Z

src/app/api/pool/summary/route.ts

+const get_annual_reward =  (block_height: number) => {
+  const current = rewards.findIndex((r) => r.start <= block_height && r.end > block_height);
+  const current_reward = rewards[current]?.reward;
+  const current_reward_end = rewards[current]?.end || 1_000_000_000_000_000;


Not sure that this will behave correctly during the Infinity. Seems like line 116 will give negative result.

azarovh · 2025-02-10T14:16:22Z

src/app/pools/_components/table/index.tsx

+  return current_reward_part + future_reward_part;
+}
+
+const get_annual_reward =  (block_height: number) => {


Is it a copy-paste of function in route.ts? Can it be reused somehow?

azarovh · 2025-02-10T14:20:55Z

src/app/pools/_components/table/index.tsx

@@ -79,7 +131,7 @@ export function Table() {
  const filterer = (item: any) => {
    if (hideNonProfitPools) {
      if (item.margin_ratio === 1) return false;
-      if (item.cost_per_block === 202) return false;
+      if (item.cost_per_block >= 151) return false;


It's better to introduce a function like block_subsidy_at_height

azarovh · 2025-02-10T14:29:36Z

src/app/pools/_components/table/index.tsx

@@ -113,17 +165,20 @@ export function Table() {
  const injectApy = (stakingAmount: any) => (pool: any) => {


Is it amountToDelegate?

azarovh · 2025-02-10T14:37:45Z

src/app/pools/_components/table/index.tsx

    // APY estimation
    const blocks_per_day = probability_per_second * 24 * 60 * 60;
    const part = stakingAmount / (stakingAmount + pool.delegations_amount + pool.staker_balance);
-    const reward_per_block = (reward - pool.cost_per_block) * (1 - pool.margin_ratio) * part;
-    const apy = ((reward_per_block * blocks_per_day * 365) / stakingAmount) * 100; // * 100 to display percent
+    // const reward_per_block = (reward - pool.cost_per_block) * (1 - pool.margin_ratio) * part;


This feels like half-encapsulated. I'd move part calculation inside and also give it a proper name because it's very confusing right now.

part can't be moved inside since it's required below to make a label

const part_label = (part * 100).toFixed(2);

azarovh · 2025-02-13T09:14:11Z

src/utils/emission.ts

+  return total;
+}
+
+export const block_subsidy_at_height = (block_height: number) => {


you can now use it in the functions below

azarovh · 2025-02-13T09:19:58Z

src/utils/emission.ts

@@ -0,0 +1,57 @@
+export const EMISSION_TABLE = [
+  { start: 0      , end: 262800 , reward: 202 },


I think typical notation is [begin; end) and [first; last] where end is always exclusive. That would avoid confusion on whether reward for 262800 is 202 or 151

What about

{ range: [0, 262800], subsidy: 202 }, { range: [262801, 525600], subsidy: 151 },

[first; last] also good to me

azarovh · 2025-02-13T09:20:53Z

src/utils/emission.ts

+  return current_subsidy_part + future_subsidy_part;
+}
+
+export const get_annual_subsidy_delegator =  (block_height: number, pool: any, part: any) => {


I'd leave a comment what part means or find a better name for it

azarovh · 2025-02-13T09:32:23Z

src/utils/emission.spec.ts

+    expect(get_annual_subsidy(1)).toEqual(53085549); // 202 * 262799 + 151 * 1
+    expect(get_annual_subsidy(10)).toEqual(53085090); // 202 * 262790 + 151 * 10
+    expect(get_annual_subsidy(262800)).toEqual(39682800); // 151 * 262800
+    expect(get_annual_subsidy(262801)).toEqual(39682762); // 151 * 262799 + 113


testing delegators logic would be nice

azarovh · 2025-02-13T09:33:48Z

src/utils/emission.ts

+export const get_annual_subsidy =  (block_height: number) => {
+  const current = EMISSION_TABLE.findIndex((r) => r.start <= block_height && r.end >= block_height);
+  const current_subsidy = EMISSION_TABLE[current]?.reward;
+  const current_subsidy_end = EMISSION_TABLE[current]?.end || Infinity;


I still think that it's incorrect to use Infinity here because you subtract it on line 44. Also there is no test for such case to prove otherwise.

that's correct, fixing that case

azarovh reviewed Feb 10, 2025

View reviewed changes

anyxem force-pushed the feat/apy-adjustments branch 4 times, most recently from fad2c13 to b71d570 Compare February 13, 2025 08:39

azarovh reviewed Feb 13, 2025

View reviewed changes

anyxem force-pushed the feat/apy-adjustments branch 2 times, most recently from e83d09e to c99f31d Compare February 17, 2025 14:48

anyxem added 4 commits February 18, 2025 14:14

feat: more accurate apy

e206954

add tests and update naming

af612f2

add tests

6af3aad

add tests

a92ef0e

anyxem force-pushed the feat/apy-adjustments branch from c99f31d to a92ef0e Compare February 18, 2025 13:14

anyxem added 10 commits February 18, 2025 22:56

fix: add sqlite to store pools data

e249801

empty data

dd11eea

env vars

9f3b5a5

cleanup logs

26e057d

process end

857cff5

cors

52460e8

Merge branch 'master' into feat/apy-adjustments

1d1a6a9

data summary chache adjust

d8c2f15

cache exchange rate

0f1c7c1

fix build

560d1ec

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/apy adjustments #6

Feat/apy adjustments #6

anyxem commented Feb 6, 2025

azarovh left a comment

azarovh Feb 10, 2025

azarovh Feb 10, 2025

azarovh Feb 10, 2025

azarovh Feb 10, 2025

azarovh Feb 10, 2025

azarovh Feb 10, 2025

azarovh Feb 10, 2025

anyxem Feb 12, 2025

azarovh Feb 13, 2025

azarovh Feb 13, 2025

anyxem Feb 13, 2025 •

edited

Loading

anyxem Feb 13, 2025

azarovh Feb 13, 2025

azarovh Feb 13, 2025

azarovh Feb 13, 2025

anyxem Feb 13, 2025

		@@ -113,17 +165,20 @@ export function Table() {
		const injectApy = (stakingAmount: any) => (pool: any) => {

		@@ -0,0 +1,57 @@
		export const EMISSION_TABLE = [
		{ start: 0 , end: 262800 , reward: 202 },

Feat/apy adjustments #6

Are you sure you want to change the base?

Feat/apy adjustments #6

Conversation

anyxem commented Feb 6, 2025

azarovh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anyxem Feb 13, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anyxem Feb 13, 2025 •

edited

Loading