Templates
Templates - это готовые сценарии подписки внутри проекта. Они помогают владельцу проекта превратить технические triggers в понятные пользователю варианты: что именно можно отслеживать, какие параметры нужно заполнить и какие topics можно выбрать.
Если trigger отвечает на вопрос “какое событие читать и как его обработать”, то template отвечает на вопрос “как пользователю удобно подписаться на это событие”. Template не заменяет trigger, а собирает один или несколько triggers в более понятный subscription flow.
Для чего нужны templates
Templates нужны, когда проект должен быть удобен не только владельцу интеграции, но и пользователям marketplace.
Без template пользователь выбирает trigger напрямую и работает ближе к технической конфигурации: inputs, filters, defaults и action settings. Это нормально для точных или продвинутых сценариев.
С template владелец проекта заранее подготавливает более простой путь:
- группирует связанные сценарии в один template;
- задает понятные topics;
- оставляет пользователю только нужные inputs;
- связывает topics с triggers и filters;
- может выбрать topics, которые будут включены по умолчанию.
Из чего состоит template
Project
Template всегда принадлежит конкретному project. Он использует triggers этого проекта и отображается на вкладке Templates страницы проекта.
Template metadata
Metadata описывает сам template: видимое название, внутреннее имя и описание. Эти данные показываются в списке templates и помогают пользователю понять, какой сценарий подписки он выбирает.
Inputs
Inputs - это значения, которые пользователь заполняет при создании subscription через template.
Например, template может попросить адрес, token id, threshold amount или другой параметр. Затем эти значения можно использовать в rules как условия фильтрации. Важно: inputs обязательны для заполнения, если они используются выбранным topic/rule.
Topics
Topic - это отдельный вариант внутри template, который пользователь может включить или выключить при создании subscription.
Например, один template Token activity может содержать topics Transfers, Mints и Burns. Пользователь выбирает один или несколько topics, а template уже знает, какие triggers и conditions стоят за каждым topic.
Rules
Rule связывает topic с конкретным trigger.
Один topic может использовать один rule, если он основан на одном trigger, или несколько rules, если topic должен включать несколько похожих событий. В rule выбирается trigger и, при необходимости, filters.
Filters
Filters внутри rule ограничивают, какие trigger results подходят для выбранного topic.
Значение filter можно задать напрямую или связать с template input через Use inputs. Во втором случае пользователь заполняет input при создании subscription, а rule использует это значение в условии.
Как templates используются в subscriptions
Когда пользователь нажимает Subscribe на template, интерфейс открывает создание subscription уже с выбранным project/template/topic.
Если у template есть topics с Selected by default, они будут выбраны автоматически. Если таких topics нет, интерфейс выбирает первый доступный topic.
Пользователь может:
- выбрать topics;
- заполнить inputs, которые нужны выбранным rules;
- настроить actions и notification overrides в subscription wizard;
- позже изменить subscription, не меняя сам template.
Template vs Trigger
Trigger можно использовать напрямую, если нужен точный технический контроль или единичный сценарий.
Template удобнее, если нужно дать пользователю готовый выбор: несколько topics, понятные inputs и заранее подготовленные rules поверх triggers.
Оба подхода нормальны. Выбор зависит от того, кто будет создавать subscription и насколько техническим должен быть процесс.
Статусы и ошибки
Если у template есть проблема с rule или связанным trigger, в списке может появиться Needs review. Такой template нужно проверить и исправить перед тем, как пользователи смогут нормально подписываться через него.
Частые причины:
- trigger был удален или переименован;
- rule ссылается на несуществующий topic;
- filter больше не совпадает со schema trigger;
- template еще не содержит topics.
Управление
На вкладке Templates владелец проекта может:
- создать template через Add template;
- открыть существующий template на редактирование;
- удалить один или несколько templates;
- открыть создание subscription через
Subscribe, если template валиден и содержит topics.
Подробный процесс создания описан в разделе Add template / Edit template.