diff --git a/docs/bos/community/indexers.md b/docs/bos/community/indexers.md index fc8722a81ac..1cd34724e07 100644 --- a/docs/bos/community/indexers.md +++ b/docs/bos/community/indexers.md @@ -10,6 +10,14 @@ With QueryAPI you can quickly create your own indexer by: * Specifying the schema for your own custom hosted database and write to it with your indexer function; * Retrieving that data through a GraphQL API. +:::info + +NEAR QueryAPI is currently under development. Users who want to test-drive this solution need to be added to the allowlist before creating or forking QueryAPI indexers. + +You can request access through [this link](https://near.org/dev-queryapi.dataplatform.near/widget/NearQueryApi) or by contacting us in the [Near Indexer Builder Group](https://nearbuilders.com/tg-data) on Telegram. + +::: + ### How it Works This works by: @@ -22,13 +30,13 @@ You can access the [NEAR QueryAPI by following this link](https://near.org/datap This should take you to a dashboard that looks like this: -![QueryAPI Dashboard](./assets/QAPIScreen.png) +![QueryAPI Dashboard](/docs/assets/QAPIScreen.png) ## Creating an Indexer Clicking on "Create New Indexer" will redirect you in-browser to a Component code editor that looks like this: -![QueryAPI Indexer Dashboard](./assets/QAPIScreen2.png) +![QueryAPI Indexer Dashboard](/docs/assets/QAPIScreen2.png) This is the interface through which you can create a new Indexer. On here you can specify: @@ -83,7 +91,7 @@ await context.graphql(` Creating these queries within strings can be very difficult, especially considering that the table names vary depending on your indexer name and account ID. An easier way to do this would be by visiting the GraphQL Playground site and creating the queries there. You can then copy and paste them into your `indexingLogic.js` file as shown below: -![Alt Text](./assets/QAPIScreen.gif) +![Alt Text](/docs/assets/QAPIScreen.gif) ::: diff --git a/docs/bos/tutorial/indexer-tutorials/feed-indexer.md b/docs/bos/tutorial/indexer-tutorials/feed-indexer.md index aebf56825d4..4a265658dca 100644 --- a/docs/bos/tutorial/indexer-tutorials/feed-indexer.md +++ b/docs/bos/tutorial/indexer-tutorials/feed-indexer.md @@ -4,7 +4,13 @@ title: BOS Feed Indexer sidebar_label: BOS Feed Indexer --- -This indexer can be found by [following this link](https://near.org/#/dataplatform.near/widget/QueryApi.App?selectedIndexerPath=roshaan.near/feed-indexer&view=editor-window). +:::info + +NEAR QueryAPI is currently under development. Users who want to test-drive this solution need to be added to the allowlist before creating or forking QueryAPI indexers. + +You can request access through [this link](https://near.org/dev-queryapi.dataplatform.near/widget/NearQueryApi) or by contacting us in the [Near Indexer Builder Group](https://nearbuilders.com/tg-data) on Telegram. + +::: ## Running `feed-indexer` @@ -16,6 +22,12 @@ The indexer `indexingLogic.js` is comprised of functions that help handle, trans A schema is also specified for the tables in which data from relevant transactions is to be persisted, this can be found in the `schema.sql` tab. +:::tip + +This indexer can be found by [following this link](https://near.org/dataplatform.near/widget/QueryApi.App?selectedIndexerPath=dataplatform.near/social_feed&view=editor-window). + +::: + ## Schema Definition :::note diff --git a/docs/bos/tutorial/indexer-tutorials/hype-indexer.md b/docs/bos/tutorial/indexer-tutorials/hype-indexer.md index 64c6acaff38..e8a2cf85fa7 100644 --- a/docs/bos/tutorial/indexer-tutorials/hype-indexer.md +++ b/docs/bos/tutorial/indexer-tutorials/hype-indexer.md @@ -4,12 +4,24 @@ title: Hype Indexer sidebar_label: Hype Indexer --- -This indexer can be found by [following this link](https://near.org/dataplatform.near/widget/QueryApi.App?selectedIndexerPath=somepublicaddress.near/hypeindexer&view=indexer-status). +:::info + +NEAR QueryAPI is currently under development. Users who want to test-drive this solution need to be added to the allowlist before creating or forking QueryAPI indexers. + +You can request access through [this link](https://near.org/dev-queryapi.dataplatform.near/widget/NearQueryApi) or by contacting us in the [Near Indexer Builder Group](https://nearbuilders.com/tg-data) on Telegram. + +::: ## Overview This indexer creates a new row in a pre-defined `posts` or `comments` table created by the user in the GraphQL database for every new post or comment found on the blockchain that contains either "PEPE" or "DOGE" in the contents. This is a simple example that shows how to specify two tables, filter blockchain transaction data for a specific type of transaction and its contents, and save the data to the database. +:::tip + +This indexer can be found by [following this link](https://near.org/dataplatform.near/widget/QueryApi.App?selectedIndexerPath=somepublicaddress.near/hypeindexer&view=indexer-status). + +::: + ## Defining the Database Schema The first step to creating an indexer is to define the database schema. This is done by editing the `schema.sql` file in the code editor. The schema for this indexer looks like this: diff --git a/docs/bos/tutorial/indexer-tutorials/posts-indexer.md b/docs/bos/tutorial/indexer-tutorials/posts-indexer.md index f89e8d21667..6923778e9a3 100644 --- a/docs/bos/tutorial/indexer-tutorials/posts-indexer.md +++ b/docs/bos/tutorial/indexer-tutorials/posts-indexer.md @@ -4,12 +4,24 @@ title: Posts Indexer sidebar_label: Posts Indexer --- -This indexer can be found by [following this link](https://near.org/dataplatform.near/widget/QueryApi.App?selectedIndexerPath=somepublicaddress.near/postsexample&view=indexer-status). +:::info + +NEAR QueryAPI is currently under development. Users who want to test-drive this solution need to be added to the allowlist before creating or forking QueryAPI indexers. + +You can request access through [this link](https://near.org/dev-queryapi.dataplatform.near/widget/NearQueryApi) or by contacting us in the [Near Indexer Builder Group](https://nearbuilders.com/tg-data) on Telegram. + +::: ## Overview This indexer creates a new row in a pre-defined `posts` table created by the user in the GraphQL database for every new post found on the blockchain. This is a simple example that shows how to specify a single table, filter blockchain transaction data for a specific type of transaction, and save the data to the database. +:::tip + +This indexer can be found by [following this link](https://near.org/dataplatform.near/widget/QueryApi.App?selectedIndexerPath=somepublicaddress.near/postsexample&view=indexer-status). + +::: + ## Defining the Database Schema The first step to creating an indexer is to define the database schema. This is done by editing the `schema.sql` file in the code editor. The schema for this indexer looks like this: diff --git a/docs/bos/community/assets/QAPIScreen.gif b/website/static/docs/assets/QAPIScreen.gif similarity index 100% rename from docs/bos/community/assets/QAPIScreen.gif rename to website/static/docs/assets/QAPIScreen.gif diff --git a/docs/bos/community/assets/QAPIScreen.png b/website/static/docs/assets/QAPIScreen.png similarity index 100% rename from docs/bos/community/assets/QAPIScreen.png rename to website/static/docs/assets/QAPIScreen.png diff --git a/docs/bos/community/assets/QAPIScreen2.png b/website/static/docs/assets/QAPIScreen2.png similarity index 100% rename from docs/bos/community/assets/QAPIScreen2.png rename to website/static/docs/assets/QAPIScreen2.png