How to Use Subgraph Studio

Reading time: 5 min

Добро пожаловать на вашу новую пусковую площадку 👩🏽‍🚀

Subgraph Studio is your place to build and create subgraphs, add metadata, and publish them to the new decentralized Explorer (more on that here).

What you can do in Subgraph Studio:

• Создать подграф с помощью Studio UI
• Развернуть подграф с помощью CLI
• Опубликовать подграф с помощью Studio UI
• Протестировать это на тестовой площадке
• Интегрировать его в промежуточный этап, используя URL-адрес запроса
• Создание и управление ключами API для определенных подграфов

Here in Subgraph Studio, you have full control over your subgraphs. Not only can you test your subgraphs before you publish them, but you can also restrict your API keys to specific domains and only allow certain Indexers to query from their API keys.

Запросы к подграфам генерируют плату за запросы, которая используется для вознаграждения индексаторов в сети Graph. Если вы являетесь разработчиком dapp или разработчиком подграфов, Studio поможет вам создать лучшие подграфы для обеспечения запросов для вас или вашего сообщества. Studio состоит из 5 основных частей:

• Элементы управления вашей учетной записью пользователя
• Список созданных вами подграфов
• Раздел для управления, просмотра подробностей и визуализации статуса конкретного подграфа
• Раздел для управления API ключами, которые понадобятся для выполнения запросов к подграфу
• Раздел для управления биллингом

1. Sign in with your wallet - you can do this via MetaMask, WalletConnect, Coinbase Wallet or Safe.
2. Как только вы войдете в систему, вы увидите свой уникальный ключ на домашней странице вашей учетной записи. Это позволит вам либо публиковать свои подграфы, либо управлять ключами API + биллингом. У вас будет уникальный ключ, который можно восстановить, если вы считаете, что он был скомпрометирован.

In order to be supported by Indexers on The Graph Network, subgraphs must:

• Индексировать поддерживаемую сеть
• Не должны использовать ни одну из следующих функций:
  • ipfs.cat & ipfs.map
  • Неисправимые ошибки
  • Grafting

Дополнительные функции и сети будут добавляться в сеть The Graph постепенно.

After you have created your subgraph, you will be able to deploy it using the CLI, or command-line interface. Deploying a subgraph with the CLI will push the subgraph to the Studio where you’ll be able to test subgraphs using the playground. This will eventually allow you to publish to the Graph Network. For more information on CLI setup, check this out (psst, make sure you have your deploy key on hand). Remember, deploying is not the same as publishing. When you deploy a subgraph, you just push it to the Studio where you’re able to test it. Versus, when you publish a subgraph, you are publishing it on-chain.

Если вы хотите протестировать ваш подграф перед публикацией в сети, вы можете сделать это в ** Subgraph Playground** или просмотреть свои логи. Логи подграфа сообщат вам, где ваш подграф терпит неудачу в том случае, если это произойдет.

Вы зашли так далеко - поздравляю!

In order to publish your subgraph successfully, you’ll need to go through the following steps outlined in this section.

Ознакомьтесь также с видео обзором ниже:

Remember, while you’re going through your publishing flow, you’ll be able to push to either Arbitrum One or Arbitrum Sepolia. If you’re a first-time subgraph developer, we highly suggest you start with publishing to Arbitrum Sepolia, which is free to do. This will allow you to see how the subgraph will work in Graph Explorer and will allow you to test curation elements.

Индексаторы должны предоставить Proof of Indexing записей по определенному хэшу блока. Поскольку публикация подграфа - это действие, выполняемое внутри сети, помните, что транзакция может занять до нескольких минут. Любой адрес, который вы используете для публикации контракта, будет единственным, способным публиковать будущие версии. Выбирайте с умом!

Подграфы с кураторским сигналом показываются индексаторам, чтобы они могли быть проиндексированы в децентрализованной сети. Вы можете публиковать подграфы и сигнал в одной транзакции, что позволяет вам минтить первый сигнал кураторства на подграф и экономить на стоимости газа. Добавляя свой сигнал к сигналам, позже предоставленным кураторами, ваш подграф также будет иметь более высокие шансы на конечное обслуживание запросов.

Теперь, когда вы опубликовали свой подграф, давайте разберемся, как управлять им на регулярной основе. Обратите внимание, что вы не можете опубликовать свой подграф в сеть, если он не прошел синхронизацию. Обычно это происходит потому, что в подграфе есть ошибки - журналы покажут вам, где эти проблемы имеются!

Developers might want to update their subgraph, for a variety of reasons. When this is the case, you can deploy a new version of your subgraph to the Studio using the CLI (it will only be private at this point) and if you are happy with it, you can publish this new deployment to Graph Explorer. This will create a new version of your subgraph that curators can start signaling on and Indexers will be able to index this new version.

Up until recently, developers were forced to deploy and publish a new version of their subgraph to the Explorer to update the metadata of their subgraphs. Now, developers can update the metadata of their subgraphs without having to publish a new version. Developers can update their subgraph details in the Studio (under the profile picture, name, description, etc) by checking an option called Update Details in Graph Explorer. If this is checked, an on-chain transaction will be generated that updates subgraph details in the Explorer without having to publish a new version with a new deployment.

Обратите внимание, что публикация новой версии подграфа в сети связана с определенными расходами. Помимо платы за транзакции, разработчики должны также оплачивать часть сбора за кураторство по сигналу автоматической миграции. Вы не можете опубликовать новую версию своего подграфа, если кураторы не подали на него сигнал. Подробнее о рисках кураторства читайте здесь.

Whenever you deploy a new subgraph version in Subgraph Studio, the previous version will be archived. Archived versions won't be indexed/synced and therefore cannot be queried. You can unarchive an archived version of your subgraph in the Studio UI. Please note that previous versions of non-published subgraphs deployed to the Studio will be automatically archived.