\n\n \n\n| Statements | Branches | Functions | Lines |\n| --------------------------- | ----------------------- | ------------------------- | ----------------- |\n|  |  |  |  |\n\n# Installation\n\n1. Run `yarn`\n\n# Run tests\n\n1. Run `yarn test`\n\n# Functionality\nThe repository currently supports 4 queries:\n* ``src/queries/voltz-protocol/getAMMs``: returns the AMM entities of Voltz Protocol\n* ``src/queries/voltz-protocol/getPositions``: returns the positions of Voltz Protocol\n* ``src/queries/community-sbt/getSeasonUsers``: returns the users of Community v2\n* ``src/queries/community-sbt/getRoots``: returns the merkle roots for the Community v2 badges\n* ``src/queries/voltz-protocol/getHistoricalFixedRate``: returns history of tick updates in the VAMM\n* ``src/queries/voltz-protocol/getHistoricalVariableIndex``: returns history of rate updates in the rate oracle\n\n# Implementing new query\nTo add support for multiple queries, the standard pattern is:\n* to create a new folder inside voltz-protocol or community-sbt (or other) with the name of the query\n* inside the query folder:\n * create a file ``staticQuery.ts`` that generates the GraphQL query string\n * create a mapper file that maps the raw response of the query to the corresponding type\n * create a file ``query.ts`` that fetches the data (in batches of 1000 items)\n * export the necessary variables via ``index.ts``\n * add tests into a dedicated file inside ``tests`` folder\n * add documentation to the query function and update README\n\n# Terms & Conditions\nThe Voltz Protocol, and any products or services associated therewith, is offered only to persons (aged 18 years or older) or entities who are not residents of, citizens of, are incorporated in, owned or controlled by a person or entity in, located in, or have a registered office or principal place of business in any “Restricted Territory.”\n\nThe term Restricted Territory includes the United States of America (including its territories), Algeria, Bangladesh, Bolivia, Belarus, Myanmar (Burma), Côte d’Ivoire (Ivory Coast), Egypt, Republic of Crimea, Cuba, Democratic Republic of the Congo, Iran, Iraq, Liberia, Libya, Mali, Morocco, Nepal, North Korea, Oman, Qatar, Somalia, Sudan, Syria, Tunisia, Venezuela, Yemen, Zimbabwe; or any jurisdictions in which the sale of cryptocurrencies are prohibited, restricted or unauthorized in any form or manner whether in full or in part under the laws, regulatory requirements or rules in such jurisdiction; or any state, country, or region that is subject to sanctions enforced by the United States, such as the Specially Designed Nationals and Blocked Persons List (“SDN List”) and Consolidated Sanctions List (“Non-SDN Lists”), the United Kingdom, or the European Union.\n","readmeFilename":"README.md"}
![\"Voltz\"](\"https://media-exp1.licdn.com/dms/image/D4D16AQHyqUgavAAOUA/profile-displaybackgroundimage-shrink_200_800/0/1664801799041?e=1674086400&v=beta&t=AGn611qP9keyyEF7kuovi_G3bXNPyvk-SZ3i9HTo40U\")
\n ![](\"https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat\"){kind=icon}
\n