diff --git a/docs/bg/README.md b/docs/bg/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/bg/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ + +
+ + diff --git a/docs/bg/miscellaneous/ambassadors.md b/docs/bg/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..25d6802c0c6 --- /dev/null +++ b/docs/bg/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Програма за Амбасадори + +![Банер изображение на Амбасадор](/assets/img/ambassador_banner.png) + +Една от най-силните ни страни е нашата общност, затова с ваша помощ искаме да се разрастваме и да привлечем все повече амбасадори от различни общности по целия свят. + +[Кандидатствайте сега!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## В какво вярваме + +Нашият екип се обединява около споделената визия за изграждане на основите на една гъвкава и приобщаваща услуга за данни в екосистемата Polkadot. + +**Създаден от разработчици, за разработчици:** SubQuery е постоянно растяща общност, фокусираща се върху предоставянето на най-добрите продукти и услуги за нашите разработчици в рамките на нашата екосистема. Проектът SubQuery ще постигне забележителен успех заедно със самата екосистемата Polkadot, всичко, затова което правим, е с мисъл за клиентите. + +**Почтеност и отчетност:** Нашият екип е съставен от различни членове, някои от тях се намират в Окланд, Шанхай и Сидни, затова дистанционната работа е важна за нас. Очакваме членовете от нашия екип да работят автономно и в същото време задружно и синхронизирано, за постигане на целите ни. Основното изискване, което имаме е членовете от екипа ни да носят отговарност за действията си и да се държат почтено помежду си и с работните задълженията. + +**Ръководство по приобщаване и поддръжка:** Блокчейн технологиите са трудни, затова всеки понякога се нуждае от помощ. В нашата общност ние не се притесняваме от зададените въпроси, няма такова нещо като глупав въпрос, затова се очаква всеки член от нашия екип да помага и подкрепя нашите потребители. Често научаваме някои важни и ценни възможности относно предоставяните ни услуги (и как можем да ги подобрим) директно от нашата общност. + +## Нашата Амбасадорска програма + +Нашата програма SubQuery Ambassador цели намиране на членове и лидери от общността, интересуващи се от Polkadot и SubQuery. Търсим самоинициативни участници, които ще ни помогнат в разпространението на информацията за SubQuery в общностите от своите региони и държави и да предоставят подкрепа на нови разработчици, целящи използване на SubQuery за създаване на невероятни приложения и услуги в Polkadot. + +### Предимства, които носи Амбасадорската програма + +В SubQuery работим усилено, за да постигнем целите си. По същия начин очакваме от нашите амбасадорите да отделят една част от свободното си време, след присъединяване към нашия екип, за което ще бъдат възнаградени. + +**Финансиране и подкрепа:** Възможно е да бъдете възнаградени за добра работа и помощ в развитието на проекта с различни възможности като продажби, награди, конкурси. Готови сме да ви предоставим ви предоставим безвъзмездни средства за провеждане на срещи и АМА във вашата общност. + +**Достъп до екипа на SubQuery:** Получавате директен достъп към основния екип на SubQuery с възможности за практическо обучение, ексклузивни AMA с нашите лидери и разработчици и достъп към нашата пътна карта. + +**Развитие на мрежата:** Бъдете готови към развието вашите собствени професионални умения, контакти, бъдейки Амбасадор на един от най-добрите проекти в Polkadot. Запознайте се с други амбасадори от целия свят и получете информация относно локални проекти в Polkadot, които трябва да подкрепим на местно ниво. Ще се постараем да ви осигурим безплатен вход, за да получите възможност да представлявате SubQuery в събития във вашия регион. + +**Swag и други безплатни стоки:** Всеки харесва безплатни неща и подаръци! Получавайте веднъж годишно безплатни неща и SubQuery swag, които ще ви помогнат да се откроите в тълпата. Допълнително разпределени подаръци, което можете да споделяте и подарявате при организация на събития в общността. Ще получите и ексклузивен NFT за вашия статус на амбасадор. + +## Какъв е процеса на работа + +Нашата програма за Амбасадори се състои множество нива, всяко от които има различни предимства и възможности. Можете да се придвижвате нагоре в йерархията, като участвате в различните дейности за Амбасадори и работите усилено за нас. + +След като изпратите вашето заявление за участие, ние ще изберем кандидати, които отговарят на нашите ценности. Ако бъдете избрани, започвате дейност в нашата програма като стажанти като получите информационен пакет, объясняващ и подпомагащ разбирането ви за SubQuery. След това можете да започнете да работите в програмата за стажанти, като изпълнявате определени задачи (например създаване на SubQuery проект). Ще бъдем домакини на семинари по време на този процес, за да ви подкрепим. + +След като преминете успешно програмата за стажанти, ще се издигнете до амбасадор на SubQuery и ще бъдете приети напълно в нашата програма. Оттук нататък можете да продължите да работите в програмата, да напредвате нагоре по нивата, като печелите повече награди и предимства, докато се изкачвате в системата от ранговете. + +## Активности на Амбасадорите + +Амбасадорите на SubQuery имат възможност да допринесат към проекта по четири основни начина, включително организиране на събития, създаване на контент, превод и управляване на общността. Можете да участвате в толкова от областите, в колкото пожелаете, като не сте задължени с която и да е една определена. + +**Организиране на събития:** Изграждайте локални общности като хоствате, организирате и провеждате различни събития. Изграждането на локално общности е ключов аспект при разрастването на общността SubQuery. SubQuery ще ви подкрепи чрез осигуряване финансиране за организиране на събития, с предоставяне на swag/стоки за раздаване на членовете от общността, както и с участие в онлайн събития Q& или като лектори или в сесии или AMA. + +**Създаване на контент:** Предлагаме дълъг списък с контент и помощни материали, от които се нуждаете като помощ при създаването на контента. Не забравяйте, че нашият успех разчита на способността на нашите потребители да изграждат невероятни неща въз основа на нашата база, така че се нуждаем от вашата помощ, за да направим това по-лесно. Контента, създаден от вас може да включва видеа, инфографики, упътвания, анимации или всякакви други свързани материали, за да повече информиранност, образование или вдъхновяване на членове на общността в рамките на екосистемата на SubQuery. SubQuery ще ви подкрепи в създаването на контент чрез предоставяне на брандинг материали и опит в подобна сфера. Използваме също така маркетинговите инструменти на SubQuery, за да бъдат информирани другите относно вашето съдържание (и за вас самите). + +**Преводи:** Нашите потребители не говорят само английски език! Нуждаем се от вашата помощ да направим SubQuery по-достъпен, затова очакваме да ни помогнете с превода на нашият контент на ваш роден език, както и да помогнете за споделянето на информацията с нашата международна общност. + +**Модериране и управление на общността:** Модераторите помогат за разрастването на общността на SubQuery, като гарантират, че официалните канали на общността са активни и ангажиращи. SubQuery ще подкрепя модераторите, като популяризира каналите, които те ръководят, както и ще предоставя насоки за действията. + +[Кандидатствайте сега!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/bg/miscellaneous/branding.md b/docs/bg/miscellaneous/branding.md new file mode 100644 index 00000000000..20a6ca20422 --- /dev/null +++ b/docs/bg/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Брандирани материали + +**Всички елементи от бранда/ марката SubQuery са фирмена собственост, като се отнасяме много отговорно към нашата визията бранда. ** + +Ако решите да използвате различни търговски марки, лого, дизайни или други характеристики на марката, моля, следвайте внимателно указанията описани тук или се свържете с нас чрез социалните медии за допълнително разяснение. + +Ако се съмнявате, попитайте! + +## Пакет от брандинг активи + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/bg/miscellaneous/contributing.md b/docs/bg/miscellaneous/contributing.md new file mode 100644 index 00000000000..6fadbe6fac6 --- /dev/null +++ b/docs/bg/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Принос и участие в SubQuery + +Добре дошли и ви благодаря, че обмисляте да допринесете за този SubQuery проект! Заедно можем да проправим пътя към по-децентрализирано бъдеще. + +::: tip Note This documentation is actively maintained by the SubQuery team. Приветстваме и се радваме на вашия принос към проекта. Можете да го направите, като създадете форк на нашия GitHub проект и направите промени във всички файлове от документацията в директорията `документи`. ::: + +По-долу ви предоставяме набор от насоки (не правила) за принос към SubQuery. Следването на тези указания ще ни помогне да направим процеса на принос лесен и ефективен за всички участници. Това също означава, че се съгласявате да уважавате времето на разработчиците, които управляват и разработват този проект. В замяна ние ще отвърнем на това с доза уважение, като разгледаме проблема ви, ще разгледаме промените, ще си сътрудничим за подобрения и ще ви помогнем да финализирате заявките си. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Кодекс на поведение + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Нека да започнем + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Потърсете съществуващи проблеми и заявки за изтегляне, преди да създадете свои собствени. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Приятелското @ споменаване в коментарите към подателя или сътрудника, може да ви помогне да привлечете внимание, в случай че проблемът ви блокира. + +## Как да допринесете + +### Докладване на грешки + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Използвайте ясно и описателно заглавие на проблема, за да идентифицирате проблема. +- Опишете точните стъпки за възпроизвеждане на проблема. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Включете снимки на екрана, ако е възможно. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Подаване на заявки за изтегляне + +In general, we follow the "fork-and-pull" Git workflow: + +- Разклонете хранилището към вашия собствен Github акаунт. +- Клонирайте проекта на вашата машина. +- Създайте клон локално със сбито, но описателно име. +- Извършете промени в клона. +- Следвайки всички указания за форматиране и тестване, специфични за това репо. +- Изпратете промените във вашата вилица. +- Отворете PR в нашето хранилище. + +## Правила за кодиране + +### Git Commit съобщения + +- Използвайте сегашно време („Добавяне на функция“, а не „Добавена функция“). +- Използвайте повелително наклонение („Преместване на курсора на...“, а не „Преместване на курсора на...“). +- Ограничете първия ред до 72 знака или по-малко. + +### JavaScript Styleguide + +- Целият JavaScript код е линтиран с Prettier и ESLint. diff --git a/docs/bg/miscellaneous/social_media.md b/docs/bg/miscellaneous/social_media.md new file mode 100644 index 00000000000..0e0920dafb9 --- /dev/null +++ b/docs/bg/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Линкове към социалните медии + +SubQuery е активен проект, който поддържа връзка и комуникира със своите последователи чрез различни канали в социалните медийни. + +Нашата цел - винаги да слушаме активните членове и да се ангажираме с лоялнана част от нашата общност, така че ви молим да се присъедините към беседите и ни изпращате вашите идеи или въпроси! + +## Линкове към Официалните общности в SubQuery + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Основна общност със създадени канали за техническа поддръжка) +- [Medium](https://subquery.medium.com) (Основен канал за съобщения) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (Канал само за анонси) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Линкове към Неофициалните общности в SubQuery + +Тези общности не се модерират от екипа на SubQuery, а от нашите Амбасадори, които ще ви предоставят подкрепа. Моля, внимавайте със всякакъв вид измама или скам, тъй като SubQuery **не** носи отговорност, за това, което се случва в тях. + +- [Telegram (Chinese)](https://t.me/subquerychina) +- [Telegram (Russian)](https://t.me/SubQuery_russia) +- [Telegram (Spanish)](https://t.me/SubQueryES) +- [Telegram (Thai)](https://t.me/subquerynetworkthai) +- [Telegram (Turkish)](https://t.me/subquery_TR) +- [Telegram (Vietnamese)](https://t.me/subqueryvietnam) +- [Telegram (Vietnamese Announcement)](https://t.me/subqueryannvn) diff --git a/docs/bg/miscellaneous/vulnerability-reporting.md b/docs/bg/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/bg/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/bg/subquery_network/2024.md b/docs/bg/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/bg/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/bg/subquery_network/about.md b/docs/bg/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/bg/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/bg/subquery_network/community.md b/docs/bg/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/bg/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/bg/subquery_network/fair-use.md b/docs/bg/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/bg/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/bg/subquery_network/faq.md b/docs/bg/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/bg/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/bg/subquery_network/glossary.md b/docs/bg/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/bg/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/bg/subquery_network/infra-changes.md b/docs/bg/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/bg/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/bg/subquery_network/parameters.md b/docs/bg/subquery_network/parameters.md new file mode 100644 index 00000000000..26139d81a0d --- /dev/null +++ b/docs/bg/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Описание | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/bg/subquery_network/welcome.md b/docs/bg/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/bg/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/de/README.md b/docs/de/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/de/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/de/miscellaneous/ambassadors.md b/docs/de/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..7935e28542a --- /dev/null +++ b/docs/de/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Ambassador-Programm + +![Ambassador Banner Bild](/assets/img/ambassador_banner.png) + +Wir wissen, dass eine unserer größten Stärken unsere Gemeinschaft ist, und mit Ihrer Hilfe möchten wir wachsen und lokale Ambassadors für Gemeinschaften auf der ganzen Welt etablieren. + +[Jetzt bewerben!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## Woran wir glauben + +Unser Team kam mit der gemeinsamen Vision zusammen, die Grundlagen für einen flexiblen und integrativen Datendienst für das Polkadot-Ökosystem zu schaffen. + +**Von Entwicklern für Entwickler entwickelt:** SubQuery ist eine wachsende Community, die sich darauf konzentriert, unseren Entwicklern und Buildern in unserem Ökosystem die besten Produkte und Dienstleistungen bereitzustellen. SubQuery ist nur erfolgreich, wenn das Polkadot-Ökosystem erfolgreich ist, und daher haben wir bei allem, was wir tun, unsere Kunden im Blick. + +**Integrität und Verantwortlichkeit:** Wir haben Teammitglieder in Auckland, Shanghai und Sydney, daher ist uns Remote-Arbeit wichtig. Wir erwarten, dass unser Team befähigt ist und eigenverantwortlich zusammenarbeitet, um unsere Ziele zu erreichen. Eine wesentliche Voraussetzung dafür ist, dass unser Team für sein Handeln verantwortlich ist und seine Integrität bewahrt. + +**Inklusive Anleitung und Unterstützung:** Blockchain ist schwer und jeder braucht manchmal Hilfe. In unserer Community gibt es keine dummen Fragen und von jedem in unserem Team wird erwartet, dass er unsere Benutzer unterstützt. Einige der wertvollsten Erkenntnisse über unseren Service (und wie wir ihn verbessern können) erfahren wir direkt von unserer Community. + +## Unser Ambassador-Programm + +Unser SubQuery Ambassador-Programm zielt darauf ab, Community-Leader zu finden, die sich für Polkadot und SubQuery begeistern. Wir suchen nach Selbststartern, die SubQuery in ihren lokalen Gebieten bekannt machen und neue Entwickler unterstützen, die mit SubQuery fantastische Apps und Dienste auf Polkadot erstellen möchten. + +### Ambassador-Vorteile + +Bei SubQuery arbeiten wir hart daran, das zu erreichen, was wir tun. In ähnlicher Weise wird von Botschaftern erwartet, dass sie sich etwas Zeit nehmen, wenn sie unserem Team beitreten, werden jedoch mit Vorteilen belohnt. + +**Finanzierung und Unterstützung:** Sie können für gute Arbeit mit frühen Gelegenheiten zu privaten Verkäufen und Prämien belohnt werden. Darüber hinaus stellen wir Ihnen finanzielle Zuschüsse für die Durchführung von Community-Meetings zur Verfügung. + +**Das SubQuery-Team-Zugriff:** Sie haben direkten Zugriff auf das Kernteam von SubQuery mit Möglichkeiten für praktische Schulungen, exklusive AMAs mit unseren Führungskräften und Entwicklern und Einblicke in unsere Roadmap. + +**Netzwerkentwicklung:** Erwarten Sie, dass Sie Ihr berufliches Netzwerk erweitern, indem Sie Ambassador für eines der Top-Projekte von Polkadot werden. Treffen Sie andere Ambassadors aus der ganzen Welt und erhalten Sie Einführungen in lokale Polkadot-Projekte, die wir vor Ort unterstützen müssen. Möglicherweise erhalten Sie sogar freien Eintritt, um SubQuery bei Veranstaltungen in Ihrer Nähe zu vertreten. + +**Swag und andere kostenlose Sachen:** Jeder mag kostenlose Sachen! Erhalten Sie eine jährliche Zuteilung von SubQuery-Swag, mit der Sie sich von der Masse abheben. Plus zusätzliche Zuweisung, die Sie bei Community-Events teilen können. Sie erhalten außerdem eine exklusive NFT für Ihren Ambassador-Status. + +## Wie funktioniert es + +Unser Ambassador-Programm hat mehrere Stufen, jede Stufe hat unterschiedliche Vorteile und Fähigkeiten. Sie können aufsteigen, indem Sie an Ambassador-Aktivitäten teilnehmen und hart für uns arbeiten. + +Nachdem Sie eine Bewerbung abgeschickt haben, wählen wir Kandidaten aus, die unseren Werten entsprechen. Bei Auswahl werden Sie in unser Traineeprogramm aufgenommen und erhalten ein Informationspaket, das Ihr Verständnis von SubQuery erweitert. Danach können Sie mit dem Durcharbeiten des Trainee-Programms beginnen, indem Sie bestimmte Onboarding-Aufgaben erledigen (z. B. Erstellen eines SubQuery-Projekts). Wir werden während dieses Prozesses Workshops veranstalten, um Sie zu unterstützen. + +Sobald Sie das Trainee-Programm bestanden haben, können Sie sich SubQuery-Ambassador nennen und werden in unser vollständiges Programm aufgenommen. Von nun an können Sie das Programm weiter durcharbeiten und die Stufen aufsteigen, um beim Aufsteigen der Ränge mehr Belohnungen und Vorteile zu erhalten. + +## Ambassador-Aktivitäten + +SubQuery-Ambassadors können in vier Hauptbereichen einen Beitrag leisten, darunter Veranstaltungsmanagement, Inhaltserstellung, Übersetzung und Community-Moderation. Du kannst an so vielen Bereichen teilnehmen, wie du möchtest, du bist nicht an einen gebunden. + +**Veranstaltungsmanagement:** Bauen Sie lokale Gemeinschaften auf, indem Sie verschiedene Veranstaltungen veranstalten, organisieren und verwalten. Der Aufbau einer lokalen Community wird ein wichtiger Bestandteil des Wachstums der SubQuery-Community sein. SubQuery unterstützt Sie durch die Bereitstellung von Mitteln für Veranstaltungen, das Versenden von Swag/Merchandise zum Verschenken sowie die Teilnahme an Fragen und Antworten oder Online-Veranstaltungen als Redner oder in AMA-Sitzungen. + +**Inhaltserstellung:** Wir haben eine lange Liste von Inhalten und unterstützendem Material, bei deren Erstellung wir Hilfe benötigen. Denken Sie daran, dass unser Erfolg von der Fähigkeit unserer Kunden abhängt, erstaunliche Dinge auf unserem Service aufzubauen, also brauchen wir Ihre Hilfe, um dies einfacher zu machen. Der Inhalt umfasst Videos, Infografiken, Tutorials, Animationen oder andere verwandte Materialien, um Community-Mitglieder innerhalb des SubQuery-Ökosystems zu informieren, aufzuklären oder zu inspirieren. SubQuery wird Inhaltsersteller unterstützen, indem es Branding-Assets und Fachwissen bereitstellt. Wir nutzen auch die Marketingkanäle von SubQuery, um die Bekanntheit Ihrer Inhalte (und Ihrer selbst) zu steigern. + +**Übersetzung:** Unsere Kunden sprechen nicht nur Englisch! Wir brauchen Ihre Hilfe, um SubQuery zugänglicher zu machen, indem Sie unsere Inhalte in Ihre eigene Sprache übersetzen und dabei helfen, das Wort mit unserer internationalen Community zu teilen. + +**Community-Moderation:** Moderatoren tragen zum Wachstum der SubQuery-Community bei, indem sie sicherstellen, dass die offiziellen Community-Kanäle aktiv und ansprechend sind. SubQuery wird Moderatoren unterstützen, indem es die von ihnen überwachten Kanäle fördert und Richtlinien für unsere Erwartungen bereitstellt. + +[Jetzt bewerben!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/de/miscellaneous/branding.md b/docs/de/miscellaneous/branding.md new file mode 100644 index 00000000000..1d1b22e4dd9 --- /dev/null +++ b/docs/de/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Markenmaterialien + +**Alle Markenfunktionen von SubQuery sind proprietär und wir nehmen unsere Marke sehr ernst.** + +Wenn Sie sich für die Verwendung von Marken, Logos, Designs oder anderen Markenmerkmalen entscheiden, befolgen Sie bitte sorgfältig die Richtlinien hier oder kontaktieren Sie uns über soziale Medien zur Klärung. + +Im Zweifel bitte nachfragen! + +## Marken-Assets-Paket + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/de/miscellaneous/contributing.md b/docs/de/miscellaneous/contributing.md new file mode 100644 index 00000000000..985f80f8b08 --- /dev/null +++ b/docs/de/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Zu SubQuery beitragen + +Herzlich Willkommen und vielen Dank, dass Sie in Erwägung ziehen, zu diesem SubQuery-Projekt beizutragen! Gemeinsam können wir den Weg in eine dezentralere Zukunft ebnen. + +::: tip Note This documentation is actively maintained by the SubQuery team. Wir freuen uns über Ihre Beiträge. Sie können dies tun, indem Sie unser GitHub-Projekt verzweigen und Änderungen an allen Dokumentations-Markdown-Dateien im Verzeichnis `docs` vornehmen. ::: + +Was folgt, ist eine Reihe von Richtlinien (keine Regeln) für das Mitwirken an SubQuery. Die Befolgung dieser Richtlinien hilft uns dabei, den Beitragsprozess für alle Beteiligten einfach und effektiv zu gestalten. Es teilt auch mit, dass Sie sich bereit erklären, die Zeit der Entwickler zu respektieren, die dieses Projekt verwalten und entwickeln. Im Gegenzug werden wir diesen Respekt erwidern, indem wir Ihr Problem angehen, Änderungen in Betracht ziehen, an Verbesserungen mitarbeiten und Ihnen helfen, Ihre Pull-Anfragen abzuschließen. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Code of Conduct + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Erste Schritte + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Suchen Sie nach bestehenden Problemen und PRs, bevor Sie Ihre eigenen erstellen. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Eine freundliche @-Erwähnung im Kommentarthread an den Einreicher oder einen Beitragenden kann helfen, Aufmerksamkeit zu erregen, wenn Ihr Problem blockiert. + +## Wie man einen Beitrag leistet + +### Fehler melden + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Verwenden Sie einen klaren und beschreibenden Titel für das Problem, um das Problem zu identifizieren. +- Beschreiben Sie die genauen Schritte, um das Problem zu reproduzieren. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Fügen Sie wenn möglich Screenshots hinzu. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Senden von Pull-Requests + +In general, we follow the "fork-and-pull" Git workflow: + +- Verzweigen Sie das Repository zu Ihrem eigenen Github-Konto. +- Klonen Sie das Projekt auf Ihren Computer. +- Erstellen Sie lokal einen Zweig mit einem prägnanten, aber aussagekräftigen Namen. +- Übernehmen Sie Änderungen an der Verzweigung. +- Befolgen Sie alle Formatierungs- und Testrichtlinien, die für dieses Repo spezifisch sind. +- Pushen Sie Änderungen an Ihren Fork. +- Öffnen Sie eine PR in unserem Repository. + +## Kodierungskonventionen + +### Git-Commit-Nachrichten + +- Verwenden Sie die Gegenwartsform ("Add feature" not "Added feature"). +- Verwenden Sie den Imperativ ("Move cursor to..." not "Moves cursor to..."). +- Beschränken Sie die erste Zeile auf 72 Zeichen oder weniger. + +### JavaScript-Styleguide + +- Der gesamte JavaScript-Code ist mit Prettier und ESLint versehen. diff --git a/docs/de/miscellaneous/social_media.md b/docs/de/miscellaneous/social_media.md new file mode 100644 index 00000000000..4685d4620b1 --- /dev/null +++ b/docs/de/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Social-Media-Links + +SubQuery ist ein aktives Projekt, das unsere Follower über viele Social-Media-Kanäle pflegt und mit ihnen kommuniziert. + +Es ist unser Ziel, unserer treuen Community immer zuzuhören und mit ihr in Kontakt zu treten. Bitte beteiligen Sie sich an der Diskussion und senden Sie uns Ihre Ideen oder Fragen! + +## Offizielle SubQuery-Communitys + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Primäre Community mit dedizierten technischen Supportkanälen) +- [Medium](https://subquery.medium.com) (Primärer Ankündigungskanal) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (Nur Ankündigungskanal) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Inoffizielle SubQuery-Communitys + +Diese Communities werden nicht vom SubQuery-Team moderiert, aber unsere Ambassadors sind möglicherweise da, um Sie zu unterstützen. Bitte seien Sie vorsichtig bei Betrug, da SubQuery **nicht** für das verantwortlich ist, was darin passiert. + +- [Telegram (Chinesisch)](https://t.me/subquerychina) +- [Telegram (Russisch)](https://t.me/SubQuery_russia) +- [Telegram (Spanisch)](https://t.me/SubQueryES) +- [Telegram (Thai)](https://t.me/subquerynetworkthai) +- [Telegram (Türkisch)](https://t.me/subquery_TR) +- [Telegram (Vietnamesisch)](https://t.me/subqueryvietnam) +- [Telegram (vietnamesische Ankündigungen)](https://t.me/subqueryannvn) diff --git a/docs/de/miscellaneous/vulnerability-reporting.md b/docs/de/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/de/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/de/subquery_network/2024.md b/docs/de/subquery_network/2024.md new file mode 100644 index 00000000000..cea4a68d051 --- /dev/null +++ b/docs/de/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. Das SubQuery-Token (SQT) ist als Utility-Token konzipiert, das das SubQuery-Netzwerk antreibt, einen Anreiz zur Teilnahme bietet und als Tauschmittel für Transaktionen innerhalb des SubQuery-Netzwerks dient. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/de/subquery_network/about.md b/docs/de/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/de/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/de/subquery_network/community.md b/docs/de/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/de/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/de/subquery_network/fair-use.md b/docs/de/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/de/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/de/subquery_network/faq.md b/docs/de/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/de/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/de/subquery_network/glossary.md b/docs/de/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/de/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/de/subquery_network/infra-changes.md b/docs/de/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/de/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/de/subquery_network/parameters.md b/docs/de/subquery_network/parameters.md new file mode 100644 index 00000000000..a52ca956a6b --- /dev/null +++ b/docs/de/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Beschreibung | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/de/subquery_network/welcome.md b/docs/de/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/de/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/es/README.md b/docs/es/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/es/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/es/miscellaneous/ambassadors.md b/docs/es/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..57c81786a77 --- /dev/null +++ b/docs/es/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Programa de Embajador + +![Ambassador Banner Image](/assets/img/ambassador_banner.png) + +Entendemos que una de nuestras mayores fortalezas es nuestra comunidad, y con tu ayuda, queremos crecer y establecer embajadores locales para comunidades de todo el mundo. + +[¡Aplica ahora!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## En qué creemos + +Nuestro equipo se unió a la visión compartida de construir los cimientos de un servicio de datos flexible e inclusivo para el ecosistema Polkadot. + +**Construido por desarrolladores, para desarrolladores:** SubQuery es una comunidad creciente que se centra en proporcionar los mejores productos y servicios para nuestros desarrolladores, y constructores en nuestro ecosistema. SubQuery sólo es exitoso si el ecosistema Polkadot tiene éxito, por lo que todo lo que hacemos está pensando en nuestros clientes. + +**Integridad y responsabilidad:** Tenemos miembros del equipo en Auckland, la República Checa y Sydney por lo que el trabajo remoto es importante para nosotros. Esperamos que nuestro equipo esté capacitado y trabaje juntos de forma autónoma para lograr nuestros objetivos. Un requisito clave para esto es que nuestro equipo rinda cuentas por sus acciones y mantenga su integridad. + +**Guía y soporte incluidos:** Blockchain es difícil y todo el mundo necesita ayuda a veces. No existe una pregunta estúpida en nuestra comunidad y se espera que todos los miembros de nuestro equipo ayuden a nuestros usuarios. Aprendemos algunas de las ideas más valiosas acerca de nuestro servicio (y cómo podemos mejorarlo) directamente de nuestra comunidad. + +## Nuestro Programa de Embajador + +Nuestro programa de Embajadores de SubQuery tiene como objetivo encontrar líderes comunitarios apasionados por Polkadot y SubQuery. Estamos buscando autoiniciadores que puedan difundir la noticia sobre SubQuery en sus áreas locales y proporcionar soporte a nuevos desarrolladores que quieran usar SubQuery para construir aplicaciones y servicios asombrosos en Polkadot. + +### Beneficios del Embajador + +En SubQuery, trabajamos duro para lograr lo que hacemos. Del mismo modo, se espera que los Embajadores se comprometan algún tiempo al unirse a nuestro equipo, pero serán recompensados con beneficios. + +**Financiación y soporte:** Es posible que seas recompensado por un buen trabajo con oportunidades tempranas en ventas privadas y recompensas. Adicionalmente, estaremos proporcionando subvenciones para que usted organice reuniones de la comunidad. + +**Acceso al Equipo de SubQuery:** Tendrás acceso directo al equipo de SubQuery principal con oportunidades de entrenamiento práctico, AMAs exclusivas con nuestros líderes y desarrolladores, y ver nuestra ruta. + +**Desarrollo de red:** Espere que su red profesional crezca siendo un embajador de uno de los mejores proyectos Polkadot. Conoce a otros embajadores de todo el mundo y recibe presentaciones a proyectos locales de Polkadot que necesitamos apoyar localmente. Incluso puede obtener entrada gratuita para representar a SubQuery en eventos en su área local. + +**Swag y otras cosas gratis:** ¡A todo el mundo le gusta las cosas gratis! Recibe una asignación anual de SubQuery swag que te hará destacar del resto. Además de la asignación adicional que puedes compartir en eventos de la comunidad. También recibirás un NFT exclusivo para tu estatus de Embajador. + +## ¿Cómo funciona? + +Nuestro programa de Embajadores tiene múltiples niveles, cada nivel tiene diferentes beneficios y capacidades. Usted puede subir niveles participando en las actividades del Embajador y trabajando duro para nosotros. + +Una vez que haya enviado una solicitud, seleccionaremos candidatos que se ajusten a nuestros valores. Si lo seleccionamos, usted se coloca en nuestro programa de prácticas y recibirá un paquete de información, ampliando su comprensión de SubQuery. Después de esto, puede comenzar a trabajar a través del programa de prácticas completando ciertas tareas de incorporación (por ejemplo, crear un Proyecto de SubQuery). Realizaremos talleres durante todo este proceso para apoyarle. + +Una vez que pase el programa de aprendizaje, puede llamarse embajador de SubQuery y será aceptado en nuestro programa completo. Desde aquí puedes continuar trabajando a través del programa y progresar en los niveles, ganar más recompensas y beneficios a medida que subas el rango. + +## Actividades del embajador + +SubQuery Ambassadors are able to contribute through four main areas, including event management, content creation, translation, and community moderation. You can participate in as many areas as you want, you’re not bound to any single one. + +**Event Management:** Build local communities by hosting, organising, and managing different events. Building a local community will be a key part of growing the SubQuery community. SubQuery will support you by providing funding for events, sending swag/merchandise to be given away, as well as attending Q&As or online events as speakers or in AMA sessions. + +**Content Creation:** We have a long list of content and support material that we need help creating. Remember, our success relies on the ability of our customers to build amazing things on our service, so we need your help to make that easier. Content includes videos, infographics, tutorials, animations, or any other related material, to inform, educate, or inspire community members within the SubQuery Ecosystem. SubQuery will support Content Creators by providing branding assets and expertise. We’ll also use SubQuery’s marketing channels to increase awareness of your content (and yourself). + +**Translation:** Our customers don’t just speak English! We need your help making SubQuery more accessible by translating our content into your own language, as well as helping sharing the word to our international community. + +**Community Moderation:** Moderators will help grow the SubQuery community by ensuring that official community channels are active and engaging. SubQuery will support Moderators by promoting the channels that they monitor, as well as provide guidelines for our expectations. + +[¡Aplica ahora!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/es/miscellaneous/branding.md b/docs/es/miscellaneous/branding.md new file mode 100644 index 00000000000..13dc616f71f --- /dev/null +++ b/docs/es/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Material de Marca + +**Todas las características de la marca de SubQuery son propietarias y nos tomamos nuestra marca extremadamente en serio.** + +Si opta por utilizar cualquier marca registrada, logotipos, diseños u otras características de marca, por favor siga cuidadosamente las directrices aquí o comuníquese con nosotros a través de los medios de comunicación sociales para aclaración. + +En caso de duda, por favor, pregunte! + +## Paquete de Recursos de Marca + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/es/miscellaneous/contributing.md b/docs/es/miscellaneous/contributing.md new file mode 100644 index 00000000000..0232ff7eec8 --- /dev/null +++ b/docs/es/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Contribuyendo a SubQuery + +¡Bienvenido y un gran agradecimiento por considerar contribuir a este proyecto de SubQuery! Juntos podemos allanar el camino hacia un futuro más descentralizado. + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Código de Conducta + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Primeros pasos + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Busca problemas y PRs existentes antes de crear los tuyos. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Una mención amigable @ en el hilo de comentarios para el envío o un colaborador puede ayudar a llamar la atención si su problema está bloqueando. + +## ¿Cómo contribuir? + +### Informar de fallos + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Utilice un título claro y descriptivo para identificar el problema. +- Describa los pasos exactos para reproducir el problema. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Incluye capturas de pantalla si es posible. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Envío de Pull Request + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## Convenciones de Código + +### Mensajes de Git Commit + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### Guía de estilo de JavaScript + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/es/miscellaneous/social_media.md b/docs/es/miscellaneous/social_media.md new file mode 100644 index 00000000000..0dc99251125 --- /dev/null +++ b/docs/es/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Enlaces a redes sociales + +SubQuery es un proyecto activo que mantiene y se comunica con nuestros seguidores a través de muchos canales de redes sociales. + +Nuestro objetivo es siempre escuchar y comprometerse con nuestra comunidad leal, así que por favor únase a la conversación y envíenos sus ideas o preguntas! + +## Comunidades Oficiales de SubQuery + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Comunidad primaria con canales de soporte técnico dedicados) +- [Medium](https://subquery.medium.com) (Canal de anuncios principal) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (Sólo canal de anuncios) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Comunidades de SubQuery no oficiales + +Estas comunidades no son moderadas por el equipo de SubQuery, pero nuestros embajadores pueden estar allí para proporcionar apoyo. Por favor, ten cuidado con las estafas ya que SubQuery **no** es responsable de lo que sucede dentro de ellas. + +- [Telegram (Chino)](https://t.me/subquerychina) +- [Telegram (Ruso)](https://t.me/SubQuery_russia) +- [Telegram (Spanish)](https://t.me/SubQueryES) +- [Telegram (Thai)](https://t.me/subquerynetworkthai) +- [Telegram (Turkish)](https://t.me/subquery_TR) +- [Telegram (Vietnamese)](https://t.me/subqueryvietnam) +- [Telegram (Vietnamese Announcement)](https://t.me/subqueryannvn) diff --git a/docs/es/miscellaneous/vulnerability-reporting.md b/docs/es/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/es/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/es/subquery_network/2024.md b/docs/es/subquery_network/2024.md new file mode 100644 index 00000000000..1fa294e025c --- /dev/null +++ b/docs/es/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. SubQuery Token (SQT) está diseñado como un token de utilidad que potencia la SubQuery Network, proporcionando un incentivo para la participación, así como servir como medio de intercambio para transacciones dentro de SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/es/subquery_network/about.md b/docs/es/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/es/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/es/subquery_network/community.md b/docs/es/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/es/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/es/subquery_network/fair-use.md b/docs/es/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/es/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/es/subquery_network/faq.md b/docs/es/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/es/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/es/subquery_network/glossary.md b/docs/es/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/es/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/es/subquery_network/infra-changes.md b/docs/es/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/es/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/es/subquery_network/parameters.md b/docs/es/subquery_network/parameters.md new file mode 100644 index 00000000000..b27b8885f37 --- /dev/null +++ b/docs/es/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Descripción | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/es/subquery_network/welcome.md b/docs/es/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/es/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/fr/README.md b/docs/fr/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/fr/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/fr/miscellaneous/ambassadors.md b/docs/fr/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..bc2fb8406a0 --- /dev/null +++ b/docs/fr/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Programme Ambassadeur + +![Image de la bannière de l'ambassadeur](/assets/img/ambassador_banner.png) + +Nous savons que l'une de nos plus grandes forces est notre communauté, et avec votre aide, nous voulons nous développer et établir des ambassadeurs locaux pour les communautés du monde entier. + +[Postulez maintenant !](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## Ce en quoi nous croyons + +Notre équipe s'est réunie avec la vision commune de construire les bases d'un service de données flexible et inclusif pour l'écosystème Polkadot. + +**Construit par des développeurs, pour des développeurs:** SubQuery est une communauté en pleine croissance qui se concentre sur la fourniture des meilleurs produits et services pour nos développeurs, et les constructeurs de notre écosystème. SubQuery n'est une réussite que si l'écosystème Polkadot est une réussite, c'est pourquoi tout ce que nous faisons à pour but de satisfaire nos clients. + +**Intégrité et responsabilité:** Nous avons des membres de l'équipe à Auckland, Shanghai et Sydney, donc le travail à distance est important pour nous. Nous attendons de notre équipe qu'elle soit responsabilisée et qu'elle travaille ensemble de manière autonome pour atteindre nos objectifs. Pour cela, il est essentiel que notre équipe soit responsable de ses actes et conserve son intégrité. + +**Orientation et soutien inclusifs :** La blockchain est difficile, et tout le monde a parfois besoin d'aide. Il n'y a pas de question stupide dans notre communauté et chacun dans notre équipe est censé aider nos utilisateurs. C'est directement auprès de notre communauté que nous obtenons certaines des informations les plus précieuses sur notre service (et sur la manière de l'améliorer). + +## Notre programme d'ambassadeurs + +Notre programme d'ambassadeurs SubQuery vise à trouver des leaders communautaires passionnés par Polkadot et SubQuery. Nous recherchons des personnes autonomes capables de faire connaître SubQuery dans leur région et de soutenir les nouveaux développeurs qui souhaitent utiliser SubQuery pour créer des applications et des services étonnants sur Polkadot. + +### Avantages pour les ambassadeurs + +Chez SubQuery, nous travaillons dur pour réaliser ce que nous faisons. De même, les ambassadeurs doivent consacrer un peu de temps lorsqu'ils rejoignent notre équipe, mais ils seront récompensés par des avantages. + +**Financement et soutien:** Vous pouvez être récompensé pour un bon travail avec des opportunités précoces de ventes privées et de primes. En outre, nous fournirons des subventions pour vous permettre d'organiser des rencontres communautaires. + +**Accès à l'équipe SubQuery:** Vous aurez un accès direct au noyau de l'équipe SubQuery avec des possibilités de formation pratique, des AMA exclusifs avec nos dirigeants et développeurs, et un aperçu de notre feuille de route. + +**Développement du réseau :** Attendez-vous à développer votre réseau professionnel en étant ambassadeur de l'un des principaux projets Polkadot. Rencontrez d'autres ambassadeurs dans le monde entier et recevez des présentations de projets Polkadot locaux que nous devons soutenir localement. Vous pourriez même obtenir une entrée gratuite pour représenter SubQuery lors d'événements dans votre région. + +**Cadeaux et autres choses gratuits :** Tout le monde aime les choses gratuits ! Recevez une allocation annuelle de cadeaux SubQuery qui vous permettront de vous distinguer dans la foule. Plus une allocation supplémentaire que vous pouvez partager lors d'événements communautaires. Vous recevrez également un NFT exclusif pour votre statut d'ambassadeur. + +## Comment cela fonctionne + +Notre programme Ambassadeur comporte plusieurs niveaux, chaque niveau offrant des avantages et des possibilités différents. Vous pouvez gravir les échelons en participant aux activités des ambassadeurs et en travaillant dur pour nous. + +Une fois que vous aurez envoyé votre candidature, nous sélectionnerons les candidats qui correspondent à nos valeurs. Si vous êtes sélectionné, vous serez placé dans notre programme de formation et recevrez un dossier d'information qui vous permettra de mieux comprendre SubQuery. Ensuite, vous pouvez commencer à travailler dans le cadre du programme de formation en accomplissant certaines tâches d'accueil (par exemple, la création d'un projet de SubQuery). Nous organiserons des ateliers tout au long de ce processus pour vous soutenir. + +Une fois que vous aurez réussi le programme de formation, vous pourrez vous considérer comme un ambassadeur de SubQuery et serez accepté dans notre programme complet. À partir de là, vous pouvez continuer à travailler dans le cadre du programme et gravir les échelons, en obtenant davantage de récompenses et d'avantages à mesure que vous gravissez les échelons. + +## Activités des ambassadeurs + +SubQuery Ambassadors are able to contribute through four main areas, including event management, content creation, translation, and community moderation. You can participate in as many areas as you want, you’re not bound to any single one. + +**Event Management:** Build local communities by hosting, organising, and managing different events. Building a local community will be a key part of growing the SubQuery community. SubQuery will support you by providing funding for events, sending swag/merchandise to be given away, as well as attending Q&As or online events as speakers or in AMA sessions. + +**Content Creation:** We have a long list of content and support material that we need help creating. Remember, our success relies on the ability of our customers to build amazing things on our service, so we need your help to make that easier. Content includes videos, infographics, tutorials, animations, or any other related material, to inform, educate, or inspire community members within the SubQuery Ecosystem. SubQuery will support Content Creators by providing branding assets and expertise. We’ll also use SubQuery’s marketing channels to increase awareness of your content (and yourself). + +**Translation:** Our customers don’t just speak English! We need your help making SubQuery more accessible by translating our content into your own language, as well as helping sharing the word to our international community. + +**Community Moderation:** Moderators will help grow the SubQuery community by ensuring that official community channels are active and engaging. SubQuery will support Moderators by promoting the channels that they monitor, as well as provide guidelines for our expectations. + +[Postulez maintenant !](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/fr/miscellaneous/branding.md b/docs/fr/miscellaneous/branding.md new file mode 100644 index 00000000000..fb114b22f2f --- /dev/null +++ b/docs/fr/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Matériel d'image de marque + +**Toutes les caractéristiques de la marque SubQuery sont exclusives et nous prenons notre marque très au sérieux.** + +Si vous décidez d'utiliser des marques, des logos, des dessins ou d'autres caractéristiques de la marque, veuillez suivre attentivement les directives énoncées ici ou nous contacter via les médias sociaux pour obtenir des précisions. + +En cas de doute, n'hésitez pas à demander ! + +## Paquet d'actifs de marque + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/fr/miscellaneous/contributing.md b/docs/fr/miscellaneous/contributing.md new file mode 100644 index 00000000000..c6f016c53bf --- /dev/null +++ b/docs/fr/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Contribuer à SubQuery + +Bienvenue et un grand merci d'avoir envisagé de contribuer à ce projet SubQuery ! Ensemble, nous pouvons ouvrir la voie à un avenir plus décentralisé. + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Code de conduite + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Pour commencer + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Recherchez les numéros d'Issues et de PRs existants avant de créer les vôtres. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Une mention amicale @ dans le fil de commentaires à l'auteur de la proposition ou à un contributeur peut aider à attirer l'attention si votre problème est bloquant. + +## Comment contribuer + +### Rapporter des bugs + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Utilisez un titre clair et descriptif de la question pour identifier le problème. +- Décrivez les étapes exactes pour reproduire le problème. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Incluez des captures d'écran si possible. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Soumettre des Pull Requests + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## Conventions de codage + +### Messages de commit Git + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### Guide de style JavaScript + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/fr/miscellaneous/social_media.md b/docs/fr/miscellaneous/social_media.md new file mode 100644 index 00000000000..17644b27339 --- /dev/null +++ b/docs/fr/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Liens vers les réseaux sociaux + +SubQuery est un projet actif qui entretient et communique avec ses adeptes par le biais de nombreux canaux de réseaux sociaux. + +Notre objectif est de toujours écouter et de nous engager auprès de notre fidèle communauté, alors n'hésitez pas à participer à la conversation et à nous envoyer vos idées ou vos questions ! + +## Communautés officielles de SubQuery + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Communauté principal avec des canaux de support technique dédiés) +- [Medium](https://subquery.medium.com) (canal d'annonces principales) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (Channel d'annonce uniquement) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Communautés non officielles de SubQuery + +Ces communautés ne sont pas modérées par l'équipe SubQuery, mais nos ambassadeurs peuvent y être présents pour apporter leur soutien. Veuillez faire attention aux escroqueries car SubQuery n'est **pas** responsable de ce qui s'y passe. + +- [Telegram (Chinois)](https://t.me/subquerychina) +- [Telegram (Russe)](https://t.me/SubQuery_russia) +- [Telegram (Espagnol)](https://t.me/SubQueryES) +- [Telegram (Thaïlandais)](https://t.me/subquerynetworkthai) +- [Telegram (Turc)](https://t.me/subquery_TR) +- [Telegram (Vietnamien)](https://t.me/subqueryvietnam) +- [Telegram (Annonce en Vietnamien)](https://t.me/subqueryannvn) diff --git a/docs/fr/miscellaneous/vulnerability-reporting.md b/docs/fr/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/fr/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/fr/subquery_network/2024.md b/docs/fr/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/fr/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/fr/subquery_network/about.md b/docs/fr/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/fr/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/fr/subquery_network/community.md b/docs/fr/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/fr/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/fr/subquery_network/fair-use.md b/docs/fr/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/fr/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/fr/subquery_network/faq.md b/docs/fr/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/fr/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/fr/subquery_network/glossary.md b/docs/fr/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/fr/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/fr/subquery_network/infra-changes.md b/docs/fr/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/fr/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/fr/subquery_network/parameters.md b/docs/fr/subquery_network/parameters.md new file mode 100644 index 00000000000..07eff2e49b6 --- /dev/null +++ b/docs/fr/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Description | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/fr/subquery_network/welcome.md b/docs/fr/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/fr/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/id/README.md b/docs/id/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/id/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/id/miscellaneous/ambassadors.md b/docs/id/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..e4a61d88546 --- /dev/null +++ b/docs/id/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Program Ambassador + +![Gambar Spanduk Ambassador](/assets/img/ambassador_banner.png) + +Kami memahami bahwa salah satu kekuatan terbesar kami adalah komunitas kami, dan dengan bantuan Anda, kami ingin mengembangkan dan membentuk ambassador lokal untuk komunitas di seluruh dunia. + +[Daftar Sekarang!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## Apa yang Kami Yakini + +Tim kami bersatu dengan visi bersama untuk membangun yayasan layanan data yang fleksibel dan inklusif untuk ekosistem Polkadot. + +**Dibangun oleh pengembang, untuk pengembang:** SubQuery adalah komunitas yang sedang berkembang yang fokus pada penyediaan produk dan layanan terbaik untuk pengembang kami, dan pembangun di ekosistem kami. SubQuery hanya berhasil jika ekosistem Polkadot berhasil, dan semua yang kami lakukan adalah mempertimbangkan pelanggan kami. + +**Integritas dan Akuntabilitas:** Kami memiliki anggota tim di Auckland, Shanghai, dan Sydney sehingga pekerjaan jarak jauh penting bagi kami. Kami berharap tim kami diberdayakan dan bekerja sama secara mandiri untuk mencapai tujuan kami. Persyaratan utama untuk ini adalah agar tim kami bertanggung jawab atas tindakan mereka dan menjaga integritas mereka. + +**Dukungan dan Bimbingan Inklusif:** Blockchain itu sulit, dan setiap orang terkadang membutuhkan bantuan. Tidak ada pertanyaan bodoh di komunitas kami dan semua orang di tim kami diharapkan membantu mendukung pengguna kami. Kami mempelajari beberapa wawasan paling berharga tentang layanan kami (dan bagaimana kami dapat meningkatkannya) langsung dari komunitas kami. + +## Program Ambassador Kami + +Program Ambassador SubQuery kami bertujuan untuk menemukan pemimpin komunitas yang tertarik tentang Polkadot dan SubQuery. Kami mencari para pemula yang dapat menyebarkan berita tentang SubQuery di area lokal mereka dan menyediakan dukungan kepada pengembang baru yang ingin menggunakan SubQuery untuk membuat aplikasi dan layanan yang luar biasa di Polkadot. + +### Keuntungan Ambassador + +Di SubQuery, kami bekerja keras untuk mencapai apa yang kami lakukan. Demikian juga, para Ambassador diharapkan untuk meluangkan waktu ketika bergabung dengan tim kami tetapi akan diberi imbalan dengan keuntungan. + +**Pendanaan dan Dukungan:** Anda akan diberi imbalan untuk pekerjaan yang baik dengan peluang awal untuk penjualan dan hadiah pribadi. Selain itu, kami akan menyediakan dana untuk Anda untuk menjalankan pertemuan komunitas. + +**Akses Tim SubQuery:** Anda akan memiliki akses langsung ke tim SubQuery inti dengan peluang untuk pelatihan langsung, AMA eksklusif dengan para pemimpin dan pengembang kami, dan wawasan tentang peta jalan kami. + +**Pengembangan Jaringan:** Berharap untuk mengembangkan jaringan profesional Anda dengan menjadi Duta Besar untuk salah satu proyek Polkadot teratas. Bertemu ambassador lain di seluruh dunia dan berkenalan dengan proyek Polkadot lokal yang perlu kami dukung secara lokal. Anda bahkan mungkin bisa masuk gratis untuk mewakili SubQuery dalam acara di area lokal Anda. + +**Hadiah dan barang gratis lainnya:** Semua orang suka barang gratis! Menerima alokasi tahunan hadiah SubQuery yang akan membuat Anda menonjol di antara orang banyak. Ditambah alokasi tambahan yang bisa Anda bagikan di acara komunitas. Anda juga akan menerima NFT eksklusif untuk status Duta Besar Anda. + +## Bagaimana cara kerjanya + +Program Ambassador kami memiliki beberapa tingkatan, setiap tingkatan memiliki keuntungan dan kemampuan yang berbeda. Anda dapat naik tingkatan dengan berpartisipasi dalam aktivitas Ambassador dan bekerja keras untuk kami. + +Setelah Anda mengirim melalui aplikasi, kami akan memilih kandidat yang sesuai dengan nilai-nilai kami. Jika terpilih, Anda ditempatkan dalam program pelatihan kami dan akan menerima paket informasi, memperluas pemahaman Anda tentang SubQuery. Setelah ini, Anda dapat mulai bekerja melalui program pelatihan dengan menyelesaikan tugas orientasi tertentu (misalnya membuat Proyek SubQuery). Kami akan menyelenggarakan lokakarya selama proses ini untuk mendukung Anda. + +Setelah Anda lulus program pelatihan, Anda dapat menyebut diri Anda sebagai duta besar SubQuery dan akan diterima dalam program penuh kami. Dari sini Anda dapat terus bekerja melalui program dan naik tingkatan, mendapatkan lebih banyak hadiah dan keuntungan saat Anda naik peringkat. + +## Aktivitas Ambassador + +Duta SubQuery dapat berkontribusi melalui empat bidang utama, termasuk manajemen acara, pembuatan konten, terjemahan, dan moderasi komunitas. Anda dapat berpartisipasi di sebanyak mungkin bidang yang Anda inginkan, Anda tidak terikat pada satu bidang saja. + +**Manajemen Acara:** Membangun komunitas lokal dengan menjadi tuan rumah, mengatur, dan mengelola berbagai acara. Membangun komunitas lokal akan menjadi bagian penting dalam menumbuhkan komunitas SubQuery. SubQuery akan mendukung Anda dengan menyediakan dana untuk acara, mengirimkan barang curian/merchandise untuk diberikan, serta menghadiri Q&As atau acara online sebagai pembicara atau dalam sesi AMA. + +**Pembuatan Konten:** Kami memiliki daftar panjang konten dan materi pendukung yang perlu kami bantu buat. Ingat, kesuksesan kami bergantung pada kemampuan pelanggan kami untuk membangun hal-hal luar biasa pada layanan kami, jadi kami membutuhkan bantuan Anda untuk membuatnya lebih mudah. Konten mencakup video, infografis, tutorial, animasi, atau materi terkait lainnya, untuk menginformasikan, mengedukasi, atau menginspirasi anggota komunitas dalam Ekosistem SubQuery. SubQuery akan mendukung Pembuat Konten dengan menyediakan aset dan keahlian branding. Kami juga akan menggunakan saluran pemasaran SubQuery untuk meningkatkan kesadaran akan konten Anda (dan diri Anda sendiri). + +**Penerjemahan:** Pelanggan kami tidak hanya berbicara bahasa Inggris! Kami membutuhkan bantuan Anda untuk membuat SubQuery lebih mudah diakses dengan menerjemahkan konten kami ke dalam bahasa Anda sendiri, serta membantu menyebarkan berita ke komunitas internasional kami. + +**Moderasi Komunitas:** Moderator akan membantu menumbuhkan komunitas SubQuery dengan memastikan bahwa saluran komunitas resmi aktif dan menarik. SubQuery akan mendukung Moderator dengan mempromosikan saluran yang mereka pantau, serta memberikan pedoman untuk harapan kami. + +[Daftar Sekarang!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/id/miscellaneous/branding.md b/docs/id/miscellaneous/branding.md new file mode 100644 index 00000000000..1a49903a6df --- /dev/null +++ b/docs/id/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Materi Merek + +**Semua fitur merek SubQuery adalah hak milik dan kami memperlakukan merek kami dengan sangat serius.** + +Jika Anda memilih untuk menggunakan merek dagang, logo, desain, atau fitur merek lainnya, harap ikuti panduan di sini dengan cermat atau hubungi kami melalui media sosial untuk klarifikasi. + +Jika ragu, silakan bertanya! + +## Paket Aset Merek + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/id/miscellaneous/contributing.md b/docs/id/miscellaneous/contributing.md new file mode 100644 index 00000000000..3dd74e99c0c --- /dev/null +++ b/docs/id/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Berkontribusi Untuk SubQuery + +Selamat datang dan terima kasih banyak telah mempertimbangkan untuk berkontribusi pada proyek SubQuery ini! Bersama-sama kita dapat membuka jalan menuju masa depan yang lebih terdesentralisasi. + +::: tip Note This documentation is actively maintained by the SubQuery team. Kami juga menerima kontribusi. Anda dapat melakukannya dengan melakukan forking proyek GitHub kami dan membuat perubahan pada semua file markdown dokumentasi di bawah direktori `docs`. ::: + +Berikut ini adalah seperangkat pedoman (bukan aturan) untuk berkontribusi pada SubQuery. Mengikuti panduan ini akan membantu kami membuat proses kontribusi menjadi mudah dan efektif untuk semua orang yang terlibat. Ini juga menyampaikan bahwa Anda setuju untuk menghormati waktu dari developer yang mengelola dan mengembangkan proyek ini. Sebagai imbalannya, kami akan membalas rasa hormat itu dengan mengatasi masalah Anda, mempertimbangkan perubahan, berkolaborasi dalam peningkatan, dan membantu Anda menyelesaikan pull request Anda. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Kode Etik + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Memulai + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Cari Issue and PR yang ada terlebih dahulu sebelum membuat milik Anda sendiri. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Sebuah @ sebutan ramah di utas komentar kepada pengirim atau kontributor dapat membantu menarik perhatian jika issue Anda terblokir. + +## Bagaimana Berkontribusi + +### Melaporkan Bug + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Gunakan judul issue yang jelas dan deskriptif untuk mengidentifikasi masalah. +- Jelaskan langkah-langkah yang akurat untuk mereproduksi masalah. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Sertakan screenshot jika memungkinkan. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Mengirimkan Pull Request + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork repositori ke akun Github Anda sendiri. +- Clone proyek ke mesin Anda. +- Buat branch secara lokal dengan nama yang ringkas namun deskriptif. +- Commit perubahan ke branch. +- Ikuti pedoman pemformatan dan testing apa pun yang khusus untuk repo ini. +- Push perubahan ke fork Anda. +- Buka sebuah PR di repositori kami. + +## Konvensi Coding + +### Pesan Git Commit + +- Gunakan bentuk waktu kini ("Tambahkan fitur" bukan "Fitur yang ditambahkan"). +- Gunakan suasana perintah ("Pindahkan kursor ke..." bukan "Memindahkan kursor ke..."). +- Batasi baris pertama hingga 72 karakter atau kurang. + +### JavaScript Styleguide + +- Semua kode JavaScript diverifikasi dengan Prettier dan ESLint. diff --git a/docs/id/miscellaneous/social_media.md b/docs/id/miscellaneous/social_media.md new file mode 100644 index 00000000000..82ea06757db --- /dev/null +++ b/docs/id/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Tautan Media Sosial + +SubQuery adalah proyek aktif yang menjaga dan berkomunikasi dengan pengikut kami melalui banyak saluran media sosial. + +Merupakan tujuan kami untuk selalu mendengarkan dan terlibat dengan komunitas setia kami, jadi silakan bergabung dalam percakapan dan kirimkan ide atau pertanyaan Anda kepada kami! + +## Komunitas SubQuery Resmi + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Komunitas Utama dengan saluran dukungan teknis khusus) +- [Medium](https://subquery.medium.com) (Saluran pengumuman utama) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (Hanya jalur pengumuman) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Komunitas SubQuery Tidak Resmi + +Komunitas ini tidak dimoderasi oleh tim SubQuery, tetapi ambassador kami mungkin ada di sana untuk memberikan dukungan. Harap berhati-hati terhadap penipuan karena SubQuery **tidak** bertanggung jawab atas apa yang terjadi di dalamnya. + +- [Telegram (Cina)](https://t.me/subquerychina) +- [Telegram (Rusia)](https://t.me/SubQuery_russia) +- [Telegram (Spanyol)](https://t.me/SubQueryES) +- [Telegram (Thailand)](https://t.me/subquerynetworkthai) +- [Telegram (Turki)](https://t.me/subquery_TR) +- [Telegram (Vietnam)](https://t.me/subqueryvietnam) +- [Telegram (Pengumuman Vietnam)](https://t.me/subqueryannvn) diff --git a/docs/id/miscellaneous/vulnerability-reporting.md b/docs/id/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/id/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/id/subquery_network/2024.md b/docs/id/subquery_network/2024.md new file mode 100644 index 00000000000..dfe086f16d3 --- /dev/null +++ b/docs/id/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. Seperti yang diuraikan dalam Whitepaper, SQT dimaksudkan untuk menjadi token yang menggerakkan Jaringan SubQuery, memberikan insentif untuk partisipasi, serta berfungsi sebagai media pertukaran untuk transaksi dalam Jaringan SubQuery. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/id/subquery_network/about.md b/docs/id/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/id/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/id/subquery_network/community.md b/docs/id/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/id/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/id/subquery_network/fair-use.md b/docs/id/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/id/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/id/subquery_network/faq.md b/docs/id/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/id/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/id/subquery_network/glossary.md b/docs/id/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/id/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/id/subquery_network/infra-changes.md b/docs/id/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/id/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/id/subquery_network/parameters.md b/docs/id/subquery_network/parameters.md new file mode 100644 index 00000000000..77c8a9715c8 --- /dev/null +++ b/docs/id/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Deskripsi | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/id/subquery_network/welcome.md b/docs/id/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/id/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/it/README.md b/docs/it/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/it/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/it/miscellaneous/ambassadors.md b/docs/it/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..de84b65a42e --- /dev/null +++ b/docs/it/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Programma Ambasciatore + +![Immagine Banner Ambassador](/assets/img/ambassador_banner.png) + +Ci rendiamo conto che uno dei nostri maggiori punti di forza è la nostra comunità, e con il vostro aiuto, vogliamo crescere e stabilire ambasciatori locali per le comunità di tutto il mondo. + +[Candidati ora!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## In cosa crediamo + +Il nostro team si è riunito con la visione condivisa di costruire le basi di un servizio dati flessibile e inclusivo per l'ecosistema Polkadot. + +**Costruito dagli sviluppatori, per gli sviluppatori:** SubQuery è una comunità in crescita che si concentra sulla fornitura dei migliori prodotti e servizi per i nostri sviluppatori e costruttori nel nostro ecosistema. SubQuery ha successo solo se l'ecosistema Polkadot ha successo, e quindi tutto quello che facciamo è con i nostri clienti in mente. + +**Integrità e responsabilità:** Abbiamo membri del team ad Auckland, Shanghai e Sydney, quindi il lavoro a distanza è importante per noi. Ci aspettiamo che il nostro team sia responsabilizzato e lavori autonomamente insieme per raggiungere i nostri obiettivi. Un requisito chiave per questo è che il nostro team sia responsabile delle proprie azioni e mantenga la propria integrità. + +**Guida e supporto inclusivi:** Blockchain è difficile, e tutti hanno bisogno di aiuto a volte. Non esistono domande stupide nella nostra comunità e ci si aspetta che tutti nel nostro team aiutino i nostri utenti. Impariamo alcune delle intuizioni più preziose sul nostro servizio (e su come possiamo migliorarlo) direttamente dalla nostra comunità. + +## Il nostro programma di ambasciatori + +Il nostro programma SubQuery Ambassador mira a trovare leader della comunità appassionati di Polkadot e SubQuery. Siamo alla ricerca di auto-iniziative che possono diffondere la parola su SubQuery nelle loro aree locali e fornire supporto ai nuovi sviluppatori che vogliono utilizzare SubQuery per costruire applicazioni e servizi incredibili su Polkadot. + +### Vantaggi dell'ambasciatore + +A SubQuery, lavoriamo duramente per ottenere ciò che facciamo. Allo stesso modo, ci si aspetta che gli ambasciatori impegnino del tempo quando si uniscono al nostro team, ma saranno ricompensati con benefici. + +**Finanziamento e supporto:** Potresti essere ricompensato per un buon lavoro con opportunità precoci di vendite private e taglie. Inoltre, forniremo sovvenzioni per finanziare i meetup della comunità. + +**Accesso al team SubQuery:** Avrai accesso diretto al team di base di SubQuery con opportunità di formazione pratica, AMA esclusivi con i nostri leader e sviluppatori, e visione della nostra roadmap. + +**Sviluppo della rete:** Aspettati di far crescere la tua rete professionale essendo un ambasciatore per uno dei principali progetti Polkadot. Incontrare altri ambasciatori in tutto il mondo e ricevere introduzioni ai progetti locali Polkadot che dobbiamo sostenere a livello locale. Potresti anche ottenere un ingresso gratuito per rappresentare SubQuery in eventi nella tua zona. + +**Swag e altre cose gratis:** A tutti piacciono le cose gratis! Ricevi un'assegnazione annuale di swag SubQuery che ti farà risaltare tra la folla. Più un'assegnazione aggiuntiva che puoi condividere in giro agli eventi della comunità. Riceverai anche un NFT esclusivo per il tuo status di Ambasciatore. + +## Come funziona + +Il nostro programma Ambasciatore ha più livelli, ogni livello ha diversi benefici e capacità. Puoi salire di livello partecipando alle attività dell'Ambasciatore e lavorando sodo per noi. + +Una volta inviata la candidatura, selezioneremo i candidati che si allineano con i nostri valori. Se sarai selezionato, sarai inserito nel nostro programma di tirocinio e riceverai un pacchetto informativo che amplierà la tua comprensione di SubQuery. Dopo questo, si può iniziare a lavorare attraverso il programma di tirocinio completando alcuni compiti di onboarding (ad esempio la creazione di un progetto SubQuery). Ospiteremo workshop durante tutto questo processo per sostenerti. + +Una volta superato il programma di tirocinio, potrai definirti un ambasciatore di SubQuery e sarai accettato nel nostro programma completo. Da qui in poi si può continuare a lavorare attraverso il programma e progredire nei livelli, guadagnando più premi e benefici man mano che si sale di livello. + +## Attività dell'ambasciatore + +SubQuery Ambassadors are able to contribute through four main areas, including event management, content creation, translation, and community moderation. You can participate in as many areas as you want, you’re not bound to any single one. + +**Event Management:** Build local communities by hosting, organising, and managing different events. Building a local community will be a key part of growing the SubQuery community. SubQuery will support you by providing funding for events, sending swag/merchandise to be given away, as well as attending Q&As or online events as speakers or in AMA sessions. + +**Content Creation:** We have a long list of content and support material that we need help creating. Remember, our success relies on the ability of our customers to build amazing things on our service, so we need your help to make that easier. Content includes videos, infographics, tutorials, animations, or any other related material, to inform, educate, or inspire community members within the SubQuery Ecosystem. SubQuery will support Content Creators by providing branding assets and expertise. We’ll also use SubQuery’s marketing channels to increase awareness of your content (and yourself). + +**Translation:** Our customers don’t just speak English! We need your help making SubQuery more accessible by translating our content into your own language, as well as helping sharing the word to our international community. + +**Community Moderation:** Moderators will help grow the SubQuery community by ensuring that official community channels are active and engaging. SubQuery will support Moderators by promoting the channels that they monitor, as well as provide guidelines for our expectations. + +[Candidati ora!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/it/miscellaneous/branding.md b/docs/it/miscellaneous/branding.md new file mode 100644 index 00000000000..00fdbf23ccd --- /dev/null +++ b/docs/it/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Materiali per il branding + +**Tutte le caratteristiche del marchio di SubQuery sono proprietarie e noi prendiamo il nostro marchio molto seriamente.** + +Se si sceglie di utilizzare qualsiasi marchio, logo, design o altre caratteristiche del marchio, si prega di seguire attentamente le linee guida qui o di contattarci tramite i social media per chiarimenti. + +Se avete dei dubbi, chiedete pure! + +## Pacchetto di risorse del marchio + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/it/miscellaneous/contributing.md b/docs/it/miscellaneous/contributing.md new file mode 100644 index 00000000000..5e92bd7d5c0 --- /dev/null +++ b/docs/it/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Contribuire alla subquery + +Benvenuto e un grande grazie per aver considerato di contribuire a questo progetto SubQuery! Insieme possiamo aprire la strada verso un futuro più decentralizzato. + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Codice di condotta + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Come iniziare + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Cerca le questioni e i PR esistenti prima di crearne uno tuo. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Un'amichevole menzione @ nel thread dei commenti al presentatore o a un collaboratore può aiutare ad attirare l'attenzione se il tuo problema è bloccante. + +## Come contribuire + +### Segnalazione di bug + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Usate un titolo chiaro e descrittivo per la questione per identificare il problema. +- Descrivete i passi esatti per riprodurre il problema. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Includi degli screenshot se possibile. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Invio di richieste di pull + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## Convenzioni di codifica + +### Messaggi di commit di Git + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### JavaScript Styleguide + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/it/miscellaneous/social_media.md b/docs/it/miscellaneous/social_media.md new file mode 100644 index 00000000000..6cab7bc93ec --- /dev/null +++ b/docs/it/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Link ai social media + +SubQuery è un progetto attivo che mantiene e comunica con i nostri seguaci attraverso molti canali di social media. + +Il nostro obiettivo è quello di ascoltare e coinvolgere sempre la nostra fedele comunità, quindi per favore unisciti alla conversazione e mandaci le tue idee o domande! + +## Comunità ufficiali di SubQuery + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Comunità primaria con canali di supporto tecnico dedicati) +- [Medium](https://subquery.medium.com) (canale degli annunci primari) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (solo canale annunci) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Comunità non ufficiali di SubQuery + +Queste comunità non sono moderate dal team di SubQuery, ma i nostri ambasciatori possono essere presenti per fornire supporto. Fai attenzione alle truffe poiché SubQuery **non** è responsabile di ciò che accade al loro interno. + +- [Telegram (Cinese)](https://t.me/subquerychina) +- [Telegram (Russo)](https://t.me/SubQuery_russia) +- [Telegram (Spagnolo)](https://t.me/SubQueryES) +- [Telegram (Tailandese)](https://t.me/subquerynetworkthai) +- [Telegram (Turco)](https://t.me/subquery_TR) +- [Telegram (Vietnamita)](https://t.me/subqueryvietnam) +- [Telegram (Annuncio Vietnamita)](https://t.me/subqueryannvn) diff --git a/docs/it/miscellaneous/vulnerability-reporting.md b/docs/it/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/it/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/it/subquery_network/2024.md b/docs/it/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/it/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/it/subquery_network/about.md b/docs/it/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/it/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/it/subquery_network/community.md b/docs/it/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/it/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/it/subquery_network/fair-use.md b/docs/it/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/it/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/it/subquery_network/faq.md b/docs/it/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/it/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/it/subquery_network/glossary.md b/docs/it/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/it/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/it/subquery_network/infra-changes.md b/docs/it/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/it/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/it/subquery_network/parameters.md b/docs/it/subquery_network/parameters.md new file mode 100644 index 00000000000..3c6f545f969 --- /dev/null +++ b/docs/it/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Descrizione | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/it/subquery_network/welcome.md b/docs/it/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/it/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/ja/README.md b/docs/ja/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/ja/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/ja/miscellaneous/ambassadors.md b/docs/ja/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..6682a8f98da --- /dev/null +++ b/docs/ja/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# アンバサダープログラム + +![Ambassador Banner Image](/assets/img/ambassador_banner.png) + +私たちは、私たちの最大の強みの一つがコミュニティであることを理解しており、皆さんの力を借りて、世界中のコミュニティのローカルアンバサダーを育成・確立していきたいと考えています。 + +[今すぐ申し込む](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## 私たちが信じるもの + +私たちのチームは、Polkadotのエコシステムのために、柔軟で包括的なデータサービスの基盤を構築するという共通のビジョンを持って集まりました。 + +**開発者による開発者のためのコミュニティ：** SubQueryは、開発者とエコシステムの構築者のために最高の製品とサービスを提供することに重点を置いた成長中のコミュニティです。 SubQuery は Polkadot エコシステムが成功した場合にのみ成功し、すべてがユーザを念頭に置いています。 + +**誠実さと責任感:**オークランド、上海、シドニーにチームメンバーがいるため、リモートワークも重要視しています。 私たちのチームが力を与えられ、目標を達成するために自律的に協力することを期待しています。 そのためには、私たちのチームが自らの行動に責任を持ち、誠実さを維持することが重要な要件となります。 + +**包括的なガイダンスとサポート：** ブロックチェーンは難しく、誰もが時々助けを必要とします。 私たちのコミュニティにはくだらない質問などありませんし、チームの全員がユーザをサポートすることを期待されています。 私たちは、私たちのサービスに関する最も貴重な洞察（およびそれをどのように改善できるか）を、コミュニティから直接学んでいます。 + +## アンバサダープログラム + +SubQuery アンバサダープログラムは、Polkadot と SubQuery に情熱的なコミュニティリーダーを見つけることを目指しています。 各コミュニティでSubQueryを広め、SubQueryを使ってPolkadotに素晴らしいアプリやサービスを作りたいと考えている新しい開発者を自律的にサポートできるメンバーを求めています。 + +### アンバサダー特典 + +SubQueryでは、私たちがやっていることを達成するために懸命に取り組んでいます。 同様に、アンバサダーはチームに参加する際にある程度の時間を割くことが求められますが、その分、特典を受けることができます。 + +**資金調達とサポート：** 早期の個人販売と報奨金に対する良い仕事に対して報酬を受け取ることができます。 さらに、コミュニティミートアップを運営するための資金助成も行っていきます。 + +**SubQueryチームへのアクセス：** SubQueryのコアチームへ直接アクセスでき、ハンズオントレーニング、リーダーや開発者との独占AMA、ロードマップの洞察などの機会が得られます。 + +**ネットワーク展開：** Polkadotのトッププロジェクトのアンバサダーになることで、プロフェッショナルなネットワークが広がることを期待します。 世界中の他のアンバサダーと出会い、現地でサポートが必要なPolkadotプロジェクトの紹介を受けることができます。 ローカルエリアのイベントでSubQueryを表現するための無料のエントリを取得することもできます。 + +**スワッグなどの無料アイテム：** 誰でも無料アイテムは好きですよね。 群衆の中で目立つような SubQuery スワッグ の年間割り当てを受け取りましょう。 さらに、コミュニティイベントで共有できる追加の割り当てがあります。 アンバサダーのステータスとして専用の NFT を受け取ることもできます。 + +## 仕組みについて + +アンバサダープログラムには複数のランクがあり、ランクごとに異なる特典と機能があります。 アンバサダーの活動に参加し、私たちのために頑張ってください。 + +ご応募いただいた後、私たちの価値観に合致する候補者を選考させていただきます。 採用されると、SubQueryの理解を深めるためのインフォメーションパッケージが提供され、研修生プログラムに参加することができます。 この後、特定のオンボーディングタスク（SubQuery Projectの作成など）を完了することで、研修生プログラムを開始することができます。 このプロセスを通じてワークショップを開催し、皆様を支援します。 + +研修生プログラムに合格すると、SubQueryアンバサダーを名乗ることができ、正式なプログラムへの参加も認められます。 ここから先はプログラムを継続し、ランクアップしていくことで、より多くの報酬や特典を得ることができます。 + +## アンバサダーの活動 + +SubQuery Ambassadors are able to contribute through four main areas, including event management, content creation, translation, and community moderation. You can participate in as many areas as you want, you’re not bound to any single one. + +**Event Management:** Build local communities by hosting, organising, and managing different events. Building a local community will be a key part of growing the SubQuery community. SubQuery will support you by providing funding for events, sending swag/merchandise to be given away, as well as attending Q&As or online events as speakers or in AMA sessions. + +**Content Creation:** We have a long list of content and support material that we need help creating. Remember, our success relies on the ability of our customers to build amazing things on our service, so we need your help to make that easier. Content includes videos, infographics, tutorials, animations, or any other related material, to inform, educate, or inspire community members within the SubQuery Ecosystem. SubQuery will support Content Creators by providing branding assets and expertise. We’ll also use SubQuery’s marketing channels to increase awareness of your content (and yourself). + +**Translation:** Our customers don’t just speak English! We need your help making SubQuery more accessible by translating our content into your own language, as well as helping sharing the word to our international community. + +**Community Moderation:** Moderators will help grow the SubQuery community by ensuring that official community channels are active and engaging. SubQuery will support Moderators by promoting the channels that they monitor, as well as provide guidelines for our expectations. + +[今すぐ申し込む](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/ja/miscellaneous/branding.md b/docs/ja/miscellaneous/branding.md new file mode 100644 index 00000000000..f0398c82411 --- /dev/null +++ b/docs/ja/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# ブランディング素材 + +**SubQueryのブランド素材はすべて独自のものであり、私たちはブランドを極めて重要視しています。** + +商標、ロゴ、デザイン、その他のブランドの特徴を使用する場合は、このガイドラインに注意深く従うか、ソーシャルメディアを通じて私たちに連絡して明確にしてください。 + +疑問がある場合は、お問い合わせください！ + +## ブランド素材パッケージ + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/ja/miscellaneous/contributing.md b/docs/ja/miscellaneous/contributing.md new file mode 100644 index 00000000000..1e2a92fdf07 --- /dev/null +++ b/docs/ja/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# SubQueryへの貢献 + +このSubQueryプロジェクトへの貢献をご検討いただき、誠にありがとうございます！ 私たちは共に、より分散化された未来への道を切り開くことができます。 + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## 行動規範 + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## はじめに + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- 自分で作成する前に、既存のIssuesやPRを検索してください。 +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. あなたの問題がブロックされている場合、コメントスレッドで投稿者や投稿者に友好的に@で言及することで、注意を引くことができます。 + +## 貢献方法 + +### バグ報告 + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- 問題を特定するために、明確で説明的なタイトルを使用します。 +- 問題を再現するための正確なステップを記述します。 +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- 可能であればスクリーンショットを含めます。 + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### プルリクエストを送る + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## コーディング規約 + +### コミットメッセージ + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### JavaScript Styleguide + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/ja/miscellaneous/social_media.md b/docs/ja/miscellaneous/social_media.md new file mode 100644 index 00000000000..d8b56263cee --- /dev/null +++ b/docs/ja/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# ソーシャル メディアリンク + +SubQueryは、多くのソーシャルメディアチャンネルを通じてフォロワーを維持し、コミュニケーションのアクティブなプロジェクトです。 + +私たちの目標は、常に忠実なコミュニティの声に耳を傾け、それに応えることです。 + +## 公式SubQueryコミュニティ + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery)(専用のテクニカルサポートチャンネルを持つプライマリーコミュニティ) +- [Medium](https://subquery.medium.com) (プライマリー・アナウンスチャネル) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (アナウンスチャネルのみ) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## 非公式SubQueryコミュニティ + +これらのコミュニティはSubQueryチームの管理下にはありませんが、アンバサダーがサポートしてくれる場合があります。 SubQueryはその中で起こることに**責任を負わない**ので、詐欺にはご注意ください。 + +- [Telegram (中国語)](https://t.me/subquerychina) +- [Telegram (ロシア語)](https://t.me/SubQuery_russia) +- [Telegram (スペイン語)](https://t.me/SubQueryES) +- [Telegram (タイ語)](https://t.me/subquerynetworkthai) +- [Telegram (トルコ語)](https://t.me/subquery_TR) +- [Telegram (ベトナム語)](https://t.me/subqueryvietnam) +- [Telegram (ベトナム語アナウンス)](https://t.me/subqueryannvn) diff --git a/docs/ja/miscellaneous/vulnerability-reporting.md b/docs/ja/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/ja/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/ja/subquery_network/2024.md b/docs/ja/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/ja/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/ja/subquery_network/about.md b/docs/ja/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/ja/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/ja/subquery_network/community.md b/docs/ja/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/ja/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/ja/subquery_network/fair-use.md b/docs/ja/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/ja/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/ja/subquery_network/faq.md b/docs/ja/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/ja/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/ja/subquery_network/glossary.md b/docs/ja/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/ja/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/ja/subquery_network/infra-changes.md b/docs/ja/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/ja/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/ja/subquery_network/parameters.md b/docs/ja/subquery_network/parameters.md new file mode 100644 index 00000000000..5239c195206 --- /dev/null +++ b/docs/ja/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | 説明 | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/ja/subquery_network/welcome.md b/docs/ja/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/ja/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/ko/README.md b/docs/ko/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/ko/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/ko/miscellaneous/ambassadors.md b/docs/ko/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..13d98c57085 --- /dev/null +++ b/docs/ko/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# 앰버서더 프로그램 + +![앰배서더 배너 이미지](/assets/img/ambassador_banner.png) + +우리의 가장 큰 강점은 우리 커뮤니티라는 점을 이해하고 있으며, 전 세계 커뮤니티를 위한 로컬 앰버서더를 양성하고자 합니다. + +[지금 신청하세요!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## 우리의 믿음 + +우리 팀은 Polkadot 생태계를 위한 유연하고 포괄적인 데이터 서비스의 기반 구축이라는 공통된 비전을 가지고 함께 해나가고 있습니다. + +**개발자에 의한, 개발자를 위한 구축:** SubQuery는 개발자와 생태계의 빌더에게 최고의 제품 및 서비스 제공에 중점을 두고 성장하는 커뮤니티입니다. 서브쿼리는 폴카닷 생태계의 성패를 따르기 때문에 우리는 모든 일에서 고객을 염두에 두고 있습니다. + +**Integrity and Accountability:** 우리팀은 오클랜드, 상하이, 그리고 시드니에 위치하고 있기 때문에 원격 업무수행이 중요합니다. 우리는 활력적, 자율적으로 협력해 목표를 달성하기를 기대합니다. 이를 위한 중요한 요건은 저희 팀이 그들의 행동에 책임을 지고 그들의 성실함을 유지하는 것입니다. + +**Inclusive Guidance and Support:** 블록체인은 어렵고 누구나 때로는 도움을 필요로 합니다. 우리 커뮤니티에서 멍청한 질문이라는 건 없습니다. 저희 팀 모두는 저희 사용자를 서포트하기를 기대하고 있습니다. 저희는 저희의 서비스에 대한 가장 가치 있는 통찰력(그리고 저희가 그것을 어떻게 개선할 수 있는가) 을 커뮤니티로부터 직접 배웁니다. + +## 앰배서더 프로그램 + +서브쿼리 앰버서더 프로그램은 폴카닷과 서브쿼리에 열정이 있는 커뮤니티 리더를 발굴하는 것이 목표입니다. 저희는 각 지역에서 서브쿼리에 대한 정보를 알리거나 서브쿼리를 이용해 폴카닷 상에 멋진 앱과 서비스를 구축하길 원하는 새로운 개발자들을 지원할 자원자를 찾고 있습니다. + +### 앰배서더 혜택 + +서브 쿼리에서 저희는 저희의 일을 달성하기 위해 노력할 것입니다. 마찬가지로 앰배사더들은 저희 팀에 합류할 때 일정한 시간을 할애할 것으로 예상되지만 혜택을 받을 수 있습니다. + +**Funding and Support:** 앰배서더로서 좋은 활동을 한다면 프라이빗 세일과 바운티 등을 보상받을 수 있습니다. 또한 저희는 여러분이 커뮤니티 밋업을 운영할 수 있도록 기금을 제공합니다. + +**SubQuery Team Access:**실천적인 훈련, 리더 및 개발자와의 독점적인 AMA 및 로드맵의 통찰력을 갖춘 코어 서브쿼리 팀에 직접 액세스 할 수 있습니다. + +**Network Development:** 폴카닷 탑 프로젝트 중의 하나인 서브쿼리의 앰배서더를 맡음으로써, 여러분의 전문적인 네트워크가 성장하는 것을 기대하세요. 전 세계 다른 앰배서더들을 만나고 현지에서 지원이 필요한 현지 폴카닷 프로젝트를 소개받으세요. 여러분의 지역 이벤트에서 서브쿼리를 대표함으로써 무료 엔트리를 얻을 수도 있습니다. + +**Swag and other free stuff:** 누구나 무료를 좋아합니다! 서브쿼리 스웨그를 연간 할당받아 여러 사람들 속에서 돋보일 수 있습니다. 게다가 커뮤니티 이벤트에서 공유할 수 있는 추가 할당이 있습니다. 또한 앰배서더 지위에 대한 독점 NFT도 받습니다. + +## 어떻게 해야 되나요? + +앰배서더 프로그램은 여러 티어로 구성되어 있고, 각 티어는 다른 혜택과 역할이 있습니다. 앰버서더로서 서브쿼리를 위해 열심히 활동함으로써, 더 높은 티어에 오를 수 있습니다. + +신청서를 보낸 후에, 저희는 저희의 가치에 맞는 후보자를 선택할 것입니다. 만약 선택이 되면 트레이닝 프로그램에 등록되어 정보패키지를 받게 되며 서브쿼리에 대한 이해를 넓힐 수 있을 것입니다. 그런 다음 특정 온보드 태스크(예를 들어 서브 쿼리 프로젝트생성)를 완료함으로써 연수생 프로그램 작업을 시작할 수 있습니다. 저희는 여러분을 지원하기 위해 이 과정을 통해 워크숍을 개최할 것입니다. + +훈련생 프로그램을 통과하면, 서브쿼리 앰배서더라는 이름으로 저희의 전체 프로그램에 참여할 수 있습니다. 여기서부터 여러분은 프로그램을 지속적으로 진행하여 단계적으로 발전하고 귀하가 승진함에 따라 더 많은 보상과 이익을 얻을 수 있습니다. + +## 앰배서더 활동 + +SubQuery 대사는 이벤트 관리, 콘텐츠 생성, 번역 및 커뮤니티 조정을 포함한 네 가지 주요 영역을 통해 기여할 수 있습니다. 원하는 만큼 많은 영역에 참여할 수 있으며 어느 하나의 영역에만 국한되지는 않습니다. + +**이벤트 관리:** 다양한 이벤트를 주최, 조직, 관리하여 지역 커뮤니티를 구축하세요. 지역 커뮤니티를 구축하는 것은 SubQuery 커뮤니티 성장의 핵심 부분이 될 것입니다. SubQuery는 이벤트에 자금을 제공하고 선물/상품을 보내며 참석할 수 있도록 지원합니다 Q&As 또는 연사 또는 AMA 세션의 온라인 이벤트. + +**콘텐츠 제작:** 우리는 제작에 도움이 필요한 콘텐츠와 지원 자료의 목록을 많이 보유하고 있습니다. 우리의 성공은 우리 서비스에 놀라운 기능을 구축하는 고객의 능력에 달려 있으므로 이를 더 쉽게 만들려면 여러분의 도움이 필요합니다. 콘텐츠에는 SubQuery 생태계 내의 커뮤니티 구성원에게 정보를 제공하고, 교육하고, 영감을 주기 위한 비디오, 인포그래픽, 튜토리얼, 애니메이션 또는 기타 관련 자료가 포함됩니다. SubQuery는 브랜딩 자산과 전문 지식을 제공하여 콘텐츠 제작자를 지원합니다. 또한 SubQuery의 마케팅 채널을 사용하여 귀하의 콘텐츠(및 귀하 자신) 에 대한 인지도를 높일 것입니다. + +**번역:** 우리 고객은 영어만 구사하는 것이 아닙니다! 우리 콘텐츠를 귀하의 언어로 번역하고 국제 커뮤니티에 해당 내용을 공유함으로써 SubQuery에 대한 접근성을 높이는 데 도움이 필요합니다. + +**커뮤니티 조정:** 중재자는 공식 커뮤니티 채널이 활성화되고 참여하도록 보장하여 SubQuery 커뮤니티를 성장시키는 데 도움을 줍니다. SubQuery는 모니터링하는 채널을 홍보하여 중재자를 지원하고 기대치에 대한 지침을 제공합니다. + +[지금 신청하세요!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/ko/miscellaneous/branding.md b/docs/ko/miscellaneous/branding.md new file mode 100644 index 00000000000..c0def565505 --- /dev/null +++ b/docs/ko/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# 브랜딩 자료 + +**SubQuery의 브랜드 관련된 모든 것들은 상표 등록이 되어 있으며 우리는 우리 브랜드를 매우 중요하게 생각합니다.** + +만약 상표, 로고, 디자인 또는 기타 브랜드 기능을 사용하고자 한다면, 지침을 주의 깊게 따르거나 소셜 미디어를 통해 당사에 연락하시길 바랍니다. + +의문점이 있다면, 물어보십시오! + +## 브랜드 자산 패키지 + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/ko/miscellaneous/contributing.md b/docs/ko/miscellaneous/contributing.md new file mode 100644 index 00000000000..349f1979449 --- /dev/null +++ b/docs/ko/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# SubQuery에 기여하기 + +SubQuery 프로젝트에 도움을 주는 여러분을 환영하고 깊은 감사의 말씀을 드립니다. 우리는 함께 보다 탈중화 미래를 위한 길을 마련할 수 있습니다. + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## 운영 규칙 + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## 시작하기 + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- 본인의 것을 만들기 전에 기존의 Issues 및 PRs를 검색하십시오. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. 당신의 문제가 막힌 경우, 댓글로 친절하게 @로 제출자 혹은 기여자를 언급하면 보다 쉽게 관심을 끌 수 있습니다. + +## 기여 방법 + +### 버그 신고 + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- 문제를 식별하기 위해 문제에 대해 명확하고 자세한 제목을 사용합니다. +- 문제를 재현 확인하기 위한 정확한 단계를 설명합니다. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- 가능하다면, 스크린샷을 첨부하세요. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Pull Requests 제출 + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## 코딩 규칙 + +### Git 커밋 메시지 + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### 자바스크립트 스타일 지침 + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/ko/miscellaneous/social_media.md b/docs/ko/miscellaneous/social_media.md new file mode 100644 index 00000000000..c01d557b1d6 --- /dev/null +++ b/docs/ko/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# 소셜 미디어 링크 + +SubQuery는 다양한 소셜 미디어 채널을 통해 팔로워들과 소통하고 유지하는 활발한 프로젝트입니다. + +항상 커뮤니티에 귀를 기울이고 참여하는 것을 목표로 하며, 커뮤니티에 참여하여 아이디어 또는 질문을 보내주세요! + +## 공식 SubQuery 커뮤니티 + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (집중 기술 지원 채널이 있는 기본 커뮤니티) +- [Medium](https://subquery.medium.com) (기본 공지 채널) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (공식 발표 채널만) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## 비공식 SubQuery 커뮤니티 + +이러한 커뮤니티는 SubQuery 팀에서 관여하지 않지만, 우리의 앰버서더들이 지원할 수 있습니다. SubQuery는 그 안에서 일어나는 일에 대해 책임이 **없으므로** 스캠에 주의하십시오. + +- [Telegram (중국)](https://t.me/subquerychina) +- [Telegram (러시아)](https://t.me/SubQuery_russia) +- [Telegram (스페인)](https://t.me/SubQueryES) +- [Telegram (태국)](https://t.me/subquerynetworkthai) +- [Telegram (터키)](https://t.me/subquery_TR) +- [Telegram (베트남)](https://t.me/subqueryvietnam) +- [Telegram (베트남 공지)](https://t.me/subqueryannvn) diff --git a/docs/ko/miscellaneous/vulnerability-reporting.md b/docs/ko/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/ko/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/ko/subquery_network/2024.md b/docs/ko/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/ko/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/ko/subquery_network/about.md b/docs/ko/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/ko/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/ko/subquery_network/community.md b/docs/ko/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/ko/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/ko/subquery_network/fair-use.md b/docs/ko/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/ko/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/ko/subquery_network/faq.md b/docs/ko/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/ko/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/ko/subquery_network/glossary.md b/docs/ko/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/ko/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/ko/subquery_network/infra-changes.md b/docs/ko/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/ko/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/ko/subquery_network/parameters.md b/docs/ko/subquery_network/parameters.md new file mode 100644 index 00000000000..5ce76d3ed76 --- /dev/null +++ b/docs/ko/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | 설명 | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/ko/subquery_network/welcome.md b/docs/ko/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/ko/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/ru/README.md b/docs/ru/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/ru/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/ru/miscellaneous/ambassadors.md b/docs/ru/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..b6bdd18729a --- /dev/null +++ b/docs/ru/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Программа амбассадоров + +![Изображение амбассадора](/assets/img/ambassador_banner.png) + +Мы понимаем, что одна из наших самых сильных сторон - это наше сообщество, и с вашей помощью мы хотим расти и создавать в каждой стране амбассадоров для сообществ по всему миру. + +[Подай заявку прямо сейчас!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## То, во что мы верим + +Наша команда SubQuery вместе с командой Polkadot пришла к единым взглядам на создание основ гибкого и инклюзивного сервиса данных для экосистемы Polkadot. + +**Создано разработчиками, для разработчиков:** SubQuery - это растущее сообщество, которое фокусируется на предоставлении лучших продуктов и услуг для наших разработчиков и строителей в нашей экосистеме. SubQuery будет успешным только в том случае, если будет успешной экосистема Polkadot, поэтому все, что мы делаем, мы делаем с учетом интересов наших клиентов. + +**Целостность и подотчетность:** Наши сотрудники работают в Окленде, Шанхае и Сиднее, поэтому удаленная работа очень важна для нас. Мы ожидаем, что наша команда наделена всеми необходимыми полномочиями и работает автономно вместе для достижения наших целей. Ключевым требованием для этого является ответственность нашей команды за свои действия и сохранение честности. + +**Общее руководство и поддержка:**Блокчейн - это не просто, и всем иногда нужна помощь в понимании данных процессов. В нашем сообществе нет такого понятия, как глупый вопрос, и каждый в нашей команде должен помогать нашим пользователям. Некоторые из самых ценных сведений о нашем сервисе (и о том, как мы можем его улучшить) мы получаем непосредственно от нашего сообщества. + +## Программа амбассадоров SubQuery + +Наша амбассадорская программа SubQuery направлена на поиск лидеров в каждой стране, увлеченных экосистемой Polkadot и непосредственно нашим проектом SubQuery. Мы ищем людей, которые могут распространять информацию о SubQuery в своих регионах и оказывать поддержку новым разработчикам, которые хотят использовать SubQuery для создания удивительных приложений и сервисов на Polkadot. + +### Ценность стать амбассадором проекта SubQuery + +В компании SubQuery мы много работаем, чтобы добиться того, что мы делаем. Поэтому от амбассадоров ожидается, что, присоединившись к нашей команде, они будут уделять время развитию нашего проекта, и будут вознаграждены за это. + +**Финансирование и поддержка:** Вы можете быть вознаграждены за хорошую работу возможностью участия продажи токенов на этапе Ico, а также получить различные награды от проекта. Кроме того, мы будем предоставлять вам гранты на проведение встреч сообщества. + +** Доступ к команде SubQuery:** У вас будет прямой доступ к основной команде SubQuery с возможностью практического обучения, эксклюзивных AMA с нашими лидерами и разработчиками, а также ознакомления с нашей дорожной картой. + +** Образование:** Вас ожидает профессиональный рост как амбассадора одного из лучших проектов Polkadot. Познакомьтесь с амбассадорами других стран и получите информацию о проектах Polkadot в любой стране, которые мы должны поддерживать на местах. Вы даже можете получить бесплатный вход, чтобы представлять SubQuery на мероприятиях в вашем регионе. + +**Дополнительные вознаграждения:** Все любят бесплатные вещи! Получайте годовое распределение сувенирной продукции SubQuery, которая выделит вас из толпы. Также вам могут присвоить определенные назначения (роли в проекте), которыми вы можете поделиться на общественных мероприятиях. Вы также получите эксклюзивный NFT за статус амбассадора проекта. + +## Как работает амбассадорская программа + +Наша программа "Амбассадор" имеет несколько уровней, каждый из которых имеет свои преимущества и возможности. Вы можете продвигаться по уровням вверх, участвуя в различной деятельности амбассадора. + +После того, как вы отправите заявку, мы отберем кандидатов, которые соответствуют нашим ценностям. Если вы будете выбраны, то попадете в нашу программу стажировки и получите всю необходимую информацию о SubQuery. После этого вы можете начать работать по программе "Стажер", выполнив определенные задания (например, создание проекта SubQuery). В течение всего этого процесса мы будем проводить семинары, чтобы поддержать вас. + +После прохождения программы "Стажер" вы можете называть себя амбассадором SubQuery и будете приняты в нашу команду. С этого момента вы можете продолжать работать по определенной программе и продвигаться выше по уровням, получая все больше наград и преимуществ. + +## Амбассадорские деятельность + +Послы SubQuery cмогут вносить свой вклад в четырех основных областях: организация мероприятий, создание контента, перевод и модерация сообщества. Вы не ограничены в выборе активностей и их направлений, вы не привязаны к какой-то одной. + +** Организация мероприятий:** Создание локальных сообществ путем проведения, организации и управления различными мероприятиями. Создание локального сообщества будет ключевой частью развития сообщества SubQuery. SubQuery будет поддерживать вас, предоставляя финансирование для проведения мероприятий, присылая сувениры и атрибутику для раздачи, а также предоставляя возможность участия в Q&As или онлайн-мероприятиях в качестве докладчиков или в сессиях AMA. + +** Создание контента:** У нас есть длинный перечень контента и дополнительных материалов, в создании которых нам нужна помощь. Помните, наш успех зависит от возможности наших клиентов создавать удивительные вещи с помощью нашего сервиса, поэтому нам нужна ваша помощь, чтобы сделать это доступнее. Контент может включать в себя видео, инфографику, гайды, анимацию или любой другой учебный материал, чтобы осведомлять, обучать или вдохновлять членов сообщества в рамках экосистемы SubQuery. SubQuery готов поддерживать создателей качественного контента за счет предоставления брендинговых активов и опыта. Мы также будем подключать маркетинговые каналы SubQuery для повышения осведомленности о вашем контенте (и о вас самих). + +**Перевод:** Наши клиенты говорят не только по-английски! Нам нужна ваша помощь, чтобы сделать SubQuery более доступным, переводя наши материалы на ваш родной язык, а также помогая распространять информацию среди нашего международного сообщества. + +** Модерация сообщества:** Модераторы будут помогать развитию сообщества SubQuery, обеспечивая активность и вовлеченность официальных каналов сообщества. SubQuery будет поддерживать модераторов, продвигая каналы, которми они управляют, а также предоставлять рекомендации по нашим ожиданиям. + +[Подай заявку прямо сейчас!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/ru/miscellaneous/branding.md b/docs/ru/miscellaneous/branding.md new file mode 100644 index 00000000000..f28d7774c64 --- /dev/null +++ b/docs/ru/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Брендинговые материалы + +**Все элементы бренда SubQuery являются собственностью, и мы очень серьезно относимся к нашему бренду.** + +Если вы решили использовать любые торговые марки, логотипы, дизайны или другие функции бренда, внимательно следуйте руководящим принципам здесь или обращайтесь к нам через социальные сети для уточнения. + +Если у вас есть сомнения, спросите! + +## Пакет брендовых активов + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/ru/miscellaneous/contributing.md b/docs/ru/miscellaneous/contributing.md new file mode 100644 index 00000000000..e7d5e5b6054 --- /dev/null +++ b/docs/ru/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Вклад в SubQuery + +Добро пожаловать и большое спасибо за то, что рассмотрели возможность внести свой вклад в этот проект SubQuery! Вместе мы сможем создать путь к более децентрализованному будущему. + +::: tip Note This documentation is actively maintained by the SubQuery team. Мы рады вашим вкладам. Вы можете сделать это, создав форк нашего проекта на GitHub и внеся изменения во все файлы разметки документации в каталоге `docs`. ::: + +Ниже приводится набор рекомендаций (не правил) по внесению вклада в SubQuery. Соблюдение этих рекомендаций поможет нам сделать процесс внесения взносов простым и эффективным для всех участников. Это также означает, что вы согласны уважать время разработчиков, управляющих и развивающих этот проект. В свою очередь, мы ответим на это уважением, учитывая изменения, рассматривая изменения, сотрудничая в улучшении и помогая вам дорабатывать ваши запросы. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Нормы поведения + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Приступая к работе + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Ищите существующие Замечания и PR, прежде чем создавать собственные. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Дружественное @ упоминание в ветке комментариев отправителю или участнику может помочь привлечь внимание, если ваша задача блокируется. + +## Как сделать вклад + +### Сообщить об ошибках + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Чтобы идентифицировать проблему, используйте понятное и описательное название. +- Опишите точные шаги для воспроизведения проблемы. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Если возможно, включите скриншоты + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Отправка Pull Request'ов + +In general, we follow the "fork-and-pull" Git workflow: + +- Перенесите репозиторий на свой аккаунт Github. +- Клонируйте проект на свою машину. +- Создайте локальный филиал с кратким, но описательным именем. +- Зафиксируйте изменения в ветке. +- Соблюдение всех рекомендаций по форматированию и тестированию, характерных для данного репозитория. +- Отправить изменения в ваш форк. +- Откройте PR в нашем репозитории. + +## Контрагенты кодирования + +### Сообщения Git Commit + +- Используйте настоящее время ("Добавить функцию", а не "Добавлена функция"). +- Используйте повелительное наклонение ("Move cursor to...", а не "Moves cursor to..."). +- Ограничьте первую строку 72 символами или менее. + +### Руководство по стилю JavaScript + +- Весь код JavaScript проверяется с помощью Prettier и ESLint. diff --git a/docs/ru/miscellaneous/social_media.md b/docs/ru/miscellaneous/social_media.md new file mode 100644 index 00000000000..f00ba961f8f --- /dev/null +++ b/docs/ru/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Ссылки в социальных сетях + +SubQuery - это активный проект, который поддерживает и общается с нашими подписчиками через множество каналов социальных сетей. + +Наша цель - всегда прислушиваться к нашему лояльному сообществу и взаимодействовать с ним, поэтому, пожалуйста, присоединяйтесь к беседам и отправляйте нам свои идеи или вопросы! + +## Официальные комьюнити SubQuery + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Основное сообщество с выделенными каналами технической поддержки) +- [Medium](https://subquery.medium.com) (Основной канал анонсов) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (только канал объявлений) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Неофициальные комьюнити SubQuery + +Эти сообщества не модерируются командой SubQuery, но наши представители могут быть там для оказания поддержки. Пожалуйста, будьте осторожны с мошенниками, поскольку SubQuery ** не ** несет ответственности за ваше взаимодействии с ними. + +- [Telegram (Китайский)](https://t.me/subquerychina) +- [Telegram (Русский)](https://t.me/SubQuery_russia) +- [Telegram (Испанский)](https://t.me/SubQueryES) +- [Telegram (Тайский)](https://t.me/subquerynetworkthai) +- [Telegram (Турецкий)](https://t.me/subquery_TR) +- [Telegram (Вьетнамский)](https://t.me/subqueryvietnam) +- [Telegram (Вьетнамские объявления)](https://t.me/subqueryannvn) diff --git a/docs/ru/miscellaneous/vulnerability-reporting.md b/docs/ru/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/ru/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/ru/subquery_network/2024.md b/docs/ru/subquery_network/2024.md new file mode 100644 index 00000000000..3c75b053c28 --- /dev/null +++ b/docs/ru/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. Токен SubQuery Token (SQT) разработан как полезный токен, который обеспечивает работу сети SubQuery Network, стимулирует участие в ней, а также служит средством обмена для транзакций в сети SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/ru/subquery_network/about.md b/docs/ru/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/ru/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/ru/subquery_network/community.md b/docs/ru/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/ru/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/ru/subquery_network/fair-use.md b/docs/ru/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/ru/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/ru/subquery_network/faq.md b/docs/ru/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/ru/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/ru/subquery_network/glossary.md b/docs/ru/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/ru/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/ru/subquery_network/infra-changes.md b/docs/ru/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/ru/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/ru/subquery_network/parameters.md b/docs/ru/subquery_network/parameters.md new file mode 100644 index 00000000000..26139d81a0d --- /dev/null +++ b/docs/ru/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Описание | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/ru/subquery_network/welcome.md b/docs/ru/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/ru/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/th/README.md b/docs/th/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/th/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/th/miscellaneous/ambassadors.md b/docs/th/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..6121e30d140 --- /dev/null +++ b/docs/th/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# โปรแกรมแอมบาสเดอร์ + +![Ambassador Banner Image](/assets/img/ambassador_banner.png) + +เราเข้าใจดีว่าจุดแข็งที่ใหญ่ที่สุดจุดหนึ่งของเราคือคอมมูนิตี้ และด้วยความช่วยเหลือของคุณ เราต้องการที่จะเติบโตและจัดตั้งแอมบาสเดอร์ท้องถิ่นเพื่อคอมมูนิตี้ต่างๆ ทั่วโลก + +[สมัครเลย!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## ความเชื่อของเรา + +ทีมงานของเรามาพร้อมกับวิสัยทัศน์เดียวกันที่จะสร้างรากฐานของบริการข้อมูลที่ยืดหยุ่นและครอบคลุมสำหรับระบบนิเวศ Polkadot + +**สร้างโดยนักพัฒนาเพื่อนักพัฒนา:** SubQuery เป็นคอมมูนิตี้ที่กำลังเติบโต ซึ่งมุ่งเน้นการจัดหาผลิตภัณฑ์และบริการที่ดีที่สุดสำหรับนักพัฒนาและผู้สร้างในระบบนิเวศของเรา SubQuery จะประสบความสำเร็จก็ต่อเมื่อระบบนิเวศของ Polkadot ประสบความสำเร็จ ดังนั้นทุกสิ่งที่ทำเราจะคำนึงถึงลูกค้าของเราเสมอ + +**ความซื่อสัตย์และความรับผิดชอบ:** เรามีสมาชิกทีมในโอ๊คแลนด์ เซี่ยงไฮ้ และซิดนีย์ ดังนั้นการทำงานทางไกลจึงสำคัญสำหรับเรา สมาชิกในทีมจะมีอำนาจในการตัดสินใจและสามารถทำงานร่วมกันอย่างอิสระเพื่อให้บรรลุเป้าหมายของเรา ซึ่งเงื่อนไขที่สำคัญสำหรับสิ่งนี้คือทีมของเราต้องรับผิดชอบต่อการกระทำของพวกเขาและรักษาความซื่อสัตย์ + +**คำแนะนำและการสนับสนุนที่ครอบคลุม:** บล็อกเชนนั้นเป็นเรื่องยาก และในบางครั้งทุกคนจึงต้องการความช่วยเหลือ จะไม่มีสิ่งที่เรียกว่าคำถามโง่ๆ ในคอมมูนิตี้ของเรา และทุกคนในทีมพร้อมให้การช่วยเหลือและสนับสนุนผู้ใช้ของเรา เราได้เรียนรู้ข้อมูลเชิงลึกที่มีค่าที่สุดบางอย่างเกี่ยวกับบริการของเรา (และวิธีที่เราจะปรับปรุงบริการให้ดีขึ้น) โดยตรงจากคอมมูนิตี้ของเรา + +## โปรแกรมแอมบาสเดอร์ของเรา + +โปรแกรมแอมบาสเดอร์ของ SubQuery มีเป้าหมายเพื่อค้นหาผู้นำคอมมูนิตี้ที่หลงใหลใน Polkadot และ SubQuery โดยเรากำลังมองหาผู้ริเริ่มที่จะสามารถกระจายข่าวและข้อมูลเกี่ยวกับ SubQuery ในพื้นที่ของตนและให้การสนับสนุนนักพัฒนารายใหม่ที่ต้องการใช้ SubQuery เพื่อสร้างแอปและบริการที่น่าทึ่งบน Polkadot + +### สิทธิประโยชน์ของแอมบาสเดอร์ + +ที่ SubQuery เราทำงานอย่างหนักเพื่อบรรลุสิ่งที่เราต้องการ ในทำนองเดียวกัน เมื่อเข้าร่วมทีมกับเราแอมบาสเดอร์นั้นควรจะต้องใช้เวลาพอสมควรในการทำงาน แต่จะได้รับรางวัลเป็นสิทธิประโยชน์ต่างๆ มากมาย + +**เงินทุนและการสนับสนุน:** คุณอาจได้รับรางวัลสำหรับการทำงานที่ดีเป็นโอกาสในการเข้าร่วม Private Sale และเงินสนับสนุนก่อนคนอื่น นอกจากนี้ เรายังมีทุนสนับสนุนเพื่อให้กับคุณ เพื่อใช้ในการจัดกิจกรรมพบปะสังสรรค์สำหรับคอมมูนิตี้อีกด้วย + +**การเข้าถึงทีม SubQuery:** คุณจะสามารถเข้าถึงทีมหลัก SubQuery ได้โดยตรง พร้อมได้รับโอกาสในการฝึกอบรมภาคปฏิบัติ, AMA สุดพิเศษกับผู้นำและนักพัฒนาของเรา และรวมถึงรับรู้ข้อมูลเชิงลึกเกี่ยวกับแผนการทำงานของเรา + +**การพัฒนาเครือข่าย:** คุณจะสามารถขยายเครือข่ายการทำงานของคุณได้ด้วยการเป็นแอมบาสเดอร์ให้หนึ่งในโปรเจกต์ชั้นนำของ Polkadot รวมถึงพบกับแอมบาสเดอร์คนอื่นๆ ทั่วโลกและได้รับการแนะนำเกี่ยวกับโปรเจกต์ต่างๆ ของ Polkadot ในท้องถิ่นที่เราจำเป็นต้องสนับสนุน โดยคุณอาจได้รับสิทธิ์เข้าร่วมเพื่อเป็นตัวแทนของ SubQuery สำหรับกิจกรรมในพื้นที่ของคุณฟรีอีกด้วย + +**ของที่ระลึกและของฟรีอื่นๆ:** ใครๆ ก็ชอบของฟรี! ได้รับการของที่ระลึกจาก SubQuery ที่ทำให้คุณโดดเด่นกว่าคนอื่น รวมไปถึงส่วนแบ่งที่ได้รับจากกิจกรรมในคอมมูนิตี้ และคุณจะยังได้รับ NFT สุดพิเศษ สำหรับแอมบาสเดอร์อีกด้วย + +## ระบบของโปรแกรมแอมบาสเดอร์ + +โปรแกรมแอมบาสเดอร์ของเรามีหลายระดับ โดยแต่ละระดับจะมีสิทธิประโยชน์และระดับความสามารถที่แตกต่างกัน คุณสามารถเลื่อนระดับได้โดยการเข้าร่วมกิจกรรมแอมบาสเดอร์และทำงานหนักให้กับเรา + +เมื่อคุณส่งใบสมัครแล้ว เราจะคัดเลือกผู้สมัครที่สอดคล้องกับค่านิยมของเรา และหากได้รับเลือก คุณจะได้เข้าร่วมโปรแกรมฝึกหัดของเราและจะได้รับแพ็คเกจข้อมูล ซึ่งจะช่วยให้คุณมีความเข้าใจเกี่ยวกับ SubQuery มากขึ้น หลังจากนั้น คุณสามารถเริ่มทำงานผ่านโปรแกรมฝึกหัด โดยจะต้องทำงานบางอย่างในโปรแกรมอบรมให้เสร็จสิ้น (เช่น การสร้างโปรเจกต์ SubQuery) โดยเราจะจัดเวิร์กช็อปตลอดกระบวนการนี้เพื่อให้ความช่วยเหลือกับคุณ + +เมื่อคุณผ่านโปรแกรมฝึกหัดแล้ว คุณจะสามารถเรียกตัวเองว่าแอมบาสเดอร์ของ SubQuery ได้และจะได้เข้าร่วมโปรแกรมอย่างเต็มรูปแบบกับเรา จากนั้นคุณสามารถทำงานในโปรแกรมต่อไปได้เพื่อเลื่อนระดับ รับรางวัล รวมถึงสิทธิประโยชน์ที่มากขึ้นเมื่อระดับของคุณสูงขึ้น + +## กิจกรรมของแอมบาสเดอร์ + +SubQuery Ambassadors are able to contribute through four main areas, including event management, content creation, translation, and community moderation. You can participate in as many areas as you want, you’re not bound to any single one. + +**Event Management:** Build local communities by hosting, organising, and managing different events. Building a local community will be a key part of growing the SubQuery community. SubQuery will support you by providing funding for events, sending swag/merchandise to be given away, as well as attending Q&As or online events as speakers or in AMA sessions. + +**Content Creation:** We have a long list of content and support material that we need help creating. Remember, our success relies on the ability of our customers to build amazing things on our service, so we need your help to make that easier. Content includes videos, infographics, tutorials, animations, or any other related material, to inform, educate, or inspire community members within the SubQuery Ecosystem. SubQuery will support Content Creators by providing branding assets and expertise. We’ll also use SubQuery’s marketing channels to increase awareness of your content (and yourself). + +**Translation:** Our customers don’t just speak English! We need your help making SubQuery more accessible by translating our content into your own language, as well as helping sharing the word to our international community. + +**Community Moderation:** Moderators will help grow the SubQuery community by ensuring that official community channels are active and engaging. SubQuery will support Moderators by promoting the channels that they monitor, as well as provide guidelines for our expectations. + +[สมัครเลย!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/th/miscellaneous/branding.md b/docs/th/miscellaneous/branding.md new file mode 100644 index 00000000000..05fb0fda660 --- /dev/null +++ b/docs/th/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# สิ่งต่าง ๆ สำหรับการทำแบรนด์ของ SubQuery + +**โลโก้หรือเครื่องหมายต่างๆ ของ SubQuery ทั้งหมดเป็นกรรมสิทธิ์ของเรา และเราให้ความสำคัญกับแบรนด์ของเราเป็นอย่างมาก** + +หากคุณเลือกใช้เครื่องหมายการค้า, โลโก้, งานดีไซน์, หรือคุณลักษณะอื่นๆ ของแบรนด์ โปรดปฏิบัติตามหลักเกณฑ์นี้อย่างละเอียด หรือติดต่อเราผ่านโซเชียลมีเดียเพื่อสอบถามเพิ่มเติม + +หากมีข้อสงสัย โปรดอย่าลังเลที่จะติดต่อเราเพื่อสอบถาม! + +## แพ็คเกจทรัพยากรแบรนด์ + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/th/miscellaneous/contributing.md b/docs/th/miscellaneous/contributing.md new file mode 100644 index 00000000000..c1a6c75c505 --- /dev/null +++ b/docs/th/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# การมีส่วนร่วมใน SubQuery + +ยินดีต้อนรับและขอขอบคุณเป็นอย่างยิ่งที่สนใจที่จะเข้าร่วมในโปรเจ็กต์ SubQuery นี้! ด้วยความร่วมมือกัน เราจะสามารถปูทางไปสู่อนาคตที่มีการกระจายอำนาจมากขึ้น + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## จรรยาบรรณ + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## เริ่มต้น + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- การค้นหา Issues และ PR ที่มีอยู่ก่อนที่จะสร้าง Issues ของคุณเอง +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. การใช้ @ mention ที่เป็นมิตรในความคิดเห็นถึงผู้ส่งหรือผู้ร่วมให้ข้อมูลสามารถช่วยดึงดูดความสนใจได้หาก Issue ของคุณยังไม่ได้รับการแก้ไข้ + +## วิธีการมีส่วนร่วม + +### การรายงานข้อบกพร่อง (Bug) + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- ตั้งชื่อ Issue ที่ชัดเจนและสื่อความหมายเพื่อระบุปัญหา +- อธิบายขั้นตอนที่แน่นอนในการทำให้เกิดปัญหานี้ซ้ำ +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- รวมภาพหน้าจอด้วย ถ้าเป็นไปได้ + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### การส่ง Pull Requests + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## ข้อตกลงในการเขียนโค้ด + +### ข้อความในการยืนยัน Git + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### แนวทางรูปแบบสำหรับ JavaScript + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/th/miscellaneous/social_media.md b/docs/th/miscellaneous/social_media.md new file mode 100644 index 00000000000..8b107ed8307 --- /dev/null +++ b/docs/th/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# ลิงค์โซเชียลมีเดีย + +SubQuery เป็นโปรเจ็กต์ที่มีการใช้งานอยู่ โดยดูแลและสื่อสารกับผู้ติดตามของเราผ่านช่องทางโซเชียลมีเดียมากมาย + +เป้าหมายของเราคือการรับฟังและการมีส่วนร่วมกับชุมชนที่เหนียวแน่นของเราเสมอ ดังนั้นโปรดเข้าร่วมการสนทนาและส่งความคิดหรือคำถามของคุณมาให้เรา! + +## ชุมชน SubQuery อย่างเป็นทางการ + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (ชุมชนหลัก พร้อมช่องทางการสนับสนุนด้านเทคนิคโดยเฉพาะ) +- [Medium](https://subquery.medium.com) (ช่องทางสำหรับการประกาศหลัก) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (ช่องสำหรับประกาศเท่านั้น) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## ชุมชน SubQuery ที่ไม่เป็นทางการ + +ชุมชนเหล่านี้ไม่ได้ดูแลโดยทีม SubQuery แต่ Ambassadors ของเราอาจอยู่ที่นั่นเพื่อให้การสนับสนุน โปรดระวังการหลอกลวงเนื่องจาก SubQuery **จะไม่** รับผิดชอบต่อสิ่งที่เกิดขึ้นภายในนั้น + +- [Telegram (ภาษาจีน)](https://t.me/subquerychina) +- [Telegram (ภาษารัสเซีย)](https://t.me/SubQuery_russia) +- [Telegram (ภาษาสเปน)](https://t.me/SubQueryES) +- [Telegram (ภาษาไทย)](https://t.me/subquerynetworkthai) +- [Telegram (ภาษาตุรกี)](https://t.me/subquery_TR) +- [Telegram (ภาษาเวียดนาม)](https://t.me/subqueryvietnam) +- [Telegram (สำหรับการประกาศภาษาเวียดนาม)](https://t.me/subqueryannvn) diff --git a/docs/th/miscellaneous/vulnerability-reporting.md b/docs/th/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/th/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/th/subquery_network/2024.md b/docs/th/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/th/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/th/subquery_network/about.md b/docs/th/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/th/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/th/subquery_network/community.md b/docs/th/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/th/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/th/subquery_network/fair-use.md b/docs/th/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/th/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/th/subquery_network/faq.md b/docs/th/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/th/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/th/subquery_network/glossary.md b/docs/th/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/th/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/th/subquery_network/infra-changes.md b/docs/th/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/th/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/th/subquery_network/parameters.md b/docs/th/subquery_network/parameters.md new file mode 100644 index 00000000000..6c876d7531c --- /dev/null +++ b/docs/th/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | คำอธิบาย | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/th/subquery_network/welcome.md b/docs/th/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/th/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/tr/README.md b/docs/tr/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/tr/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/tr/miscellaneous/ambassadors.md b/docs/tr/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..ae494e39dac --- /dev/null +++ b/docs/tr/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Büyükelçi Programı + +![Ambassador Afiş Resmi](/assets/img/ambassador_banner.png) + +En güçlü yönlerimizden birinin topluluğumuz olduğunu biliyoruz ve sizin yardımınızla büyümek ve dünyanın dört bir yanındaki topluluklar için yerel elçiler seçmek istiyoruz. + +[Şimdi Başvur!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## Neye İnanıyoruz + +Ekibimiz, Polkadot ekosistemi için esnek ve kapsayıcı bir veri hizmetinin temellerini atmak için ortak bir vizyonla bir araya geldi. + +**Geliştiriciler tarafından, geliştiriciler için oluşturulmuştur:** SubQuery, geliştiricilerimiz ve ekosistemimizdeki geliştiriciler için en iyi ürünleri ve hizmetleri sağlamaya odaklanmış büyüyen bir topluluktur. SubQuery, yalnızca Polkadot ekosistemi başarılı olduğunda başarılı olur ve bu nedenle yaptığımız her şeyi müşterilerimizi hesaba katarak yapıyoruz. + +**Bütünlük ve Sorumluluk:** Auckland, Şanghay ve Sidney şehirlerinde ekip üyelerimiz var, uzaktan çalışma işimizin çok önemli bir parçası. Hedeflerimize ulaşmak için ekibimizin yetkilendirilmiş olmasını ve birlikte özerk bir şekilde çalışmasını beklemekteyiz. Bunun esas gereksinimlerden biri, ekibimizin eylemlerinden sorumlu olması ve bütünlüğünü korumasıdır. + +**Kapsayıcı Rehberlik ve Destek:** Blok zinciri zor bir alan ve bazen herkesin yardıma ihtiyacı olur. Topluluğumuzda aptalca soru diye bir şey yoktur ve ekibimizdeki herkesin kullanıcılarımızı desteklemeye yardımcı olması beklenir. Hizmetimizle (ve onu nasıl daha iyileştirebileceğimizle) ilgili en değerli bilgilerden bazılarını direkt olarak topluluğumuzdan öğreniyoruz. + +## Büyükelçi Programımız + +SubQuery Büyükelçi programımız, Polkadot ve SubQuery'e tutkuyla yanaşan topluluk liderlerini bulmayı amaçlıyor. SubQuery'yi kendi yerel bölgelerinde yaygın hale getirecek ve Polkadot'ta muhteşem uygulamalar ve hizmetler geliştirmek için SubQuery kullanmak isteyen yeni geliştiricilere destek sağlayabilecek bireyleri arıyoruz. + +### Büyükelçi Avantajları + +SubQuery'de başarımızın altında yatan ana etken sıkı çalışmamızdır. Benzer şekilde, Elçilerin ekibimize katılırken bir süre taahhütünde bulunmaları beklenir, ancak buna karşılık avantajlarla ödüllendirileceklerdir. + +**Finansman ve Destek:** Yaptığınız iyi işler için özel satışlar, ödüller ve erken fırsatlarla ödüllendirilebilirsiniz. Ek olarak, topluluk buluşmalarını düzenleyebilmeniz için size finansman hibeleri sağlayacağız. + +**SubQuery Ekip Erişimi:** Çekirdek SubQuery ekibine doğrudan erişiminiz olacak. Ayrıca uygulamalı eğitim fırsatlarına, liderlerimiz ve geliştiricilerimizle birlikte özel AMA'lara erişebilecek ve yol haritamız hakkında bilgi edinebileceksiniz. + +**Ağ Geliştirme:** Ana Polkadot projelerinden birinin Elçisi olarak profesyonel ağınızı büyütmeyi bekleyebilirsiniz. Dünyanın dört bir yanındaki diğer elçilerle tanışın ve yerel olarak desteklememiz gereken yerel Polkadot projelerinin tanıtımlarını alın. Yerel bölgenizdeki etkinliklerde SubQuery'i temsil etmek için ücretsiz giriş bile alabilirsiniz. + +**Swag ve diğer ücretsiz şeyler:** Herkes ücretsiz şeylere bayılır! Kalabalıkta öne çıkmanızı sağlayacak yıllık bir SubQuery swag tahsisi alın. Ek olarak topluluk etkinliklerinde paylaşabileceğiniz ilave tahsisat. Ayrıca Ambassador statünüz için özel bir NFT alacaksınız. + +## Nasıl çalışır + +Ambassador programımızın birden çok katmanı vardır, her katmanın farklı faydaları ve üstünlükleri vardır. Büyükelçi etkinliklerine katılarak ve sıkı çalışarak katmanlarda pozisyonuzu yükselebilirsiniz. + +Siz bir başvuru gönderdikten sonra, bizim değerlerimizle uyumlu olan adayları seçeceğiz. Eğer seçilirseniz, stajyer programımıza yerleştirilecek ve SubQuery hakkındaki anlayışınızı genişletecek bir bilgi paketi alacaksınız. Bundan sonra, belirli alıştırma görevlerini tamamlayarak (örn. bir SubQuery Projesi oluşturarak) stajyer programı üzerinden çalışmalarınıza başlayabileceksiniz. Bu süreç boyunca size destek olmak için workshop etkinlikleri düzenleyeceğiz. + +Stajyer programını başarıyla geçtikten sonra kendinize bir SubQuery elçisi olarak adlandırabilirsiniz. Bu aşamadan sonra tam programımıza kabul edileceksiniz. Bundan sonra program boyunca çalışmaya devam edebilir ve kademelerde ilerleyebilirsiniz. Bu kademelerde yukarıya doğru tırmandıkça daha fazla ödül ve avantaj elde edeceksiniz. + +## Büyükelçi Aktiviteleri + +SubQuery Ambassadors are able to contribute through four main areas, including event management, content creation, translation, and community moderation. You can participate in as many areas as you want, you’re not bound to any single one. + +**Event Management:** Build local communities by hosting, organising, and managing different events. Building a local community will be a key part of growing the SubQuery community. SubQuery will support you by providing funding for events, sending swag/merchandise to be given away, as well as attending Q&As or online events as speakers or in AMA sessions. + +**Content Creation:** We have a long list of content and support material that we need help creating. Remember, our success relies on the ability of our customers to build amazing things on our service, so we need your help to make that easier. Content includes videos, infographics, tutorials, animations, or any other related material, to inform, educate, or inspire community members within the SubQuery Ecosystem. SubQuery will support Content Creators by providing branding assets and expertise. We’ll also use SubQuery’s marketing channels to increase awareness of your content (and yourself). + +**Translation:** Our customers don’t just speak English! We need your help making SubQuery more accessible by translating our content into your own language, as well as helping sharing the word to our international community. + +**Community Moderation:** Moderators will help grow the SubQuery community by ensuring that official community channels are active and engaging. SubQuery will support Moderators by promoting the channels that they monitor, as well as provide guidelines for our expectations. + +[Şimdi Başvur!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/tr/miscellaneous/branding.md b/docs/tr/miscellaneous/branding.md new file mode 100644 index 00000000000..ee84c158cfa --- /dev/null +++ b/docs/tr/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Markalaşma Materyalleri + +**SubQuery'nin tüm marka özellikleri tescillidir ve markamızı son derece ciddiye alıyoruz.** + +Herhangi bir ticari marka, logo, tasarım veya diğer marka özelliklerini kullanmayı tercih ederseniz, lütfen buradaki yönergeleri dikkatle izleyin veya açıklama için sosyal medya üzerinden bize ulaşın. + +Şüpheniz varsa, lütfen bize sorun! + +## Marka Varlıkları Paketi + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/tr/miscellaneous/contributing.md b/docs/tr/miscellaneous/contributing.md new file mode 100644 index 00000000000..91d599cef78 --- /dev/null +++ b/docs/tr/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# SubQuery Katkıda Bulunmak + +Hoş geldiniz ve bu SubQuery projesine katkıda bulunmayı düşündüğünüz için büyük bir teşekkür ederiz! Birlikte daha merkezi olmayan bir geleceğin yolunu açabiliriz. + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +What follows is a set of guidelines (not rules) for contributing to SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Davranış Kuralları + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Başlarken + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Kendi sorunlarınızı oluşturmadan önce mevcut Sorunları ve PRs arayın. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Yorum başlığındaki bir dost @ bahsetmesi gönderene veya bir katılımcıya sorununuzu engelliyorsa dikkat çekmeye yardımcı olabilir. + +## Nasıl Katkıda Bulunulur + +### Raporlama Hataları + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Sorunu tanımlamak için sorun için açık ve açıklayıcı bir başlık kullanın. +- Sorunu yeniden oluşturmak için tam adımları açıklayın. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Mümkünse ekran görüntülerini ekleyin. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Çekme İstekleri Gönderme + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## Kodlama Kuralları + +### Git İletileri Kaydet + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### JavaScript Stil Kılavuzu + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/tr/miscellaneous/social_media.md b/docs/tr/miscellaneous/social_media.md new file mode 100644 index 00000000000..1d3efbb23cf --- /dev/null +++ b/docs/tr/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Sosyal Medya Bağlantıları + +SubQuery, birçok sosyal medya kanalı aracılığıyla takipçilerimizle iletişim kuran ve halen devam eden aktif bir projedir. + +Amacımız her zaman sadık topluluğumuzu dinlemek ve onlarla etkileşim kurmaktır, bu yüzden lütfen siz de sohbete katılın ve fikirlerinizi veya sorularınızı bize gönderin! + +## Resmi SubQuery Toplulukları + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Özel teknik destek kanallarına sahip Birincil Topluluk) +- [Medium](https://subquery.medium.com) (Birincil duyuru kanalı) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (Yalnızca duyuru kanalı) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Resmi Olmayan SubQuery Toplulukları + +Bu topluluklar SubQuery ekibi tarafından yönetilmiyor, ancak temsilcilerimiz destek sağlamak için orada bulunabilir. Lütfen dolandırıcılığa karşı dikkatli olun, SubQuery burada olanlardan sorumlu **değildir**. + +- [Telegram (Çince)](https://t.me/subquerychina) +- [Telegram (Rusça)](https://t.me/SubQuery_russia) +- [Telegram (İspanyolca)](https://t.me/SubQueryES) +- [Telegram (Tayca)](https://t.me/subquerynetworkthai) +- [Telegram (Türkçe)](https://t.me/subquery_TR) +- [Telegram (Vietnamca)](https://t.me/subqueryvietnam) +- [Telegram (Vietnamca Duyuru)](https://t.me/subqueryannvn) diff --git a/docs/tr/miscellaneous/vulnerability-reporting.md b/docs/tr/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/tr/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/tr/subquery_network/2024.md b/docs/tr/subquery_network/2024.md new file mode 100644 index 00000000000..412a1f34fc1 --- /dev/null +++ b/docs/tr/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/tr/subquery_network/about.md b/docs/tr/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/tr/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/tr/subquery_network/community.md b/docs/tr/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/tr/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/tr/subquery_network/fair-use.md b/docs/tr/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/tr/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/tr/subquery_network/faq.md b/docs/tr/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/tr/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/tr/subquery_network/glossary.md b/docs/tr/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/tr/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/tr/subquery_network/infra-changes.md b/docs/tr/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/tr/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/tr/subquery_network/parameters.md b/docs/tr/subquery_network/parameters.md new file mode 100644 index 00000000000..4397c2f5f3c --- /dev/null +++ b/docs/tr/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Tarif | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/tr/subquery_network/welcome.md b/docs/tr/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/tr/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/uk/README.md b/docs/uk/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/uk/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/uk/miscellaneous/ambassadors.md b/docs/uk/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..2c05bc98191 --- /dev/null +++ b/docs/uk/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Програма амбасадорів 👩:🩲 + +![Зображення банера представника](/assets/img/ambassador_banner.png) + +Ми розуміємо, що одна з наших найбільших сильних сторін - це наша спільнота, і з вашою допомогою ми хочемо зростати та встановлювати місцевих амбассадорів для громад по всьому світу. + +[Подати зараз](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## У що ми віримо + +Наша команда разом зі спільним баченням побудувала основи гнучкої та інклюзивної служби передачі даних для екосистеми Polkadot. + +**Розроблено розробниками для розробників:** SubQuery - це зростаюча спільнота, яка зосереджена на наданні найкращих продуктів та послуг для наших розробників у нашій екосистемі. SubQuery є успішним лише в тому випадку, якщо екосистема Polkadot успішна, і нам важлива думка наших клієнтів. + +**Чесність та підзвітність:** У нас є члени команди в Окленді, Шанхаї та Сіднеї, і тому віддалена робота для нас важлива. Ми очікуємо, що наша команда отримає повноваження та працюватиме автономно разом для досягнення наших цілей. Ключова вимога для цього - щоб наша команда відповідала за свої дії та зберігала свою чесність. + +**Включений Керівництво та Підтримка:** Blockchain це складно, і всім потрібна допомога іноді. У нашій спільноті немає поганих запитань, і кожен у нашій команді повинен підтримувати наших користувачів. Деякі відгуки про наш сервіс (і про те, як ми можемо його покращити) ми дізнаємось безпосередньо від нашої спільноти. + +## Програма амбасадорів 👩:🩲 + +Наша програма "SubQuery Амбассадор" спрямована на те, щоб лідери спільноти захоплювалися Polkadot та SubQuery. Ми шукаємо людей, які можуть поширювати інформацію про SubQuery у своїх локальних регіонах та надавати підтримку новим розробникам, які хочуть використовувати SubQuery для створення чудових програм та послуг на Polkadot. + +### Переваги Амбассадора + +У SubQuery ми наполегливо працюємо над досягненням того, що робимо. Так само очікується, що Амбассадори виділять деякий свій час, коли приєднаються до нашої команди, але будуть нагороджені перевагами. + +**Фінансування та підтримка:** Ви можете бути винагороджені за хорошу роботу з ранніми можливостями у приватних продажах та винагородах. Крім того, ми будемо надавати вам гранти на фінансування для проведення зборів у громаді. + +**Доступ до команди SubQuery:** Ви матимете прямий доступ до основної команди SubQuery з можливостями практичного навчання, ексклюзивними AMA з нашими керівниками та розробниками та ознайомленням з нашою дорожньою картою. + +**Розвиток зв'язків:** Очікуйте розширення своїх професійних зв'язків, будучи Амбассадором у одному з найкращих проектів Polkadot. Познайомтесь з іншими Амбассадорами по всьому світу та ознайомтесь із місцевими проектами Polkadot, які ми повинні підтримати на місцевому рівні. Ви навіть можете отримати безкоштовний вхід для представлення SubQuery у подіях у вашому регіоні. + +**Swag і інші безкоштовні речі:** Всі люблять безкоштовні матеріали! Отримуйте речі SubQuery, які виділять вас серед натовпу. Плюс додаткові речі, якими ви можете поділитися на подіях з ком'юніті. Ви також отримаєте ексклюзивний NFT за статус Амбассадора. + +## Як це працює? + +Наша програма Амбассадор має кілька рівнів, кожен рівень має різні переваги та можливості. Ви можете підвищити рівень, беручи участь у заходах Амбассадорів та наполегливо працюючи для нас. + +Після того, як ви надішлете заявку, ми відберемо кандидатів, які відповідають нашим цінностям. У разі вибору ви потрапляєте до нашої програми стажування та отримуєте інформаційний пакет, який розширює ваше уявлення про SubQuery. Після цього ви можете розпочати роботу за програмою стажера, виконавши певні завдання з впровадження (наприклад, створити проект SubQuery). Ми будемо проводити семінари протягом усього цього процесу, щоб підтримати вас. + +Після проходження програми стажування ви можете називати себе Амбассадором SubQuery і вас приймуть до нашої повної програми. З цього моменту ви можете продовжувати працювати у програмі та просуватися по рівнях, заробляючи більше нагород та переваг, ніби ви піднімаєтесь по сходах. + +## Діяльність Амбассадора + +Посли SubQuery можуть робити внесок у чотирьох основних сферах, включаючи керування подіями, створення вмісту, переклад і модерування спільноти. Ви можете брати участь у будь-якій кількості областей, не прив’язаних до жодної. + +**Керування подіями:** створюйте місцеві спільноти, проводячи, організовуючи та керуючи різними подіями. Створення місцевої спільноти буде ключовою частиною розвитку спільноти SubQuery. SubQuery підтримуватиме вас, забезпечуючи фінансування заходів, надсилаючи подарунки/товари для роздачі, а також відвідуючи питання та відповіді чи онлайн-події в якості доповідачів або на сесіях AMA. + +**Створення вмісту:** у нас є довгий список вмісту та допоміжних матеріалів, у створенні яких нам потрібна допомога. Пам’ятайте, що наш успіх залежить від здатності наших клієнтів створювати дивовижні речі на нашому сервісі, тому нам потрібна ваша допомога, щоб зробити це простіше. Вміст включає відео, інфографіку, навчальні посібники, анімацію або будь-який інший пов’язаний матеріал для інформування, навчання або надихання членів спільноти в екосистемі SubQuery. SubQuery підтримуватиме творців вмісту, надаючи активи брендингу та досвід. Ми також використовуватимемо маркетингові канали SubQuery, щоб підвищити обізнаність про ваш вміст (і вас самих). + +**Переклад:** наші клієнти не просто розмовляють англійською! Нам потрібна ваша допомога, щоб зробити SubQuery доступнішим, перекладаючи наш вміст на вашу рідну мову, а також допомагаючи ділитися інформацією з нашою міжнародною спільнотою. + +**Модерація спільноти:** модератори допоможуть розширити спільноту SubQuery, забезпечуючи активність і залучення офіційних каналів спільноти. SubQuery підтримуватиме модераторів, рекламуючи канали, які вони відстежують, а також надаватиме вказівки щодо наших очікувань. + +[Подати зараз](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/uk/miscellaneous/branding.md b/docs/uk/miscellaneous/branding.md new file mode 100644 index 00000000000..bda0ed4a771 --- /dev/null +++ b/docs/uk/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Брендінг Матеріали + +**Всі функції бренду SubQuery є власними, і ми сприймаємо наш бренд надзвичайно серйозно.** + +Якщо ви вирішили використовувати будь-які торгові марки, логотипи, конструкції чи інші функції бренду, будь ласка, уважно дотримуйтесь вказівок тут або звертайтесь до нас через соціальні медіа для уточнення. + +Якщо сумніви, запитайте будь ласка! + +## Пакет активів марки + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/uk/miscellaneous/contributing.md b/docs/uk/miscellaneous/contributing.md new file mode 100644 index 00000000000..79bff10124a --- /dev/null +++ b/docs/uk/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Вклад у розвиток проекту SubQuery + +Ласкаво просимо! Ми хочемо подякувати вам за те, що ви розглянули можливість зробити свій вклад у проект SubQuery! Разом ми зможемо прокласти шлях до бiльш децентралізованого майбутнього. + +::: tip Note This documentation is actively maintained by the SubQuery team. Ми вітаємо ваші внески. Ви можете зробити це, розгалузивши наш проект на GitHub і внісши зміни в усі файли документації markdown в каталозі `docs`. ::: + +Нижче наводиться набір рекомендацій (не правил) щодо внесення вкладу в SubQuery. Дотримання цих рекомендацій допоможе нам зробити процес внесення внесків простим і ефективним для всіх учасників. Це також означає, що ви згодні поважати час розробників, які керують і розвивають цей проєкт. У свою чергу, ми відповімо взаємністю на цю повагу, вирішивши вашу проблему, розглянувши зміни, співпрацюючи в поліпшенні і допомагаючи вам завершити ваші запити на Витяг. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Наш Кодекс Поведінки + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Початок роботи + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Перш ніж створювати власні питання та PR, за допомогою пошука переконайтеся в тому, що вони не були створені раніше. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Дружня @ згадка відправника або учасника у гілці коментарів може допомогти привернути увагу до вашої проблеми, якщо вона не вирішується. + +## Як зробити вклад у Проект + +### Звіт про знайдені помилки/баги + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Щоб ідентифікувати проблему, намагайтеся використовувати зрозумілу та описову назву. +- Опишіть точні кроки для вiдтворення проблеми. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- При можливості додавайте скріншоти. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Відправлення Pull Requests + +In general, we follow the "fork-and-pull" Git workflow: + +- Перенесіть репозиторій на свій обліковий запис Github. +- Клонуйте проект на свій комп'ютер. +- Створіть локальну гілку з коротким, але описовим назвою. +- Зафіксуйте зміни в гілці. +- Дотримуйтесь усіх рекомендацій щодо форматування та тестування, характерних для цього сховища. +- Внесіть зміни у свою вилку. +- Відкрийте PR у нашому сховищі. + +## Стандарт Оформлення Коду + +### Повідомлення Git Commit + +- Використовуйте даний час ("Додати функцію", а не"додана функція"). +- Використовуйте наказовий спосіб ("Перемістити курсор на..." не "Переміщує курсор на..."). +- Обмежте перший рядок 72 символами або менше. + +### Посібник із стилю JavaScript + +- Весь код JavaScript перевіряється за допомогою Prettier і ESLint. diff --git a/docs/uk/miscellaneous/social_media.md b/docs/uk/miscellaneous/social_media.md new file mode 100644 index 00000000000..d6657138a05 --- /dev/null +++ b/docs/uk/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Посилання на соціальні медіа + +SubQuery є активним проектом, який підтримує зв'язок зі своїми підписниками через різнi канали соціальних мереж. + +Наша мета - завжди прислухатися до нашої відданої спільноти та взаємодіяти з нею, тому ми просимо вас приєднатися до нас. Діліться з нами своїми ідеями, а також надсилайте свої запитання! + +## Офіційні спільноти SubQuery + +- [Linktree](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (Наша головна спільнота з виділеними каналами технічної підтримки) +- [Medium](https://subquery.medium.com) (Головний канал оголошень) +- [Twitter](https://twitter.com/subquerynetwork) +- [ Telegram ](https://t.me/subquerynetwork) (канал лише для оголошень) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Неофіційні спільноти SubQuery + +Ці спільноти не модеруються командою SubQuery, але наші амбассадори зможут надати вам підтримку та відповісти на вашi запитання. Будьте обережні щодо шахрайств, оскільки SubQuery **не ** несе відповідальності за те, що відбувається в цих чатах. + +- [Telegram (Китайська мова)](https://t.me/subquerychina) +- [Telegram (Російська мова)](https://t.me/SubQuery_russia) +- [Telegram (Іспанська мова)](https://t.me/SubQueryES) +- [Telegram (Тайська мова)](https://t.me/subquerynetworkthai) +- [Telegram (Турецька мова)](https://t.me/subquery_TR) +- [Telegram (В'єтнамська мова)](https://t.me/subqueryvietnam) +- [Telegram (Оголошення на В'єтнамськiй мовi)](https://t.me/subqueryannvn) diff --git a/docs/uk/miscellaneous/vulnerability-reporting.md b/docs/uk/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/uk/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/uk/subquery_network/2024.md b/docs/uk/subquery_network/2024.md new file mode 100644 index 00000000000..29790ca0542 --- /dev/null +++ b/docs/uk/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. Токен SubQuery Token (SQT) розроблений як корисний токен, який забезпечує роботу мережі SubQuery Network, стимулює участь у ній, а також служить засобом обміну для транзакцій у мережі SubQuery Network. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/uk/subquery_network/about.md b/docs/uk/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/uk/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/uk/subquery_network/community.md b/docs/uk/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/uk/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/uk/subquery_network/fair-use.md b/docs/uk/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/uk/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/uk/subquery_network/faq.md b/docs/uk/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/uk/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/uk/subquery_network/glossary.md b/docs/uk/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/uk/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/uk/subquery_network/infra-changes.md b/docs/uk/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/uk/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/uk/subquery_network/parameters.md b/docs/uk/subquery_network/parameters.md new file mode 100644 index 00000000000..12dd446be84 --- /dev/null +++ b/docs/uk/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Описання | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/uk/subquery_network/welcome.md b/docs/uk/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/uk/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/vi/README.md b/docs/vi/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/vi/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/vi/miscellaneous/ambassadors.md b/docs/vi/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..97204f6bf20 --- /dev/null +++ b/docs/vi/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# Chương trình Đại sứ SubQuery + +![Hình ảnh Banner Đại sứ](/assets/img/ambassador_banner.png) + +Chúng tôi hiểu rằng, một trong những thế mạnh lớn nhất của chúng tôi là cộng đồng, và với sự hỗ trợ của bạn, chúng tôi mong muốn xây dựng và phát triển mạng lưới các đại sứ khu vực cho các cộng đồng trên toàn thế giới. + +[Đăng ký Ngay!](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## Điều chúng tôi tin tưởng + +Nhóm chúng tôi đã cùng nhau hợp tác với tầm nhìn chung là xây dựng nền tảng dịch vụ dữ liệu linh hoạt và toàn diện cho hệ sinh thái Polkadot. + +** Được xây dựng bởi các nhà phát triển, dành cho các nhà phát triển: ** SubQuery là một cộng đồng đang phát triển tập trung vào việc cung cấp các sản phẩm và dịch vụ tốt nhất cho các nhà phát triển và những người xây dựng trong hệ sinh thái của chúng tôi. Thành công của SubQuery phụ thuộc vào sự thành công của hệ sinh thái Polkadot, vì vậy mọi thứ chúng tôi làm đều hướng đến khách hàng của mình. + +** Chính trực và Trách nhiệm: ** Chúng tôi có các thành viên trong nhóm ở Auckland, Thượng Hải và Sydney và vì vậy làm việc từ xa là rất quan trọng đối với chúng tôi. Chúng tôi mong rằng cả nhóm luôn có động lực cùng nhau làm việc một cách tự chủ, độc lập để đạt được mục tiêu. Yêu cầu chính cho việc này là nhóm của chúng tôi phải chịu trách nhiệm về các hành động và duy trì tính nhất quán của họ. + +**Hướng dẫn và Hỗ trợ Toàn diện:** Blockchain là một lĩnh vực rất khó, và mọi người nhiều khi cần được hỗ trợ. Trong cộng đồng của chúng tôi, không có câu hỏi nào là ngu ngốc, tất cả mọi người trong nhóm đều có mong muốn hỗ trợ các người dùng. Chúng tôi tìm hiểu một số thông tin chi tiết có giá trị nhất về dịch vụ của chúng tôi (và cách chúng tôi có thể cải thiện nó) trực tiếp từ cộng đồng của chúng tôi. + +## Chương trình Đại sứ của Chúng tôi + +Mục đích chương trình Đại sứ SubQuery của chúng tôi là tìm kiếm các nhà lãnh đạo cộng đồng đam mê Polkadot và SubQuery. Chúng tôi là tìm kiếm những người luôn tự chủ và có thể quảng bá rộng rãi về SubQuery ở các khu vực mà họ đang sinh sống và hỗ trợ cho các nhà phát triển mới sử dụng SubQuery để xây dựng các ứng dụng và dịch vụ trên Polkadot. + +### Quyền lợi của Đại sứ + +Tại SubQuery, chúng tôi làm việc chăm chỉ để đạt được những gì chúng tôi mong muốn. Tương tự, các Đại sứ phải cam kết một thời gian khi tham gia nhóm của chúng tôi nhưng sẽ được thưởng bằng các quyền lợi. + +** Tài trợ và hỗ trợ: ** Bạn có thể được thưởng cho công việc tốt với cơ hội sớm tham gia private sale và tiền thưởng. Ngoài ra, chúng tôi sẽ cung cấp các khoản tài trợ để bạn tổ chức các buổi gặp mặt cộng đồng. + +**Quyền truy cập vào nhóm SubQuery:** Bạn sẽ có quyền truy cập trực tiếp vào core team của SubQuery và có cơ hội được đào tạo thực hành, tham gia AMA (giải đáp) độc quyền với các nhà lãnh đạo và nhà phát triển của chúng tôi, cũng như thông tin chi tiết về lộ trình phát triển của chúng tôi. + +** Phát triển mạng lưới: ** Mong đợi phát triển mạng lưới chuyên nghiệp của bạn bằng cách trở thành Đại sứ cho một trong những dự án Polkadot hàng đầu. Gặp gỡ các đại sứ khác trên khắp thế giới và nhận giới thiệu về các dự án Polkadot địa phương mà chúng tôi cần hỗ trợ tại địa phương. Bạn thậm chí có thể được vào cửa miễn phí để đại diện cho SubQuery trong các sự kiện ở khu vực địa phương của bạn. + +** Swag và những thứ miễn phí khác: ** Mọi người đều thích những thứ miễn phí! Nhận được phân bổ hàng năm của SubQuery swag sẽ khiến bạn nổi bật trong đám đông. Cộng với phân bổ bổ sung mà bạn có thể chia sẻ tại các sự kiện cộng đồng. Bạn cũng sẽ nhận được một NFT độc quyền cho tư cách Đại sứ của bạn. + +## Cách thực hoạt động của Chương trình + +Chương trình Đại sứ của chúng tôi có nhiều cấp, mỗi cấp có những lợi ích và khả năng khác nhau. Bạn có thể thăng hạng bằng cách tham gia vào các hoạt động của Đại sứ và làm việc chăm chỉ cho chúng tôi. + +Khi bạn đã gửi đơn đăng ký, chúng tôi sẽ chọn những ứng viên phù hợp với giá trị của chúng tôi. Nếu được chọn, bạn sẽ được đưa vào chương trình thực tập sinh của chúng tôi và sẽ nhận được một gói thông tin, mở rộng hiểu biết của bạn về SubQuery. Sau đó, bạn có thể bắt đầu làm việc thông qua chương trình thực tập sinh bằng cách hoàn thành một số nhiệm vụ nhập môn (ví dụ: tạo Dự án SubQuery). Chúng tôi sẽ tổ chức các hội thảo trong suốt quá trình này để hỗ trợ bạn. + +Sau khi vượt qua chương trình thực tập sinh, bạn có thể tự gọi mình là đại sứ SubQuery và sẽ được nhận vào chương trình đầy đủ của chúng tôi. Từ đây trở đi, bạn có thể tiếp tục công việc thông qua chương trình đại sứ và thăng hạng dần dần, kiếm thêm nhiều phần thưởng và quyền lợi với mỗi lần thăng hạng. + +## Các Hoạt động của Đại sứ + +Các Đại sứ SubQuery có thể đóng góp thông qua bốn lĩnh vực chính, bao gồm quản lý sự kiện, sáng tạo nội dung, dịch thuật và kiểm duyệt cộng đồng. Bạn có thể tham gia vào bao nhiêu lĩnh vực tùy thích, không bị ràng buộc vào bất kỳ lĩnh vực nào. + +**Quản lý sự kiện:** Xây dựng cộng đồng địa phương bằng cách chia sẻ, tổ chức và quản lý các sự kiện khác nhau. Xây dựng cộng đồng địa phương sẽ là một phần quan trọng trong việc phát triển cộng đồng SubQuery. SubQuery sẽ hỗ trợ bạn bằng cách cung cấp tài chính cho các sự kiện, gửi quà/hàng hóa để tặng, cũng như tham dự Q&A hoặc các sự kiện trực tuyến với tư cách là diễn giả hoặc trong các phiên AMA. + +**Sáng tạo nội dung:** Chúng tôi có một danh sách dài các nội dung và tài liệu hỗ trợ mà chúng tôi cần sự trợ giúp từ các bạn. Hãy nhớ rằng, thành công của chúng tôi dựa vào khả năng khách hàng có thể tạo ra những điều tuyệt vời trên dịch vụ của chúng tôi, vì vậy chúng tôi cần sự giúp đỡ của bạn để thực hiện điều đó dễ dàng hơn. Nội dung bao gồm video, đồ họa thông tin, hướng dẫn, hoạt ảnh hoặc bất kỳ tài liệu liên quan nào khác, để thông báo, giáo dục hoặc truyền cảm hứng cho các thành viên cộng đồng trong Hệ sinh thái SubQuery. SubQuery sẽ hỗ trợ Người sáng tạo nội dung bằng cách cung cấp tài sản và kiến ​​thức chuyên môn về thương hiệu. Chúng tôi cũng sẽ sử dụng các kênh tiếp thị của SubQuery để nâng cao nhận thức về nội dung của bạn (và chính bạn). + +**Dịch thuật:** Khách hàng của chúng tôi không chỉ nói tiếng Anh! Chúng tôi cần sự trợ giúp của bạn để làm cho SubQuery dễ tiếp cận hơn bằng cách dịch nội dung của chúng tôi sang ngôn ngữ của bạn, cũng như giúp chia sẻ chúng đến cộng đồng quốc tế của chúng tôi. + +**Kiểm duyệt cộng đồng:** Người kiểm duyệt sẽ giúp phát triển cộng đồng SubQuery bằng cách đảm bảo rằng các kênh cộng đồng chính thức hoạt động tích cực và gắn kết. SubQuery sẽ hỗ trợ Người kiểm duyệt bằng cách quảng bá các kênh mà họ quản lý cũng như cung cấp các hướng dẫn theo đúng với kỳ vọng. + +[Đăng ký Ngay!](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/vi/miscellaneous/branding.md b/docs/vi/miscellaneous/branding.md new file mode 100644 index 00000000000..ff712ffb103 --- /dev/null +++ b/docs/vi/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# Vật liệu xây dựng thương hiệu + +**Tất cả các đặc điểm thương hiệu của SubQuery là độc quyền và chúng tôi rất coi trọng thương hiệu của mình.** + +Nếu bạn chọn sử dụng bất kỳ nhãn hiệu, biểu tượng, thiết kế hoặc đặc điểm nhãn hiệu nào khác, vui lòng thực hiện nghiêm túc các hướng dẫn tại đây hoặc liên hệ với chúng tôi qua phương tiện truyền thông xã hội để được giải thích rõ. + +Nếu có thắc mắc, xin hãy đặt câu hỏi! + +## Gói tài sản thương hiệu + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/vi/miscellaneous/contributing.md b/docs/vi/miscellaneous/contributing.md new file mode 100644 index 00000000000..2971a021b33 --- /dev/null +++ b/docs/vi/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# Đóng góp cho SubQuery + +Chào mừng và chân thành cảm ơn bạn đã cân nhắc đóng góp cho dự án SubQuery! Cùng nhau, chúng ta có thể mở đường cho một tương lai phi tập trung hơn. + +::: tip Note This documentation is actively maintained by the SubQuery team. We welcome your contributions. You can do so by forking our GitHub project and making changes to all the documentation markdown files under the `docs` directory. ::: + +Sau đây là một tập hợp các nguyên tắc (không phải quy tắc) để đóng góp vào SubQuery. Following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing this project. In return, we will reciprocate that respect by addressing your issue, considering changes, collaborating on improvements, and helping you finalise your pull requests. + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## Quy tắc ứng xử + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## Bắt đầu + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- Tìm kiếm các Vấn đề và PR hiện có trước khi tự làm. +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. Đề cập @ thân thiện trong chuỗi nhận xét cho người gửi hoặc người đóng góp có thể giúp thu hút sự chú ý nếu vấn đề của bạn đang bị chặn. + +## Cách đóng góp + +### Báo cáo lỗi + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- Sử dụng tiêu đề rõ ràng và mang tính mô tả cho vấn đề để xác định vấn đề. +- Mô tả các bước chính xác để tái tạo vấn đề. +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- Bao gồm ảnh chụp màn hình nếu có thể. + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### Gửi Pull Requests + +In general, we follow the "fork-and-pull" Git workflow: + +- Fork the repository to your own Github account. +- Clone the project to your machine. +- Create a branch locally with a succinct but descriptive name. +- Commit changes to the branch. +- Following any formatting and testing guidelines specific to this repo. +- Push changes to your fork. +- Open a PR in our repository. + +## Quy ước mã hóa + +### Thông báo cam kết Git + +- Use the present tense ("Add feature" not "Added feature"). +- Use the imperative mood ("Move cursor to..." not "Moves cursor to..."). +- Limit the first line to 72 characters or less. + +### Hướng dẫn định kiểu JavaScript + +- All JavaScript code is linted with Prettier and ESLint. diff --git a/docs/vi/miscellaneous/social_media.md b/docs/vi/miscellaneous/social_media.md new file mode 100644 index 00000000000..ddf6f60d008 --- /dev/null +++ b/docs/vi/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# Liên kết truyền thông xã hội + +SubQuery là một dự án đang hoạt động nhằm duy trì và giao tiếp với những người theo dõi qua nhiều kênh truyền thông xã hội. + +Mục đích của chúng tôi là lắng nghe và tương tác với cộng đồng trung thành của mình, vì vậy hãy tham gia cuộc trò chuyện và gửi cho chúng tôi ý tưởng hoặc câu hỏi của bạn! + +## Cộng đồng SubQuery chính thức + +- [Linktree](https://linktr.ee/subquerynetwork) +- [ Discord ](https://discord.com/invite/subquery) (Cộng đồng chính với các kênh hỗ trợ kỹ thuật chuyên dụng) +- [Medium](https://subquery.medium.com) (Kênh thông báo chính) +- [Twitter](https://twitter.com/subquerynetwork) +- [ Telegram ](https://t.me/subquerynetwork) (Chỉ kênh thông báo) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## Cộng đồng SubQuery không chính thức + +Những cộng đồng này không được kiểm duyệt bởi đội ngũ SubQuery, nhưng các đại sứ của chúng tôi có thể ở đó để hỗ trợ. Hãy cẩn thận với các thủ đoạn lừa đảo vì SubQuery **không** chịu trách nhiệm về những gì xảy ra bởi những hành động này. + +- [Telegram (Chinese)](https://t.me/subquerychina) +- [Telegram (Russian)](https://t.me/SubQuery_russia) +- [Telegram (Spanish)](https://t.me/SubQueryES) +- [Telegram (Thai)](https://t.me/subquerynetworkthai) +- [Telegram (Turkish)](https://t.me/subquery_TR) +- [Telegram (Vietnamese)](https://t.me/subqueryvietnam) +- [Telegram (Vietnamese Announcement)](https://t.me/subqueryannvn) diff --git a/docs/vi/miscellaneous/vulnerability-reporting.md b/docs/vi/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/vi/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/vi/subquery_network/2024.md b/docs/vi/subquery_network/2024.md new file mode 100644 index 00000000000..3b99879288c --- /dev/null +++ b/docs/vi/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. Mã thông báo SubQuery (SQT) được thiết kế như một mã thông báo tiện ích cung cấp năng lượng cho Mạng SubQuery, cung cấp động lực cho sự tham gia, cũng như phục vụ như một phương tiện trao đổi cho các giao dịch trong Mạng SubQuery. Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/vi/subquery_network/about.md b/docs/vi/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/vi/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/vi/subquery_network/community.md b/docs/vi/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/vi/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/vi/subquery_network/fair-use.md b/docs/vi/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/vi/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/vi/subquery_network/faq.md b/docs/vi/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/vi/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/vi/subquery_network/glossary.md b/docs/vi/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/vi/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/vi/subquery_network/infra-changes.md b/docs/vi/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/vi/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/vi/subquery_network/parameters.md b/docs/vi/subquery_network/parameters.md new file mode 100644 index 00000000000..b3e01e4a26d --- /dev/null +++ b/docs/vi/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | Mô tả | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/vi/subquery_network/welcome.md b/docs/vi/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/vi/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ + diff --git a/docs/zh/README.md b/docs/zh/README.md new file mode 100644 index 00000000000..0126792da6f --- /dev/null +++ b/docs/zh/README.md @@ -0,0 +1,241 @@ +- - - +footer: false sidebar: false lastUpdated: false contributors: false editLink: false photoSwipe: false +- - - + + +
+ +
+ + +
+ + Indexer SDK +
+ Build with SubQuery's Indexer SDK + SubQuery is a fast, flexible, and reliable open-source data indexer + that provides you with custom APIs for your web3 project across all + of our supported chains. + +
+ +
+ + + + +
+ + AI Apps Framework +
+ Agentic AI with SubQuery's AI Apps + The AI App Framework allows you to build, deploy, and run agentic production AI apps on the SubQuery Network in a trusted and decentralised environment. +
+ +
+ + + + +
+ + SubQuery Network +
+ Decentralised Infra on the SubQuery Network + + Our decentralised infrastructure network revolutionises the web3 + landscape, providing both RPC and indexed data to consumers around + the world. +
+ +
+ + + +
+
+ Our Most Popular Guides +
+ + + {{ guide.title }} + {{ guide.description }} + + +
+
+
+ Start building on different chains +
+ + + + {{ + startWith.name + }} + + +
+
+ +
+
+ + diff --git a/docs/zh/miscellaneous/ambassadors.md b/docs/zh/miscellaneous/ambassadors.md new file mode 100644 index 00000000000..44d4ea4e6b7 --- /dev/null +++ b/docs/zh/miscellaneous/ambassadors.md @@ -0,0 +1,55 @@ +# 大使计划 + +![Ambassador Banner Image](/assets/img/ambassador_banner.png) + +我们认识到，我们的最大优势之一是我们的社区。 在你们的帮助下，我们想要发展和联系世界各地社区的地方大使。 + +[立即申请！](https://forms.gle/GXBbJ6LDpNfM2v1X6) + +## 我们相信 + +我们的团队共同愿景是为Polkadot生态系统建立一个更具灵活和包容性的数据服务基础设施。 + +**由开发人员构建，为开发人员服务**：SubQuery 是一个不断发展的社区，专注于为我们的开发人员和我们生态系统中的构建者提供最好的产品和服务。 只有 Polkadot 生态系统成功，SubQuery 才会成功，因此我们所做的一切都以客户为中心。 + +**诚信和责任：**我们在奥克兰、上海和悉尼都有团队成员，因此远程工作对我们很重要。 我们希望我们的团队拥有自主能力并自主合作以实现我们的目标。 对此的一个关键要求是让我们的团队对他们的行为负责并保持他们的诚信。 + +**包容性指导和支持：**区块链很复杂，每个人都有需要帮助的时刻。 在我们的社区中没有愚蠢的问题，我们团队中的每个人都应该帮助支持我们的用户。 我们直接从我们的社区中了解到一些关于我们的服务(以及我们如何改进它) 的最有价值的见解。 + +## 我们的大使计划 + +我们的 SubQuery 大使计划旨在寻找对 Polkadot 和 SubQuery 充满热情的社区领袖 。 我们正在寻找能够在当地传播有关 SubQuery 的信息并为希望使用 SubQuery 在 Polkadot 上构建出色应用程序和服务的新开发人员提供支持的具有内驱力的行动者。 + +### 大使福利 + +在SubQuery，我们努力实现我们的目标。 同样，我们也期待大使们在加入我们的团队时花费一些时间，他们会通过一些工作得到奖励。 + +**融资和支持：** 您可能会因为工作良好而得到奖励，有机会提前进入私募和奖励阶段。 此外，我们将为您提供资金以举办社区活动 + +**SubQuery 团队访问权限：** 您将具有直接访问SubQuery核心 团队的权限，并且有机会接受来自核心团队的亲自培训以及领导者和开发者举办的独家AMA，以便 能够对我们的项目计划进展有深刻的了解。 + +**网络发展：**通过成为顶级 Polkadot 项目之一的大使来发展您的专业人际网。 能够见到世界各地的其他大使，也能接收到当地的需要我们支持的波卡项目的介绍。 您甚至可以免费获得在当地活动中代表SubQuery出席的机会。 + +**交换和其他白嫖物品：**人人都喜欢白嫖！ 接收SubQuery每年分配的代币额度，这将使你在人群中脱颖而出。 另加您可以在社区活动中也可以赢取额外的代币额度。 您还将收到您的专属大使身份NFT。 + +## 运作模式 + +我们的大使方案有多个不同层级，每个层级都有不同的收益和能力要求。 你可以通过参加大使活动和为我们努力工作来提高等级。 + +一旦您通过应用申请资格，我们将选择符合SubQuery价值的候选人。 如果您被选中，您将被放置在我们的实习方案中，并将收到一个信息包，以增强您对 SubQuery 的理解。 在此之后，您可以通过实习方案完成某些在线任务(例如创建一个SubQuery项目)。 我们将在整个过程中进行专题讲解来支持你的工作。 + +一旦通过实习阶段，您就可以成为SubQuery大使，并将被纳入我们的全部方案。 从这里你可以继续向上晋升， 以此在你升高等级时赚取更多的奖励和报酬。 + +## 大使活动 + +SubQuery 大使需要通过四个主要领域做出贡献，包括活动管理、内容创建、翻译和社区管理。 你可以参与尽可能多的领域，而不是被绑定到任何单一方向。 + +**活动管理：** 通过主办、组织和管理不同的活动来建立本地社区。 建立一个地方社区将是扩大SubQuery社区的一个关键部分。 SubQuery 将为你举办的活动提供资金支持，或准备礼物与奖品， 还以发言者身份或在AMA会议上以及其他线上活动提供帮助。 + +**内容创建：** 我们有很长的内容和支持材料，我们需要你帮助创建。 记住，我们的成功取决于我们的用户能否在我们的服务中制造惊人的东西。 这样我们就需要你的帮助来使这更加容易实现。 内容包括视频、信息图表、教程、动画或任何其他相关材料，用于在SubQuery生态系统内宣传、教育或激励社区成员。 SubQuery 将通过提供品牌物件和专门知识来支持内容创建者。 我们还将使用 SubQuery 的营销渠道来提高对您的内容的认识(和您自己)。 + +**翻译：** 我们的客户不只是说英语！ 我们需要您的帮助，通过将我们的内容翻译成您自己的语言，使世界各地的人都更容易了解 SubQuery。 + +**社区管理：** 管理员将通过活跃官方社交平台的方式来帮助SubQuery社区的成长。 SubQuery将支持管理员发展他们管理的社交平台渠道，并为我们的目标提供指导方针。 + +[立即申请！](https://forms.gle/GXBbJ6LDpNfM2v1X6) diff --git a/docs/zh/miscellaneous/branding.md b/docs/zh/miscellaneous/branding.md new file mode 100644 index 00000000000..011587eaf67 --- /dev/null +++ b/docs/zh/miscellaneous/branding.md @@ -0,0 +1,11 @@ +# 品牌材料 + +**SubQuery 的所有品牌特性都是专有的，我们极为认真地对待我们的品牌。** + +如果您选择使用任何商标、徽标、设计或其他品牌功能，请仔细遵守此处的指导原则，或通过社交媒体联系我们以获得授权。 + +如果有疑问，请咨询！ + +## 品牌资源包 + +A smaller ZIP package of brand assets: [public_branding.zip](https://static.subquery.network/public-branding.zip). diff --git a/docs/zh/miscellaneous/contributing.md b/docs/zh/miscellaneous/contributing.md new file mode 100644 index 00000000000..729f6387343 --- /dev/null +++ b/docs/zh/miscellaneous/contributing.md @@ -0,0 +1,58 @@ +# 为SubQuery项目贡献代码 + +非常欢迎并感谢您考虑为SubQuery项目贡献时间和精力编写项目代码！ 让我们一起为更加去中心化的未来铺平道路。 + +::: tip Note This documentation is actively maintained by the SubQuery team. 我们欢迎您的意见 我们欢迎您为此做出贡献，您可以通过查看我们的GitHub项目并更改`docs`目录下的所有标记文件来实现这一点。 ::: + +下面是一套促进SubQuery发展的准则(而不是规则)。 遵循这些指导方针将有助于我们使作出贡献的进程对每一个参与者都是容易和有效的。 它还通知您同意尊重开发者管理和开发此项目的时间。 作为回报，我们将通过解决你的问题、考虑变化、协作改进以及帮助你完成你的拉请求来对付这种尊重。 + +::: info Contributing to the SubQuery Network There are specific contribution guidelines for the SubQuery Network [here](../subquery_network/community.md#contributing-to-codebases). ::: + +## 编程规约 + +We take our open source community projects and responsibility seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/subquery/subql/blob/main/CODE_OF_CONDUCT.md). + +## 快速入门 + +Contributions to our repositories are made through Issues and Pull Requests (PRs). A few general guidelines that cover both: + +- 在创建您自己之前先搜索现有的问题和PR。 +- We work hard to make sure issues are handled in promptly but, depending on the impact, it could take a while to investigate the root cause. 如果您遇到问题，可以在评论帖子中友情@提及提交者或贡献者获得帮助。 + +## 如何参与贡献 + +### 提交 bug + +Bugs are tracked as GitHub issues. When logging an issue, explain the problem and include additional details to help maintainers reproduce the problem: + +- **使用一个明确的和描述性的标题**\ 来描述问题。 +- 描述复制问题的确切步骤。 +- Describe the behaviour you observed after following the steps. +- Explain which behaviour you expected to see instead and why. +- 尽可能包括屏幕截图。 + +If it is a security issue, please review our documentation on [Vulnerability Reporting](./vulnerability-reporting.md) + +### 提交 Pull requests + +In general, we follow the "fork-and-pull" Git workflow: + +- 将repository 分派到您自己的 Github 帐户. +- 复制项目到您的设备. +- 以简洁但描述性的名称创建本地分支. +- 提交对项目的更改. +- 遵循原repo 的格式和测试准则. +- 将更改推送到你的账户中. +- 在 repository中打开一个Pull requests。 + +## 代码约定 + +### 提交消息 + +- 使用当前时态("去添加功能"而不是"添加过的功能"). +- 使用准确的代码时态("移动光标到..."而不是“移动光标到..."). +- 第一行限制为72个字符或更少字符. + +### JavaScript 样式表 + +- 所有 JavaScript 代码都与Prettier 和 ESLint 同调. diff --git a/docs/zh/miscellaneous/social_media.md b/docs/zh/miscellaneous/social_media.md new file mode 100644 index 00000000000..152114c1c17 --- /dev/null +++ b/docs/zh/miscellaneous/social_media.md @@ -0,0 +1,29 @@ +# 社交媒体链接 + +SubQuery 是一个活跃的项目，通过许多社交媒体与我们的用户保持联系和沟通。 + +我们希望倾听社区的声音，所以请加入社区并向我们发送您的想法或问题！ + +## SubQuery官方社区 + +- [链接](https://linktr.ee/subquerynetwork) +- [Discord](https://discord.com/invite/subquery) (拥有专业技术支持频道的主社区) +- [ Medium ](https://subquery.medium.com) (主要通知公告) +- [Twitter](https://twitter.com/subquerynetwork) +- [Telegram](https://t.me/subquerynetwork) (公告频道) +- [Telegram](https://t.me/subquerynetworkcommunity) (Community channel) +- [GitHub](https://github.com/subquery/) +- [Matrix/Riot](https://matrix.to/#/#subquery:matrix.org) +- [LinkedIn](https://www.linkedin.com/company/subquery) + +## SubQuery非官方社区 + +这些社区并不是由SubQuery团队搭建的，但我们的大使可能在那里提供支持。 请注意防骗，因为SubQuery **不** 负责它们内部发生的事情。 + +- [Telegram (Chinese)](https://t.me/subquerychina) +- [Telegram (Russian)](https://t.me/SubQuery_russia) +- [Telegram (Spanish)](https://t.me/SubQueryES) +- [Telegram (Thai)](https://t.me/subquerynetworkthai) +- [Telegram (Turkish)](https://t.me/subquery_TR) +- [Telegram (Vietname)](https://t.me/subqueryvietnam) +- [Telegram (Vietnamese Announcement)](https://t.me/subqueryannvn) diff --git a/docs/zh/miscellaneous/vulnerability-reporting.md b/docs/zh/miscellaneous/vulnerability-reporting.md new file mode 100644 index 00000000000..0a794f3d339 --- /dev/null +++ b/docs/zh/miscellaneous/vulnerability-reporting.md @@ -0,0 +1,52 @@ +# Vulnerability Reporting + +SubQuery welcomes security vulnerability reports from the public, and we do pay out bug bounties for responsibly reported issues and vulnerabilities + +## Scope + +While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. + +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a customer's codebase we will: + +- Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. +- If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). + +## Rules + +Before you start + +- Never attempt non-technical attacks such as social engineering, phishing, or physical attacks against our employees, users, or infrastructure. +- When in doubt, contact us at [privacy@subquery.network](mailto:privacy@subquery.network). +- By participating in SubQuery's vulnerability reporting program (the "Program"), you acknowledge that you have read and agree to SubQuery's [Terms of Service](https://subquery.network/terms) and [Privacy Policy](https://subquery.network/privacy) as well as the following: + - you are not currently a SubQuery employee or contractor, were not a SubQuery employee or contractor within six months prior to submission, and you did not collaborate on your submission with anyone who was. + - your participation in the Program will not violate any law applicable to you, or disrupt or compromise any data that is not your own. + - you are solely responsible for any applicable taxes, withholding or otherwise, arising from or relating to your participation in the Program, including from any bounty payments. + - SubQuery reserves the right to terminate or discontinue the Program at its discretion. + - Only test for vulnerabilities on sites you know to be operated by SubQuery and are in-scope. + - We cannot reward any individual on any U.S. sanctions list, or any individual residing in any U.S.-sanctioned country or region. + +## Performing your research + +- Do not impact other users with your testing, this includes testing vulnerabilities in accounts or workspaces that you do not own. If you are attempting to find an authorisation bypass, you must use accounts you own. +- If you intend to perform load testing, please notify us before hand at [privacy@subquery.network](mailto:privacy@subquery.network) +- The following are **never** allowed and are ineligible for reward: + - Performing distributed denial of service (DDoS) or other volumetric attacks + - Spamming content + - Large-scale vulnerability scanners, scrapers, or automated tools which produce excessive amounts of traffic. + +## Handling personally identifiable information (PII) + +- Personally identifying information (PII) includes legal and/or full names, or email addresses +- Do not intentionally access others' PII. If you suspect a vulnerability provides access to PII, limit queries to your own personal information. +- Report the vulnerability _immediately_ and do not attempt to access any other data. The SubQuery Security team will assess the scope and impact of the PII exposure. +- Limit the amount of data returned from services. For SQL injection, for example, limit the number of rows returned +- You must delete all your local, stored, or cached copies of data containing PII as soon as possible. We may ask you to sign a certificate of deletion and confidentiality agreement regarding the exact information you accessed. This agreement will not affect your bounty reward. +- We may ask you for the usernames and IP addresses used during your testing to assess the impact of the vulnerability + +##  Reporting your vulnerability + +- Please email [privacy@subquery.network](mailto:privacy@subquery.network) with all submissions +- Submissions must include written instructions for reproducing the vulnerability. Submissions without clear reproduction steps or which only include reproduction steps in video form may be ineligible for a reward. +- When reporting vulnerabilities you must keep all information private. Please refrain from posting information to video-sharing or pastebin sites. +- For vulnerabilities involving personally identifiable information, please explain the kind of PII you believe is exposed and limit the amount of PII data included in your submissions. For textual information and screenshots, please only include redacted data in your submission. +- During the course of an investigation, it may take time to resolve the issue you have reported. We ask that you refrain from publicly disclosing details regarding an issue you've reported until the fix has been publicly made available. diff --git a/docs/zh/subquery_network/2024.md b/docs/zh/subquery_network/2024.md new file mode 100644 index 00000000000..9ea2cd7f617 --- /dev/null +++ b/docs/zh/subquery_network/2024.md @@ -0,0 +1,62 @@ +# 2024 in Review: SubQuery’s Top 5 Milestones + +As we look back on 2024, we’re proud to call it a major “year of firsts” for us here at SubQuery. This year was filled with groundbreaking achievements, major launches, and remarkable community growth. The year has flown by but it also feels so long ago that we had our TGE, CEX Listing and SubQuery Network mainnet launch - all on the same day! + +Let’s celebrate some of the key milestones that made 2024 unforgettable. + +## 1. Mainnet Launch + +After an extremely successful Public Sale on 30 January 2024, selling out of SubQuery’s native token (SQT) in less than 2 hours, we worked very hard to launch the SubQuery Network mainnet on 23 February 2024. Powered by SQT and launched on Base, immediately users could consume and/or index data from over 150 networks ([now over 270 networks](https://subquery.network/networks)). + +Almost 1 year on and we have: + +- 46 globally distributed and highly skilled Node Operators servicing the network +- More than 330 million SQT staked and delegated in the Network +- Serving more than 50 million RPC requests every day +- An overall average APY of 22.28% and much higher for Node Operators (94.66%) + +## 2. SQT Token Generation Event + +Combined with the Mainnet launch, we ambitiously chose to do our TGE and day one CEX listing with Bybit on the same day (23 February 2024) as well. 我们的目标是将SQT作为SubQuery网络的通证经济，提供参与激励，并作为SubQuery网络内交易的交换媒介。 Consumers of data commit SQT in exchange for RPC queries or indexed data from our globally distributed Node Operators. + +Today, you can acquire SQT through any of these centralised exchange: + +- [Bybit](https://www.bybit.com/en/trade/spot/SQT/USDT) +- [Gate.io](https://www.gate.io/trade/SQT_USDT) +- [Crypto.com](https://crypto.com/exchange/trade/SQT_USD) +- [MEXC](https://www.mexc.com/exchange/SQT_USDT) + +SQT is on a number of DEX Pools however most liquidity is on Uniswap. + +- [Uniswap Pool on Ethereum](https://app.uniswap.org/explore/tokens/ethereum/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85) +- [Unsiwap Pool on Base](https://app.uniswap.org/explore/tokens/base/0x858c50c3af1913b0e849afdb74617388a1a5340d) + +## 3. Expansion into Decentralised RPCs + +This vision was announced at the end of 2023 but really came to fruition in 2024. We expanded our network capabilities by introducing support for Remote Procedure Call (RPC) services. This was the first step of expanding away from just a data indexer to a major decentralised infrastructure network, allowing us to support a more accessible, interoperable, and developer-friendly web3 ecosystem. + +Now serving RPC requests on 20+ networks, [get your decentralised RPCs from the SubQuery Network today](https://subquery.network/rpc/list/). + +### 4\. Launching Artificial Intelligence Tools + +SubQuery took its first steps into the AI space by launching decentralised AI inference model hosting on the SubQuery Network plus a new developer SDK called the AI App Framework. This massively expands the tools and services that we can offer to web3 builders across, all under one roof. + +The AI App Framework allows you to build, deploy, and run production AI apps on the SubQuery Network in a trusted and decentralised environment. AI apps are self-contained and easily scalable AI agents that you can use to power your intelligent applications. They are sandboxed to a trusted runner and can be easily distributed and scaled horizontally across the SubQuery Network. + +[Start building AI Apps today!](https://academy.subquery.network/ai/welcome.html) + +## 5. SubQuery Rebranding + +As we expanded into the Artificial Intelligence space, we felt a new look was warranted to match our new pursuit. So we rebranded to a complete new look with sleek chromatic details and a flower/root narrative. + +The flower and root theme symbolises SubQuery’s commitment to fostering innovation and growth within the blockchain community. The roots represent the deep, stable, and reliable infrastructure that SubQuery provides, while the flowers symbolise the diverse and vibrant dApps that developers can create with the help of this infrastructure. + +[Check out the new look](https://subquery.network/). + +## Looking Ahead to 2025 + +While 2024 was full of exciting milestones, we know this is just the beginning. With a stronger community, enhanced technology, and bold new goals, we’re ready to scale even greater heights in 2025. With our most recent [2024 roadmap](https://blog.subquery.network/subquery-releases-network-roadmap-for-2024/?lng=en) almost fully accomplished, stay tuned for a new version packed with ambitious plans. + +Thank you to everyone—developers, partners, and community members—who helped make this year possible. + +Here’s to many more firsts ahead! \ No newline at end of file diff --git a/docs/zh/subquery_network/about.md b/docs/zh/subquery_network/about.md new file mode 100644 index 00000000000..1699165773b --- /dev/null +++ b/docs/zh/subquery_network/about.md @@ -0,0 +1,47 @@ +# About Us + +Our mission is to innovate Web3 infrastructure so builders can decentralise the next generation of applications - without compromise. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we power Web3's transition to an open, efficient and user-centric future.Join us on our journey to build the future of web3 infrastructure. + +[Join our Discord Community](https://discord.com/invite/subquery) + +## Core team + +SubQuery has a deep bench of highly skilled talent of engineers, customer service, and operations personnel.Headquartered in Singapore, we have key representation in New Zealand, Lisbon, and Sydney. + +### Ian He - CTO and Co-Founder + +Ian forged his interest in blockchain during his tenure as the Technical Team Lead for Centrality where he led the development of core components of CENNZnet. Ian also led a team that won 2nd place in the world's first Substrate/Polkadot Hackathon in 2019. Prior to this, Ian obtained significant experience working on large-scale infrastructure working for Alipay and Yihaodian.com. + +### Scott Twiname - Principal Dev of SDK + +Scott has a large wealth of experience in blockchain development. He started out learning about blockchain in his own time and eventually got the opportunity to apply his knowledge as a senior developer at Sylo. He has worked on all facets of blockchain development from smart contracts, dapps, decentralised technologies and wallet integration for various networks including Bitcoin, Ethereum, Tezos and CENNZnet. + +### Marta Adamczyk - Head of Business Development + +Marta is a huge tech advocate, Web3 enthusiast and IT-meetup addict. She helps SubQuery customers develop and scale their projects by delivering technical consultancy, developer-oriented content and technical education. Former product evangelist, frontend developer, digital marketer, educator and sales manager with corporate and start-up experience. + +### Brittany Seales - Head of Marketing + +Brittany has a background in chemistry but since then she became the closest point of contact with SubQuery customers and helped ensure that every SubQuery customer gets an excellent on-boarding experience. Naturally Brittany is heavily integrated with the community and content marketing and has since taken over this area. Sadly, no amount of interaction with successful blockchain projects has give her the ability to pick a winning NFT! + +### James Bayly - Advisor + +Well-versed across the business, from product engineering to being the face of SubQuery, James is also a serial entrepreneur leading several tech companies. When he’s not in Berlin sipping cocktails, you’ll find him hiking up the Routeburn Track in New Zealand. + +## Our Manifesto + +In the new era of Web3, true power isn't bought – it's built with innovation and vision. +We are SubQuery, not just a company, but a revolution. Our mission: to lead the charge in decentralising the future. +We're pioneering an infrastructure that's fast, flexible, scalable – ready to power tomorrow's Web3 world. Crafting an open, efficient, and user-centric digital landscape. +For the visionaries, the forward-thinkers, the builders of tomorrow – SubQuery is your platform. +Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. Let's shape the future of Web3, together. + +## About SubQuery + +SubQuery Network is innovating in web3 infrastructure with tools that empower builders to decentralise without compromise. SubQuery’s infrastructure network offers everything from data indexers, RPCs and AI agents - all fully decentralised and production ready. + +Our fast, flexible, and open data indexer supercharges thousands of dApps on nearly 300 networks. Our Sharded Data Node will provide breakthroughs in the RPC industry and our AI App framework makes building AI apps easier than ever before. We pioneer the web3 revolution for visionaries and forward-thinkers. We’re not just a company — we’re a movement driving an inclusive and decentralised web3 era, together. + +[Linktree](https://linktr.ee/subquerynetwork) | [Website](https://subquery.network) | [Discord](https://discord.com/invite/subquery) | [Telegram](https://t.me/subquerynetworkcommunity) | [Twitter](https://twitter.com/subquerynetwork) | [Blog](https://blog.subquery.network/?lng=en) | [Medium](https://medium.com/@subquery) | [LinkedIn](https://www.linkedin.com/company/subquery) | [YouTube](https://www.youtube.com/c/SubQueryNetwork) \ No newline at end of file diff --git a/docs/zh/subquery_network/community.md b/docs/zh/subquery_network/community.md new file mode 100644 index 00000000000..59c4aaeb078 --- /dev/null +++ b/docs/zh/subquery_network/community.md @@ -0,0 +1,178 @@ +# SubQuery Network Community + +The key focus of the [SubQuery Foundation](./governance/foundation.md) and community is to ensure that there is enough support that anyone, from an expert blockchain team to a new hobbyist developer, can build their own Project. Together we can pave the way to a more decentralised future! + +## Connecting with others + +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. + +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! + +### Join the Node Operator community + +If you're a Node Operator on the Network, we strongly suggest that you keep up with the latest news, announcements, and tips by joining the following Discord channels: + +- `#network-announcements` +- `#network-general` +- `#network-services-release` +- `#network-indexer-announcements` +- `#network-indexer-general` + +## Contributing to Codebases + +SubQuery is open source and open to the community, if you want to contribute (e.g. add a feature, fix a bug, suggest an improvement, or even just fix a typo in our documentation), please review our [contributing guide](../miscellaneous/contributing.md). + +The following codebases are where you can find code for all the contracts, applications, and backend SubQuery projects. We're looking forward to seeing your contributions! + +### `network-app` + +dApp for indexers, consumers and delegators interact with SubQuery Network. + + + +### `network-airdrop-app` + +dApp for users to interact with the SubQuery airdrop contract. + + + +### `network-contracts` + +Contracts for SubQuery Network. + + + +You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json) + +### `network-app-backend` + +SubQuery project for the backend of the SubQuery App. + + + +### `network-airdrop-app-backend` + +SubQuery project for the backend of the SubQuery Airdrop App. + + + +### `network-swap-app-backend` + +SubQuery project for the backend of the SubQuery Swap App. + + + +### `network-indexer-services` + +Services that Indexers run to connect and serve data to the SubQuery Network. + + + +### `network-clients` + +Client SDKs for SubQuery Network. + + + +### `subquery-component-library` + +React UI component library for SubQuery dApps. + + + +## Community Tools + +There are a number of community built tools that you can use to help your SubQuery Network experience. Feel free to contribute your own. + +:::warning +Please note that none of these tools have been endorsed by the SubQuery team and descriptions have been written by third parties. This section is open for contribution by all. + +Please research and use at your own risk +::: + +### SQTScan + +[SQTScan](https://sqtscan.com/?ref=blog.subquery.network) is a ***community-owned application*** designed specifically to help expert users such as Node Operators and Delegators to gain a deeper understanding of historical rewards on the SubQuery Network and optimise their participation. + +SQT Scan helps expert users (Node Operators and Delegators) with: + +1. **Education:** Understand how their rewards are calculated and how they should make decisions +2. **Compare Opportunities:** Decide which projects to deploy based on historical rewards +3. **Compare Others:** Compare their APY with other Node Operators, overall and by project, to see how they're performing relatively +4. **APY Maximisation:** Identify ways to increase their APY + +If you would like to add your support, suggest improvements or new features, or even contribute code, it is welcomed! + +Links + +- [SQTSCan](https://sqtscan.com) +- [Github](https://github.com/HuberTRoy/subquery-sqtscan) + +### Indexer Monitoring Tools (by web3cdn.network) + +Five products: +1. **Toolkit:** A toolkit contains everything you need to index, monitor and properly access from any device +2. **Telegram Uptime Bot:** Eagle Eye is a bot which will provide you live updates in Telegram on the uptime of your indexer +3. **UpdateHunter** +4. **Snapshots** +5. **Snapshots Toolkit** + +Toolkit Features: + +- Extended monitoring of all indexer parameters, sync time, balances, issues. Metrics also support Alerting rules +- Flags problems that have arisen through monitoring and help you to not miss rewards. +- Makes your indexer and infrastructure secure +- Ease of updating without the risk of changing important parameters +- Secured access to dangerous zone with your own VPN, Access from mobile devices to monitoring, and internal services in any time. +- Very easy installation and user error protection + +Eagle Eye Telegram Bot Notifications: + +- Provide reports on your indexer's uptime - help you to know about an errors in advance and not lose funds. +- If your indexer is offline +- If your project is somehow unavailable +- If you do not have enough funds +- If your certificate is about to expire +- And more + +UpdateHunter: + + - A tool that notifies you when a project is updated or a new project is created, providing complete documentation to enable fast and secure upgrades. + - It scans the blockchain and alerts an indexer via a Telegram channel about updates, automati­cally generating instructions and SQL queries. + - The bot integrates with GitHub, posting documentation updates to a public repository. + + Snapshots: + + - Service generates daily snapshots for all active projects + - This service is ideal if your indexer: + - Is newly deployed and you want to avoid ~1 month of downtime for project synchronization + - Has experienced data loss (corrupted disk, hardware failures, or software issues) + + Snapshots Toolkit: + + - Open Source toolkit for an own snapshot generator. With this repository indexer can generate its own snapshots. + +Links + +- [Toolkit Github](https://toolkit.subquery.dev/) +- [Eagle Eye Telegram Bot](https://eagleeye.subquery.dev/) +- [UpdateHunter](https://eagleeye.subquery.dev/updates) +- [Snapshots](https://snapshots.subquery.dev/) +- [Snapshots Toolkit](https://snapshots.subquery.dev/toolkit) + +### Kepler Network Dashboard (by DappLooker) + +To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics: + +- Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network. +- Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week. +- Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week. +- Stake Distribution: The distribution of kSQT stakes between Indexers and Delegators on the Kepler Network. + +To make the data more accessible and user-friendly, DappLooker has also made the SubQuery Kepler data publicly available for everyone. This means that anyone can create custom dashboards tailored to their needs using the indexed data from the Kepler Network. + +Links + +- [Dashboard](https://dapplooker.com/dashboard/subquery-kepler-network-dashboard-577) +- [Indexed Dataset](https://analytics.dapplooker.com/browse/2/schema/subquery_kepler) +- [Announcement Article](https://blog.dapplooker.com/dapplooker-integrates-subquery-kepler-network-to-provide-analytics-and-dashboard-solution-to-web3-fb0c5aeea899) diff --git a/docs/zh/subquery_network/fair-use.md b/docs/zh/subquery_network/fair-use.md new file mode 100644 index 00000000000..5ef96de4b0b --- /dev/null +++ b/docs/zh/subquery_network/fair-use.md @@ -0,0 +1,48 @@ +# Network Fair Use Principles + +This is a non-exhaustive list of “fair use” rules and polices that all participants in the SubQuery Network should abide by. It shall be applied with impartial judgement by the SubQuery Council, and it is intended that these rules and polices are applied evenly and fairly to all participants. + +Any changes to these rules and policies require a SMP proposal from the SubQuery Council to be ratified. + +## Rule 1 - No Unfair Collusion + +Participants should not work together or collude in a way that: + +1. Is designed to get around restrictions or other fair use policies; or +2. Reduces the competitiveness of the network as a whole or in terms of an individual project deployment. + +## Rule 2 - All Projects Should be Publicly Indexable + +SubQuery Network ideally runs public projects, where the source RPC dataset is open-source and in most cases there is a publicly available RPC that any indexer can sync from. In addition, SubQuery’s indexing SDK is designed to be deterministic, that is any indexer can sync it using a publicly available RPC endpoint and have an exact mirror of the data to be able to serve to the network. + +In summary, indexing a project should be permissionless. + +Although the SubQuery Network supports non-deterministic or non-public project, the Foundation reserves the right to remove projects that don’t meet both of these criteria if: + +1. These projects are being boosted or run in a way that results in significant network allocation rewards; or +2. There is evidence of collusion on these projects (see [Rule 1](#rule-1---no-unfair-collusion)). + +## Rule 3 - Falsifying Project Health Checks + +Node Operators should never falsify [Proof of Indexing](./introduction/proof-of-index.md), health checks or responses to common request (e.g. project metadata requests or current block height). These requests and health checks should always reach the actual node and represent the true state of the node. + +If the Foundation detects that Node Operator is falsifying [PoI](./introduction/proof-of-index.md), request data, health checks, or any other commonly requested data to make their endpoint perform in a deceiving way, penalties will be severe. + +## Rule 4 - No Unfair Project Boosting + +The purpose of boosting a project is mainly for two reasons + +1. Increase allocation rewards to a given project and so the reward is large enough to attract Node Operators to service it; or +2. Receive boost query rewards and so consumers can later query the project for free. + +Node Operators should not boost projects that they are syncing, or collude with others to boost their projects unfairly (see [Rule 1](#rule-1---no-unfair-collusion)). + +Boosters should not boost outsized amounts of tokens towards a single project, more than what a reasonable boost amount should be (compared to other projects). + +## Rule 5 - Public RPC Endpoint + +Usage of the Public RPC endpoints is subject to the terms described in [Terms of Service of SubQuery Network Public RPCs](https://subquery.foundation/public-rpc-terms). The Foundation may amend these Terms from time to time by posting the updated policy on our Website and/or Platform. Any changes that the Foundation makes will be posted on [this](https://subquery.foundation/public-rpc-terms) page and, where appropriate, notified to to end users by e-mail or post. + +## Changelog + +1. 2023-07-14 Initial commit from [SMP-2](https://forum.subquery.network/t/smp-2-draft-subquery-network-fair-use-policy/544) diff --git a/docs/zh/subquery_network/faq.md b/docs/zh/subquery_network/faq.md new file mode 100644 index 00000000000..a298d22efe5 --- /dev/null +++ b/docs/zh/subquery_network/faq.md @@ -0,0 +1,78 @@ +# Frequently Asked Questions + +FAQs for specific network participants: + +- [Node Operators](./node_operators/setup/faq.md) +- [Consumers](./consumers/faq.md) + +## Proof-of-indexing + +[Proof Of Index](./introduction/proof-of-index.md) + +## How do you ensure indexed data accuracy? + +Ensured by [Proof Of Index](./introduction/proof-of-index.md) + +## Are there a list of RPC providers that can provide support for \_\_\_ chain? + +SubQuery Network is decentralised, so we can't say what individual node operators would decide to serve you, nor can we say what infrastructure the node operators use and where it is hosted + +## What is the integration and deployment timeline for RPCs? + +SubQuery team can enable the RPC in a few days depending on how long an archive node on your network would take to sync. + +## Where is your/provider's infra hosted? + +Depends on the provider, SubQuery don't dictate this. But SubQuery gateway encourages competition to provide high performance, low latency, and geographically decentralised services. Most providers are running on their own bare metal for cost considerations + +## Is there a testnet environment? + +Yes, be sure to check https://dev.thechaindata.com/ + +## Is there a meaning behind SubQuery's name? + +The name "SubQuery" refers to its function in the blockchain ecosystem. A subquery is essentially a query within another query, allowing users to access data more efficiently. It is a powerful tool for indexing and querying blockchain data. + +## What was the first network that SubQuery first supported? + +SubQuery initially supported the Polkadot network, focusing on indexing and querying data for the Polkadot and its parachains. + +## How many networks do SubQuery support now? + +As of now, SubQuery supports multiple networks, including Polkadot, Kusama, Ethereum, and many others, expanding its reach to a wide array of blockchain ecosystems. + +## How does SubQuery improve blockchain data access? + +SubQuery enhances blockchain data access by providing an indexing layer that aggregates and organizes data from blockchain networks. This allows developers and applications to quickly retrieve and interact with data in a structured and efficient manner. + +## How does SubQuery differ from traditional block explorers? + +Traditional block explorers allow users to explore blockchain data in a static, non-queryable format. SubQuery, on the other hand, provides dynamic and customizable data querying, giving developers the ability to filter, process, and retrieve data in real-time for their applications. + +## What programming languages does SubQuery support? + +SubQuery primarily supports JavaScript and TypeScript for building queries and processing data. Developers can use these languages to define the structure and logic for data retrieval from supported networks. + +## Is SubQuery open-source? + +Yes, SubQuery is open-source. It encourages developers to contribute to its growth and use its tools to build decentralized applications (dApps) more efficiently. The source code is available on GitHub. + +## What are the main use cases for SubQuery? + +SubQuery is used for various purposes, such as: + +- Building decentralized applications (dApps) that need to access blockchain data. +- Indexing and querying blockchain data for analysis and reporting. +- Creating custom data solutions for blockchain ecosystems and decentralized finance (DeFi) platforms. + +## Can I deploy SubQuery on my own infrastructure? + +Yes, SubQuery can be deployed on your own infrastructure, whether on-premise or in the cloud. It offers flexibility to users who want complete control over their indexing and querying solutions. + +## How does SubQuery handle data updates and changes? + +SubQuery continuously updates its data by monitoring blockchain events in real-time. This ensures that the indexed data is always up to date, and any changes to the blockchain are reflected immediately in the data queries. + +## How can I get started with SubQuery? + +To get started with SubQuery, you can visit their official documentation, which provides step-by-step guides on setting up a project, writing queries, and deploying them on supported networks. The community also offers support through forums and Discord. diff --git a/docs/zh/subquery_network/glossary.md b/docs/zh/subquery_network/glossary.md new file mode 100644 index 00000000000..a3551670f77 --- /dev/null +++ b/docs/zh/subquery_network/glossary.md @@ -0,0 +1,83 @@ +# Glossary + +# Network + +![terminology](/assets/img/glossary/terminology.png) + +## **Service Agreements** + +A Service Agreement is a mutual agreement between the Consumers and Indexers on how the transactions will take place and how the services will be delivered. + +The Service Agreement ensures transparency between both parties. It includes details as given below: + +- Project Name and the Network Name +- Version - Deployment Id of the project +- The id of the Consumer +- The id of the Indexer +- When the project expires +- Query URL +- The price that the consumer will pay to the indexer for delivering the service(rewards will be in SQT) + +Read more about the two types of Service Agreements(Closed and Open Market) [here](../subquery_network/introduction/payment-methods.md) + +## **Allocating** + +Act of an Indexer assigning SQT to a given project. + +### **Reallocating** + +A combined operation of removing staked tokens from one project and immediately associating that with another project (comes into effect at the end of the next Era). This is represented/expressed as a percentage of the indexer’s bonded SQT. + +## **Bonding** + +Act of depositing SQT into a global staking contract performed by either an Indexer or a Delegator. + +### **Unbonding** + +Act of an Indexer or a Delegator withdrawing SQT from the global staking contract. + +This is effectively a transfer of SQT from the global staking contract to the Indexer’s or Delegator’s wallet. In other words, this can be thought of as the Indexer or Delegator withdrawing part or all of their stake. Note that a lock period applies when tokens are unbonded. + +## **Delegating** + +Act of a Delegator assigning SQT into the global staking contract and then assigning SQT to an Indexer. Note that delegating and bonding are atomic operations. + +## **Undelegating** + +Act of withdrawing SQT from an Indexer at the end of an Era and then withdrawing that SQT from the global staking contract to a wallet address. This is subject to a lock period. + +## **Redelegating** + +Act of a Delegator reassigning SQT from one Indexer to another Indexer. Redelegating does not require tokens to be undelegated and is queued to take effect at the end of the Era. + +## **Staking** + +Act of an Indexer assigning tokens in a global staking contract and into the Indexer’s own contract. + +## **Unstaking** + +Act of an Indexer withdrawing their SQT. This triggers a 28 day “lock period”. Indexer can restake to cancel this process and return their lock period tokens to the staking contract. + +## **Restaking** + +Act of Indexer restaking SQT during the lock period to return locked period tokens to the staking contract. + +--- + +## **Contract Ratio** + +The sum of daily contracts value (defined as contract value/period) cannot exceed a ratio with their total stake (indexer + delegator). + +## **Era** + +A period or duration of time where configurations and settings remain constant and calculations take place. For example, during an Era: + +- the Indexer Commission Rate cannot be changed during an Era. + +## **Indexer Delegation Ratio** + +The amount an Indexer can “borrow” or leverage from Delegators. This ratio is yet to be determined. + +## **Lock period** + +A period where tokens are unbonded awaiting withdrawal. During this period, tokens do not earn any rewards. Currently, the lock period is defined as 28 days. diff --git a/docs/zh/subquery_network/infra-changes.md b/docs/zh/subquery_network/infra-changes.md new file mode 100644 index 00000000000..b30b5fa306d --- /dev/null +++ b/docs/zh/subquery_network/infra-changes.md @@ -0,0 +1,109 @@ +# Redefining Web3: SubQuery Network’s Bold Infrastructure Evolution + +Back in December 2023, we announced the evolution of SubQuery, in which we aim to transition from simply indexing web3 data to pioneering a complete web3 infrastructure revolution. + +Over the last year, as we’ve been building out our data indexing service and network, we realised our network is in a prime position to address broader centralisation issues throughout the web3 infrastructure landscape. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. + +Read on to learn about the challenges we’re taking on and the next steps we’re taking to play a bigger role in decentralising the future. + +### The Web3 Infrastructure Landscape + +Web3 middleware services like indexers, RPCs, oracles and storage services are pivotal in blockchain dApp development. In fact, the utilisation of these middleware services is what sets apart successful, large-scale, production dApps - they accelerate performance and can scale to thousands of users, while providing a superior developer experience to bring in more users, TVL, and value. Indexers and RPCs shoulder the heavy lifting, standing as mission-critical services that underpin the functionality and efficiency of web3 applications. + +![](https://lh7-us.googleusercontent.com/2lbQyLR4fxrgV2dTqljyFV6bECXrfq3anA2k_qM6gJuWdSN01dHrVjIFU6OZeFXXJv57dwaXNQ6_lKdGtLK9YDWr0EdS7yDDv0BwZfFXT_j6aw-iu7bDxIS5ZkgliPD2mY_l5kbJXGKEqI6OWuZIEwk) + +**The current segregated web3 infrastructure landscape** + +Data indexers (like SubQuery) speed up data retrieval, enhancing performance and response times for users. They also simplify data by transforming raw blockchain information into more digestible formats, facilitating efficient development and a smooth user experience. + +Meanwhile, RPCs are pivotal for communication between blockchain nodes and external entities, facilitating data retrieval, smart contract interactions, and transaction submissions. Under the hood of your favourite dApp, tens of requests are passing through RPC providers to query and submit transactions to the network. + +While these middleware services are integral to a successful dApp, there is a significant issue that needs to be addressed. + +### Web3’s Dirty Little Secret + +There is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is that many leading dApps have a significant reliance on centralised middleware components. This centralisation poses a substantial threat to the envisioned unstoppability of a web3 future, at any given moment, a single entity can undermine supposedly decentralised applications. + +Nowhere is this more apparent with RPC providers, and to a lesser extent, data indexers. These crucial services distinguish the scalable, reliable, and polished dApps from rudimentary applications that go without. But due to historical challenges in the process of decentralisation, for a long time, this has been a compromise most apps have accepted. + +The call for decentralised alternatives to these pivotal middleware services is essential for the foundation of the next generation of dApps to build upon. We need to decentralise these services, without compromise. + +### SubQuery Network Evolution Revealed + +At the start we set out to create a viable decentralised solution to the data indexing problem. + +Web3 developers face great difficulties aggregating and organising data to power dApps, and SubQuery has helped thousands of developers building the world's best and biggest networks, dApps, and analytics tools by providing fast and performant data indexing. + +In 2022 we launched Kepler Network, a pre-mainnet release that enabled us to bootstrap the network sustainably by bringing onboard proficient indexers and projects. The success of Kepler lead to the realisation that the ecosystem we’ve built could bring benefits for more than just decentralised data indexing, but for middleware infrastructure as a whole. The key components of the network we have built and deployed - reward and pricing rails, service verification tools, and dispute resolution processes - are valuable for others verticals. + +Knowing that the SubQuery Network could give our existing community of top node runners a solution to trustlessly receive rewards for running data indexing infrastructure, why couldn’t it work for those other services, for other parts of the dApp tech stack? + +We realised the full potential of the SubQuery Network mainnet should not be limited to just data indexing; its fundamental contracts, tools, and reward flows enable it to be so much more. By harnessing the power of the existing participants and mechanisms, the SubQuery Network is ready to extend to various infrastructure verticals. It dawned on us that there is a massive opportunity ahead of us when we think holistically about the entire developer experience. + +> With the launch of mainnet, the SubQuery Network will emerge as a solution to _decentralise everything_, revolutionising the entire developer experience in web3. + +![](https://lh7-us.googleusercontent.com/fXK85pf2n1zTFAsbxyhYKk4I_negGP3mNvXP_vE-_k-ppDlNQeCUPc-iKG7b2HjaeBaisWhkdDqPL8SoQb0QHW6eHI4-5Bra1GK7hrfIhzx9SW1SWgVJ9Nces5Vfza3fwYNug_nduW_8HJ-XB8eZwig) + +**The vision for SubQuery Network to encompass key web3 infrastructure components in a completely decentralised manner** + +### Starting with RPCs + +Our next step that we have completed is to decentralise the biggest infrastructure component for dApps - _Remote Procedure Call_ or RPC services. + +RPC services are still the main interface to the blockchain, under the hood of your favourite dApp, dozens of requests are passing through RPC providers to query and submit transactions to the network. They are the most critical part of the ecosystem, when one has an outage, [the effects reverberate across the industry](https://decrypt.co/47846/ethereum-backbone-infura-suffers-major-damage?ref=blog.subquery.network). + +Since SubQuery relies on performant and scalable RPCs to maximise our indexing speed, we already work extremely closely with RPC providers. On our quest to index over [115+ chains and counting](https://subquery.network/networks?ref=blog.subquery.network), we’ve discovered that the RPC ecosystem is very fractured: some ecosystems have excellent support, and some don’t, and that makes delivering an excellent indexing experience across all chains difficult. + +Across many smaller emergent networks, amateur RPC services operate to provide RPCs to various developers building on the network. These RPCs are usually run (at a loss) by the core network foundation team, and perhaps a collection of validators (for staking advertising purposes). Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited, and have no upsell options for unrestricted access. As a result, dApp developers will often run a private RPC endpoint for their own use. This is expensive, frustrating, poses high barriers to entry, and results in no redundancy for dApp developers. + +For more established networks, one or more commercial providers may come and offer a freemium service, where there is a free plan/public endpoint, and a paid upsell to higher scale access. This serves dApp developers well, but the law of economies of scale dictate that networks tend towards a small number of hyperscale RPC providers who centralise the network and cause major outages that affect thousands of dApps when they go offline. They also extract huge economic value from a network and send that directly to big private cloud companies and VCs. + +We have built an alternative to these two dangerous equilibriums, and help decentralise everything.The SubQuery Network provides an open market for both data indexers and RPC providers and their consumers that: + +- Maintains low barriers of entry: Any node operator can join as a provider for any service on any network. +- Incentivises performance and cost: Node operators are automatically rewarded with requests based on these metrics, driving these values across the network. +- Encourages constant expansion to new chains: Node operators are free to onboard new chains and projects for first mover advantage, constantly expanding the network. + +### Enhancing RPCs - SubQuery’s Data Node + +The performance limitations of data indexers and many other applications have long been limited by the RPC endpoint. Developers have long focussed on building nodes to ensure efficient validation to ensure the safety of the network. As a result of this sacrifice, RPCs are extremely costly and they’re not at all optimised for querying. + +This is compounded by the rise of L2 chains where, with higher throughput, the query performance and cost are major outstanding issues to address. With limited querying capabilities, many don’t support complex querying languages or operations, making it inefficient to retrieve specific data. + +We have delivered the SubQuery Data Node, an enhanced and heavily-forked RPC node that is perfectly optimised for querying, especially on endpoints like `eth_getLog`, and the ability to filter transactions in a single API call. + +The Data Node is open source, allowing people to contribute, extend, or fork the implementation in any way. It supports leading layer-2s and other EVM networks initially, and they are optimised to run on the SubQuery Network in a decentralised way. + +Working together, the SubQuery Indexer and SubQuery Data Node provides the most performant indexing performance possible and in a completely decentralised way thanks to the SubQuery Network. + +Our node runners are able to run these data nodes on the network, bringing powerful and cost-effective RPC access to all, cementing SubQuery’s position as the fastest decentralised data indexer in web3. + +### Democratising RPCs - SubQuery’s Sharded Data Node + +In the final stage of our RPC journey, SubQuery will work to democratise RPCs (and solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network)) in the process by delivering the Sharded Data Node, which will make RPCs cheaper to run and operate by node providers. + +In the last few months we’ve spoken with many RPC providers in the ecosystem. In many networks (in particular Cosmos), small scale RPC services operate to provide RPCs to various developers building on the network. Unfortunately for cost reasons, these RPCs are usually heavily pruned and rate limited and have no upsell options for unrestricted access. + +One of the key reasons for this is the sheer size of the node - an Ethereum archive requires about ~12 TB on Geth, an Osmosis archive is at least the same. This is an incredible cost that limits these nodes to large centralised infrastructure providers. + +SubQuery recognises that in order to decentralised RPCs correctly, you need to be able to make running these nodes easier and more accessible to everyday users. Currently the storage is made smaller by “pruning” data, which is intentionally discarding older information while cryptographically confirming that the recent data that is valid. This works fine for writing transactions, but means that indexers and other services are unable to query old data. + +SubQuery will extend its Data Node to support sharding, that is making each Data Node smaller by splitting up block ranges between node operators. Since SubQuery’s Data Node only runs within the boundaries of a specific block range, it does not need to constantly sync new data, allowing it to optimise further for query performance rather than validation and verification. + +The SubQuery Sharded node won’t just shard historical data, but also shard the historical state within the node. By itself, this won’t change much, but these sharded nodes will be optimised to run on the network, and the network will be designed to combine all these shards to expose a single unified endpoint that appears to cover the entire historical state of the chain. Developers will benefit from the entire historical state of the given network, and node operators will benefit from significantly lower running costs, creating a more cost efficient network. + +This is a revolutionary step forward for the RPC industry, and a potential solution to one of the great challenges facing older and larger blockchains with their state bloat size. This solution has the potential to help scale Ethereum, solve [EIP-4444](https://eips.ethereum.org/EIPS/eip-4444?ref=blog.subquery.network), and greatly support proliferation of Layer-2’s and rollups, while further democratising and decentralising the SubQuery Network. + +### Summary + +The future of SubQuery is not simply indexing web3 data, but pioneering a complete web3 infrastructure revolution. web3 middleware services like indexers and RPC providers are pivotal in blockchain dApp development, but there is a hidden truth behind the mask of “decentralisation” most of these middleware services wear. The reality is a significant reliance on centralised middleware components, which poses a substantial threat to the envisioned unstoppability of a web3 future. + +Our mission has expanded, and so has the opportunity space we’re going to be working in. We need to decentralise these services, without compromise. We’ve already delivered breakthroughs in decentralised data indexing, but our next steps will focus on enhancing the performance of RPCs with the SubQuery Data Node, and then to bring RPCs to the masses, with SubQuery’s Sharded Data Nodes. These steps together, will help unlock the next level of performance increases in web3. + +No other team today is better equipped at working to provide a holistic approach to solving this problem. In summary, our vision goes beyond data indexing; it's about revolutionising how data and infrastructure services are organised and accessed. + +Pioneering fast, flexible, and scalable decentralised infrastructure, we will help power web3's transition to an open, efficient and user-centric future. Join us in this journey. With SubQuery, it's not just about building for today, but architecting a decentralised, inclusive future. + +_Let's shape the future of web3, together._ \ No newline at end of file diff --git a/docs/zh/subquery_network/parameters.md b/docs/zh/subquery_network/parameters.md new file mode 100644 index 00000000000..c22d330b073 --- /dev/null +++ b/docs/zh/subquery_network/parameters.md @@ -0,0 +1,16 @@ +# Current Network Parameters + +The SubQuery technical council is constantly adjusting various parameters of the SubQuery Network to optimise for APR and sustainability, while ensuring prices are competitive compared to centralised alternatives. This page lists all the current network parameters and is kept up to date. + +| Parameter | Value | 描述 | +| -------------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Era Length | 7 days | See [Era](./introduction/era.md) | +| Minimum Node Operator Stake | 200,000 SQT | All Node Operators must stake a minimum amount of SQT to become a Node Operator. See [Node Operator Stake](./node_operators/stake.md). | +| Delegation Capacity | 12x | There is a maximum allowed delegation amount based on the size of the Node Operator's own stake, this ensures the Node Operator has sufficient skin in the game. Increasing own stake can mean delegators are able to delegate more to you. 12x means that the total stake (delegation + own stake) can be up to 12x the Node Operators own stake. | +| Network Inflation Rate | 1.2% | New tokens minted and allocated to [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), or distributed to the SubQuery treasury. | +| Network Inflation Rewards Rate | 1% | The majority of network inflation acts as [network inflation rewards](./introduction/reward-distribution.md#network-inflation-rewards), while the remainder (0.2%) goes to the SubQuery Treasury | +| Staking/Delegation Unlock Period | 14 days | How long SQT is locked when it is unstaked or undelegated. Note that you can skip this period if you instead redelegate. | +| Staking/Delegation Unlock Fee | 0.1% | The network fee to unstake or undelegate your SQT | +| Dispute Deposit | 10,000 SQT | The minimum amount to open up a network dispute. | +| Offer Cancellation Penalty Rate | 10% | When a consumer cancels an unexpired purchase offer, this penalty is taken from the offer and sent to the SubQuery treasury. | +| Minimum Deployment Booster | 1,000 SQT | The minimum boost amount that must be boosted against a project deployment in order for the project deployment to start receiving booster rewards. | diff --git a/docs/zh/subquery_network/welcome.md b/docs/zh/subquery_network/welcome.md new file mode 100644 index 00000000000..53c14ae9c38 --- /dev/null +++ b/docs/zh/subquery_network/welcome.md @@ -0,0 +1,283 @@ +--- +footer: false +lastUpdated: false +contributors: false +editLink: false +photoSwipe: false +--- + + +
+
+
+ SubQuery Network + + The SubQuery Network is the most scalable, reliable, and unified data infrastructure network. 1,000s of decentralised Indexers and RPC providers simplify the data layer for a myriad of applications and use cases. + +
+
+
+ +
+
+ + + One network, all your web3 data needs + +
+ +
+ + {{ item.title }} + {{ item.subtitle }} + + {{ content }} + + + + + + +
+ +
+ Anyone can participate + + There’s a role for everyone in the network, from highly technical + developers to those with some experience and blockchain beginners. Find + out how you can participate and be rewarded. + +
+
+ + {{ anyone.name }} + + {{ anyone.description }} + + + + +
+
+ + +
+ Get Started with the Network Today + Our decentralised network is live and vibrant +
+ + + {{ item.title }} + + {{ item.desc }} + + + +
+
+ + +
+
+ +