From 82884da73efab920c337422f2fb296719cd899c6 Mon Sep 17 00:00:00 2001 From: SissonJ Date: Tue, 26 Mar 2024 17:30:40 -0500 Subject: [PATCH] feat: docs --- docs/.vitepress/config.ts | 1 + docs/contracts.md | 2 ++ docs/queries/derivativeScrt.md | 1 + src/contracts/services/derivativeScrt.ts | 4 +++- 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index b5177c5..a1ca801 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -27,6 +27,7 @@ export default defineConfig({ items: [ { text: 'Swap', link: '/queries/swap' }, { text: 'Oracle', link: '/queries/oracle' }, + { text: 'stkd-SCRT', link: '/queries/derivativeScrt' }, { text: 'Batch Query', link: '/queries/batch-query' }, { text: 'Snip20', link: '/queries/snip20' }, ] diff --git a/docs/contracts.md b/docs/contracts.md index 37a15fd..c2e5f79 100644 --- a/docs/contracts.md +++ b/docs/contracts.md @@ -9,6 +9,7 @@ This page contains a list of deployed contracts. | ShadeSwap Router | secret1pjhdug87nxzv0esxasmeyfsucaj98pw4334wyc | 448e3f6d801e453e838b7a5fbaa4dd93b84d0f1011245f0d5745366dadaf3e85 | | Batch Query Router | secret17gnlxnwux0szd7qhl90ym8lw22qvedjz4v09dm | 72a09535b77b76862f7b568baf1ddbe158a2e4bbd0f0879c69ada9b398e31c1f | | Oracle | secret10n2xl5jmez6r9umtdrth78k0vwmce0l5m9f5dm | 32c4710842b97a526c243a68511b15f58d6e72a388af38a7221ff3244c754e91 | +| stkd-scrt | secret1k6u0cy4feepm6pehnz804zmwakuwdapm69tuc4 | f6be719b3c6feb498d3554ca0398eb6b7e7db262acb33f84a8f12106da6bbb09 | ::: tip The ShadeSwap pairs contracts are accessible via the factory registered pairs query. @@ -22,3 +23,4 @@ The ShadeSwap pairs contracts are accessible via the factory registered pairs qu | ShadeSwap Router | secret137sjm7hgqdp4d0dldqnrxe2ktw02meaygnjd0e | 93dac48bf508eeb4c619fcb8b1cb260f9957e31450740a2b7325440ddf92daa8 | | Batch Query Router | secret10cxkxmspt44mp2wym6dcguk5wqqkm5a9ydw3du | 72a09535b77b76862f7b568baf1ddbe158a2e4bbd0f0879c69ada9b398e31c1f | | Oracle | secret17z47r9u4nqytpdgvewxq4jqd965sfj2wpsnlak | 113c47c016667817b315dde03b4ee9774edf1fb293a7ea3f02d983c6b1fa1cf1 | +| stkd-scrt | secret14svk0x3sztxwta9kv9dv6fwzqlc26mmjfyypc2 | 680fbb3c8f8eb1c920da13d857daaedaa46ab8f9a8e26e892bb18a16985ec29e | diff --git a/docs/queries/derivativeScrt.md b/docs/queries/derivativeScrt.md index 6ea8a11..c20c08a 100644 --- a/docs/queries/derivativeScrt.md +++ b/docs/queries/derivativeScrt.md @@ -12,6 +12,7 @@ This page demonstrates how to query the stkd Scrt derivative contracts * * queryTimeSeconds is a paramater to query the contract * at a specific time in seconds from the UNIX Epoch + * Optional and will default to current time */ const queryDerivativeScrtInfo = ({ queryRouterContractAddress, diff --git a/src/contracts/services/derivativeScrt.ts b/src/contracts/services/derivativeScrt.ts index e6666f5..f568188 100644 --- a/src/contracts/services/derivativeScrt.ts +++ b/src/contracts/services/derivativeScrt.ts @@ -54,7 +54,7 @@ function parseDerivativeScrtStakingInfo( exchangeRate: convertCoinFromUDenom(exchangeRate, DERIVATE_PRICE_DECIMALS).toNumber(), communityRewards, nextUnboundAmount, - // Seconds to Miliseconds + // Seconds to Milliseconds nextUnbondingBatchEstimatedTime: nextUnbondingBatchEstimatedTime * 1000, }; } @@ -97,6 +97,7 @@ const parseDerivativeScrtInfo = ( * * queryTimeSeconds is a paramater to query the contract * at a specific time in seconds from the UNIX Epoch + * Optional and will default to current time */ const queryDerivativeScrtInfo$ = ({ queryRouterContractAddress, @@ -150,6 +151,7 @@ const queryDerivativeScrtInfo$ = ({ * * queryTimeSeconds is a paramater to query the contract * at a specific time in seconds from the UNIX Epoch + * Optional and will default to current time */ async function queryDerivativeScrtInfo({ queryRouterContractAddress,