Socket
Socket
Sign inDemoInstall

@generationsoftware/hyperstructure-react-hooks

Package Overview
Dependencies
1
Maintainers
3
Versions
67
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @generationsoftware/hyperstructure-react-hooks

React hooks library for interacting with PoolTogether contracts


Version published
Weekly downloads
153
decreased by-17.3%
Maintainers
3
Created
Weekly downloads
 

Readme

Source

PoolTogether Brand


💻   PoolTogether Hyperstucture React Hooks Library

ts viem react npm license

Client Monorepo | Documentation | Prize Pool Contract | Vault Contract

🏆   Overview

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.

💾   Installation

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

🐱‍👤   Available Hooks

App Hooks

  • useCachedVaultLists
  • useLastCheckedPrizesTimestamps
  • useSelectedVaultListIds
  • useSelectedVaultLists
  • useSelectedVaults
  • useSelectedVault
  • useVaultList

Blockchain Hooks

  • useBlock
  • useBlockAtTimestamp
  • useBlocks
  • useBlocksAtTimestamps
  • useClientChainId
  • useClientChainIds
  • useClients
  • useGasAmountEstimate
  • useGasCostEstimates
  • useGasPrice
  • useTxReceipt
  • useTxReceipts

Event Hooks

  • useDrawAwardedEvents
  • useDrawFinishedEvents
  • useDrawStartedEvents
  • useLiquidationEvents
  • useManualContributionEvents
  • usePrizeBackstopEvents
  • usePromotionCreatedEvents
  • usePromotionRewardsClaimedEvents
  • useTransferEvents

Prize Pool Hooks

  • useAllDrawIds
  • useAllDrawPeriods
  • useAllFirstDrawOpenedAt
  • useAllPrizeDrawWinners
  • useAllPrizeInfo
  • useAllUserBalanceUpdates
  • useAllUserEligibleDraws
  • useAllUserPrizeOdds
  • useAllUserPrizePoolWins
  • useDrawAuctionDuration
  • useDrawIds
  • useDrawPeriod
  • useDrawsToCheckForPrizes
  • useEstimatedPrizeCount
  • useFirstDrawOpenedAt
  • useGrandPrize
  • useLargestGrandPrize
  • useLastAwardedDrawId
  • useLastAwardedDrawTimestamps
  • usePrizeDrawWinners
  • usePrizeOdds
  • usePrizePools
  • usePrizeTokenData
  • usePrizeTokenPrice

Signature Hooks

  • useApproveSignature

Token Hooks

  • useHistoricalTokenPrices
  • useTokenAllowances
  • useTokenBalances
  • useTokenNonces
  • useTokenPermitSupport
  • useTokenPrices
  • useTokenPricesAcrossChains
  • useTokens
  • useTokenVersion

Transaction Hooks

  • useSendApproveTransaction
  • useSendClaimRewardsTransaction
  • useSendClaimVaultFeesTransaction
  • useSendCreatePromotionTransaction
  • useSendDeployLiquidationPairTransaction
  • useSendDeployVaultTransaction
  • useSendDepositTransaction
  • useSendDepositWithPermitTransaction
  • useSendRedeemTransaction
  • useSendSetClaimerTransaction
  • useSendSetLiquidationPairTransaction
  • useSendWithdrawTransaction

Vault Hooks

  • 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

FAQs

Last updated on 02 May 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc