feat: add total locked token metrics #101
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| import { useQuery } from "@tanstack/react-query"; | ||
| import { getPublicClient } from "@/services/viem/client"; | ||
| import useNetwork from "./useNetwork"; | ||
|
|
||
| interface UseBlockNumberOptions { | ||
| refetchInterval?: number | false; | ||
| } | ||
|
|
||
| /** | ||
| * Custom hook to fetch the current block number using viem's public client. | ||
| * | ||
| * @returns Query result containing the current block number | ||
| * | ||
| * @example | ||
| * ```tsx | ||
| * const { data: blockNumber, isLoading } = useBlockNumber(); | ||
| * ``` | ||
| */ | ||
| export function useBlockNumber(options?: UseBlockNumberOptions) { | ||
| const { network } = useNetwork(); | ||
|
|
||
| return useQuery({ | ||
| queryKey: ["blockNumber", network], | ||
| queryFn: async () => { | ||
| const publicClient = getPublicClient(network); | ||
| const blockNumber = await publicClient.getBlockNumber(); | ||
| return blockNumber; | ||
| }, | ||
| refetchInterval: options?.refetchInterval || false, | ||
| placeholderData: (previousData) => previousData, | ||
| }); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| import { createPublicClient, http, type PublicClient } from "viem"; | ||
| import { getChain } from "@/constants/chains"; | ||
| import type { Network } from "@/types"; | ||
|
|
||
| const clients = new Map<Network, PublicClient>(); | ||
|
|
||
| export function getPublicClient(network: Network): PublicClient { | ||
| const existing = clients.get(network); | ||
| if (existing) { | ||
| return existing; | ||
| } | ||
|
|
||
| const chain = getChain(network); | ||
| const client = createPublicClient({ | ||
| chain, | ||
| transport: http(), | ||
| }); | ||
|
|
||
| clients.set(network, client); | ||
| return client; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| /** | ||
| * Calculate total lockup for a token using the current block number. | ||
| * | ||
| * Formula: lockupCurrent + lockupRate * (blockNumber - lockupLastSettledUntilEpoch) | ||
| * | ||
| * @param lockupCurrent - The current fixed lockup amount | ||
| * @param lockupRate - The rate at which lockup increases per block | ||
| * @param lockupLastSettledUntilEpoch - The block number when lockup was last settled | ||
| * @param blockNumber - The current block number | ||
| * @returns The total lockup amount as a string, or "0" if calculation fails | ||
| * | ||
| * @example | ||
| * ```ts | ||
| * const totalLockup = calculateTotalLockup( | ||
| * "1000", | ||
| * "10", | ||
| * "100", | ||
| * 150n | ||
| * ); | ||
| * // Returns: "1500" (1000 + 10 * (150 - 100)) | ||
| * ``` | ||
| */ | ||
| export function calculateTotalLockup( | ||
| lockupCurrent: bigint | string | undefined, | ||
| lockupRate: bigint | string | undefined, | ||
| lockupLastSettledUntilEpoch: bigint | string | undefined, | ||
| blockNumber: bigint | string | undefined, | ||
| ): string { | ||
| // Handle missing data | ||
| if ( | ||
| lockupCurrent === undefined || | ||
| lockupRate === undefined || | ||
| lockupLastSettledUntilEpoch === undefined || | ||
| blockNumber === undefined | ||
| ) { | ||
| return "0"; | ||
| } | ||
|
|
||
| try { | ||
| lockupCurrent = BigInt(lockupCurrent); | ||
| lockupRate = BigInt(lockupRate); | ||
| lockupLastSettledUntilEpoch = BigInt(lockupLastSettledUntilEpoch); | ||
| blockNumber = BigInt(blockNumber); | ||
|
|
||
| // If no streaming lockup (rate is 0), return only fixed lockup | ||
| if (lockupRate === 0n) { | ||
| return lockupCurrent.toString(); | ||
| } | ||
|
|
||
| // If current block is before or equal to last settled, return only fixed lockup | ||
| if (blockNumber <= lockupLastSettledUntilEpoch) { | ||
| return lockupCurrent.toString(); | ||
| } | ||
|
|
||
| // Calculate streaming lockup: rate * (blockNumber - lastSettled) | ||
| const blockDelta = blockNumber - lockupLastSettledUntilEpoch; | ||
| const streamingLockup = lockupRate * blockDelta; | ||
|
|
||
| // Total lockup = fixed + streaming | ||
| const totalLockup = lockupCurrent + streamingLockup; | ||
|
|
||
| // Ensure non-negative result | ||
| return totalLockup >= 0n ? totalLockup.toString() : "0"; | ||
| } catch (error) { | ||
| console.error("Error calculating total lockup:", error); | ||
| return "0"; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ditto for removal?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was using this query before the merging the current upstream branch, after which I've seen that it's no longer used so I decided to delete it. YAGNI.