Даведнік RPC

TALER прадастаўляе комплексны JSON-RPC інтэрфейс для праграмнага ўзаемадзеяння з блокчэйнам, кашальком і сеткай. Гэты даведнік дакументуе ўсе даступныя RPC метады.

Пачатак працы з TALER RPC

Уключэнне доступу RPC

1. Наладзьце RPC у taler.conf

Стварыце або адрэдагуйце ваш файл канфігурацыі:

Linux/macOS: ~/.taler/taler.conf Windows: %APPDATA%\TALER\taler.conf

# Уключыць RPC сервер
server=1

# Уліковыя дадзеныя RPC (абавязкова)
rpcuser=yourusername
rpcpassword=yourpassword

# Апцыянальна: прывязаць да канкрэтнага IP
rpcbind=127.0.0.1

# Апцыянальна: дазволіць злучэнні з канкрэтнага IP
rpcallowip=127.0.0.1

# Апцыянальна: карыстальніцкі RPC порт (па змаўчанні: 23333)
rpcport=23333

2. Запусціце talerd з уключаным RPC

talerd -daemon

Выкананне RPC выклікаў

Выкарыстанне taler-cli (рэкамендуецца)

taler-cli [опцыі] <каманда> [параметры]

Прыклад:

taler-cli getblockcount
taler-cli getbalance
taler-cli sendtoaddress "TFNxSh9X75WguDWRj4FbRELK8GUP37xu4E" 10.5

Выкарыстанне curl (HTTP POST)

curl --user yourusername:yourpassword \
  --data-binary '{"jsonrpc":"1.0","id":"curltest","method":"getblockcount","params":[]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:23333/

Фармат адказу:

{
  "result": 123456,
  "error": null,
  "id": "curltest"
}

RPC метады па катэгорыях

Інфармацыя аб блокчэйне

Запыт стану блокчэйна, блокаў, транзакцый і статыстыкі ланцуга.

Mempool (пул транзакцый)

Праверка і кіраванне транзакцыямі, якія чакаюць пацверджання.

Набор UTXO

Запыт невыдаткаваных выхадаў транзакцый і праверка доказаў.

Прасунутае кіраванне блокчэйнам

Прасунутыя аперацыі для тэсціравання і кіравання блокчэйнам.

Майнінг і генерацыя

Кіраванне генерацыяй блокаў для proof-of-work (PoW) і proof-of-stake (PoS).

Заўвага: Для прадакшн стэйкінгу выкарыстоўвайце setgeneratepos true з зашыфраваным і разблакаваным кашальком. Гл. Кіраўніцтва па майнінгу і стэйкінгу для дэталяў.

Сырыя транзакцыі

Стварэнне, дэкадаванне, подпіс і трансляцыя сырых транзакцый.

Стварэнне транзакцый

Дэкадаванне транзакцый

Подпіс транзакцый

Трансляцыя транзакцый

Аперацыі з PSBT

Аб’яднанне транзакцый

Кіраванне кашальком

Кіраванне файламі кашалька, шыфраваннем, рэзервовымі копіямі і пуламі ключоў.

Аперацыі з кашальком

Шыфраванне і бяспека кашалька

Важна: Заўсёды шыфруйце ваш кашалёк перад стэйкінгам. Гл. Лепшыя практыкі бяспекі для дэталяў.

Кіраванне пулам ключоў

Адрасы і меткі

Генерацыя і кіраванне адрасамі кашалька.

Генерацыя адрасоў

Тыпы адрасоў: "legacy", "p2sh-segwit", "bech32" (па змаўчанні залежыць ад канфігурацыі кашалька)

Меткі і арганізацыя

Мультыподпісныя адрасы

Балансы і гісторыя транзакцый

Запыт балансаў кашалька і інфармацыі аб транзакцыях.

Інфармацыя аб балансе

Гісторыя транзакцый

Адпраўка транзакцый

Адпраўка манет TALER з кашалька.

Простая адпраўка

Прыклад:

