feat: added routing for docs

securesecrets · Mar 28, 2024 · 8811bc0 · 8811bc0
1 parent afe0170
commit 8811bc0
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 17 deletions.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -28,6 +28,7 @@ export default defineConfig({
           { text: 'Swap', link: '/queries/swap' },
           { text: 'Oracle', link: '/queries/oracle' },
           { text: 'stkd-SCRT', link: '/queries/derivativeScrt' },
+          { text: 'Shade Staking', link: '/queries/shadeStaking' },
           { text: 'Batch Query', link: '/queries/batch-query' },
           { text: 'Snip20', link: '/queries/snip20' },
         ]
@@ -45,6 +46,7 @@ export default defineConfig({
         items: [
           { text: 'Swap', link: '/calculations/swap' },
           { text: 'Routing', link: '/calculations/routing' },
+          { text: 'Apy', link: '/calculations/apy' },
         ]
       },
       {

diff --git a/src/contracts/services/shadeStaking.test.ts b/src/contracts/services/shadeStaking.test.ts
@@ -7,7 +7,11 @@ import {
 import { of } from 'rxjs';
 import stakingOpportunityResponse from '~/test/mocks/shadeStaking/stakingOpportunityResponse.json';
 import { stakingOpportunityResponseParsed } from '~/test/mocks/shadeStaking/response';
-import { parseStakingOpportunity, queryShadeStakingOpportunity, queryShadeStakingOpportunity$ } from '~/contracts/services/shadeStaking';
+import {
+  parseStakingOpportunity,
+  queryShadeStakingOpportunity,
+  queryShadeStakingOpportunity$,
+} from '~/contracts/services/shadeStaking';
 import { StakingInfoServiceResponse } from '~/types/contracts/shadeStaking/index';
 
 const sendSecretClientContractQuery$ = vi.hoisted(() => vi.fn());

diff --git a/src/lib/apy/derivativeScrt.test.ts b/src/lib/apy/derivativeScrt.test.ts
@@ -6,11 +6,12 @@ import {
 } from 'vitest';
 import { of } from 'rxjs';
 import { queryDerivativeScrtInfo$ } from '~/contracts/services/derivativeScrt';
+import { SecretQueryOptions } from '~/types/apy';
+import { secretChainQueries$ } from './secretQueries';
 import {
-  secretChainQueries$,
-} from './secretQueries';
-import { calculateDerivativeScrtApy, calculateDerivativeScrtApy$ } from './derivativeScrt';
-import { SecretQueryOptions } from '../../types/apy';
+  calculateDerivativeScrtApy,
+  calculateDerivativeScrtApy$,
+} from './derivativeScrt';
 
 beforeAll(() => {
   vi.mock('~/lib/apy/secretQueries', () => ({

diff --git a/src/lib/apy/derivativeScrt.ts b/src/lib/apy/derivativeScrt.ts
@@ -4,7 +4,10 @@ import {
   ValidatorRate,
 } from '~/types/apy';
 import { forkJoin, lastValueFrom, map } from 'rxjs';
-import { DerivativeScrtValidator, DerivativeScrtInfo } from '~/types/contracts/derivativeScrt/model';
+import {
+  DerivativeScrtValidator,
+  DerivativeScrtInfo,
+} from '~/types/contracts/derivativeScrt/model';
 import { convertCoinFromUDenom } from '~/lib/utils';
 import { queryDerivativeScrtInfo$ } from '~/contracts/services/derivativeScrt';
 import { secretChainQueries$ } from './secretQueries';

diff --git a/src/lib/apy/derivativeShd.test.ts b/src/lib/apy/derivativeShd.test.ts
@@ -24,7 +24,6 @@ test('it can calculate the correct derivative apy', async () => {
     shadeTokenContractAddress: 'secret153wu605vvp934xhd4k9dtd640zsep5jkesstdm',
     shadeStakingContractAddress: 'MOCK_STAKING_ADDRESS',
     shadeStakingCodeHash: 'MOCK_STAKING_HASH',
-    decimals: 8,
     price: '7.15',
     lcdEndpoint: 'MOCK_ENDPOINT',
     chainId: 'MOCK_CHAIN_ID',

diff --git a/src/lib/apy/derivativeShd.ts b/src/lib/apy/derivativeShd.ts
@@ -4,6 +4,8 @@ import { StakingInfoServiceModel } from '~/types/contracts/shadeStaking/index';
 import { convertCoinFromUDenom } from '~/lib/utils';
 import { calcAPY } from './derivativeScrt';
 
+const SHADE_DECIMALS = 8;
+
 /**
  * Calculate APY
  * Formula is (1+r/n)^n-1
@@ -14,12 +16,10 @@ function calculateRewardPoolAPY({
   rate,
   totalStaked,
   price,
-  decimalPlaces,
 }:{
   rate: number,
   totalStaked: string,
   price: string,
-  decimalPlaces: number,
 }) {
   // Check that price returned successfully
   if (!Number(price)) {
@@ -32,7 +32,7 @@ function calculateRewardPoolAPY({
   const periodRate = rewardsPerYearPerStakedToken * Number(price);
   // divide by stakedPrice to determine a percentage. Units are now ($)/($*day)
   const r = periodRate / Number(price);
-  return calcAPY(365, r) * (10 ** decimalPlaces);
+  return calcAPY(365, r) * (10 ** SHADE_DECIMALS);
 }
 
 /**
@@ -45,15 +45,13 @@ function calculateDerivativeShdApy$({
   shadeTokenContractAddress,
   shadeStakingContractAddress,
   shadeStakingCodeHash,
-  decimals,
   price,
   lcdEndpoint,
   chainId,
 }:{
   shadeTokenContractAddress: string,
   shadeStakingContractAddress: string,
   shadeStakingCodeHash?: string,
-  decimals: number,
   price: string,
   lcdEndpoint?: string,
   chainId?: string,
@@ -70,10 +68,9 @@ function calculateDerivativeShdApy$({
         if (current.tokenAddress === shadeTokenContractAddress
             && current.endDate.getTime() > Date.now()) {
           return prev + calculateRewardPoolAPY({
-            rate: convertCoinFromUDenom(current.rateRaw, decimals).toNumber(),
+            rate: convertCoinFromUDenom(current.rateRaw, SHADE_DECIMALS).toNumber(),
             totalStaked: response.totalStakedRaw,
             price,
-            decimalPlaces: decimals,
           });
         }
         return prev;
@@ -93,15 +90,13 @@ async function calculateDerivativeShdApy({
   shadeTokenContractAddress,
   shadeStakingContractAddress,
   shadeStakingCodeHash,
-  decimals,
   price,
   lcdEndpoint,
   chainId,
 }:{
   shadeTokenContractAddress: string,
   shadeStakingContractAddress: string,
   shadeStakingCodeHash?: string,
-  decimals: number,
   price: string,
   lcdEndpoint?: string,
   chainId?: string,
@@ -110,7 +105,6 @@ async function calculateDerivativeShdApy({
     shadeTokenContractAddress,
     shadeStakingContractAddress,
     shadeStakingCodeHash,
-    decimals,
     price,
     lcdEndpoint,
     chainId,