JSON-RPC API

Core предоставляет JSON-RPC 2.0 через HTTP и отклоняет переключение на WebSocket. Стандартный адрес:

http://127.0.0.1:9601

Имена всех методов начинаются с префикса пространства имён paranoid_. Параметры передаются позиционными JSON-массивами. Размер тела запроса ограничен 2 237 632 байтами, а JSON-RPC batch продолжает поддерживаться в пределах этого размера.

curl --silent --show-error \
  -H 'Content-Type: application/json' \
  --data '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "paranoid_getChainInfo",
    "params": []
  }' \
  http://127.0.0.1:9601

Соглашения

• Целочисленные денежные поля выражены в μNOID.
• Один NOID равен 1 000 000 μNOID.
• Хэши передаются в нижнем регистре hex без 0x.
• Целевое значение PoW и байты nonce используют канонический порядок от младшего байта к старшему (little-endian).
• Адреса имеют каноническую форму bech32m o1…, если поле явно не требует hex.
• Неизвестный постоянный объект обычно возвращает null.
• После 42-блочного окна старое тело блока возвращает null, но его заголовок остаётся доступен.
• Десятичные строки используются для агрегатов, которые могут выйти за диапазон точного представления чисел JSON.
• Поля с плавающей точкой *_noid предназначены для отображения. Учётный код должен использовать соответствующее целое поле *_micronoid.

Аутентификация

По умолчанию RPC не имеет аутентификации и должен оставаться на локальном интерфейсе. Core отказывается запускать неаутентифицированный listener на нелокальном адресе.

Соединение без Origin, принятое с фактического TCP-адреса loopback, получает локальные права владельца без заголовка Authorization, даже если настроены mining-токен или operator-токен. Поэтому GUI и CLI на машине ноды работают без пароля. Если заголовок Authorization передан, он всегда проверяется и выбирает только область доступа соответствующего токена. Нелокальный клиент обязан передать настроенный токен. Заголовки Host, Forwarded, X-Forwarded-For и другие HTTP-заголовки не могут выдать удалённое соединение за локальное.

При запуске Core с --mining-key TOKEN или --mining-key-file FILE для запросов внешнего майнинга требуется заголовок:

Authorization: Bearer TOKEN

При отсутствующем или другом токене сервер отвечает HTTP 401 без JSON-RPC-результата. Правильный mining-токен разрешает только paranoid_getBlockTemplate и paranoid_submitBlock; он не даёт доступа к кошельку, управлению нодой и остальным RPC-методам. Токен аутентифицирует, но не шифрует соединение, поэтому для удалённого доступа используйте приватный транспорт или TLS-прокси.

Пулы с отдельным хостом учёта или выплат могут настроить независимый --operator-key TOKEN или --operator-key-file FILE. Этот токен разрешает только:

• paranoid_walletMinedBlocks
• paranoid_walletGetBalance
• paranoid_walletStatus
• paranoid_walletPlanSend
• paranoid_walletSend
• paranoid_walletPlanConsolidation
• paranoid_walletConsolidate
• paranoid_walletReceipts
• paranoid_walletQueryReceipts
• paranoid_walletExportReceipt
• paranoid_getTx
• paranoid_getMempoolEntry
• paranoid_verifyReceipt
• paranoid_submitTxIntent
• paranoid_validateAddress
• paranoid_getChainInfo
• paranoid_estimateFee
• paranoid_estimateFeeDetailed

Operator-токен не может вызывать методы майнинга, paranoid_stop, сканирование и обнаружение кошелька, управление адресами, неограниченные списки истории или UTXO и любые текущие или будущие методы вне списка. Mining-токен и operator-токен должны различаться. Если настроены оба токена, каждый запрос получает только область доступа предъявленного токена. Области доступа не объединяются.

Operator-токен может расходовать средства активного кошелька через walletSend. Bearer-аутентификация не шифрует транспорт. Привязывайте listener к приватному интерфейсу, ограничивайте адреса источника межсетевым экраном и используйте VPN, SSH-туннель или аутентифицированный TLS-прокси, если сеть не полностью доверенная. Reverse proxy, подключающийся к ноде через loopback, должен пересылать Bearer-заголовок. Если он удалит Authorization, нода увидит прокси как локального клиента владельца и не применит область доступа удалённого токена.

Создавайте независимые токены командой openssl rand -hex 32. Передача токена в командной строке сохранена для совместимости. Предпочтителен файл с доступом только владельцу, потому что он не показывает токен в аргументах процесса.

Методы цепи

getBlockDetails.retained описывает каноническое тело, пока оно хранится на узле. Сюда входят промежуточные блоки многоблочного коммита, чья валидность покрывается терминальным доказательством вершины суффикса. Для них history_step_bytes и bundle_bytes равны нулю: отдельного proof bundle нет, но block_bytes и transactions описывают доступное тело. После удаления тела getBlock возвращает null, а getBlockDetails — постоянный заголовок с retained: null. У каждой сохранённой транзакции поле contract равно "call", "close" или null по битам вызова и закрытия. После удаления тела это поле недоступно.

getRecentTransactions сканирует сохранённые канонические тела, включая промежуточные блоки многоблочных коммитов. Нумерация страниц начинается с единицы, размер ограничен диапазоном 1–32. Переданный адрес добавляет точные суммы расходования и получения этого владельца.

getSlot возвращает ошибку для индекса вне текущего домена 2^log_slots. Пустой слот внутри диапазона возвращает empty: true, нулевую стоимость и пустую строку владельца.

Методы ноды, сети и комиссий

Подробный расчёт принимает от 1 до 1 020 входов и от 1 до 256 выходов. Возвращаемая комиссия учитывает текущую локальную границу ретрансляции.

Расчёт комиссии принимает пределы формата, но не разрешает вместимость блока. Планирование и допуск соблюдают 504 входа и бюджет страниц класса.

Вспомогательные методы и отправка

Подсказки слотов ничего не резервируют. Оба метода исключают выходы, зарезервированные в мемпуле, возвращают не более 256 записей и могут вернуть меньше, если свободных слотов недостаточно. Декодированный salt ограничен 256 байтами.

submitTxIntent принимает каноническое намерение обычного платежа либо вызова контракта v2 вместе с отдельной капсулой авторизации. До парсинга и проверки доказательства декодированный вход ограничен 303 495 байтами.

Методы мемпула

getMempoolEntry возвращает каноническое публичное открытие размером 699 байт в поле contract_opening_hex, пока вызов находится в мемпуле. Для обычной транзакции поле равно null. getMempoolInfo по-прежнему содержит только метаданные. Если вызов покинул мемпул, получить его открытие этим методом уже нельзя, поэтому опрос RPC не заменяет архив контрактов.

Ответы мемпула описывают атомарные логические транзакции, а не физические страницы.

Проверка чека

После декодирования hex вход чека ограничен 128 KiB. merkle_valid и canonical независимы: математически согласованный чек может ссылаться на корень вне канонической цепи этой ноды.

Методы внешнего майнинга

Нода должна работать в режиме внешнего майнера. Пустой miner_address использует адрес выплаты ноды; непустой принимается только при разрешённом пользовательском адресе выплаты.

nonce_hex состоит ровно из 32 строчных hex-символов, кодирующих 16 байт в порядке от младшего к старшему. Шаблоны одноразовые и истекают через 30 секунд.

Управление нодой

Первый вызов запрашивает корректное завершение. Повторные вызовы безопасны, пока процесс закрывается.

Методы кошелька

walletUtxoSnapshot без ревизии или с устаревшей ревизией возвращает весь массив utxos. При совпадении known_revision возвращается utxos: null, и клиент сохраняет прежний массив. revision: null означает, что реализация всегда возвращает полный массив. Ревизии непрозрачны, меняются при резервировании и замене кеша владельцев и не переносятся через перезапуск кошелька или ноды. walletListUtxos всегда возвращает прежний полный результат. GUI использует его, если метод условного снимка недоступен. Доступ operator от этого не расширяется.

