From d492bfad09a9ee2fa91d24bfb2e73ee6e6abab19 Mon Sep 17 00:00:00 2001 From: polistern Date: Sat, 2 Jul 2022 16:38:40 +0000 Subject: [PATCH] docs: Added info about Nodes and Peers. Added few clarifications. --- docs/docs/bote/v5/packet_types.md | 9 +++++++-- docs/docs/bote/v5/packet_types.ru.md | 12 ++++++++---- docs/docs/bote/v5/terms.md | 8 +++++++- docs/docs/bote/v5/terms.ru.md | 8 +++++++- docs/docs/user-guide/run.md | 8 ++++---- docs/docs/user-guide/run.ru.md | 8 ++++---- 6 files changed, 37 insertions(+), 16 deletions(-) diff --git a/docs/docs/bote/v5/packet_types.md b/docs/docs/bote/v5/packet_types.md index 163a02b..4913d61 100644 --- a/docs/docs/bote/v5/packet_types.md +++ b/docs/docs/bote/v5/packet_types.md @@ -81,6 +81,8 @@ Contains the DHT keys of one or more `Email Packets`, a `Delete Verification` Ha Contains information about deleted DHT items, which can be `Email Packets` or `Index Packet` entries. +Must be a part of `Response packet ` on `Deletion Query`. + | Field | Data Type | Description | |---------|------------|-----------------------------------| | `TYPE` | 1 byte | Value = `'T'` | @@ -281,8 +283,11 @@ A request to a peer to return a data item for a given DHT key and data type. ### 3.2 Deletion Query -A request to a peer to return a `Deletion Info Packet` for a given `Email Packet` DHT key. -`Response Packet` with correct status is expected back `[VER 5]`. +A request to a node to return a `Deletion Info Packet` for a given `Email Packet` DHT key. +Used to determine mail delivery. + +`Response Packet` with correct status is expected back. `[VER 5]` +`Response Packet` must contain `Deletion Info Packet`. | Field | Data Type | Description | |---------|------------|----------------------------------------------| diff --git a/docs/docs/bote/v5/packet_types.ru.md b/docs/docs/bote/v5/packet_types.ru.md index 40983fe..4284486 100644 --- a/docs/docs/bote/v5/packet_types.ru.md +++ b/docs/docs/bote/v5/packet_types.ru.md @@ -77,9 +77,10 @@ ToDo: add info about alg-specific prefixes | `DVn` | 32 байт | `Хэш Подтверждения Удаления` для `KEYn` (SHA-256 хэш `Авторизации Удаления` их `Почтового пакета`) | | `TIMn` | 8 байт | Время, в которое `KEYn` был добавлен на узел. (int64) `[VER 5]` | -### 1.4 Пакет информации для удаления +### 1.4 Информационный пакет удаления Содержит информацию об удалённых из DHT элементах, которые могут быть `Почтовыми пакетами` или `Индексными пакетами`. +Содержится в `Пакете ответа` на `Запрос удаления`. | Поле | Размер | Описание | |---------|---------|----------------------------------------------------------| @@ -279,10 +280,13 @@ ToDo: add info about alg-specific prefixes | `'E'` | `Почтовый пакет` | | `'C'` | `Контакт` | -### 3.2 Запрос на удаление +### 3.2 Запрос удаления -Запрос к узлу на возврат `Информационного пакета удаления` для предоставленного DHT-ключа `Почтового пакета`. -`Пакет ответа` с корректным статусом ожидается в ответ. `[VER 5]` +Запрос к узлу на возврат `Информационного пакета удаления` для предоставленного DHT-ключа `Почтового пакета`. +Используется для определения доставки почты. + +`Пакет ответа` с корректным статусом ожидается в ответ. `[VER 5]` +`Пакет ответа` должен содержать `Информационный пакет удаления`. | Поле | Размер | Описание | |---------|------------|--------------------------------------------------| diff --git a/docs/docs/bote/v5/terms.md b/docs/docs/bote/v5/terms.md index c274769..876d872 100644 --- a/docs/docs/bote/v5/terms.md +++ b/docs/docs/bote/v5/terms.md @@ -32,4 +32,10 @@ The address of a I2P-Bote node on the I2P network. There is normally no need to ## Node -## Relay +A full-featured node that is capable of handling requests for storage, retrieval, deletion, etc. +The "closest" to the DHT-keys is determined by the `I2P destination` of this nodes type. + +## Relay (Peer) + +A node with high availability in the near future (at least 18 hours in the last 24 hours). +They are used as intermediaries for anonymized transmission of packets to `Nodes`. diff --git a/docs/docs/bote/v5/terms.ru.md b/docs/docs/bote/v5/terms.ru.md index 8c4c872..b871893 100644 --- a/docs/docs/bote/v5/terms.ru.md +++ b/docs/docs/bote/v5/terms.ru.md @@ -30,4 +30,10 @@ ## Узел -## Реле +Полнофункциональный узел, который способен обрабатывать запросы на хранение, получени, удаление, и т.д. +По `I2P назначениям` этих узлов определяется "близость" к DHT-ключам. + +## Реле (Пир) + +Узел с большой доступностью в течении ближайшего времени (не менее 18 часов за последние 24 часа). +Используются как посредники для анонимизированой передачи пакетов к `Узлам`. diff --git a/docs/docs/user-guide/run.md b/docs/docs/user-guide/run.md index b5cb660..ce78f30 100644 --- a/docs/docs/user-guide/run.md +++ b/docs/docs/user-guide/run.md @@ -1,13 +1,13 @@ # Running -## The pboted needs I2P router +## pboted needs I2P router -- Install and run I2P router -- Enable SAM API +- Install I2P router +- Enable SAMv3 API - Restart I2P router - Local TCP port 7656 and UDP port 7655 should be available -## Recommended way to run pboted built from source +## Recommended way to run pboted (built from source) - Create `/etc/pboted` directory: diff --git a/docs/docs/user-guide/run.ru.md b/docs/docs/user-guide/run.ru.md index c2af7c7..d7b137c 100644 --- a/docs/docs/user-guide/run.ru.md +++ b/docs/docs/user-guide/run.ru.md @@ -1,13 +1,13 @@ # Запуск -## pboted нужен I2P маршрутизатор +## pboted требуется I2P маршрутизатор -- Установите и запустите I2P маршрутизатор -- Включите SAM API. +- Установите I2P маршрутизатор +- Включите SAMv3 API - Перезапустите I2P маршрутизатор - TCP порт 7656 и UDP порт 7655 должны стать доступны -## Рекомендуемый способ запуска pboted, собранного из исходников +## Рекомендуемый способ запуска pboted (собранного из исходников) - Создайте директорию `/etc/pboted`: