Подписка на блоки
В этой подписке передаются новые блоки из воркчейнов -1 и 0 по возрастанию seqno.
Вы можете настроить получение данных только из определенного воркчейна и выбрать, какие именно данные блока получать.
Структура уведомления
Когда новый блок будет сформирован, вы получите уведомление, которое содержит все транзакции и измененные состояния аккаунтов в блоке.
Пример реального уведомления можно посмотреть тут.
{
"jsonrpc": "2.0",
"method": "block",
"params": {
"id": {
"@type": "tonNode.blockIdExt",
"workchain": 0,
"shard": -9223372036854775808,
"seqno": 1234567890,
"root_hash": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"file_hash": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
},
"header": {
/* TL-B-схема 'BlockInfo' в 'block.tlb' */
},
"transactions": {
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=": { // хэш транзакции
/* TL-B-схема 'Transaction' в 'block.tlb' */
}
},
"account_states": {
"AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=": { // хэш аккаунта
/* TL-B-схема 'ShardAccount' в 'block.tlb' */
}
}
}
} | Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| id | object | Да | Расширенный идентификатор блока. TL-схема tonNode.blockIdExt в ton_api.tl. |
| header | object | Нет | Заголовок блока. TL-B-схема BlockInfo в block.tlb. Поле присутствует, если include_block_header установлен true. |
| transactions | object | Нет | Список обработанных транзакций в блоке, отсортированных по возрастанию параметра lt транзакции. Ключ - хэш транзакции, значение - TL-B-схема Transaction в block.tlb. Поле присутствует, если include_transactions установлен true. |
| account_states | object | Нет | Список измененных состояний аккаунтов. Ключ - хэш аккаунта (часть адреса аккаунта), значение - TL-B-схема ShardAccount в block.tlb. Поле присутствует, если include_account_states установлен true. |
Создание подписки
Подписка на все воркчейны
Чтобы подписаться на все воркчейны, укажите только название подписки без других параметров.
{
"jsonrpc": "2.0",
"method": "subscribe",
"params": {
"subscription": "block"
},
"id": 1
} Подписка на конкретный воркчейн
Чтобы подписаться на определенный воркчейн, укажите его номер в параметре workchains.
{
"jsonrpc": "2.0",
"method": "subscribe",
"params": {
"subscription": "block",
"workchains": [0]
},
"id": 1
} Настройка получаемых данных
Чтобы получать только определенные данные блока, установите true для нужного параметра include_*.
{
"jsonrpc": "2.0",
"method": "subscribe",
"params": {
"subscription": "block",
"workchains": [0],
"include_block_header": false,
"include_transactions": true
},
"id": 1
} Ответ сервера
После каждого запроса в ответ вы будете получать сообщение с текущими параметрами подписки, чтобы видеть актуальную подписку на сервере.
{
"jsonrpc": "2.0",
"result": {
"subscription": "block",
"workchains": [0, -1],
"include_block_header": false,
"include_transactions": true,
"include_account_states": false
},
"id": 1
} | Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| subscription | string | Да | Имя подписки. По умолчанию всегда block. |
| workchains | int[] | Нет | Список воркчейнов. |
| include_block_header | bool | Нет | Включать ли заголовок блока в уведомления. |
| include_transactions | bool | Нет | Включать ли транзакции блока в уведомления. |
| include_account_states | bool | Нет | Включать ли состояния аккаунтов блока в уведомления. |
Управление подпиской
Допустим, у вас есть подписка с такими параметрами.
{
"subscription": "block",
"workchains": [-1],
"include_block_header": true,
"include_transactions": true,
"include_account_states": false
} Добавление воркчейна
Чтобы добавить к этой подписке еще один воркчейн, укажите его в параметре workchains.
{
"jsonrpc": "2.0",
"method": "subscribe",
"params": {
"subscription": "block",
"workchains": [0]
},
"id": 2
} В ответ вы получите сообщение с обновленными параметрами подписки.
{
"jsonrpc": "2.0",
"result": {
"subscription": "block",
"workchains": [0, -1],
"include_block_header": true,
"include_transactions": true,
"include_account_states": false
},
"id": 2
} Добавление параметров
Чтобы добавить параметры include_*, укажите true для нужного параметра, а в workchains укажите [].
Если в workchains указать null или опустить этот параметр, это будет эквивалентно подписке на все воркчейны.
{
"jsonrpc": "2.0",
"method": "subscribe",
"params": {
"subscription": "block",
"workchains": [],
"include_account_states": true
},
"id": 3
} В ответ вы получите сообщение с обновленными параметрами подписки.
{
"jsonrpc": "2.0",
"result": {
"subscription": "block",
"workchains": [0, -1],
"include_block_header": true,
"include_transactions": true,
"include_account_states": true
},
"id": 3
} Добавление воркчейна и параметров include_* можно делать в одном запросе.
Удаление воркчейна
Допустим, у вас есть подписка на воркчейны и параметры.
Чтобы убрать из подписки один воркчейн, укажите его в параметре workchains.
Если в параметр workchains указать null или все воркчейны, подписка будет полностью удалена.
{
"jsonrpc": "2.0",
"method": "unsubscribe",
"params": {
"subscription": "block",
"workchains": [0]
},
"id": 4
} В ответ вы получите сообщение с обновленными параметрами подписки.
{
"jsonrpc": "2.0",
"result": {
"subscription": "block",
"workchains": [-1],
"include_block_header": true,
"include_transactions": true,
"include_account_states": true
},
"id": 4
} Удаление параметров
Чтобы удалить параметры include_*, укажите true для нужного параметра, а в workchains укажите [].
В запросе unsubscribe значение true удаляет соответствующий тип данных из подписки.
{
"jsonrpc": "2.0",
"method": "unsubscribe",
"params": {
"subscription": "block",
"workchains": [],
"include_account_states": true
},
"id": 5
} В ответ вы получите сообщение с обновленными параметрами подписки.
{
"jsonrpc": "2.0",
"result": {
"subscription": "block",
"workchains": [-1],
"include_block_header": true,
"include_transactions": true,
"include_account_states": false
},
"id": 5
} Удаление воркчейна и параметров include_* можно делать в одном запросе.
Удаление подписки
Чтобы полностью удалить подписку, укажите только её название без других параметров.
{
"jsonrpc": "2.0",
"method": "unsubscribe",
"params": {
"subscription": "block"
},
"id": 6
} В ответ вы получите сообщение об удалении подписки.
{
"jsonrpc": "2.0",
"result": {
"subscription": "block",
"include_block_header": false,
"include_transactions": false,
"include_account_states": false
},
"id": 6
}