1.28.1 • Published 6 months ago

@generationsoftware/hyperstructure-react-hooks v1.28.1

Weekly downloads
-
License
MIT
Repository
-
Last release
6 months ago

💻   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

EIP 5792 Hooks

  • useSend5792AggregateClaimRewardsTransaction
  • useSend5792Calls
  • useSend5792ClaimRewardsTransaction
  • useSend5792DelegateTransaction
  • useSend5792DepositTransaction
  • useSend5792DepositZapTransaction
  • useSend5792PoolWideClaimRewardsTransaction
  • useSend5792RedeemTransaction
  • useSend5792WithdrawZapTransaction

Event Hooks

  • useDepositEvents
  • useDrawAwardedEvents
  • useDrawFinishedEvents
  • useDrawStartedEvents
  • useLiquidationEvents
  • useManualContributionEvents
  • usePoolWidePromotionCreatedEvents
  • usePoolWidePromotionRewardsClaimedEvents
  • usePrizeBackstopEvents
  • usePromotionCreatedEvents
  • usePromotionRewardsClaimedEvents
  • useTransferEvents
  • useVaultContributionEvents
  • useWithdrawEvents

Prize Pool Hooks

  • useAllDrawIds
  • useAllDrawPeriods
  • useAllFirstDrawOpenedAt
  • useAllGrandPrizePeriodDraws
  • useAllGrandPrizes
  • useAllLastAwardedDrawIds
  • useAllLastPrizeDrawWinners
  • useAllPrizeDrawWinners
  • useAllPrizeInfo
  • useAllPrizeTokenData
  • useAllPrizeTokenPrices
  • useAllPrizeValue
  • useAllUserBalanceUpdates
  • useAllUserEligibleDraws
  • useAllUserPrizeOdds
  • useAllUserPrizePoolWins
  • useDrawAuctionDuration
  • useDrawIds
  • useDrawPeriod
  • useDrawsToCheckForPrizes
  • useEstimatedPrizeCount
  • useFirstDrawOpenedAt
  • useGrandPrize
  • useGrandPrizePeriodDraws
  • useLargestGrandPrize
  • useLastAwardedDrawId
  • useLastAwardedDrawTimestamps
  • useLastPrizeDrawWinners
  • usePrizeDrawWinners
  • usePrizeOdds
  • usePrizePools
  • usePrizeTokenData
  • usePrizeTokenPrice
  • useWalletAddresses

Signature Hooks

  • useApproveSignature
  • useGenericApproveSignature

Token Hooks

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

Transaction Hooks

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

Vault Hooks

  • useAllPoolWideVaultPromotions
  • useAllUserClaimablePoolWideRewards
  • useAllUserClaimableRewards
  • useAllUserVaultBalances
  • useAllUserVaultDelegates
  • useAllUserVaultDelegationBalances
  • useAllVaultBalances
  • useAllVaultContributionAmounts
  • useAllVaultExchangeRates
  • useAllVaultHistoricalSharePrices
  • useAllVaultHistoricalTokenPrices
  • useAllVaultPercentageContributions
  • useAllVaultPrizeYields
  • useAllVaultPromotions
  • useAllVaultPromotionsApr
  • useAllVaultShareData
  • useAllVaultSharePrices
  • useAllVaultTokenAddresses
  • useAllVaultTokenData
  • useAllVaultTokenPrices
  • useAllVaultTotalDelegateSupplies
  • useAllVaultTotalSupplyTwabs
  • usePoolWideVaultPromotions
  • 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
  • useVaultTotalDelegateSupply
  • useVaultTotalSupplyTwab
  • useVaultTwabController
  • useVaultYieldSource

Zap Hooks

  • useBeefyVault
  • useCurveAddLiquidityOutput
  • useIsCurveLp
  • useIsVelodromeLp
  • useLpToken
  • useSendDepositZapTransaction
  • useSendWithdrawZapTransaction
  • useSwapTx
  • useZapArgs
  • useZapTokenInfo
1.25.4

11 months ago

1.25.5

11 months ago

1.25.8

8 months ago

1.25.9

8 months ago

1.25.6

9 months ago

1.25.7

9 months ago

1.25.10

8 months ago

1.26.0

8 months ago

1.26.1

8 months ago

1.26.2

8 months ago

1.27.2

6 months ago

1.27.0

7 months ago

1.27.1

6 months ago

1.27.4

6 months ago

1.28.1

6 months ago

1.28.0

6 months ago

1.25.3

1 year ago

1.25.1

1 year ago

1.25.2

1 year ago

1.25.0

1 year ago

1.24.0

1 year ago

1.23.0

1 year ago

1.23.1

1 year ago

1.21.5

1 year ago

1.22.0

1 year ago

1.21.4

1 year ago

1.21.3

1 year ago

1.21.2

1 year ago

1.21.0

1 year ago

1.21.1

1 year ago

1.19.2

1 year ago

1.20.1

1 year ago

1.18.1

1 year ago

1.18.0

1 year ago

1.18.3

1 year ago

1.18.2

1 year ago

1.19.0

1 year ago

1.17.2

1 year ago

1.17.1

1 year ago

1.17.6

1 year ago

1.17.5

1 year ago

1.17.4

1 year ago

1.19.1

1 year ago

1.17.3

1 year ago

1.17.8

1 year ago

1.17.7

1 year ago

1.16.16

1 year ago

1.16.14

1 year ago

1.16.15

1 year ago

1.16.12

1 year ago

1.16.9

1 year ago

1.16.10

1 year ago

1.16.11

1 year ago

1.16.7

1 year ago

1.16.8

1 year ago

1.16.6

1 year ago

1.16.5

1 year ago

1.16.4

1 year ago

1.16.3

1 year ago

1.16.2

2 years ago

1.16.1

2 years ago

1.16.0

2 years ago

1.15.0

2 years ago

1.14.5

2 years ago

1.14.4

2 years ago

1.14.3

2 years ago

1.14.2

2 years ago

1.14.1

2 years ago

1.14.0

2 years ago

1.13.0

2 years ago

1.12.0

2 years ago

1.11.4

2 years ago

1.11.5

2 years ago

1.11.3

2 years ago

1.11.2

2 years ago

1.10.5

2 years ago

1.11.0

2 years ago

1.11.1

2 years ago

1.10.3

2 years ago

1.10.2

2 years ago

1.10.1

2 years ago

1.10.0

2 years ago

1.9.6

2 years ago

1.9.5

2 years ago

1.9.4

2 years ago

1.9.3

2 years ago

1.9.2

2 years ago

1.9.1

2 years ago

1.9.0

2 years ago

1.8.0

2 years ago

1.7.10

2 years ago

1.7.9

2 years ago

1.7.8

2 years ago

1.7.7

2 years ago

1.7.6

2 years ago

1.7.5

2 years ago

1.7.4

2 years ago

1.7.3

2 years ago

1.7.2

2 years ago

1.7.1

2 years ago

1.7.0

2 years ago

1.4.10

2 years ago

1.4.9

2 years ago

1.4.8

2 years ago

1.4.6

2 years ago

1.4.5

2 years ago

1.4.4

2 years ago

1.3.3

2 years ago

1.3.2

2 years ago

1.3.1

2 years ago

1.3.0

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.3

2 years ago