4 minutes
Deploying Using Subgraph Studio
Узнайте, как развернуть свой субграф в Subgraph Studio.
Note: When you deploy a subgraph, you push it to Subgraph Studio, where you’ll be able to test it. It’s important to remember that deploying is not the same as publishing. When you publish a subgraph, you’re publishing it onchain.
Обзор Subgraph Studio
В Subgraph Studio Вы можете выполнять следующие действия:
- Просматривать список созданных Вами субграфов
- Управлять, просматривать детали и визуализировать статус конкретного субграфа
- Создание и управление ключами API для определенных подграфов
- Ограничивать использование своих API-ключей определенными доменами и разрешать только определенным индексаторам выполнять запросы с их помощью
- Создавать свой субграф
- Развертывать свой субграф, используя The Graph CLI
- Тестировать свой субграф в тестовой среде Playground
- Интегрировать свой субграф на стадии разработки, используя URL запроса разработки
- Публиковать свой субграф в The Graph Network
- Управлять своими платежами
Установка The Graph CLI
Перед развертыванием необходимо установить The Graph CLI.
Для использования The Graph CLI у Вас должны быть установлены Node.js и менеджер пакетов на Ваш выбор (npm, yarn или pnpm). Проверьте у себя наличие самой последней версии CLI.
Установка с помощью yarn
yarn global add @graphprotocol/graph-cliУстановка с помощью npm
npm install -g @graphprotocol/graph-cliНачнем
- Откройте Subgraph Studio.
- Подключите свой кошелек для входа.
- Вы можете это сделать через MetaMask, Coinbase Wallet, WalletConnect или Safe.
- После входа в систему Ваш уникальный ключ развертывания будет отображаться на странице сведений о Вашем субграфе.
- Ключ развертывания позволяет публиковать субграфы, а также управлять вашими API-ключами и оплатой. Он уникален, но может быть восстановлен, если Вы подозреваете, что он был взломан.
Важно: для выполнения запросов к субграфам необходим API-ключ
How to Create a Subgraph in Subgraph Studio
For additional written detail, review the Quick Start.
Совместимость подграфов с сетью Graph
In order to be supported by Indexers on The Graph Network, subgraphs must:
- Index a supported network
- Не должны использовать ни одну из следующих функций:
- ipfs.cat & ipfs.map
- Нефатальные ошибки
- Grafting
Инициализация Вашего Субграфа
После создания субграфа в Subgraph Studio Вы можете инициализировать его код через CLI с помощью следующей команды:
graph init <SUBGRAPH_SLUG>Значение <SUBGRAPH_SLUG> можно найти на странице сведений о субграфе в Subgraph Studio, см. изображение ниже:
После запуска graph init Вам будет предложено ввести адрес контракта, сеть и ABI, которые Вы хотите запросить. Это приведет к созданию новой папки на Вашем локальном компьютере с базовым кодом для начала работы над субграфом. Затем Вы можете завершить работу над своим субграфом, чтобы убедиться, что он функционирует должным образом.
Аутентификация в Graph
Прежде чем Вы сможете развернуть свой субграф в Subgraph Studio, Вам будет необходимо войти в свою учетную запись в CLI. Для этого Вам понадобится ключ развертывания, который Вы сможете найти на странице сведений о субграфе.
После этого используйте следующую команду для аутентификации через CLI:
graph auth <DEPLOY KEY>Развертывание субграфа
Когда будете готовы, Вы сможете развернуть свой субграф в Subgraph Studio.
Развертывание субграфа с помощью CLI отправляет его в Studio, где Вы сможете протестировать его и обновить метаданные. Это действие не приводит к публикации субграфа в децентрализованной сети.
Используйте следующую команду CLI для развертывания своего субграфа:
graph deploy <SUBGRAPH_SLUG>После выполнения этой команды CLI запросит метку версии.
- Настоятельно рекомендуется использовать semver для управления версиями типа
0.0.1. При этом Вы можете выбрать любую строку в качестве версии, например:v1,version1илиasdf. - Созданные вами метки будут видны в Graph Explorer, и кураторы смогут использовать их для принятия решения, сигнализировать на определенную версию или нет, поэтому выбирайте метки с умом.
Тестирование Вашего субграфа
После развертывания Вы можете протестировать свой субграф (в Subgraph Studio или в собственном приложении, используя URL-адрес запроса на развертывание), развернуть другую версию, обновить метаданные и, когда будете готовы, опубликовать в Graph Explorer.
Используйте Subgraph Studio, чтобы проверить логи на панели управления и обнаружить возможные ошибки в своем субграфе.
Публикация Вашего субграфа
In order to publish your subgraph successfully, review publishing a subgraph.
Управление версиями Вашего субграфа с помощью CLI
Если Вы хотите обновить свой субграф, Вы можете сделать следующее:
- Вы можете развернуть новую версию в Studio, используя CLI (на этом этапе она будет только приватной).
- Если результат Вас устроит, Вы можете опубликовать новое развертывание в Graph Explorer.
- Это действие создаст новую версию вашего субграфа, о которой Кураторы смогут начать сигнализировать, а Индексаторы — индексировать.
You can also update your subgraph’s metadata without publishing a new version. You can update your subgraph details in Studio (under the profile picture, name, description, etc.) by checking an option called Update Details in Graph Explorer. If this is checked, an onchain transaction will be generated that updates subgraph details in Explorer without having to publish a new version with a new deployment.
Note: There are costs associated with publishing a new version of a subgraph to the network. In addition to the transaction fees, you must also fund a part of the curation tax on the auto-migrating signal. You cannot publish a new version of your subgraph if Curators have not signaled on it. For more information, please read more here.
Автоматическое архивирование версий подграфа
Каждый раз, когда Вы развертываете новую версию субграфа в Subgraph Studio, предыдущая версия архивируется. Архивированные версии не будут проиндексированы/синхронизированы и, следовательно, их нельзя будет запросить. Вы можете разархивировать архивированную версию своего субграфа в Subgraph Studio.
Примечание: предыдущие версии непубликованных субграфов, развернутых в Studio, будут автоматически архивированы.
