Client Monorepo | Documentation | Prize Pool Contract | Vault Contract
A library of shared React hooks specific to Hyperstructure functionality, using WAGMI.
Many hooks utilize react-query
in order to prevent unecessary refetching. A refetch
function is returned in order to manually refetch if necessary, or alternatively a refetchInterval
may be passed initially in order to automatically refetch every N milliseconds.
This library is available as an NPM package:
npm install @generationsoftware/hyperstructure-react-hooks
or
pnpm install @generationsoftware/hyperstructure-react-hooks
or
yarn add @generationsoftware/hyperstructure-react-hooks
useCachedVaultLists
useLastCheckedPrizesTimestamps
useSelectedVaultListIds
useSelectedVaultLists
useSelectedVaults
useSelectedVault
useVaultList
useBlock
useBlockAtTimestamp
useBlocks
useBlocksAtTimestamps
useClientChainId
useClientChainIds
useClients
useGasAmountEstimate
useGasCostEstimates
useGasPrice
useTxReceipt
useTxReceipts
useDrawAwardedEvents
useDrawFinishedEvents
useDrawStartedEvents
useLiquidationEvents
useManualContributionEvents
usePrizeBackstopEvents
usePromotionCreatedEvents
usePromotionRewardsClaimedEvents
useTransferEvents
useAllDrawIds
useAllDrawPeriods
useAllFirstDrawOpenedAt
useAllPrizeDrawWinners
useAllPrizeInfo
useAllUserBalanceUpdates
useAllUserEligibleDraws
useAllUserPrizeOdds
useAllUserPrizePoolWins
useDrawAuctionDuration
useDrawIds
useDrawPeriod
useDrawsToCheckForPrizes
useEstimatedPrizeCount
useFirstDrawOpenedAt
useGrandPrize
useLargestGrandPrize
useLastAwardedDrawId
useLastAwardedDrawTimestamps
usePrizeDrawWinners
usePrizeOdds
usePrizePools
usePrizeTokenData
usePrizeTokenPrice
useApproveSignature
useHistoricalTokenPrices
useTokenAllowances
useTokenBalances
useTokenNonces
useTokenPermitSupport
useTokenPrices
useTokenPricesAcrossChains
useTokens
useTokenVersion
useSendApproveTransaction
useSendClaimRewardsTransaction
useSendClaimVaultFeesTransaction
useSendCreatePromotionTransaction
useSendDeployLiquidationPairTransaction
useSendDeployVaultTransaction
useSendDepositTransaction
useSendDepositWithPermitTransaction
useSendRedeemTransaction
useSendSetClaimerTransaction
useSendSetLiquidationPairTransaction
useSendWithdrawTransaction
useAllUserClaimableRewards
useAllUserVaultBalances
useAllUserVaultDelegates
useAllUserVaultDelegationBalances
useAllVaultBalances
useAllVaultContributionAmounts
useAllVaultExchangeRates
useAllVaultHistoricalSharePrices
useAllVaultHistoricalTokenPrices
useAllVaultPercentageContributions
useAllVaultPrizeYields
useAllVaultPromotions
useAllVaultPromotionsApr
useAllVaultShareData
useAllVaultSharePrices
useAllVaultTokenAddresses
useAllVaultTokenData
useAllVaultTokenPrices
useAllVaultTotalSupplyTwabs
useSortedVaults
useUserClaimableRewards
useUserVaultDelegate
useUserVaultDelegationBalance
useUserVaultShareBalance
useUserVaultTokenBalance
useVault
useVaultBalance
useVaultClaimer
useVaultContributionAmount
useVaultExchangeRate
useVaultFeeInfo
useVaultFeesAvailable
useVaultLiquidationPair
useVaultOwner
useVaultPercentageContribution
useVaultPrizeYield
useVaultPromotions
useVaultPromotionsApr
useVaults
useVaultShareData
useVaultSharePrice
useVaultTokenAddress
useVaultTokenData
useVaultTokenPrice
useVaultTotalSupplyTwab
useVaultYieldSource