{"_id":"@generationsoftware/hyperstructure-client-js","_rev":"61-a7729c6fb367e4547d5d895712ef40fb","name":"@generationsoftware/hyperstructure-client-js","dist-tags":{"latest":"1.22.2"},"versions":{"1.0.0":{"name":"@generationsoftware/hyperstructure-client-js","version":"1.0.0","license":"MIT","_id":"@generationsoftware/hyperstructure-client-js@1.0.0","maintainers":[{"name":"ncookie","email":"ncukiert@gmail.com"},{"name":"asselstine","email":"mail.asselstine@gmail.com"},{"name":"chuckbergeron","email":"chuck.bergeron+nnppmm@gmail.com"}],"dist":{"shasum":"bf85871e030fd7391c8d57bcb7443eb55a7e53cf","tarball":"https://registry.npmjs.org/@generationsoftware/hyperstructure-client-js/-/hyperstructure-client-js-1.0.0.tgz","fileCount":9,"integrity":"sha512-YGglmMk+3MupWWbMQtcQ1q0CtiIALLLr0FcSatgXdzwV2Czw/GsZ/9K8gmUlS77SdxP/wMlv7i1d1OU7dYvGqg==","signatures":[{"sig":"MEYCIQDTwgzBHMVrk/up+ikhK3oSfvFaSNnqNokypqMSP6m1RwIhAKFYgeX01SIMW/fJ/ABhDC9Hpq9NfQqJcLyO0iX9frA0","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":367686},"main":"./dist/index.mjs","tsup":{"dts":true,"entry":["src/index.ts"],"format":["esm"]},"_from":"file:generationsoftware-hyperstructure-client-js-1.0.0.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\\006bec9d66a2e56c013fca4f1bb63210\\generationsoftware-hyperstructure-client-js-1.0.0.tgz","_integrity":"sha512-YGglmMk+3MupWWbMQtcQ1q0CtiIALLLr0FcSatgXdzwV2Czw/GsZ/9K8gmUlS77SdxP/wMlv7i1d1OU7dYvGqg==","_npmVersion":"8.15.0","description":"

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

\n\n
\n\n# 💻   PoolTogether Hyperstucture Client 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![npm](https://img.shields.io/npm/v/@generationsoftware/hyperstructure-client-js)\n![license](https://img.shields.io/npm/l/@generationsoftware/hyperstructure-client-js)\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 JS client library for wrapping [Viem](https://viem.sh/) contracts and providing simple, unopinionated interfaces for interacting with the protocol.\n\nThe library exports the following classes to interact with different aspects of the protocol, including reading and writing onchain data:\n\n- `PrizePool`\n- `Vault`\n- `Vaults`\n\nUseful utilities and types are also exported from internal packages. See the [utilities](https://github.com/GenerationSoftware/pooltogether-client-monorepo/tree/main/packages/utilities) or [types](https://github.com/GenerationSoftware/pooltogether-client-monorepo/tree/main/packages/types) packages for more info.\n\n## 💾   Installation\n\nThis library is available as an NPM package:\n\n```sh\nnpm install @generationsoftware/hyperstructure-client-js\n```\n\nor\n\n```sh\npnpm install @generationsoftware/hyperstructure-client-js\n```\n\nor\n\n```sh\nyarn add @generationsoftware/hyperstructure-client-js\n```\n\n## 🏎️   Quickstart\n\n### PrizePool\n\nA `PrizePool` is an interface to interact with a [prize pool contract](https://github.com/GenerationSoftware/pt-v5-prize-pool), which is responsible for aggregating contributions from all vaults and awarding prizes.\n\nTo create an instance of a `PrizePool`, you will need:\n\n- The chain ID of the network the prize pool contract is deployed to.\n- The prize pool's address.\n- A [Viem public client](https://viem.sh/docs/clients/public.html).\n\nIf you'd like to use any write methods, you must also provide a [Viem wallet client](https://viem.sh/docs/clients/wallet.html).\n\n```ts\nimport { PrizePool } from '@generationsoftware/hyperstructure-client-js'\nimport { createPublicClient, createWalletClient } from 'viem'\n\n// Viem clients\nconst publicClient = createPublicClient({ ... })\nconst walletClient = createWalletClient({ ... })\n\n// Optional parameters\nconst options = {\n walletClient: walletClient,\n prizeTokenAddress: '0x456...',\n drawPeriodInSeconds: 86_400,\n tierShares: 100\n}\n\n// Initializing PrizePool\nconst prizePool = new PrizePool(1, '0x123...', publicClient, options)\n```\n\n### Vault\n\nA `Vault` is an interface to interact with a [vault contract](https://github.com/GenerationSoftware/pt-v5-vault), which is an [ERC 4626](https://eips.ethereum.org/EIPS/eip-4626) wrapper around any yield source, responsible for deposits and withdrawals.\n\nTo create an instance of a `Vault`, you will need:\n\n- The chain ID of the network the vault contract is deployed to.\n- The vault's address.\n- A [Viem public client](https://viem.sh/docs/clients/public.html).\n\nIf you'd like to use any write methods, you must also provide a [Viem wallet client](https://viem.sh/docs/clients/wallet.html).\n\n```ts\nimport { Vault } from '@generationsoftware/hyperstructure-client-js'\nimport { createPublicClient, createWalletClient } from 'viem'\n\n// Viem clients\nconst publicClient = createPublicClient({ ... })\nconst walletClient = createWalletClient({ ... })\n\n// Optional parameters\nconst options = {\n walletClient: walletClient,\n decimals: 18,\n tokenAddress: '0x456...',\n name: 'Really Cool Vault',\n logoURI: 'https://...',\n tokenLogoURI: 'https://...'\n}\n\n// Initializing Vault\nconst vault = new Vault(1, '0x123...', publicClient, options)\n```\n\n### Vaults\n\nA `Vaults` is an read-only interface for multiple [vault contracts](https://github.com/GenerationSoftware/pt-v5-vault). It is meant to take in all vaults in a `VaultList` and create `Vault` objects for each of them, allowing for more efficient aggregate queries.\n\nTo create an instance of `Vaults`, you will need:\n\n- An array of `VaultInfo` data for each of the vaults in the `VaultList`.\n- [Viem public clients](https://viem.sh/docs/clients/public.html) for each network vaults are deployed in.\n\nSee the typing of a `VaultList` [here](https://github.com/GenerationSoftware/pooltogether-client-monorepo/blob/main/shared/types/types/vaults.ts).\n\n```ts\nimport { Vaults } from '@generationsoftware/hyperstructure-client-js'\n\n// VaultList\nconst vaultList = {\n name: 'Amazing Vault List',\n version: { ... },\n timestamp: '...',\n tokens: [{ ... }]\n}\n\n// Viem public clients\nconst publicClients = {\n 1: createPublicClient({ ... }),\n 10: createPublicClient({ ... }),\n 42161: createPublicClient({ ... })\n}\n\n// Initializing Vaults\nconst vaults = new Vaults(vaultList.tokens, publicClients)\n```\n\n## 🧮   Examples\n\n### Getting prize token data for a prize pool\n\n```ts\nconst tokenData = await prizePool.getPrizeTokenData()\n```\n\n### Getting a prize pool's last awarded draw ID\n\n```ts\nconst lastDrawId = await prizePool.getLastAwardedDrawId()\n```\n\n### Getting current and estimated prize amounts and frequency for all tiers of a prize pool\n\n```ts\nconst allPrizeInfo = await prizePool.getAllPrizeInfo()\n```\n\n### Claiming a prize from a prize pool\n\nNOTE: Since this is a write function, a wallet client is required when initializing `PrizePool`.\n\n```ts\nconst userAddress = '0x123...'\nconst prizeTier = 0\nconst txHash = await prizePool.claimPrize(userAddress, prizeTier)\n```\n\n### Getting token & share data for a vault\n\n```ts\nconst tokenData = await vault.getTokenData() // Deposited asset\nconst shareData = await vault.getShareData() // Receipt token\n```\n\n### Getting a user's deposited balance for a vault\n\n```ts\nconst userAddress = '0x123...'\nconst tokenBalance = await vault.getUserTokenBalance(userAddress)\nconst shareBalance = await vault.getUserShareBalance(userAddress)\n```\n\n### Getting total tokens deposited in a vault\n\n```ts\nconst totalTokenBalance = await vault.getTotalTokenBalance()\n```\n\n### Depositing into a vault\n\nNOTE: Since this is a write function, a wallet client is required when initializing `Vault`.\n\n```ts\nconst amount = 123456789n // Bigint value w/ decimals\nconst txHash = await vault.deposit(amount)\n```\n\n### Withdrawing from a vault\n\nNOTE: Since this is a write function, a wallet client is required when initializing `Vault`.\n\nNOTE: You can `withdraw` a token amount, but it is generally better to `redeem` a share amount.\n\n```ts\nconst amount = 123456789n // Bigint value w/ decimals\nconst txHash = await vault.redeem(amount)\n```\n\n### Getting token & share data for multiple vaults\n\n```ts\nconst allTokenData = await vaults.getTokenData()\nconst allShareData = await vaults.getShareData()\n```\n\n### Getting a user's deposited balances for multiple vaults\n\n```ts\nconst userAddress = '0x123...'\nconst allTokenBalances = await vaults.getUserTokenBalances(userAddress)\nconst allShareBalances = await vaults.getUserShareBalances(userAddress)\n```\n","readmeFilename":"README.md"}