Необязательная категория walletReceipts: all, noid, tokens, trades или nfts. Вызов без неё сохраняет прежнее поведение. walletQueryReceipts фильтрует всю библиотеку по точному ID актива или коллекции, операции, времени UTC и статусу проверки, затем сортирует записи до разбиения на страницы. См. параметры запроса чеков.

Суммы и комиссии выражены в μNOID. Нулевая комиссия в отправке или плане запрашивает автоматический подбор.

Страницы чеков и добытых блоков начинаются с единицы и принимают размер 1–50. walletDiscoverAddresses принимает 1–20 и останавливается на первом пустом производном владельце.

walletConsolidate привязан к расчёту. Список слотов, комиссия и стоимость выхода должны точно совпадать с последним планом; иначе вызов завершится ошибкой и потребуется новый расчёт.

Методы контрактов

Все методы имеют префикс paranoid_ и требуют локальных прав владельца. walletFundObject, previewObjectCall, walletCallObject требуют аутентифицированного runtime (runtime_available = true).

getObjectInstances использует включительный курсор слота и limit 1–256. Списки состояний и журнала — исключительные nullable-курсоры и limit 1–64; ответы содержат высоту и хеш вершины. Журнал включает сохранённые вызовы обеих сторон и признак canonical. Импорт объединяет проверенные данные по txid, сохраняя свои записи. Балансы проверяются по State.

Руководство API контрактов задаёт конструкторы, поля собственных программ, защиту предпросмотра, обработку ошибок и CLI. Контрактные квитанции проверяются через verifyObjectReceipt / walletImportObjectReceipt, предел после декодирования — 1 110 624 байта. У verifyReceipt отдельный платёжный формат до 128 KiB. createObject создаёт условия без комиссии; max_fee_micronoid ограничивает будущий вызов. Счётчики и константы инструкций — канонические десятичные строки u64.

Схемы контрактов

ObjectDefinition и ObjectProgramStep описаны в API и ядре. Поля ObjectCallDetails включаются непосредственно в объекты квитанций и журнала. Квитанция доказывает прошлый вызов, текущий State проверяется отдельно.

ObjectInfo {
  abi_version: u16
  state: [decimal u64 string, decimal u64 string]
  address: string
  opening_hex: string
  code_id: string
  state_hex: string
  program: ObjectProgramStep[16]
  claim_authority: string
  recovery_authority: string
  claim_recipient: string
  recovery_recipient: string
  deadline_height: u64
  max_fee_micronoid: u64
  max_payout_micronoid: u64
  min_retained_micronoid: u64
  claim_can_continue: bool
  claim_can_close: bool
  recovery_can_continue: bool
  recovery_can_close: bool
  unrestricted_payout_recipient: bool
}

ObjectStatus {
  object: ObjectInfo
  slot: SlotInfo
  matches_opening: bool
  tip_height: u64
  next_call_height: u64
  active_authority: string
}

ObjectInstances {
  address: string
  height: u64
  tip_hash: string
  slots: SlotInfo[]
  next_slot: u32 | null
}

ObjectKnownState {
  object: ObjectInfo
  has_balance: bool
}

ObjectKnownStates {
  states: ObjectKnownState[]
  height: u64
  tip_hash: string
  next_root: string | null
}

ObjectPayout {
  address: string
  amount_micronoid: u64
}

ObjectCallRequest {
  opening_hex: string
  slot_index: u32
  creation_id: u64
  terminal: bool
  payout: ObjectPayout | null
  fee_micronoid: u64
  expected_recovery: bool | null
  expected_authority: string | null
  expected_call_height: u64 | null
  expected_txid: string | null
}

ObjectCallPreview {
  txid: string
  call_height: u64
  authority: string
  recovery: bool
  terminal: bool
  fee_micronoid: u64
  retained_micronoid: u64
  payout: ObjectPayout | null
  successor: ObjectInfo | null
}

ObjectCallResult {
  transaction: WalletSendResult
  call_height: u64
  successor: ObjectInfo | null
  output_slot: u32
}

ObjectReceiptResult {
  valid: bool
  ...ObjectCallDetails
}

ObjectCallDetails {
  height: u64
  txid: string
  terminal: bool
  authority: string
  original: ObjectInfo
  successor: ObjectInfo | null
  input_micronoid: u64
  fee_micronoid: u64
  retained_micronoid: u64
  payout: ObjectPayout | null
}

