API proxy ports и fee wallets

Эти вызовы напрямую меняют поведение proxy. Создайте backup и считайте X-ACCESS-TOKEN высокопривилегированным credential. Модели ниже получены из готового frontend и проверены безопасными read-only запросами к запущенному экземпляру.

Endpoints и ответы

{id} — это server.id, возможно строка, а не listen port. Исключение: /api/stat/port/{id} использует server.port.

Полный PortRecord

Каждая запись содержит server, wallets[], stat и setting.

Поля server

KENC задается как protocol=1, setting.et_mode=1, SOCKS5 — protocol=0, setting.et_mode=2.

Поля wallets[]

Поддерживается до десяти fee wallets. Строки с нулевым ratio текущий frontend не отправляет.

Поля setting

Семантика reserved fields не выводится надежно из frontend. Сначала выполните GET и merge изменений, не заменяйте объект целиком.

Поля stat

Тело create/edit

{
  "port": 3333,
  "name": "BTC Proxy",
  "currency": "BTC",
  "category": "sha256",
  "protocol": 0,
  "limit_connections": 60000,
  "pool_address": "stratum.example.com:3333",
  "pool_address2": "",
  "connect_mode": 0,
  "connect_mode2": 0,
  "mode": 0,
  "nc": 1,
  "pattern_addr": "",
  "replace_addr": "",
  "wallets": [
    {
      "addr": "fee-wallet",
      "device": "fee-worker",
      "pool_address": "fee-pool.example.com:3333",
      "pool_protocol": 0,
      "ratio": 0.01
    }
  ],
  "setting": {
    "port": 3333,
    "cp_name": "",
    "cp_mode": 1,
    "pu_mode": 0,
    "et_mode": 0,
    "pth": 1,
    "cut": 0,
    "fr": 0,
    "ft": 0,
    "op": 0,
    "sp": 0,
    "sd": "",
    "st": "",
    "ra": null,
    "lj": 0,
    "li": null,
    "cs": 0,
    "cl": 8
  }
}

Для NGINX или protocol=9 frontend отключает advanced options, очищает wallets и устанавливает mode=0.

Правила запроса lossless-режима

Lossless pumping сейчас поддерживает только BTC и LTC. Перед созданием или редактированием вызовите /api/lossless/pools, попросите пользователя выбрать платформу, которой действительно принадлежит адрес основного пула, затем отправьте mode: 2 и выбранный id в setting.li.

Все wallets[].pool_address и pool_protocol должны совпадать с server.pool_address и connect_mode. Поля addr, device и ratio остаются независимыми. Используйте только ID из ответа endpoint, не создавайте его самостоятельно.

Backend не может определить платформу пользователя только по адресу. Несовпадение выбранной платформы с основным пулом может привести к сбою lossless-режима и серьезным непредсказуемым последствиям. Если целевого пула нет в списке, отправляйте mode: 0.

Список lossless-пулов и проверка

GET /api/lossless/pools возвращает элементы следующего вида:

[
  {
    "id": 1,
    "name": "Pool name",
    "state": 0
  }
]

Список динамический, его нельзя заменять жестко заданным allowlist. После смены монеты или основного пула очистите старый выбор и запросите подтверждение пользователя заново.

GET /api/port/{id}/lossless/ok возвращает { "is_ok": true } или { "is_ok": false }; {id} — это server.id. Это read-only проверка текущей конфигурации, она не заменяет выбор пользователем фактической платформы пула.

Импорт и проверка pool

POST /api/ports/import принимает { "ports": [...] }; каждый элемент использует модель этой главы. Проверяйте массив ошибок даже при HTTP 200.

POST /api/ping принимает:

{
  "address": "stratum.example.com:3333",
  "conn_type": 0
}

Не добавляйте stratum+tcp://. conn_type=0 — TCP, 1 — TLS/SSL.

Hot update fee wallets

Форма показывает проценты, но request ratio остается дробью 0–1. Оба ID берутся из ответа port detail.

