{"_id":"@generationsoftware/hyperstructure-react-hooks","_rev":"126-d7f8abcb1f41a9d07fb4830130da0788","name":"@generationsoftware/hyperstructure-react-hooks","dist-tags":{"latest":"1.28.4"},"versions":{"1.0.3":{"name":"@generationsoftware/hyperstructure-react-hooks","version":"1.0.3","license":"MIT","_id":"@generationsoftware/hyperstructure-react-hooks@1.0.3","maintainers":[{"name":"ncookie","email":"ncukiert@gmail.com"},{"name":"asselstine","email":"mail.asselstine@gmail.com"},{"name":"chuckbergeron","email":"chuck.bergeron+nnppmm@gmail.com"}],"dist":{"shasum":"5f859a745302e8f3d1b628100652f5a505f8ac2b","tarball":"https://registry.npmjs.org/@generationsoftware/hyperstructure-react-hooks/-/hyperstructure-react-hooks-1.0.3.tgz","fileCount":83,"integrity":"sha512-UqcUzprOn1zPQf8eSrEkNzhmdhV8dMtGeCNbTV+OBphwqVqLbJM4p3DpcYQZBAGxStqNwvSB4rbhlJ/FxPSPhw==","signatures":[{"sig":"MEYCIQCnGwrjHQCEOyzN7qouNJE+FFSE/D8tSXMpsm1NLEaI1AIhAI78Tv30EQV/mt4zI+M1mdGTJVt03X657hS3I5CdvmoH","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":606534},"main":"./dist/index.mjs","tsup":{"dts":true,"entry":["src/index.ts"],"format":["esm"]},"_from":"file:generationsoftware-hyperstructure-react-hooks-1.0.3.tgz","types":"./dist/index.d.ts","scripts":{"build":"tsup","clean":"rm -rf dist"},"_npmUser":{"name":"ncookie","email":"ncukiert@gmail.com"},"_resolved":"C:\\Users\\Ncookie\\AppData\\Local\\Temp\\9bd6fa924453c895e75024d4917ef6c2\\generationsoftware-hyperstructure-react-hooks-1.0.3.tgz","_integrity":"sha512-UqcUzprOn1zPQf8eSrEkNzhmdhV8dMtGeCNbTV+OBphwqVqLbJM4p3DpcYQZBAGxStqNwvSB4rbhlJ/FxPSPhw==","_npmVersion":"8.15.0","description":"

\r \r \n \n \"PoolTogether\n \n

\n\n
\n\n# 💻   PoolTogether Hyperstucture React Hooks Library\n\n![ts](https://img.shields.io/badge/typescript-%23007ACC.svg?style=flat&logo=typescript&logoColor=white)\n![viem](https://img.shields.io/static/v1?label&logo=v&logoColor=white&message=viem&color=gray)\n![react](https://img.shields.io/badge/react-%2320232a.svg?style=flat&logo=react&logoColor=%2361DAFB)\n![npm](https://img.shields.io/npm/v/@generationsoftware/hyperstructure-react-hooks)\n![license](https://img.shields.io/npm/l/@generationsoftware/hyperstructure-react-hooks)\n\n[Client Monorepo](https://github.com/GenerationSoftware/pooltogether-client-monorepo) | [Documentation](https://dev.pooltogether.com/) | [Prize Pool Contract](https://github.com/GenerationSoftware/pt-v5-prize-pool) | [Vault Contract](https://github.com/GenerationSoftware/pt-v5-vault)\n\n# 🏆   Overview\n\nA library of shared React hooks specific to Hyperstructure functionality, using [WAGMI](https://wagmi.sh/).\n\nMany 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.\n\n## 💾   Installation\n\nThis library is available as an NPM package:\n\n```sh\nnpm install @generationsoftware/hyperstructure-react-hooks\n```\n\nor\n\n```sh\npnpm install @generationsoftware/hyperstructure-react-hooks\n```\n\nor\n\n```sh\nyarn add @generationsoftware/hyperstructure-react-hooks\n```\n\n## 🐱‍👤   Available Hooks\n\n### App Hooks\n\n- `useCachedVaultLists`\n- `useLastCheckedPrizesTimestamps`\n- `useSelectedVaultListIds`\n- `useSelectedVaultLists`\n- `useSelectedVaults`\n- `useSelectedVault`\n- `useVaultList`\n\n### Blockchain Hooks\n\n- `useBlock`\n- `useBlockAtTimestamp`\n- `useBlocks`\n- `useBlocksAtTimestamps`\n- `useClientChainId`\n- `useClientChainIds`\n- `useClients`\n- `useGasAmountEstimate`\n- `useGasCostEstimates`\n- `useGasPrice`\n- `useTxReceipt`\n- `useTxReceipts`\n\n### EIP 5792 Hooks\n\n- `useSend5792AggregateClaimRewardsTransaction`\n- `useSend5792Calls`\n- `useSend5792ClaimRewardsTransaction`\n- `useSend5792DelegateTransaction`\n- `useSend5792DepositTransaction`\n- `useSend5792DepositZapTransaction`\n- `useSend5792PoolWideClaimRewardsTransaction`\n- `useSend5792RedeemTransaction`\n- `useSend5792WithdrawZapTransaction`\n\n### Event Hooks\n\n- `useDepositEvents`\n- `useDrawAwardedEvents`\n- `useDrawFinishedEvents`\n- `useDrawStartedEvents`\n- `useLiquidationEvents`\n- `useManualContributionEvents`\n- `usePoolWidePromotionCreatedEvents`\n- `usePoolWidePromotionRewardsClaimedEvents`\n- `usePrizeBackstopEvents`\n- `usePromotionCreatedEvents`\n- `usePromotionRewardsClaimedEvents`\n- `useTransferEvents`\n- `useVaultContributionEvents`\n- `useWithdrawEvents`\n\n### Prize Pool Hooks\n\n- `useAllDrawIds`\n- `useAllDrawPeriods`\n- `useAllFirstDrawOpenedAt`\n- `useAllGrandPrizePeriodDraws`\n- `useAllGrandPrizes`\n- `useAllLastAwardedDrawIds`\n- `useAllLastPrizeDrawWinners`\n- `useAllPrizeDrawWinners`\n- `useAllPrizeInfo`\n- `useAllPrizeTokenData`\n- `useAllPrizeTokenPrices`\n- `useAllPrizeValue`\n- `useAllUserBalanceUpdates`\n- `useAllUserEligibleDraws`\n- `useAllUserPrizeOdds`\n- `useAllUserPrizePoolWins`\n- `useDrawAuctionDuration`\n- `useDrawIds`\n- `useDrawPeriod`\n- `useDrawsToCheckForPrizes`\n- `useEstimatedPrizeCount`\n- `useFirstDrawOpenedAt`\n- `useGrandPrize`\n- `useGrandPrizePeriodDraws`\n- `useLargestGrandPrize`\n- `useLastAwardedDrawId`\n- `useLastAwardedDrawTimestamps`\n- `useLastPrizeDrawWinners`\n- `usePrizeDrawWinners`\n- `usePrizeOdds`\n- `usePrizePools`\n- `usePrizeTokenData`\n- `usePrizeTokenPrice`\n- `useWalletAddresses`\n\n### Signature Hooks\n\n- `useApproveSignature`\n- `useGenericApproveSignature`\n\n### Token Hooks\n\n- `useHistoricalTokenPrices`\n- `useTokenAllowances`\n- `useTokenBalances`\n- `useTokenNonces`\n- `useTokenPermitSupport`\n- `useTokenPrices`\n- `useTokenPricesAcrossChains`\n- `useTokens`\n- `useTokenVersion`\n\n### Transaction Hooks\n\n- `useSendAggregateClaimRewardsTransaction`\n- `useSendApproveTransaction`\n- `useSendClaimRewardsTransaction`\n- `useSendClaimVaultFeesTransaction`\n- `useSendCreatePromotionTransaction`\n- `useSendDeployLiquidationPairTransaction`\n- `useSendDeployVaultTransaction`\n- `useSendDepositTransaction`\n- `useSendDepositWithPermitTransaction`\n- `useSendGenericApproveTransaction`\n- `useSendPoolWideClaimRewardsTransaction`\n- `useSendRedeemTransaction`\n- `useSendSetClaimerTransaction`\n- `useSendSetLiquidationPairTransaction`\n- `useSendWithdrawTransaction`\n\n### Vault Hooks\n\n- `useAllPoolWideVaultPromotions`\n- `useAllUserClaimablePoolWideRewards`\n- `useAllUserClaimableRewards`\n- `useAllUserVaultBalances`\n- `useAllUserVaultDelegates`\n- `useAllUserVaultDelegationBalances`\n- `useAllVaultBalances`\n- `useAllVaultContributionAmounts`\n- `useAllVaultExchangeRates`\n- `useAllVaultHistoricalSharePrices`\n- `useAllVaultHistoricalTokenPrices`\n- `useAllVaultPercentageContributions`\n- `useAllVaultPrizeYields`\n- `useAllVaultPromotions`\n- `useAllVaultPromotionsApr`\n- `useAllVaultShareData`\n- `useAllVaultSharePrices`\n- `useAllVaultTokenAddresses`\n- `useAllVaultTokenData`\n- `useAllVaultTokenPrices`\n- `useAllVaultTotalDelegateSupplies`\n- `useAllVaultTotalSupplyTwabs`\n- `usePoolWideVaultPromotions`\n- `useSortedVaults`\n- `useUserClaimableRewards`\n- `useUserVaultDelegate`\n- `useUserVaultDelegationBalance`\n- `useUserVaultShareBalance`\n- `useUserVaultTokenBalance`\n- `useVault`\n- `useVaultBalance`\n- `useVaultClaimer`\n- `useVaultContributionAmount`\n- `useVaultExchangeRate`\n- `useVaultFeeInfo`\n- `useVaultFeesAvailable`\n- `useVaultLiquidationPair`\n- `useVaultOwner`\n- `useVaultPercentageContribution`\n- `useVaultPrizeYield`\n- `useVaultPromotions`\n- `useVaultPromotionsApr`\n- `useVaults`\n- `useVaultShareData`\n- `useVaultSharePrice`\n- `useVaultTokenAddress`\n- `useVaultTokenData`\n- `useVaultTokenPrice`\n- `useVaultTotalDelegateSupply`\n- `useVaultTotalSupplyTwab`\n- `useVaultTwabController`\n- `useVaultYieldSource`\n\n### Zap Hooks\n\n- `useBeefyVault`\n- `useCurveAddLiquidityOutput`\n- `useIsCurveLp`\n- `useIsVelodromeLp`\n- `useLpToken`\n- `useSendDepositZapTransaction`\n- `useSendWithdrawZapTransaction`\n- `useSwapTx`\n- `useZapArgs`\n- `useZapTokenInfo`\n","readmeFilename":"README.md"}