ObjectActivityEntry {
  ...ObjectCallDetails
  block_hash: string
  canonical: bool
}

ObjectActivityPage {
  height: u64
  tip_hash: string
  entries: ObjectActivityEntry[]
  next_cursor: string | null
}

ObjectClassLimits {
  class: string
  pages: usize
  live_inputs: usize
  contract_calls: usize
}

ObjectProtocolInfo {
  tip_height: u64
  activation_height: u64 | null
  active_at_next_block: bool
  runtime_available: bool
  next_block_time_seconds: u64
  abi_version: u16
  instructions: usize
  persistent_registers: usize
  classes: ObjectClassLimits[]
}

Необязательные защиты запроса можно опустить либо передать null. creation_id обязателен. Закрытие: terminal: true, payout: null; смысловой результат показывает выплату закрытия без преемника. Нулевая комиссия запрашивает текущий минимум в пределах потолка политики. Ответ отправки ещё требует включения.

Схемы ответов

В следующих схемах ? обозначает необязательное поле, а null — явное отсутствие значения в JSON.

Цепь и State

ChainInfo {
  height: u64
  best_hash: string
  difficulty_target: string
  active_slot_count: u64
  log_slots: u32
  circulating_supply_micronoid: decimal string
}

BlockHeaderInfo {
  height: u64
  hash: string
  prev_hash: string
  state_root: string
  tx_root: string
  timestamp: u64
  miner: string
  nonce_hex: string
  difficulty_target: string
  log_slots: u32
  active_slot_count: u64
  alloc_counter: u64
}

SlotInfo {
  slot_index: u32
  value: u64
  creation_id: u64
  owner: string
  empty: bool
}

TxInfo {
  tx_hash: string
  height: u64
  block_hash: string
  tx_position: u32
}

circulating_supply_micronoid — точная сумма стоимости всех UTXO в Live State, выраженная в μNOID. Поле передаётся десятичной строкой, чтобы JSON не терял точность.

StateInfo {
  log_slots: u32
  capacity: u64
  active_slots: u64
  fill_pct: number
  slots_until_expand: i64
  expand_trigger_pct: u8
  log_slots_max: u32
  state_bytes: u64
  state_size_human: string
}

StateMapInfo {
  log_slots: u32
  bucket_capacity: u64
  live_counts: u64[]
}

state_bytes — канонически кодированные данные сегментов без страниц MDBX, индексов и накладных расходов файловой системы.

Подробности блока

BlockDetailsInfo {
  header: BlockHeaderInfo
  retained: RetainedBlockInfo | null
}

RetainedBlockInfo {
  proof_class: string
  logical_transactions: u16
  user_pages: u16
  live_inputs: u16
  live_outputs: u16
  reward_micronoid: u64
  reward_noid: number
  total_fees_micronoid: decimal string
  block_bytes: u64
  history_step_bytes: u64
  bundle_bytes: u64
  transactions: BlockTransactionInfo[]
}

BlockTransactionInfo {
  position: u16
  txid: string
  page_count: u16
  live_inputs: u16
  live_outputs: u16
  fee_micronoid: u64
  coinbase: bool
  development_payout: bool
  contract: "call" | "close" | null
  epoch_anchor: string
  input_owner: string | null
  input_sum_micronoid: decimal string
  output_sum_micronoid: decimal string
  page_hashes: string[]
  inputs: BlockTransactionInputInfo[]
  outputs: BlockTransactionOutputInfo[]
}

BlockTransactionInputInfo {
  page: u16
  lane: u8
  slot_index: u32
  amount_micronoid: u64
  creation_id: u64
}

BlockTransactionOutputInfo {
  page: u16
  lane: u8
  slot_index: u32
  amount_micronoid: u64
  owner: string
  creation_id: u64
}

RecentTransactionsPage {
  page: u32
  page_size: u32
  total: usize
  total_pages: u32
  tip_height: u64
  retained_from_height: u64
  address: string | null
  transactions: RecentTransactionInfo[]
}