Для порта с mode=2 hot update по-прежнему может добавлять, удалять и менять wallets, включая addr, device и ratio. pool_address и pool_protocol должны следовать за основным пулом и не переключаются отдельно. Для смены основного пула или lossless-платформы редактируйте весь порт.

Hot replacement кошелька и worker name

Hot-replacement rule принадлежит уже созданному proxy port. Поэтому server_id во всех endpoints ниже должен быть значением server.id, а не числовым listen port. При совпадении rule сервер принудительно отключает соответствующий miner. Замена не меняет текущее соединение и применяется при следующем подключении miner.

Полный процесс Web UI описан в Hot replacement кошелька и worker name.

Текущий endpoint принимает только комбинированный тип кошелька и worker name t=2. Типы t=0 и t=1 устарели и больше не должны отправляться. pat и target используют формат wallet.device ровно с одной точкой, разделяющей кошелек и worker name.

Каждая сторона pat принимает одно значение, список через запятую или * для всей стороны; формат rule не ограничивает длину списка. Обычные значения допускают латинские буквы, цифры, _, @ и -. Например, a.* совпадает со всеми workers кошелька a, *.b — с worker name b любого кошелька, *.* — со всеми miners, а a,b,c.* и *.d,e,f задают несколько кошельков или worker names. Сопоставление выполняется по полному значению; регулярные выражения и частичные wildcard не поддерживаются.

Каждая сторона target содержит фиксированное значение из обычных символов выше или placeholder сохранения текущего значения. Используйте #{WALLET} на стороне кошелька и #{DEVICE} на стороне worker name. Например, a.#{DEVICE} меняет только кошелек, #{WALLET}.b — только worker name, а c.d — обе части. Placeholder нельзя использовать на неправильной стороне.

Сводка endpoints

Hot-replacement rules нельзя редактировать после создания. Чтобы изменить match pattern или replacement target, удалите существующий rule и создайте новый.

Создание rule

POST /api/ht/new
X-ACCESS-TOKEN: <Access Token>
Content-Type: application/json

{
  "server_id": "cEdmA.46",
  "pat": "wallet_a,wallet_b.*",
  "target": "#{WALLET}.worker-new",
  "t": 2,
  "address": "stratum.example.com:3333",
  "c": 0
}

address и c образуют одну необязательную пару. Отправляйте оба поля, если совпавший miner нужно также перенаправить в другой pool. Если требуется только замена identity, опустите оба поля вместо отправки пустого address. Перенаправление pool не изменяет комбинированную rule: сервер применяет target кошелька и worker name и переподключает miner к указанному pool.

Получение rules

GET /api/ht/cEdmA.46
X-ACCESS-TOKEN: <Access Token>

[
  ["8ZLG", "cEdmA.46", "wallet_a,wallet_b.*", "#{WALLET}.worker-new", 2, "stratum.example.com:3333", 0],
  ["Mirr", "cEdmA.46", "*.worker_a,worker_b", "wallet-new.#{DEVICE}", 2]
]

Текущий frontend также принимает массив объектов с теми же значениями полей:

[
  {
    "id": "8ZLG",
    "server_id": "cEdmA.46",
    "pat": "wallet_a,wallet_b.*",
    "target": "#{WALLET}.worker-new",
    "t": 2,
    "address": "stratum.example.com:3333",
    "c": 0
  }
]

В объектном ответе используются одноименные поля. Обрабатывайте address и c как одну пару. Если address пуст или отсутствует, miner продолжает использовать pool текущего порта; не считайте перенаправление включенным только по значению c.

Удаление rule

Отправьте id rule и server_id его порта в POST /api/ht:

{
  "id": "8ZLG",
  "server_id": "cEdmA.46"
}

После create или delete повторно вызовите GET /api/ht/{server_id} и не считайте текст Ok окончательным состоянием. Поле wd в списке workers содержит ID совпавшей комбинированной rule и соответствует индексу tuple 0 (id) в ответе rules. Поля hw и hd устарели. См. поля ответа worker.