Развертывание с использованием Subgraph Studio
Reading time: 4 min
Узнайте, как развернуть свой субграф в Subgraph Studio.
Примечание: При развертывании субграфа Вы отправляете его в Subgraph Studio, где сможете его протестировать. Важно помнить, что развертывание — это не то же самое, что публикация. При публикации субграфа Вы размещаете его на чейне.
В Вы можете выполнять следующие действия:
- Просматривать список созданных Вами субграфов
- Управлять, просматривать детали и визуализировать статус конкретного субграфа
- Создание и управление ключами API для определенных подграфов
- Ограничивать использование своих API-ключей определенными доменами и разрешать только определенным индексаторам выполнять запросы с их помощью
- Создавать свой субграф
- Развертывать свой субграф, используя The Graph CLI
- Тестировать свой субграф в тестовой среде Playground
- Интегрировать свой субграф на стадии разработки, используя URL запроса разработки
- Публиковать свой субграф в The Graph Network
- Управлять своими платежами
Перед развертыванием необходимо установить The Graph CLI.
Для использования The Graph CLI у Вас должны быть установлены и менеджер пакетов на Ваш выбор (npm, yarn или pnpm). Проверьте у себя наличие версии CLI.
yarn global add @graphprotocol/graph-cli
npm install -g @graphprotocol/graph-cli
- Откройте .
- Подключите свой кошелек для входа.
- Вы можете это сделать через MetaMask, Coinbase Wallet, WalletConnect или Safe.
- После входа в систему Ваш уникальный ключ развертывания будет отображаться на странице сведений о Вашем субграфе.
- Ключ развертывания позволяет публиковать субграфы, а также управлять вашими API-ключами и оплатой. Он уникален, но может быть восстановлен, если Вы подозреваете, что он был взломан.
Важно: для выполнения запросов к субграфам необходим API-ключ
In order to be supported by Indexers on The Graph Network, subgraphs must:
- Индексировать
- Не должны использовать ни одну из следующих функций:
- ipfs.cat & ipfs.map
- Неисправимые ошибки
- Grafting
После создания субграфа в Subgraph Studio Вы можете инициализировать его код через CLI с помощью следующей команды:
graph init <SUBGRAPH_SLUG>
Значение <SUBGRAPH_SLUG> можно найти на странице сведений о субграфе в Subgraph Studio, см. изображение ниже:
После запуска graph init Вам будет предложено ввести адрес контракта, сеть и ABI, которые Вы хотите запросить. Это приведет к созданию новой папки на Вашем локальном компьютере с базовым кодом для начала работы над субграфом. Затем Вы можете завершить работу над своим субграфом, чтобы убедиться, что он функционирует должным образом.
Прежде чем Вы сможете развернуть свой субграф в Subgraph Studio, Вам будет необходимо войти в свою учетную запись в CLI. Для этого Вам понадобится ключ развертывания, который Вы сможете найти на странице сведений о субграфе.
После этого используйте следующую команду для аутентификации через CLI:
graph auth <DEPLOY KEY>
Когда будете готовы, Вы сможете развернуть свой субграф в Subgraph Studio.
Развертывание субграфа с помощью CLI отправляет его в Studio, где Вы сможете протестировать его и обновить метаданные. Это действие не приводит к публикации субграфа в децентрализованной сети.
Используйте следующую команду CLI для развертывания своего субграфа:
graph deploy <SUBGRAPH_SLUG>
После выполнения этой команды CLI запросит метку версии.
- Настоятельно рекомендуется использовать для управления версиями типа
0.0.1. При этом Вы можете выбрать любую строку в качестве версии, например:v1,version1илиasdf. - Созданные вами метки будут видны в Graph Explorer, и кураторы смогут использовать их для принятия решения, сигнализировать на определенную версию или нет, поэтому выбирайте метки с умом.
После развертывания Вы можете протестировать свой субграф (в Subgraph Studio или в собственном приложении, используя URL-адрес запроса на развертывание), развернуть другую версию, обновить метаданные и, когда будете готовы, опубликовать в .
Используйте Subgraph Studio, чтобы проверить логи на панели управления и обнаружить возможные ошибки в своем субграфе.
Чтобы успешно опубликовать свой субграф, ознакомьтесь с .
Если Вы хотите обновить свой субграф, Вы можете сделать следующее:
- Вы можете развернуть новую версию в Studio, используя CLI (на этом этапе она будет только приватной).
- Если результат Вас устроит, Вы можете опубликовать новое развертывание в .
- Это действие создаст новую версию вашего субграфа, о которой Кураторы смогут начать сигнализировать, а Индексаторы — индексировать.
Вы также можете обновить метаданные субграфа без публикации новой версии. В Studio можно обновить данные субграфа (аватар, название, описание и т.д.), выбрав опцию Обновить данные в . Если эта опция выбрана, будет сгенерирована транзакция в сети, которая обновит информацию о субграфе в Explorer без необходимости публиковать новую версию с новым развертыванием.
Примечание: Публикация новой версии субграфа в сети требует определенных затрат. Помимо комиссий за транзакцию, Вам нужно также оплатить часть кураторского сбора за авто-миграционный сигнал. Вы не сможете опубликовать новую версию субграфа, если на нее не был подан сигнал от Кураторов. Дополнительную информацию можно прочитать .
Каждый раз, когда Вы развертываете новую версию субграфа в Subgraph Studio, предыдущая версия архивируется. Архивированные версии не будут проиндексированы/синхронизированы и, следовательно, их нельзя будет запросить. Вы можете разархивировать архивированную версию своего субграфа в Subgraph Studio.
Примечание: предыдущие версии непубликованных субграфов, развернутых в Studio, будут автоматически архивированы.