taler-cli sendtoaddress "TFNxSh9X75WguDWRj4FbRELK8GUP37xu4E" 10.5
taler-cli sendmany "" '{"TAddr1":10,"TAddr2":5.5}'

Кіраванне транзакцыямі

Кіраванне UTXO

Кіраванне невыдаткаванымі выхадамі, даступнымі для выдатк��вання.

Прыклад - Блакіроўка UTXO:

taler-cli lockunspent false '[{"txid":"abc123...","vout":0}]'

Прыклад - Разблакіроўка ўсіх UTXO:

taler-cli lockunspent true

Імпарт і экспарт

Імпарт і экспарт ключоў, адрасоў і дадзеных кашалька.

Імпарт

Экспарт

Папярэджанне бяспекі: Ніколі не дзяліцеся экспартаванымі прыватнымі ключамі або дампамі кашалька. Любы, хто мае доступ да прыватных ключоў, можа выдаткоўваць вашы манеты.

Подпіс і праверка паведамленняў

Подпіс паведамленняў адрасамі кашалька і праверка подпісаў.

Прыклад:

# Падпісаць паведамленне
taler-cli signmessage "TFNxSh9X75WguDWRj4FbRELK8GUP37xu4E" "Hello TALER"

# Праверыць подпіс
taler-cli verifymessage "TFNxSh9X75WguDWRj4FbRELK8GUP37xu4E" "H1234..." "Hello TALER"

Стэйкінг (Proof-of-Stake)

Маніторынг і кіраванне proof-of-stake майнтынгам/стэйкінгам.

Для падрабязных інструкцый па наладзе стэйкінгу, гл. Кіраўніцтва па майнінгу і стэйкінгу.

Інфармацыя аб сетцы

Запыт злучэнняў піраў і сеткавай статыстыкі.

Кіраванне пірамі

Сеткавая статыстыка

Кіраванне банамі

Прыклад - Забаніць IP:

taler-cli setban "192.168.1.100" "add" 86400

Кіраванне сеткай

Кіраванне серверам і інфармацыя

Кіраванне дэманам TALER і запыт сістэмнай інфармацыі.

Прыклад:

# Атрымаць даведку па камандзе
taler-cli help getblockcount

# Праверыць час працы сервера
taler-cli uptime

# Спыніць дэман
taler-cli stop

Састарэлыя метады

Наступныя метады састарэлі і падтрымліваюцца толькі для зваротнай сумяшчальнасці. Яны могуць быць выдаленыя ў будучых версіях.

Апрацоўка памылак

RPC выклікі вяртаюць памылкі ў наступным фармаце:

{
  "result": null,
  "error": {
    "code": -5,
    "message": "Invalid address"
  },
  "id": "curltest"
}

Распаўсюджаныя коды памылак

Аўтэнтыфікацыя RPC

TALER RPC выкарыстоўвае HTTP Basic Authentication. Наладзьце ўліковыя дадзеныя ў taler.conf:

rpcuser=yourusername
rpcpassword=yourpassword

Лепшыя практыкі бяспекі:

• Выкарыстоўвайце моцны, выпадкова згенераваны пароль
• Ніколі не выстаўляйце RPC у публічны інтэрнэт
• Выкарыстоўвайце rpcallowip для абмежавання доступу з канкрэтных IP
• Разгледзьце выкарыстанне SSH тунэліравання для аддаленага доступу
• Выкарыстоўвайце HTTPS/TLS пры аддаленым доступе да RPC (патрабуецца зваротны проксі)

Дадатковыя рэсурсы

• Кіраўніцтва па наладзе ноды: Запуск ноды TALER
• Даведнік каманднага радка: talerd & taler-cli
• Лепшыя практыкі бяспекі: Бяспека кашалька
• Кіраўніцтва па стэйкінгу: Майнінг і стэйкінг
• Разгортванне Docker: Налада Docker

Для пытанняў або падтрымкі наведайце Супольнасць TALER у Telegram.