RecentTransactionInfo {
  height: u64
  block_hash: string
  timestamp: u64
  position: u16
  txid: string
  page_count: u16
  live_inputs: u16
  live_outputs: u16
  fee_micronoid: u64
  coinbase: bool
  development_payout: bool
  input_owner: string | null
  input_sum_micronoid: decimal string
  output_sum_micronoid: decimal string
  address_spent_micronoid: decimal string | null
  address_received_micronoid: decimal string | null
}

Нода и майнинг

MiningInfo {
  height: u64
  difficulty_bits: u32
  difficulty_target: string
  block_reward_micronoid: u64
  block_reward_noid: number
  active_slot_count: u64
}

NodeStatus {
  synced: bool
  sync_stage: "headers" | "state" | "tip"
  mining: bool
  mining_ready: bool
  mining_confirmed_peers: usize
  mining_required_peers: usize
  isolated_mining: bool
  backend: string
  available_threads: usize
  worker_threads: usize
}

isolated_mining — состояние ноды, запущенной в специальном операторском контексте. В публичном развёртывании это поле нельзя использовать как удалённое управление или свойство пира.

Комиссии

FeeEstimate {
  n_inputs: usize
  n_outputs: usize
  net_new_slots: u64
  active_slot_count: u64
  log_slots: u32
  fee_micronoid: u64
  breakdown: FeeBreakdownInfo
}

FeeBreakdownInfo {
  base: u64
  input: u64
  output: u64
  io: u64
  state_growth: u64
  required_total: u64
  relay_floor: u64
  relay_total: u64
  paid_total: u64
  burned: u64
  miner_claimable: u64
}

Мемпул

MempoolInfo {
  size: usize
  fee_floor: u64
  txs: MempoolTxInfo[]
}

MempoolStats {
  size: usize
  capacity: usize
  intent_bytes: u64
  max_intent_bytes: u64
  fee_floor: u64
}

MempoolTxInfo {
  tx_hash: string
  fee_micronoid: u64
  fee_rate: u64
  n_inputs: usize
  n_outputs: usize
  page_count: usize
  minimum_proof_class: string
  requires_b255_miner: bool
  admitted_height: u64
  has_authorization: bool
}

MempoolEntryInfo {
  ...MempoolTxInfo
  contract_opening_hex: string | null
}

Ставка комиссии (fee rate) использует взвешенные единицы:

inputs + outputs + 4 × net_new_slots

Проверка адреса

AddressInfo {
  valid: bool
  bech32: string | null
  hex: string | null
  error: string | null
}

Некорректный синтаксис адреса возвращается как valid: false, а не как транспортная ошибка JSON-RPC.

Идентичность и баланс кошелька

WalletAddressInfo {
  address: string
  key_index: u32
  is_active: bool
}

WalletStatus {
  exists: bool
  address: string
  active_index: u32
  balance_micronoid: u64
  balance_noid: number
  utxo_count: usize
  address_count: u32
}

WalletBalance {
  balance_micronoid: u64
  balance_noid: number
  utxo_count: usize
  pending_outbound_micronoid: u64
  pending_incoming_micronoid: u64
  spendable_micronoid: u64
  spendable_noid: number
}

WalletUtxoInfo {
  slot_index: u32
  value_micronoid: u64
  creation_id: u64
  value_noid: number
  address: string
  key_index: u32
  confirmed_height: u64
  reserved: bool
}

WalletHistoryEntry {
  tx_hash: string
  height: u64
  direction: "sent" | "received"
  is_coinbase: bool
  amount_micronoid: u64
  amount_noid: number
  peer_address: string | null
  timestamp: u64
  own_address: string | null
  own_key_index: u32 | null
}

Отправка и консолидация кошелька

WalletSendPlan {
  amount_micronoid: u64
  fee_micronoid: u64
  total_spend_micronoid: u64
  input_count: usize
  output_count: usize
  change_micronoid: u64
  fee_breakdown: FeeBreakdownInfo
}

WalletSendResult {
  txid: string
  amount_micronoid: u64
  fee_micronoid: u64
  input_count: usize
  output_count: usize
}

