Deploying > Как использовать Subgraph Studio

Как использовать Subgraph Studio

Reading time: 5 min

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

Subgraph Studio - это ваше место для создания подграфов, добавления метаданных и публикации их в новом децентрализованном Explorer (подробнее об этом здесь).

Что вы можете сделать в Subgraph Studio:

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

В Subgraph Studio у вас есть полный контроль над вашими подграфами. Вы можете не только тестировать свои подграфы перед их публикацией, но и ограничивать свои API-ключи конкретными доменами и разрешать определенным индексаторам запрашивать запросы только с их API-ключей.

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

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

Как создать свою учетную запись

Ссылка на этот раздел
  1. Войдите в систему с помощью своего кошелька - вы можете сделать это через MetaMask или Wallet Connect
  2. Как только вы войдете в систему, вы увидите свой уникальный ключ на домашней странице вашей учетной записи. Это позволит вам либо публиковать свои подграфы, либо управлять ключами API + биллингом. У вас будет уникальный ключ, который можно восстановить, если вы считаете, что он был скомпрометирован.

How to Create a Subgraph in Subgraph Studio

Ссылка на этот раздел

Совместимость подграфов с сетью Graph

Ссылка на этот раздел

Сеть Graph пока не может поддерживать все доступные в Hosted Service источники информации и функции. Для того чтобы индексаторы в сети поддерживали подграфы, они должны:

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

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

Жизненный цикл подграфа

Ссылка на этот раздел

Жизненный цикл подграфа

После того как вы создадите свой подграф, вы сможете развернуть его, используя CLI, или интерфейс командной строки. Развертывание подграфа с помощью CLI отправит подграф в Studio, где вы сможете протестировать подграфы с помощью тестовой площадки. В конечном итоге это позволит вам публиковать их в сети The Graph. Для получения дополнительной информации о настройке CLI, ознакомьтесь с этим (после публикации убедитесь, что у вас есть ключ под рукой). Помните, что развертывание - это ** не то же самое, что** публикация. Когда вы развертываете подграф, вы просто отправляете его в Studio, где вы можете его протестировать. Напротив, когда вы публикуете подграф, вы публикуете его в сети.

Тестирование вашего подграфа в Subgraph Studio

Ссылка на этот раздел

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

Публикация вашего подграфа в Subgraph Studio

Ссылка на этот раздел

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

Чтобы успешно опубликовать свой подграф, вам необходимо выполнить следующие шаги, описанные в этом блоге.

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

Помните, что в процессе публикации вы сможете публиковать свои данные либо в основной сети, либо в сети Sepolia. Если вы впервые разрабатываете подграф, мы настоятельно рекомендуем вам начать с публикации в сети Sepolia, которая является бесплатной. Это позволит вам увидеть, как подграф будет работать в The Graph Explorer, и даст возможность протестировать элементы кураторства.

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

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

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

Управление версиями вашего подграфа с помощью CLI

Ссылка на этот раздел

Разработчики могут захотеть обновить свой подграф по разным причинам. В таком случае вы можете развернуть новую версию вашего подграфа в Studio с помощью CLI (на данный момент она будет только приватной) и, если она вас устраивает, вы можете опубликовать эту новую версию в The Graph Explorer. Это создаст новую версию вашего подграфа, которую кураторы смогут начать сигнализировать, а индексаторы смогут индексировать эту новую версию.

Вплоть до недавнего времени разработчики были вынуждены развертывать и публиковать новую версию своего подграфа в эксплорере, чтобы обновить метаданные своих подграфов. Теперь разработчики могут обновлять метаданные своих подграфов ** без необходимости публиковать новую версию**. Разработчики могут обновить сведения о своих подграфах в Studio (под изображением профиля, именем, описанием и т. д.), установив флажок Update Details в Graph Explorer. Если этот флажок установлен, будет сгенерирована транзакция внутри сети, которая обновляет сведения о подграфе в эксплорере без необходимости публикации новой версии с новым развертыванием.

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

Автоматическое архивирование версий подграфа

Ссылка на этот раздел

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

Subgraph Studio - Разархивирование

Редактировать страницу

Предыдущий
Часто задаваемые вопросы о субграфах, работающих на основе субпотоков (Substreams)
Следующий
Развертывание подграфа в Subgraph Studio
Редактировать страницу