Документация/О портале

Обзор портала

Этот портал — внутренняя база знаний и набор инструментов для администраторов проекта, работающих со swap-провайдерами. Он решает три задачи:

  1. Документация — объясняет простым языком, как работает каждый подключённый провайдер: авторизация, комиссии, пошаговые сценарии, ответы на частые вопросы.
  2. Песочница API (/sandbox) — живые запросы через серверный прокси. Режим «Обучение» ведёт по шагам свопа с формами для 1Click, Relay и LI.FI, SwapKit. Режим «Эксперт» — конструктор запросов с шаблонами.
  3. Проверка котировки (/quote) — быстрый способ узнать, сколько получит пользователь при обмене (сейчас заточено под 1Click dry-quote).

Какие провайдеры подключены#

ПровайдерСтатусЧто это
1Click API (NEAR Intents)активенREST API кросс-чейн свопов на NEAR Intents; Partner JWT
Relay.linkактивенNon-custodial quote → steps → status; optional x-api-key
LI.FIактивенNon-custodial агрегатор; GET /v1/quote → transactionRequest
SwapKitактивенАгрегатор → suppliers (NEAR, THORChain…); POST /v3/quote

Список и конфигурация провайдеров хранятся в каталоге providers/ репозитория. Сравнение покрытия: /providers/compare. Как мы описываем новых провайдеров — в разделе «Провайдеры».

Как устроен репозиторий#

  • app/ — страницы и прокси (/api/proxy/1click, /api/proxy/relay, /api/proxy/lifi, /api/proxy/swapkit);
  • content/docs/ — документация (markdown);
  • providers/<id>/ — манифест и шаблоны песочницы;
  • .env.example — образец env (без значений);
  • data/oneclick.jwt, data/relay.api-key, data/lifi.api-key, data/swapkit.api-key — секреты на сервере (не в git; /api-keys-install).

С чего начать#

  1. Установите секреты на /api-keys-install (один пароль гейта): Partner JWT, опционально Relay, LI.FI и SwapKit ключи.
  2. Откройте песочницу, выберите провайдера, режим «Обучение».
  3. Прочитайте «Безопасность и секреты».
  4. Изучите доки: 1Click, Relay, LI.FI, SwapKit.