WalletConsolidationPlan {
  input_value_micronoid: u64
  fee_micronoid: u64
  output_value_micronoid: u64
  balance_before_micronoid: u64
  balance_after_micronoid: u64
  input_count: usize
  untouched_count: usize
  remaining_count: usize
  freed_slots: usize
  selected_input_slots: u32[]
  fee_breakdown: FeeBreakdownInfo
}

WalletConsolidationResult {
  txid: string
  input_value_micronoid: u64
  fee_micronoid: u64
  output_value_micronoid: u64
  input_count: usize
  output_count: usize
  freed_slots: usize
}

Сканирование и страницы кошелька

WalletScanResult {
  found_utxos: usize
  balance_micronoid: u64
  balance_noid: number
  active_index: u32
  snapshot_height: u64
  snapshot_tip_hash: string
  snapshot_state_root: string
}

WalletReceiptsPage {
  page: u32
  page_size: u32
  total: usize
  total_pages: u32
  receipts: WalletReceiptInfo[]
}

WalletReceiptInfo {
  txid: string
  height: u64
  timestamp: u64
  amount_micronoid: u64
  fee_micronoid: u64
  peer_address: string | null
  own_address: string | null
  own_key_index: u32 | null
  input_count: usize
  output_count: usize
  receipt_bytes: usize
}

WalletMinedBlocksPage {
  page: u32
  page_size: u32
  total: usize
  total_pages: u32
  blocks: WalletMinedBlockInfo[]
}

WalletMinedBlockInfo {
  height: u64
  block_hash: string
  coinbase_txid: string
  timestamp: u64
  reward_micronoid: u64
  reward_noid: number
  payout_address: string
  payout_key_index: u32
  confirmations: u64
  full_block_available: bool
}

Проверка чека

ReceiptVerifyResult {
  merkle_valid: bool
  canonical: bool
  confirmed: bool
  error: string | null
  authenticated_summary?: ReceiptSummaryInfo
}

ReceiptSummaryInfo {
  txid: string
  claimed_height: u64
  confirmed_unix: u64
  tx_index: u16
  tx_count: u16
  fee_micronoid: u64
  inputs: ReceiptInputInfo[]
  outputs: ReceiptOutputInfo[]
}

ReceiptInputInfo {
  slot_index: u32
  owner: string
}

ReceiptOutputInfo {
  slot_index: u32
  amount_micronoid: u64
  owner: string
}

authenticated_summary присутствует только при корректном доказательстве Merkle.

Внешний шаблон

BlockTemplateResponse {
  template_id: string
  pow_fields_hex: string
  nonce_field_index: usize
  difficulty_target_hex: string
  height: u64
  expires_in_seconds: u64
  n_txs: usize
  tx_input_counts?: usize[]
  tx_output_counts?: usize[]
  coinbase_value_micronoid: u64
  claimable_fees_micronoid: u64
}

pow_fields_hex содержит 16 последовательных 16-байтных little-endian полей. Внешний вычислитель заменяет поле nonce_field_index, канонически равное 10.

Ошибки

Ошибки парсинга, некорректного запроса, метода и параметров используют стандартные коды JSON-RPC.

Ошибки приложения обычно используют:

-32000

с человекочитаемым сообщением.

Одна ошибка планирования кошелька имеет стабильный машиночитаемый контракт:

{
  "code": -32011,
  "message": "InputLimitExceeded",
  "data": {
    "max_inputs": 504
  }
}

Это означает, что средств может быть достаточно, но в каноническом лимите входов невозможно построить корректный платёж.

Клиент должен:

1. проверить HTTP-статус до декодирования JSON;
2. проверить объект JSON-RPC error;
3. обрабатывать документированные стабильные коды;
4. показывать остальные сообщения приложения оператору, не пытаясь разбирать их текст.

requires_b255_miner сохраняет имя для совместимости API. Оно означает необходимость Large; реальные бюджеты сообщает getContractProtocol.

Средства контрактов запрашиваются через методы объектов. Обычный баланс кошелька перечисляет его владельцев и не включает произвольные обязательства контрактов. getTx сохраняет индексный указатель после очистки тела.