sembr update

<img width="1158" height="635" alt="image"
src="https://github.com/user-attachments/assets/3f3582b4-77b2-4eb5-a7ea-12b60951303c"
/>

codex/raw/codex-marketplace.md

@@ -0,0 +1,802 @@
+---
+slug: codex-marketplace
+title: CODEX-MARKETPLACE
+name: Codex Storage Marketplace
+status: raw
+category: Standards Track
+tags: codex, storage, marketplace, smart-contract
+editor: Codex Team and Dmitriy Ryajov <dryajov@status.im>
+contributors:
+  - Mark Spanbroek <mark@codex.storage>
+  - Adam Uhlíř <adam@codex.storage>
+  - Eric Mastro <eric@codex.storage>
+  - Jimmy Debe <jimmy@status.im>
+  - Filip Dimitrijevic <filip@status.im>
+---
+
+## Abstract
+
+Codex Marketplace and its interactions are defined by a smart contract deployed on an EVM-compatible blockchain. This specification describes these interactions for the various roles within the network.
+
+The document is intended for implementors of Codex nodes.
+
+## Semantics
+
+The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+### Definitions
+
+| Terminology               | Description                                                                                                               |
+|---------------------------|---------------------------------------------------------------------------------------------------------------------------|
+| Storage Provider (SP)      | A node in the Codex network that provides storage services to the marketplace.                                             |
+| Validator                  | A node that assists in identifying missing storage proofs.                                                                |
+| Client                     | A node that interacts with other nodes in the Codex network to store, locate, and retrieve data.                           |
+| Storage Request or Request | A request created by a client node to persist data on the Codex network.                                                  |
+| Slot or Storage Slot       | A space allocated by the storage request to store a piece of the request's dataset.              |
+| Smart Contract             | A smart contract implementing the marketplace functionality.                                                               |
+| Token               | The ERC20-based token used within the Codex network.     |
+
+## Motivation
+
+The Codex network aims to create a peer-to-peer storage engine with robust data durability, data persistence guarantees, and a comprehensive incentive structure.
+
+The marketplace is a critical component of the Codex network, serving as a platform where all involved parties interact to ensure data persistence. It provides mechanisms to enforce agreements and facilitate data repair when SPs fail to fulfill their duties.
+
+Implemented as a smart contract on an EVM-compatible blockchain, the marketplace enables various scenarios where nodes assume one or more roles to maintain a reliable persistence layer for users. This specification details these interactions.
+
+The marketplace contract manages storage requests, maintains the state of allocated storage slots, and orchestrates SP rewards, collaterals, and storage proofs.
+
+A node that wishes to participate in the Codex persistence layer MUST implement one or more roles described in this document.
+
+### Roles
+
+A node can assume one of the three main roles in the network: the client, SP, and validator.
+
+A client is a potentially short-lived node in the network with the purpose of persisting its data in the Codex persistence layer.
+
+An SP is a long-lived node providing storage for clients in exchange for profit. To ensure a reliable, robust service for clients, SPs are required to periodically provide proofs that they are persisting the data.
+
+A validator ensures that SPs have submitted valid proofs each period where the smart contract required a proof to be submitted for slots filled by the SP.
+
+---
+
+## Part I: Protocol Specification
+
+This part defines the **normative requirements** for the Codex Marketplace protocol. All implementations MUST comply with these requirements to participate in the Codex network. The protocol is defined by smart contract interactions on an EVM-compatible blockchain.
+
+## Storage Request Lifecycle
+
+The diagram below depicts the lifecycle of a storage request:
+
+```text
+                      ┌───────────┐
+                      │ Cancelled │
+                      └───────────┘
+                            ▲
+                            │ Not all
+                            │ Slots filled
+                            │
+    ┌───────────┐    ┌──────┴─────────────┐           ┌─────────┐
+    │ Submitted ├───►│ Slots Being Filled ├──────────►│ Started │
+    └───────────┘    └────────────────────┘ All Slots └────┬────┘
+                                            Filled         │
+                                                           │
+                                   ┌───────────────────────┘
+                           Proving ▼
+    ┌────────────────────────────────────────────────────────────┐
+    │                                                            │
+    │                 Proof submitted                            │
+    │       ┌─────────────────────────► All good                 │
+    │       │                                                    │
+    │ Proof required                                             │
+    │       │                                                    │
+    │       │         Proof missed                               │
+    │       └─────────────────────────► After some time slashed  │
+    │                                   eventually Slot freed    │
+    │                                                            │
+    └────────┬─┬─────────────────────────────────────────────────┘
+             │ │                                      ▲
+             │ │                                      │
+             │ │ SP kicked out and Slot freed ┌───────┴────────┐
+All good     │ ├─────────────────────────────►│ Repair process │
+Time ran out │ │                              └────────────────┘
+             │ │
+             │ │ Too many Slots freed         ┌────────┐
+             │ └─────────────────────────────►│ Failed │
+             ▼                                └────────┘
+       ┌──────────┐
+       │ Finished │
+       └──────────┘
+```
+
+## Client Role
+
+A node implementing the client role mediates the persistence of data within the Codex network.
+
+A client has two primary responsibilities:
+
+- Requesting storage from the network by sending a storage request to the smart contract.
+- Withdrawing funds from the storage requests previously created by the client.
+
+### Creating Storage Requests
+
+When a user prompts the client node to create a storage request, the client node SHOULD receive the input parameters for the storage request from the user.
+
+To create a request to persist a dataset on the Codex network, client nodes MUST split the dataset into data chunks, $(c_1, c_2, c_3, \ldots, c_{n})$. Using the erasure coding method and the provided input parameters, the data chunks are encoded and distributed over a number of slots. The applied erasure coding method MUST use the [Reed-Solomon algorithm](https://hackmd.io/FB58eZQoTNm-dnhu0Y1XnA). The final slot roots and other metadata MUST be placed into a `Manifest` (TODO: Manifest RFC). The CID for the `Manifest` MUST then be used as the `cid` for the stored dataset.
+
+After the dataset is prepared, a client node MUST call the smart contract function `requestStorage(request)`, providing the desired request parameters in the `request` parameter. The `request` parameter is of type `Request`:
+
+```solidity
+struct Request {
+  address client;
+  Ask ask;
+  Content content;
+  uint64 expiry;
+  bytes32 nonce;
+}
+
+struct Ask {
+  uint256 proofProbability;
+  uint256 pricePerBytePerSecond;
+  uint256 collateralPerByte;
+  uint64 slots;
+  uint64 slotSize;
+  uint64 duration;
+  uint64 maxSlotLoss;
+}
+
+struct Content {
+  bytes cid;
+  bytes32 merkleRoot;
+}
+```
+
+The table below provides the description of the `Request` and the associated types attributes:
+
+| attribute | type | description |
+|-----------|------|-------------|
+| `client` | `address` | The Codex node requesting storage. |
+| `ask` | `Ask` | Parameters of Request. |
+| `content` | `Content` | The dataset that will be hosted with the storage request. |
+| `expiry` | `uint64` | Timeout in seconds during which all the slots have to be filled, otherwise Request will get cancelled. The final deadline timestamp is calculated at the moment the transaction is mined. |
+| `nonce` | `bytes32` | Random value to differentiate from other requests of same parameters. It SHOULD be a random byte array. |
+| `pricePerBytePerSecond` | `uint256` | Amount of tokens that will be awarded to SPs for finishing the storage request. It MUST be an amount of tokens offered per slot per second per byte. The Ethereum address that submits the `requestStorage()` transaction MUST have [approval](https://docs.openzeppelin.com/contracts/2.x/api/token/erc20#IERC20-approve-address-uint256-) for the transfer of at least an equivalent amount of full reward (`pricePerBytePerSecond * duration * slots * slotSize`) in tokens. |
+| `collateralPerByte` | `uint256` | The amount of tokens per byte of slot's size that SPs submit when they fill slots. Collateral is then slashed or forfeited if SPs fail to provide the service requested by the storage request (more information in the [Slashing](#### Slashing) section). |
+| `proofProbability` | `uint256` | Determines the average frequency that a proof is required within a period: $\frac{1}{proofProbability}$. SPs are required to provide proofs of storage to the marketplace contract when challenged. To prevent hosts from only coming online when proofs are required, the frequency at which proofs are requested from SPs is stochastic and is influenced by the `proofProbability` parameter. |
+| `duration` | `uint64` | Total duration of the storage request in seconds. It MUST NOT exceed the limit specified in the configuration `config.requestDurationLimit`. |
+| `slots` | `uint64` | The number of requested slots. The slots will all have the same size. |
+| `slotSize` | `uint64` | Amount of storage per slot in bytes. |
+| `maxSlotLoss` | `uint64` |  Max slots that can be lost without data considered to be lost. |
+| `cid`     | `bytes` | An identifier used to locate the Manifest representing the dataset. It MUST be a [CIDv1](https://github.com/multiformats/cid#cidv1), SHA-256 [multihash](https://github.com/multiformats/multihash) and the data it represents SHOULD be discoverable in the network, otherwise the request will be eventually canceled. |
+| `merkleRoot` | `bytes32` | Merkle root of the dataset, used to verify storage proofs |
+
+#### Renewal of Storage Requests
+
+It should be noted that the marketplace does not support extending requests. It is REQUIRED that if the user wants to extend the duration of a request, a new request with the same CID must be [created](### Creating Storage Requests) **before the original request completes**.
+
+This ensures that the data will continue to persist in the network at the time when the new (or existing) SPs need to retrieve the complete dataset to fill the slots of the new request.
+
+### Monitoring and State Management
+
+Client nodes MUST implement the following smart contract interactions for monitoring and state management:
+
+- **getRequest(requestId)**: Retrieve the full `StorageRequest` data from the marketplace. This function is used for recovery and state verification after restarts or failures.
+
+- **requestState(requestId)**: Query the current state of a storage request. Used for monitoring request progress and determining the appropriate client actions.
+
+- **requestExpiresAt(requestId)**: Query when the request will expire if not fulfilled.
+
+- **getRequestEnd(requestId)**: Query when a fulfilled request will end (used to determine when to call `freeSlot` or `withdrawFunds`).
+
+Client nodes MUST subscribe to the following marketplace events:
+
+- **RequestFulfilled(requestId)**: Emitted when a storage request has enough filled slots to start. Clients monitor this event to determine when their request becomes active and transitions from the submission phase to the active phase.
+
+- **RequestFailed(requestId)**: Emitted when a storage request fails due to proof failures or other reasons. Clients observe this event to detect failed requests and initiate fund withdrawal.
+
+### Withdrawing Funds
+
+The client node MUST monitor the status of the requests it created. When a storage request enters the `Cancelled`, `Failed`, or `Finished` state, the client node MUST initiate the withdrawal of the remaining or refunded funds from the smart contract using the `withdrawFunds(requestId)` function.
+
+Request states are determined as follows:
+
+- The request is considered `Cancelled` if no `RequestFulfilled(requestId)` event is observed during the timeout specified by the value returned from the `requestExpiresAt(requestId)` function.
+- The request is considered `Failed` when the `RequestFailed(requestId)` event is observed.
+- The request is considered `Finished` after the interval specified by the value returned from the `getRequestEnd(requestId)` function has elapsed.
+
+## Storage Provider Role
+
+A Codex node acting as an SP persists data across the network by hosting slots requested by clients in their storage requests.
+
+The following tasks need to be considered when hosting a slot:
+
+- Filling a slot
+- Proving
+- Repairing a slot
+- Collecting request reward and collateral
+
+### Filling Slots
+
+When a new request is created, the `StorageRequested(requestId, ask, expiry)` event is emitted with the following properties:
+
+- `requestId` - the ID of the request.
+- `ask` - the specification of the request parameters. For details, see the definition of the `Request` type in the [Creating Storage Requests](### Creating Storage Requests) section above.
+- `expiry` - a Unix timestamp specifying when the request will be canceled if all slots are not filled by then.
+
+It is then up to the SP node to decide, based on the emitted parameters and node's operator configuration, whether it wants to participate in the request and attempt to fill its slot(s) (note that one SP can fill more than one slot). If the SP node decides to ignore the request, no further action is required. However, if the SP decides to fill a slot, it MUST follow the remaining steps described below.
+
+The node acting as an SP MUST decide which slot, specified by the slot index, it wants to fill. The SP MAY attempt to fill more than one slot. To fill a slot, the SP MUST first reserve the slot in the smart contract using `reserveSlot(requestId, slotIndex)`. If reservations for this slot are full, or if the SP has already reserved the slot, the transaction will revert. If the reservation was unsuccessful, then the SP is not allowed to fill the slot. If the reservation was successful, the node MUST then download the slot data using the CID of the manifest (**TODO: Manifest RFC**) and the slot index. The CID is specified in `request.content.cid`, which can be retrieved from the smart contract using `getRequest(requestId)`. Then, the node MUST generate a proof over the downloaded data (**TODO: Proving RFC**).
+
+When the proof is ready, the SP MUST call `fillSlot()` on the smart contract with the following REQUIRED parameters:
+
+- `requestId` - the ID of the request.
+- `slotIndex` - the slot index that the node wants to fill.
+- `proof` - the `Groth16Proof` proof structure, generated over the slot data.
+
+The Ethereum address of the SP node from which the transaction originates MUST have [approval](https://docs.openzeppelin.com/contracts/2.x/api/token/erc20#IERC20-approve-address-uint256-) for the transfer of at least the amount of tokens required as collateral for the slot (`collateralPerByte * slotSize`).
+
+If the proof delivered by the SP is invalid or the slot was already filled by another SP, then the transaction will revert. Otherwise, a `SlotFilled(requestId, slotIndex)` event is emitted. If the transaction is successful, the SP SHOULD transition into the **proving** state, where it will need to submit proof of data possession when challenged by the smart contract.
+
+It should be noted that if the SP node observes a `SlotFilled` event for the slot it is currently downloading the dataset for or generating the proof for, it means that the slot has been filled by another node in the meantime. In response, the SP SHOULD stop its current operation and attempt to fill a different, unfilled slot.
+
+### Proving
+
+Once an SP fills a slot, it MUST submit proofs to the marketplace contract when a challenge is issued by the contract. SPs SHOULD detect that a proof is required for the current period using the `isProofRequired(slotId)` function, or that it will be required using the `willProofBeRequired(slotId)` function in the case that the [proving clock pointer is in downtime](https://github.com/codex-storage/codex-research/blob/41c4b4409d2092d0a5475aca0f28995034e58d14/design/storage-proof-timing.md).
+
+Once an SP knows it has to provide a proof it MUST get the proof challenge using `getChallenge(slotId)`, which then
+MUST be incorporated into the proof generation as described in Proving RFC (**TODO: Proving RFC**).
+
+When the proof is generated, it MUST be submitted by calling the `submitProof(slotId, proof)` smart contract function.
+
+#### Slashing
+
+There is a slashing scheme orchestrated by the smart contract to incentivize correct behavior and proper proof submissions by SPs. This scheme is configured at the smart contract level and applies uniformly to all participants in the network. The configuration of the slashing scheme can be obtained via the `configuration()` contract call.
+
+The slashing works as follows:
+
+- When SP misses a proof and a validator trigger detection of this event using the `markProofAsMissing()` call, the SP is slashed by `config.collateral.slashPercentage` **of the originally required collateral** (hence the slashing amount is always the same for a given request).
+- If the number of slashes exceeds `config.collateral.maxNumberOfSlashes`, the slot is freed, the remaining collateral is burned, and the slot is offered to other nodes for repair. The smart contract also emits the `SlotFreed(requestId, slotIndex)` event.
+
+If, at any time, the number of freed slots exceeds the value specified by the `request.ask.maxSlotLoss` parameter, the dataset is considered lost, and the request is deemed _failed_. The collateral of all SPs that hosted the slots associated with the storage request is burned, and the `RequestFailed(requestId)` event is emitted.
+
+### Repair
+
+When a slot is freed due to too many missed proofs, which SHOULD be detected by listening to the `SlotFreed(requestId, slotIndex)` event, an SP node can decide whether to participate in repairing the slot. Similar to filling a slot, the node SHOULD consider the operator's configuration when making this decision. The SP that originally hosted the slot but failed to comply with proving requirements MAY also participate in the repair. However, by refilling the slot, the SP **will not** recover its original collateral and must submit new collateral using the `fillSlot()` call.
+
+The repair process is similar to filling slots. If the original slot dataset is no longer present in the network, the SP MAY use erasure coding to reconstruct the dataset. Reconstructing the original slot dataset requires retrieving other pieces of the dataset stored in other slots belonging to the request. For this reason, the node that successfully repairs a slot is entitled to an additional reward. (**TODO: Implementation**)
+
+The repair process proceeds as follows:
+
+1. The SP observes the `SlotFreed` event and decides to repair the slot.
+2. The SP MUST reserve the slot with the `reserveSlot(requestId, slotIndex)` call. For more information see the [Filling Slots](###filling slots) section.
+3. The SP MUST download the chunks of data required to reconstruct the freed slot's data. The node MUST use the [Reed-Solomon algorithm](https://hackmd.io/FB58eZQoTNm-dnhu0Y1XnA) to reconstruct the missing data.
+4. The SP MUST generate proof over the reconstructed data.
+5. The SP MUST call the `fillSlot()` smart contract function with the same parameters and collateral allowance as described in the [Filling Slots](###filling slots) section.
+
+### Collecting Funds
+
+An SP node SHOULD monitor the requests and the associated slots it hosts.
+
+When a storage request enters the `Cancelled`, `Finished`, or `Failed` state, the SP node SHOULD call the `freeSlot(slotId)` smart contract function.
+
+The aforementioned storage request states (`Cancelled`, `Finished`, and `Failed`) can be detected as follows:
+
+- A storage request is considered `Cancelled` if no `RequestFulfilled(requestId)` event is observed within the time indicated by the `expiry` request parameter. Note that a `RequestCancelled` event may also be emitted, but the node SHOULD NOT rely on this event to assert the request expiration, as the `RequestCancelled` event is not guaranteed to be emitted at the time of expiry.
+- A storage request is considered `Finished` when the time indicated by the value returned from the `getRequestEnd(requestId)` function has elapsed.
+- A node concludes that a storage request has `Failed` upon observing the `RequestFailed(requestId)` event.
+
+For each of the states listed above, different funds are handled as follows:
+
+- In the `Cancelled` state, the collateral is returned along with a proportional payout based on the time the node actually hosted the dataset before the expiry was reached.
+- In the `Finished` state, the full reward for hosting the slot, along with the collateral, is collected.
+- In the `Failed` state, no funds are collected. The reward is returned to the client, and the collateral is burned. The slot is removed from the list of slots and is no longer included in the list of slots returned by the `mySlots()` function.
+
+## Validator Role
+
+In a blockchain, a contract cannot change its state without a transaction and gas initiating the state change. Therefore, our smart contract requires an external trigger to periodically check and confirm that a storage proof has been delivered by the SP. This is where the validator role is essential.
+
+The validator role is fulfilled by nodes that help to verify that SPs have submitted the required storage proofs.
+
+It is the smart contract that checks if the proof requested from an SP has been delivered. The validator only triggers the decision-making function in the smart contract. To incentivize validators, they receive a reward each time they correctly mark a proof as missing corresponding to the percentage of the slashed collateral defined by `config.collateral.validatorRewardPercentage`.
+
+Each time a validator observes the `SlotFilled` event, it SHOULD add the slot reported in the `SlotFilled` event to the validator's list of watched slots. Then, after the end of each period, a validator has up to `config.proofs.timeout` seconds (a configuration parameter retrievable with `configuration()`) to validate all the slots. If a slot lacks the required proof, the validator SHOULD call the `markProofAsMissing(slotId, period)` function on the smart contract. This function validates the correctness of the claim, and if right, will send a reward to the validator.
+
+If validating all the slots observed by the validator is not feasible within the specified `timeout`, the validator MAY choose to validate only a subset of the observed slots.
+
+---
+
+## Part II: Implementation Suggestions
+
+> **IMPORTANT**: The sections above (Abstract through Validator Role) define the normative Codex Marketplace protocol requirements. All implementations MUST comply with those protocol requirements to participate in the Codex network.
+>
+> **The sections below are non-normative**. They document implementation approaches used in the nim-codex reference implementation. These are suggestions to guide implementors but are NOT required by the protocol. Alternative implementations MAY use different approaches as long as they satisfy the protocol requirements defined in Part I.
+
+## Implementation Suggestions
+
+This section describes implementation approaches used in reference implementations. These are **suggestions and not normative requirements**. Implementations are free to use different internal architectures, state machines, and data structures as long as they correctly implement the protocol requirements defined above.
+
+### Storage Provider Implementation
+
+The nim-codex reference implementation provides a complete Storage Provider implementation with state machine management, slot queueing, and resource management. This section documents the nim-codex approach.
+
+#### State Machine
+
+The Sales module implements a deterministic state machine for each slot, progressing through the following states:
+
+1. **SalePreparing** - Find a matching availability and create a reservation
+2. **SaleSlotReserving** - Reserve the slot on the marketplace
+3. **SaleDownloading** - Stream and persist the slot's data
+4. **SaleInitialProving** - Wait for stable challenge and generate initial proof
+5. **SaleFilling** - Compute collateral and fill the slot
+6. **SaleFilled** - Post-filling operations and expiry updates
+7. **SaleProving** - Generate and submit proofs periodically
+8. **SalePayout** - Free slot and calculate collateral
+9. **SaleFinished** - Terminal success state
+10. **SaleFailed** - Free slot on market and transition to error
+11. **SaleCancelled** - Cancellation path
+12. **SaleIgnored** - Sale ignored (no matching availability or other conditions)
+13. **SaleErrored** - Terminal error state
+14. **SaleUnknown** - Recovery state for crash recovery
+15. **SaleProvingSimulated** - Proving with injected failures for testing
+
+All states move to `SaleErrored` if an error is raised.
+
+##### SalePreparing
+
+- Find a matching availability based on the following criteria: `freeSize`, `duration`, `collateralPerByte`, `minPricePerBytePerSecond` and `until`
+- Create a reservation
+- Move to `SaleSlotReserving` if successful
+- Move to `SaleIgnored` if no availability is found or if `BytesOutOfBoundsError` is raised because of no space available.
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleSlotReserving
+
+- Check if the slot can be reserved
+- Move to `SaleDownloading` if successful
+- Move to `SaleIgnored` if `SlotReservationNotAllowedError` is raised or the slot cannot be reserved. The collateral is returned.
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleDownloading
+
+- Select the correct data expiry:
+  - When the request is started, the request end date is used
+  - Otherwise the expiry date is used
+- Stream and persist data via `onStore`
+- For each written batch, release bytes from the reservation
+- Move to `SaleInitialProving` if successful
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+- Move to `SaleFilled` on `SlotFilled` event from the `marketplace`
+
+##### SaleInitialProving
+
+- Wait for a stable initial challenge
+- Produce the initial proof via `onProve`
+- Move to `SaleFilling` if successful
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleFilling
+
+- Get the slot collateral
+- Fill the slot
+- Move to `SaleFilled` if successful
+- Move to `SaleIgnored` on `SlotStateMismatchError`. The collateral is returned.
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleFilled
+
+- Ensure that the current host has filled the slot by checking the signer address
+- Notify by calling `onFilled` hook
+- Call `onExpiryUpdate` to change the data expiry from expiry date to request end date
+- Move to `SaleProving` (or `SaleProvingSimulated` for simulated mode)
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleProving
+
+- For each period: fetch challenge, call `onProve`, and submit proof
+- Move to `SalePayout` when the slot request ends
+- Re-raise `SlotFreedError` when the slot is freed
+- Raise `SlotNotFilledError` when the slot is not filled
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleProvingSimulated
+
+- Submit invalid proofs every `N` periods (`failEveryNProofs` in configuration) to test failure scenarios
+
+##### SalePayout
+
+- Get the current collateral and try to free the slot to ensure that the slot is freed after payout.
+- Forward the returned collateral to cleanup
+- Move to `SaleFinished` if successful
+- Move to `SaleFailed` on `RequestFailed` event from the `marketplace`
+- Move to `SaleCancelled` on cancelled timer elapsed, set to storage contract expiry
+
+##### SaleFinished
+
+- Call `onClear` hook
+- Call `onCleanUp` hook
+
+##### SaleFailed
+
+- Free the slot
+- Move to `SaleErrored` with the failure message
+
+##### SaleCancelled
+
+- Ensure that the node hosting the slot frees the slot
+- Call `onClear` hook
+- Call `onCleanUp` hook with the current collateral
+
+##### SaleIgnored
+
+- Call `onCleanUp` hook with the current collateral
+
+##### SaleErrored
+
+- Call `onClear` hook
+- Call `onCleanUp` hook
+
+##### SaleUnknown
+
+- Recovery entry: get the `on-chain` state and jump to the appropriate state
+
+#### Slot Queue
+
+Slot queue schedules slot work and instantiates one `SalesAgent` per item with bounded concurrency.
+
+- Accepts `(requestId, slotIndex, …)` items and orders them by priority
+- Spawns one `SalesAgent` for each dequeued item, in other words, one item for one agent
+- Caps concurrent agents to `maxWorkers`
+- Supports pause/resume
+- Allows controlled requeue when an agent finishes with `reprocessSlot`
+
+##### Slot Ordering
+
+The criteria are in the following order:
+
+1) **Unseen before seen** - Items that have not been seen are dequeued first.
+2) **More profitable first** - Higher `profitability` wins. `profitability` is `duration * pricePerSlotPerSecond`.
+3) **Less collateral first** - The item with the smaller `collateral` wins.
+4) **Later expiry first** - If both items carry an `expiry`, the one with the greater timestamp wins.
+
+Within a single request, per-slot items are shuffled before enqueuing so the default slot-index order does not influence priority.
+
+##### Pause / Resume
+
+When the Slot queue processes an item with `seen = true`, it means that the item was already evaluated against the current availabilities and did not match.
+To avoid draining the queue with untenable requests (due to insufficient availability), the queue pauses itself.
+
+The queue resumes when:
+
+- `OnAvailabilitySaved` fires after an availability update that increases one of: `freeSize`, `duration`, `minPricePerBytePerSecond`, or `totalRemainingCollateral`.
+- A new unseen item (`seen = false`) is pushed.
+- `unpause()` is called explicitly.
+
+##### Reprocess
+
+Availability matching occurs in `SalePreparing`.
+If no availability fits at that time, the sale is ignored with `reprocessSlot` to true, meaning that the slot is added back to the queue with the flag `seen` to true.
+
+##### Startup
+
+On `SlotQueue.start()`, the sales module first deletes reservations associated with inactive storage requests, then starts a new `SalesAgent` for each active storage request:
+
+- Fetch the active `on-chain` active slots.
+- Delete the local reservations for slots that are not in the active list.
+- Create a new agent for each slot and assign the `onCleanUp` callback.
+- Start the agent in the `SaleUnknown` state.
+
+#### Main Behaviour
+
+When a new slot request is received, the sales module extracts the pair `(requestId, slotIndex, …)` from the request.
+A `SlotQueueItem` is then created with metadata such as `profitability`, `collateral`, `expiry`, and the `seen` flag set to `false`.
+This item is pushed into the `SlotQueue`, where it will be prioritised according to the ordering rules.
+
+#### SalesAgent
+
+SalesAgent is the instance that executes the state machine for a single slot.
+
+- Executes the sale state machine across the slot lifecycle
+- Holds a `SalesContext` with dependencies and host hooks
+- Supports crash recovery via the `SaleUnknown` state
+- Handles errors by entering `SaleErrored`, which runs cleanup routines
+
+#### SalesContext
+
+SalesContext is a container for dependencies used by all sales.
+
+- Provides external interfaces: `Market` (marketplace) and `Clock`
+- Provides access to `Reservations`
+- Provides host hooks: `onStore`, `onProve`, `onExpiryUpdate`, `onClear`, `onSale`
+- Shares the `SlotQueue` handle for scheduling work
+- Provides configuration such as `simulateProofFailures`
+- Passed to each `SalesAgent`
+
+#### Marketplace Subscriptions
+
+The sales module subscribes to on-chain events to keep the queue and agents consistent.
+
+##### StorageRequested
+
+When the marketplace signals a new request, the sales module:
+
+- Computes collateral for free slots.
+- Creates per-slot `SlotQueueItem` entries (one per `slotIndex`) with `seen = false`.
+- Pushes the items into the `SlotQueue`.
+
+##### SlotFreed
+
+When the marketplace signals a freed slot (needs repair), the sales module:
+
+- Retrieves the request data for the `requestId`.
+- Computes collateral for repair.
+- Creates a `SlotQueueItem`.
+- Pushes the item into the `SlotQueue`.
+
+##### RequestCancelled
+
+When a request is cancelled, the sales module removes all queue items for that `requestId`.
+
+##### RequestFulfilled
+
+When a request is fulfilled, the sales module removes all queue items for that `requestId` and notifies active agents bound to the request.
+
+##### RequestFailed
+
+When a request fails, the sales module removes all queue items for that `requestId` and notifies active agents bound to the request.
+
+##### SlotFilled
+
+When a slot is filled, the sales module removes the queue item for that specific `(requestId, slotIndex)` and notifies the active agent for that slot.
+
+##### SlotReservationsFull
+
+When the marketplace signals that reservations are full, the sales module removes the queue item for that specific `(requestId, slotIndex)`.
+
+#### Reservations
+
+The Reservations module manages both Availabilities and Reservations.
+When an Availability is created, it reserves bytes in the storage module so no other modules can use those bytes.
+Before a dataset for a slot is downloaded, a Reservation is created, and the freeSize of the Availability is reduced.
+When bytes are downloaded, the reservation of those bytes in the storage module is released.
+Accounting of both reserved bytes in the storage module and freeSize in the Availability are cleaned up upon completion of the state machine.
+
+```mermaid
+graph TD
+    A[Availability] -->|creates| R[Reservation]
+    A -->|reserves bytes in| SM[Storage Module]
+    R -->|reduces| AF[Availability.freeSize]
+    R -->|downloads data| D[Dataset]
+    D -->|releases bytes to| SM
+    TC[Terminal State] -->|triggers cleanup| C[Cleanup]
+    C -->|returns bytes to| AF
+    C -->|deletes| R
+    C -->|returns collateral to| A
+```
+
+#### Hooks
+
+- **onStore**: streams data into the node's storage
+- **onProve**: produces proofs for initial and periodic proving
+- **onExpiryUpdate**: notifies the client node of a change in the expiry data
+- **onSale**: notifies that the host is now responsible for the slot
+- **onClear**: notification emitted once the state machine has concluded; used to reconcile Availability bytes and reserved bytes in the storage module
+- **onCleanUp**: cleanup hook called in terminal states to release resources, delete reservations, and return collateral to availabilities
+
+#### Error Handling
+
+- Always catch `CancelledError` from `nim-chronos` and log a trace, exiting gracefully
+- Catch `CatchableError`, log it, and route to `SaleErrored`
+
+#### Cleanup
+
+Cleanup releases resources held by a sales agent and optionally requeues the slot.
+
+- Return reserved bytes to the availability if a reservation exists
+- Delete the reservation and return any remaining collateral
+- If `reprocessSlot` is true, push the slot back into the queue marked as seen
+- Remove the agent from the sales set and track the removal future
+
+#### Resource Management Approach
+
+The nim-codex implementation uses Availabilities and Reservations to manage local storage resources:
+
+##### Reservation Management
+
+- Maintain `Availability` and `Reservation` records locally
+- Match incoming slot requests to available capacity using prioritisation rules
+- Lock capacity and collateral when creating a reservation
+- Release reserved bytes progressively during download and free all remaining resources in terminal states
+
+**Note:** Availabilities and Reservations are completely local to the Storage Provider implementation and are not visible at the protocol level. They provide one approach to managing storage capacity, but other implementations may use different resource management strategies.
+
+---
+
+> **Protocol Compliance Note**: The Storage Provider implementation described above is specific to nim-codex. The only normative requirements for Storage Providers are defined in the [Storage Provider Role](#storage-provider-role) section of Part I. Implementations must satisfy those protocol requirements but may use completely different internal designs.
+
+### Client Implementation
+
+The nim-codex reference implementation provides a complete Client implementation with state machine management for storage request lifecycles. This section documents the nim-codex approach.
+
+The nim-codex implementation uses a state machine pattern to manage purchase lifecycles, providing deterministic state transitions, explicit terminal states, and recovery support. The state machine definitions (state identifiers, transitions, state descriptions, requirements, data models, and interfaces) are documented in the subsections below.
+
+> **Note**: The Purchase module terminology and state machine design are specific to the nim-codex implementation. The protocol only requires that clients interact with the marketplace smart contract as specified in the Client Role section.
+
+#### State Identifiers
+
+- PurchasePending: `pending`
+- PurchaseSubmitted: `submitted`
+- PurchaseStarted: `started`
+- PurchaseFinished: `finished`
+- PurchaseErrored: `errored`
+- PurchaseCancelled: `cancelled`
+- PurchaseFailed: `failed`
+- PurchaseUnknown: `unknown`
+
+#### General Rules for All States
+
+- If a `CancelledError` is raised, the state machine logs the cancellation message and takes no further action.
+- If a `CatchableError` is raised, the state machine moves to `errored` with the error message.
+
+#### State Transitions
+
+```text
+                                                                      |
+                                                                      v
+                                         ------------------------- unknown
+        |                               /                             /
+        v                              v                             /
+     pending ----> submitted ----> started ---------> finished <----/
+                        \              \                           /
+                         \              ------------> failed <----/
+                          \                                      /
+                           --> cancelled <-----------------------
+```
+
+**Note:**
+
+Any state can transition to errored upon a `CatchableError`.
+`failed` is an intermediate state before `errored`.
+`finished`, `cancelled`, and `errored` are terminal states.
+
+#### State Descriptions
+
+**Pending State (`pending`)**
+
+A storage request is being created by making a call `on-chain`. If the storage request creation fails, the state machine moves to the `errored` state with the corresponding error.
+
+**Submitted State (`submitted`)**
+
+The storage request has been created and the purchase waits for the request to start. When it starts, an `on-chain` event `RequestFulfilled` is emitted, triggering the subscription callback, and the state machine moves to the `started` state. If the expiry is reached before the callback is called, the state machine moves to the `cancelled` state.
+
+**Started State (`started`)**
+
+The purchase is active and waits until the end of the request, defined by the storage request parameters, before moving to the `finished` state. A subscription is made to the marketplace to be notified about request failure. If a request failure is notified, the state machine moves to `failed`.
+
+Marketplace subscription signature:
+
+```nim
+method subscribeRequestFailed*(market: Market, requestId: RequestId, callback: OnRequestFailed): Future[Subscription] {.base, async.}
+```
+
+**Finished State (`finished`)**
+
+The purchase is considered successful and cleanup routines are called. The purchase module calls `marketplace.withdrawFunds` to release the funds locked by the marketplace:
+
+```nim
+method withdrawFunds*(market: Market, requestId: RequestId) {.base, async: (raises: [CancelledError, MarketError]).}
+```
+
+After that, the purchase is done; no more states are called and the state machine stops successfully.
+
+**Failed State (`failed`)**
+
+If the marketplace emits a `RequestFailed` event, the state machine moves to the `failed` state and the purchase module calls `marketplace.withdrawFunds` (same signature as above) to release the funds locked by the marketplace. After that, the state machine moves to `errored`.
+
+**Cancelled State (`cancelled`)**
+
+The purchase is cancelled and the purchase module calls `marketplace.withdrawFunds` to release the funds locked by the marketplace (same signature as above). After that, the purchase is terminated; no more states are called and the state machine stops with the reason of failure as error.
+
+**Errored State (`errored`)**
+
+The purchase is terminated; no more states are called and the state machine stops with the reason of failure as error.
+
+**Unknown State (`unknown`)**
+
+The purchase is in recovery mode, meaning that the state has to be determined. The purchase module calls the marketplace to get the request data (`getRequest`) and the request state (`requestState`):
+
+```nim
+method getRequest*(market: Market, id: RequestId): Future[?StorageRequest] {.base, async: (raises: [CancelledError]).}
+
+method requestState*(market: Market, requestId: RequestId): Future[?RequestState] {.base, async.}
+```
+
+Based on this information, it moves to the corresponding next state.
+
+> **Note**: Functional and non-functional requirements for the client role are summarized in the [Codex Marketplace Specification](https://github.com/codex-storage/codex-spec/blob/master/specs/marketplace.md). The requirements listed below are specific to the nim-codex Purchase module implementation.
+
+#### Functional Requirements
+
+##### Purchase Definition
+
+- Every purchase MUST represent exactly one `StorageRequest`
+- The purchase MUST have a unique, deterministic identifier `PurchaseId` derived from `requestId`
+- It MUST be possible to restore any purchase from its `requestId` after a restart
+- A purchase is considered expired when the expiry timestamp in its `StorageRequest` is reached before the request start, i.e, an event `RequestFulfilled` is emitted by the `marketplace`
+
+##### State Machine Progression
+
+- New purchases MUST start in the `pending` state (submission flow)
+- Recovered purchases MUST start in the `unknown` state (recovery flow)
+- The state machine MUST progress step-by-step until a deterministic terminal state is reached
+- The choice of terminal state MUST be based on the `RequestState` returned by the `marketplace`
+
+##### Failure Handling
+
+- On marketplace failure events, the purchase MUST immediately transition to `errored` without retries
+- If a `CancelledError` is raised, the state machine MUST log the cancellation and stop further processing
+- If a `CatchableError` is raised, the state machine MUST transition to `errored` and record the error
+
+#### Non-Functional Requirements
+
+##### Execution Model
+
+A purchase MUST be handled by a single thread; only one worker SHOULD process a given purchase instance at a time.
+
+##### Reliability
+
+`load` supports recovery after process restarts.
+
+##### Performance
+
+State transitions should be non-blocking; all I/O is async.
+
+##### Logging
+
+All state transitions and errors should be clearly logged for traceability.
+
+##### Safety
+
+- Avoid side effects during `new` other than initialising internal fields; `on-chain` interactions are delegated to states using `marketplace` dependency.
+- Retry policy for external calls.
+
+##### Testing
+
+- Unit tests check that each state handles success and error properly.
+- Integration tests check that a full purchase flows correctly through states.
+
+---
+
+> **Protocol Compliance Note**: The Client implementation described above is specific to nim-codex. The only normative requirements for Clients are defined in the [Client Role](#client-role) section of Part I. Implementations must satisfy those protocol requirements but may use completely different internal designs.
+
+---
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+### Normative
+
+- [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) - Key words for use in RFCs to Indicate Requirement Levels
+- [Reed-Solomon algorithm](https://hackmd.io/FB58eZQoTNm-dnhu0Y1XnA) - Erasure coding algorithm used for data encoding
+- [CIDv1](https://github.com/multiformats/cid#cidv1) - Content Identifier specification
+- [multihash](https://github.com/multiformats/multihash) - Self-describing hashes
+- [Proof-of-Data-Possession](https://hackmd.io/2uRBltuIT7yX0CyczJevYg?view) - Zero-knowledge proof system for storage verification
+- [Original Codex Marketplace Spec](https://github.com/codex-storage/codex-spec/blob/master/specs/marketplace.md) - Source specification for this document
+
+### Informative
+
+- [Codex Implementation](https://github.com/codex-storage/nim-codex) - Reference implementation in Nim
+- [Codex market implementation](https://github.com/codex-storage/nim-codex/blob/master/codex/market.nim) - Marketplace module implementation
+- [Codex Sales Component Spec](https://github.com/codex-storage/codex-docs-obsidian/blob/main/10%20Notes/Specs/Component%20Specification%20-%20Sales.md) - Storage Provider implementation details
+- [Codex Purchase Component Spec](https://github.com/codex-storage/codex-docs-obsidian/blob/main/10%20Notes/Specs/Component%20Specification%20-%20Purchase.md) - Client implementation details
+- [Nim Chronos](https://github.com/status-im/nim-chronos) - Async/await framework for Nim
+- [Storage proof timing design](https://github.com/codex-storage/codex-research/blob/41c4b4409d2092d0a5475aca0f28995034e58d14/design/storage-proof-timing.md) - Proof timing mechanism

nomos/README.md

@@ -2,5 +2,5 @@
 
 Nomos is building a secure, flexible, and
 scalable infrastructure for developers creating applications for the network state.
-To learn more about Nomos current protocols under discussion,
-head over to [Nomos Specs](https://github.com/logos-co/nomos-specs).
+Published Specifications are currently available here,
+[Nomos Specifications](https://nomos-tech.notion.site/project).

nomos/raw/nomosda-encoding.md

@@ -0,0 +1,170 @@
+--- 
+title: NOMOSDA-ENCODING
+name: NomosDA Encoding Protocol 
+status: raw
+category: 
+tags: data-availability
+editor: Daniel Sanchez-Quiros <danielsq@status.im>
+contributors:
+- Daniel Kashepava <danielkashepava@status.im>
+- Álvaro Castro-Castilla <alvaro@status.im>
+- Filip Dimitrijevic <filip@status.im>
+- Thomas Lavaur <thomaslavaur@status.im>
+- Mehmet Gonen <mehmet@status.im>
+---
+
+## Introduction
+
+This document describes the encoding and verification processes of NomosDA, which is the data availability (DA) solution used by the Nomos blockchain. NomosDA provides an assurance that all data from Nomos blobs are accessible and verifiable by every network participant.
+
+This document presents an implementation specification describing how:
+
+- Encoders encode blobs they want to upload to the Data Availability layer.
+- Other nodes implement the verification of blobs that were already uploaded to DA.
+
+## Definitions
+
+- **Encoder**: An encoder is any actor who performs the encoding process described in this document. This involves committing to the data, generating proofs, and submitting the result to the DA layer.
+
+    In the Nomos architecture, the rollup sequencer typically acts as the encoder, but the role is not exclusive and any actor in the DA layer can also act as encoders.
+- **Verifier**: Verifies its portion of the distributed blob data as per the verification protocol. In the Nomos architecture, the DA nodes act as the verifiers.
+
+## Overview
+
+In the encoding stage, the encoder takes the DA parameters and the padded blob data and creates an initial matrix of data chunks. This matrix is expanded using Reed-Solomon coding and various commitments and proofs are created for the data.
+
+When a verifier receives a sample, it verifies the data it receives from the encoder and broadcasts the information if the data is verified. Finally, the verifier stores the sample data for the required length of time.
+
+## Construction
+
+The encoder and verifier use the [NomosDA cryptographic protocol](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21) to carry out their respective functions. These functions are implemented as abstracted and configurable software entities that allow the original data to be encoded and verified via high-level operations.
+
+### Glossary
+
+| Name | Description | Representation |
+| --- | --- | --- |
+| `Commitment` | Commitment as per the [NomosDA Cryptographic Protocol](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21) | `bytes` |
+| `Proof` | Proof as per the [NomosDA Cryptographic Protocol](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21) | `bytes` |
+| `ChunksMatrix` | Matrix of chunked data. Each chunk is **31 bytes.** Row and Column sizes depend on the encoding necessities. | `List[List[bytes]]` |
+
+### Encoder
+
+An encoder takes a set of parameters and the blob data, and creates a matrix of chunks that it uses to compute the necessary cryptographic data. It produces the set of Reed-Solomon (RS) encoded data, the commitments, and the proofs that are needed prior to [dispersal](https://www.notion.so/NomosDA-Dispersal-1fd261aa09df815288c9caf45ed72c95?pvs=21).
+
+```mermaid
+flowchart LR
+    A[DaEncoderParams] -->|Input| B(Encoder)
+    I[31bytes-padded-input] -->|Input| B
+    B -->|Creates| D[Chunks matrix]
+    D --> |Input| C[NomosDA encoding]
+    C --> E{Encoded data📄}
+```
+
+#### Encoding Process
+
+The encoder executes the encoding process as follows:
+
+1. The encoder takes the following input parameters:
+
+    ```python
+    class DAEncoderParams:
+        column_count: usize
+        bytes_per_field_element: usize
+    ```
+
+    | Name | Description | Representation |
+    | --- | --- | --- |
+    | `column_count` | The number of subnets available for dispersal in the system | `usize`, `int` in Python |
+    | `bytes_per_field_element` | The amount of bytes per data chunk. This is set to 31 bytes. Each chunk has 31 bytes rather than 32 to ensure that the chunk value does not exceed the maximum value on the [BLS12-381 elliptic curve](https://electriccoin.co/blog/new-snark-curve/). | `usize`, `int` in Python |
+
+2. The encoder also includes the blob data to be encoded, which must be of a size that is a multiple of `bytes_per_field_element` bytes. Clients are responsible for padding the data so it fits this constraint.
+3. The encoder splits the data into `bytes_per_field_element`-sized chunks. It also arranges these chunks into rows and columns, creating a matrix.
+    a. The amount of columns of the matrix needs to fit with the `column_count` parameter, taking into account the `rs_expansion_factor` (currently fixed to 2).
+        i. This means that the size of each row in this matrix is `(bytes_per_field_element*column_count)/rs_expansion_factor`.
+    b. The amount of rows depends on the size of the data.
+4. The data is encoded as per [the cryptographic details](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21).
+5. The encoder provides the encoded data set:
+
+    | Name | Description | Representation |
+    | --- | --- | --- |
+    | `data` | Original data | `bytes` |
+    | `chunked_data` | Matrix before RS expansion | `ChunksMatrix` |
+    | `extended_matrix` | Matrix after RS expansion | `ChunksMatrix` |
+    | `row_commitments` | Commitments for each matrix row | `List[Commitment]` |
+    | `combined_column_proofs` | Proofs for each matrix column | `List[Proof]` |
+
+    ```python
+    class EncodedData:
+        data: bytes
+        chunked_data: ChunksMatrix
+        extended_matrix: ChunksMatrix
+        row_commitments: List[Commitment]
+        combined_column_proofs: List[Proof]
+    ```
+
+#### Encoder Limits
+
+NomosDA does not impose a fixed limit on blob size at the encoding level. However, protocols that involve resource-intensive operations must include upper bounds to prevent abuse. In the case of NomosDA, blob size limits are expected to be enforced, as part of the protocol's broader responsibility for resource management and fairness.
+
+Larger blobs naturally result in higher computational and bandwidth costs, particularly for the encoder, who must compute a proof for each column. Without size limits, malicious clients could exploit the system by attempting to stream unbounded data to DA nodes. Since payment is provided before blob dispersal, DA nodes are protected from performing unnecessary work. This enables the protocol to safely accept very large blobs, as the primary computational cost falls on the encoder. The protocol can accommodate generous blob sizes in practice, while rejecting only absurdly large blobs, such as those exceeding 1 GB, to prevent denial-of-service attacks and ensure network stability.
+
+To mitigate this, the protocol define acceptable blob size limits, and DA implementations enforce local mitigation strategies, such as flagging or blacklisting clients that violate these constraints.
+
+### Verifier
+
+A verifier checks the proper encoding of data blobs it receives. A verifier executes the verification process as follows:
+
+1. The verifier receives a `DAShare` with the required verification data:
+
+    | Name | Description | Representation |
+    | --- | --- | --- |
+    | `column` | Column chunks (31 bytes) from the encoded matrix | `List[bytes]` |
+    | `column_idx` | Column id (`0..2047`). It is directly related to the `subnetworks` in the [network specification](https://www.notion.so/NomosDA-Network-Specification-1fd261aa09df81188e76cb083791252d?pvs=21). | `u16`, unsigned int of 16 bits. `int` in Python |
+    | `combined_column_proof` | Proof of the random linear combination of the column elements. | `Proof` |
+    | `row_commitments` | Commitments for each matrix row | `List[Commitment]` |
+    | `blob_id` | This is computed as the hash (**blake2b**) of `row_commitments` | `bytes` |
+
+2. Upon receiving the above data it verifies the column data as per the [cryptographic details](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21). If the verification is successful, the node triggers the [replication protocol](https://www.notion.so/NomosDA-Subnetwork-Replication-1fd261aa09df811d93f8c6280136bfbb?pvs=21) and stores the blob.
+
+    ```python
+    class DAShare:
+        column: Column
+        column_idx: u16
+        combined_column_proof: Proof
+        row_commitments: List[Commitment]
+
+        def blob_id(self) -> BlobId:
+            hasher = blake2b(digest_size=32)
+            for c in self.row_commitments:
+                hasher.update(bytes(c))
+            return hasher.digest()
+    ```
+
+### Verification Logic
+
+```mermaid
+sequenceDiagram
+    participant N as Node
+    participant S as Subnetwork Column N
+    loop For each incoming blob column
+        N-->>N: If blob is valid
+        N-->>S: Replication
+        N->>N: Stores blob
+    end
+```
+
+## Details
+
+The encoder and verifier processes described above make use of a variety of cryptographic functions to facilitate the correct verification of column data by verifiers. These functions rely on primitives such as polynomial commitments and Reed-Solomon erasure codes, the details of which are outside the scope of this document. These details, as well as introductions to the cryptographic primitives being used, can be found in the NomosDA Cryptographic Protocol:
+
+[NomosDA Cryptographic Protocol](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21)
+
+## References
+
+- Encoder Specification: [GitHub/encoder.py](https://github.com/logos-co/nomos-specs/blob/master/da/encoder.py)
+- Verifier Specification: [GitHub/verifier.py](https://github.com/logos-co/nomos-specs/blob/master/da/verifier.py)
+- Cryptographic protocol: [NomosDA Cryptographic Protocol](https://www.notion.so/NomosDA-Cryptographic-Protocol-1fd261aa09df816fa97ac81304732e77?pvs=21)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

nomos/raw/nomosda-network.md

@@ -0,0 +1,255 @@
+---
+title: NOMOS-DA-NETWORK
+name: NomosDA Network
+status: raw
+category:
+tags: network, data-availability, da-nodes, executors, sampling
+editor: Daniel Sanchez Quiros <danielsq@status.im>
+contributors:
+- Álvaro Castro-Castilla <alvaro@status.im>
+- Daniel Kashepava <danielkashepava@status.im>
+- Gusto Bacvinka <augustinas@status.im>
+- Filip Dimitrijevic <filip@status.im>
+---
+
+## Introduction
+
+NomosDA is the scalability solution protocol for data availability within the Nomos network.
+This document delineates the protocol's structure at the network level,
+identifies participants,
+and describes the interactions among its components.  
+Please note that this document does not delve into the cryptographic aspects of the design.
+For comprehensive details on the cryptographic operations,
+a detailed specification is a work in progress.
+
+## Objectives
+
+NomosDA was created to ensure that data from Nomos zones is distributed, verifiable, immutable, and accessible.
+At the same time, it is optimised for the following properties:
+
+- **Decentralization**: NomosDA’s data availability guarantees must be achieved with minimal trust assumptions
+and centralised actors. Therefore,
+permissioned DA schemes involving a Data Availability Committee (DAC) had to be avoided in the design.
+Schemes that require some nodes to download the entire blob data were also off the list
+due to the disproportionate role played by these “supernodes”.
+
+- **Scalability**: NomosDA is intended to be a bandwidth-scalable protocol, ensuring that its functions are maintained as the Nomos network grows. Therefore, NomosDA was designed to minimise the amount of data sent to participants, reducing the communication bottleneck and allowing more parties to participate in the DA process.
+
+To achieve the above properties, NomosDA splits up zone data and
+distributes it among network participants,
+with cryptographic properties used to verify the data’s integrity.
+A major feature of this design is that parties who wish to receive an assurance of data availability
+can do so very quickly and with minimal hardware requirements.
+However, this comes at the cost of additional complexity and resources required by more integral participants.
+
+## Requirements
+
+In order to ensure that the above objectives are met,
+the NomosDA network requires a group of participants
+that undertake a greater burden in terms of active involvement in the protocol.
+Recognising that not all node operators can do so,
+NomosDA assigns different roles to different kinds of participants,
+depending on their ability and willingness to contribute more computing power
+and bandwidth to the protocol.
+It was therefore necessary for NomosDA to be implemented as an opt-in Service Network.
+
+Because the NomosDA network has an arbitrary amount of participants,
+and the data is split into a fixed number of portions (see the [Encoding & Verification Specification](https://www.notion.so/NomosDA-Encoding-Verification-4d8ca269e96d4fdcb05abc70426c5e7c)),
+it was necessary to define exactly how each portion is assigned to a participant who will receive and verify it.
+This assignment algorithm must also be flexible enough to ensure smooth operation in a variety of scenarios,
+including where there are more or fewer participants than the number of portions.
+
+## Overview
+
+### Network Participants
+
+The NomosDA network includes three categories of participants:
+
+- **Executors**: Tasked with the encoding and dispersal of data blobs.  
+- **DA Nodes**: Receive and verify the encoded data,
+subsequently temporarily storing it for further network validation through sampling.  
+- **Light Nodes**: Employ sampling to ascertain data availability.
+
+### Network Distribution
+
+The NomosDA network is segmented into `num_subnets` subnetworks.
+These subnetworks represent subsets of peers from the overarching network,
+each responsible for a distinct portion of the distributed encoded data.
+Peers in the network may engage in one or multiple subnetworks,
+contingent upon network size and participant count.
+
+### Sub-protocols
+
+The NomosDA protocol consists of the following sub-protocols:
+
+- **Dispersal**: Describes how executors distribute encoded data blobs to subnetworks.
+[NomosDA Dispersal](https://www.notion.so/NomosDA-Dispersal-1818f96fb65c805ca257cb14798f24d4?pvs=21)
+- **Replication**: Defines how DA nodes distribute encoded data blobs within subnetworks.
+[NomosDA Subnetwork Replication](https://www.notion.so/NomosDA-Subnetwork-Replication-1818f96fb65c80119fa0e958a087cc2b?pvs=21)
+- **Sampling**: Used by sampling clients (e.g., light clients) to verify the availability of previously dispersed
+and replicated data.
+[NomosDA Sampling](https://www.notion.so/NomosDA-Sampling-1538f96fb65c8031a44cf7305d271779?pvs=21)
+- **Reconstruction**: Describes gathering and decoding dispersed data back into its original form.
+[NomosDA Reconstruction](https://www.notion.so/NomosDA-Reconstruction-1828f96fb65c80b2bbb9f4c5a0cf26a5?pvs=21)
+- **Indexing**: Tracks and exposes blob metadata on-chain.
+[NomosDA Indexing](https://www.notion.so/NomosDA-Indexing-1bb8f96fb65c8044b635da9df20c2411?pvs=21)
+
+## Construction
+
+### NomosDA Network Registration
+
+Entities wishing to participate in NomosDA must declare their role via [SDP](https://www.notion.so/Final-Draft-Validator-Role-Protocol-17b8f96fb65c80c69c2ef55e22e29506) (Service Declaration Protocol).
+Once declared, they're accounted for in the subnetwork construction.
+
+This enables participation in:
+
+- Dispersal (as executor)
+- Replication & sampling (as DA node)
+- Sampling (as light node)
+
+### Subnetwork Assignment
+
+The NomosDA network comprises `num_subnets` subnetworks,
+which are virtual in nature.
+A subnetwork is a subset of peers grouped together so nodes know who they should connect with,
+serving as groupings of peers tasked with executing the dispersal and replication sub-protocols.
+In each subnetwork, participants establish a fully connected overlay,
+ensuring all nodes maintain permanent connections for the lifetime of the SDP set
+with peers within the same subnetwork.
+Nodes refer to nodes in the Data Availability SDP set to ascertain their connectivity requirements across subnetworks.
+
+#### Assignment Algorithm
+
+The concrete distribution algorithm is described in the following specification:
+[DA Subnetwork Assignation](https://www.notion.so/DA-Subnetwork-Assignation-217261aa09df80fc8bb9cf46092741ce)
+
+## Executor Connections
+
+Each executor maintains a connection with one peer per subnetwork,
+necessitating at least num_subnets stable and healthy connections.
+Executors are expected to allocate adequate resources to sustain these connections.
+An example algorithm for peer selection would be:
+
+```python
+def select_peers(
+    subnetworks: Sequence[Set[PeerId]],
+    filtered_subnetworks: Set[int],
+    filtered_peers: Set[PeerId]
+) -> Set[PeerId]:
+    result = set()
+    for i, subnetwork in enumerate(subnetworks):
+        available_peers = subnetwork - filtered_peers
+        if i not in filtered_subnetworks and available_peers:
+            result.add(next(iter(available_peers)))
+    return result
+```
+
+## NomosDA Protocol Steps
+
+### Dispersal
+
+1. The NomosDA protocol is initiated by executors
+who perform data encoding as outlined in the [Encoding Specification](https://www.notion.so/NomosDA-Encoding-Verification-4d8ca269e96d4fdcb05abc70426c5e7c).
+2. Executors prepare and distribute each encoded data portion
+to its designated subnetwork (from `0` to `num_subnets - 1` ).
+3. Executors might opt to perform sampling to confirm successful dispersal.
+4. Post-dispersal, executors publish the dispersed `blob_id` and metadata to the mempool. <!-- TODO: add link to dispersal document-->
+
+### Replication
+
+DA nodes receive columns from dispersal or replication
+and validate the data encoding.
+Upon successful validation,
+they replicate the validated column to connected peers within their subnetwork.
+Replication occurs once per blob; subsequent validations of the same blob are discarded.
+
+### Sampling
+
+1. Sampling is [invoked based on the node's current role](https://www.notion.so/1538f96fb65c8031a44cf7305d271779?pvs=25#15e8f96fb65c8006b9d7f12ffdd9a159).
+2. The node selects `sample_size` random subnetworks
+and queries each for the availability of the corresponding column for the sampled blob. Sampling is deemed successful only if all queried subnetworks respond affirmatively.
+
+- If `num_subnets` is 2048, `sample_size` is [20 as per the sampling research](https://www.notion.so/1708f96fb65c80a08c97d728cb8476c3?pvs=25#1708f96fb65c80bab6f9c6a946940078)
+
+```mermaid
+sequenceDiagram
+    SamplingClient ->> DANode_1: Request
+    DANode_1 -->> SamplingClient: Response
+    SamplingClient ->>DANode_2: Request
+    DANode_2 -->> SamplingClient: Response
+    SamplingClient ->> DANode_n: Request
+    DANode_n -->> SamplingClient: Response
+```
+
+### Network Schematics
+
+The overall network and protocol interactions is represented by the following diagram
+
+```mermaid
+flowchart TD
+subgraph Replication
+    subgraph Subnetwork_N
+        N10 -->|Replicate| N20
+        N20 -->|Replicate| N30
+        N30 -->|Replicate| N10
+    end
+    subgraph ...
+    end
+    subgraph Subnetwork_0
+        N1 -->|Replicate| N2
+        N2 -->|Replicate| N3
+        N3 -->|Replicate| N1
+    end
+end
+subgraph Sampling
+    N9 -->|Sample 0| N2
+    N9 -->|Sample S| N20
+end
+subgraph Dispersal
+    Executor -->|Disperse| N1
+    Executor -->|Disperse| N10
+end
+```
+
+## Details
+
+### Network specifics
+
+The NomosDA network is engineered for connection efficiency.
+Executors manage numerous open connections,
+utilizing their resource capabilities.
+DA nodes, with their resource constraints,
+are designed to maximize connection reuse.
+
+NomosDA uses [multiplexed](https://docs.libp2p.io/concepts/transports/quic/#quic-native-multiplexing) streams over [QUIC](https://docs.libp2p.io/concepts/transports/quic/) connections.
+For each sub-protocol, a stream protocol ID is defined to negotiate the protocol,
+triggering the specific protocol once established:
+
+- Dispersal: /nomos/da/{version}/dispersal
+- Replication: /nomos/da/{version}/replication
+- Sampling: /nomos/da/{version}/sampling
+
+Through these multiplexed streams,
+DA nodes can utilize the same connection for all sub-protocols.
+This, combined with virtual subnetworks (membership sets),
+ensures the overlay node distribution is scalable for networks of any size.
+
+## References
+
+- [Encoding Specification](https://www.notion.so/NomosDA-Encoding-Verification-4d8ca269e96d4fdcb05abc70426c5e7c)
+- [Encoding & Verification Specification](https://www.notion.so/NomosDA-Encoding-Verification-4d8ca269e96d4fdcb05abc70426c5e7c)
+- [NomosDA Dispersal](https://www.notion.so/NomosDA-Dispersal-1818f96fb65c805ca257cb14798f24d4?pvs=21)
+- [NomosDA Subnetwork Replication](https://www.notion.so/NomosDA-Subnetwork-Replication-1818f96fb65c80119fa0e958a087cc2b?pvs=21)
+- [DA Subnetwork Assignation](https://www.notion.so/DA-Subnetwork-Assignation-217261aa09df80fc8bb9cf46092741ce)
+- [NomosDA Sampling](https://www.notion.so/NomosDA-Sampling-1538f96fb65c8031a44cf7305d271779?pvs=21)
+- [NomosDA Reconstruction](https://www.notion.so/NomosDA-Reconstruction-1828f96fb65c80b2bbb9f4c5a0cf26a5?pvs=21)
+- [NomosDA Indexing](https://www.notion.so/NomosDA-Indexing-1bb8f96fb65c8044b635da9df20c2411?pvs=21)
+- [SDP](https://www.notion.so/Final-Draft-Validator-Role-Protocol-17b8f96fb65c80c69c2ef55e22e29506)
+- [invoked based on the node's current role](https://www.notion.so/1538f96fb65c8031a44cf7305d271779?pvs=25#15e8f96fb65c8006b9d7f12ffdd9a159)
+- [20 as per the sampling research](https://www.notion.so/1708f96fb65c80a08c97d728cb8476c3?pvs=25#1708f96fb65c80bab6f9c6a946940078)
+- [multiplexed](https://docs.libp2p.io/concepts/transports/quic/#quic-native-multiplexing)
+- [QUIC](https://docs.libp2p.io/concepts/transports/quic/)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

nomos/raw/p2p-hardware-requirements.md

@@ -0,0 +1,236 @@
+---
+title: P2P-HARDWARE-REQUIREMENTS
+name: Nomos p2p Network Hardware Requirements Specification
+status: raw
+category: infrastructure
+tags: [hardware, requirements, nodes, validators, services]
+editor: Daniel Sanchez-Quiros <danielsq@status.im>
+contributors:
+- Filip Dimitrijevic <filip@status.im>
+---
+
+## Abstract
+
+This specification defines the hardware requirements for running various types of Nomos blockchain nodes. Hardware needs vary significantly based on the node's role, from lightweight verification nodes to high-performance Zone Executors. The requirements are designed to support diverse participation levels while ensuring network security and performance.
+
+## Motivation
+
+The Nomos network is designed to be inclusive and accessible across a wide range of hardware configurations. By defining clear hardware requirements for different node types, we enable:
+
+1. **Inclusive Participation**: Allow users with limited resources to participate as Light Nodes
+2. **Scalable Infrastructure**: Support varying levels of network participation based on available resources
+3. **Performance Optimization**: Ensure adequate resources for computationally intensive operations
+4. **Network Security**: Maintain network integrity through properly resourced validator nodes
+5. **Service Quality**: Define requirements for optional services that enhance network functionality
+
+**Important Notice**: These hardware requirements are preliminary and subject to revision based on implementation testing and real-world network performance data.
+
+## Specification
+
+### Node Types Overview
+
+Hardware requirements vary based on the node's role and services:
+
+- **Light Node**: Minimal verification with minimal resources
+- **Basic Bedrock Node**: Standard validation participation
+- **Service Nodes**: Enhanced capabilities for optional network services
+
+### Light Node
+
+Light Nodes provide network verification with minimal resource requirements, suitable for resource-constrained environments.
+
+**Target Use Cases:**
+
+- Mobile devices and smartphones
+- Single-board computers (Raspberry Pi, etc.)
+- IoT devices with network connectivity
+- Users with limited hardware resources
+
+**Hardware Requirements:**
+
+| Component | Specification |
+|-----------|---------------|
+| **CPU** | Low-power processor (smartphone/SBC capable) |
+| **Memory (RAM)** | 512 MB |
+| **Storage** | Minimal (few GB) |
+| **Network** | Reliable connection, 1 Mbps free bandwidth |
+
+### Basic Bedrock Node (Validator)
+
+Basic validators participate in Bedrock consensus using typical consumer hardware.
+
+**Target Use Cases:**
+
+- Individual validators on consumer hardware
+- Small-scale validation operations
+- Entry-level network participation
+
+**Hardware Requirements:**
+
+| Component | Specification |
+|-----------|---------------|
+| **CPU** | 2 cores, 2 GHz modern multi-core processor |
+| **Memory (RAM)** | 1 GB minimum |
+| **Storage** | SSD with 100+ GB free space, expandable |
+| **Network** | Reliable connection, 1 Mbps free bandwidth |
+
+### Service-Specific Requirements
+
+Nodes can optionally run additional Bedrock Services that require enhanced resources beyond basic validation.
+
+#### Data Availability (DA) Service
+
+DA Service nodes store and serve data shares for the network's data availability layer.
+
+**Service Role:**
+
+- Store blockchain data and blob data long-term
+- Serve data shares to requesting nodes
+- Maintain high availability for data retrieval
+
+**Additional Requirements:**
+
+| Component | Specification | Rationale |
+|-----------|---------------|-----------|
+| **CPU** | Same as Basic Bedrock Node | Standard processing needs |
+| **Memory (RAM)** | Same as Basic Bedrock Node | Standard memory needs |
+| **Storage** | **Fast SSD, 500+ GB free** | Long-term chain and blob storage |
+| **Network** | **High bandwidth (10+ Mbps)** | Concurrent data serving |
+| **Connectivity** | **Stable, accessible external IP** | Direct peer connections |
+
+**Network Requirements:**
+
+- Capacity to handle multiple concurrent connections
+- Stable external IP address for direct peer access
+- Low latency for efficient data serving
+
+#### Blend Protocol Service
+
+Blend Protocol nodes provide anonymous message routing capabilities.
+
+**Service Role:**
+
+- Route messages anonymously through the network
+- Provide timing obfuscation for privacy
+- Maintain multiple concurrent connections
+
+**Additional Requirements:**
+
+| Component | Specification | Rationale |
+|-----------|---------------|-----------|
+| **CPU** | Same as Basic Bedrock Node | Standard processing needs |
+| **Memory (RAM)** | Same as Basic Bedrock Node | Standard memory needs |
+| **Storage** | Same as Basic Bedrock Node | Standard storage needs |
+| **Network** | **Stable connection (10+ Mbps)** | Multiple concurrent connections |
+| **Connectivity** | **Stable, accessible external IP** | Direct peer connections |
+
+**Network Requirements:**
+
+- Low-latency connection for effective message blending
+- Stable connection for timing obfuscation
+- Capability to handle multiple simultaneous connections
+
+#### Executor Network Service
+
+Zone Executors perform the most computationally intensive work in the network.
+
+**Service Role:**
+
+- Execute Zone state transitions
+- Generate zero-knowledge proofs
+- Process complex computational workloads
+
+**Critical Performance Note**: Zone Executors perform the heaviest computational work in the network. High-performance hardware is crucial for effective participation and may provide competitive advantages in execution markets.
+
+**Hardware Requirements:**
+
+| Component | Specification | Rationale |
+|-----------|---------------|-----------|
+| **CPU** | **Very high-performance multi-core processor** | Zone logic execution and ZK proving |
+| **Memory (RAM)** | **32+ GB strongly recommended** | Complex Zone execution requirements |
+| **Storage** | Same as Basic Bedrock Node | Standard storage needs |
+| **GPU** | **Highly recommended/often necessary** | Efficient ZK proof generation |
+| **Network** | **High bandwidth (10+ Mbps)** | Data dispersal and high connection load |
+
+**GPU Requirements:**
+
+- **NVIDIA**: CUDA-enabled GPU (RTX 3090 or equivalent recommended)
+- **Apple**: Metal-compatible Apple Silicon
+- **Performance Impact**: Strong GPU significantly reduces proving time
+
+**Network Requirements:**
+
+- Support for **2048+ direct UDP connections** to DA Nodes (for blob publishing)
+- High bandwidth for data dispersal operations
+- Stable connection for continuous operation
+
+*Note: DA Nodes utilizing [libp2p](https://docs.libp2p.io/) connections need sufficient capacity to receive and serve data shares over many connections.*
+
+## Implementation Requirements
+
+### Minimum Requirements
+
+All Nomos nodes MUST meet:
+
+1. **Basic connectivity** to the Nomos network via [libp2p](https://docs.libp2p.io/)
+2. **Adequate storage** for their designated role
+3. **Sufficient processing power** for their service level
+4. **Reliable network connection** with appropriate bandwidth for [QUIC](https://docs.libp2p.io/concepts/transports/quic/) transport
+
+### Optional Enhancements
+
+Node operators MAY implement:
+
+- Hardware redundancy for critical services
+- Enhanced cooling for high-performance configurations
+- Dedicated network connections for service nodes utilizing [libp2p](https://docs.libp2p.io/) protocols
+- Backup power systems for continuous operation
+
+### Resource Scaling
+
+Requirements may vary based on:
+
+- **Network Load**: Higher network activity increases resource demands
+- **Zone Complexity**: More complex Zones require additional computational resources
+- **Service Combinations**: Running multiple services simultaneously increases requirements
+- **Geographic Location**: Network latency affects optimal performance requirements
+
+## Security Considerations
+
+### Hardware Security
+
+1. **Secure Storage**: Use encrypted storage for sensitive node data
+2. **Network Security**: Implement proper firewall configurations
+3. **Physical Security**: Secure physical access to node hardware
+4. **Backup Strategies**: Maintain secure backups of critical data
+
+### Performance Security
+
+1. **Resource Monitoring**: Monitor resource usage to detect anomalies
+2. **Redundancy**: Plan for hardware failures in critical services
+3. **Isolation**: Consider containerization or virtualization for service isolation
+4. **Update Management**: Maintain secure update procedures for hardware drivers
+
+## Performance Characteristics
+
+### Scalability
+
+- **Light Nodes**: Minimal resource footprint, high scalability
+- **Validators**: Moderate resource usage, network-dependent scaling
+- **Service Nodes**: High resource usage, specialized scaling requirements
+
+### Resource Efficiency
+
+- **CPU Usage**: Optimized algorithms for different hardware tiers
+- **Memory Usage**: Efficient data structures for constrained environments
+- **Storage Usage**: Configurable retention policies and compression
+- **Network Usage**: Adaptive bandwidth utilization based on [libp2p](https://docs.libp2p.io/) capacity and [QUIC](https://docs.libp2p.io/concepts/transports/quic/) connection efficiency
+
+## References
+
+1. [libp2p protocol](https://docs.libp2p.io/)
+2. [QUIC protocol](https://docs.libp2p.io/concepts/transports/quic/)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

nomos/raw/p2p-nat-solution.md

@@ -0,0 +1,377 @@
+---
+title: P2P-NAT-SOLUTION
+name: Nomos P2P Network NAT Solution Specification
+status: raw
+category: networking
+tags: [nat, traversal, autonat, upnp, pcp, nat-pmp]
+editor: Antonio Antonino <antonio@status.im>
+contributors:
+- Álvaro Castro-Castilla <alvaro@status.im>
+- Daniel Sanchez-Quiros <danielsq@status.im>
+- Petar Radovic <petar@status.im>
+- Gusto Bacvinka <augustinas@status.im>
+- Youngjoon Lee <youngjoon@status.im>
+- Filip Dimitrijevic <filip@status.im>
+---
+
+## Abstract
+
+This specification defines a comprehensive NAT (Network Address Translation) traversal solution for the Nomos P2P network. The solution enables nodes to automatically determine their NAT status and establish both outbound and inbound connections regardless of network configuration. The strategy combines [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md), dynamic port mapping protocols, and continuous verification to maximize public reachability while maintaining decentralized operation.
+
+## Motivation
+
+Network Address Translation presents a critical challenge for Nomos participants, particularly those operating on consumer hardware without technical expertise. The Nomos network requires a NAT traversal solution that:
+
+1. **Automatic Operation**: Works out-of-the-box without user configuration
+2. **Inclusive Participation**: Enables nodes on consumer hardware to participate effectively
+3. **Decentralized Approach**: Leverages the existing Nomos P2P network rather than centralized services
+4. **Progressive Fallback**: Escalates through increasingly complex protocols as needed
+5. **Dynamic Adaptation**: Handles changing network environments and configurations
+
+The solution must ensure that nodes can both establish outbound connections and accept inbound connections from other peers, maintaining network connectivity across diverse NAT configurations.
+
+## Specification
+
+### Terminology
+
+- **Public Node**: A node that is publicly reachable via a public IP address or valid port mapping
+- **Private Node**: A node that is not publicly reachable due to NAT/firewall restrictions
+- **Dialing**: The process of establishing a connection using the [libp2p protocol](https://docs.libp2p.io/) stack
+- **NAT Status**: Whether a node is publicly reachable or hidden behind NAT
+
+### Key Design Principles
+
+#### Optional Configuration
+
+The NAT traversal strategy must work out-of-the-box whenever possible. Users who do not want to engage in configuration should only need to install the node software package. However, users requiring full control must be able to configure every aspect of the strategy.
+
+#### Decentralized Operation
+
+The solution leverages the existing Nomos P2P network for coordination rather than relying on centralized third-party services. This maintains the decentralized nature of the network while providing necessary NAT traversal capabilities.
+
+#### Progressive Fallback
+
+The protocol begins with lightweight checks and escalates through more complex and resource-intensive protocols. Failure at any step moves the protocol to the next stage in the strategy, ensuring maximum compatibility across network configurations.
+
+#### Dynamic Network Environment
+
+Unless explicitly configured for static addresses, each node's public or private status is assumed to be dynamic. A once publicly-reachable node can become unreachable and vice versa, requiring continuous monitoring and adaptation.
+
+### Node Discovery Considerations
+
+The Nomos public network encourages participation from a large number of nodes, many deployed through simple installation procedures. Some nodes will not achieve Public status, but the discovery protocol must track these peers and allow other nodes to discover them. This prevents network partitioning and ensures Private nodes remain accessible to other participants.
+
+### NAT Traversal Protocol
+
+#### Protocol Requirements
+
+**Each node MUST:**
+
+- Run an [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) client, except for nodes statically configured as Public
+- Use the [Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md) to advertise support for:
+  - `/nomos/autonat/2/dial-request` for main network
+  - `/nomos-testnet/autonat/2/dial-request` for public testnet
+  - `/nomos/autonat/2/dial-back` and `/nomos-testnet/autonat/2/dial-back` respectively
+
+#### NAT State Machine
+
+The NAT traversal process follows a multi-phase state machine:
+
+```mermaid
+graph TD
+  Start@{shape: circle, label: "Start"} -->|Preconfigured public IP or port mapping| StaticPublic[Statically configured as<br/>**Public**]
+  subgraph Phase0 [Phase 0]
+  Start -->|Default configuration| Boot
+  end
+  subgraph Phase1 [Phase 1]
+  Boot[Bootstrap and discover AutoNAT servers]--> Inspect
+  Inspect[Inspect own IP addresses]-->|At least 1 IP address in the public range| ConfirmPublic[AutoNAT]
+  end
+  subgraph Phase2 [Phase 2]
+  Inspect -->|No IP addresses in the public range| MapPorts[Port Mapping Client<br/>UPnP/NAT-PMP/PCP]
+  MapPorts -->|Successful port map| ConfirmMapPorts[AutoNAT]
+  end
+  ConfirmPublic -->|Node's IP address reachable by AutoNAT server| Public[**Public** Node]
+  ConfirmPublic -->|Node's IP address not reachable by AutoNAT server or Timeout| MapPorts
+  ConfirmMapPorts -->|Mapped IP address and port reachable by AutoNAT server| Public
+  ConfirmMapPorts -->|Mapped IP address and port not reachable by AutoNAT server or Timeout| Private
+  MapPorts -->|Failure or Timeout| Private[**Private** Node]
+  subgraph Phase3 [Phase 3]
+  Public -->Monitor
+  Private --> Monitor
+  end
+  Monitor[Network Monitoring] -->|Restart| Inspect
+```
+
+### Phase Implementation
+
+#### Phase 0: Bootstrapping and Identifying Public Nodes
+
+If the node is statically configured by the operator to be Public, the procedure stops here.
+
+The node utilizes bootstrapping and discovery mechanisms to find other Public nodes. The [Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md) confirms which detected Public nodes support [AutoNAT v2](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md).
+
+#### Phase 1: NAT Detection
+
+The node starts an [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) client and inspects its own addresses. For each public IP address, the node verifies public reachability via [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md). If any public IP addresses are confirmed, the node assumes Public status and moves to Phase 3. Otherwise, it continues to Phase 2.
+
+#### Phase 2: Automated Port Mapping
+
+The node attempts to secure port mapping on the default gateway using:
+
+- **[PCP](https://datatracker.ietf.org/doc/html/rfc6887)** (Port Control Protocol) - Most reliable
+- **[NAT-PMP](https://datatracker.ietf.org/doc/html/rfc6886)** (NAT Port Mapping Protocol) - Second most reliable  
+- **[UPnP-IGD](https://datatracker.ietf.org/doc/html/rfc6970)** (Universal Plug and Play Internet Gateway Device) - Most widely deployed
+
+**Port Mapping Algorithm:**
+
+```python
+def try_port_mapping():
+    # Step 1: Get the local IPv4 address
+    local_ip = get_local_ipv4_address()
+    
+    # Step 2: Get the default gateway IPv4 address
+    gateway_ip = get_default_gateway_address()
+    
+    # Step 3: Abort if local or gateway IP could not be determined
+    if not local_ip or not gateway_ip:
+        return "Mapping failed: Unable to get local or gateway IPv4"
+
+    # Step 4: Probe the gateway for protocol support
+    supports_pcp = probe_pcp(gateway_ip)
+    supports_nat_pmp = probe_nat_pmp(gateway_ip)
+    supports_upnp = probe_upnp(gateway_ip)  # Optional for logging
+
+    # Step 5-9: Try protocols in order of reliability
+    # PCP (most reliable) -> NAT-PMP -> UPnP -> fallback attempts
+    
+    protocols = [
+        (supports_pcp, try_pcp_mapping),
+        (supports_nat_pmp, try_nat_pmp_mapping),
+        (True, try_upnp_mapping),  # Always try UPnP
+        (not supports_pcp, try_pcp_mapping),  # Fallback
+        (not supports_nat_pmp, try_nat_pmp_mapping)  # Last resort
+    ]
+    
+    for supported, mapping_func in protocols:
+        if supported:
+            mapping = mapping_func(local_ip, gateway_ip)
+            if mapping:
+                return mapping
+    
+    return "Mapping failed: No protocol succeeded"
+```
+
+If mapping succeeds, the node uses [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) to confirm public reachability. Upon confirmation, the node assumes Public status. Otherwise, it assumes Private status.
+
+**Port Mapping Sequence:**
+
+```mermaid
+sequenceDiagram
+    box Node
+        participant AutoNAT Client
+        participant NAT State Machine
+        participant Port Mapping Client
+    end
+    participant Router
+    
+    alt Mapping is successful
+        Note left of AutoNAT Client: Phase 2
+        Port Mapping Client ->> +Router: Requests new mapping
+        Router ->> Port Mapping Client: Confirms new mapping
+        Port Mapping Client ->> NAT State Machine: Mapping secured
+        NAT State Machine ->> AutoNAT Client: Requests confirmation<br/>that mapped address<br/>is publicly reachable
+        
+        alt Node asserts Public status
+            AutoNAT Client ->> NAT State Machine: Mapped address<br/>is publicly reachable
+            Note left of AutoNAT Client: Phase 3<br/>Network Monitoring
+        else Node asserts Private status
+            AutoNAT Client ->> NAT State Machine: Mapped address<br/>is not publicly reachable
+            Note left of AutoNAT Client: Phase 3<br/>Network Monitoring
+        end
+    else Mapping fails, node asserts Private status
+        Note left of AutoNAT Client: Phase 2
+        Port Mapping Client ->> Router: Requests new mapping
+        Router ->> Port Mapping Client: Refuses new mapping or Timeout
+        Port Mapping Client ->> NAT State Machine: Mapping failed
+        Note left of AutoNAT Client: Phase 3<br/>Network Monitoring
+    end
+```
+
+#### Phase 3: Network Monitoring
+
+Unless explicitly configured, nodes must monitor their network status and restart from Phase 1 when changes are detected.
+
+**Public Node Monitoring:**
+
+A Public node must restart when:
+
+- [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) client no longer confirms public reachability
+- A previously successful port mapping is lost or refresh fails
+
+**Private Node Monitoring:**
+
+A Private node must restart when:
+
+- It gains a new public IP address
+- Port mapping is likely to succeed (gateway change, sufficient time passed)
+
+**Network Monitoring Sequence:**
+
+```mermaid
+sequenceDiagram
+    participant AutoNAT Server
+    box Node
+        participant AutoNAT Client
+        participant NAT State Machine
+        participant Port Mapping Client
+    end
+    participant Router
+
+    Note left of AutoNAT Server: Phase 3<br/>Network Monitoring
+    par Refresh mapping and monitor changes
+        loop periodically refreshes mapping
+            Port Mapping Client ->> Router: Requests refresh
+            Router ->> Port Mapping Client: Confirms mapping refresh
+        end
+        break Mapping is lost, the node loses Public status
+            Router ->> Port Mapping Client: Refresh failed or mapping dropped
+            Port Mapping Client ->> NAT State Machine: Mapping lost
+            NAT State Machine ->> NAT State Machine: Restart
+        end
+    and Monitor public reachability of mapped addresses
+        loop periodically checks public reachability
+            AutoNAT Client ->> AutoNAT Server: Requests dialback
+            AutoNAT Server ->> AutoNAT Client: Dialback successful
+        end
+        break
+            AutoNAT Server ->> AutoNAT Client: Dialback failed or Timeout
+            AutoNAT Client ->> NAT State Machine: Public reachability lost
+            NAT State Machine ->> NAT State Machine: Restart
+        end
+    end
+    Note left of AutoNAT Server: Phase 1
+```
+
+### Public Node Responsibilities
+
+**A Public node MUST:**
+
+- Run an [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) server
+- Listen on and advertise via [Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md) its publicly reachable [multiaddresses](https://github.com/libp2p/specs/blob/master/addressing/README.md):
+  
+  `/{public_peer_ip}/udp/{port}/quic-v1/p2p/{public_peer_id}`
+
+- Periodically renew port mappings according to protocol recommendations
+- Maintain high availability for [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) services
+
+### Peer Dialing
+
+Other peers can always dial a Public peer using its publicly reachable [multiaddresses](https://github.com/libp2p/specs/blob/master/addressing/README.md):
+
+`/{public_peer_ip}/udp/{port}/quic-v1/p2p/{public_peer_id}`
+
+## Implementation Requirements
+
+### Mandatory Components
+
+All Nomos nodes MUST implement:
+
+1. **[AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) client** for NAT status detection
+2. **Port mapping clients** for [PCP](https://datatracker.ietf.org/doc/html/rfc6887), [NAT-PMP](https://datatracker.ietf.org/doc/html/rfc6886), and [UPnP-IGD](https://datatracker.ietf.org/doc/html/rfc6970)
+3. **[Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md)** for capability advertisement
+4. **Network monitoring** for status change detection
+
+### Optional Enhancements
+
+Nodes MAY implement:
+
+- Custom port mapping retry strategies
+- Enhanced network change detection
+- Advanced [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) server load balancing
+- Backup connectivity mechanisms
+
+### Configuration Parameters
+
+#### [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) Configuration
+
+```yaml
+autonat:
+  client:
+    dial_timeout: 15s
+    max_peer_addresses: 16
+    throttle_global_limit: 30
+    throttle_peer_limit: 3
+  server:
+    dial_timeout: 30s
+    max_peer_addresses: 16
+    throttle_global_limit: 30
+    throttle_peer_limit: 3
+```
+
+#### Port Mapping Configuration
+
+```yaml
+port_mapping:
+  pcp:
+    timeout: 30s
+    lifetime: 7200s  # 2 hours
+    retry_interval: 300s
+  nat_pmp:
+    timeout: 30s
+    lifetime: 7200s
+    retry_interval: 300s
+  upnp:
+    timeout: 30s
+    lease_duration: 7200s
+    retry_interval: 300s
+```
+
+## Security Considerations
+
+### NAT Traversal Security
+
+1. **Port Mapping Validation**: Verify that requested port mappings are actually created
+2. **[AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) Server Trust**: Implement peer reputation for [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) servers
+3. **Gateway Communication**: Secure communication with NAT devices
+4. **Address Validation**: Validate public addresses before advertisement
+
+### Privacy Considerations
+
+1. **IP Address Exposure**: Public nodes necessarily expose IP addresses
+2. **Traffic Analysis**: Monitor for patterns that could reveal node behavior
+3. **Gateway Information**: Minimize exposure of internal network topology
+
+### Denial of Service Protection
+
+1. **[AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) Rate Limiting**: Implement request throttling for [AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) services
+2. **Port Mapping Abuse**: Prevent excessive port mapping requests
+3. **Resource Exhaustion**: Limit concurrent NAT traversal attempts
+
+## Performance Characteristics
+
+### Scalability
+
+- **[AutoNAT](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md) Server Load**: Distributed across Public nodes
+- **Port Mapping Overhead**: Minimal ongoing resource usage
+- **Network Monitoring**: Efficient periodic checks
+
+### Reliability
+
+- **Fallback Mechanisms**: Multiple protocols ensure high success rates
+- **Continuous Monitoring**: Automatic recovery from connectivity loss
+- **Protocol Redundancy**: Multiple port mapping protocols increase reliability
+
+## References
+
+1. [Multiaddress spec](https://github.com/libp2p/specs/blob/master/addressing/README.md)
+2. [Identify protocol spec](https://github.com/libp2p/specs/blob/master/identify/README.md)
+3. [AutoNAT v2 protocol spec](https://github.com/libp2p/specs/blob/master/autonat/autonat-v2.md)
+4. [Circuit Relay v2 protocol spec](https://github.com/libp2p/specs/blob/master/relay/circuit-v2.md)
+5. [PCP - RFC 6887](https://datatracker.ietf.org/doc/html/rfc6887)
+6. [NAT-PMP - RFC 6886](https://datatracker.ietf.org/doc/html/rfc6886)
+7. [UPnP IGD - RFC 6970](https://datatracker.ietf.org/doc/html/rfc6970)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

nomos/raw/p2p-network-bootstrapping.md

@@ -0,0 +1,185 @@
+---
+title: P2P-NETWORK-BOOTSTRAPPING
+name: Nomos P2P Network Bootstrapping Specification
+status: raw
+category: networking
+tags: [p2p, networking, bootstrapping, peer-discovery, libp2p]
+editor: Daniel Sanchez-Quiros <danielsq@status.im>
+contributors:
+- Álvaro Castro-Castilla <alvaro@status.im>
+- Petar Radovic <petar@status.im>
+- Gusto Bacvinka <augustinas@status.im>
+- Antonio Antonino <antonio@status.im>
+- Youngjoon Lee <youngjoon@status.im>
+- Filip Dimitrijevic <filip@status.im>
+---
+
+## Introduction
+
+Nomos network bootstrapping is the process by which a new node discovers peers and synchronizes with the existing decentralized network. It ensures that a node can:
+
+1. **Discover Peers** – Find other active nodes in the network.
+2. **Establish Connections** – Securely connect to trusted peers.
+3. **Negotiate (libp2p) Protocols** - Ensure that other peers operate in the same protocols as the node needs.
+
+## Overview
+
+The Nomos P2P network bootstrapping strategy relies on a designated subset of **bootstrap nodes** to facilitate secure and efficient node onboarding. These nodes serve as the initial entry points for new network participants.
+
+### Key Design Principles
+
+#### Trusted Bootstrap Nodes
+
+A curated set of publicly announced and highly available nodes ensures reliability during initial peer discovery. These nodes are configured with elevated connection limits to handle a high volume of incoming bootstrapping requests from new participants.
+
+#### Node Configuration & Onboarding
+
+New node operators must explicitly configure their instances with the addresses of bootstrap nodes. This configuration may be preloaded or dynamically fetched from a trusted source to minimize manual setup.
+
+#### Network Integration
+
+Upon initialization, the node establishes connections with the bootstrap nodes and begins participating in Nomos networking protocols. Through these connections, the node discovers additional peers, synchronizes with the network state, and engages in protocol-specific communication (e.g., consensus, block propagation).
+
+### Security & Decentralization Considerations
+
+**Trust Minimization**: While bootstrap nodes provide initial connectivity, the network rapidly transitions to decentralized peer discovery to prevent over-reliance on any single entity.
+
+**Authenticated Announcements**: The identities and addresses of bootstrap nodes are publicly verifiable to mitigate impersonation attacks. From [libp2p documentation](https://docs.libp2p.io/concepts/transports/quic/#quic-in-libp2p):
+
+> To authenticate each others' peer IDs, peers encode their peer ID into a self-signed certificate, which they sign using their host's private key.
+
+**Dynamic Peer Management**: After bootstrapping, nodes continuously refine their peer lists to maintain a resilient and distributed network topology.
+
+This approach ensures **rapid, secure, and scalable** network participation while preserving the decentralized ethos of the Nomos protocol.
+
+## Protocol
+
+### Protocol Overview
+
+The bootstrapping protocol follows libp2p conventions for peer discovery and connection establishment. Implementation details are handled by the underlying libp2p stack with Nomos-specific configuration parameters.
+
+### Bootstrapping Process
+
+#### Step-by-Step bootstrapping process
+
+1. **Node Initial Configuration**: New nodes load pre-configured bootstrap node addresses. Addresses may be `IP` or `DNS` embedded in a compatible [libp2p PeerId multiaddress](https://docs.libp2p.io/concepts/fundamentals/peers/#peer-ids-in-multiaddrs). Node operators may chose to advertise more than one address. This is out of the scope of this protocol. For example:
+
+    `/ip4/198.51.100.0/udp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N` or
+
+    `/dns/foo.bar.net/udp/4242/p2p/QmYyQSo1c1Ym7orWxLYvCrM2EmxFTANf8wXmmE7DWjhx5N`
+
+2. **Secure Connection**: Nodes establish connections to bootstrap nodes announced addresses. Verifies network identity and protocol compatibility.
+
+3. **Peer Discovery**: Requests and receives validated peer lists from bootstrap nodes. Each entry includes connectivity details as per the peer discovery protocol engaging after the initial connection.
+
+4. **Network Integration**: Iteratively connects to discovered peers. Gradually build peer connections.
+
+5. **Protocol Engagement**: Establishes required protocol channels (gossip/consensus/sync). Begins participating in network operations.
+
+6. **Ongoing Maintenance**: Continuously evaluates and refreshes peer connections. Ideally removes the connection to the bootstrap node itself. Bootstrap nodes may chose to remove the connection on their side to keep high availability for other nodes.
+
+```mermaid
+sequenceDiagram
+    participant Nomos Network
+    participant Node
+    participant Bootstrap Node
+
+    Node->>Node: Fetches bootstrapping addresses
+
+    loop Interacts with bootstrap node
+        Node->>+Bootstrap Node: Connects
+        Bootstrap Node->>-Node: Sends discovered peers information
+    end
+
+    loop Connects to Network participants
+        Node->>Nomos Network: Engages in connections
+        Node->>Nomos Network: Negotiates protocols
+    end
+
+    loop Ongoing maintenance
+        Node-->>Nomos Network: Evaluates peer connections
+        alt Bootstrap connection no longer needed
+            Node-->>Bootstrap Node: Disconnects
+        else Bootstrap enforces disconnection
+            Bootstrap Node-->>Node: Disconnects
+        end
+    end
+```
+
+## Implementation Details
+
+The bootstrapping process for the Nomos p2p network uses the **QUIC** transport as specified in the Nomos network specification.
+
+Bootstrapping is separated from the network's peer discovery protocol. It assumes that there is one protocol that would engage as soon as the connection with the bootstrapping node triggers. Currently Nomos network uses `kademlia` as the current first approach for the Nomos p2p network, this comes granted.
+
+### Bootstrap Node Requirements
+
+Bootstrap nodes MUST fulfill the following requirements:
+
+- **High Availability**: Maintain uptime of 99.5% or higher
+- **Connection Capacity**: Support minimum 1000 concurrent connections
+- **Geographic Distribution**: Deploy across multiple regions
+- **Protocol Compatibility**: Support all required Nomos network protocols
+- **Security**: Implement proper authentication and rate limiting
+
+### Network Configuration
+
+Bootstrap node addresses are distributed through:
+
+- **Hardcoded addresses** in node software releases
+- **DNS seeds** for dynamic address resolution
+- **Community-maintained lists** with cryptographic verification
+
+## Security Considerations
+
+### Trust Model
+
+Bootstrap nodes operate under a **minimal trust model**:
+
+- Nodes verify peer identities through cryptographic authentication
+- Bootstrap connections are temporary and replaced by organic peer discovery
+- No single bootstrap node can control network participation
+
+### Attack Mitigation
+
+**Sybil Attack Protection**: Bootstrap nodes implement connection limits and peer verification to prevent malicious flooding.
+
+**Eclipse Attack Prevention**: Nodes connect to multiple bootstrap nodes and rapidly diversify their peer connections.
+
+**Denial of Service Resistance**: Rate limiting and connection throttling protect bootstrap nodes from resource exhaustion attacks.
+
+## Performance Characteristics
+
+### Bootstrapping Metrics
+
+- **Initial Connection Time**: Target < 30 seconds to first bootstrap node
+- **Peer Discovery Duration**: Discover minimum viable peer set within 2 minutes
+- **Network Integration**: Full protocol engagement within 5 minutes
+
+### Resource Requirements
+
+#### Bootstrap Nodes
+
+- Memory: Minimum 4GB RAM
+- Bandwidth: 100 Mbps sustained
+- Storage: 50GB available space
+
+#### Regular Nodes
+
+- Memory: 512MB for bootstrapping process
+- Bandwidth: 10 Mbps during initial sync
+- Storage: Minimal requirements
+
+## References
+
+- P2P Network Specification (internal document)
+- [libp2p QUIC Transport](https://docs.libp2p.io/concepts/transports/quic/)
+- [libp2p Peer IDs and Addressing](https://docs.libp2p.io/concepts/fundamentals/peers/)
+- [Ethereum bootnodes](https://ethereum.org/en/developers/docs/nodes-and-clients/bootnodes/)
+- [Bitcoin peer discovery](https://developer.bitcoin.org/devguide/p2p_network.html#peer-discovery)
+- [Cardano nodes connectivity](https://docs.cardano.org/stake-pool-operators/node-connectivity)
+- [Cardano peer sharing](https://www.coincashew.com/coins/overview-ada/guide-how-to-build-a-haskell-stakepool-node/part-v-tips/implementing-peer-sharing)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

nomos/raw/p2p-network.md

@@ -0,0 +1,307 @@
+---
+title: NOMOS-P2P-NETWORK
+name: Nomos P2P Network Specification
+status: draft
+category: networking
+tags: [p2p, networking, libp2p, kademlia, gossipsub, quic]
+editor: Daniel Sanchez-Quiros <danielsq@status.im>
+contributors:
+- Filip Dimitrijevic <filip@status.im>
+---
+
+## Abstract
+
+This specification defines the peer-to-peer (P2P) network layer for Nomos blockchain nodes. The network serves as the comprehensive communication infrastructure enabling transaction dissemination through mempool and block propagation. The specification leverages established libp2p protocols to ensure robust, scalable performance with low bandwidth requirements and minimal latency while maintaining accessibility for diverse hardware configurations and network environments.
+
+## Motivation
+
+The Nomos blockchain requires a reliable, scalable P2P network that can:
+
+1. **Support diverse hardware**: From laptops to dedicated servers across various operating systems and geographic locations
+2. **Enable inclusive participation**: Allow non-technical users to operate nodes with minimal configuration
+3. **Maintain connectivity**: Ensure nodes remain reachable even with limited connectivity or behind NAT/routers
+4. **Scale efficiently**: Support large-scale networks (+10k nodes) with eventual consistency
+5. **Provide low-latency communication**: Enable efficient transaction and block propagation
+
+## Specification
+
+### Network Architecture Overview
+
+The Nomos P2P network addresses three critical challenges:
+
+- **Peer Connectivity**: Mechanisms for peers to join and connect to the network
+- **Peer Discovery**: Enabling peers to locate and identify network participants  
+- **Message Transmission**: Facilitating efficient message exchange across the network
+
+### Transport Protocol
+
+#### QUIC Protocol Transport
+
+The Nomos network employs **[QUIC protocol](https://docs.libp2p.io/concepts/transports/quic/)** as the primary transport protocol, leveraging the [libp2p protocol](https://docs.libp2p.io/) implementation.
+
+**Rationale for [QUIC protocol](https://docs.libp2p.io/concepts/transports/quic/):**
+
+- Rapid connection establishment
+- Enhanced NAT traversal capabilities (UDP-based)
+- Built-in multiplexing simplifies configuration
+- Production-tested reliability
+
+### Peer Discovery
+
+#### Kademlia DHT
+
+The network utilizes libp2p's Kademlia Distributed Hash Table (DHT) for peer discovery.
+
+**Protocol Identifiers:**
+
+- **Mainnet**: `/nomos/kad/1.0.0`
+- **Testnet**: `/nomos-testnet/kad/1.0.0`
+
+**Features:**
+
+- Proximity-based peer discovery heuristics
+- Distributed peer routing table
+- Resilient to network partitions
+- Automatic peer replacement
+
+#### Identify Protocol
+
+Complements Kademlia by enabling peer information exchange.
+
+**Protocol Identifiers:**
+
+- **Mainnet**: `/nomos/identify/1.0.0`
+- **Testnet**: `/nomos-testnet/identify/1.0.0`
+
+**Capabilities:**
+
+- Protocol support advertisement
+- Peer capability negotiation
+- Network interoperability enhancement
+
+#### Future Considerations
+
+The current Kademlia implementation is acknowledged as interim. Future improvements target:
+
+- Lightweight design without full DHT overhead
+- Highly-scalable eventual consistency
+- Support for 10k+ nodes with minimal resource usage
+
+### NAT Traversal
+
+The network implements comprehensive NAT traversal solutions to ensure connectivity across diverse network configurations.
+
+**Objectives:**
+
+- Configuration-free peer connections
+- Support for users with varying technical expertise
+- Enable nodes on standard consumer hardware
+
+**Implementation:**
+
+- Tailored solutions based on user network configuration
+- Automatic NAT type detection and adaptation
+- Fallback mechanisms for challenging network environments
+
+*Note: Detailed NAT traversal specifications are maintained in a separate document.*
+
+### Message Dissemination
+
+#### Gossipsub Protocol
+
+Nomos employs **gossipsub** for reliable message propagation across the network.
+
+**Integration:**
+
+- Seamless integration with Kademlia peer discovery
+- Automatic peer list updates
+- Efficient message routing and delivery
+
+#### Topic Configuration
+
+**Mempool Dissemination:**
+
+- **Mainnet**: `/nomos/mempool/0.1.0`
+- **Testnet**: `/nomos-testnet/mempool/0.1.0`
+
+**Block Propagation:**
+
+- **Mainnet**: `/nomos/cryptarchia/0.1.0`
+- **Testnet**: `/nomos-testnet/cryptarchia/0.1.0`
+
+#### Network Parameters
+
+**Peering Degree:**
+
+- **Minimum recommended**: 8 peers
+- **Rationale**: Ensures redundancy and efficient propagation
+- **Configurable**: Nodes may adjust based on resources and requirements
+
+### Bootstrapping
+
+#### Initial Network Entry
+
+New nodes connect to the network through designated bootstrap nodes.
+
+**Process:**
+
+1. Connect to known bootstrap nodes
+2. Obtain initial peer list through Kademlia
+3. Establish gossipsub connections
+4. Begin participating in network protocols
+
+**Bootstrap Node Requirements:**
+
+- High availability and reliability
+- Geographic distribution
+- Version compatibility maintenance
+
+### Message Encoding
+
+All network messages follow the Nomos Wire Format specification for consistent encoding and decoding across implementations.
+
+**Key Properties:**
+
+- Deterministic serialization
+- Efficient binary encoding
+- Forward/backward compatibility support
+- Cross-platform consistency
+
+*Note: Detailed wire format specifications are maintained in a separate document.*
+
+## Implementation Requirements
+
+### Mandatory Protocols
+
+All Nomos nodes MUST implement:
+
+1. **Kademlia DHT** for peer discovery
+2. **Identify protocol** for peer information exchange
+3. **Gossipsub** for message dissemination
+
+### Optional Enhancements
+
+Nodes MAY implement:
+
+- Advanced NAT traversal techniques
+- Custom peering strategies
+- Enhanced message routing optimizations
+
+### Network Versioning
+
+Protocol versions follow semantic versioning:
+
+- **Major version**: Breaking protocol changes
+- **Minor version**: Backward-compatible enhancements
+- **Patch version**: Bug fixes and optimizations
+
+## Configuration Parameters
+
+### Implementation Note
+
+**Current Status**: The Nomos P2P network implementation uses hardcoded libp2p protocol parameters for optimal performance and reliability. While the node configuration file (`config.yaml`) contains network-related settings, the core libp2p protocol parameters (Kademlia DHT, Identify, and Gossipsub) are embedded in the source code.
+
+### Node Configuration
+
+The following network parameters are configurable via `config.yaml`:
+
+#### Network Backend Settings
+
+```yaml
+network:
+  backend:
+    host: 0.0.0.0
+    port: 3000
+    node_key: <node_private_key>
+    initial_peers: []
+```
+
+#### Protocol-Specific Topics
+
+**Mempool Dissemination:**
+
+- **Mainnet**: `/nomos/mempool/0.1.0`
+- **Testnet**: `/nomos-testnet/mempool/0.1.0`
+
+**Block Propagation:**
+
+- **Mainnet**: `/nomos/cryptarchia/0.1.0`
+- **Testnet**: `/nomos-testnet/cryptarchia/0.1.0`
+
+### Hardcoded Protocol Parameters
+
+The following libp2p protocol parameters are currently hardcoded in the implementation:
+
+#### Peer Discovery Parameters
+
+- **Protocol identifiers** for Kademlia DHT and Identify protocols
+- **DHT routing table** configuration and query timeouts
+- **Peer discovery intervals** and connection management
+
+#### Message Dissemination Parameters  
+
+- **Gossipsub mesh parameters** (peer degree, heartbeat intervals)
+- **Message validation** and caching settings
+- **Topic subscription** and fanout management
+
+#### Rationale for Hardcoded Parameters
+
+1. **Network Stability**: Prevents misconfigurations that could fragment the network
+2. **Performance Optimization**: Parameters are tuned for the target network size and latency requirements
+3. **Security**: Reduces attack surface by limiting configurable network parameters
+4. **Simplicity**: Eliminates need for operators to understand complex P2P tuning
+
+## Security Considerations
+
+### Network-Level Security
+
+1. **Peer Authentication**: Utilize libp2p's built-in peer identity verification
+2. **Message Validation**: Implement application-layer message validation
+3. **Rate Limiting**: Protect against spam and DoS attacks
+4. **Blacklisting**: Mechanism for excluding malicious peers
+
+### Privacy Considerations
+
+1. **Traffic Analysis**: Gossipsub provides some resistance to traffic analysis
+2. **Metadata Leakage**: Minimize identifiable information in protocol messages
+3. **Connection Patterns**: Randomize connection timing and patterns
+
+### Denial of Service Protection
+
+1. **Resource Limits**: Impose limits on connections and message rates
+2. **Peer Scoring**: Implement reputation-based peer management
+3. **Circuit Breakers**: Automatic protection against resource exhaustion
+
+### Node Configuration Example
+
+[Nomos Node Configuration](https://github.com/logos-co/nomos/blob/master/nodes/nomos-node/config.yaml) is an example node configuration
+
+## Performance Characteristics
+
+### Scalability
+
+- **Target Network Size**: 10,000+ nodes
+- **Message Latency**: Sub-second for critical messages
+- **Bandwidth Efficiency**: Optimized for limited bandwidth environments
+
+### Resource Requirements
+
+- **Memory Usage**: Minimal DHT routing table overhead
+- **CPU Usage**: Efficient cryptographic operations
+- **Network Bandwidth**: Adaptive based on node role and capacity
+
+## References
+
+Original working document, from Nomos Notion: [P2P Network Specification](https://nomos-tech.notion.site/P2P-Network-Specification-206261aa09df81db8100d5f410e39d75).
+
+1. [libp2p Specifications](https://docs.libp2p.io/)
+2. [QUIC Protocol Specification](https://docs.libp2p.io/concepts/transports/quic/)
+3. [Kademlia DHT](https://docs.libp2p.io/concepts/discovery-routing/kaddht/)
+4. [Gossipsub Protocol](https://github.com/libp2p/specs/tree/master/pubsub/gossipsub)
+5. [Identify Protocol](https://github.com/libp2p/specs/blob/master/identify/README.md)
+6. [Nomos Implementation](https://github.com/logos-co/nomos) - Reference implementation and source code
+7. [Nomos Node Configuration](https://github.com/logos-co/nomos/blob/master/nodes/nomos-node/config.yaml) - Example node configuration
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

nomos/raw/sdp.md

@@ -0,0 +1,345 @@
+---
+title: NOMOS-SDP
+name: Nomos Service Declaration Protocol Specification
+status: raw
+category: 
+tags: participation, validators, declarations
+editor: Marcin Pawlowski <marcin@status.im>
+contributors:
+- Mehmet <mehmet@status.im>
+- Daniel Sanchez Quiros <danielsq@status.im>
+- Álvaro Castro-Castilla <alvaro@status.im>
+- Thomas Lavaur <thomaslavaur@status.im>
+- Filip Dimitrijevic <filip@status.im>
+- Gusto Bacvinka <augustinas@status.im>
+- David Rusu <davidrusu@status.im>
+---
+
+## Introduction
+
+This document defines a mechanism enabling validators to declare their participation in specific protocols that require a known and agreed-upon list of participants. Some examples of this are Data Availability and the Blend Network. We create a single repository of identifiers which is used to establish secure communication between validators and provide services. Before being admitted to the repository, the validator proves that it locked at least a minimum stake.
+
+## Requirements
+
+The requirements for the protocol are defined as follows:
+
+- A declaration must be backed by a confirmation that the sender of the declaration owns a certain value of the stake.
+- A declaration is valid until it is withdrawn or is not used for a service-specific amount of time.
+
+## Overview
+
+The SDP enables nodes to declare their eligibility to serve a specific service in the system, and withdraw their declarations.
+
+### Protocol Actions
+
+The protocol defines the following actions:
+
+- **Declare**: A node sends a declaration that confirms its willingness to provide a specific service, which is confirmed by locking a threshold of stake.
+- **Active**: A node marks that its participation in the protocol is active according to the service-specific activity logic. This action enables the protocol to monitor the node's activity. We utilize this as a non-intrusive differentiator of node activity. It is crucial to exclude inactive nodes from the set of active nodes, as it enhances the stability of services.
+- **Withdraw**: A node withdraws its declaration and stops providing a service.
+
+The logic of the protocol is straightforward:
+
+1. A node sends a declaration message for a specific service and proves it has a minimum stake.
+2. The declaration is registered on the ledger, and the node can commence its service according to the service-specific service logic.
+3. After a service-specific service-providing time, the node confirms its activity.
+4. The node must confirm its activity with a service-specific minimum frequency; otherwise, its declaration is inactive.
+5. After the service-specific locking period, the node can send a withdrawal message, and its declaration is removed from the ledger, which means that the node will no longer provide the service.
+
+💡 The protocol messages are subject to a finality that means messages become part of the immutable ledger after a delay. The delay at which it happens is defined by the consensus.
+
+## Construction
+
+In this section, we present the main constructions of the protocol. First, we start with data definitions. Second, we describe the protocol actions. Finally, we present part of the Bedrock Mantle design responsible for storing and processing SDP-related messages and data.
+
+### Data
+
+In this section, we discuss and define data types, messages, and their storage.
+
+#### Service Types
+
+We define the following services which can be used for service declaration:
+
+- `BN`: for Blend Network service.
+- `DA`: for Data Availability service.
+
+```python
+class ServiceType(Enum):
+    BN="BN"  # Blend Network
+    DA="DA"  # Data Availability
+```
+
+A declaration can be generated for any of the services above. Any declaration that is not one of the above must be rejected. The number of services might grow in the future.
+
+#### Minimum Stake
+
+The minimum stake is a global value that defines the minimum stake a node must have to perform any service.
+
+The `MinStake` is a structure that holds the value of the stake `stake_threshold` and the block number it was set at: `timestamp`.
+
+```python
+class MinStake:
+    stake_threshold: StakeThreshold
+    timestamp: BlockNumber
+```
+
+The `stake_thresholds` is a structure aggregating all defined `MinStake` values.
+
+```python
+stake_thresholds: list[MinStake]
+```
+
+For more information on how the minimum stake is calculated, please refer to the Nomos documentation.
+
+#### Service Parameters
+
+The service parameters structure defines the parameters set necessary for correctly handling interaction between the protocol and services. Each of the service types defined above must be mapped to a set of the following parameters:
+
+- `session_length` defines the session length expressed as the number of blocks; the sessions are counted from block `timestamp`.
+- `lock_period` defines the minimum time (as a number of sessions) during which the declaration cannot be withdrawn, this time must include the period necessary for finalizing the declaration (which might be implicit) and provision of a service for least a single session; it can be expressed as the number of blocks by multiplying its value by the `session_length`.
+- `inactivity_period` defines the maximum time (as a number of sessions) during which an activation message must be sent; otherwise, the declaration is considered inactive; it can be expressed as the number of blocks by multiplying its value by the `session_length`.
+- `retention_period` defines the time (as a number of sessions) after which the declaration can be safely deleted by the Garbage Collection mechanism; it can be expressed as the number of blocks by multiplying its value by the `session_length`.
+- `timestamp` defines the block number at which the parameter was set.
+
+```python
+class ServiceParameters:
+    session_length: NumberOfBlocks
+    lock_period: NumberOfSessions
+    inactivity_period: NumberOfSessions
+    retention_period: NumberOfSessions
+    timestamp: BlockNumber
+```
+
+The `parameters` is a structure aggregating all defined `ServiceParameters` values.
+
+```python
+parameters: list[ServiceParameters]
+```
+
+#### Identifiers
+
+We define the following set of identifiers which are used for service-specific cryptographic operations:
+
+- `provider_id`: used to sign the SDP messages and to establish secure links between validators; it is `Ed25519PublicKey`.
+- `zk_id`: used for zero-knowledge operations by the validator that includes rewarding ([Zero Knowledge Signature Scheme (ZkSignature)](https://www.notion.so/Zero-Knowledge-Signature-Scheme-ZkSignature-21c261aa09df8119bfb2dc74a3430df6?pvs=21)).
+
+#### Locators
+
+A `Locator` is the address of a validator which is used to establish secure communication between validators. It follows the [multiaddr addressing scheme from libp2p](https://docs.libp2p.io/concepts/fundamentals/addressing/), but it must contain only the location part and must not contain the node identity (`peer_id`).
+
+The `provider_id` must be used as the node identity. Therefore, the `Locator` must be completed by adding the `provider_id` at the end of it, which makes the `Locator` usable in the context of libp2p.
+
+The length of the `Locator` is restricted to 329 characters.
+
+The syntax of every `Locator` entry must be validated.
+
+**The common formatting of every** `Locator` **must be applied to maintain its unambiguity, to make deterministic ID generation work consistently.** The `Locator` must at least contain only lower case letters and every part of the address must be explicit (no implicit defaults).
+
+#### Declaration Message
+
+The construction of the declaration message is as follows:
+
+```python
+class DeclarationMessage:
+    service_type: ServiceType
+    locators: list[Locator]
+    provider_id: Ed25519PublicKey 
+    zk_id: ZkPublicKey
+```
+
+The `locators` list length must be limited to reduce the potential for abuse. Therefore, the length of the list cannot be longer than 8.
+
+The message must be signed by the `provider_id` key to prove ownership of the key that is used for network-level authentication of the validator. The message is also signed by the `zk_id` key (by default all Mantle transactions are signed with `zk_id` key).
+
+#### Declaration Storage
+
+Only valid declaration messages can be stored on the ledger. We define the `DeclarationInfo` as follows:
+
+```python
+class DeclarationInfo:
+    service: ServiceType
+    provider_id: Ed25519PublicKey
+    zk_id: ZkPublicKey
+    locators: list[Locator]
+    created: BlockNumber
+    active: BlockNumber
+    withdrawn: BlockNumber
+    nonce: Nonce
+```
+
+Where:
+
+- `service` defines the service type of the declaration;
+- `provider_id` is an `Ed25519PublicKey` used to sign the message by the validator;
+- `zk_id` is used for zero-knowledge operations by the validator that includes rewarding ([Zero Knowledge Signature Scheme (ZkSignature)](https://www.notion.so/Zero-Knowledge-Signature-Scheme-ZkSignature-21c261aa09df8119bfb2dc74a3430df6?pvs=21));
+- `locators` are a copy of the `locators` from the `DeclarationMessage`;
+- `created` refers to the block number of the block that contained the declaration;
+- `active` refers to the latest block number for which the active message was sent (it is set to `created` by default);
+- `withdrawn` refers to the block number for which the service declaration was withdrawn (it is set to 0 by default).
+- The `nonce` must be set to 0 for the declaration message and must increase monotonically by every message sent for the `declaration_id`.
+
+We also define the `declaration_id` (of a `DeclarationId` type) that is the unique identifier of `DeclarationInfo` calculated as a hash of the concatenation of `service`, `provider_id`, `locators` and `zk_id`. The implementation of the hash function is `blake2b` using 256 bits of the output.
+
+```python
+declaration_id = Hash(service||provider_id||zk_id||locators)
+```
+
+The `declaration_id` is not stored as part of the `DeclarationInfo` but it is used to index it.
+
+All `DeclarationInfo` references are stored in the `declarations` and are indexed by `declaration_id`.
+
+```python
+declarations: list[declaration_id]
+```
+
+#### Active Message
+
+The construction of the active message is as follows:
+
+```python
+class ActiveMessage:
+    declaration_id: DeclarationId
+    nonce: Nonce
+    metadata: Metadata
+```
+
+where `metadata` is a service-specific node activeness metadata.
+
+The message must be signed by the `zk_id` key associated with the `declaration_id`.
+
+The `nonce` must increase monotonically by every message sent for the `declaration_id`.
+
+#### Withdraw Message
+
+The construction of the withdraw message is as follows:
+
+```python
+class WithdrawMessage:
+    declaration_id: DeclarationId
+    nonce: Nonce
+```
+
+The message must be signed by the `zk_id` key from the `declaration_id`.
+
+The `nonce` must increase monotonically by every message sent for the `declaration_id`.
+
+#### Indexing
+
+Every event must be correctly indexed to enable lighter synchronization of the changes. Therefore, we index every `declaration_id` according to `EventType`, `ServiceType`, and `Timestamp`. Where `EventType = { "created", "active", "withdrawn" }` follows the type of the message.
+
+```python
+events = {
+    event_type: {
+        service_type: {
+            timestamp: {
+                declarations: list[declaration_id]
+            }
+        }
+    }
+}
+```
+
+### Protocol
+
+#### Declare
+
+The Declare action associates a validator with a service it wants to provide. It requires sending a valid `DeclarationMessage` (as defined in Declaration Message), which is then processed (as defined below) and stored (as defined in Declaration Storage).
+
+The declaration message is considered valid when all of the following are met:
+
+- The sender meets the stake requirements.
+- The `declaration_id` is unique.
+- The sender knows the secret behind the `provider_id` identifier.
+- The length of the `locators` list must not be longer than 8.
+- The `nonce` is increasing monotonically.
+
+If all of the above conditions are fulfilled, then the message is stored on the ledger; otherwise, the message is discarded.
+
+#### Active
+
+The Active action enables marking the provider as actively providing a service. It requires sending a valid `ActiveMessage` (as defined in Active Message), which is relayed to the service-specific node activity logic (as indicated by the service type in Common SDP Structures).
+
+The Active action updates the `active` value of the `DeclarationInfo`, which means that it also activates inactive (but not expired) providers.
+
+The SDP active action logic is:
+
+1. A node sends a `ActiveMessage` transaction.
+2. The `ActiveMessage` is verified by the SDP logic.
+    a. The `declaration_id` returns an existing `DeclarationInfo`.
+    b. The transaction containing `ActiveMessage` is signed by the `zk_id`.
+    c. The `withdrawn` from the `DeclarationInfo` is set to zero.
+    d. The `nonce` is increasing monotonically.
+3. If any of these conditions fail, discard the message and stop processing.
+4. The message is processed by the service-specific activity logic alongside the `active` value indicating the period since the last active message was sent. The `active` value comes from the `DeclarationInfo`.
+5. If the service-specific activity logic approves the node active message, then the `active` field of the `DeclarationInfo` is set to the current block height.
+
+#### Withdraw
+
+The withdraw action enables a withdrawal of a service declaration. It requires sending a valid `WithdrawMessage` (as defined in Withdraw Message). The withdrawal cannot happen before the end of the locking period, which is defined as the number of blocks counted since `created`. This lock period is stored as `lock_period` in the Service Parameters.
+
+The logic of the withdraw action is:
+
+1. A node sends a `WithdrawMessage` transaction.
+2. The `WithdrawMessage` is verified by the SDP logic:
+    a. The `declaration_id` returns an existing `DeclarationInfo`.
+    b. The transaction containing `WithdrawMessage` is signed by the `zk_id`.
+    c. The `withdrawn` from `DeclarationInfo` is set to zero.
+    d. The `nonce` is increasing monotonically.
+3. If any of the above is not correct, then discard the message and stop.
+4. Set the `withdrawn` from the `DeclarationInfo` to the current block height.
+5. Unlock the stake.
+
+#### Garbage Collection
+
+The protocol requires a garbage collection mechanism that periodically removes unused `DeclarationInfo` entries.
+
+The logic of garbage collection is:
+
+For every `DeclarationInfo` in the `declarations` set, remove the entry if either:
+
+1. The entry is past the retention period: `withdrawn + retention_period < current_block_height`.
+2. The entry is inactive beyond the inactivity and retention periods: `active + inactivity_period + retention_period < current_block_height`.
+
+#### Query
+
+The protocol must enable querying the ledger in at least the following manner:
+
+- `GetAllProviderId(timestamp)`, returns all `provider_id`s associated with the `timestamp`.
+- `GetAllProviderIdSince(timestamp)`, returns all `provider_id`s since the `timestamp`.
+- `GetAllDeclarationInfo(timestamp)`, returns all `DeclarationInfo` entries associated with the `timestamp`.
+- `GetAllDeclarationInfoSince(timestamp)`, returns all `DeclarationInfo` entries since the `timestamp`.
+- `GetDeclarationInfo(provider_id)`, returns the `DeclarationInfo` entry identified by the `provider_id`.
+- `GetDeclarationInfo(declaration_id)`, returns the `DeclarationInfo` entry identified by the `declaration_id`.
+- `GetAllServiceParameters(timestamp)`, returns all entries of the `ServiceParameters` store for the requested `timestamp`.
+- `GetAllServiceParametersSince(timestamp)`, returns all entries of the `ServiceParameters` store since the requested `timestamp`.
+- `GetServiceParameters(service_type, timestamp)`, returns the service parameter entry from the `ServiceParameters` store of a `service_type` for a specified `timestamp`.
+- `GetMinStake(timestamp)`, returns the `MinStake` structure at the requested `timestamp`.
+- `GetMinStakeSince(timestamp)`, returns a set of `MinStake` structures since the requested `timestamp`.
+
+The query must return an error if the retention period for the delegation has passed and the requested information is not available.
+
+The list of queries may be extended.
+
+Every query must return information for a finalized state only.
+
+### Mantle and ZK Proof
+
+For more information about the Mantle and ZK proofs, please refer to [Mantle Specification](https://www.notion.so/Mantle-Specification-21c261aa09df810c8820fab1d78b53d9?pvs=21).
+
+## Appendix
+
+### Future Improvements
+
+Refer to the [Mantle Specification](https://www.notion.so/Mantle-Specification-21c261aa09df810c8820fab1d78b53d9?pvs=21) for a list of potential improvements to the protocol.
+
+## References
+
+- Mantle and ZK Proof: [Mantle Specification](https://www.notion.so/Mantle-Specification-21c261aa09df810c8820fab1d78b53d9?pvs=21)
+- Ed25519 Digital Signatures: [RFC 8032](https://datatracker.ietf.org/doc/html/rfc8032)
+- BLAKE2b Cryptographic Hash: [RFC 7693](https://datatracker.ietf.org/doc/html/rfc7693)
+- libp2p Multiaddr: [Addressing Specification](https://docs.libp2p.io/concepts/fundamentals/addressing/)
+- Zero Knowledge Signatures: [ZkSignature Scheme](https://www.notion.so/Zero-Knowledge-Signature-Scheme-ZkSignature-21c261aa09df8119bfb2dc74a3430df6?pvs=21)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

status/deprecated/3rd-party.md

@@ -0,0 +1,127 @@
+---
+title: 3RD-PARTY
+name: 3rd party
+status: deprecated
+description: This specification discusses 3rd party APIs that Status relies on.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Volodymyr Kozieiev <volodymyr@status.im>
+---
+
+## Abstract
+
+This specification discusses 3rd party APIs that Status relies on.  
+These APIs provide various capabilities, including:
+
+- communicating with the Ethereum network,  
+- allowing users to view address and transaction details on external websites,  
+- retrieving fiat/crypto exchange rates,  
+- obtaining information about collectibles,  
+- hosting the privacy policy.
+
+## Definitions
+
+| Term              | Description                                                                                           |
+|-------------------|-------------------------------------------------------------------------------------------------------|
+| Fiat money        | Currency established as money, often by government regulation, but without intrinsic value.           |
+| Full node         | A computer, connected to the Ethereum network, that enforces all Ethereum consensus rules.            |
+| Crypto-collectible| A unique, non-fungible digital asset, distinct from cryptocurrencies where tokens are identical.      |
+
+## Why 3rd Party APIs Can Be a Problem
+
+Relying on 3rd party APIs conflicts with Status’s censorship-resistance principle.
+Since Status aims to avoid suppression of information,  
+it is important to minimize reliance on 3rd parties that are critical to app functionality.
+
+## 3rd Party APIs Used by the Current Status App
+
+### Infura
+
+**What is it?**  
+Infura hosts a collection of Ethereum full nodes and provides an API  
+to access the Ethereum and IPFS networks without requiring a full node.
+
+**How Status Uses It**  
+Since Status operates on mobile devices,  
+it cannot rely on a local node.  
+Therefore, all Ethereum network communication happens via Infura.
+
+**Concerns**  
+Making an HTTP request can reveal user metadata,  
+which could be exploited in attacks if Infura is compromised.  
+Infura uses centralized hosting providers;  
+if these providers fail or cut off service,  
+Ethereum-dependent features in Status would be affected.
+
+### Etherscan
+
+**What is it?**  
+Etherscan is a service that allows users to explore the Ethereum blockchain  
+for transactions, addresses, tokens, prices,  
+and other blockchain activities.
+
+**How Status Uses It**  
+The Status Wallet allows users to view address and transaction details on Etherscan.
+
+**Concerns**  
+If Etherscan becomes unavailable,  
+users won’t be able to view address or transaction details through Etherscan.  
+However, in-app information will still be accessible.
+
+### CryptoCompare
+
+**What is it?**  
+CryptoCompare provides live crypto prices, charts, and analysis from major exchanges.
+
+**How Status Uses It**  
+Status regularly fetches crypto prices from CryptoCompare,  
+using this information to calculate fiat values  
+for transactions or wallet assets.
+
+**Concerns**  
+HTTP requests can reveal metadata,  
+which could be exploited if CryptoCompare is compromised.  
+If CryptoCompare becomes unavailable,  
+Status won’t be able to show fiat equivalents for crypto in the wallet.
+
+### Collectibles
+
+Various services provide information on collectibles:
+
+- [Service 1](https://api.pixura.io/graphql)  
+- [Service 2](https://www.etheremon.com/api)  
+- [Service 3](https://us-central1-cryptostrikers-prod.cloudfunctions.net/cards/)
+- [Service 4](https://api.cryptokitties.co/)  
+
+**Concerns**  
+HTTP requests can reveal metadata,  
+which could be exploited if these services are compromised.
+
+### Iubenda
+
+**What is it?**  
+Iubenda helps create compliance documents for websites and apps across jurisdictions.
+
+**How Status Uses It**  
+Status’s privacy policy is hosted on Iubenda.
+
+**Concerns**  
+If Iubenda becomes unavailable,  
+users will be unable to view the app's privacy policy.
+
+## Changelog
+
+| Version | Comment        |
+|---------|-----------------|
+| 0.1.0   | Initial release |
+
+## Copyright
+
+Copyright and related rights waived via CC0.
+
+## References
+
+- [GraphQL](https://api.pixura.io/graphql)  
+- [Etheremon](https://www.etheremon.com/api)  
+- [Cryptostrikers](https://us-central1-cryptostrikers-prod.cloudfunctions.net/cards/)
+- [Cryptokitties](https://api.cryptokitties.co/)  

status/deprecated/IPFS-gateway-for-sticker-Pack.md

@@ -0,0 +1,138 @@
+---
+title: IPFS-gateway-for-Sticker-Pack
+name: IPFS gateway for Sticker Pack
+status: deprecated
+description: This specification describes how Status uses the IPFS gateway to store stickers. 
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Gheorghe Pinzaru <gheorghe@status.im>
+---
+
+## Abstract
+
+This specification describes how Status uses the IPFS gateway  
+to store stickers.  
+The specification explores image format,  
+how a user uploads stickers,  
+and how an end user can see them inside the Status app.
+
+## Definition
+
+| Term             | Description                                                                            |
+|------------------|----------------------------------------------------------------------------------------|
+| **Stickers**     | A set of images which can be used to express emotions                                  |
+| **Sticker Pack** | ERC721 token which includes the set of stickers                                        |
+| **IPFS**         | P2P network used to store and share data, in this case, the images for the stickerpack |
+
+## Specification
+
+### Image format
+
+Accepted image file types are `PNG`, `JPG/JPEG` and `GIF`,
+with a maximum allowed size of 300kb.
+The minimum sticker image resolution is 512x512,
+and its background SHOULD be transparent.
+
+### Distribution
+
+The node implements sticker packs as [ERC721 token](https://eips.ethereum.org/EIPS/eip-721)
+and contain a set of stickers.
+The node stores these stickers inside the sticker pack as a set of hyperlinks pointing to IPFS storage.
+These hyperlinks are publicly available and can be accessed by any user inside the status chat.
+Stickers can be sent in chat only by accounts that own the sticker pack.
+
+### IPFS gateway
+
+At the moment of writing, the current main Status app uses the [Infura](https://infura.io/) gateway.
+However, clients could choose a different gateway or to run own IPFS node.
+Infura gateway is an HTTPS gateway,
+which based on an HTTP GET request with the multihash block will return the stored content at that block address.
+
+The node requires the use of a gateway to enable easy access to the resources over HTTP.
+The node stores each image of a sticker inside IPFS using a unique address that is
+derived from the hash of the file.
+This ensures that a file can't be overridden,
+and an end-user of the IPFS will receive the same file at a given address.
+
+### Security
+
+The IPFS gateway acts as an end-user of the IPFS
+and allows users of the gateway to access IPFS without connection to the P2P network.
+Usage of a gateway introduces potential risk for the users of that gateway provider.
+In case of a compromise in the security of the provider, meta information such as IP address,
+User-Agent and other of its users can be leaked.
+If the provider servers are unavailable the node loses access through the gateway to the IPFS network.
+
+### Status sticker usage
+
+When the app shows a sticker, the Status app makes an HTTP GET request to IPFS gateway using the hyperlink.
+
+To send a sticker in chat, a user of Status should buy or install a sticker pack.
+
+To be available for installation a Sticker Pack should be submitted to Sticker market by an author.
+
+#### Submit a sticker
+
+To submit a sticker pack, the author should upload all assets to IPFS.
+Then generate a payload including name, author, thumbnail,
+preview and a list of stickers in the [EDN format](https://github.com/edn-format/edn). Following this structure:
+``
+{meta {:name "Sticker pack name"
+       :author "Author Name"
+       :thumbnail "e30101701220602163b4f56c747333f43775fdcbe4e62d6a3e147b22aaf6097ce0143a6b2373"
+       :preview "e30101701220ef54a5354b78ef82e542bd468f58804de71c8ec268da7968a1422909357f2456"
+       :stickers [{:hash "e301017012207737b75367b8068e5bdd027d7b71a25138c83e155d1f0c9bc5c48ff158724495"}
+       {:hash "e301017012201a9cdea03f27cda1aede7315f79579e160c7b2b6a2eb51a66e47a96f47fe5284"}]}}
+``
+All asset fields, are contenthash fields as per [EIP 1577](https://eips.ethereum.org/EIPS/eip-1577).
+The node also uploads this payload to IPFS, and the node uses the IPFS address in the content field of the Sticker Market contract.
+See [Sticker Market spec](https://github.com/status-im/sticker-market/blob/651e88e5f38c690e57ecaad47f46b9641b8b1e27/docs/specification.md) for a detailed description of the contract.
+
+#### Install a sticker pack
+
+To install a sticker pack, the node fetches all sticker packs available in Sticker Market.
+The node needs the following steps to fetch all sticker packs:
+
+#### 1. Get total number of sticker packs
+
+Call `packCount()` on the sticker market contract, will return number of sticker pack registered as `uint256`.
+
+#### 2. Get sticker pack by id
+
+ID's are represented as `uint256` and are incremental from `0` to total number of sticker packs in the contract,
+received in the previous step.
+To get a sticker pack call `getPackData(sticker-pack-id)`, the return type is  `["bytes4[]" "address" "bool" "uint256" "uint256" "bytes"]`
+which represents the following fields: `[category owner mintable timestamp price contenthash]`.
+Price is the SNT value in wei set by sticker pack owner.
+The contenthash is the IPFS address described in the [submit description](#submit-a-sticker) above.
+Other fields specification could be found in [Sticker Market spec](https://github.com/status-im/sticker-market/blob/651e88e5f38c690e57ecaad47f46b9641b8b1e27/docs/specification.md)
+
+##### 3. Get owned sticker packs
+
+The current Status app fetches owned sticker packs during the open of any sticker view
+(a screen which shows a sticker pack, or the list of sticker packs).
+To get owned packs, get all owned tokens for the current account address,
+by calling `balanceOf(address)` where address is the address for the current account.
+This method returns a `uint256` representing the count of available tokens. Using `tokenOfOwnerByIndex(address,uint256)` method,
+with the address of the user and ID in form of a `uint256`
+which is an incremented int from 0 to the total number of tokens, gives the token id.
+To get the sticker pack id from a token call`tokenPackId(uint256)` where `uint256` is the token id.
+This method will return an `uint256` which is the id of the owned sticker pack.
+
+##### 4. Buy a sticker pack
+
+To buy a sticker pack call `approveAndCall(address,uint256,bytes)`
+where `address` is the address of buyer,`uint256` is the price and third parameters `bytes` is the callback  called if approved.
+In the callback, call `buyToken(uint256,address,uint256)`, first parameter is sticker pack id, second buyers address, and the last is the price.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [ERC721 Token Standard](https://eips.ethereum.org/EIPS/eip-721)
+- [Infura](https://infura.io/)
+- [EDN Format](https://github.com/edn-format/edn)
+- [EIP 1577](https://eips.ethereum.org/EIPS/eip-1577)
+- [Sticker Market Specification](https://github.com/status-im/sticker-market/blob/651e88e5f38c690e57ecaad47f46b9641b8b1e27/docs/specification.md)

status/deprecated/account.md

@@ -0,0 +1,461 @@
+---
+title: ACCOUNT
+name: Account
+status: deprecated
+description: This specification explains what a Status account is, and how a node establishes trust.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Corey Petty <corey@status.im>
+  - Oskar Thorén <oskar@status.im>
+  - Samuel Hawksby-Robinson <samuel@status.im>
+---
+
+## Abstract
+
+This specification explains what a Status account is,  
+and how a node establishes trust.
+
+## Introduction
+
+The core concept of an account in Status is a set of cryptographic keypairs.
+Namely, the combination of the following:
+
+1. a Whisper/Waku chat identity keypair
+1. a set of cryptocurrency wallet keypairs
+
+The node verifies or derives everything else associated with the contact from the above items, including:
+
+- Ethereum address (future verification, currently the same base keypair)
+- 3 word mnemonic name
+- identicon
+- message signatures
+
+## Initial Key Generation
+
+### Public/Private Keypairs
+
+- An ECDSA (secp256k1 curve) public/private keypair MUST be generated via a [BIP43](https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki) derived path from a [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) mnemonic seed phrase.
+- The default paths are defined as such:
+  - Whisper/Waku Chat Key (`IK`): `m/43'/60'/1581'/0'/0`  (post Multiaccount integration)
+    - following [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md)
+    <!-- WE CURRENTLY DO NOT IMPLEMENT ENCRYPTION KEY, FOR FUTURE - C.P. -->
+    <!-- - DB encryption Key (`DBK`): `m/43'/60'/1581'/1'/0` (post Multiaccount integration) -->
+    <!-- - following [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md) -->
+    - Status Wallet paths: `m/44'/60'/0'/0/i` starting at `i=0`
+      - following [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)
+      - NOTE: this (`i=0`) is also the current (and only) path for Whisper/Waku key before Multiaccount integration
+
+### X3DH Prekey bundle creation
+
+- Status follows the X3DH prekey bundle scheme that [Open Whisper Systems](https://en.wikipedia.org/wiki/Signal_Messenger#2013%E2%80%932018:_Open_Whisper_Systems) (not to be confused with the Whisper sub-protocol) outlines [in their documentation](https://signal.org/docs/specifications/x3dh/#the-x3dh-protocol) with the following exceptions:
+
+  - Status does not publish one-time keys `OPK` or perform DH including them, because there are no central servers in the Status implementation.
+- A client MUST create X3DH prekey bundles, each defined by the following items:
+  - Identity Key: `IK`
+  - Signed prekey: `SPK`
+  - Prekey signature: `Sig(IK, Encode(SPK))`
+  - Timestamp
+- These bundles are made available in a variety of ways, as defined in section 2.1.
+
+## Account Broadcasting
+
+- A user is responsible for broadcasting certain information publicly so that others may contact them.
+
+### X3DH Prekey bundles
+
+- A client SHOULD regenerate a new X3DH prekey bundle every 24 hours.  This MAY be done in a lazy way, such that a client that does not come online past this time period does not regenerate or broadcast bundles.
+- The current bundle SHOULD be broadcast on a Whisper/Waku topic specific to his Identity Key, `{IK}-contact-code`, intermittently.  This MAY be done every 6 hours.
+- A bundle SHOULD accompany every message sent.
+- TODO: retrieval of long-time offline users bundle via `{IK}-contact-code`
+
+## Optional Account additions
+
+### ENS Username
+
+- A user MAY register a public username on the Ethereum Name System (ENS).  This username is a user-chosen subdomain of the `stateofus.eth` ENS registration that maps to their Whisper/Waku identity key (`IK`).
+
+<!-- ### User Profile Picture
+- An account MAY edit the `IK` generated identicon with a chosen picture.  This picture will become part of the publicly broadcast profile of the account. -->
+
+<!-- TODO: Elaborate on wallet account and multiaccount -->
+<!-- TODO: Elaborate on security implications -->
+
+## Trust establishment
+
+**Trust establishment deals with users verifying they are communicating with who they think they are.**
+
+### Terms Glossary
+
+| term                      | description |
+| ------------------------- | ----------- |
+| privkey                   | ECDSA secp256k1 private key |
+| pubkey                    | ECDSA secp256k1 public key |
+| Whisper/Waku key          | pubkey for chat with HD derivation path m/43'/60'/1581'/0'/0 |
+
+### Contact Discovery
+
+#### Public channels
+
+- Public group channels in Status are a broadcast/subscription system.  All public messages are encrypted with a symmetric key derived from the channel name, `K_{pub,sym}`, which is publicly known.
+- A public group channel's symmetric key MUST creation must follow the [web3 API](https://web3js.readthedocs.io/en/1.0/web3-shh.html#generatesymkeyfrompassword)'s `web3.ssh.generateSymKeyFromPassword` function
+- In order to post to a public group channel, a client MUST have a valid account created.
+- In order to listen to a public group channel, a client must subscribe to the channel name.
+The sender of a message is derived from the message's signature.
+- Discovery of channel names is not currently part of the protocol, and is typically done out of band.
+If a channel name is used that has not been used, it will be created.
+- A client MUST sign the message otherwise it will be discarded by the recipients.
+- channel name specification:
+  - matches `[a-z0-9\-]`
+  - is not a public key
+
+#### Private 1:1 messages
+
+This can be done in the following ways:
+
+1. scanning a user generated QR code
+1. discovery through the Status app
+1. asynchronous X3DH key exchange
+1. public key via public channel listening
+    - `status-mobile/src/status_im/contact_code/core.cljs`
+1. contact codes
+1. decentralized storage (not implemented)
+1. Whisper/Waku
+
+### Initial Key Exchange
+
+#### Bundles
+
+- An X3DH prekey bundle is defined as ([code](https://github.com/status-im/status-go/messaging/chat/protobuf/encryption.pb.go)):
+
+  ```golang
+  Identity                // Identity key
+  SignedPreKeys           // a map of installation id to array of signed prekeys by that installation id
+  Signature               // Prekey signature
+  Timestamp               // When the bundle was lasted created locally
+  ```
+
+  - include BundleContainer
+- a new bundle SHOULD be created at least every 12 hours
+- a node only generates a bundle when it is used
+- a bundle SHOULD be distributed on the contact code channel. This is the Whisper and Waku topic `{IK}-contact-code`,
+where `IK` is the hex encoded public key of the user, prefixed with `0x`.
+The node encrypts the channel in the same way it encrypted public chats.
+
+### Contact Verification
+
+To verify that contact key information is as it should be, use the following.
+
+#### Identicon
+
+A low-poly identicon is deterministically generated from the Whisper/Waku chat public key.
+This can be compared out of band to ensure the receiver's public key is the one stored locally.
+
+#### 3 word pseudonym / Whisper/Waku key fingerprint
+
+Status generates a deterministic 3-word random pseudonym from the Whisper/Waku chat public key.
+This pseudonym acts as a human readable fingerprint to the Whisper/Waku chat public key.
+This name also shows when viewing a contact's public profile and in the chat UI.
+
+- implementation: [gfycat](https://github.com/status-im/status-mobile/tree/develop/src/status_im/utils/gfycat)
+
+#### ENS name
+
+Status offers the ability to register a mapping of a human readable subdomain of `stateofus.eth` to their Whisper/Waku chat public key.
+The user purchases this registration (currently by staking 10 SNT)
+and the node stores it on the Ethereum mainnet blockchain for public lookup.
+
+<!-- TODO: Elaborate on security implications -->
+
+<!-- TODO: Incorporate or cut below into proper spec
+
+### Possible Connection Breakdown
+
+possible connections
+- client - client (not really ever, this is facilitated through all other connections)
+    - personal chat
+        - ratcheted with X3DH
+    - private group chat
+        - pairwise ratcheted with X3DH
+    - public chat
+- client - mailserver (statusd + ???)
+    - a mailserver identifies itself by an [enode address](https://github.com/ethereum/wiki/wiki/enode-url-format) 
+- client - Whisper/Waku node (statusd)
+    - a node identifies itself by an enode address
+- client - bootnode (go-ethereum)
+    - a bootnode identifies itself by
+        - an enode address
+        - `NOTE: redezvous information here`
+- client - ENS registry (ethereum blockchain -> default to infura)
+- client - Ethereum RPC (custom go-ethereum RPC API -> default to infura API)
+- client - IPFS (Status hosted IPFS gateway -> defaults to ???)
+    - we have a status hosted IPFS gateway for pinning but it currently isn't used much.
+
+### Notes
+
+A user in the system is a public-private key pair using the Elliptic-Curve Cryptography secp256k1 that Ethereum uses.
+- A 3-word random name is derived from the public key using the following package
+    - `NOTE: need to find package`
+    - This provides an associated human-readble fingerprint to the user's public key
+- A user can optionally add additional layers on top of this keypair
+    - Chosen username
+    - ENS username
+
+All messages sent are encrypted with the public key of the destination and signed by the private key of the given user using the following scheme:
+- private chat
+    - X3DH is used to define shared secrets which is then double ratcheted
+- private group chat
+    - considered pairwise private chats 
+- public group chat
+    - the message is encrypted with a symmetric key derived from the chat name
+
+-->
+
+## Public Key Serialization
+
+Idiomatically known as "public key compression" and "public key decompression".
+
+The node SHOULD provide functionality for the serialization and deserialization of public / chat keys.
+
+For maximum flexibility, when implementing this functionality, the node MUST support public keys encoded in a range of encoding formats, detailed below.
+
+### Basic Serialization Example
+
+In the example of a typical hexadecimal encoded elliptical curve (EC) public key (such as a secp256k1 pk),
+
+```text
+0x04261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc3cd4e22200c68daf7493e1f8da6a190a68a671e2d3977809612424c7c3888bc6
+```
+
+minor modification for compatibility and flexibility makes the key self-identifiable and easily parsable,
+
+```text
+fe70104261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc3cd4e22200c68daf7493e1f8da6a190a68a671e2d3977809612424c7c3888bc6
+```
+
+EC serialization and compact encoding produces a much smaller string representation of the original key.
+
+```text
+zQ3shPyZJnxZK4Bwyx9QsaksNKDYTPmpwPvGSjMYVHoXHeEgB
+```
+
+### Public Key "Compression" Rationale
+
+Serialized and compactly encoded ("compressed") public keys have a number of UI / UX advantages
+over non-serialized less densely encoded public keys.
+
+Compressed public keys are smaller, and users may perceive them as less intimidating and less unnecessarily large.
+Compare the "compressed" and "uncompressed" version of the same public key from above example:
+
+- `0xe70104261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc3cd4e22200c68daf7493e1f8da6a190a68a671e2d3977809612424c7c3888bc6`
+- `zQ3shPyZJnxZK4Bwyx9QsaksNKDYTPmpwPvGSjMYVHoXHeEgB`
+
+The user can transmit and share the same data, but at one third of the original size.
+136 characters uncompressed vs 49 characters compressed, giving a significant character length reduction of 64%.
+
+The user client app MAY use the compressed public keys throughout the user interface.
+For example in the `status-mobile` implementation of the user interface
+the following places could take advantage of a significantly smaller public key:  
+
+- `Onboarding` > `Choose a chat name`
+- `Profile` > `Header`
+- `Profile` > `Share icon` > `QR code popover`
+- `Invite friends` url from `Invite friends` button and `+ -button` > `Invite friends`
+- Other user `Profile details`
+- `Profile details` > `Share icon` > `QR code popover`
+
+In the case of QR codes a compressed public key can reduce the complexity of the derived codes:
+
+| Uncompressed |
+| --- |
+|![image](/status/deprecated/images/qr-code1-accountmd.png) |
+
+| Compressed |
+| --- |
+| ![image](/status/deprecated/images/qr-code2-accountmd.png)|
+
+### Key Encoding
+
+When implementing the pk de/serialization functionality, the node MUST use the [multiformats/multibase](https://github.com/multiformats/multibase)
+encoding protocol to interpret incoming key data and to return key data in a desired encoding.
+
+The node SHOULD support the following `multibase` encoding formats.
+
+```csv
+encoding,          code, description,                                              status
+identity,          0x00, 8-bit binary (encoder and decoder keeps data unmodified), default
+base2,             0,    binary (01010101),                                        candidate
+base8,             7,    octal,                                                    draft
+base10,            9,    decimal,                                                  draft
+base16,            f,    hexadecimal,                                              default
+base16upper,       F,    hexadecimal,                                              default
+base32hex,         v,    rfc4648 case-insensitive - no padding - highest char,     candidate
+base32hexupper,    V,    rfc4648 case-insensitive - no padding - highest char,     candidate
+base32hexpad,      t,    rfc4648 case-insensitive - with padding,                  candidate
+base32hexpadupper, T,    rfc4648 case-insensitive - with padding,                  candidate
+base32,            b,    rfc4648 case-insensitive - no padding,                    default
+base32upper,       B,    rfc4648 case-insensitive - no padding,                    default
+base32pad,         c,    rfc4648 case-insensitive - with padding,                  candidate
+base32padupper,    C,    rfc4648 case-insensitive - with padding,                  candidate
+base32z,           h,    z-base-32 (used by Tahoe-LAFS),                           draft
+base36,            k,    base36 [0-9a-z] case-insensitive - no padding,            draft
+base36upper,       K,    base36 [0-9a-z] case-insensitive - no padding,            draft
+base58btc,         z,    base58 bitcoin,                                           default
+base58flickr,      Z,    base58 flicker,                                           candidate
+base64,            m,    rfc4648 no padding,                                       default
+base64pad,         M,    rfc4648 with padding - MIME encoding,                     candidate
+base64url,         u,    rfc4648 no padding,                                       default
+base64urlpad,      U,    rfc4648 with padding,                                     default
+```
+
+**Note** this specification RECOMMENDs that implementations extend the standard `multibase` protocol
+to parse strings prepended with `0x` as `f` hexadecimal encoded bytes.
+
+Implementing this recommendation will allow the node to correctly interpret traditionally identified hexadecimal strings (e.g. `0x1337c0de`).
+
+*Example:*
+
+`0xe70102261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc`
+
+SHOULD be interpreted as
+
+`fe70102261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc`
+
+This specification RECOMMENDs that the consuming service of the node uses a compact encoding type,
+such as base64 or base58 to allow for as short representations of the key as possible.
+
+### Public Key Types
+
+When implementing the pk de/serialization functionality, The node MUST support the [multiformats/multicodec](https://github.com/multiformats/multicodec) key type identifiers for the following public key type.
+
+| Name               | Tag | Code   | Description                          |
+| ------------------ | --- | ------ | ------------------------------------ |
+| `secp256k1-pub`    | key | `0xe7` | Secp256k1 public key                 |
+
+For a public key to be identifiable to the node the public key data MUST be prepended with the relevant [multiformats/unsigned-varint](https://github.com/multiformats/unsigned-varint) formatted code.
+
+*Example:*
+
+Below is a representation of an deserialized secp256k1 public key.
+
+```text
+04
+26 | 1c | 55 | 67 | 5e | 55 | ff | 25
+ed | b5 | 0b | 34 | 5c | fb | 3a | 3f
+35 | f6 | 07 | 12 | d2 | 51 | cb | aa
+ab | 97 | bd | 50 | 05 | 4c | 6e | bc
+3c | d4 | e2 | 22 | 00 | c6 | 8d | af
+74 | 93 | e1 | f8 | da | 6a | 19 | 0a
+68 | a6 | 71 | e2 | d3 | 97 | 78 | 09
+61 | 24 | 24 | c7 | c3 | 88 | 8b | c6
+```
+
+The `multicodec` code for a secp256k1 public key is `0xe7`.
+
+After parsing the code `0xe7` as a `multiformats/uvarint`, the byte value is `0xe7 0x01`, prepending this to the public key results in the below representation.
+
+```text
+e7 | 01 | 04
+26 | 1c | 55 | 67 | 5e | 55 | ff | 25
+ed | b5 | 0b | 34 | 5c | fb | 3a | 3f
+35 | f6 | 07 | 12 | d2 | 51 | cb | aa
+ab | 97 | bd | 50 | 05 | 4c | 6e | bc
+3c | d4 | e2 | 22 | 00 | c6 | 8d | af
+74 | 93 | e1 | f8 | da | 6a | 19 | 0a
+68 | a6 | 71 | e2 | d3 | 97 | 78 | 09
+61 | 24 | 24 | c7 | c3 | 88 | 8b | c6
+```
+
+### De/Serialization Process Flow
+
+When implementing the pk de/serialization functionality, the node MUST be passed a `multicodec` identified public key,
+of the above supported types, encoded with a valid `multibase` identifier.
+
+This specification RECOMMENDs that the node also accept an encoding type parameter to encode the output data.
+This provides for the case where the user requires the de/serialization key to be in a different encoding to the encoding of the given key.
+
+#### Serialization Example
+
+A hexadecimal encoded secp256k1 public chat key typically is represented as below:
+
+```text
+0x04261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc3cd4e22200c68daf7493e1f8da6a190a68a671e2d3977809612424c7c3888bc6
+```
+
+To be properly interpreted by the node for serialization the public key MUST be prepended with the `multicodec` `uvarint` code `0xea 0x01`
+and encoded with a valid `multibase` encoding, therefore giving the following:
+
+```text
+fea0104261c55675e55ff25edb50b345cfb3a3f35f60712d251cbaaab97bd50054c6ebc3cd4e22200c68daf7493e1f8da6a190a68a671e2d3977809612424c7c3888bc6
+```
+
+If adhering to the specification recommendation to provide the user with an output encoding parameter,
+the above string would be passed to the node with the following `multibase` encoding identifier.
+
+In this example the output encoding is defined as `base58 bitcoin`.
+
+```text
+z
+```
+
+The return value in this case would be
+
+```text
+zQ3shPyZJnxZK4Bwyx9QsaksNKDYTPmpwPvGSjMYVHoXHeEgB
+```
+
+Which after `multibase` decoding can be represented in bytes as below:
+
+```text
+e7 | 01 | 02
+26 | 1c | 55 | 67 | 5e | 55 | ff | 25
+ed | b5 | 0b | 34 | 5c | fb | 3a | 3f
+35 | f6 | 07 | 12 | d2 | 51 | cb | aa
+ab | 97 | bd | 50 | 05 | 4c | 6e | bc
+```
+
+#### Deserialization Example
+
+For the user, the deserialization process is exactly the same as serialization with the exception
+that the user MUST provide a serialized public key for deserialization. Else the deserialization algorithm will fail.
+
+For further guidance on the implementation of public key de/serialization consult the [`status-go` implementation and tests](https://github.com/status-im/status-go/blob/c9772325f2dca76b3504191c53313663ca2efbe5/api/utils_test.go).  
+
+## Security Considerations
+
+-
+
+## Changelog
+
+### Version 0.4
+
+Released [June 24, 2020](https://github.com/status-im/specs/commit/e98a9b76b7d4e1ce93e0b692e1521c2d54f72c59)
+
+- Added details of public key serialization and deserialization
+
+### Version 0.3
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+- Added language to include Waku in all relevant places
+- Change to keep `Mailserver` term consistent
+- Added clarification to Open Whisper Systems
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [BIP43](https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki)
+- [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
+- [EIP1581](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1581.md)
+- [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)
+- [Open Whisper Systems](https://en.wikipedia.org/wiki/Signal_Messenger#2013%E2%80%932018:_Open_Whisper_Systems)
+- [X3DH](https://signal.org/docs/specifications/x3dh/#the-x3dh-protocol)
+- [web3 API](https://web3js.readthedocs.io/en/1.0/web3-shh.html#generatesymkeyfrompassword)
+- [Protobuf encryption](https://github.com/status-im/status-go/messaging/chat/protobuf/encryption.pb.go)
+- [gfycat in Status](https://github.com/status-im/status-mobile/tree/develop/src/status_im/utils/gfycat)
+- [multiformats](https://github.com/multiformats/)
+- [status-go implementation and tests](https://github.com/status-im/status-go/blob/c9772325f2dca76b3504191c53313663ca2efbe5/api/utils_test.go)
+- [June 24, 2020 change commit](https://github.com/status-im/specs/commit/e98a9b76b7d4e1ce93e0b692e1521c2d54f72c59)
+- [May 22, 2020 change commit](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)

status/deprecated/client.md

@@ -0,0 +1,427 @@
+---
+title: CLIENT
+name: Client
+status: deprecated
+description: This specification describes how to write a Status client for communicating with other Status clients.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Adam Babik <adam@status.im>
+  - Andrea Maria Piana <andreap@status.im>
+  - Dean Eigenmann <dean@status.im>
+  - Corey Petty <corey@status.im>
+  - Oskar Thorén <oskar@status.im>
+  - Samuel Hawksby-Robinson <samuel@status.im>
+---
+
+## Abstract
+
+This specification describes how to write a Status client for communicating  
+with other Status clients.  
+This specification presents a reference implementation of the protocol
+used in a command-line client and a mobile app.
+
+This document consists of two parts.  
+The first outlines the specifications required to be a full Status client.  
+The second provides a design rationale and answers some common questions.
+
+## Introduction
+
+### Protocol layers
+
+Implementing a Status clients largely means implementing the following layers.
+Additionally, there are separate specifications for things like key management and account lifecycle.
+
+Other aspects, such as how a node uses IPFS for stickers or how the browser works, are currently underspecified.
+These specifications facilitate the implementation of a Status client for basic private communication.
+
+| Layer             | Purpose                        | Technology                   |
+| ----------------- | ------------------------------ | ---------------------------- |
+| Data and payloads | End user functionality         | 1:1, group chat, public chat |
+| Data sync         | Data consistency               | MVDS.                        |
+| Secure transport  | Confidentiality, PFS, etc      | Double Ratchet               |
+| Transport privacy | Routing, Metadata protection   | Waku / Whisper               |
+| P2P Overlay       | Overlay routing, NAT traversal | devp2p                       |
+
+### Protobuf
+
+[`protobuf`](https://developers.google.com/protocol-buffers/) is used in different layers, version `proto3` used is unless stated otherwise.
+
+## Components
+
+### P2P Overlay
+
+Status clients run on a public, permissionless peer-to-peer network, as specified by the devP2P
+network protocols. devP2P provides a protocol for node discovery which is in
+draft mode
+[here](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md). See
+more on node discovery and management in the next section.
+
+To communicate between Status nodes, the [RLPx Transport
+Protocol, v5](https://github.com/ethereum/devp2p/blob/master/rlpx.md) is used, which
+allows for TCP-based communication between nodes.
+
+On top of this RLPx-based subprotocols are ran, the client
+SHOULD NOT use [Whisper V6](https://eips.ethereum.org/EIPS/eip-627), the client
+SHOULD use [Waku V1](/waku/standards/legacy/6/waku1.md)
+for privacy-preserving messaging and efficient usage of a node's bandwidth.
+
+#### Node discovery and roles
+
+There are four types of node roles:
+
+1. `Bootstrap node`
+1. `Whisper/Waku relayer`
+1. `Mailserver` (servers and clients)
+1. `Mobile node` (Status Clients)
+
+A standard Status client MUST implement both `Whisper/Waku relayer` and `Mobile node` node types. The
+other node types are optional, but it is RECOMMEND to implement a `Mailserver`
+client mode, otherwise the user experience is likely to be poor.
+
+#### Bootstrapping
+
+Bootstrap nodes allow Status nodes to discover and connect to other Status nodes
+in the network.
+
+Currently, Status Gmbh provides the main bootstrap nodes, but anyone can
+run these provided they are connected to the rest of the Whisper/Waku network.
+
+Status maintains a list of production fleet bootstrap nodes in the following locations:
+
+**Hong Kong:**
+
+- `enode://6e6554fb3034b211398fcd0f0082cbb6bd13619e1a7e76ba66e1809aaa0c5f1ac53c9ae79cf2fd4a7bacb10d12010899b370c75fed19b991d9c0cdd02891abad@47.75.99.169:443`
+- `enode://23d0740b11919358625d79d4cac7d50a34d79e9c69e16831c5c70573757a1f5d7d884510bc595d7ee4da3c1508adf87bbc9e9260d804ef03f8c1e37f2fb2fc69@47.52.106.107:443`
+
+**Amsterdam:**
+
+- `enode://436cc6f674928fdc9a9f7990f2944002b685d1c37f025c1be425185b5b1f0900feaf1ccc2a6130268f9901be4a7d252f37302c8335a2c1a62736e9232691cc3a@178.128.138.128:443`
+- `enode://5395aab7833f1ecb671b59bf0521cf20224fe8162fc3d2675de4ee4d5636a75ec32d13268fc184df8d1ddfa803943906882da62a4df42d4fccf6d17808156a87@178.128.140.188:443`
+
+**Central US:**
+
+- `enode://32ff6d88760b0947a3dee54ceff4d8d7f0b4c023c6dad34568615fcae89e26cc2753f28f12485a4116c977be937a72665116596265aa0736b53d46b27446296a@34.70.75.208:443`
+- `enode://5405c509df683c962e7c9470b251bb679dd6978f82d5b469f1f6c64d11d50fbd5dd9f7801c6ad51f3b20a5f6c7ffe248cc9ab223f8bcbaeaf14bb1c0ef295fd0@35.223.215.156:443`
+
+These bootstrap nodes MAY change and are not guaranteed to stay this way forever
+and at some point circumstances might force them to change.
+
+#### Discovery
+
+A Status client MUST discover or have a list of peers to connect to. Status uses a
+light discovery mechanism based on a combination of [Discovery v5](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md) and
+[Rendezvous Protocol](https://github.com/libp2p/specs/tree/master/rendezvous),
+(with some [modifications](https://github.com/status-im/rendezvous#differences-with-original-rendezvous)).
+Additionally, some static nodes MAY also be used.
+
+A Status client MUST use at least one discovery method or use static nodes
+to communicate with other clients.
+
+Discovery V5 uses bootstrap nodes to discover other peers. Bootstrap nodes MUST support
+Discovery V5 protocol as well in order to provide peers. It is kademlia-based discovery mechanism
+and it might consume significant (at least on mobile) amount of network traffic to operate.
+
+In order to take advantage from simpler and more mobile-friendly peers discovery mechanism,
+i.e. Rendezvous protocol, one MUST provide a list of Rendezvous nodes which speak
+Rendezvous protocol. Rendezvous protocol is request-response discovery mechanism.
+It uses Ethereum Node Records (ENR) to report discovered peers.
+
+Both peers discovery mechanisms use topics to provide peers with certain capabilities.
+There is no point in returning peers that do not support a particular protocol.
+Status nodes that want to be discovered MUST register to Discovery V5 and/or Rendezvous
+with the `whisper` topic. Status nodes that are `Mailservers` and want to
+be discoverable MUST additionally register with the `whispermail` topic.
+
+It is RECOMMENDED to use both mechanisms but at the same time implement a structure
+called `PeerPool`. `PeerPool` is responsible for maintaining an optimal number of peers.
+For mobile nodes, there is no significant advantage to have more than 2-3 peers and one `Mailserver`.
+`PeerPool` can notify peers discovery protocol implementations that they should suspend
+their execution because the optimal number of peers is found. They should resume
+if the number of connected peers drops or a `Mailserver` disconnects.
+
+It is worth noticing that an efficient caching strategy MAY be of great use, especially,
+on mobile devices. Discovered peers can be cached as they rarely change and used
+when the client starts again. In such a case, there might be no need to even start
+peers discovery protocols because cached peers will satisfy the optimal number of peers.
+
+Alternatively, a client MAY rely exclusively on a list of static peers. This is the most efficient
+way because there are no peers discovery algorithm overhead introduced. The disadvantage
+is that these peers might be gone and without peers discovery mechanism, it won't be possible to find
+new ones.
+
+The current list of static peers is published on <https://fleets.status.im/>. `eth.prod` is the current
+group of peers the official Status client uses. The others are test networks.
+
+Finally, Waku node addresses can be retrieved by traversing
+the merkle tree found at [`fleets.status.im`](https://fleets.status.im), as described in [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459#client-protocol).
+
+#### Mobile nodes
+
+A `Mobile node` is a Whisper and/or Waku node which connects to part of the respective Whisper
+and/or Waku network(s). A `Mobile node` MAY relay messages. See next section for more details on how
+to use Whisper and/or Waku to communicate with other Status nodes.
+
+### Transport privacy and Whisper / Waku usage
+
+Once a Whisper and/or Waku node is up and running there are some specific settings required
+to communicate with other Status nodes.
+
+See [WHISPER-USAGE](/status/deprecated/whisper-usage.md) and [WAKU-USAGE](/status/deprecated/waku-usage.md) for more details.
+
+For providing an offline inbox, see the complementary [WHISPER-MAILSERVER](/status/deprecated/whisper-mailserver.md) and [WAKU-MAILSERVER](/status/deprecated/waku-mailserver.md).
+
+### Secure Transport
+
+In order to provide confidentiality, integrity, authentication and forward
+secrecy of messages the node implements a secure transport on top of Whisper and Waku. This is
+used in 1:1 chats and group chats, but not for public chats. See [SECURE-TRANSPORT](/status/deprecated/secure-transport.md) for more.
+
+### Data Sync
+
+[MVDS](/vac/2/mvds.md) is used for 1:1 and group chats, however it is currently not in use for public chats.
+[Status payloads](#payloads-and-clients) are serialized and then wrapped inside an
+MVDS message which is added to an [MVDS payload](/vac/2/mvds.md#payloads),
+the node encrypts this payload (if necessary for 1-to-1 / group-chats) and sends it using
+Whisper or Waku which also encrypts it.
+
+### Payloads and clients
+
+On top of secure transport, various types of data sync clients and
+the node uses payload formats for things like 1:1 chat, group chat and public chat. These have
+various degrees of standardization. Please refer to [PAYLOADS](/status/deprecated/payloads.md) for more details.
+
+### BIPs and EIPs Standards support
+
+For a list of EIPs and BIPs that SHOULD be supported by Status client, please
+see [EIPS](/status/deprecated/eips.md).
+
+## Security Considerations
+
+See [Appendix A](#appendix-a-security-considerations)
+
+## Design Rationale
+
+P2P Overlay
+
+### Why devp2p? Why not use libp2p?
+
+At the time Status developed the main Status clients, devp2p was the most
+mature. However, in the future libp2p is likely to be used, as it'll
+provide us with multiple transports, better protocol negotiation, NAT traversal,
+etc.
+
+For very experimental bridge support, see the bridge between libp2p and devp2p
+in [Murmur](https://github.com/status-im/murmur).
+
+### What about other RLPx subprotocols like LES, and Swarm?
+
+Status is primarily optimized for resource restricted devices, and at present
+time light client support for these protocols are suboptimal. This is a work in
+progress.
+
+For better Ethereum light client support, see [Re-enable LES as
+option](https://github.com/status-im/status-go/issues/1025). For better Swarm
+support, see [Swarm adaptive
+nodes](https://github.com/ethersphere/SWIPs/pull/12).
+
+For transaction support, Status clients currently have to rely on Infura.
+
+Status clients currently do not offer native support for file storage.
+
+### Why do you use Whisper?
+
+Whisper is one of the [three parts](http://gavwood.com/dappsweb3.html) of the
+vision of Ethereum as the world computer, Ethereum and Swarm being the other
+two. Status was started as an encapsulation of and a clear window to this world
+computer.
+
+### Why do you use Waku?
+
+Waku is a direct upgrade and replacement for Whisper, the main motivation for
+developing and implementing Waku can be found in the [Waku specs](/waku/).
+
+>Waku was created to incrementally improve in areas that Whisper is lacking in,
+>with special attention to resource restricted devices. We specify the standard for
+>Waku messages in order to ensure forward compatibility of different Waku clients,
+>backwards compatibility with Whisper clients, as well as to allow multiple
+>implementations of Waku and its capabilities. We also modify the language to be more
+>unambiguous, concise and consistent.
+
+Considerable work has gone into the active development of Ethereum, in contrast Whisper
+is not currently under active development, and it has several drawbacks. Among others:
+
+- Whisper is very wasteful bandwidth-wise and doesn't appear to be scalable
+- Proof of work is a poor spam protection mechanism for heterogeneous devices
+- The privacy guarantees provided are not rigorous
+- There are no incentives to run a node
+
+Finding a more suitable transport privacy is an ongoing research effort,
+together with [Vac](https://vac.dev/vac-overview) and other teams in the space.
+
+### Why is PoW for Waku set so low?
+
+A higher PoW would be desirable, but this kills the battery on mobile phones,
+which is a prime target for Status clients.
+
+This means the network is currently vulnerable to DDoS attacks. Alternative
+methods of spam protection are currently being researched.
+
+### Why do you not use Discovery v5 for node discovery?
+
+At the time of implementing dynamic node discovery, Discovery v5 wasn't completed
+yet. Additionally, running a DHT on a mobile leads to slow node discovery, bad
+battery and poor bandwidth usage. Instead, each client can choose to turn on
+Discovery v5 for a short period until the node populates their peer list.
+
+For some further investigation, see
+[here](https://github.com/status-im/swarms/blob/master/ideas/092-disc-v5-research.md).
+
+### I heard something about `Mailservers` being trusted somehow?
+
+In order to use a `Mailserver`, a given node needs to connect to it directly, i.e. add the `Mailserver`
+as its peer and mark it as trusted.
+This means that the `Mailserver` is able to send direct p2p messages to the node instead of broadcasting them.
+Effectively, it knows the bloom filter of the topics the node is interested in,
+when it is online as well as many metadata like IP address.
+
+### Data sync
+
+#### Why is MVDS not used for public chats?
+
+Currently, public chats are broadcast-based, and there's no direct way of finding
+out who is receiving messages. Hence there's no clear group sync state context
+whereby participants can sync. Additionally, MVDS is currently not optimized for
+large group contexts, which means bandwidth usage will be a lot higher than
+reasonable. See [P2P Data Sync for Mobile](https://vac.dev/p2p-data-sync-for-mobile) for more.
+This is an active area of research.
+
+## Footnotes
+
+1. <https://github.com/status-im/status-protocol-go/>
+2. <https://github.com/status-im/status-console-client/>
+3. <https://github.com/status-im/status-mobile/>
+
+## Appendix A: Security considerations
+
+There are several security considerations to take into account when running Status.
+Chief among them are: scalability, DDoS-resistance and privacy.
+These also vary depending on what capabilities are used, such as `Mailserver`, light node, and so on.
+
+### Scalability and UX
+
+**Bandwidth usage:**
+
+In version 1 of Status, bandwidth usage is likely to be an issue.
+In Status version 1.1 this is partially addressed with Waku usage, see [the theoretical scaling model](https://github.com/vacp2p/research/tree/dcc71f4779be832d3b5ece9c4e11f1f7ec24aac2/whisper_scalability).
+
+**`Mailserver` High Availability requirement:**
+
+A `Mailserver` has to be online to receive messages for other nodes, this puts a high availability requirement on it.
+
+**Gossip-based routing:**
+
+Use of gossip-based routing doesn't necessarily scale.
+It means each node can see a message multiple times,
+and having too many light nodes can cause propagation probability that is too low.
+See [Whisper vs PSS](https://our.status.im/whisper-pss-comparison/) for more and a possible Kademlia based alternative.
+
+**Lack of incentives:**
+
+Status currently lacks incentives to run nodes, which means node operators are more likely to create centralized choke points.
+
+### Privacy
+
+**Light node privacy:**
+
+The main privacy concern with light nodes is that directly connected peers will know that a message originates from them (as it are the only ones it sends). This means nodes can make assumptions about what messages (topics) their peers are interested in.
+
+**Bloom filter privacy:**
+
+A user reveals which messages they are interested in, by setting only the topics they are interested in on the bloom filter.
+This is a fundamental trade-off between bandwidth usage and privacy,
+though the trade-off space is likely suboptimal in terms of the [Anonymity](https://eprint.iacr.org/2017/954.pdf) [trilemma](https://petsymposium.org/2019/files/hotpets/slides/coordination-helps-anonymity-slides.pdf).
+
+**`Mailserver client` privacy:**
+
+A `Mailserver client` has to trust a `Mailserver`, which means they can send direct traffic. This reveals what topics / bloom filter a node is interested in, along with its peerID (with IP).
+
+**Privacy guarantees not rigorous:**
+
+Privacy for Whisper or Waku hasn't been studied rigorously for various threat models like global passive adversary, local active attacker, etc. This is unlike e.g. Tor and mixnets.
+
+**Topic hygiene:**
+
+Similar to bloom filter privacy, using a very specific topic reveals more information. See scalability model linked above.
+
+### Spam resistance
+
+**PoW bad for heterogeneous devices:**
+
+Proof of work is a poor spam prevention mechanism. A mobile device can only have a very low PoW in order not to use too much CPU / burn up its phone battery. This means someone can spin up a powerful node and overwhelm the network.
+
+**`Mailserver` trusted connection:**
+
+A `Mailserver` has a direct TCP connection, which means they are trusted to send traffic. This means a malicious or malfunctioning `Mailserver` can overwhelm an individual node.
+
+### Censorship resistance
+
+**Devp2p TCP port blockable:**
+
+By default Devp2p runs on port `30303`, which is not commonly used for any other service. This means it is easy to censor, e.g. airport WiFi. This can be mitigated somewhat by running on e.g. port `80` or `443`, but there are still outstanding issues. See libp2p and Tor's Pluggable Transport for how this can be improved.
+
+See <https://github.com/status-im/status-mobile/issues/6351> for some discussion.
+
+## Acknowledgments
+
+Jacek Sieka
+
+## Changelog
+
+### Version 0.3
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+- Added that Waku SHOULD be used
+- Added that Whisper SHOULD NOT be used
+- Added language to include Waku in all relevant places
+- Change to keep `Mailserver` term consistent
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [Protobuf](https://developers.google.com/protocol-buffers/)
+- [Discv5](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md)
+- [RLPx Transport Protocol, v5](https://github.com/ethereum/devp2p/blob/master/rlpx.md)
+- [Whisper V6](https://eips.ethereum.org/EIPS/eip-627)
+- [Waku V1](/waku/standards/legacy/6/waku1.md)
+- [Rendezvous Protocol](https://github.com/libp2p/specs/tree/master/rendezvous)
+- [Rendezvous Protocol modifications](https://github.com/status-im/rendezvous#differences-with-original-rendezvous)
+- [Fleets Status](https://fleets.status.im)
+- [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459#client-protocol)
+- [WHISPER-USAGE](/status/deprecated/whisper-usage.md)
+- [WAKU-USAGE](/status/deprecated/waku-usage.md)
+- [WHISPER-MAILSERVER](/status/deprecated/whisper-mailserver.md)
+- [WAKU-MAILSERVER](/status/deprecated/waku-mailserver.md)
+- [SECURE-TRANSPORT](/status/deprecated/secure-transport.md)
+- [MVDS](/vac/2/mvds.md)
+- [PAYLOADS](/status/deprecated/payloads.md)
+- [EIPS](/status/deprecated/eips.md)
+- [Murmur](https://github.com/status-im/murmur)
+- [Re-enable LES as option](https://github.com/status-im/status-go/issues/1025)
+- [Swarm adaptive nodes](https://github.com/ethersphere/SWIPs/pull/12)
+- [Whisper vs PSS](https://our.status.im/whisper-pss-comparison/)
+- [Waku specs](/waku/)
+- [Vac](https://vac.dev/vac-overview)
+- [theoretical scaling model](https://github.com/vacp2p/research/tree/dcc71f4779be832d3b5ece9c4e11f1f7ec24aac2/whisper_scalability)
+- [Anonymity](https://eprint.iacr.org/2017/954.pdf)
+- [trilemma](https://petsymposium.org/2019/files/hotpets/slides/coordination-helps-anonymity-slides.pdf)
+- [Whisper vs PSS](https://our.status.im/whisper-pss-comparison/)
+- [Discovery v5 research](https://github.com/status-im/swarms/blob/master/ideas/092-disc-v5-research.md)
+- [P2P Data Sync for Mobile](https://vac.dev/p2p-data-sync-for-mobile)
+- [Status protocol go](https://github.com/status-im/status-protocol-go/)
+- [Status console client](https://github.com/status-im/status-console-client/)
+- [Status mobile](https://github.com/status-im/status-mobile/)
+- [Status mobile issue 6351](https://github.com/status-im/status-mobile/issues/6351)

status/deprecated/dapp-browser-API-usage.md

@@ -0,0 +1,135 @@
+---
+title: Dapp browser API usage
+name: Dapp browser API usage
+status: deprecated
+description: This document describes requirements that an application must fulfill in order to provide a proper environment for Dapps running inside a browser.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+---
+
+## Abstract
+
+This document describes requirements that an application must fulfill in order to provide a proper environment for Dapps running inside a browser.
+A description of the Status Dapp API is provided, along with an overview of bidirectional communication underlying the API implementation.
+The document also includes a list of EIPs that this API implements.
+
+## Definitions
+
+| Term       | Description                                                                         |
+|------------|-------------------------------------------------------------------------------------|
+| **Webview**   | Platform-specific browser core implementation.                                    |
+| **Ethereum Provider** | A JS object (`window.ethereum`) injected into each web page opened in the browser providing web3 compatible provider. |
+| **Bridge** | A set of facilities allow bidirectional communication between JS code and the application. |
+
+## Overview
+
+The application should expose an Ethereum Provider object (`window.ethereum`) to JS code running inside the browser.
+It is important to have the `window.ethereum` object available before the page loads, otherwise Dapps might not work correctly.
+
+Additionally, the browser component should also provide bidirectional communication between JS code and the application.
+
+## Usage in Dapps
+
+Dapps can use the below properties and methods of `window.ethereum` object.
+
+### Properties
+
+#### `isStatus`
+
+Returns true. Can be used by the Dapp to find out whether it's running inside Status.
+
+#### `status`
+
+Returns a `StatusAPI` object. For now it supports one method: `getContactCode` that sends a `contact-code` request to Status.
+
+### Methods
+
+#### `isConnected`
+
+Similarly to Ethereum JS API [docs](https://github.com/ethereum/wiki/wiki/JavaScript-API#web3isconnected),
+it should be called to check if connection to a node exists. On Status, this fn always returns true, as once Status is up and running, node is automatically started.
+
+#### `scanQRCode`
+
+Sends a `qr-code` Status API request.
+
+#### `request`
+
+`request` method as defined by EIP-1193.
+
+### Unused
+
+Below are some legacy methods that some Dapps might still use.
+
+#### `enable` (DEPRECATED)
+
+Sends a `web3` Status API request. It returns a first entry in the list of available accounts.
+
+Legacy `enable` method as defined by [EIP1102](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md).
+
+#### `send` (DEPRECATED)
+
+Legacy `send` method as defined by [EIP1193](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md).
+
+#### `sendAsync` (DEPRECATED)
+
+Legacy `sendAsync` method as defined by [EIP1193](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md).
+
+#### `sendSync` (DEPRECATED)
+
+Legacy `send` method.
+
+## Implementation
+
+Status uses a [forked version](https://github.com/status-im/react-native-webview) of [react-native-webview](https://github.com/react-native-community/react-native-webview)  to display web or dapps content.
+The fork provides an Android implementation of JS injection before page load.
+It is required in order to properly inject Ethereum Provider object.
+
+Status injects two JS scripts:
+
+- [provider.js](https://github.com/status-im/status-mobile/blob/develop/resources/js/provider.js): `window.ethereum` object
+- [webview.js](https://github.com/status-im/status-mobile/blob/develop/resources/js/webview.js): override for `history.pushState` used internally
+
+Dapps running inside a browser communicate with Status Ethereum node by means of a *bridge* provided by react-native-webview library.
+The bridge allows for bidirectional communication between browser and Status. In order to do so, it injects a special `ReactNativeWebview` object into each page it loads.
+
+On Status (React Native) end, `react-native-webview` library provides `WebView.injectJavascript` function
+on a webview component that allows to execute arbitrary code inside the webview.
+Thus it is possible to inject a function call passing Status node response back to the Dapp.
+
+Below is the table briefly describing what functions/properties are used. More details available in package [docs](https://github.com/react-native-community/react-native-webview/blob/master/docs/Guide.md#communicating-between-js-and-native).
+
+| Direction | Side | Method |
+|-----------|------|-----------|
+| Browser->Status | JS | `ReactNativeWebView.postMessage()`|
+| Browser->Status | RN | `WebView.onMessage()`|
+| Status->Browser | JS | `ReactNativeWebView.onMessage()`|
+| Status->Browser | RN | `WebView.injectJavascript()`|
+
+## Compatibility
+
+Status browser supports the following EIPs:
+
+- [EIP1102](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md): `eth_requestAccounts` support
+- [EIP1193](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md): `connect`, `disconnect`, `chainChanged`, and `accountsChanged` event support is not implemented
+
+## Changelog
+
+| Version | Comment |
+| :-----: | ------- |
+| 0.1.0 | Initial Release |
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [Ethereum JS API docs](https://github.com/ethereum/wiki/wiki/JavaScript-API#web3isconnected)
+- [EIP1102](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md)
+- [EIP1193](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md)
+- [forked version](https://github.com/status-im/react-native-webview)
+- [react-native-webview](https://github.com/react-native-community/react-native-webview)
+- [provider.js](https://github.com/status-im/status-mobile/blob/develop/resources/js/provider.js)
+- [webview.js](https://github.com/status-im/status-mobile/blob/develop/resources/js/webview.js)
+- [docs](https://github.com/react-native-community/react-native-webview/blob/master/docs/Guide.md#communicating-between-js-and-native)

status/deprecated/eips.md

@@ -0,0 +1,286 @@
+---
+title: EIPS
+name: EIPS
+status: deprecated
+description: Status relation with the EIPs
+editor: Ricardo Guilherme Schmidt <ricardo3@status.im>
+contributors:
+- 
+---
+
+## Abstract
+
+This specification describes how Status relates with EIPs.
+
+## Introduction
+
+Status should follow all standards as possible.
+Whenever the Status app needs a feature, it should be first checked if there is a standard for that,
+if not, Status should propose a standard.
+
+### Support table
+
+|          | Status v0 | Status v1 | Other    | State    |
+|----------|-----------|-----------|----------| -------- |
+| BIP32    | N         | Y         | N        | `stable` |
+| BIP39    | Y         | Y         | Y        | `stable` |
+| BIP43    | N         | Y         | N        | `stable` |
+| BIP44    | N         | Y         | N        | `stable` |
+| EIP20    | Y         | Y         | Y        | `stable` |
+| EIP55    | Y         | Y         | Y        | `stable` |
+| EIP67    | P         | P         | N        | `stable` |
+| EIP137   | P         | P         | N        | `stable` |
+| EIP155   | Y         | Y         | Y        | `stable` |
+| EIP165   | P         | N         | N        | `stable` |
+| EIP181   | P         | N         | N        | `stable` |
+| EIP191   | Y?        | N         | Y        | `stable` |
+| EIP627   | Y         | Y         | N        | `stable` |
+| EIP681   | Y         | N         | Y        | `stable` |
+| EIP712   | P         | P         | Y        | `stable` |
+| EIP721   | P         | P         | Y        | `stable` |
+| EIP831   | N         | Y         | N        | `stable` |
+| EIP945   | Y         | Y         | N        | `stable` |
+| EIP1102  | Y         | Y         | Y        | `stable` |
+| EIP1193  | Y         | Y         | Y        | `stable` |
+| EIP1577  | Y         | P         | N        | `stable` |
+| EIP1581  | N         | Y         | N        | `stable` |
+| EIP1459  | N         |           | N        | `raw`    |
+
+## Components
+
+### BIP32 - Hierarchical Deterministic Wallets
+
+Support: Dependency.  
+[Reference](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
+Description: Enable wallets to derive multiple private keys from the same seed.  
+Used for: Dependency of BIP39 and BIP43.  
+
+### BIP39 - Mnemonic code for generating deterministic keys
+
+Support: Dependency.  
+[Reference](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
+Description: Enable wallet to create private key based on a safe seed phrase.
+Used for: Security and user experience.
+
+### BIP43 - Purpose Field for Deterministic Wallets
+
+Support: Dependency.  
+[Reference](https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki)
+Description: Enable wallet to create private keys branched for a specific purpose.
+Used for: Dependency of BIP44, uses "ethereum" coin.
+
+### BIP44 - Multi-Account Hierarchy for Deterministic Wallets
+
+Support: Dependency.
+[Reference](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)
+Description: Enable wallet to derive multiple accounts in top of BIP39.  
+Used for: Privacy.  
+[Source code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/constants.cljs#L240)
+Observation: BIP44 don't solve privacy issues regarding the transparency of transactions, therefore directly connected addresses through a transactions can be identifiable by a "network reconnaissance attack" over transaction history, this attack together with leakage of information from centralized services, such as exchanges, would be fatal against the whole privacy of users, regardless of BIP44.  
+
+### EIP20 - Fungible Token
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-20)
+Description: Enable wallets to use tokens based on smart contracts compliant with this standard.  
+Used for: Wallet feature.  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/tokens.cljs)  
+
+### EIP55 - Mixed-case checksum address encoding
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-55)
+Description: Checksum standard that uses lowercase and uppercase inside address hex value.  
+Used for: Sanity check of forms using ethereum address.  
+[Related](https://github.com/status-im/status-mobile/issues/4959) [Also](https://github.com/status-im/status-mobile/issues/8707)
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/eip55.cljs)
+
+### EIP67 - Standard URI scheme with metadata, value and byte code
+
+Support: Partial.  
+[Reference](https://github.com/ethereum/EIPs/issues/67)
+Description: A standard way of creating Ethereum URIs for various use-cases.  
+Used for: Legacy support.  
+[Issue](https://github.com/status-im/status-mobile/issues/875)  
+
+### EIP137 - Ethereum Domain Name Service - Specification
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-137)
+Description: Enable wallets to lookup ENS names.  
+Used for: User experience, as a wallet and identity feature, usernames.  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/ens.cljs#L86)
+
+### EIP155 - Simple replay attack protection
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-155)
+Description: Defined chainId parameter in the singed ethereum transaction payload.  
+Used for: Signing transactions, crucial to safety of users against replay attacks.  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/core.cljs)
+
+### EIP165 - Standard Interface Detection
+
+Support: Dependency/Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-165)
+Description: Standard interface for contract to answer if it supports other interfaces.  
+Used for: Dependency of ENS and EIP721.  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/eip165.cljs)
+
+### EIP181 - ENS support for reverse resolution of Ethereum addresses
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-181)
+Description: Enable wallets to render reverse resolution of Ethereum addresses.  
+Used for: Wallet feature.  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/ens.cljs#L86)
+
+### EIP191 - Signed Message
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-191)
+Description: Contract signature standard, adds an obligatory padding to signed message to differentiate from Ethereum Transaction messages.  
+Used for: Dapp support, security, dependency of ERC712.  
+
+### EIP627 - Whisper Specification
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-627)
+Description: format of Whisper messages within the ÐΞVp2p Wire Protocol.  
+Used for: Chat protocol.  
+
+### EIP681 - URL Format for Transaction Requests
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-681)
+Description: A link that pop up a transaction in the wallet.  
+Used for: Useful as QR code data for transaction requests, chat transaction requests and for dapp links to transaction requests.  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/eip681.cljs)
+Related: [Issue #9183: URL Format for Transaction Requests (EIP681) is poorly supported](https://github.com/status-im/status-mobile/issues/9183) [Issue #9240](https://github.com/status-im/status-mobile/pull/9240) [Issue #9238](https://github.com/status-im/status-mobile/issues/9238) [Issue #7214](https://github.com/status-im/status-mobile/issues/7214) [Issue #7325](https://github.com/status-im/status-mobile/issues/7325) [Issue #8150](https://github.com/status-im/status-mobile/issues/8150)
+
+### EIP712 - Typed Signed Message
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-712)
+Description: Standardize types for contract signature, allowing users to easily inspect whats being signed.  
+Used for: User experience, security.  
+Related: [Isse #5461](https://github.com/status-im/status-mobile/issues/5461) [Commit](https://github.com/status-im/status-mobile/commit/ba37f7b8d029d3358c7b284f6a2383b9ef9526c9)
+
+### EIP721 - Non Fungible Token
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-721)
+Description: Enable wallets to use tokens based on smart contracts compliant with this standard.  
+Used for: Wallet feature.  
+Related: [Issue #8909](https://github.com/status-im/status-mobile/issues/8909)
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/erc721.cljs) [Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/tokens.cljs)  
+
+### EIP945 - Web 3 QR Code Scanning API
+
+Support: Full.  
+[Reference](https://github.com/ethereum/EIPs/issues/945)
+Used for: Sharing contactcode, reading transaction requests.  
+Related: [Issue #5870](https://github.com/status-im/status-mobile/issues/5870)
+
+### EIP1102 - Opt-in account exposure
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-1102)
+Description: Allow users to opt-in the exposure of their ethereum address to dapps they browse.  
+Used for: Privacy, DApp support.  
+Related: [Issue #7985](https://github.com/status-im/status-mobile/issues/7985)
+
+### EIP1193 - Ethereum Provider JavaScript API
+
+Support: Full.  
+[Reference](https://eips.ethereum.org/EIPS/eip-1193)
+Description: Allows dapps to recognize event changes on wallet.  
+Used for: DApp support.  
+Related: [Issue #7246](https://github.com/status-im/status-mobile/pull/7246)
+
+### EIP1577 - contenthash field for ENS
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-1577)  
+Description: Allows users browse ENS domains using contenthash standard.  
+Used for: Browser, DApp support.  
+Related: [Isse #6688](https://github.com/status-im/status-mobile/issues/6688)
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/utils/contenthash.cljs) [Sourcecode](https://github.com/status-im/status-mobile/blob/develop/test/cljs/status_im/test/utils/contenthash.cljs#L5)  
+
+### EIP1581 - Non-wallet usage of keys derived from BIP-32 trees
+
+Support: Partial.  
+[Reference](https://eips.ethereum.org/EIPS/eip-1581)
+Description: Allow wallet to derive keys that are less sensible (non wallet).  
+Used for: Security (don't reuse wallet key) and user experience (don't request keycard every login).  
+Related: [Issue #9096](https://github.com/status-im/status-mobile/issues/9088) [Issue #9096](https://github.com/status-im/status-mobile/pull/9096)  
+[Sourcecode](https://github.com/status-im/status-mobile/blob/develop/src/status_im/constants.cljs#L242)
+
+### EIP1459 - Node Discovery via DNS
+
+Support: -
+[Reference](https://eips.ethereum.org/EIPS/eip-1459)
+Description: Allows the storing and retrieving of nodes through merkle trees stored in TXT records of a domain.
+Used for: Finding Waku nodes.
+Related: -
+Sourcecode: -
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [BIP32 - Hierarchical Deterministic Wallets](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)
+- [BIP39 - Mnemonic code for generating deterministic keys](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki)
+- [BIP43 - Purpose Field for Deterministic Wallets](https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki)
+- [BIP44 - Multi-Account Hierarchy for Deterministic Wallets](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)
+- [BIP44 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/constants.cljs#L240)
+- [EIP20 - Fungible Token](https://eips.ethereum.org/EIPS/eip-20)
+- [EIP20 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/tokens.cljs)
+- [EIP55 - Mixed-case checksum address encoding](https://eips.ethereum.org/EIPS/eip-55)
+- [EIP55 Related Issue 4959](https://github.com/status-im/status-mobile/issues/4959)
+- [EIP55 Related Issue 8707](https://github.com/status-im/status-mobile/issues/8707)
+- [EIP55 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/eip55.cljs)
+- [EIP67 - Standard URI scheme with metadata, value and byte code](https://github.com/ethereum/EIPs/issues/67)
+- [EIP67 Related Issue 875](https://github.com/status-im/status-mobile/issues/875)
+- [EIP137 - Ethereum Domain Name Service - Specification](https://eips.ethereum.org/EIPS/eip-137)
+- [EIP137 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/ens.cljs#L86)
+- [EIP155 - Simple replay attack protection](https://eips.ethereum.org/EIPS/eip-155)
+- [EIP155 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/core.cljs)
+- [EIP165 - Standard Interface Detection](https://eips.ethereum.org/EIPS/eip-165)
+- [EIP165 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/eip165.cljs)
+- [EIP181 - ENS support for reverse resolution of Ethereum addresses](https://eips.ethereum.org/EIPS/eip-181)
+- [EIP181 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/ens.cljs#L86)
+- [EIP191 - Signed Message](https://eips.ethereum.org/EIPS/eip-191)
+- [EIP627 - Whisper Specification](https://eips.ethereum.org/EIPS/eip-627)
+- [EIP681 - URL Format for Transaction Requests](https://eips.ethereum.org/EIPS/eip-681)
+- [EIP681 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/eip681.cljs)
+- [EIP681 Related Issue 9183](https://github.com/status-im/status-mobile/issues/9183)
+- [EIP681 Related Issue 9240](https://github.com/status-im/status-mobile/pull/9240)
+- [EIP681 Related Issue 9238](https://github.com/status-im/status-mobile/issues/9238)
+- [EIP681 Related Issue 7214](https://github.com/status-im/status-mobile/issues/7214)
+- [EIP681 Related Issue 7325](https://github.com/status-im/status-mobile/issues/7325)
+- [EIP681 Related Issue 8150](https://github.com/status-im/status-mobile/issues/8150)
+- [EIP712 - Typed Signed Message](https://eips.ethereum.org/EIPS/eip-712)
+- [EIP712 Related Issue 5461](https://github.com/status-im/status-mobile/issues/5461)
+- [EIP712 Related Commit](https://github.com/status-im/status-mobile/commit/ba37f7b8d029d3358c7b284f6a2383b9ef9526c9)
+- [EIP721 - Non Fungible Token](https://eips.ethereum.org/EIPS/eip-721)
+- [EIP721 Related Issue 8909](https://github.com/status-im/status-mobile/issues/8909)
+- [EIP721 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/erc721.cljs)
+- [EIP721 Source Code (Tokens)](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/tokens.cljs)
+- [EIP945 - Web 3 QR Code Scanning API](https://github.com/ethereum/EIPs/issues/945)
+- [EIP945 Related Issue 5870](https://github.com/status-im/status-mobile/issues/5870)
+- [EIP1102 - Opt-in account exposure](https://eips.ethereum.org/EIPS/eip-1102)
+- [EIP1102 Related Issue 7985](https://github.com/status-im/status-mobile/issues/7985)
+- [EIP1193 - Ethereum Provider JavaScript API](https://eips.ethereum.org/EIPS/eip-1193)
+- [EIP1193 Related Issue 7246](https://github.com/status-im/status-mobile/pull/7246)
+- [EIP1577 - contenthash field for ENS](https://eips.ethereum.org/EIPS/eip-1577)
+- [EIP1577 Related Issue 6688](https://github.com/status-im/status-mobile/issues/6688)
+- [EIP1577 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/utils/contenthash.cljs)
+- [EIP1577 Test Source Code](https://github.com/status-im/status-mobile/blob/develop/test/cljs/status_im/test/utils/contenthash.cljs#L5)
+- [EIP1581 - Non-wallet usage of keys derived from BIP-32 trees](https://eips.ethereum.org/EIPS/eip-1581)
+- [EIP1581 Related Issue 9088](https://github.com/status-im/status-mobile/issues/9088)
+- [EIP1581 Related Issue 9096](https://github.com/status-im/status-mobile/pull/9096)
+- [EIP1581 Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/constants.cljs#L242)
+- [EIP1459 - Node Discovery via DNS](https://eips.ethereum.org/EIPS/eip-1459)

status/deprecated/ethereum-usage.md

@@ -0,0 +1,237 @@
+---
+title: ETHEREUM-USAGE
+name: Status interactions with the Ethereum blockchain
+status: deprecated
+description: All interactions that the Status client has with the Ethereum blockchain.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+    - Andrea Maria Piana <andreap@status.im>
+---
+
+## Abstract
+
+This specification documents all the interactions that the Status client has
+with the [Ethereum](https://ethereum.org/developers/) blockchain.
+
+## Background
+
+All the interactions are made through [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC).
+Currently [Infura](https://infura.io/) is used.
+The client assumes high-availability,
+otherwise it will not be able to interact with the Ethereum blockchain.
+Status nodes rely on these Infura nodes
+to validate the integrity of the transaction and report a consistent history.
+
+Key handling is described [here](/status/deprecated/account.md)
+
+1. [Wallet](#wallet)
+2. [ENS](#ens)
+
+## Wallet
+
+The wallet in Status has two main components:
+
+1) Sending transactions
+2) Fetching balance
+
+In the section below are described the `RPC` calls made the nodes, with a brief
+description of their functionality and how it is used by Status.
+
+1.[Sending transactions](#sending-transactions)
+
+- [EstimateGas](#estimategas)
+- [PendingNonceAt](#pendingnonceat)
+- [SuggestGasPrice](#suggestgasprice)
+- [SendTransaction](#sendtransaction)
+
+2.[Fetching balance](#fetching-balance)
+
+- [BlockByHash](#blockbyhash)
+- [BlockByNumber](#blockbynumber)
+- [FilterLogs](#filterlogs)
+- [HeaderByNumber](#headerbynumber)
+- [NonceAt](#nonceat)
+- [TransactionByHash](#transactionbyhash)
+- [TransactionReceipt](#transactionreceipt)
+
+### Sending transactions
+
+#### EstimateGas
+
+EstimateGas tries to estimate the gas needed to execute a specific transaction
+based on the current pending state of the backend blockchain.
+There is no guarantee that this is the true gas limit requirement
+as other transactions may be added or removed by miners,
+but it should provide a basis for setting a reasonable default.
+
+```go
+func (ec *Client) EstimateGas(ctx context.Context, msg ethereum.CallMsg) (uint64, error)
+```
+
+[L499](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L499)
+
+#### PendingNonceAt
+
+`PendingNonceAt` returns the account nonce of the given account in the pending state.
+ This is the nonce that should be used for the next transaction.
+
+ ```go
+func (ec *Client) PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
+```
+
+[L440](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L440)
+
+#### SuggestGasPrice
+
+`SuggestGasPrice` retrieves the currently suggested gas price to allow a timely
+execution of a transaction.
+
+```go
+func (ec *Client) SuggestGasPrice(ctx context.Context) (*big.Int, error)
+```
+
+[L487](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L487)
+
+#### SendTransaction
+
+`SendTransaction` injects a signed transaction into the pending pool for execution.
+
+If the transaction was a contract creation use the TransactionReceipt method to get the
+contract address after the transaction has been mined.
+
+```go
+func (ec *Client) SendTransaction(ctx context.Context, tx *types.Transaction) error 
+```
+
+[L512](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L512)
+
+### Fetching balance
+
+A Status node fetches the current and historical [ECR20](https://eips.ethereum.org/EIPS/eip-20) and ETH balance for the user wallet address.
+Collectibles following the [ERC-721](https://eips.ethereum.org/EIPS/eip-721) are also fetched if enabled.
+
+A Status node supports by default the following [tokens](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/tokens.cljs). Custom tokens can be added by specifying the `address`, `symbol` and `decimals`.
+
+#### BlockByHash
+
+`BlockByHash` returns the given full block.
+
+It is used by status to fetch a given block which will then be inspected
+for transfers to the user address, both tokens and ETH.
+
+```go
+func (ec *Client) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
+```
+
+[L78](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L78)
+
+#### BlockByNumber
+
+`BlockByNumber` returns a block from the current canonical chain. If number is nil, the
+latest known block is returned.
+
+```go
+func (ec *Client) BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
+```
+
+[L82](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L82)
+
+#### FilterLogs
+
+`FilterLogs` executes a filter query.
+
+Status uses this function to filter out logs, using the hash of the block
+and the address of interest, both inbound and outbound.
+
+```go
+func (ec *Client) FilterLogs(ctx context.Context, q ethereum.FilterQuery) ([]types.Log, error) 
+```
+
+[L377](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L377)
+
+#### NonceAt
+
+`NonceAt` returns the account nonce of the given account.
+
+```go
+func (ec *Client) NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
+```
+
+[L366](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L366)
+
+#### TransactionByHash
+
+`TransactionByHash` returns the transaction with the given hash,
+used to inspect those transactions made/received by the user.
+
+```go
+func (ec *Client) TransactionByHash(ctx context.Context, hash common.Hash) (tx *types.Transaction, isPending bool, err error)
+```
+
+[L202](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L202)
+
+#### HeaderByNumber
+
+`HeaderByNumber` returns a block header from the current canonical chain.
+
+```go
+func (ec *Client) HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error) 
+```
+
+[L172](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L172)
+
+#### TransactionReceipt
+
+`TransactionReceipt` returns the receipt of a transaction by transaction hash.
+It is used in status to check if a token transfer was made to the user address.
+
+```go
+func (ec *Client) TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
+```
+
+[L270](https://github.com/ethereum/go-ethereum/blob/26d271dfbba1367326dec38068f9df828d462c61/ethclient/ethclient.go#L270)
+
+## ENS
+
+All the interactions with `ENS` are made through the [ENS contract](https://github.com/ensdomains/ens)
+
+For the `stateofus.eth` username, one can be registered through these [contracts](https://github.com/status-im/ens-usernames)
+
+### Registering, releasing and updating
+
+- [Registering a username](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L113)
+- [Releasing a username](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L131)
+- [Updating a username](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L174)
+
+### Slashing
+
+Usernames MUST be in a specific format, otherwise they MAY be slashed:
+
+- They MUST only contain alphanumeric characters
+- They MUST NOT  be in the form `0x[0-9a-f]{5}.*` and have more than 12 characters
+- They MUST NOT be in the [reserved list](https://github.com/status-im/ens-usernames/blob/47c4c6c2058be0d80b7d678e611e166659414a3b/config/ens-usernames/reservedNames.js)
+- They MUST NOT be too short, this is dynamically set in the contract and can be checked against the [contract](https://github.com/status-im/ens-usernames/blob/master/contracts/registry/UsernameRegistrar.sol#L26)
+
+- [Slash a reserved username](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L237)
+- [Slash an invalid username](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L261)
+- [Slash a username too similar to an address](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L215)
+- [Slash a username that is too short](https://github.com/status-im/ens-usernames/blob/77d9394d21a5b6213902473b7a16d62a41d9cd09/contracts/registry/UsernameRegistrar.sol#L200)
+
+ENS names are propagated through `ChatMessage` and `ContactUpdate` [payload](/status/deprecated/payloads.md).
+A client SHOULD verify ens names against the public key of the sender on receiving the message against the [ENS contract](https://github.com/ensdomains/ens)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [Ethereum Developers](https://ethereum.org/developers/)
+- [JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC)
+- [Infura](https://infura.io/)
+- [Key Handling](/status/deprecated/account.md)
+- [ERC-20 Token Standard](https://eips.ethereum.org/EIPS/eip-20)
+- [ERC-721 Non-Fungible Token Standard](https://eips.ethereum.org/EIPS/eip-721)
+- [Supported Tokens Source Code](https://github.com/status-im/status-mobile/blob/develop/src/status_im/ethereum/tokens.cljs)
+- [go-ethereum](https://github.com/ethereum/go-ethereum/)
+- [ENS Contract](https://github.com/ensdomains/ens)

status/deprecated/group-chat.md

@@ -0,0 +1,162 @@
+---
+title: GROUP-CHAT
+name: Group Chat
+status: deprecated
+description: This document describes the group chat protocol used by the Status application.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Andrea Piana <andreap@status.im>
+---
+
+## Abstract
+
+This document describes the group chat protocol used by the Status application.
+The node uses pairwise encryption among members so a message is exchanged  
+between each participant, similarly to a one-to-one message.
+
+## Membership updates
+
+The node uses membership updates messages to propagate group chat membership changes.
+The protobuf format is described in the [PAYLOADS](/status/deprecated/payloads.md).
+Below describes each specific field.
+
+The protobuf messages are:
+
+```protobuf
+// MembershipUpdateMessage is a message used to propagate information
+// about group membership changes.
+message MembershipUpdateMessage {
+  // The chat id of the private group chat
+  string chat_id = 1;
+  // A list of events for this group chat, first 65 bytes are the signature, then is a 
+  // protobuf encoded MembershipUpdateEvent
+  repeated bytes events = 2;
+  // An optional chat message
+  ChatMessage message = 3;
+}
+
+message MembershipUpdateEvent {
+  // Lamport timestamp of the event as described in [Status Payload Specs](status-payload-specs.md#clock-vs-timestamp-and-message-ordering)
+  uint64 clock = 1;
+  // List of public keys of the targets of the action
+  repeated string members = 2;
+  // Name of the chat for the CHAT_CREATED/NAME_CHANGED event types
+  string name = 3;
+  // The type of the event
+  EventType type = 4;
+
+  enum EventType {
+    UNKNOWN = 0;
+    CHAT_CREATED = 1; // See [CHAT_CREATED](#chat-created)
+    NAME_CHANGED = 2; // See [NAME_CHANGED](#name-changed)
+    MEMBERS_ADDED = 3; // See [MEMBERS_ADDED](#members-added)
+    MEMBER_JOINED = 4; // See [MEMBER_JOINED](#member-joined)
+    MEMBER_REMOVED = 5; // See [MEMBER_REMOVED](#member-removed)
+    ADMINS_ADDED = 6; // See [ADMINS_ADDED](#admins-added)
+    ADMIN_REMOVED = 7; // See [ADMIN_REMOVED](#admin-removed)
+  }
+}
+```
+
+### Payload
+
+`MembershipUpdateMessage`:
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | chat-id | `string` | The chat id of the chat where the change is to take place |
+| 2 | events | See details | A list of events that describe the membership changes, in their encoded protobuf form |
+| 3 | message | `ChatMessage` | An optional message, described in [Message](/status/deprecated/payloads.md/#message) |
+
+`MembershipUpdateEvent`:
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | clock | `uint64` | The clock value of the event |
+| 2 | members | `[]string` | An optional list of hex encoded (prefixed with `0x`) public keys, the targets of the action |
+| 3 | name | `name` | An optional name, for those events that make use of it |
+| 4 | type | `EventType` | The type of event sent, described below |
+
+### Chat ID
+
+Each membership update MUST be sent with a corresponding `chatId`.
+The format of this chat ID MUST be a string of [UUID](https://tools.ietf.org/html/rfc4122),
+concatenated with the hex-encoded public key of the creator of the chat, joined by `-`.
+This chatId MUST be validated by all clients, and MUST be discarded if it does not follow these rules.
+
+### Signature
+
+The node calculates the signature for each event by encoding each `MembershipUpdateEvent` in its protobuf representation
+and prepending the bytes of the chatID, lastly the node signs the `Keccak256` of the bytes
+using the private key by the author and added to the `events` field of MembershipUpdateMessage.
+
+### Group membership event
+
+Any `group membership` event received MUST be verified by calculating the signature as per the method described above.
+The author MUST be extracted from it, if the verification fails the event MUST be discarded.
+
+#### CHAT_CREATED
+
+Chat `created event` is the first event that needs to be sent.
+Any event with a clock value lower than this MUST be discarded.
+Upon receiving this event a client MUST validate the `chatId`
+provided with the updates and create a chat with identified by `chatId` and named `name`.
+
+#### NAME_CHANGED
+
+`admins` use a `name changed` event to change the name of the group chat.
+Upon receiving this event a client MUST validate the `chatId` provided with the updates
+and MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored.
+If the event is valid the chat name SHOULD be changed to `name`.
+
+#### MEMBERS_ADDED
+
+`admins` use a `members added` event to add members to the chat.
+Upon receiving this event a client MUST validate the `chatId`
+provided with the updates and MUST ensure the author of the event is an admin of the chat, otherwise the event MUST be ignored.
+If the event is valid a client MUST update the list of members of the chat who have not joined, adding the `members` received.
+`members` is an array of hex encoded public keys.
+
+#### MEMBER_JOINED
+
+`members` use a `members joined` event to signal that they want to start receiving messages from this chat.
+Upon receiving this event a client MUST validate the `chatId` provided with the updates.
+If the event is valid a client MUST update the list of members of the chat who joined, adding the signer.
+Any `message` sent to the group chat should now include the newly joined member.
+
+#### ADMINS_ADDED
+
+`admins` use an `admins added` event to add make other admins in the chat.
+Upon receiving this event a client MUST validate the `chatId` provided with the updates,
+MUST ensure the author of the event is an admin of the chat
+and MUST ensure all `members` are already `members` of the chat, otherwise the event MUST be ignored.
+If the event is valid a client MUST update the list of admins of the chat, adding the `members` received.
+`members` is an array of hex encoded public keys.
+
+#### MEMBER_REMOVED
+
+`members` and/or `admins` use a `member-removed` event to leave or kick members of the chat.
+Upon receiving this event a client MUST validate the `chatId` provided with the updates, MUST ensure that:
+
+- If the author of the event is an admin, target can only be themselves or a non-admin member.
+- If the author of the event is not an admin, the target of the event can only be themselves.
+
+If the event is valid a client MUST remove the member from the list of `members`/`admins` of the chat,
+and no further message should be sent to them.
+
+#### ADMIN_REMOVED
+
+`Admins` use an `admin-removed` event to drop admin privileges.
+Upon receiving this event a client MUST validate the `chatId` provided with the updates,
+MUST ensure that the author of the event is also the target of the event.
+
+If the event is valid a client MUST remove the member from the list of `admins` of the chat.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [PAYLOADS](/status/deprecated/payloads.md)
+- [UUID](https://tools.ietf.org/html/rfc4122)

status/deprecated/keycard-usage-for-wallet-and-chat-keys.md

@@ -0,0 +1,303 @@
+---
+title: Keycard Usage for Wallet and Chat Keys
+name: Keycard Usage for Wallet and Chat Keys
+status: deprecated
+description: In this specification, we describe how Status communicates with Keycard to create, store and use multiaccount.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+   - Roman Volosovskyi <roman@status.im>
+---
+
+## Abstract
+
+In this specification, we describe how Status communicates with Keycard to create, store and use multiaccount.
+
+## Definitions
+
+| Term               | Description                                              |
+| ------------------ | -------------------------------------------------------- |
+| Keycard Hardwallet | [https://keycard.tech/docs/](https://keycard.tech/docs/) |
+|                    |                          |
+
+## Multiaccount creation/restoring
+
+### Creation and restoring via mnemonic
+
+1. `status-im.hardwallet.card/get-application-info`
+    request: `nil`
+    response: `{"initialized?" false}`
+2. `status-im.hardwallet.card/init-card`
+   request: `{:pin 123123}`
+   response:
+
+   ```clojure
+   {"password" "nEJXqf6VWbqeC5oN", 
+    "puk" "411810112887", 
+    "pin" "123123"}
+   ```
+
+3. `status-im.hardwallet.card/get-application-info`
+    request: `nil`
+    response:
+
+    ```clojure
+    {"free-pairing-slots" 5, 
+     "app-version" "2.2", 
+     "secure-channel-pub-key" "04e70d7af7d91b8cd23adbefdfc242c096adee6c1b5ad27a4013a8f926864c1a4f816b338238dc4a04226ab42f23672585c6dca03627885530643f1656ee69b025", 
+     "key-uid" "", 
+     "instance-uid" "9f149d438988a7af5e1a186f650c9328", 
+     "paired?" false, 
+     "has-master-key?" false, 
+     "initialized?" true}
+    ```
+
+4. `status-im.hardwallet.card/pair`
+   params: `{:password "nEJXqf6VWbqeC5oN"}`
+   response: `AAVefVX0kPGsxnvQV5OXRbRTLGI3k8/S27rpsq/lZrVR` (`pairing`)
+
+5. `status-im.hardwallet.card/generate-and-load-keys`
+
+ ```clojure
+    {:mnemonic "lift mansion moment version card type uncle sunny lock gather nerve math", 
+     :pairing "AAVefVX0kPGsxnvQV5OXRbRTLGI3k8/S27rpsq/lZrVR", 
+     :pin "123123"}
+    ```
+    response:
+    ```clojure
+    {"whisper-address" "1f29a1a60c8a12f80c397a91c6ae0323f420e609", 
+     "whisper-private-key" "123123123123123", 
+     "wallet-root-public-key" "04eb9d01990a106a65a6dfaa48300f72aecfeabe502d9f4f7aeaccb146dc2f16e2dec81dcec0a1a52c1df4450f441a48c210e1a73777c0161030378df22e4ae015", 
+     "encryption-public-key" "045ee42f012d72be74b31a28ce320df617e0cd5b9b343fad34fcd61e2f5dfa89ab23d880473ba4e95401a191764c7f872b7af92ea0d8c39462147df6f3f05c2a11", 
+     "wallet-root-address" "132dd67ff47cc1c376879c474fd2afd0f1eee6de", 
+     "whisper-public-key" "0450ad84bb95f32c64f4e5027cc11d1b363a0566a0cfc475c5653e8af9964c5c9b0661129b75e6e1bc6e96ba2443238e53e7f49f2c5f2d16fcf04aca4826765d46", 
+     "address" "bf93eb43fea2ce94bf3a6463c16680b56aa4a08a", 
+     "wallet-address" "7eee1060d8e4722d36c99f30ff8291caa3cfc40c", 
+     "key-uid" "472d8436ccedb64bcbd897bed5895ec3458b306352e1bcee377df87db32ef2c2", 
+     "wallet-public-key" "0495ab02978ea1f8b059140e0be5a87aad9b64bb7d9706735c47dda6e182fd5ca41744ca37583b9a10c316b01d4321d6c85760c61301874089acab041037246294", 
+     "public-key" "0465d452d12171711f32bb931f9ea26fe1b88fe2511a7909a042b914fde10a99719136365d506e2d1694fc14627f9d557da33865efc6001da3942fc1d4d2469ca1", 
+     "instance-uid" "9f149d438988a7af5e1a186f650c9328"}
+    ```
+
+### Multiaccount restoring via pairing
+This flow is required in case if a user want to pair a card with an existing multiaccount on it.
+1. `status-im.hardwallet.card/get-application-info` 
+    request: `nil`
+    response: 
+
+    ```clojure
+    {"free-pairing-slots" 4, 
+     "app-version" "2.2", 
+     "secure-channel-pub-key" "04e70d7af7d91b8cd23adbefdfc242c096adee6c1b5ad27a4013a8f926864c1a4f816b338238dc4a04226ab42f23672585c6dca03627885530643f1656ee69b025", 
+     "key-uid" "", 
+     "instance-uid" "9f149d438988a7af5e1a186f650c9328", 
+     "paired?" false, 
+     "has-master-key?" false, 
+     "initialized?" true}
+    ```
+2. `status-im.hardwallet.card/pair` 
+   params: `{:password "nEJXqf6VWbqeC5oN"}`
+   response: `AAVefVX0kPGsxnvQV5OXRbRTLGI3k8/S27rpsq/lZrVR` (`pairing`)
+   
+3. `status-im.hardwallet.card/generate-and-load-keys` 
+    ```clojure
+    {:mnemonic "lift mansion moment version card type uncle sunny lock gather nerve math", 
+     :pairing "AAVefVX0kPGsxnvQV5OXRbRTLGI3k8/S27rpsq/lZrVR", 
+     :pin "123123"}
+    ```
+    response:
+    ```clojure
+    {"whisper-address" "1f29a1a60c8a12f80c397a91c6ae0323f420e609", 
+     "whisper-private-key" "123123123123123123123", 
+     "wallet-root-public-key" "04eb9d01990a106a65a6dfaa48300f72aecfeabe502d9f4f7aeaccb146dc2f16e2dec81dcec0a1a52c1df4450f441a48c210e1a73777c0161030378df22e4ae015", 
+     "encryption-public-key" "045ee42f012d72be74b31a28ce320df617e0cd5b9b343fad34fcd61e2f5dfa89ab23d880473ba4e95401a191764c7f872b7af92ea0d8c39462147df6f3f05c2a11", 
+     "wallet-root-address" "132dd67ff47cc1c376879c474fd2afd0f1eee6de", 
+     "whisper-public-key" "0450ad84bb95f32c64f4e5027cc11d1b363a0566a0cfc475c5653e8af9964c5c9b0661129b75e6e1bc6e96ba2443238e53e7f49f2c5f2d16fcf04aca4826765d46", 
+     "address" "bf93eb43fea2ce94bf3a6463c16680b56aa4a08a", 
+     "wallet-address" "7eee1060d8e4722d36c99f30ff8291caa3cfc40c", 
+     "key-uid" "472d8436ccedb64bcbd897bed5895ec3458b306352e1bcee377df87db32ef2c2", 
+     "wallet-public-key" "0495ab02978ea1f8b059140e0be5a87aad9b64bb7d9706735c47dda6e182fd5ca41744ca37583b9a10c316b01d4321d6c85760c61301874089acab041037246294", 
+     "public-key" "0465d452d12171711f32bb931f9ea26fe1b88fe2511a7909a042b914fde10a99719136365d506e2d1694fc14627f9d557da33865efc6001da3942fc1d4d2469ca1", 
+     "instance-uid" "9f149d438988a7af5e1a186f650c9328"}
+   ```
+
+## Multiaccount unlocking
+
+1. `status-im.hardwallet.card/get-application-info`
+    params:
+
+    ```clojure
+    {:pairing nil, :on-success nil}
+    ```
+
+    response:
+
+    ```clojure
+    {"free-pairing-slots" 4, 
+     "app-version" "2.2", 
+     "secure-channel-pub-key" "04b079ac513d5e0ebbe9becbae1618503419f5cb59edddc7d7bb09ce0db069a8e6dec1fb40c6b8e5454f7e1fcd0bb4a0b9750256afb4e4390e169109f3ea3ba91d", 
+     "key-uid" "a5424fb033f5cc66dce9cbbe464426b6feff70ca40aa952c56247aaeaf4764a9", 
+     "instance-uid" "2268254e3ed7898839abe0b40e1b4200", 
+     "paired?" false, 
+     "has-master-key?" true, 
+     "initialized?" true}
+   ```
+
+2. `status-im.hardwallet.card/get-keys`
+    params:
+
+    ```clojure
+    {:pairing "ACEWbvUlordYWOE6M1Narn/AXICRltjyuKIAn4kkPXQG",
+     :pin "123123"}
+    ```
+
+    response:
+
+    ```clojure
+    {"whisper-address" "ec83f7354ca112203d2ce3e0b77b47e6e33258aa", 
+     "whisper-private-key" "123123123123123123123123",
+     "wallet-root-public-key" "0424a93fe62a271ad230eb2957bf221b4644670589f5c0d69bd11f3371034674bf7875495816095006c2c0d5f834d628b87691a8bbe3bcc2225269020febd65a19", 
+     "encryption-public-key" "0437eef85e669f800570f444e64baa2d0580e61cf60c0e9236b4108455ec1943f385043f759fcb5bd8348e32d6d6550a844cf24e57f68e9397a0f7c824a8caee2d", 
+     "wallet-root-address" "6ff915f9f31f365511b1b8c1e40ce7f266caa5ce", 
+     "whisper-public-key" "04b195df4336c596cca1b89555dc55dd6bb4c5c4491f352f6fdfae140a2349213423042023410f73a862aa188f6faa05c80b0344a1e39c253756cb30d8753f9f8324", 
+     "address" "73509a1bb5f3b74d0dba143705cd9b4b55b8bba1", 
+     "wallet-address" "2f0cc0e0859e7a05f319d902624649c7e0f48955", 
+     "key-uid" "a5424fb033f5cc66dce9cbbe464426b6feff70ca40aa952c56247aaeaf4764a9", 
+     "wallet-public-key" "04d6fab73772933215872c239787b2281f3b10907d099d04b88c861e713bd2b95883e0b1710a266830da29e76bbf6b87ed034ab139e36cc235a1b2a5b5ddfd4e91", 
+     "public-key" "0437eef85e669f800570f444e64baa2d0580e61cf60c0e9236b4108455ec1943f385043f759fcb5bd8348e32d6d6550a844cf24e57f68e9397a0f7c824a8caee2d", 
+     "instance-uid" "2268254e3ed7898839abe0b40e1b4200"}
+    ```
+
+3. `status-im.hardwallet.card/get-application-info`
+    params:
+
+    ```clojure
+    {:pairing "ACEWbvUlordYWOE6M1Narn/AXICRltjyuKIAn4kkPXQG"}
+    ```
+
+    response:
+
+    ```clojure
+    {"paired?" true, 
+     "has-master-key?" true, 
+     "app-version" "2.2", 
+     "free-pairing-slots" 4, 
+     "pin-retry-counter" 3, 
+     "puk-retry-counter" 5, 
+     "initialized?" true, 
+     "secure-channel-pub-key" "04b079ac513d5e0ebbe9becbae1618503419f5cb59edddc7d7bb09ce0db069a8e6dec1fb40c6b8e5454f7e1fcd0bb4a0b9750256afb4e4390e169109f3ea3ba91d", 
+     "key-uid" "a5424fb033f5cc66dce9cbbe464426b6feff70ca40aa952c56247aaeaf4764a9", 
+     "instance-uid" "2268254e3ed7898839abe0b40e1b4200"}
+    ```
+
+## Transaction signing
+
+1. `status-im.hardwallet.card/get-application-info`
+
+   params:
+
+   ```clojure
+   {:pairing "ALecvegKyOW4szknl01yYWx60GLDK5gDhxMgJECRZ+7h", 
+    :on-success :hardwallet/sign}
+   ```
+
+   response:
+
+   ```clojure
+    {"paired?" true, 
+     "has-master-key?" true, 
+     "app-version" "2.2", 
+     "free-pairing-slots" 4, 
+     "pin-retry-counter" 3, 
+     "puk-retry-counter" 5, 
+     "initialized?" true, 
+     "secure-channel-pub-key" "0476d11f2ccdad4e7779b95a1ce063d7280cb6c09afe2c0e48ca0c64ab9cf2b3c901d12029d6c266bfbe227c73a802561302b2330ac07a3270fc638ad258fced4a", 
+     "key-uid" "d5c8cde8085e7a3fcf95aafbcbd7b3cfe32f61b85c2a8f662f60e76bdc100718", 
+     "instance-uid" "e20e27bfee115b431e6e81b8e9dcf04c"}
+    ```
+
+2. `status-im.hardwallet.card/sign`
+   params:
+
+   ```clojure
+   {:hash "92fc7ef54c3e0c42de256b93fbf2c49dc6948ee089406e204dec943b7a0142a9", 
+    :pairing "ALecvegKyOW4szknl01yYWx60GLDK5gDhxMgJECRZ+7h", 
+    :pin "123123", 
+    :path "m/44'/60'/0'/0/0"}
+   ```
+
+   response: `5d2ca075593cf50aa34007a0a1df7df14a369534450fce4a2ae8d023a9d9c0e216b5e5e3f64f81bee91613318d01601573fdb15c11887a3b8371e3291e894de600`
+
+## Account derivation
+
+1. `status-im.hardwallet.card/verify-pin`
+    params:
+
+    ```clojure
+    {:pin "123123", 
+     :pairing "ALecvegKyOW4szknl01yYWx60GLDK5gDhxMgJECRZ+7h"}
+    ```
+
+    response: `3`
+1. `status-im.hardwallet.card/export-key`
+    params:
+
+    ```clojure
+    {:pin "123123", 
+     :pairing "ALecvegKyOW4szknl01yYWx60GLDK5gDhxMgJECRZ+7h", 
+     :path "m/44'/60'/0'/0/1"}
+    ```
+
+    response: `046d1bcd2310a5e0094bc515b0ec995a8cb59e23d564094443af10011b6c00bdde44d160cdd32b4b6341ddd7dc83a4f31fdf60ec2276455649ccd7a22fa4ea01d8` (account's `public-key`)
+
+## Reset pin
+
+1. `status-im.hardwallet.card/change-pin`
+    params:
+
+   ```clojure
+   {:new-pin "111111", 
+    :current-pin "222222", 
+    :pairing "AA0sKxPkN+jMHXZZeI8Rgz04AaY5Fg0CzVbm9189Khob"}
+   ```
+
+   response:
+   `true`
+
+## Unblock pin
+
+If user enters a wrong pin three times in a row a card gets blocked. The user can use puk code then to unblock the card and set a new pin.
+
+1. `status-im.hardwallet.card/unblock-pin`
+   params:
+
+   ```clojure
+   {:puk "120702722103", 
+    :new-pin "111111", 
+    :pairing "AIoQl0OtCL0/uSN7Ct1/FHRMEk/eM2Lrhn0bw7f8sgOe"}
+   ```
+
+   response
+   `true`
+
+## Status go calls
+
+In order to use the card in the app we need to use some parts of status-go API, specifically:
+
+1. [`SaveAccountAndLoginWithKeycard`](https://github.com/status-im/status-go/blob/b33ad8147d23a932064f241e575511d70a601dcc/mobile/status.go#L337) after multiaccount creation/restoring to store multiaccount and login into it
+2. [`LoginWithKeycard`](https://github.com/status-im/status-go/blob/b33ad8147d23a932064f241e575511d70a601dcc/mobile/status.go#L373) to log into already existing account
+3. [`HashTransaction`](https://github.com/status-im/status-go/blob/b33ad8147d23a932064f241e575511d70a601dcc/mobile/status.go#L492) and [`HashMessage`](https://github.com/status-im/status-go/blob/b33ad8147d23a932064f241e575511d70a601dcc/mobile/status.go#L520) for hashing transaction/message before signing
+4. [`SendTransactionWithSignature`](https://github.com/status-im/status-go/blob/b33ad8147d23a932064f241e575511d70a601dcc/mobile/status.go#L471) to send transaction
+
+## Where are the keys stored?
+
+1. When we create a regular multiaccount all its keys are stored on device and are encrypted via key which is derived from user's password. In case if account was created using keycard all keys are stored on the card and are retrieved from it during signing into multiaccount.
+2. When we create a regular multiaccount we also create a separate database for it and this database is encrypted using key which is derived from user's password. For a keycard account we use `encryption-public-key` (returned by `status-im.hardwallet.card/get-keys`/`status-im.hardwallet.card/generate-and-load-keys`) as a password.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [Keycard Hardwallet Documentation](https://keycard.tech/docs/)
+- [Keycard Codebase](https://github.com/status-im/status-go/blob/b33ad8147d23a932064f241e575511d70a601dcc/mobile/status.go)

status/deprecated/notifications.md

@@ -0,0 +1,52 @@
+---
+title: NOTIFICATIONS
+name: Notifications
+status: deprecated
+description: A client should implement local notifications to offer notifications for any event in the app without the privacy cost and dependency on third party services.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Eric Dvorsak <eric@status.im>
+---
+
+## Local Notifications
+
+A client should implement local notifications to offer notifications
+for any event in the app without the privacy cost and dependency on third party services.
+This means that the client should run a background service to continuously or periodically check for updates.
+
+### Android
+
+Android allows running services on the device. When the user enables notifications,
+the client may start a ``Foreground Service`,
+and display a permanent notification indicating that the service is running,
+as required by Android guidelines.
+The service will simply keep the app from being killed by the system when it is in the background.
+The client will then be able to run in the background
+and display local notifications on events such as receiving a message in a one to one chat.
+
+To facilitate the implementation of local notifications,
+a node implementation such as `status-go` may provide a specific `notification` signal.
+
+Notifications are a separate process in Android, and interaction with a notification generates an `Intent`.
+To handle intents, the `NewMessageSignalHandler` may use a `BroadcastReceiver`,
+in order to update the state of local notifications when the user dismisses or tap a notification.
+If the user taps on a notification, the `BroadcastReceiver` generates a new intent to open the app should use universal links to get the user to the right place.
+
+### iOS
+
+We are not able to offer local notifications on iOS because there is no concept of services in iOS.
+It offers background updates but they’re not consistently triggered, and cannot be relied upon.
+The system decides when the background updates are triggered and the heuristics aren't known.
+
+## Why is there no Push Notifications?
+
+Push Notifications, as offered by Apple and Google are a privacy concern,
+they require a centralized service that is aware of who the notification needs to be delivered to.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- None

status/deprecated/payloads.md

@@ -0,0 +1,386 @@
+---
+title: PAYLOADS
+name: Payloads
+status: deprecated
+description: Payload of messages in Status, regarding chat and chat-related use cases.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+- Adam Babik <adam@status.im>
+- Andrea Maria Piana <andreap@status.im>
+- Oskar Thorén <oskar@status.im>
+---
+
+## Abstract
+
+This specification describes how the payload of each message in Status looks like.
+It is primarily centered around chat and chat-related use cases.
+
+The payloads aims to be flexible enough to support messaging but also cases
+described in the [Status Whitepaper](https://status.im/whitepaper.pdf)
+as well as various clients created using different technologies.
+
+## Introduction
+
+This document describes the payload format and some special considerations.
+
+## Payload wrapper
+
+The node wraps all payloads in a [protobuf record](https://developers.google.com/protocol-buffers/):
+
+```protobuf
+message ApplicationMetadataMessage {
+  bytes signature = 1;
+  bytes payload = 2;
+
+  Type type = 3;
+
+  enum Type {
+    UNKNOWN = 0;
+    CHAT_MESSAGE = 1;
+    CONTACT_UPDATE = 2;
+    MEMBERSHIP_UPDATE_MESSAGE = 3;
+    PAIR_INSTALLATION = 4;
+    SYNC_INSTALLATION = 5;
+    REQUEST_ADDRESS_FOR_TRANSACTION = 6;
+    ACCEPT_REQUEST_ADDRESS_FOR_TRANSACTION = 7;
+    DECLINE_REQUEST_ADDRESS_FOR_TRANSACTION = 8;
+    REQUEST_TRANSACTION = 9;
+    SEND_TRANSACTION = 10;
+    DECLINE_REQUEST_TRANSACTION = 11;
+    SYNC_INSTALLATION_CONTACT = 12;
+    SYNC_INSTALLATION_ACCOUNT = 13;
+    SYNC_INSTALLATION_PUBLIC_CHAT = 14;
+    CONTACT_CODE_ADVERTISEMENT = 15;
+    PUSH_NOTIFICATION_REGISTRATION = 16;
+    PUSH_NOTIFICATION_REGISTRATION_RESPONSE = 17;
+    PUSH_NOTIFICATION_QUERY = 18;
+    PUSH_NOTIFICATION_QUERY_RESPONSE = 19;
+    PUSH_NOTIFICATION_REQUEST = 20;
+    PUSH_NOTIFICATION_RESPONSE = 21;
+  }
+}
+```
+
+`signature` is the bytes of the signed `SHA3-256` of the payload,
+signed with the key of the author of the message.
+The node needs the signature to validate authorship of the message,
+so that the message can be relayed to third parties.
+If a signature is not present, but an author is provided by a layer below,
+the message is not to be relayed to third parties, and it is considered plausibly deniable.
+
+`payload` is the protobuf encoded content of the message, with the corresponding `type` set.
+
+## Encoding
+
+The node encodes the payload using [Protobuf](https://developers.google.com/protocol-buffers)
+
+## Types of messages
+
+### Message
+
+The type `ChatMessage` represents a chat message exchanged between clients.
+
+#### Payload
+
+The protobuf description is:
+
+```protobuf
+message ChatMessage {
+  // Lamport timestamp of the chat message
+  uint64 clock = 1;
+  // Unix timestamps in milliseconds, currently not used as we use Whisper/Waku as more reliable, but here
+  // so that we don't rely on it
+  uint64 timestamp = 2;
+  // Text of the message
+  string text = 3;
+  // Id of the message that we are replying to
+  string response_to = 4;
+  // Ens name of the sender
+  string ens_name = 5;
+  // Chat id, this field is symmetric for public-chats and private group chats,
+  // but asymmetric in case of one-to-ones, as the sender will use the chat-id
+  // of the received, while the receiver will use the chat-id of the sender.
+  // Probably should be the concatenation of sender-pk & receiver-pk in alphabetical order
+  string chat_id = 6;
+
+  // The type of message (public/one-to-one/private-group-chat)
+  MessageType message_type = 7;
+  // The type of the content of the message
+  ContentType content_type = 8;
+
+  oneof payload {
+    StickerMessage sticker = 9;
+  }
+
+  enum MessageType {
+    UNKNOWN_MESSAGE_TYPE = 0;
+    ONE_TO_ONE = 1;
+    PUBLIC_GROUP = 2;
+    PRIVATE_GROUP = 3;
+    // Only local
+    SYSTEM_MESSAGE_PRIVATE_GROUP = 4;}
+  enum ContentType {
+    UNKNOWN_CONTENT_TYPE = 0;
+    TEXT_PLAIN = 1;
+    STICKER = 2;
+    STATUS = 3;
+    EMOJI = 4;
+    TRANSACTION_COMMAND = 5;
+    // Only local
+    SYSTEM_MESSAGE_CONTENT_PRIVATE_GROUP = 6;
+  }
+}
+```
+
+Payload
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | clock | `uint64` | The clock of the chat|
+| 2 | timestamp | `uint64` | The sender timestamp at message creation |
+| 3 | text | `string` | The content of the message |
+| 4 | response_to | `string` | The ID of the message replied to |
+| 5 | ens_name | `string` | The ENS name of the user sending the message |
+| 6 | chat_id | `string` | The local ID of the chat the message is sent to |
+| 7 | message_type | `MessageType` | The type of message, different for one-to-one, public or group chats |
+| 8 | content_type | `ContentType` | The type of the content of the message |
+| 9 | payload | `Sticker\|nil` | The payload of the message based on the content type |
+
+#### Content types
+
+A node requires content types for a proper interpretation of incoming messages. Not each message is plain text but may carry different information.
+
+The following content types MUST be supported:
+
+* `TEXT_PLAIN` identifies a message which content is a plaintext.
+
+There are other content types that MAY be implemented by the client:
+
+* `STICKER`
+* `STATUS`
+* `EMOJI`
+* `TRANSACTION_COMMAND`
+
+##### Mentions
+
+A mention MUST be represented as a string with the `@0xpk` format, where `pk` is the public key of the [user account](/status/deprecated/account.md) to be mentioned,
+within the `text` field of a message with content_type `TEXT_PLAIN`.
+A message MAY contain more than one mention.
+This specification RECOMMENDs that the application does not require the user to enter the entire pk.
+This specification RECOMMENDs that the application allows the user to create a mention
+by typing @ followed by the related ENS or 3-word pseudonym.
+This specification RECOMMENDs that the application provides the user auto-completion functionality to create a mention.
+For better user experience, the client SHOULD display a known [ens name or the 3-word pseudonym corresponding to the key](/status/deprecated/account.md#contact-verification) instead of the `pk`.
+
+##### Sticker content type
+
+A `ChatMessage` with `STICKER` `Content/Type` MUST also specify the ID of the `Pack` and
+the `Hash` of the pack, in the `Sticker` field of `ChatMessage`
+
+```protobuf
+message StickerMessage {
+  string hash = 1;
+  int32 pack = 2;
+}
+```
+
+#### Message types
+
+A node requires message types to decide how to encrypt a particular message
+and what metadata needs to be attached when passing a message to the transport layer.
+For more on this, see [WHISPER-USAGE](/status/deprecated/whisper-usage.md)
+and [WAKU-USAGE](/status/deprecated/waku-usage.md).
+
+<!-- TODO: This reference is a bit odd, considering the layer payloads should interact with is Secure Transport, and not Whisper/Waku. This requires more detail -->
+
+The following messages types MUST be supported:
+
+* `ONE_TO_ONE` is a message to the public group
+* `PUBLIC_GROUP` is a private message
+* `PRIVATE_GROUP` is a message to the private group.
+
+#### Clock vs Timestamp and message ordering
+
+If a user sends a new message before the messages sent
+while the user was offline are received,
+the newmessage is supposed to be displayed last in a chat.
+This is where the basic algorithm of Lamport timestamp would fall short
+as it's only meant to order causally related events.
+
+The status client therefore makes a "bid", speculating that it will beat the current chat-timestamp, s.t. the status client's
+Lamport timestamp format is: `clock = max({timestamp}, chat_clock + 1)`
+
+This will satisfy the Lamport requirement, namely: a -> b then T(a) < T(b)
+
+`timestamp` MUST be Unix time calculated, when the node creates the message, in milliseconds.
+This field SHOULD not be relied upon for message ordering.
+
+`clock` SHOULD be calculated using the algorithm of [Lamport timestamps](https://en.wikipedia.org/wiki/Lamport_timestamps).
+When there are messages available in a chat,
+the node calculates `clock`'s value based on the last received message in a particular chat: `max(timeNowInMs, last-message-clock-value + 1)`.
+If there are no messages, `clock` is initialized with `timestamp`'s value.
+
+Messages with a `clock` greater than `120` seconds over the Whisper/Waku timestamp SHOULD be discarded,
+in order to avoid malicious users to increase the `clock` of a chat arbitrarily.
+
+Messages with a `clock` less than `120` seconds under the Whisper/Waku timestamp
+might indicate an attempt to insert messages in the chat history which is not distinguishable from a `datasync` layer re-transit event.
+A client MAY mark this messages with a warning to the user, or discard them.
+
+The node uses `clock` value for the message ordering.
+The algorithm used, and the distributed nature of the system produces casual ordering, which might produce counter-intuitive results in some edge cases.
+For example, when a user joins a public chat and sends a message
+before receiving the exist messages, their message `clock` value might be lower
+and the message will end up in the past when the historical messages are fetched.
+
+#### Chats
+
+Chat is a structure that helps organize messages.
+It's usually desired to display messages only from a single recipient,
+or a group of recipients at a time and chats help to achieve that.
+
+All incoming messages can be matched against a chat.
+The below table describes how to calculate a chat ID for each message type.
+
+|Message Type|Chat ID Calculation|Direction|Comment|
+|------------|-------------------|---------|-------|
+|PUBLIC_GROUP|chat ID is equal to a public channel name; it should equal `chatId` from the message|Incoming/Outgoing||
+|ONE_TO_ONE|let `P` be a public key of the recipient; `hex-encode(P)` is a chat ID; use it as `chatId` value in the message|Outgoing||
+|user-message|let `P` be a public key of message's signature; `hex-encode(P)` is a chat ID; discard `chat-id` from message|Incoming|if there is no matched chat, it might be the first message from public key `P`; the node MAY discard the message or MAY create a new chat; Status official clients create a new chat|
+|PRIVATE_GROUP|use `chatId` from the message|Incoming/Outgoing|find an existing chat by `chatId`; if none is found, the user is not a member of that chat or the user hasn't joined that chat, the message MUST be discarded |
+
+### Contact Update
+
+`ContactUpdate` is a message exchange to notify peers that either the
+user has been added as a contact, or that information about the sending user have
+changed.
+
+```protobuf
+message ContactUpdate {
+  uint64 clock = 1;
+  string ens_name = 2;
+  string profile_image = 3;
+}
+```
+
+Payload
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | clock | `uint64` | The clock of the chat with the user |
+| 2 | ens_name | `string` | The ENS name if set |
+| 3 | profile_image | `string` | The base64 encoded profile picture of the user |
+
+#### Contact update
+
+A client SHOULD send a `ContactUpdate` to all the contacts each time:
+
+* The ens_name has changed
+* A user edits the profile image
+
+A client SHOULD also periodically send a `ContactUpdate` to all the contacts, the interval is up to the client,
+the Status official client sends these updates every 48 hours.
+
+### SyncInstallationContact
+
+The node uses `SyncInstallationContact` messages to synchronize in a best-effort the contacts to other devices.
+
+```protobuf
+message SyncInstallationContact {
+  uint64 clock = 1;
+  string id = 2;
+  string profile_image = 3;
+  string ens_name = 4;
+  uint64 last_updated = 5;
+  repeated string system_tags = 6;
+}
+```
+
+Payload
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | clock | `uint64` | clock value of the chat |
+| 2 | id | `string` | id of the contact synced |
+| 3 | profile_image | `string` |  `base64` encoded profile picture of the user |
+| 4 | ens_name | `string` | ENS name of the contact |
+| 5 | `array[string]` | Array of `system_tags` for the user, this can currently be: `":contact/added", ":contact/blocked", ":contact/request-received"`||
+
+### SyncInstallationPublicChat
+
+The node uses `SyncInstallationPublicChat` message to synchronize in a best-effort the public chats to other devices.
+
+```protobuf
+message SyncInstallationPublicChat {
+  uint64 clock = 1;
+  string id = 2;
+}
+```
+
+Payload
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | clock | `uint64` | clock value of the chat |
+| 2 | id | `string` | id of the chat synced |
+
+### PairInstallation
+
+The node uses `PairInstallation` messages to propagate information about a device to its paired devices.
+
+```protobuf
+message PairInstallation {
+  uint64 clock = 1;
+  string installation_id = 2;
+  string device_type = 3;
+  string name = 4;
+}
+```
+
+Payload
+
+| Field | Name | Type | Description |
+| ----- | ---- | ---- | ---- |
+| 1 | clock | `uint64` | clock value of the chat |
+| 2| installation_id | `string` | A randomly generated id that identifies this device |
+| 3 | device_type | `string` | The OS of the device `ios`,`android` or `desktop` |
+| 4 | name | `string` | The self-assigned name of the device |
+
+### MembershipUpdateMessage and MembershipUpdateEvent
+
+`MembershipUpdateEvent` is a message used to propagate information about group membership changes in a group chat.
+The details are in the [Group chats specs](/status/deprecated/group-chat.md).
+
+## Upgradability
+
+There are two ways to upgrade the protocol without breaking compatibility:
+
+* A node always supports accretion
+* A node does not support deletion of existing fields or messages, which might break compatibility
+
+## Security Considerations
+
+## Changelog
+
+### Version 0.3
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+* Added language to include Waku in all relevant places
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+[Status Whitepaper](https://status.im/whitepaper.pdf)  
+[protobuf record](https://developers.google.com/protocol-buffers/)  
+[Protobuf](https://developers.google.com/protocol-buffers)  
+[Status user account](/status/deprecated/account.md)  
+[ens name or the 3-word pseudonym corresponding to the key](deprecated/account/#contact-verification)  
+[WHISPER-USAGE](/status/deprecated/whisper-usage.md)  
+[WAKU-USAGE](/status/deprecated/waku-usage.md)  
+[Lamport timestamps](https://en.wikipedia.org/wiki/Lamport_timestamps)  
+[Group chats specs](/status/deprecated/group-chat.md)  
+[May 22, 2020 change commit](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)  

status/deprecated/push-notification-server.md

@@ -0,0 +1,753 @@
+---
+title: PUSH-NOTIFICATION-SERVER
+name: Push notification server
+status: deprecated
+description: Status provides a set of Push notification services that can be used to achieve this functionality.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Andrea Maria Piana <andreap@status.im>
+---
+
+## Reason
+
+Push notifications for iOS devices and some Android devices can only be implemented by relying on [APN service](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html#//apple_ref/doc/uid/TP40008194-CH8-SW1) for iOS or [Firebase](https://firebase.google.com/).
+
+This is useful for Android devices that do not support foreground services
+or that often kill the foreground service.
+
+iOS only allows certain kind of applications to keep a connection open when in the
+background, VoIP for example, which current status client does not qualify for.
+
+Applications on iOS can also request execution time when they are in the [background](https://developer.apple.com/documentation/uikit/app_and_environment/scenes/preparing_your_ui_to_run_in_the_background/updating_your_app_with_background_app_refresh)
+but it has a limited set of use cases, for example it won't schedule any time
+if the application was force quit,
+and generally is not responsive enough to implement a push notification system.
+
+Therefore Status provides a set of Push notification services
+that can be used to achieve this functionality.
+
+Because this can't be safely implemented in a privacy preserving manner,
+clients MUST be given an option to opt-in to receiving and sending push notifications.
+They are disabled by default.
+
+## Requirements
+
+The party releasing the app MUST possess a certificate for the Apple Push Notification service
+and its has to run a [gorush](https://github.com/appleboy/gorush) publicly accessible server for sending the actual notification.
+The party releasing the app, Status in this case, needs to run its own [gorush](https://github.com/appleboy/gorush)
+
+## Components
+
+### Gorush instance
+
+A [gorush](https://github.com/appleboy/gorush) instance MUST be publicly available,
+this will be used only by push notification servers.
+
+### Push notification server
+
+A push notification server used by clients to register for receiving and sending push notifications.
+
+### Registering client
+
+A Status client that wants to receive push notifications
+
+### Sending client
+
+A Status client that wants to send push notifications
+
+## Registering with the push notification service
+
+A client MAY register with one or more Push Notification services of their choice.
+
+A `PNR message` (Push Notification Registration) MUST be sent to the [partitioned topic](status/deprecated/waku-usage/#partitioned-topic)
+for the public key of the node, encrypted with this key.
+
+The message MUST be wrapped in a [`ApplicationMetadataMessage`](status/deprecated/payload/#payload-wrapper) with type set to `PUSH_NOTIFICATION_REGISTRATION`.
+
+The marshaled protobuf payload MUST also be encrypted with AES-GCM
+using the Diffie–Hellman key generated from the client and server identity.
+
+This is done in order to ensure that the extracted key from the signature will be
+considered invalid if it can't decrypt the payload.
+
+The content of the message MUST contain the following [protobuf record](https://developers.google.com/protocol-buffers/):
+
+```protobuf
+message PushNotificationRegistration {
+  enum TokenType {
+    UNKNOWN_TOKEN_TYPE = 0;
+    APN_TOKEN = 1;
+    FIREBASE_TOKEN = 2;
+  }
+  TokenType token_type = 1;
+  string device_token = 2;
+  string installation_id = 3;
+  string access_token = 4;
+  bool enabled = 5;
+  uint64 version = 6;
+  repeated bytes allowed_key_list = 7;
+  repeated bytes blocked_chat_list = 8;
+  bool unregister = 9;
+  bytes grant = 10;
+  bool allow_from_contacts_only = 11;
+  string apn_topic = 12;
+  bool block_mentions = 13;
+  repeated bytes allowed_mentions_chat_list = 14;
+}
+```
+
+A push notification server will handle the message according to the following rules:
+
+- it MUST extract the public key of the sender from the signature and verify that
+  the payload can be decrypted successfully.
+- it MUST verify that `token_type` is supported
+- it MUST verify that `device_token` is non empty
+- it MUST verify that `installation_id` is non empty
+- it MUST verify that `version` is non-zero and greater than the currently stored version for the public key and installation id of the sender, if any
+- it MUST verify that `grant` is non empty and according to the [specs](#server-grant)
+- it MUST verify that `access_token` is a valid [`uuid`](https://tools.ietf.org/html/rfc4122)
+- it MUST verify that `apn_topic` is set if `token_type` is `APN_TOKEN`
+
+If the message can't be decrypted, the message MUST be discarded.
+
+If `token_type` is not supported, a response MUST be sent with `error` set to
+`UNSUPPORTED_TOKEN_TYPE`.
+
+If `token`,`installation_id`,`device_tokens`,`version` are empty, a response MUST
+be sent with `error` set to `MALFORMED_MESSAGE`.
+
+If the `version` is equal or less than the currently stored version, a response MUST
+be sent with `error` set to `VERSION_MISMATCH`.
+
+If any other error occurs the `error` should be set to `INTERNAL_ERROR`.
+
+If the response is successful `success` MUST be set to `true` otherwise a response MUST be sent with `success` set to `false`.
+
+`request_id` should be set to the `SHAKE-256` of the encrypted payload.
+
+The response MUST be sent on the [partitioned topic](status/deprecated/waku-usage.md#partitioned-topic) of the sender
+and MUST not be encrypted using the [secure transport](status/deprecated/secure-transport) to facilitate the usage of ephemeral keys.
+
+The payload of the response is:
+
+```protobuf
+message PushNotificationRegistrationResponse {
+  bool success = 1;
+  ErrorType error = 2;
+  bytes request_id = 3;
+
+  enum ErrorType {
+    UNKNOWN_ERROR_TYPE = 0;
+    MALFORMED_MESSAGE = 1;
+    VERSION_MISMATCH = 2;
+    UNSUPPORTED_TOKEN_TYPE = 3;
+    INTERNAL_ERROR = 4;
+  }
+}
+```
+
+The message MUST be wrapped in a [`ApplicationMetadataMessage`](status/deprecated/payloads.md#payload-wrapper) with type set to `PUSH_NOTIFICATION_REGISTRATION_RESPONSE`.
+
+A client SHOULD listen for a response sent on the [partitioned topic](status/deprecated/waku-usage/#partitioned-topic)
+that the key used to register.
+
+If `success` is `true` the client has registered successfully.
+
+If `success` is `false`:
+
+- If `MALFORMED_MESSAGE` is returned, the request SHOULD NOT be retried without ensuring that it is correctly formed.
+- If `INTERNAL_ERROR` is returned, the request MAY be retried, but the client MUST backoff exponentially
+
+A client MAY register with multiple Push Notification Servers in order to increase availability.
+
+A client SHOULD make sure that all the notification services they registered with have the same information about their tokens.
+
+If no response is returned the request SHOULD be considered failed and MAY be retried with the same server or a different one, but clients MUST exponentially backoff after each trial.
+
+If the request is successful the token SHOULD be [advertised](#advertising-a-push-notification-server) as described below
+
+### Query topic
+
+On successful registration the server MUST be listening to the topic derived from:
+
+```protobuf
+   0XHexEncode(Shake256(CompressedClientPublicKey))
+```
+
+Using the topic derivation algorithm described [here](status/deprecated/waku-usage/#public-chats)
+and listen for client queries.
+
+### Server grant
+
+A push notification server needs to demonstrate to a client that it was authorized
+by the client to send them push notifications. This is done by building
+a grant which is specific to a given client-server pair.
+The grant is built as follow:
+
+```protobuf
+   Signature(Keccak256(CompressedPublicKeyOfClient . CompressedPublicKeyOfServer . AccessToken), PrivateKeyOfClient)
+```
+
+When receiving a grant the server MUST be validate that the signature matches the registering client.
+
+## Re-registering with the push notification server
+
+A client SHOULD re-register with the node if the APN or FIREBASE token changes.
+
+When re-registering a client SHOULD ensure that it has the most up-to-date
+`PushNotificationRegistration` and increment `version` if necessary.
+
+Once re-registered, a client SHOULD advertise the changes.
+
+## Changing options
+
+This is handled in exactly the same way as re-registering above.
+
+## Unregistering from push notifications
+
+To unregister a client MUST send a `PushNotificationRegistration` request as described
+above with `unregister` set to `true`, or removing
+their device information.
+
+The server MUST remove all data about this user if `unregistering` is `true`,
+apart from the `hash` of the public key and the `version` of the last options,
+in order to make sure that old messages are not processed.
+
+A client MAY unregister from a server on explicit logout if multiple chat keys
+are used on a single device.
+
+## Advertising a push notification server
+
+Each user registered with one or more push notification servers SHOULD
+advertise periodically the push notification services that they have registered with for each device they own.
+
+```protobuf
+message PushNotificationQueryInfo {
+  string access_token = 1;
+  string installation_id = 2;
+  bytes public_key = 3;
+  repeated bytes allowed_user_list = 4;
+  bytes grant = 5;
+  uint64 version = 6;
+  bytes server_public_key = 7;
+}
+
+message ContactCodeAdvertisement {
+  repeated PushNotificationQueryInfo push_notification_info = 1;
+}
+```
+
+The message MUST be wrapped in a [`ApplicationMetadataMessage`](status/deprecated/payloads/#payload-wrapper) with type set to `PUSH_NOTIFICATION_QUERY_INFO`.
+
+If no filtering is done based on public keys,
+the access token SHOULD be included in the advertisement.
+Otherwise it SHOULD be left empty.
+
+This SHOULD be advertised on the [contact code topic](/status/deprecated/waku-usage.md#contact-code-topic)
+and SHOULD be coupled with normal contact-code advertisement.
+
+Every time a user register or re-register with a push notification service, their
+contact-code SHOULD be re-advertised.
+
+Multiple servers MAY be advertised for the same `installation_id` for redundancy reasons.
+
+## Discovering a push notification server
+
+To discover a push notification service for a given user, their [contact code topic](status/deprecated/waku-usage/#contact-code-topic)
+SHOULD be listened to.
+A mailserver can be queried for the specific topic to retrieve the most up-to-date
+contact code.
+
+## Querying the push notification server
+
+If a token is not present in the latest advertisement for a user, the server
+SHOULD be queried directly.
+
+To query a server a message:
+
+```protobuf
+message PushNotificationQuery {
+  repeated bytes public_keys = 1;
+}
+```
+
+The message MUST be wrapped in a [`ApplicationMetadataMessage`](status/deprecated/payloads/#payload-wrapper) with type set to `PUSH_NOTIFICATION_QUERY`.
+
+MUST be sent to the server on the topic derived from the hashed public key of the
+key we are querying, as [described above](#query-topic).
+
+An ephemeral key SHOULD be used and SHOULD NOT be encrypted using the [secure transport](status/deprecated/secure-transport.md).
+
+If the server has information about the client a response MUST be sent:
+
+```protobuf
+message PushNotificationQueryInfo {
+  string access_token = 1;
+  string installation_id = 2;
+  bytes public_key = 3;
+  repeated bytes allowed_user_list = 4;
+  bytes grant = 5;
+  uint64 version = 6;
+  bytes server_public_key = 7;
+}
+
+message PushNotificationQueryResponse {
+  repeated PushNotificationQueryInfo info = 1;
+  bytes message_id = 2;
+  bool success = 3;
+}
+```
+
+A `PushNotificationQueryResponse` message MUST be wrapped in a [`ApplicationMetadataMessage`](status/deprecated/payloads.md#payload-wrapper) with type set to `PUSH_NOTIFICATION_QUERY_RESPONSE`.
+
+Otherwise a response MUST NOT be sent.
+
+If `allowed_key_list` is not set `access_token` MUST be set and `allowed_key_list` MUST NOT
+be set.
+
+If `allowed_key_list` is set `allowed_key_list` MUST be set and `access_token` MUST NOT be set.
+
+If `access_token` is returned, the `access_token` SHOULD be used to send push notifications.
+
+If `allowed_key_list` are returned, the client SHOULD decrypt each
+token by generating an `AES-GCM` symmetric key from the Diffie–Hellman between the
+target client and itself
+If AES decryption succeeds it will return a valid [`uuid`](https://tools.ietf.org/html/rfc4122) which is what is used for access_token.
+The token SHOULD be used to send push notifications.
+
+The response MUST be sent on the [partitioned topic](status/deprecated/waku-usage/#partitioned-topic) of the sender
+and MUST not be encrypted using the [secure transport](status/deprecated/secure-transport.md) to facilitate
+the usage of ephemeral keys.
+
+On receiving a response a client MUST verify `grant` to ensure that the server
+has been authorized to send push notification to a given client.
+
+## Sending a push notification
+
+When sending a push notification, only the `installation_id` for the devices targeted
+by the message SHOULD be used.
+
+If a message is for all the user devices, all the `installation_id` known to the client MAY be used.
+
+The number of devices MAY be capped in order to reduce resource consumption.
+
+At least 3 devices SHOULD be targeted, ordered by last activity.
+
+For any device that a token is available, or that a token is successfully queried,
+a push notification message SHOULD be sent to the corresponding push notification server.
+
+```protobuf
+message PushNotification {
+  string access_token = 1;
+  string chat_id = 2;
+  bytes public_key = 3;
+  string installation_id = 4;
+  bytes message = 5;
+  PushNotificationType type = 6;
+  enum PushNotificationType {
+    UNKNOWN_PUSH_NOTIFICATION_TYPE = 0;
+    MESSAGE = 1;
+    MENTION = 2;
+  }
+  bytes author = 7;
+}
+
+message PushNotificationRequest {
+  repeated PushNotification requests = 1;
+  bytes message_id = 2;
+}
+```
+
+A `PushNotificationRequest` message MUST be wrapped in a [`ApplicationMetadataMessage`](/status/deprecated/payloads.md#payload-wrapper) with type set to `PUSH_NOTIFICATION_REQUEST`.
+
+Where `message` is the encrypted payload of the message and `chat_id` is the
+`SHAKE-256` of the `chat_id`.
+`message_id` is the id of the message
+`author` is the `SHAKE-256` of the public key of the sender.
+
+If multiple server are available for a given push notification, only one notification
+MUST be sent.
+
+If no response is received
+a client SHOULD wait at least 3 seconds, after which the request MAY be retried against a different server
+
+This message SHOULD be sent using an ephemeral key.
+
+On receiving the message, the push notification server MUST validate the access token.
+If the access token is valid, a notification MUST be sent to the gorush instance with the
+following data:
+
+```protobuf
+{
+  "notifications": [
+    {
+      "tokens": ["token_a", "token_b"],
+      "platform": 1,
+      "message": "You have a new message",
+      "data": {
+        "chat_id": chat_id,
+        "message": message,
+        "installation_ids": [installation_id_1, installation_id_2]
+      }
+    }
+  ]
+}
+```
+
+Where platform is `1` for IOS and `2` for Firebase, according to the [gorush documentation](https://github.com/appleboy/gorush)
+
+A server MUST return a response message:
+
+```protobuf
+message PushNotificationReport {
+  bool success = 1;
+  ErrorType error = 2;
+  enum ErrorType {
+    UNKNOWN_ERROR_TYPE = 0;
+    WRONG_TOKEN = 1;
+    INTERNAL_ERROR = 2;
+    NOT_REGISTERED = 3;
+  }
+  bytes public_key = 3;
+  string installation_id = 4;
+}
+
+message PushNotificationResponse {
+  bytes message_id = 1;
+  repeated PushNotificationReport reports = 2;
+}
+```
+
+A `PushNotificationResponse` message MUST be wrapped in a [`ApplicationMetadataMessage`](/status/deprecated/payloads.md#payload-wrapper) with type set to `PUSH_NOTIFICATION_RESPONSE`.
+
+Where `message_id` is the `message_id` sent by the client.
+
+The response MUST be sent on the [partitioned topic](/status/deprecated/waku-usage.md#partitioned-topic) of the sender
+and MUST not be encrypted using the [secure transport](/status/deprecated/secure-transport.md) to facilitate
+the usage of ephemeral keys.
+
+If the request is accepted `success` MUST be set to `true`.
+Otherwise `success` MUST be set to `false`.
+
+If `error` is `BAD_TOKEN` the client MAY query again the server for the token and
+retry the request.
+
+If `error` is `INTERNAL_ERROR` the client MAY retry the request.
+
+## Flow
+
+### Registration process
+
+- A client will generate a notification token through `APN` or `Firebase`.
+- The client will [register](#registering-with-the-push-notification-service) with one or more push notification server of their choosing.
+- The server should process the response and respond according to the success of the operation
+- If the request is not successful it might be retried, and adjusted according to the response. A different server can be also used.
+- Once the request is successful the client should [advertise](#advertising-a-push-notification-server) the new coordinates
+
+### Sending a notification
+
+- A client should prepare a message and extract the targeted installation-ids
+- It should retrieve the most up to date information for a given user, either by
+  querying a push notification server, a mailserver if not listening already to the given topic, or checking
+  the database locally
+- It should then [send](#sending-a-push-notification) a push notification according
+  to the rules described
+- The server should then send a request to the gorush server including all the required
+  information
+
+### Receiving a push notification
+
+- On receiving the notification, a client can open the right account by checking the
+  `installation_id` included. The `chat_id` MAY be used to open the chat if present.
+- `message` can be decrypted and presented to the user. Otherwise messages can be pulled from the mailserver if the `message_id` is no already present.
+
+## Protobuf description
+
+### PushNotificationRegistration
+
+`token_type`: the type of token. Currently supported is `APN_TOKEN` for Apple Push
+`device_token`: the actual push notification token sent by `Firebase` or `APN`
+and `FIREBASE_TOKEN` for firebase.
+`installation_id`: the [`installation_id`](/status/deprecated/account.md) of the device
+`access_token`: the access token that will be given to clients to send push notifications
+`enabled`: whether the device wants to be sent push notifications
+`version`: a monotonically increasing number identifying the current `PushNotificationRegistration`. Any time anything is changed in the record it MUST be increased by the client, otherwise the request will not be accepted.
+`allowed_key_list`: a list of `access_token` encrypted with the AES key generated
+ by Diffie–Hellman between the publisher and the allowed
+contact.
+`blocked_chat_list`: a list of `SHA2-256` hashes of chat ids.
+Any chat id in this list will not trigger a notification.
+`unregister`: whether the account should be unregistered
+`grant`: the grant for this specific server
+`allow_from_contacts_only`: whether the client only wants push notifications from contacts
+`apn_topic`: the APN topic for the push notification
+`block_mentions`: whether the client does not want to be notified on mentions
+`allowed_mentions_chat_list`:  a list of `SHA2-256` hashes of chat ids where we want to receive mentions
+
+#### Data disclosed
+
+- Type of device owned by a given user
+- The `FIREBASE` or `APN` push notification token
+- Hash of the chat_id a user is not interested in for notifications
+- The times a push notification record has been modified by the user
+- The number of contacts a client has, in case `allowed_key_list` is set
+
+### PushNotificationRegistrationResponse
+
+`success`: whether the registration was successful
+`error`: the error type, if any
+`request_id`: the `SHAKE-256` hash of the `signature` of the request
+`preferences`: the server stored preferences in case of an error
+
+### ContactCodeAdvertisement
+
+`push_notification_info`: the information for each device advertised
+
+Data disclosed
+
+- The chat key of the sender
+
+### PushNotificationQuery
+
+`public_keys`: the `SHAKE-256` of the public keys the client is interested in
+
+Data disclosed
+
+- The hash of the public keys the client is interested in
+
+### PushNotificationQueryInfo
+
+`access_token`: the access token used to send a push notification
+`installation_id`: the `installation_id` of the device associated with the `access_token`
+`public_key`: the `SHAKE-256` of the public key associated with this `access_token` and `installation_id`
+`allowed_key_list`: a list of encrypted access tokens to be returned
+to the client in case there's any filtering on public keys in place.
+`grant`: the grant used to register with this server.
+`version`: the version of the registration on the server.
+`server_public_key`: the compressed public key of the server.
+
+### PushNotificationQueryResponse
+
+`info`:  a list of `PushNotificationQueryInfo`.
+`message_id`: the message id of the `PushNotificationQueryInfo` the server is replying to.
+`success`: whether the query was successful.
+
+### PushNotification
+
+`access_token`: the access token used to send a push notification.
+`chat_id`: the `SHAKE-256` of the `chat_id`.
+`public_key`: the `SHAKE-256` of the compressed public key of the receiving client.
+`installation_id`: the installation id of the receiving client.
+`message`: the encrypted message that is being notified on.
+`type`: the type of the push notification, either `MESSAGE` or `MENTION`
+`author`: the `SHAKE-256` of the public key of the sender
+
+Data disclosed
+
+- The `SHAKE-256` of the `chat_id` the notification is to be sent for
+- The cypher text of the message
+- The `SHAKE-256` of the public key of the sender
+- The type of notification
+
+### PushNotificationRequest
+
+`requests`: a list of `PushNotification`
+`message_id`: the [status message id](/status/deprecated/payloads.md)
+
+Data disclosed
+
+- The status message id for which the notification is for
+
+### PushNotificationResponse
+
+`message_id`: the `message_id` being notified on.
+`reports`: a list of `PushNotificationReport`
+
+### PushNotificationReport
+
+`success`: whether the push notification was successful.
+`error`: the type of the error in case of failure.
+`public_key`: the public key of the user being notified.
+`installation_id`: the installation id of the user being notified.
+
+## Anonymous mode of operations
+
+An anonymous mode of operations MAY be provided by the client, where the
+responsibility of propagating information about the user is left to the client,
+in order to preserve privacy.
+
+A client in anonymous mode can register with the server using a key different
+from their chat key.
+This will hide their real chat key.
+
+This public key is effectively a secret and SHOULD only be disclosed to clients that you the user wants to be notified by.
+
+A client MAY advertise the access token on the contact-code topic of the key generated.
+A client MAY share their public key through [contact updates](/status/deprecated/payloads.md#contact-update)
+
+A client receiving a push notification public key SHOULD listen to the contact code
+topic of the push notification public key for updates.
+
+The method described above effectively does not share the identity of the sender
+nor the receiver to the server, but MAY result in missing push notifications as
+the propagation of the secret is left to the client.
+
+This can be mitigated by [device syncing](/status/deprecated/payloads.md), but not completely
+addressed.
+
+## Security considerations
+
+If no anonymous mode is used, when registering with a push notification service a client discloses:
+
+- The chat key
+- The devices that will receive notifications
+
+A client MAY disclose:
+
+- The hash of the chat_ids they want to filter out
+
+When running in anonymous mode, the client's chat key is not disclosed.
+
+When querying a push notification server a client will disclose:
+
+- That it is interested in sending push notification to another client,
+  but the querying client's chat key is not disclosed
+
+When sending a push notification a client discloses:
+
+- The `SHAKE-256` of the chat id
+
+[//]: This section can be removed, for now leaving it here in order to help with the
+review process. Point can be integrated, suggestion welcome.
+
+## FAQ
+
+### Why having ACL done at the server side and not the client?
+
+We looked into silent notification for
+[IOS](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app) (android has no equivalent)
+but can't be used as it's expected to receive maximum 2/3 per hour, so not our use case. There
+are also issue when the user force quit the app.
+
+### Why using an access token?
+
+The access token is used to decouple the requesting information from the user from
+actually sending the push notification.
+
+Some ACL is necessary otherwise it would be too easy to spam users (it's still fairly
+trivial, but with this method you could allow only contacts to send you push notifications).
+
+Therefore your identity must be revealed to the server either when sending or querying.
+
+By using an access token we increase deniability, as the server would know
+who requested the token but not necessarily who sent a push notification.
+Correlation between the two can be trivial in some cases.
+
+This also allows a mode of use as we had before, where the server does not propagate
+info at all, and it's left to the user to propagate the token, through contact requests
+for example.
+
+### Why advertise with the bundle?
+
+Advertising with the bundle allows us to piggy-back on an already implemented behavior
+and save some bandwidth in cases where is not filtering by public keys
+
+### What's the  bandwidth impact for this?
+
+Generally speaking, for each 1-to-1 message and group chat message you will sending
+1 and `number of participants` push notifications. This can be optimized if
+multiple users are using the same push notification server. Queries have also
+a bandwidth impact but they are made only when actually needed
+
+### What's the information disclosed?
+
+The data disclosed with each message sent by the client is above, but for a summary:
+
+When you register with a push notification service you may disclose:
+
+1) Your chat key
+2) Which devices you have
+3) The hash of the chat_ids you want to filter out
+4) The hash of the public keys you are interested/not interested in
+
+When you query a notification service you may disclose:
+
+1) Your chat key
+2) The fact that you are interested in sending push notification to a given user
+
+Effectively this is fairly revealing if the user has a whitelist implemented.
+Therefore sending notification should be optional.
+
+### What prevents a user from generating a random key and getting an access token and spamming?
+
+Nothing really, that's the same as the status app as a whole. the only mechanism that prevents
+this is using a white-list as described above,
+but that implies disclosing your true identity to the push notification server.
+
+### Why not 0-knowledge proofs/quantum computing
+
+We start simple, we can iterate
+
+### How to handle backward/forward compatibility
+
+Most of the request have a target, so protocol negotiation can happen. We cannot negotiated
+the advertisement as that's effectively a broadcast, but those info should not change and we can
+always accrete the message.
+
+### Why ack_key?
+
+That's necessary to avoid duplicated push notifications and allow for the retry
+in case the notification is not successful.
+
+Deduplication of the push notification is done on the client side, to reduce a bit
+of centralization and also in order not to have to modify gorush.
+
+### Can I run my own node?
+
+Sure, the methods allow that
+
+### Can I register with multiple nodes for redundancy
+
+Yep
+
+### What does my node disclose?
+
+Your node will disclose the IP address is running from, as it makes an HTTP post to
+gorush. A waku adapter could be used, but please not now.
+
+### Does this have high-reliability requirements?
+
+The gorush server yes, no way around it.
+
+The rest, kind of, at least one node having your token needs to be up for you to receive notifications.
+But you can register with multiple servers (desktop, status, etc) if that's a concern.
+
+### Can someone else (i.e not status) run this?
+
+Push notification servers can be run by anyone. Gorush can be run by anyone I take,
+but we are in charge of the certificate, so they would not be able to notify status-clients.
+
+## Changelog
+
+### Version 0.1
+
+[Released](https://github.com/status-im/specs/commit/)
+
+- Initial version
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [APN Service](https://developer.apple.com/library/archive/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/APNSOverview.html#//apple_ref/doc/uid/TP40008194-CH8-SW1)
+- [Background Execution on iOS](https://developer.apple.com/documentation/uikit/app_and_environment/scenes/preparing_your_ui_to_run_in_the_background/updating_your_app_with_background_app_refresh)
+- [Firebase](https://firebase.google.com/)
+- [Gorush](https://github.com/appleboy/gorush)
+- [UUID Specification](https://tools.ietf.org/html/rfc4122)
+- [Secure Transport](/status/deprecated/secure-transport.md)
+- [Silent Notifications on iOS](https://developer.apple.com/documentation/usernotifications/setting_up_a_remote_notification_server/pushing_background_updates_to_your_app)
+- [Waku Usage](/status/deprecated/waku-usage.md)
+- [ENS Contract](https://github.com/ensdomains/ens)
+- [Payloads](/status/deprecated/payloads.md)

status/deprecated/secure-transport.md

@@ -0,0 +1,583 @@
+---
+title: SECURE-TRANSPORT
+name: Secure Transport
+status: deprecated
+description: This document describes how Status provides a secure channel between two peers, providing confidentiality, integrity, authenticity, and forward secrecy.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Andrea Maria Piana <andreap@status.im>
+  - Corey Petty <corey@status.im>
+  - Dean Eigenmann <dean@status.im>
+  - Oskar Thorén <oskar@status.im>
+  - Pedro Pombeiro <pedro@status.im>
+---
+
+## Abstract
+
+This document describes how Status provides a secure channel between two peers,
+and thus provide confidentiality, integrity, authenticity and forward secrecy.
+It is transport-agnostic and works over asynchronous networks.
+
+It builds on the [X3DH](https://signal.org/docs/specifications/x3dh/) and [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/) specifications, with some adaptations to operate in a decentralized environment.
+
+## Introduction
+
+This document describes how nodes establish a secure channel,
+and how various conversational security properties are achieved.
+
+### Definitions
+
+- **Perfect Forward Secrecy** is a feature of specific key-agreement protocols
+which provide assurances that session keys will not be compromised even if the private keys of the participants are compromised.
+Specifically, past messages cannot be decrypted by a third-party who manages to get a hold of a private key.
+
+- **Secret channel** describes a communication channel where Double Ratchet algorithm is in use.
+
+### Design Requirements
+
+- **Confidentiality**: The adversary should not be able to learn what data is being exchanged between two Status clients.
+- **Authenticity**: The adversary should not be able to cause either endpoint of a Status 1:1 chat
+to accept data from any third party as though it came from the other endpoint.
+- **Forward Secrecy**: The adversary should not be able to learn
+what data was exchanged between two Status clients if, at some later time,
+the adversary compromises one or both of the endpoint devices.
+- **Integrity**: The adversary should not be able to cause either endpoint of a Status 1:1 chat
+to accept data that has been tampered with.
+
+All of these properties are ensured by the use of [Signal's Double Ratchet](https://signal.org/docs/specifications/doubleratchet/)
+
+### Conventions
+
+Types used in this specification are defined using [Protobuf](https://developers.google.com/protocol-buffers/).
+
+### Transport Layer
+
+[Whisper](status/deprecated/whisper-usage) and [Waku](status/deprecated/waku-usage) serves as the transport layers for the Status chat protocol.
+
+### User flow for 1-to-1 communications
+
+#### Account generation
+
+See [Account specification](status/deprecated/account)
+
+#### Account recovery
+
+If Alice later recovers her account, the Double Ratchet state information will not be available,
+so she is no longer able to decrypt any messages received from existing contacts.
+
+If an incoming message (on the same Whisper/Waku topic) fails to decrypt,
+the node replies a message with the current bundle, so that the node notifies the other end of the new device.
+Subsequent communications will use this new bundle.
+
+## Messaging
+
+All 1:1 and group chat messaging in Status is subject to end-to-end encryption
+to provide users with a strong degree of privacy and security.
+Public chat messages are publicly readable by anyone since there's no permission model
+for who is participating in a public chat.
+
+The rest of this document is purely about 1:1 and private group chat.
+Private group chat largely reduces to 1:1 chat, since there's a secure channel between each pair-wise participant.
+
+### End-to-end encryption
+
+End-to-end encryption (E2EE) takes place between two clients.
+The main cryptographic protocol is a [Status implementation](https://github.com/status-im/doubleratchet/) of the Double Ratchet protocol,
+which is in turn derived from the [Off-the-Record protocol](https://otr.cypherpunks.ca/Protocol-v3-4.1.1.html), using a different ratchet.
+The transport protocol subsequently encrypt the message payload - Whisper/Waku (see section [Transport Layer](#transport-layer)) -, using symmetric key encryption.
+Furthermore, Status uses the concept of prekeys (through the use of [X3DH](https://signal.org/docs/specifications/x3dh/))
+to allow the protocol to operate in an asynchronous environment.
+It is not necessary for two parties to be online at the same time to initiate an encrypted conversation.
+
+Status uses the following cryptographic primitives:
+
+- Whisper/Waku
+  - AES-256-GCM
+  - ECIES
+  - ECDSA
+  - KECCAK-256
+- X3DH
+  - Elliptic curve Diffie-Hellman key exchange (secp256k1)
+  - KECCAK-256
+  - ECDSA
+  - ECIES
+- Double Ratchet
+  - HMAC-SHA-256 as MAC
+  - Elliptic curve Diffie-Hellman key exchange (Curve25519)
+  - AES-256-CTR with HMAC-SHA-256 and IV derived alongside an encryption key
+
+   The node achieves key derivation using HKDF.
+
+### Prekeys
+
+Every client initially generates some key material which is stored locally:
+
+- Identity keypair based on secp256k1 - `IK`
+- A signed prekey based on secp256k1 - `SPK`
+- A prekey signature - `Sig(IK, Encode(SPK))`
+
+More details can be found in the `X3DH Prekey bundle creation` section of [2/ACCOUNT](/status/deprecated/account.md#x3dh-prekey-bundles).
+
+Prekey bundles can be extracted from any user's messages,
+or found via searching for their specific topic, `{IK}-contact-code`.
+
+TODO: See below on bundle retrieval, this seems like enhancement and parameter for recommendation
+
+### Bundle retrieval
+
+<!-- TODO: Potentially move this completely over to [Trust Establishment](./status-account-spec.md) -->
+
+X3DH works by having client apps create and make available a bundle of prekeys (the X3DH bundle)
+that can later be requested by other interlocutors when they wish to start a conversation with a given user.
+
+In the X3DH specification, nodes typically use a shared server
+to store bundles and allow other users to download them upon request.
+Given Status' goal of decentralization,
+Status chat clients cannot rely on the same type of infrastructure
+and must achieve the same result using other means.
+By growing order of convenience and security, the considered approaches are:
+
+- contact codes;
+- public and one-to-one chats;
+- QR codes;
+- ENS record;
+- Decentralized permanent storage (e.g. Swarm, IPFS).
+- Whisper/Waku
+
+<!-- TODO: Comment, it isn't clear what we actually _do_. It seems as if this is exploring the problem space. From a protocol point of view, it might make sense to describe the interface, and then have a recommendation section later on that specifies what we do. See e.g. Signal's specs where they specify specifics later on.  -->
+
+Currently, only public and one-to-one message exchanges and Whisper/Waku is used to exchange bundles.
+
+Since bundles stored in QR codes or ENS records cannot be updated to delete already used keys,
+the approach taken is to rotate more frequently the bundle (once every 24 hours),
+which will be propagated by the app through the channel available.
+
+### 1:1 chat contact request
+
+There are two phases in the initial negotiation of a 1:1 chat:
+
+1. **Identity verification** (e.g., face-to-face contact exchange through QR code, Identicon matching).
+A QR code serves two purposes simultaneously - identity verification and initial bundle retrieval;
+1. **Asynchronous initial key exchange**, using X3DH.
+
+For more information on account generation and trust establishment, see [2/ACCOUNT](/status/deprecated/account.md)
+
+#### Initial key exchange flow (X3DH)
+
+[Section 3 of the X3DH protocol](https://signal.org/docs/specifications/x3dh/#sending-the-initial-message) describes the initial key exchange flow, with some additional context:
+
+- The users' identity keys `IK_A` and `IK_B` correspond to their respective Status chat public keys;
+- Since it is not possible to guarantee that a prekey will be used only once in a decentralized world,
+the one-time prekey `OPK_B` is not used in this scenario;
+- Nodes do not send Bundles to a centralized server, but instead served in a decentralized way as described in [bundle retrieval](#bundle-retrieval).
+
+Alice retrieves Bob's prekey bundle, however it is not specific to Alice. It contains:
+
+([protobuf](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L12))
+
+``` protobuf
+// X3DH prekey bundle
+message Bundle {
+
+  bytes identity = 1;
+
+  map<string,SignedPreKey> signed_pre_keys = 2;
+
+  bytes signature = 4;
+
+  int64 timestamp = 5;
+}
+
+```golang
+- `identity`: Identity key `IK_B`
+- `signed_pre_keys`: Signed prekey `SPK_B` for each device, indexed by `installation-id`
+- `signature`: Prekey signature <i>Sig(`IK_B`, Encode(`SPK_B`))</i>
+- `timestamp`: When the bundle was created locally
+
+([protobuf](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L5))
+
+``` protobuf
+message SignedPreKey {
+  bytes signed_pre_key = 1;
+  uint32 version = 2;
+}
+```
+
+The `signature` is generated by sorting `installation-id` in lexicographical order, and concatenating the `signed-pre-key` and `version`:
+
+`installation-id-1signed-pre-key1version1installation-id2signed-pre-key2-version-2`
+
+#### Double Ratchet
+
+Having established the initial shared secret `SK` through X3DH, it can be used to seed a Double Ratchet exchange between Alice and Bob.
+
+Please refer to the [Double Ratchet spec](https://signal.org/docs/specifications/doubleratchet/) for more details.
+
+The initial message sent by Alice to Bob is sent as a top-level `ProtocolMessage` ([protobuf](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L65))
+containing a map of `DirectMessageProtocol` indexed by `installation-id` ([protobuf](https://github.com/status-im/status-go/blob/1ac9dd974415c3f6dee95145b6644aeadf02f02c/services/shhext/chat/encryption.proto#L56)):
+
+``` protobuf
+message ProtocolMessage {
+
+  string installation_id = 2;
+
+  repeated Bundle bundles = 3;
+
+  // One to one message, encrypted, indexed by installation_id
+  map<string,DirectMessageProtocol> direct_message = 101;
+
+  // Public chats, not encrypted
+  bytes public_message = 102;
+
+}
+```
+
+- `bundles`: a sequence of bundles
+- `installation_id`: the installation id of the sender
+- `direct_message` is a map of `DirectMessageProtocol` indexed by `installation-id`
+- `public_message`: unencrypted public chat message.
+
+``` protobuf
+message DirectMessageProtocol {
+  X3DHHeader X3DH_header = 1;
+  DRHeader DR_header = 2;
+  DHHeader DH_header = 101;
+  // Encrypted payload
+  bytes payload = 3;
+}
+```
+
+```protobuf
+- `X3DH_header`: the `X3DHHeader` field in `DirectMessageProtocol` contains:
+
+    ([protobuf](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L47))
+    ``` protobuf
+    message X3DHHeader {
+      bytes key = 1;
+      bytes id = 4;
+    }
+    ```
+
+    - `key`: Alice's ephemeral key `EK_A`;
+    - `id`: Identifier stating which of Bob's prekeys Alice used, in this case Bob's bundle signed prekey.
+
+    Alice's identity key `IK_A` is sent at the transport layer level (Whisper/Waku);
+
+- `DR_header`: Double ratchet header ([protobuf](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L31)). Used when Bob's public bundle is available:
+    ``` protobuf
+    message DRHeader {
+      bytes key = 1;
+      uint32 n = 2;
+      uint32 pn = 3;
+      bytes id = 4;
+    }
+    ```
+    - `key`: Alice's current ratchet public key (as mentioned in [DR spec section 2.2](https://signal.org/docs/specifications/doubleratchet/#symmetric-key-ratchet));
+    - `n`: number of the message in the sending chain;
+    - `pn`: length of the previous sending chain;
+    - `id`: Bob's bundle ID.
+
+- `DH_header`: Diffie-Helman header (used when Bob's bundle is not available):
+    ([protobuf](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L42))
+    ``` protobuf
+    message DHHeader {
+      bytes key = 1;
+    }
+    ```
+    - `key`: Alice's compressed ephemeral public key.
+
+- `payload`:
+    - if a bundle is available, contains payload encrypted with the Double Ratchet algorithm;
+    - otherwise, payload encrypted with output key of DH exchange (no Perfect Forward Secrecy).
+```
+<!-- TODO: A lot of links to status-go, seems likely these should be updated to status-protocol-go -->
+
+## Security Considerations
+
+The same considerations apply as in [section 4 of the X3DH spec](https://signal.org/docs/specifications/x3dh/#security-considerations) and [section 6 of the Double Ratchet spec](https://signal.org/docs/specifications/doubleratchet/#security-considerations), with some additions detailed below.
+
+<!-- TODO: Add any additional context here not covered in the X3DH and DR specs -->
+
+<!--
+TODO: description here
+
+### --- Security  and Privacy Features
+#### Confidentiality (YES)
+> Only the intended recipients are able to read a message. Specifically, the message must not be readable by a server operator that is not a conversation participant
+
+- Yes.
+- There's a layer of encryption at Whisper as well as above with Double Ratchet
+- Relay nodes and Mailservers can only read a topic of a Whisper message, and nothing within the payload.
+
+#### Integrity (YES)
+> No honest party will accept a message that has been modified in transit.
+
+- Yes.
+- Assuming a user validates (TODO: Check this assumption) every message they are able to decrypt and validate its signature from the sender, then it is not able to be altered in transit.
+    * [igorm] i'm really not sure about it, Whisper provides a signature, but I'm not sure we check it anywhere (simple grepping didn't give anything)
+    * [andrea] Whisper checks the signature and a public key is derived from it, we check the public key is a meaningful public key. The pk itself is not in the content of the message for public chats/1-to-1 so potentially you could send a message from a random account without having access to the private key, but that would not be much of a deal, as you might just as easily create a random account)
+
+#### Authentication (YES)
+>  Each participant in the conversation receives proof of possession of a known long-term secret from all other participants that they believe to be participating in the conversation. In addition, each participant is able to verify that a message was sent from the claimed source
+
+- 1:1 --- one-to-one messages are encrypted with the recipient's public key, and digitally signed by the sender's.  In order to provide Perfect Forward Secrecy, we build on the X3DH and Double Ratchet specifications from Open Whisper Systems, with some adaptations to operate in a decentralized environment.
+- group --- group chat is pairwise
+- public --- A user subscribes to a public channel topic and the decryption key is derived from the topic name
+
+**TODO:** Need to verify that this is actually the case
+**TODO:** Fill in explicit details here
+
+#### Participant Consistency (YES?)
+> At any point when a message is accepted by an honest party, all honest parties are guaranteed to have the same view of the participant list
+
+- **TODO:** Need details here
+
+#### Destination Validation (YES?)
+> When a message is accepted by an honest party, they can verify that they were included in the set of intended recipients for the message.
+
+- Users are aware of the topic that a message was sent to, and that they have the ability to decrypt it.
+- 
+
+#### Forward Secrecy (PARTIAL)
+> Compromising all key material does not enable decryption of previously encrypted data
+
+- After first back and forth between two contacts with PFS enabled, yes.
+
+#### Backward Secrecy (YES)
+> Compromising all key material does not enable decryption of succeeding encrypted data
+
+- PFS requires both backward and forwards secrecy
+[Andrea: This is not true, (Perfect) Forward Secrecy does not imply backward secrecy (which is also called post-compromise security, as signal calls it, or future secrecy, it's not well defined). Technically this is a NO , double ratchet offers good Backward secrecy, but not perfect. Effectively if all the key material is compromised, any future message received will be also compromised (due to the hash ratchet), until a DH ratchet step is completed (i.e. the compromised party generate a new random key and ratchet)]
+
+#### Anonymity Preserving (PARTIAL)
+> Any anonymity features provided by the underlying transport privacy architecture are not undermined (e.g., if the transport privacy system provides anonymity, the conversation security level does not de-anonymize users by linking key identifiers).
+
+- by default, yes
+- ENS Naming system attaches an identifier to a given public key
+
+#### Speaker Consistency (PARTIAL)
+> All participants agree on the sequence of messages sent by each participant. A protocol might perform consistency checks on blocks of messages during the protocol, or after every message is sent.
+
+- We use Lamport timestamps for ordering of events.
+- In addition to this, we use local timestamps to attempt a more intuitive ordering. [Andrea: currently this was introduced as a regression during performance optimization and might result in out-of-order messages if sent across day boundaries, so I consider it a bug and not part of the specs (it does not make the order more intuitive, quite the opposite as it might result in causally related messages being out-of-order, but helps dividing the messages in days)]
+- Fundamentally, there's no single source of truth, nor consensus process for global ordering [Andrea: Global ordering does not need a consensus process i.e. if you order messages alphabetically, and you break ties consistently, you have global ordering, as all the participants will see the same ordering (as opposed to say order by the time the message was received locally),  of course is not useful, you want to have causal + global to be meaningful]
+
+TODO: Understand how this is different from Global Transcript
+[Andrea: This is basically Global transcript for a single participants, we offer global transcript]
+
+#### Causality Preserving (PARTIAL)
+> Implementations can avoid displaying a message before messages that causally precede it
+
+- Not yet, but in pipeline (data sync layer)
+
+[Andrea: Messages are already causally ordered, we don't display messages that are causally related out-of-order, that's already granted by lamport timestamps]
+
+TODO: Verify if this can be done already by looking at Lamport clock difference
+
+#### Global Transcript (PARTIAL)
+> All participants see all messages in the same order
+
+- See directly above
+
+[Andrea: messages are globally (total) ordered, so all participants see the same ordering]
+
+#### Message Unlinkability (NO)
+> If a judge is convinced that a participant authored one message in the conversation, this does not provide evidence that they authored other messages
+
+- Currently, the Status software signs every messages sent with the user's public key, thus making it unable to provide unlinkability.  
+- This is not necessary though, and could be built in to have an option to not sign. 
+- Side note: moot account allows for this but is a function of the anonymity set that uses it.  The more people that use this account the stronger the unlinkability.
+
+#### Message Repudiation (NO)
+> Given a conversation transcript and all cryptographic keys, there is no evidence that a given message was authored by any particular user
+
+- All messages are digitally signed by their sender.
+- The underlying transport, Whisper/Waku, does allow for unsigned messages, but we don't use it.
+
+#### Participant Repudiation (NO)
+> Given a conversation transcript and all cryptographic key material for all but one accused (honest) participant, there is no evidence that the honest participant was in a conversation with any of the other participants.
+
+### --- Group related features
+#### Computational Equality (YES)
+>  All chat participants share an equal computational load
+
+- One a message is sent, all participants in a group chat perform the same steps to retrieve and decrypt it. 
+- If proof of work is actually used at the Whisper layer (basically turned off in Status) then the sender would have to do additional computational work to send messages.
+
+#### Trust Equality (PARTIAL)
+> No participant is more trusted or takes on more responsibility than any other
+
+- 1:1 chats and public chats are equal
+- group chats have admins (on purpose)
+- Private Group chats have Administrators and Members.  Upon construction, the creator is made an admin. These groups have the following privileges:
+    - Admins:
+        - Add group members
+        - Promote group members to admin
+        - Change group name
+    - Members:
+        - Accept invitation to group
+        - Leave group
+    - Non-Members:
+        - Invited by admins show up as "invited" in group; this leaks contact information
+        - Invited people don't opt-in to being invited
+
+TODO: Group chat dynamics should have a documented state diagram
+TODO: create issues for identity leak of invited members as well as current members of a group showing up who have not accepted yet [Andrea: that's an interesting point, didn't think of that. Currently we have this behavior for 2 reasons, backward compatibility with previous releases, which had no concept of joining, and also because we rely on other peers to propagate group info, so we don't have a single-message point of failure (the invitation), the first can be addressed easily, the second is trickier, without giving up the propagation mechanism (if we choose to give this up, then it's trivial)]
+
+#### Subgroup Messaging (NO)
+> Messages can be sent to a subset of participants without forming a new conversation
+
+- This would require a new topic and either a new public chat or a new group chat
+[Andrea: This is a YES, as messages are pairwise encrypted, and client-side fanout, so anyone could potentially send a message only to a subset of the group]
+
+#### Contractible Membership (PARTIAL)
+> After the conversation begins, participants can leave without restarting the protocol
+
+- For 1:1, there is no way to ignore or block a user from sending you a message.  This is currently in the pipeline.
+- For public chats, Yes. A member simply stops subscribing to a specific topic and will no longer receive messages. 
+- For group chats: this assumes pairwise encryption OR key is renegotiated
+- This only currently works on the identity level, and not the device level.  A ghost device will have access to anything other devices have.
+[Andrea: For group chats, that's possible as using pairwise encryption, also with group chats (which use device-to-device encryption), ghost devices is a bit more complicated, in general, they don't have access to the messages you send, i.e. If I send a message from device A1 to the group chat and there is a ghost device A2, it will not be able to decrypt the content, but will see that a message has been sent (as only paired devices are kept in sync, and those are explicitly approved by the user). Messages that you receive are different, so a ghost device (A2) will potentially be able to decrypt the message, but A1 can detect the ghost device (in most cases, it's complicated :), the pfs docs describe multi-device support), for one-to-one ghost devices are undetectable]
+
+#### Expandable Membership (PARTIAL)
+> After the conversation begins, participants can join without restarting the protocol.
+
+- 1:1: no, only 1:1
+- private group: yes, since it is pair-wise, each person in the group just creates a pair with the new member
+- public: yes, as members of a public chat are only subscribing to a topic and receiving anyone sending messages to it. 
+
+### --- Usability and Adoption
+
+#### Out-of-Order Resilient (PARTIAL)
+> If a message is delayed in transit, but eventually arrives, its contents are accessible upon arrival
+
+- Due to asynchronous forward secrecy and no additional services, private keys might be rotated
+
+[Andrea: That's correct, in some cases if the message is delayed for too long, or really out-of-order, the specific message key might have been deleted, as we only keep the last 3000 message keys]
+[Igor: TTL of a Whisper message can expire, so any node-in-transit will drop it. Also, I believe we ignore messages with skewed timestamps]
+
+#### Dropped Message Resilient (PARTIAL)
+> Messages can be decrypted without receipt of all previous messages. This is desirable for asynchronous and unreliable network services
+
+- Public chats: yes, users are able to decrypt any message received at any time.
+- 1-to-1/group chat also, this is a YES in my opinion
+
+#### Asynchronous (PARTIAL)
+> Messages can be sent securely to disconnected recipients and received upon their next connection
+
+- The semantics around message reliability are currently poor
+    * [Igor: messages are stored on mailservers for way longer than TTL (30 days), but that requires Status infrastructure]
+- There's a TTL in Whisper and mailserver can deliver messages after the fact
+
+TODO: this requires more detail
+
+#### Multi-Device Support (YES)
+> A user can participate in the conversation using multiple devices at once. Each device must be able to send and receive messages. Ideally, all devices have identical views of the conversation. The devices might use a synchronized long-term key or distinct keys.
+
+- Yes
+- There is currently work being done to improve the syncing process between a user's devices. 
+
+#### No Additional Service (NO)
+> The protocol does not require any infrastructure other than the protocol participants. Specifically, the protocol must not require additional servers for relaying messages or storing any kind of key material.
+
+- The protocol requires Whisper/Waku relay servers and mailservers currently. 
+- The larger the number of Whisper/Waku relay servers, the better the transport security but there might be potential scaling problems.
+- Mailservers act to provide asynchronicity so users can retrieve messages after coming back from an offline period. 
+
+-->
+
+## Session management
+
+A node identifies a peer by two pieces of data:
+
+1) An `installation-id` which is generated upon creating a new account in the `Status` application
+2) Their identity Whisper/Waku key
+
+### Initialization
+
+A node initializes a new session once a successful X3DH exchange has taken place. Subsequent messages will use the established session until re-keying is necessary.
+
+### Concurrent sessions
+
+If a node creates two sessions concurrently between two peers, the one with the symmetric key first in byte order SHOULD be used, this marks that the other has expired.
+
+### Re-keying
+
+On receiving a bundle from a given peer with a higher version, the old bundle SHOULD be marked as expired and a new session SHOULD be established on the next message sent.
+
+### Multi-device support
+
+Multi-device support is quite challenging as there is not a central place
+where information on which and how many devices (identified by their respective `installation-id`) belongs to a whisper-identity / waku-identity.
+
+Furthermore, account recovery always needs to be taken into consideration,
+where a user wipes clean the whole device and the nodes loses all the information about any previous sessions.
+
+Taking these considerations into account, the way the network propagates multi-device information using x3dh bundles,
+which will contain information about paired devices as well as information about the sending device.
+
+This means that every time a new device is paired, the bundle needs to be updated and propagated with the new information,
+the user has the responsibility to make sure the pairing is successful.
+
+The method is loosely based on [Sesame](https://signal.org/docs/specifications/sesame/).
+
+### Pairing
+
+When a user adds a new account in the `Status` application, a new `installation-id` will be generated.
+The device should be paired as soon as possible if other devices are present.
+Once paired the contacts will be notified of the new device and it will be included in further communications.
+
+If a bundle received from the `IK` is different to the `installation-id`,
+the device will be shown to the user and will have to be manually approved, to a maximum of 3.
+Once that is done any message sent by one device will also be sent to any other enabled device.
+
+Once a user enables a new device, a new bundle will be generated which will include pairing information.
+
+The bundle will be propagated to contacts through the usual channels.
+
+Removal of paired devices is a manual step that needs to be applied on each device,
+and consist simply in disabling the device, at which point pairing information will not be propagated anymore.
+
+### Sending messages to a paired group
+
+When sending a message, the peer will send a message to other `installation-id` that they have seen.
+The node caps the number of devices to 3, ordered by last activity.
+The node sends messages using pairwise encryption, including their own devices.
+
+Account recovery
+
+Account recovery is no different from adding a new device, and it is handled in exactly the same way.
+
+### Partitioned devices
+
+In some cases (i.e. account recovery when no other pairing device is available, device not paired),
+it is possible that a device will receive a message that is not targeted to its own `installation-id`.
+In this case an empty message containing bundle information is sent back,
+which will notify the receiving end of including this device in any further communication.
+
+## Changelog
+
+### Version 0.3
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+- Added language to include Waku in all relevant places
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [X3DH](https://signal.org/docs/specifications/x3dh/)
+- [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/)
+- [Protobuf](https://developers.google.com/protocol-buffers/)
+- [Whisper](/status/deprecated/whisper-usage.md)
+- [Waku](/status/deprecated/waku-usage.md)
+- [Account specification](/status/deprecated/account.md)
+- [Status implementation](https://github.com/status-im/doubleratchet/)
+- [Off-the-Record protocol](https://otr.cypherpunks.ca/Protocol-v3-4.1.1.html)
+- [X3DH](https://signal.org/docs/specifications/x3dh/)
+- [ACCOUNT](/status/deprecated/account.md)
+- [Sesame](https://signal.org/docs/specifications/sesame/)
+- [May 22, 2020 commit change](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)

status/deprecated/waku-mailserver.md

@@ -0,0 +1,138 @@
+---
+title: WAKU-MAILSERVER
+name: Waku Mailserver
+status: deprecated
+description: Waku Mailserver is a specification that allows messages to be stored permanently and to allow the stored messages to be delivered to requesting client nodes, regardless if the messages are not available in the network due to the message TTL expiring.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Adam Babik <adam@status.im>
+  - Oskar Thorén <oskar@status.im>
+  - Samuel Hawksby-Robinson <samuel@status.im>
+---
+
+## Abstract
+
+Being mostly offline is an intrinsic property of mobile clients.
+They need to save network transfer and battery consumption to avoid spending too much money or constant charging.
+Waku protocol, on the other hand, is an online protocol.
+Messages are available in the Waku network only for short period of time calculate in seconds.
+
+Waku Mailserver is a specification that allows messages to be stored permanently
+and allows the stored messages to be delivered to requesting client nodes,
+regardless if the messages are not available in the network due to the message TTL expiring.
+
+## `Mailserver`
+
+From the network perspective, a `Mailserver` is just like any other Waku node.
+The only difference is that a `Mailserver` has the capability of archiving messages
+and delivering them to its peers on-demand.
+
+It is important to notice that a `Mailserver` will only handle requests from its direct peers
+and exchanged packets between a `Mailserver` and a peer are p2p messages.
+
+### Archiving messages
+
+A node which wants to provide `Mailserver` functionality MUST store envelopes from
+incoming message packets (Waku packet-code `0x01`). The envelopes can be stored in any
+format, however they MUST be serialized and deserialized to the Waku envelope format.
+
+A `Mailserver` SHOULD store envelopes for all topics to be generally useful for any peer,
+however for specific use cases it MAY store envelopes for a subset of topics.
+
+### Requesting messages
+
+In order to request historic messages, a node MUST send a packet P2P Request (`0x7e`) to a peer providing `Mailserver` functionality.
+This packet requires one argument which MUST be a Waku envelope.
+
+In the Waku envelope's payload section, there MUST be RLP-encoded information about the details of the request:
+
+```golang
+[ Lower, Upper, Bloom, Limit, Cursor ]
+```
+
+`Lower`: 4-byte wide unsigned integer (UNIX time in seconds; oldest requested envelope's creation time)  
+`Upper`: 4-byte wide unsigned integer (UNIX time in seconds; newest requested envelope's creation time)  
+`Bloom`: 64-byte wide array of Waku topics encoded in a bloom filter to filter envelopes  
+`Limit`: 4-byte wide unsigned integer limiting the number of returned envelopes  
+`Cursor`: an array of a cursor returned from the previous request (optional)
+
+The `Cursor` field SHOULD be filled in if a number of envelopes between `Lower` and `Upper` is greater than `Limit`
+so that the requester can send another request using the obtained `Cursor` value.
+What exactly is in the `Cursor` is up to the implementation.
+The requester SHOULD NOT use a `Cursor` obtained from one `Mailserver` in a request to another `Mailserver` because the format or the result MAY be different.
+
+The envelope MUST be encrypted with a symmetric key agreed between the requester and the `Mailserver`.
+
+### Receiving historic messages
+
+Historic messages MUST be sent to a peer as a packet with a P2P Message code (`0x7f`) followed by an array of Waku envelopes.
+
+In order to receive historic messages from a `Mailserver`, a node MUST trust the selected `Mailserver`,
+that is allowed to send packets with the P2P Message code. By default, the node discards such packets.
+
+Received envelopes MUST be passed through the Waku envelope pipelines
+so that they are picked up by registered filters and passed to subscribers.
+
+For a requester, to know that all messages have been sent by a `Mailserver`,
+it SHOULD handle P2P Request Complete code (`0x7d`). This code is followed by the following parameters:
+
+```golang
+[ RequestID, LastEnvelopeHash, Cursor ]
+```
+
+* `RequestID`: 32-byte wide array with a Keccak-256 hash of the envelope containing the original request  
+* `LastEnvelopeHash`: 32-byte wide array with a Keccak-256 hash of the last sent envelope for the request  
+* `Cursor`: an array of a cursor returned from the previous request (optional)
+
+If `Cursor` is not empty, it means that not all messages were sent due to the set `Limit` in the request.
+One or more consecutive requests MAY be sent with `Cursor` field filled in order to receive the rest of the messages.
+
+## Security considerations
+
+### Confidentiality
+
+The node encrypts all Waku envelopes. A `Mailserver` node can not inspect their contents.
+
+### Altruistic and centralized operator risk
+
+In order to be useful, a `Mailserver` SHOULD be online most of time.
+That means users either have to be a bit tech-savvy to run their own node,
+or rely on someone else to run it for them.
+
+Currently, one of Status's legal entities provides `Mailservers` in an altruistic manner,
+but this is suboptimal from a decentralization, continuance and risk point of view.
+Coming up with a better system for this is ongoing research.
+
+A Status client SHOULD allow the `Mailserver` selection to be customizable.
+
+### Privacy concerns
+
+In order to use a `Mailserver`, a given node needs to connect to it directly,
+i.e. add the `Mailserver` as its peer and mark it as trusted.
+This means that the `Mailserver` is able to send direct p2p messages to the node instead of broadcasting them.
+Effectively, it will have access to the bloom filter of topics that the user is interested in,
+when it is online as well as many metadata like IP address.
+
+### Denial-of-service
+
+Since a `Mailserver` is delivering expired envelopes and has a direct TCP connection with the recipient,
+the recipient is vulnerable to DoS attacks from a malicious `Mailserver` node.
+
+## Changelog
+
+### Version 0.1
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+* Created document
+* Forked from [whisper-mailserver](/status/deprecated/whisper-mailserver.md)
+* Change to keep `Mailserver` term consistent
+* Replaced Whisper references with Waku
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+* [May 22, 2020 change commit](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)

status/deprecated/waku-usage.md

@@ -0,0 +1,392 @@
+---
+title: WAKU-USAGE
+name: Waku Usage
+status: deprecated
+description: Status uses Waku to provide privacy-preserving routing and messaging on top of devP2P.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Adam Babik <adam@status.im>
+  - Corey Petty <corey@status.im>
+  - Oskar Thorén <oskar@status.im>
+  - Samuel Hawksby-Robinson <samuel@status.im>
+---
+
+## Abstract
+
+Status uses [Waku](/waku/standards/legacy/6/waku1.md) to provide privacy-preserving routing
+and messaging on top of devP2P.
+Waku uses topics to partition its messages,
+and these are leveraged for all chat capabilities.
+In the case of public chats, the channel name maps directly to its Waku topic.
+This allows anyone to listen on a single channel.
+
+Additionally, since anyone can receive Waku envelopes,
+it relies on the ability to decrypt messages to decide who is the correct recipient.
+Status nodes do not rely upon this property,
+and implement another secure transport layer on top of Whisper.
+
+## Reason
+
+Provide routing, metadata protection, topic-based multicasting and basic
+encryption properties to support asynchronous chat.
+
+## Terminology
+
+* *Waku node*: an Ethereum node with Waku V1 enabled
+* *Waku network*: a group of Waku nodes connected together through the internet connection and forming a graph
+* *Message*: a decrypted Waku message
+* *Offline message*: an archived envelope
+* *Envelope*: an encrypted message with metadata like topic and Time-To-Live
+
+## Waku packets
+
+| Packet Name          | Code | References |
+| -------------------- | ---: | --- |
+| Status               |    0 | [Status](status), [WAKU-1](/waku/standards/legacy/6/waku1.md#status) |
+| Messages             |    1 | [WAKU-1](/waku/standards/legacy/6/waku1.md#messages) |
+| Batch Ack            |   11 | Undocumented. Marked for Deprecation |
+| Message Response     |   12 | [WAKU-1](/waku/standards/legacy/6/waku1.md#batch-ack-and-message-response) |
+| Status Update        |   22 | [WAKU-1](/waku/standards/legacy/6/waku1.md#status-update) |
+| P2P Request Complete |  125 | [4/WAKU-MAILSERVER](/status/deprecated/waku-mailserver.md) |
+| P2P Request          |  126 | [4/WAKU-MAILSERVER](/status/deprecated/waku-mailserver.md), [WAKU-1](/waku/standards/legacy/6/waku1.md#p2p-request) |
+| P2P Messages         |  127 | [4/WAKU-MAILSERVER](/status/deprecated/waku-mailserver.md), [WAKU-1](/waku/standards/legacy/6/waku1.md#p2p-request-complete) |
+
+## Waku node configuration
+
+A Waku node must be properly configured to receive messages from Status clients.
+
+Nodes use Waku's Proof Of Work algorithm to deter denial of service and various spam/flood attacks against the Whisper network.
+The sender of a message must perform some work which in this case means processing time.
+Because Status' main client is a mobile client, this easily leads to battery draining and poor performance of the app itself.
+Hence, all clients MUST use the following Whisper node settings:
+
+* proof-of-work requirement not larger than `0.002` for payloads less than 50,000 bytes
+* proof-of-work requirement not larger than `0.000002` for payloads greater than or equal to 50,000 bytes
+* time-to-live not lower than `10` (in seconds)
+
+## Status
+
+Handshake is a RLP-encoded packet sent to a newly connected peer. It MUST start with a Status Code (`0x00`) and follow up with items:
+
+```golang
+[
+  [ pow-requirement-key pow-requirement ]
+  [ bloom-filter-key bloom-filter ]
+  [ light-node-key light-node ]
+  [ confirmations-enabled-key confirmations-enabled ]
+  [ rate-limits-key rate-limits ]
+  [ topic-interest-key topic-interest ]
+]
+```
+
+| Option Name             | Key    | Type     | Description | References |
+| ----------------------- | ------ | -------- | ----------- | --- |
+| `pow-requirement`       | `0x00` | `uint64` | minimum PoW accepted by the peer | [WAKU-1#pow-requirement](/waku/standards/legacy/6/waku1.md#pow-requirement-field) |
+| `bloom-filter`          | `0x01` | `[]byte` | bloom filter of Waku topic accepted by the peer | [WAKU-1#bloom-filter](/waku/standards/legacy/6/waku1.md#bloom-filter-field) |
+| `light-node`            | `0x02` | `bool`   | when true, the peer won't forward envelopes through the Messages packet. | [WAKU-1#light-node](/waku/standards/legacy/6/waku1.md#light-node) |
+| `confirmations-enabled` | `0x03` | `bool`   | when true, the peer will send message confirmations | [WAKU-1#confirmations-enabled-field](/waku/standards/legacy/6/waku1.md#confirmations-enabled-field) |
+| `rate-limits`           | `0x04` |          | See [Rate limiting](/waku/standards/legacy/6/waku1.md#rate-limits-field) | [WAKU-1#rate-limits](/waku/standards/legacy/6/waku1.md#rate-limits-field) |
+| `topic-interest`        | `0x05` | `[10000][4]byte` | Topic interest is used to share a node's interest in envelopes with specific topics. It does this in a more bandwidth considerate way, at the expense of some metadata protection. Peers MUST only send envelopes with specified topics. | [WAKU-1#topic-interest](/waku/standards/legacy/6/waku1.md#topic-interest-field), [the theoretical scaling model](https://github.com/vacp2p/research/tree/dcc71f4779be832d3b5ece9c4e11f1f7ec24aac2/whisper_scalability) |
+
+<!-- TODO Add `light-node` and `confirmations-enabled` links when https://github.com/vacp2p/specs/pull/128 is merged -->
+
+## Rate limiting
+
+In order to provide an optional very basic Denial-of-Service attack protection, each node SHOULD define its own rate limits.
+The rate limits SHOULD be applied on IPs, peer IDs, and envelope topics.
+
+Each node MAY decide to whitelist, i.e. do not rate limit, selected IPs or peer IDs.
+
+If a peer exceeds node's rate limits, the connection between them MAY be dropped.
+
+Each node SHOULD broadcast its rate limits to its peers using `rate limits` in `status-options` via packet code `0x00` or `0x22`. The rate limits is RLP-encoded information:
+
+```golang
+[ IP limits, PeerID limits, Topic limits ]
+```
+
+`IP limits`: 4-byte wide unsigned integer
+`PeerID limits`: 4-byte wide unsigned integer
+`Topic limits`: 4-byte wide unsigned integer
+
+The rate limits MAY also be sent as an optional parameter in the handshake.
+
+Each node SHOULD respect rate limits advertised by its peers. The number of packets SHOULD be throttled in order not to exceed peer's rate limits.
+If the limit gets exceeded, the connection MAY be dropped by the peer.
+
+## Keys management
+
+The protocol requires a key (symmetric or asymmetric) for the following actions:
+
+* signing & verifying messages (asymmetric key)
+* encrypting & decrypting messages (asymmetric or symmetric key).
+
+As nodes require asymmetric keys and symmetric keys to process incoming messages,
+they must be available all the time and are stored in memory.
+
+Keys management for PFS is described in [5/SECURE-TRANSPORT](/status/deprecated/secure-transport.md).
+
+The Status protocols uses a few particular Waku topics to achieve its goals.
+
+### Contact code topic
+
+Nodes use the contact code topic to facilitate the discovery of X3DH bundles so that the first message can be PFS-encrypted.
+
+Each user publishes periodically to this topic. If user A wants to contact user B, she SHOULD look for their bundle on this contact code topic.
+
+Contact code topic MUST be created following the algorithm below:
+
+```golang
+contactCode := "0x" + hexEncode(activePublicKey) + "-contact-code"
+
+var hash []byte = keccak256(contactCode)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+### Partitioned topic
+
+Waku is broadcast-based protocol. In theory, everyone could communicate using a single topic but that would be extremely inefficient.
+Opposite would be using a unique topic for each conversation, however,
+this brings privacy concerns because it would be much easier to detect whether and when two parties have an active conversation.
+
+Nodes use partitioned topics to broadcast private messages efficiently.
+By selecting a number of topic, it is possible to balance efficiency and privacy.
+
+Currently, nodes set the number of partitioned topics to `5000`. They MUST be generated following the algorithm below:
+
+```golang
+var partitionsNum *big.Int = big.NewInt(5000)
+var partition *big.Int = big.NewInt(0).Mod(publicKey.X, partitionsNum)
+
+partitionTopic := "contact-discovery-" + strconv.FormatInt(partition.Int64(), 10)
+
+var hash []byte = keccak256(partitionTopic)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+### Public chats
+
+A public chat MUST use a topic derived from a public chat name following the algorithm below:
+
+```golang
+var hash []byte
+hash = keccak256(name)
+
+topicLen = 4
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+<!-- NOTE: commented out as it is currently not used.  In code for potential future use. - C.P. Oct 8, 2019
+### Personal discovery topic
+
+ Personal discovery topic is used to ???
+
+A client MUST implement it following the algorithm below:
+```golang
+personalDiscoveryTopic := "contact-discovery-" + hexEncode(publicKey)
+
+var hash []byte = keccak256(personalDiscoveryTopic)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+Each Status Client SHOULD listen to this topic in order to receive ??? -->
+
+### Group chat topic
+
+Group chats does not have a dedicated topic.
+All group chat messages (including membership updates) are sent as one-to-one messages to multiple recipients.
+
+### Negotiated topic
+
+When a client sends a one to one message to another client, it MUST listen to their negotiated topic.
+This is computed by generating a diffie-hellman key exchange between two members
+and taking the first four bytes of the `SHA3-256` of the key generated.
+
+```golang
+
+sharedKey, err := ecies.ImportECDSA(myPrivateKey).GenerateShared(
+      ecies.ImportECDSAPublic(theirPublicKey),
+      16,
+      16,
+)
+
+
+hexEncodedKey := hex.EncodeToString(sharedKey)
+
+var hash []byte = keccak256(hexEncodedKey)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+A client SHOULD send to the negotiated topic only if it has received a message from all the devices included in the conversation.
+
+### Flow
+
+To exchange messages with client `B`, a client `A` SHOULD:
+
+* Listen to client's `B` Contact Code Topic to retrieve their bundle information, including a list of active devices
+* Send a message on client's `B` partitioned topic
+* Listen to the Negotiated Topic between `A` & `B`
+* Once client `A` receives a message from `B`, the Negotiated Topic SHOULD be used
+
+## Message encryption
+
+Even though, the protocol specifies an encryption layer that encrypts messages before passing them to the transport layer,
+Waku protocol requires each Waku message to be encrypted anyway.
+
+The node encrypts public and group messages using symmetric encryption, and creates the key from a channel name string.
+The implementation is available in [`shh_generateSymKeyFromPassword`](https://github.com/ethereum/go-ethereum/wiki/Whisper-v6-RPC-API#shh_generatesymkeyfrompassword) JSON-RPC method of go-ethereum Whisper implementation.
+
+The node encrypts one-to-one messages using asymmetric encryption.
+
+## Message confirmations
+
+Sending a message is a complex process where many things can go wrong.
+Message confirmations tell a node that a message originating from it has been seen by its direct peers.
+
+A node MAY send a message confirmation for any batch of messages received in a packet Messages Code (`0x01`).
+
+A node sends a message confirmation using Batch Acknowledge packet (`0x0b`) or Message Response packet (`0x0c`).
+
+The Batch Acknowledge packet is followed by a keccak256 hash of the envelopes batch data (raw bytes).
+
+The Message Response packet is more complex and is followed by a Versioned Message Response:
+
+```golang
+[ Version, Response]
+```
+
+`Version`: a version of the Message Response, equal to `1`,
+`Response`: `[ Hash, Errors ]` where `Hash` is a keccak256 hash of the envelopes batch data (raw bytes)
+for which the confirmation is sent and `Errors` is a list of envelope errors when processing the batch.
+A single error contains `[ Hash, Code, Description ]` where `Hash` is a hash of the processed envelope,
+`Code` is an error code and `Description` is a descriptive error message.
+
+The supported codes:
+`1`: means time sync error which happens when an envelope is too old
+or created in the future (the root cause is no time sync between nodes).
+
+The drawback of sending message confirmations is that it increases the noise in the network because for each sent message,
+one or more peers broadcast a corresponding confirmation. To limit that, both Batch Acknowledge packet (`0x0b`)
+and Message Response packet (`0x0c`) are not broadcast to peers of the peers, i.e. they do not follow epidemic spread.
+
+In the current Status network setup, only `Mailservers` support message confirmations.
+A client posting a message to the network and after receiving a confirmation can be sure that the message got processed by the `Mailserver`.
+If additionally, sending a message is limited to non-`Mailserver` peers,
+it also guarantees that the message got broadcast through the network and it reached the selected `Mailserver`.
+
+## Waku V1 extensions
+
+### Request historic messages
+
+Sends a request for historic messages to a `Mailserver`.
+The `Mailserver` node MUST be a direct peer and MUST be marked as trusted (using `waku_markTrustedPeer`).
+
+The request does not wait for the response.
+It merely sends a peer-to-peer message to the `Mailserver` and it's up to `Mailserver` to process it and start sending historic messages.
+
+The drawback of this approach is that it is impossible to tell which historic messages are the result of which request.
+
+It's recommended to return messages from newest to oldest.
+To move further back in time, use `cursor` and `limit`.
+
+#### wakuext_requestMessages
+
+**Parameters**:
+
+* Object - The message request object:
+  * `mailServerPeer` - `String`: `Mailserver`'s enode address.
+  * `from` - `Number` (optional): Lower bound of time range as unix timestamp, default is 24 hours back from now.
+  * `to` - `Number` (optional): Upper bound of time range as unix timestamp, default is now.
+  * `limit` - `Number` (optional): Limit the number of messages sent back, default is no limit.
+  * `cursor` - `String` (optional): Used for paginated requests.
+  * `topics` - `Array`: hex-encoded message topics.
+  * `symKeyID` - `String`: an ID of a symmetric key used to authenticate with the `Mailserver`, derived from the `Mailserver` password.
+
+**Returns**:
+`Boolean` - returns `true` if the request was sent.
+
+The above `topics` is then converted into a bloom filter and then and sent to the `Mailserver`.
+
+<!-- TODO: Clarify actual request with bloom filter to mailserver -->
+
+## Changelog
+
+### Version 0.1
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+* Created document
+* Forked from [3-whisper-usage](3-whisper-usage.md)
+* Change to keep `Mailserver` term consistent
+* Replaced Whisper references with Waku
+* Added [Status options](#status) section
+* Updated [Waku packets](#waku-packets) section to match Waku
+* Added that `Batch Ack` is marked for deprecation
+* Changed `shh_generateSymKeyFromPassword` to `waku_generateSymKeyFromPassword`
+  * [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/waku/api.go#L172-L175)
+  * [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/eth-node/bridge/geth/public_waku_api.go#L33-L36)
+* Changed `shh_markTrustedPeer` to `waku_markTrustedPeer`
+  * [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/waku/api.go#L100-L108)
+* Changed `shhext_requestMessages` to `wakuext_requestMessages`
+  * [Exists here](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/services/wakuext/api.go#L76-L139)
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+* [Waku](waku)
+* [WAKU1](/waku/standards/legacy/6/waku1.md)
+* [WAKU-MAILSERVER](/status/deprecated/waku-mailserver.md)
+* [The theoretical scaling model](https://github.com/vacp2p/research/tree/dcc71f4779be832d3b5ece9c4e11f1f7ec24aac2/whisper_scalability)
+* [SECURE-TRANSPORT](/status/deprecated/secure-transport.md)
+* [May 22, 2020 commit](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+* [`shh_generateSymKeyFromPassword`](https://github.com/ethereum/go-ethereum/wiki/Whisper-v6-RPC-API#shh_generatesymkeyfrompassword)
+* [Key Change #1](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/waku/api.go#L172-L175)
+* [Key Change #2](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/eth-node/bridge/geth/public_waku_api.go#L33-L36)
+* [Key Change #3](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/waku/api.go#L100-L108)
+* [Key Change #4](https://github.com/status-im/status-go/blob/2d13ccf5ec3db7e48d7a96a7954be57edb96f12f/services/wakuext/api.go#L76-L139)

status/deprecated/whisper-mailserver.md

@@ -0,0 +1,148 @@
+---
+title: WHISPER-MAILSERVER
+name: Whisper mailserver
+status: deprecated
+description: Whisper Mailserver is a Whisper extension that allows to store messages permanently and deliver them to the clients even though they are already not available in the network and expired.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Adam Babik <adam@status.im>
+  - Oskar Thorén <oskar@status.im>
+---
+
+## Abstract
+
+Being mostly offline is an intrinsic property of mobile clients.
+They need to save network transfer and battery consumption
+to avoid spending too much money or constant charging.
+Whisper protocol, on the other hand, is an online protocol.
+Messages are available in the Whisper network only for short period of time calculate in seconds.
+
+Whisper `Mailserver` is a Whisper extension that allows to store messages permanently
+and deliver them to the clients even though they are already not available in the network and expired.
+
+## `Mailserver`
+
+From the network perspective, `Mailserver` is just like any other Whisper node.
+The only difference is that it has a capability of archiving messages and delivering them to its peers on-demand.
+
+It is important to notice that `Mailserver` will only handle requests from its direct peers
+and exchanged packets between `Mailserver` and a peer are p2p messages.
+
+### Archiving messages
+
+A node which wants to provide `Mailserver` functionality MUST store envelopes
+from incoming message packets (Whisper packet-code `0x01`).
+The envelopes can be stored in any format,
+however they MUST be serialized and deserialized to the Whisper envelope format.
+
+A `Mailserver` SHOULD store envelopes for all topics to be generally useful for any peer,
+however for specific use cases it MAY store envelopes for a subset of topics.
+
+### Requesting messages
+
+In order to request historic messages, a node MUST send a packet P2P Request (`0x7e`) to a peer providing `Mailserver` functionality.
+This packet requires one argument which MUST be a Whisper envelope.
+
+In the Whisper envelope's payload section, there MUST be RLP-encoded information about the details of the request:
+
+```golang
+[ Lower, Upper, Bloom, Limit, Cursor ]
+```
+
+`Lower`: 4-byte wide unsigned integer (UNIX time in seconds; oldest requested envelope's creation time)  
+`Upper`: 4-byte wide unsigned integer (UNIX time in seconds; newest requested envelope's creation time)  
+`Bloom`: 64-byte wide array of Whisper topics encoded in a bloom filter to filter envelopes  
+`Limit`: 4-byte wide unsigned integer limiting the number of returned envelopes  
+`Cursor`: an array of a cursor returned from the previous request (optional)
+
+The `Cursor` field SHOULD be filled in
+if a number of envelopes between `Lower` and `Upper` is greater than `Limit`
+so that the requester can send another request using the obtained `Cursor` value.
+What exactly is in the `Cursor` is up to the implementation.
+The requester SHOULD NOT use a `Cursor` obtained from one `Mailserver` in a request to another `Mailserver`
+because the format or the result MAY be different.
+
+The envelope MUST be encrypted with a symmetric key agreed between the requester and `Mailserver`.
+
+### Receiving historic messages
+
+Historic messages MUST be sent to a peer as a packet with a P2P Message code (`0x7f`)
+followed by an array of Whisper envelopes.
+It is incompatible with the original Whisper spec (EIP-627) because it allows only a single envelope,
+however, an array of envelopes is much more performant.
+In order to stay compatible with EIP-627, a peer receiving historic message MUST handle both cases.
+
+In order to receive historic messages from a `Mailserver`, a node MUST trust the selected `Mailserver`,
+that is allowed to send packets with the P2P Message code. By default, the node discards such packets.
+
+Received envelopes MUST be passed through the Whisper envelope pipelines
+so that they are picked up by registered filters and passed to subscribers.
+
+For a requester, to know that all messages have been sent by `Mailserver`,
+it SHOULD handle P2P Request Complete code (`0x7d`). This code is followed by the following parameters:
+
+```golang
+[ RequestID, LastEnvelopeHash, Cursor ]
+```
+
+`RequestID`: 32-byte wide array with a Keccak-256 hash of the envelope containing the original request  
+`LastEnvelopeHash`: 32-byte wide array with a Keccak-256 hash of the last sent envelope for the request  
+`Cursor`: an array of a cursor returned from the previous request (optional)
+
+If `Cursor` is not empty, it means that not all messages were sent due to the set `Limit` in the request.
+One or more consecutive requests MAY be sent with `Cursor` field filled in order to receive the rest of the messages.
+
+## Security considerations
+
+### Confidentiality
+
+The node encrypts all Whisper envelopes. A `Mailserver` node can not inspect their contents.
+
+### Altruistic and centralized operator risk
+
+In order to be useful, a `Mailserver` SHOULD be online most of the time. That means
+users either have to be a bit tech-savvy to run their own node, or rely on someone
+else to run it for them.
+
+Currently, one of Status's legal entities provides `Mailservers` in an altruistic manner, but this is
+suboptimal from a decentralization, continuance and risk point of view. Coming
+up with a better system for this is ongoing research.
+
+A Status client SHOULD allow the `Mailserver` selection to be customizable.
+
+### Privacy concerns
+
+In order to use a `Mailserver`, a given node needs to connect to it directly,
+i.e. add the `Mailserver` as its peer and mark it as trusted.
+This means that the `Mailserver` is able to send direct p2p messages to the node instead of broadcasting them.
+Effectively, it will have access to the bloom filter of topics
+that the user is interested in,
+when it is online as well as many metadata like IP address.
+
+### Denial-of-service
+
+Since a `Mailserver` is delivering expired envelopes and has a direct TCP connection with the recipient,
+the recipient is vulnerable to DoS attacks from a malicious `Mailserver` node.
+
+## Changelog
+
+### Version 0.3
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+- Change to keep `Mailserver` term consistent
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [Whisper](https://eips.ethereum.org/EIPS/eip-627)
+- [EIP-627](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-627.md)
+- [SECURE-TRANSPORT](/status/deprecated/secure-transport.md)
+- [`shh_generateSymKeyFromPassword`](https://github.com/ethereum/go-ethereum/wiki/Whisper-v6-RPC-API#shh_generatesymkeyfrompassword)
+- [Whisper v6](https://eips.ethereum.org/EIPS/eip-627)
+- [Waku V0](/waku/deprecated/5/waku0.md)
+- [Waku V1](/waku/standards/legacy/6/waku1.md)
+- [May 22, 2020 change commit](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)

status/deprecated/whisper-usage.md

@@ -0,0 +1,401 @@
+---
+title: WHISPER-USAGE
+name: Whisper Usage
+status: deprecated
+description: Status uses Whisper to provide privacy-preserving routing and messaging on top of devP2P.
+editor: Filip Dimitrijevic <filip@status.im>
+contributors:
+  - Adam Babik <adam@status.im>
+  - Andrea Piana <andreap@status.im>
+  - Corey Petty <corey@status.im>
+  - Oskar Thorén <oskar@status.im>
+---
+
+## Abstract
+
+Status uses [Whisper](https://eips.ethereum.org/EIPS/eip-627) to provide
+privacy-preserving routing and messaging on top of devP2P.
+Whisper uses topics to partition its messages,
+and these are leveraged for all chat capabilities.
+In the case of public chats, the channel name maps directly to its Whisper topic.
+This allows anyone to listen on a single channel.
+
+Additionally, since anyone can receive Whisper envelopes,
+it relies on the ability to decrypt messages to decide who is the correct recipient.
+Status nodes do not rely upon this property,
+and implement another secure transport layer on top of Whisper.
+
+Finally, using an extension of Whisper provides the ability to do offline messaging.
+
+## Reason
+
+Provide routing, metadata protection, topic-based multicasting and basic
+encryption properties to support asynchronous chat.
+
+## Terminology
+
+* *Whisper node*: an Ethereum node with Whisper V6 enabled (in the case of go-ethereum, it's `--shh` option)
+* *Whisper network*: a group of Whisper nodes connected together through the internet connection and forming a graph
+* *Message*: a decrypted Whisper message
+* *Offline message*: an archived envelope
+* *Envelope*: an encrypted message with metadata like topic and Time-To-Live
+
+## Whisper packets
+
+| Packet Name | Code | EIP-627 | References |
+| --- | --: | --- | --- |
+| Status | 0 | ✔ | [Handshake](#handshake) |
+| Messages | 1 | ✔ | [EIP-627](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-627.md) |
+| PoW Requirement | 2 | ✔ | [EIP-627](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-627.md) |
+| Bloom Filter | 3 | ✔ | [EIP-627](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-627.md) |
+| Batch Ack | 11 | 𝘅 | Undocumented |
+| Message Response | 12 | 𝘅 | Undocumented |
+| P2P Sync Request | 123 | 𝘅 | Undocumented |
+| P2P Sync Response | 124 | 𝘅 | Undocumented |
+| P2P Request Complete | 125 | 𝘅 | [4/WHISPER-MAILSERVER](/status/deprecated/whisper-mailserver.md) |
+| P2P Request | 126 | ✔ | [4/WHISPER-MAILSERVER](/status/deprecated/whisper-mailserver.md) |
+| P2P Messages | 127 | ✔/𝘅 (EIP-627 supports only single envelope in a packet) | [4/WHISPER-MAILSERVER](/status/deprecated/whisper-mailserver.md) |
+
+## Whisper node configuration
+
+A Whisper node must be properly configured to receive messages from Status clients.
+
+Nodes use Whisper's Proof Of Work algorithm to deter denial of service
+and various spam/flood attacks against the Whisper network.
+The sender of a message must perform some work which in this case means processing time.
+Because Status' main client is a mobile client, this easily leads to battery draining and poor performance of the app itself.
+Hence, all clients MUST use the following Whisper node settings:
+
+* proof-of-work requirement not larger than `0.002`
+* time-to-live not lower than `10` (in seconds)
+
+## Handshake
+
+Handshake is a RLP-encoded packet sent to a newly connected peer. It MUST start with a Status Code (`0x00`) and follow up with items:
+
+```golang
+[ protocolVersion, PoW, bloom, isLightNode, confirmationsEnabled, rateLimits ]
+```
+
+`protocolVersion`: version of the Whisper protocol
+`PoW`: minimum PoW accepted by the peer
+`bloom`: bloom filter of Whisper topic accepted by the peer
+`isLightNode`: when true, the peer won't forward messages
+`confirmationsEnabled`: when true, the peer will send message confirmations
+`rateLimits`: is `[ RateLimitIP, RateLimitPeerID, RateLimitTopic ]` where each values is an integer with a number of accepted packets per second per IP, Peer ID, and Topic respectively
+
+`bloom, isLightNode, confirmationsEnabled, and rateLimits` are all optional arguments in the handshake. However, if an optional field is specified, all optional fields preceding it MUST also be specified in order to be unambiguous.
+
+## Rate limiting
+
+In order to provide an optional very basic Denial-of-Service attack protection, each node SHOULD define its own rate limits.
+The rate limits SHOULD be applied on IPs, peer IDs, and envelope topics.
+
+Each node MAY decide to whitelist, i.e. do not rate limit, selected IPs or peer IDs.
+
+If a peer exceeds node's rate limits, the connection between them MAY be dropped.
+
+Each node SHOULD broadcast its rate limits to its peers using rate limits packet code (`0x14`). The rate limits is RLP-encoded information:
+
+```golang
+[ IP limits, PeerID limits, Topic limits ]
+```
+
+`IP limits`: 4-byte wide unsigned integer
+`PeerID limits`: 4-byte wide unsigned integer
+`Topic limits`: 4-byte wide unsigned integer
+
+The rate limits MAY also be sent as an optional parameter in the handshake.
+
+Each node SHOULD respect rate limits advertised by its peers.
+The number of packets SHOULD be throttled in order not to exceed peer's rate limits.
+If the limit gets exceeded, the connection MAY be dropped by the peer.
+
+## Keys management
+
+The protocol requires a key (symmetric or asymmetric) for the following actions:
+
+* signing & verifying messages (asymmetric key)
+* encrypting & decrypting messages (asymmetric or symmetric key).
+
+As nodes require asymmetric keys and symmetric keys to process incoming messages,
+they must be available all the time and are stored in memory.
+
+Keys management for PFS is described in [5/SECURE-TRANSPORT](/status/deprecated/whisper-mailserver.md).
+
+The Status protocols uses a few particular Whisper topics to achieve its goals.
+
+### Contact code topic
+
+Nodes use the contact code topic to facilitate the discovery of X3DH bundles so that the first message can be PFS-encrypted.
+
+Each user publishes periodically to this topic.
+If user A wants to contact user B, she SHOULD look for their bundle on this contact code topic.
+
+Contact code topic MUST be created following the algorithm below:
+
+```golang
+contactCode := "0x" + hexEncode(activePublicKey) + "-contact-code"
+
+var hash []byte = keccak256(contactCode)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+### Partitioned topic
+
+Whisper is broadcast-based protocol.
+In theory, everyone could communicate using a single topic but that would be extremely inefficient.
+Opposite would be using a unique topic for each conversation,
+however, this brings privacy concerns because it would be much easier to detect whether
+and when two parties have an active conversation.
+
+Nodes use partitioned topics to broadcast private messages efficiently.
+By selecting a number of topic, it is possible to balance efficiency and privacy.
+
+Currently, nodes set the number of partitioned topics to `5000`.
+They MUST be generated following the algorithm below:
+
+```golang
+var partitionsNum *big.Int = big.NewInt(5000)
+var partition *big.Int = big.NewInt(0).Mod(publicKey.X, partitionsNum)
+
+partitionTopic := "contact-discovery-" + strconv.FormatInt(partition.Int64(), 10)
+
+var hash []byte = keccak256(partitionTopic)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+### Public chats
+
+A public chat MUST use a topic derived from a public chat name following the algorithm below:
+
+```golang
+var hash []byte
+hash = keccak256(name)
+
+topicLen = 4
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+<!-- NOTE: commented out as it is currently not used.  In code for potential future use. - C.P. Oct 8, 2019
+### Personal discovery topic
+
+ Personal discovery topic is used to ???
+
+A client MUST implement it following the algorithm below:
+```golang
+personalDiscoveryTopic := "contact-discovery-" + hexEncode(publicKey)
+
+var hash []byte = keccak256(personalDiscoveryTopic)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+Each Status Client SHOULD listen to this topic in order to receive ??? -->
+
+<!-- NOTE: commented out as it is no longer valid as of V1. - C.P. Oct 8, 2019
+### Generic discovery topic
+
+Generic discovery topic is a legacy topic used to handle all one-to-one chats. The newer implementation should rely on [Partitioned Topic](#partitioned-topic) and [Personal discovery topic](#personal-discovery-topic).
+
+Generic discovery topic MUST be created following [Public chats](#public-chats) topic algorithm using string `contact-discovery` as a name. -->
+
+### Group chat topic
+
+Group chats does not have a dedicated topic.
+All group chat messages (including membership updates) are sent as one-to-one messages to multiple recipients.
+
+### Negotiated topic
+
+When a client sends a one to one message to another client, it MUST listen to their negotiated topic.
+This is computed by generating a diffie-hellman key exchange between two members
+and taking the first four bytes of the `SHA3-256` of the key generated.
+
+```golang
+
+sharedKey, err := ecies.ImportECDSA(myPrivateKey).GenerateShared(
+      ecies.ImportECDSAPublic(theirPublicKey),
+      16,
+      16,
+)
+
+
+hexEncodedKey := hex.EncodeToString(sharedKey)
+
+var hash []byte = keccak256(hexEncodedKey)
+var topicLen int = 4
+
+if len(hash) < topicLen {
+    topicLen = len(hash)
+}
+
+var topic [4]byte
+for i = 0; i < topicLen; i++ {
+    topic[i] = hash[i]
+}
+```
+
+A client SHOULD send to the negotiated topic only if it has received a message from all the devices included in the conversation.
+
+### Flow
+
+To exchange messages with client `B`, a client `A` SHOULD:
+
+* Listen to client's `B` Contact Code Topic to retrieve their bundle information, including a list of active devices
+* Send a message on client's `B` partitioned topic
+* Listen to the Negotiated Topic between `A` & `B`
+* Once client `A` receives a message from `B`, the Negotiated Topic SHOULD be used
+
+## Message encryption
+
+Even though, the protocol specifies an encryption layer that encrypts messages before passing them to the transport layer,
+Whisper protocol requires each Whisper message to be encrypted anyway.
+
+The node encrypts public and group messages using symmetric encryption, and creates the key from a channel name string.
+The implementation is available in [`shh_generateSymKeyFromPassword`](https://github.com/ethereum/go-ethereum/wiki/Whisper-v6-RPC-API#shh_generatesymkeyfrompassword) JSON-RPC method of go-ethereum Whisper implementation.
+
+The node encrypts one-to-one messages using asymmetric encryption.
+
+## Message confirmations
+
+Sending a message is a complex process where many things can go wrong.
+Message confirmations tell a node that a message originating from it has been seen by its direct peers.
+
+A node MAY send a message confirmation for any batch of messages received in a packet Messages Code (`0x01`).
+
+A node sends a message confirmation using Batch Acknowledge packet (`0x0b`) or Message Response packet (`0x0c`).
+
+The Batch Acknowledge packet is followed by a keccak256 hash of the envelopes batch data (raw bytes).
+
+The Message Response packet is more complex and is followed by a Versioned Message Response:
+
+```golang
+[ Version, Response]
+```
+
+`Version`: a version of the Message Response, equal to `1`,
+`Response`: `[ Hash, Errors ]` where `Hash` is a keccak256 hash of the envelopes batch data (raw bytes)
+for which the confirmation is sent and `Errors` is a list of envelope errors when processing the batch.
+A single error contains `[ Hash, Code, Description ]` where `Hash` is a hash of the processed envelope,
+`Code` is an error code and `Description` is a descriptive error message.
+
+The supported codes:
+`1`: means time sync error which happens when an envelope is too old
+or created in the future (the root cause is no time sync between nodes).
+
+The drawback of sending message confirmations is that it increases the noise in the network because for each sent message,
+one or more peers broadcast a corresponding confirmation.
+To limit that, both Batch Acknowledge packet (`0x0b`) and Message Response packet (`0x0c`) are not broadcast to peers of the peers,
+i.e. they do not follow epidemic spread.
+
+In the current Status network setup, only `Mailservers` support message confirmations.
+A client posting a message to the network and after receiving a confirmation can be sure that the message got processed by the `Mailserver`.
+If additionally, sending a message is limited to non-`Mailserver` peers,
+it also guarantees that the message got broadcast through the network and it reached the selected `Mailserver`.
+
+## Whisper / Waku bridging
+
+In order to maintain compatibility between Whisper and Waku nodes,
+a Status network that implements both Whisper and Waku messaging protocols
+MUST have at least one node that is capable of discovering peers and implements
+[Whisper v6](https://eips.ethereum.org/EIPS/eip-627),
+[Waku V0](/waku/deprecated/5/waku0.md) and
+[Waku V1](/waku/standards/legacy/6/waku1.md) specifications.
+
+Additionally, any Status network that implements both Whisper and Waku messaging protocols
+MUST implement bridging capabilities as detailed in
+[Waku V1#Bridging](/waku/standards/legacy/6/waku1.md#waku-whisper-bridging).  
+
+## Whisper V6 extensions
+
+### Request historic messages
+
+Sends a request for historic messages to a `Mailserver`.
+The `Mailserver` node MUST be a direct peer and MUST be marked as trusted (using `shh_markTrustedPeer`).
+
+The request does not wait for the response.
+It merely sends a peer-to-peer message to the `Mailserver`
+and it's up to `Mailserver` to process it and start sending historic messages.
+
+The drawback of this approach is that it is impossible to tell
+which historic messages are the result of which request.
+
+It's recommended to return messages from newest to oldest.
+To move further back in time, use `cursor` and `limit`.
+
+#### shhext_requestMessages
+
+**Parameters**:
+
+1. Object - The message request object:
+   * `mailServerPeer` - `String`: `Mailserver`'s enode address.
+   * `from` - `Number` (optional): Lower bound of time range as unix timestamp, default is 24 hours back from now.
+   * `to` - `Number` (optional): Upper bound of time range as unix timestamp, default is now.
+   * `limit` - `Number` (optional): Limit the number of messages sent back, default is no limit.
+   * `cursor` - `String` (optional): Used for paginated requests.
+   * `topics` - `Array`: hex-encoded message topics.
+   * `symKeyID` - `String`: an ID of a symmetric key used to authenticate with the `Mailserver`, derived from Mailserver password.
+
+**Returns**:
+`Boolean` - returns `true` if the request was sent.
+
+The above `topics` is then converted into a bloom filter and then and sent to the `Mailserver`.
+
+<!-- TODO: Clarify actual request with bloom filter to mailserver -->
+
+## Changelog
+
+### Version 0.3
+
+Released [May 22, 2020](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)
+
+* Added Whisper / Waku Bridging section
+* Change to keep `Mailserver` term consistent
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+* [Whisper](https://eips.ethereum.org/EIPS/eip-627)
+* [WHISPER-MAILSERVER](/status/deprecated/whisper-mailserver.md)
+* [SECURE-TRANSPORT](/status/deprecated/secure-transport.md)
+* [`shh_generateSymKeyFromPassword`](https://github.com/ethereum/go-ethereum/wiki/Whisper-v6-RPC-API#shh_generatesymkeyfrompassword)
+* [Whisper v6](https://eips.ethereum.org/EIPS/eip-627)
+* [Waku V0](/waku/deprecated/5/waku0.md)
+* [Waku V1](/waku/standards/legacy/6/waku1.md)
+* [May 22, 2020 change commit](https://github.com/status-im/specs/commit/664dd1c9df6ad409e4c007fefc8c8945b8d324e8)

vac/1/coss.md

@@ -40,7 +40,7 @@ Request For Comments specification process managed by the Vac service department
 
 ## License
 
-Copyright (c) 2008-24 the Editor and Contributors.
+Copyright (c) 2008-26 the Editor and Contributors.
 
 This Specification is free software;
 you can redistribute it and/or

vac/raw/consensus-hashgraphlike.md

@@ -0,0 +1,252 @@
+---
+title: HASHGRAPHLIKE CONSENSUS
+name: Hashgraphlike Consensus Protocol
+status: raw
+category: Standards Track
+tags: 
+editor: Ugur Sen [ugur@status.im](mailto:ugur@status.im)
+contributors: seemenkina [ekaterina@status.im](mailto:ekaterina@status.im)
+---
+## Abstract
+
+This document specifies a scalable, decentralized, and Byzantine Fault Tolerant (BFT)
+consensus mechanism inspired by Hashgraph, designed for binary decision-making in P2P networks.
+
+## Motivation
+
+Consensus is one of the essential components of decentralization.
+In particular, in the decentralized group messaging application is used for
+binary decision-making to govern the group.
+Therefore, each user contributes to the decision-making process.
+Besides achieving decentralization, the consensus mechanism MUST be strong:
+
+- Under the assumption of at least `2/3` honest users in the network.
+
+- Each user MUST conclude the same decision and scalability:
+message propagation in the network MUST occur within `O(log n)` rounds,
+where `n` is the total number of peers,
+in order to preserve the scalability of the messaging application.
+
+## Format Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
+“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document
+are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+## Flow
+
+Any user in the group initializes the consensus by creating a proposal.
+Next, the user broadcasts the proposal to the whole network.
+Upon each user receives the proposal, validates the proposal,
+adds its vote as yes or no and with its signature and timestamp.
+The user then sends the proposal and vote to a random peer in a P2P setup,
+or to a subscribed gossipsub channel if gossip-based messaging is used.
+Therefore, each user first validates the signature and then adds its new vote.
+Each sending message counts as a round.
+After `log(n)` rounds all users in the network have the others vote
+if at least `2/3` number of users are honest where honesty follows the protocol.
+
+In general, the voting-based consensus consists of the following phases:
+
+1. Initialization of voting
+2. Exchanging votes across the rounds
+3. Counting the votes
+
+### Assumptions
+
+- The users in the P2P network can discover the nodes or they are subscribing same channel in a gossipsub.
+- We MAY have non-reliable (silent) nodes.
+- Proposal owners MUST know the number of voters.
+
+## 1. Initialization of voting
+
+A user initializes the voting with the proposal payload which is
+implemented using [protocol buffers v3](https://protobuf.dev/) as follows:
+
+```bash
+syntax = "proto3";
+
+package vac.voting;
+
+message Proposal {
+  string name = 10;                  // Proposal name
+  string payload = 11;               // Proposal description
+  uint32 proposal_id = 12;           // Unique identifier of the proposal
+  bytes proposal_owner = 13;         // Public key of the creator 
+  repeated Votes = 14;               // Vote list in the proposal
+  uint32 expected_voters_count = 15; // Maximum number of distinct voters
+  uint32 round = 16;                 // Number of Votes 
+  uint64 timestamp = 17;             // Creation time of proposal
+  uint64 expiration_time = 18;       // The time interval that the proposal is active.  
+  bool liveness_criteria_yes = 19;   // Shows how managing the silent peers vote
+}
+
+message Vote {
+  uint32 vote_id = 20;            // Unique identifier of the vote
+  bytes vote_owner = 21;          // Voter's public key
+  uint32 proposal_id = 22;        // Linking votes and proposals
+  int64 timestamp = 23;           // Time when the vote was cast
+  bool vote = 24;                 // Vote bool value (true/false)
+  bytes parent_hash = 25;         // Hash of previous owner's Vote
+  bytes received_hash = 26;       // Hash of previous received Vote
+  bytes vote_hash = 27;           // Hash of all previously defined fields in Vote
+  bytes signature = 28;           // Signature of vote_hash
+}
+
+```
+
+To initiate a consensus for a proposal,
+a user MUST complete all the fields in the proposal, including attaching its `vote`
+and the `payload` that shows the purpose of the proposal.
+Notably, `parent_hash` and `received_hash` are empty strings because there is no previous or received hash.
+Then the initialization section ends when the user who creates the proposal sends it
+to the random peer from the network or sends it to the proposal to the specific channel.
+
+## 2. Exchanging votes across the peers
+
+Once the peer receives the proposal message `P_1` from a 1-1 or a gossipsub channel does the following checks:
+
+1. Check the signatures of the each votes in proposal, in particular for proposal `P_1`,
+verify the signature of `V_1` where `V_1 = P_1.votes[0]` with `V_1.signature` and `V_1.vote_owner`
+2. Do `parent_hash` check: If there are repeated votes from the same sender,
+check that the hash of the former vote is equal to the `parent_hash` of the later vote.
+3. Do `received_hash` check: If there are multiple votes in a proposal, check that the hash of a vote is equal to the `received_hash` of the next one.
+4. After successful verification of the signature and hashes, the receiving peer proceeds to generate `P_2` containing a new vote `V_2` as following:
+
+   4.1. Add its public key as `P_2.vote_owner`.
+
+   4.2. Set `timestamp`.
+
+   4.3. Set boolean `vote`.
+
+   4.4. Define `V_2.parent_hash = 0` if there is no previous peer's vote, otherwise hash of previous owner's vote.
+
+   4.5. Set `V_2.received_hash = hash(P_1.votes[0])`.
+  
+   4.6. Set `proposal_id` for the `vote`.
+  
+   4.7. Calculate `vote_hash` by hash of all previously defined fields in Vote:
+  `V_2.vote_hash = hash(vote_id, owner, proposal_id, timestamp, vote, parent_hash, received_hash)`
+
+   4.8. Sign `vote_hash` with its private key corresponding the public key as `vote_owner` component then adds `V_2.vote_hash`.
+
+5. Create `P_2` with by adding `V_2` as follows:
+  
+   5.1. Assign `P_2.name`, `P_2.proposal_id`, and `P_2.proposal_owner` to be identical to those in `P_1`.
+  
+   5.2. Add the `V_2` to the `P_2.Votes` list.
+  
+   5.3. Increase the round by one, namely `P_2.round = P_1.round + 1`.
+  
+   5.4. Verify that the proposal has not expired by checking that: `P_2.timestamp - current_time < P_1.expiration_time`.
+    If this does not hold, other peers ignore the message.
+
+After the peer creates the proposal `P_2` with its vote `V_2`,
+sends it to the random peer from the network or
+sends it to the proposal to the specific channel.
+
+## 3. Determining the result
+
+Because consensus depends on meeting a quorum threshold,
+each peer MUST verify the accumulated votes to determine whether the necessary conditions have been satisfied.
+The voting result is set YES if the majority of the `2n/3` from the distinct peers vote YES.
+
+To verify, the `findDistinctVoter` method processes the proposal by traversing its `Votes` list to determine the number of unique voters.
+
+If this method returns true, the peer proceeds with strong validation,
+which ensures that if any honest peer reaches a decision,
+no other honest peer can arrive at a conflicting result.
+
+1. Check each `signature` in the vote as shown in the [Section 2](#2-exchanging-votes-across-the-peers).
+
+2. Check the `parent_hash` chain if there are multiple votes from the same owner namely `vote_i` and `vote_i+1` respectively,
+the parent hash of `vote_i+1` should be the hash of `vote_i`
+
+3. Check the `previous_hash` chain, each received hash of `vote_i+1` should be equal to the hash of `vote_i`.
+
+4. Check the `timestamp` against the replay attack.
+In particular, the `timestamp` cannot be the old in the determined threshold.
+
+5. Check that the liveness criteria defined in the Liveness section are satisfied.
+
+If a proposal is verified by all the checks,
+the `countVote` method counts each YES vote from the list of Votes.
+
+## 4. Properties
+
+The consensus mechanism satisfies liveness and security properties as follows:
+
+### Liveness
+
+Liveness refers to the ability of the protocol to eventually reach a decision when sufficient honest participation is present.
+In this protocol, if `n > 2` and more than `n/2` of the votes among at least `2n/3` distinct peers are YES,
+then the consensus result is defined as YES; otherwise, when `n ≤ 2`, unanimous agreement (100% YES votes) is required.
+
+The peer calculates the result locally as shown in the [Section 3](#3-determining-the-result).
+From the [hashgraph property](https://hedera.com/learning/hedera-hashgraph/what-is-hashgraph-consensus),
+if a node could calculate the result of a proposal,
+it implies that no peer can calculate the opposite of the result.
+Still, reliability issues can cause some situations where peers cannot receive enough messages,
+so they cannot calculate the consensus result.
+
+Rounds are incremented when a peer adds and sends the new proposal.
+Calculating the required number of rounds, `2n/3` from the distinct peers' votes is achieved in two ways:
+
+1. `2n/3` rounds in pure P2P networks
+2. `2` rounds in gossipsub
+
+Since the message complexity is `O(1)` in the gossipsub channel,
+in case the network has reliability issues,
+the second round is used for the peers cannot receive all the messages from the first round.
+
+If an honest and online peer has received at least one vote but not enough to reach consensus,
+it MAY continue to propagate its own vote — and any votes it has received — to support message dissemination.
+This process can continue beyond the expected round count,
+as long as it remains within the expiration time defined in the proposal.
+The expiration time acts as a soft upper bound to ensure that consensus is either reached or aborted within a bounded timeframe.
+
+#### Equality of votes
+
+An equality of votes occurs when verifying at least `2n/3` distinct voters and
+applying `liveness_criteria_yes` the number of YES and NO votes is equal.
+
+Handling ties is an application-level decision. The application MUST define a deterministic tie policy:
+
+RETRY: re-run the vote with a new proposal_id, optionally adjusting parameters.
+
+REJECT: abort the proposal and return voting result as NO.
+
+The chosen policy SHOULD be consistent for all peers via proposal's `payload` to ensure convergence on the same outcome.
+
+### Silent Node Management
+
+Silent nodes are the nodes that not participate the voting as YES or NO.
+There are two possible counting votes for the silent peers.
+
+1. **Silent peers means YES:**
+Silent peers counted as YES vote, if the application prefer the strong rejection for NO votes.
+2. **Silent peers means NO:**
+Silent peers counted as NO vote, if the application prefer the strong acception for NO votes.
+
+The proposal is set to default true, which means silent peers' votes are counted as YES namely `liveness_criteria_yes` is set true by default.
+
+### Security
+
+This RFC uses cryptographic primitives to prevent the
+malicious behaviours as follows:
+
+- Vote forgery attempt: creating unsigned invalid votes
+- Inconsistent voting: a malicious peer submits conflicting votes (e.g., YES to some peers and NO to others)
+in different stages of the protocol, violating vote consistency and attempting to undermine consensus.
+- Integrity breaking attempt: tampering history by changing previous votes.
+- Replay attack: storing the old votes to maliciously use in fresh voting.
+
+## 5. Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+## 6. References
+
+- [Hedera Hashgraph](https://hedera.com/learning/hedera-hashgraph/what-is-hashgraph-consensus)
+- [Gossip about gossip](https://docs.hedera.com/hedera/core-concepts/hashgraph-consensus-algorithms/gossip-about-gossip)
+- [Simple implementation of hashgraph consensus](https://github.com/conanwu777/hashgraph)

vac/raw/decentralized-messaging-ethereum.md

@@ -1,5 +1,5 @@
 ---
-title: VAC-DECENTRALIZED-MESSAGING-ETHEREUM
+title: ETH-DCGKA
 name: Decentralized Key and Session Setup for Secure Messaging over Ethereum
 status: raw
 category: informational

vac/raw/deleted/eth-secpm.md

@@ -1,13 +1,19 @@
 ---
 title: ETH-SECPM
 name: Secure channel setup using Ethereum accounts
-status: raw
+status: deleted
 category: Standards Track
 tags:
 editor: Ramses Fernandez <ramses@status.im>
 contributors:
 ---
 
+## NOTE
+
+The content of this specification has been split between
+[ETH-DEMLS](vac/raw/eth-demls.md) and [NOISE-X3DH-RATCHET](vac/raw/noise-x3dh-ratchet.md)
+RFCs.
+
 ## Motivation
 
 The need for secure communications has become paramount.  
@@ -416,7 +422,7 @@ Credentials MUST follow the specifications of section 5.3 of
 
 Below follows the flow diagram for the generation of credentials.
 Users MUST generate key pairs by themselves.
-![figure1](./images/eth-secpm_credential.png)
+![figure1](/vac/raw/images/eth-secpm_credential.png)
 
 ### Message framing
 
@@ -759,10 +765,10 @@ CredentialType credential_types<V>;
 
 The flow diagram shows the procedure to fetch key material from other
 users:
-![figure2](./images/eth-secpm_fetching.png)
+![figure2](/vac/raw/images/eth-secpm_fetching.png)
 
 Below follows the flow diagram for the creation of a group:
-![figure3](./images/eth-secpm_creation.png)
+![figure3](/vac/raw/images/eth-secpm_creation.png)
 
 ### Group evolution
 
@@ -837,15 +843,15 @@ The client MUST apply the proposals in the list in the order described
 in Section 12.3 of [RFC9420](https://datatracker.ietf.org/docrfc9420/).
 
 Below follows the flow diagram for the addition of a member to a group:
-![figure4](./images/eth-secpm_add.png)
+![figure4](/vac/raw/images/eth-secpm_add.png)
 
 The diagram below shows the procedure to remove a group member:
 
-![figure5](./images/eth-secpm_remove.png)
+![figure5](/vac/raw/images/eth-secpm_remove.png)
 
 The flow diagram below shows an update procedure:
 
-![figure6](./images/eth-secpm_update.png)
+![figure6](/vac/raw/images/eth-secpm_update.png)
 
 ### Commit messages
 
@@ -1287,7 +1293,7 @@ and checks that it corresponds to an address contained in the ACL.
 7. Off-chain - Alice sends a welcome message to Bob.
 8. Off-chain - Alice SHOULD broadcasts a message announcing the
 addition of Bob to other users of the group.
-![figure7](./images/eth-secpm_onchain-register-1.png)
+![figure7](/vac/raw/images/eth-secpm_onchain-register-1.png)
 
 #### Alice does not know Bob’s Ethereum address
 
@@ -1310,7 +1316,7 @@ contract.
 8. Off-chain - Alice SHOULD broadcasts a message announcing the
 addition of Bob to other users of the group.
 
-![figure8](./images/eth-secpm_onchain-register-2.png)
+![figure8](/vac/raw/images/eth-secpm_onchain-register-2.png)
 
 ### Considerations regarding smart contracts
 
@@ -1330,7 +1336,7 @@ off-chain message.
   - The creator of the contract MUST update the ACL, and send
 messages to the group for key update.
 
-![figure9](./images/eth-secpm_onchain-update.png)
+![figure9](/vac/raw/images/eth-secpm_onchain-update.png)
 
 > It is important to note that both
 user removal and updates of any kind

vac/raw/eth-mls-offchain.md

@@ -0,0 +1,436 @@
+---
+title: ETH-MLS-OFFCHAIN
+name: Secure channel setup using decentralized MLS and Ethereum accounts
+status: raw
+category: Standards Track
+tags:
+editor: Ugur Sen [ugur@status.im](mailto:ugur@status.im)
+contributors: seemenkina [ekaterina@status.im](mailto:ekaterina@status.im)
+
+---
+
+## Abstract
+
+The following document specifies Ethereum authenticated scalable
+and decentralized secure group messaging application by
+integrating Message Layer Security (MLS) backend.
+Decentralization refers each user is a node in P2P network and
+each user has voice for any changes in group.
+This is achieved by integrating a consensus mechanism.
+Lastly, this RFC can also be referred to as de-MLS,
+decentralized MLS, to emphasize its deviation
+from the centralized trust assumptions of traditional MLS deployments.
+
+## Motivation
+
+Group messaging is a fundamental part of digital communication,
+yet most existing systems depend on centralized servers,
+which introduce risks around privacy, censorship, and unilateral control.
+In restrictive settings, servers can be blocked or surveilled;
+in more open environments, users still face opaque moderation policies,
+data collection, and exclusion from decision-making processes.
+To address this, we propose a decentralized, scalable peer-to-peer
+group messaging system where each participant runs a node, contributes
+to message propagation, and takes part in governance autonomously.
+Group membership changes are decided collectively through a lightweight
+partially synchronous, fault-tolerant consensus protocol without a centralized identity.
+This design enables truly democratic group communication and is well-suited
+for use cases like activist collectives, research collaborations, DAOs, support groups,
+and decentralized social platforms.
+
+## Format Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
+“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document
+are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+### Assumptions
+
+- The nodes in the P2P network can discover other nodes or will connect to other nodes when subscribing to same topic in a gossipsub.
+- We MAY have non-reliable (silent) nodes.
+- We MUST have a consensus that is lightweight, scalable and finalized in a specific time.
+
+## Roles
+
+The three roles used in de-MLS is as follows:
+
+- `node`: Nodes are participants in the network that are not currently members
+of any secure group messaging session but remain available as potential candidates for group membership.
+- `member`: Members are special nodes in the secure group messaging who
+obtains current group key of secure group messaging.
+Each node is assigned a unique identity represented as a 20-byte value named `member id`.
+- `steward`: Stewards are special and transparent members in the secure group
+messaging who organize the changes by releasing commit messages upon the voted proposals.
+There are two special subsets of steward as epoch and backup steward,
+which are defined in the section de-MLS Objects.
+
+## MLS Background
+
+The de-MLS consists of MLS backend, so the MLS services and other MLS components
+are taken from the original [MLS specification](https://datatracker.ietf.org/doc/rfc9420/), with or without modifications.
+
+### MLS Services
+
+MLS is operated in two services authentication service (AS) and delivery service (DS).
+Authentication service enables group members to authenticate the credentials presented by other group members.
+The delivery service routes MLS messages among the nodes or
+members in the protocol in the correct order and
+manage the `keyPackage` of the users where the `keyPackage` is the objects
+ that provide some public information about a user.
+
+### MLS Objects
+
+Following section presents the MLS objects and components that used in this RFC:
+
+`Epoch`: Time intervals that changes the state that is defined by members,
+section 3.4 in [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/).
+
+`MLS proposal message:` Members MUST receive the proposal message prior to the
+corresponding commit message that initiates a new epoch with key changes,
+in order to ensure the intended security properties, section 12.1 in [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/).
+Here, the add and remove proposals are used.
+
+`Application message`: This message type used in arbitrary encrypted communication between group members.
+This is restricted by [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/) as if there is pending proposal,
+the application message should be cut.
+Note that: Since the MLS is based on servers, this delay between proposal and commit messages are very small.
+
+`Commit message:` After members receive the proposals regarding group changes,
+the committer, who may be any member of the group, as specified in  [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/),
+generates the necessary key material for the next epoch, including the appropriate welcome messages
+for new joiners and new entropy for removed members. In this RFC, the committers only MUST be stewards.
+
+### de-MLS Objects
+
+This section presents the de-MLS objects:
+
+`Voting proposal`: Similar to MLS proposals, but processed only if approved through a voting process.
+They function as application messages in the MLS group,
+allowing the steward to collect them without halting the protocol.
+There are three types of `voting proposal` according to the type of consensus as in shown Consensus Types section,
+these are, `commit proposal`, `steward election proposal` and `emergency criteria proposal`.
+
+`Epoch steward`: The steward assigned to commit in `epoch E` according to the steward list.
+Holds the primary responsibility for creating commit in that epoch.
+
+`Backup steward`: The steward next in line after the `epoch steward` on the `steward list` in `epoch E`.
+Only becomes active if the `epoch steward` is malicious or fails,
+in which case it completes the commitment phase.
+If unused in `epoch E`, it automatically becomes the `epoch steward` in `epoch E+1`.
+
+`Steward list`: It is an ordered list that contains the `member id`s of authorized stewards.
+Each steward in the list becomes main responsible for creating the commit message when its turn arrives,
+according to this order for each epoch.
+For example, suppose there are two stewards in the list `steward A` first and `steward B` last in the list.
+`steward A` is responsible for creating the commit message for first epoch.
+Similarly, `steward B` is for the last epoch.
+Since the `epoch steward` is the primary committer for an epoch,
+it holds the main responsibility for producing the commit.
+However, other stewards MAY also generate a commit within the same epoch to preserve liveness
+in case the epoch steward is inactive or slow.
+Duplicate commits are not re-applied and only the single valid commit for the epoch is accepted by the group,
+as in described in section filtering proposals against the multiple comitting.
+
+Therefore, if a malicious steward occurred, the `backup steward` will be charged with committing.
+Lastly, the size of the list named as `sn`, which also shows the epoch interval for steward list determination.
+
+## Flow
+
+General flow is as follows:
+
+- A steward initializes a group just once, and then sends out Group Announcements (GA) periodically.
+- Meanwhile, each `node` creates and sends their `credential` includes `keyPackage`.
+- Each `member` creates `voting proposals` sends them to from MLS group during `epoch E`.
+- Meanwhile, the `steward` collects finalized `voting proposals` from MLS group and converts them into
+`MLS proposals` then sends them with corresponding `commit messages`
+- Evantually, with the commit messages, all members starts the next `epoch E+1`.
+
+## Creating Voting Proposal
+
+A `member` MAY initializes the voting with the proposal payload
+which is implemented using [protocol buffers v3](https://protobuf.dev/) as follows:
+
+```protobuf
+
+syntax = "proto3";
+
+message Proposal {
+string name = 10;                 // Proposal name
+string payload = 11;              // Describes the what is voting fore 
+int32 proposal_id = 12;           // Unique identifier of the proposal
+bytes proposal_owner = 13;        // Public key of the creator
+repeated Vote votes = 14;         // Vote list in the proposal
+int32 expected_voters_count = 15; // Maximum number of distinct voters
+int32 round = 16;                 // Number of Votes
+int64 timestamp = 17;             // Creation time of proposal
+int64 expiration_time = 18;       // Time interval that the proposal is active
+bool liveness_criteria_yes = 19;  // Shows how managing the silent peers vote
+}
+```
+
+```bash
+message Vote {
+int32 vote_id = 20;             // Unique identifier of the vote
+bytes vote_owner = 21;          // Voter's public key
+int64 timestamp = 22;           // Time when the vote was cast
+bool vote = 23;                 // Vote bool value (true/false)
+bytes parent_hash = 24;         // Hash of previous owner's Vote
+bytes received_hash = 25;       // Hash of previous received Vote
+bytes vote_hash = 26;           // Hash of all previously defined fields in Vote
+bytes signature = 27;           // Signature of vote_hash
+}
+```
+
+The voting proposal MAY include adding a `node` or removing a `member`.
+After the `member` creates the voting proposal,
+it is emitted to the network via the MLS `Application message` with a lightweight,
+epoch based voting such as [hashgraphlike consensus.](https://github.com/vacp2p/rfc-index/blob/consensus-hashgraph-like/vac/raw/consensus-hashgraphlike.md)
+This consensus result MUST be finalized within the epoch as YES or NO.
+
+If the voting result is YES, this points out the voting proposal will be converted into
+the MLS proposal by the `steward` and following commit message that starts the new epoch.
+
+## Creating welcome message
+
+When a MLS `MLS proposal message` is created by the `steward`,
+a `commit message` SHOULD follow,
+as in section 12.04 [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/) to the members.
+In order for the new `member` joining the group to synchronize with the current members
+who received the `commit message`,
+the `steward` sends a welcome message to the node as the new `member`,
+as in section 12.4.3.1. [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/).
+
+## Single steward
+
+To naive way to create a decentralized secure group messaging is having a single transparent `steward`
+who only applies the changes regarding the result of the voting.
+
+This is mostly similar with the general flow and specified in voting proposal and welcome message creation sections.
+
+1. Each time a single `steward` initializes a group with group parameters with parameters
+as in section 8.1. Group Context in [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/).
+2. `steward` creates a group anouncement (GA) according to the previous step and
+broadcast it to the all network periodically. GA message is visible in network to all `nodes`.
+3. The each `node` who wants to be a `member` needs to obtain this anouncement and create `credential`
+includes `keyPackage` that is specified in [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/) section 10.
+4. The `node` send the `KeyPackages` in plaintext with its signature with current `steward` public key which
+anounced in welcome topic. This step is crucial for security, ensuring that malicious nodes/stewards
+cannot use others' `KeyPackages`.
+It also provides flexibility for liveness in multi-steward settings,
+allowing more than one steward to obtain `KeyPackages` to commit.
+5. The `steward` aggregates all `KeyPackages` utilizes them to provision group additions for new members,
+based on the outcome of the voting process.
+6. Any `member` start to create `voting proposals` for adding or removing users,
+and present them to the voting in the MLS group as an application message.
+
+However, unlimited use of `voting proposals` within the group may be misused by
+malicious or overly active members.
+Therefore, an application-level constraint can be introduced to limit the number
+or frequency of proposals initiated by each member to prevent spam or abuse.
+7. Meanwhile, the `steward` collects finalized `voting proposals` with in epoch `E`,
+that have received affirmative votes from members via application messages.
+Otherwise, the `steward` discards proposals that did not receive a majority of "YES" votes.
+Since voting proposals are transmitted as application messages, omitting them does not affect
+the protocol’s correctness or consistency.
+8. The `steward` converts all approved `voting proposals` into
+corresponding `MLS proposals` and `commit message`, and
+transmits both in a single operation as in [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/) section 12.4,
+including welcome messages for the new members.
+Therefore, the `commit message` ends the previous epoch and create new ones.
+9. The `members` applied the incoming `commit message` by checking the signatures and `voting proposals`
+and synchronized with the upcoming epoch.
+
+## Multi stewards
+
+Decentralization has already been achieved in the previous section.
+However, to improve availability and ensure censorship resistance,
+the single steward protocol is extended to a multi steward architecture.
+In this design, each epoch is coordinated by a designated steward,
+operating under the same protocol as the single steward model.
+Thus, the multi steward approach primarily defines how steward roles
+rotate across epochs while preserving the underlying structure and logic of the original protocol.
+Two variants of the multi steward design are introduced to address different system requirements.
+
+### Consensus Types
+
+Consensus is agnostic with its payload; therefore, it can be used for various purposes.
+Note that each message for the consensus of proposals is an `application message` in the MLS object section.
+It is used in three ways as follows:
+
+1. `Commit proposal`:  It is the proposal instance that is specified in Creating Voting Proposal section
+with `Proposal.payload` MUST show the commit request from `members`.
+Any member MAY create this proposal in any epoch and `epoch steward` MUST collect and commit YES voted proposals.
+This is the only proposal type common to both single steward and multi steward designs.
+2. `Steward election proposal`: This is the process that finalizes the `steward list`,
+which sets and orders stewards responsible for creating commits over a predefined number of range in (`sn_min`,`sn_max`).
+The validity of the choosen `steward list` ends when the last steward in the list (the one at the final index) completes its commit.
+At that point, a new `steward election proposal` MUST be initiated again by any member during the corresponding epoch.
+The `Proposal.payload` field MUST represent the ordered identities of the proposed stewards.
+Each steward election proposal MUST be verified and finalized through the consensus process
+so that members can identify which steward will be responsible in each epoch
+and detect any unauthorized steward commits.
+3. `Emergency criteria proposal`: If there is a malicious member or steward,
+this event MUST be voted on to finalize it.
+If this returns YES, the next epoch MUST include the removal of the member or steward.
+In a specific case where a steward is removed from the group, causing the total number of stewards to fall below `sn_min`,  
+it is required to repeat the `steward election proposal`.
+`Proposal.payload` MUST consist of the evidence of the dishonesty as described in the Steward violation list,
+and the identifier of the malicious member or steward.
+This proposal can be created by any member in any epoch.
+
+The order of consensus proposal messages is important to achieving a consistent result.
+Therefore, messages MUST be prioritized by type in the following order, from highest to lowest priority:
+
+- `Emergency criteria proposal`
+
+- `Steward election proposal`
+
+- `Commit proposal`
+
+This means that if a higher-priority consensus proposal is present in the network,
+lower-priority messages MUST be withheld from transmission until the higher-priority proposals have been finalized.
+
+### Steward list creation
+
+The `steward list` consists of steward nominees who will become actual stewards if the `steward election proposal` is finalized with YES,
+is arbitrarily chosen from `member` and OPTIONALLY adjusted depending on the needs of the implementation.
+The `steward list` size, defined by the minimum `sn_min` and maximum `sn_max` bounds,
+is determined at the time of group creation.
+The `sn_min` requirement is applied only when the total number of members exceeds `sn_min`;
+if the number of available members falls below this threshold,
+the list size automatically adjusts to include all existing members.
+
+The actual size of the list MAY vary within this range as `sn`, with the minimum value being at least 1.
+
+The index of the slots shows epoch info and value of index shows `member id`s.
+The next in line steward for the `epoch E` is named as `epoch steward`, which has index E.
+And the subsequent steward in the `epoch E` is named as the `backup steward`.
+For example, let's assume steward list is (S3, S2, S1) if in the previous epoch the roles were
+(`backup steward`: S2, `epoch steward`: S1), then in the next epoch they become
+(`backup steward`: S3, `epoch steward`: S2) by shifting.
+
+If the `epoch steward` is honest, the `backup steward` does not involve the process in epoch,
+and the `backup steward` will be the `epoch steward` within the `epoch E+1`.
+
+If the `epoch steward` is malicious, the `backup steward` is involved in the commitment phase in `epoch E`
+and the former steward becomes the `backup steward` in `epoch E`.
+
+Liveness criteria:
+
+Once the active `steward list` has completed its assigned epochs,
+
+members MUST proceed to elect the next set of stewards
+(which MAY include some or all of the previous members).
+This election is conducted through a type 2 consensus procedure, `steward election proposal`.
+
+A `Steward election proposal` is considered valid only if the resulting `steward list`
+is produced through a deterministic process that ensures an unbiased distribution of steward assignments,
+since allowing bias could enable a malicious participant to manipulate the list
+and retain control within a favored group for multiple epochs.
+
+The list MUST consist of at least `sn_min` members, including retained previous stewards,
+sorted according to the ascending value of `SHA256(epoch E || member id || group id)`,
+where `epoch E` is the epoch in which the election proposal is initiated,
+and `group id` for shuffling the list across the different groups.
+Any proposal with a list that does not adhere to this generation method MUST be rejected by all members.
+
+We assume that there are no recurring entries in `SHA256(epoch E || member id || group id)`, since the SHA256 outputs are unique
+when there is no repetition in the `member id` values, against the conflicts on sorting issues.
+
+### Multi steward with big consensuses
+
+In this model, all group modifications, such as adding or removing members,
+must be approved through consensus by all participants,
+including the steward assigned for `epoch E`.
+A configuration with multiple stewards operating under a shared consensus protocol offers
+increased decentralization and stronger protection against censorship.
+However, this benefit comes with reduced operational efficiency.
+The model is therefore best suited for small groups that value
+decentralization and censorship resistance more than performance.
+
+To create a multi steward with a big consensus,
+the group is initialized with a single steward as specified as follows:
+
+1. The steward initialized the group with the config file.
+This config file MUST contain (`sn_min`,`sn_max`) as the `steward list` size range.
+2. The steward adds the members as a centralized way till the number of members reaches the `sn_min`.
+Then, members propose lists by voting proposal with size `sn`
+as a consensus among all members, as mentioned in the consensus section 2, according to the checks:
+the size of the proposed list `sn` is in the interval (`sn_min`,`sn_max`).
+Note that if the total number of members is below `sn_min`,
+then the steward list size MUST be equal to the total member count.
+3. After the voting proposal ends up with a `steward list`,
+and group changes are ready to be committed as specified in single steward section
+with a difference which is members also check the committed steward is `epoch steward` or `backup steward`,
+otherwise anyone can create `emergency criteria proposal`.
+4. If the `epoch steward` violates the changing process as mentioned in the section Steward violation list,
+one of the members MUST initialize the `emergency criteria proposal` to remove the malicious Steward.
+Then `backup steward` fulfills the epoch by committing again correctly.
+
+A large consensus group provides better decentralization, but it requires significant coordination,
+which MAY not be suitable for groups with more than 1000 members.
+
+### Multi steward with small consensuses
+
+The small consensus model offers improved efficiency with a trade-off in decentralization.
+In this design, group changes require consensus only among the stewards, rather than all members.
+Regular members participate by periodically selecting the stewards by `steward election proposal`
+but do not take part in commit decision by `commit proposal`.
+This structure enables faster coordination since consensus is achieved within a smaller group of stewards.
+It is particularly suitable for large user groups, where involving every member in each decision would be impractical.
+
+The flow is similar to the big consensus including the `steward list` finalization with all members consensus
+only the difference here, the commit messages requires `commit proposal` only among the stewards.
+
+## Filtering proposals against the multiple comitting
+
+Since stewards are allowed to produce a commit even when they are not the designated `epoch steward`,
+multiple commits may appear within the same epoch, often reflecting recurring versions of the same proposal.
+To ensure a consistent outcome, the valid commit for the epoch SHOULD be selected as the one derived
+from the longest proposal chain, ordered by the ascending value of each proposal as `SHA256(proposal)`.
+All other cases, such as invalid commits or commits based on proposals that were not approved through voting,
+can be easily detected and discarded by the members.
+
+## Steward violation list
+
+A steward’s activity is called a violation if the action is one or more of the following:
+
+1. Broken commit: The steward releases a different commit message from the voted `commit proposal`.
+This activity is identified by the `members` since the [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/) provides the methods
+that members can use to identify the broken commit messages that are possible in a few situations,
+such as commit and proposal incompatibility. Specifically, the broken commit can arise as follows:
+    1. The commit belongs to the earlier epoch.
+    2. The commit message should equal the latest epoch
+    3. The commit needs to be compatible with the previous epoch’s `MLS proposal`.
+2. Broken MLS proposal: The steward prepares a different `MLS proposal` for the corresponding `voting proposal`.
+This activity is identified by the `members` since both `MLS proposal` and `voting proposal` are visible
+and can be identified by checking the hash of `Proposal.payload` and `MLSProposal.payload` is the same as RFC9240 section 12.1. Proposals.
+3. Censorship and inactivity: The situation where there is a voting proposal that is visible for every member,
+and the Steward does not provide an MLS proposal and commit.
+This activity is again identified by the `members`since `voting proposals` are visible to every member in the group,
+therefore each member can verify that there is no `MLS proposal` corresponding to `voting proposal`.
+
+## Security Considerations
+
+In this section, the security considerations are shown as de-MLS assurance.
+
+1. Malicious Steward: A Malicious steward can act maliciously,
+as in the Steward violation list section.
+Therefore, de-MLS enforces that any steward only follows the protocol under the consensus order
+and commits without emergency criteria application.
+2. Malicious Member: A member is only marked as malicious
+when the member acts by releasing a commit message.
+3. Steward list election bias: Although SHA256 is used together with two global variables
+to shuffle stewards in a deterministic and verifiable manner,
+this approach only minimizes election bias; it does not completely eliminate it.
+This design choice is intentional, in order to preserve the efficiency advantages provided by the MLS mechanism.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+### References
+
+- [MLS RFC 9420](https://datatracker.ietf.org/doc/rfc9420/)
+- [Hashgraphlike Consensus](https://github.com/vacp2p/rfc-index/blob/consensus-hashgraph-like/vac/raw/consensus-hashgraphlike.md)
+- [vacp2p/de-mls](https://github.com/vacp2p/de-mls)

vac/raw/eth-mls-onchain.md

@@ -1,5 +1,5 @@
 ---
-title: ETH-DEMLS
+title: ETH-MLS-ONCHAIN
 name: Secure channel setup using decentralized MLS and Ethereum accounts
 status: raw
 category: Standards Track

vac/raw/noise-x3dh-double-ratchet.md

@@ -1,5 +1,5 @@
 ---
-title: ETH-SECURE-CHANNEL
+title: NOISE-X3DH-DOUBLE-RATCHET
 name: Secure 1-to-1 channel setup using X3DH and the double ratchet
 status: raw
 category: Standards Track

vac/raw/sds.md

@@ -55,6 +55,12 @@ but improves scalability by reducing direct interactions between participants.
 Each message has a globally unique, immutable ID (or hash).
 Messages can be requested from the high-availability caches or
 other participants using the corresponding message ID.
+* **Participant ID:**
+Each participant has a globally unique, immutable ID
+visible to other participants in the communication.
+* **Sender ID:**
+The **Participant ID** of the original sender of a message,
+often coupled with a **Message ID**.
 
 ## Wire protocol
 
@@ -72,20 +78,26 @@ syntax = "proto3";
 message HistoryEntry {
   string message_id = 1; // Unique identifier of the SDS message, as defined in `Message`
   optional bytes retrieval_hint = 2; // Optional information to help remote parties retrieve this SDS message; For example, A Waku deterministic message hash or routing payload hash
+
+  optional string sender_id = 3; // Participant ID of original message sender. Only populated if using optional SDS Repair extension
 }
 
 message Message {
-  // 1 Reserved for sender/participant id
+  string sender_id = 1;           // Participant ID of the message sender
   string message_id = 2;          // Unique identifier of the message
   string channel_id = 3;          // Identifier of the channel to which the message belongs
-  optional int32 lamport_timestamp = 10;    // Logical timestamp for causal ordering in channel
+  optional uint64 lamport_timestamp = 10;    // Logical timestamp for causal ordering in channel
   repeated HistoryEntry causal_history = 11;  // List of preceding message IDs that this message causally depends on. Generally 2 or 3 message IDs are included.
   optional bytes bloom_filter = 12;         // Bloom filter representing received message IDs in channel
+
+  repeated HistoryEntry repair_request = 13; // Capped list of history entries missing from sender's causal history. Only populated if using the optional SDS Repair extension.
+
   optional bytes content = 20;             // Actual content of the message
 }
 ```
 
-Each message MUST include its globally unique identifier in the `message_id` field,
+The sending participant MUST include its own globally unique identifier in the `sender_id` field.
+In addition, it MUST include a globally unique identifier for the message in the `message_id` field,
 likely based on a message hash.
 The `channel_id` field MUST be set to the identifier of the channel of group communication
 that is being synchronized.
@@ -98,12 +110,22 @@ These fields MAY be left unset in the case of [ephemeral messages](#ephemeral-me
 The message `content` MAY be left empty for [periodic sync messages](#periodic-sync-message),
 otherwise it MUST contain the application-level content
 
+> **_Note:_** Close readers may notice that,
+outside of filtering messages originating from the sender itself,
+the `sender_id` field is not used for much.
+Its importance is expected to increase once a p2p retrieval mechanism is added to SDS,
+as is planned for the protocol.
+
 ### Participant state
 
 Each participant MUST maintain:
 
 * A Lamport timestamp for each channel of communication,
-initialized to current epoch time in nanosecond resolution.
+initialized to current epoch time in millisecond resolution.
+The Lamport timestamp is increased as described in the [protocol steps](#protocol-steps)
+to maintain a logical ordering of events while staying close to the current epoch time.
+This allows the messages from new joiners to be correctly ordered with other recent messages,
+without these new participants first having to synchronize past messages to discover the current Lamport timestamp.
 * A bloom filter for received message IDs per channel.
 The bloom filter SHOULD be rolled over and
 recomputed once it reaches a predefined capacity of message IDs.
@@ -136,8 +158,11 @@ the `lamport_timestamp`, `causal_history` and `bloom_filter` fields.
 
 Before broadcasting a message:
 
-* the participant MUST increase its local Lamport timestamp by `1` and
-include this in the `lamport_timestamp` field.
+* the participant MUST set its local Lamport timestamp
+to the maximum between the current value + `1`
+and the current epoch time in milliseconds.
+In other words the local Lamport timestamp is set to `max(timeNowInMs, current_lamport_timestamp + 1)`.
+* the participant MUST include the increased Lamport timestamp in the message's `lamport_timestamp` field.
 * the participant MUST determine the preceding few message IDs in the local history
 and include these in an ordered list in the `causal_history` field.
 The number of message IDs to include in the `causal_history` depends on the application.
@@ -157,6 +182,8 @@ of unacknowledged outgoing messages.
 
 Upon receiving a message,
 
+* the participant SHOULD ignore the message if it has a `sender_id` matching its own.
+* the participant MAY deduplicate the message by comparing its `message_id` to previously received message IDs.
 * the participant MUST [review the ACK status](#review-ack-status) of messages
 in its unacknowledged outgoing buffer
 using the received message's causal history and bloom filter.
@@ -240,7 +267,8 @@ participants SHOULD periodically send sync messages to maintain state.
 These sync messages:
 
 * MUST be sent with empty content
-* MUST include an incremented Lamport timestamp
+* MUST include a Lamport timestamp increased to `max(timeNowInMs, current_lamport_timestamp + 1)`,
+where `timeNowInMs` is the current epoch time in milliseconds.
 * MUST include causal history and bloom filter according to regular message rules
 * MUST NOT be added to the unacknowledged outgoing buffer
 * MUST NOT be included in causal histories of subsequent messages
@@ -271,6 +299,197 @@ Upon reception,
 ephemeral messages SHOULD be delivered immediately without buffering for causal dependencies
 or including in the local log.
 
+### SDS Repair (SDS-R)
+
+SDS Repair (SDS-R) is an optional extension module for SDS,
+allowing participants in a communication to collectively repair any gaps in causal history (missing messages)
+preferably over a limited time window.
+Since SDS-R acts as coordinated rebroadcasting of missing messages,
+which involves all participants of the communication,
+it is most appropriate in a limited use case for repairing relatively recent missed dependencies.
+It is not meant to replace mechanisms for long-term consistency,
+such as peer-to-peer syncing or the use of a high-availability centralised cache (Store node).
+
+#### SDS-R message fields
+
+SDS-R adds the following fields to SDS messages:
+
+* `sender_id` in `HistoryEntry`:
+the original message sender's participant ID.
+This is used to determine the group of participants who will respond to a repair request.
+* `repair_request` in `Message`:
+a capped list of history entries missing for the message sender
+and for which it's requesting a repair.
+
+#### SDS-R participant state
+
+SDS-R adds the following to each participant state:
+
+* Outgoing **repair request buffer**:
+a list of locally missing `HistoryEntry`s
+each mapped to a future request timestamp, `T_req`,
+after which this participant will request a repair if at that point the missing dependency has not been repaired yet.
+`T_req` is computed as a pseudorandom backoff from the timestamp when the dependency was detected missing.
+[Determining `T_req`](#determine-t_req) is described below.
+We RECOMMEND that the outgoing repair request buffer be chronologically ordered in ascending order of `T_req`.
+
+* Incoming **repair request buffer**:
+a list of locally available `HistoryEntry`s
+that were requested for repair by a remote participant
+AND for which this participant might be an eligible responder,
+each mapped to a future response timestamp, `T_resp`,
+after which this participant will rebroadcast the corresponding requested `Message` if at that point no other participant had rebroadcast the `Message`.
+`T_resp` is computed as a pseudorandom backoff from the timestamp when the repair was first requested.
+[Determining `T_resp`](#determine-t_resp) is described below.
+We describe below how a participant can [determine if they're an eligible responder](#determine-response-group) for a specific repair request.
+
+* Augmented local history log:
+for each message ID kept in the local log for which the participant could be a repair responder,
+the full SDS `Message` must be cached rather than just the message ID,
+in case this participant is called upon to rebroadcast the message.
+We describe below how a participant can [determine if they're an eligible responder](#determine-response-group) for a specific message.
+
+**_Note:_** The required state can likely be significantly reduced in future by simply requiring that a responding participant should _reconstruct_ the original `Message` when rebroadcasting, rather than the simpler, but heavier,
+requirement of caching the entire received `Message` content in local history.
+
+#### SDS-R global state
+
+For a specific channel (that is, within a specific SDS-controlled communication)
+the following SDS-R configuration state SHOULD be common for all participants in the conversation:
+
+* `T_min`: the _minimum_ time period to wait before a missing causal entry can be repaired.
+We RECOMMEND a value of at least 30 seconds.
+* `T_max`: the _maximum_ time period over which missing causal entries can be repaired.
+We RECOMMEND a value of between 120 and 600 seconds.
+
+Furthermore, to avoid a broadcast storm with multiple participants responding to a repair request,
+participants in a single channel MAY be divided into discrete response groups.
+Participants will only respond to a repair request if they are in the response group for that request.
+The global `num_response_groups` variable configures the number of response groups for this communication.
+Its use is described below.
+A reasonable default value for `num_response_groups` is one response group for every `128` participants.
+In other words, if the (roughly) expected number of participants is expressed as `num_participants`, then
+`num_response_groups = num_participants div 128 + 1`.
+In other words, if there are fewer than 128 participants in a communication,
+they will all belong to the same response group.
+
+We RECOMMEND that the global state variables `T_min`, `T_max` and `num_response_groups`
+be set _statically_ for a specific SDS-R application,
+based on expected number of group participants and volume of traffic.
+
+**_Note:_** Future versions of this protocol will recommend dynamic global SDS-R variables,
+based on the current number of participants.
+
+#### SDS-R send message
+
+SDS-R adds the following steps when sending a message:
+
+Before broadcasting a message,
+
+* the participant SHOULD populate the `repair_request` field in the message
+with _eligible_ entries from the outgoing repair request buffer.
+An entry is eligible to be included in a `repair_request`
+if its corresponding request timestamp, `T_req`, has expired (in other words,
+`T_req <= current_time`).
+The maximum number of repair request entries to include is up to the application.
+We RECOMMEND that this quota be filled by the eligible entries from the outgoing repair request buffer with the lowest `T_req`.
+We RECOMMEND a maximum of 3 entries.
+If there are no eligible entries in the buffer,
+this optional field MUST be left unset.
+
+#### SDS-R receive message
+
+On receiving a message,
+
+* the participant MUST remove entries matching the received message ID from its _outgoing_ repair request buffer.
+This ensures that the participant does not request repairs for dependencies that have now been met.
+* the participant MUST remove entries matching the received message ID from its _incoming_ repair request buffer.
+This ensures that the participant does not respond to repair requests that another participant has already responded to.
+* the participant SHOULD add any unmet causal dependencies to its outgoing repair request buffer against a unique `T_req` timestamp for that entry.
+It MUST compute the `T_req` for each such HistoryEntry according to the steps outlined in [_Determine T_req_](#determine-t_req).
+* for each item in the `repair_request` field:
+  * the participant MUST remove entries matching the repair message ID from its own outgoing repair request buffer.
+  This limits the number of participants that will request a common missing dependency.
+  * if the participant has the requested `Message` in its local history _and_ is an eligible responder for the repair request,
+  it SHOULD add the request to its incoming repair request buffer against a unique `T_resp` timestamp for that entry.
+  It MUST compute the `T_resp` for each such repair request according to the steps outlined in [_Determine T_resp_](#determine-t_resp).
+  It MUST determine if it's an eligible responder for a repair request according to the steps outlined in [_Determine response group_](#determine-response-group).
+
+#### Determine T_req
+
+A participant determines the repair request timestamp, `T_req`,
+for a missing `HistoryEntry` as follows:
+
+```text
+T_req = current_time + hash(participant_id, message_id) % (T_max - T_min) + T_min
+```
+
+where `current_time` is the current timestamp,
+`participant_id` is the participant's _own_ participant ID
+(not the `sender_id` in the missing `HistoryEntry`),
+`message_id` is the missing `HistoryEntry`'s message ID,
+and `T_min` and `T_max` are as set out in [SDS-R global state](#sds-r-global-state).
+
+This allows `T_req` to be pseudorandomly and linearly distributed as a backoff of between `T_min` and `T_max` from current time.
+
+> **_Note:_** placing `T_req` values on an exponential backoff curve will likely be more appropriate and is left for a future improvement.
+
+#### Determine T_resp
+
+A participant determines the repair response timestamp, `T_resp`,
+for a `HistoryEntry` that it could repair as follows:
+
+```text
+distance = hash(participant_id) XOR hash(sender_id)
+T_resp = current_time + distance*hash(message_id) % T_max
+```
+
+where `current_time` is the current timestamp,
+`participant_id` is the participant's _own_ (local) participant ID,
+`sender_id` is the requested `HistoryEntry` sender ID,
+`message_id` is the requested `HistoryEntry` message ID,
+and `T_max` is as set out in [SDS-R global state](#sds-r-global-state).
+
+We first calculate the logical `distance` between the local `participant_id` and
+the original `sender_id`.
+If this participant is the original sender, the `distance` will be `0`.
+It should then be clear that the original participant will have a response backoff time of `0`,
+making it the most likely responder.
+The `T_resp` values for other eligible participants will be pseudorandomly and
+linearly distributed as a backoff of up to `T_max` from current time.
+
+> **_Note:_** placing `T_resp` values on an exponential backoff curve will likely be more appropriate and
+is left for a future improvement.
+
+#### Determine response group
+
+Given a message with `sender_id` and `message_id`,
+a participant with `participant_id` is in the response group for that message if
+
+```text
+hash(participant_id, message_id) % num_response_groups == hash(sender_id, message_id) % num_response_groups
+```
+
+where `num_response_groups` is as set out in [SDS-R global state](#sds-r-global-state).
+This ensures that a participant will always be in the response group for its own published messages.
+It also allows participants to determine immediately on first reception of a message or
+a history entry if they are in the associated response group.
+
+#### SDS-R incoming repair request buffer sweep
+
+An SDS-R participant MUST periodically check if there are any incoming requests in the **incoming** repair request buffer* that is due for a response.
+For each item in the buffer,
+the participant SHOULD broadcast the corresponding `Message` from local history
+if its corresponding response timestamp, `T_resp`, has expired
+(in other words, `T_resp <= current_time`).
+
+#### SDS-R Periodic Sync Message
+
+If the participant is due to send a periodic sync message,
+it SHOULD send the message according to [SDS-R send message](#sds-r-send-message)
+if there are any eligible items in the outgoing repair request buffer,
+regardless of whether other participants have also recently broadcast a Periodic Sync message.
+
 ## Copyright
 
 Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

vac/raw/zerokit-api.md

@@ -0,0 +1,405 @@
+---
+title: Zerokit-API
+name: Zerokit API
+status: raw
+category: Standards Track
+tags: [zerokit, rln, api]
+editor:
+contributors:
+---
+
+## Abstract
+
+This document specifies the Zerokit API, an implementation of the RLN-V2 protocol.
+The specification covers the unified interface exposed through native Rust,
+C-compatible Foreign Function Interface (FFI) bindings,
+and WebAssembly (WASM) bindings.
+
+## Motivation
+
+The main goal of this RFC is to define the API contract,
+serialization formats,
+and architectural guidance for integrating the Zerokit library
+across all supported platforms.
+Zerokit is the reference implementation of the RLN-V2 protocol.
+
+## Format Specification
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
+“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document
+are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+### Important Note
+
+All terms and parameters used remain the same as in [32/RLN-V1](../32/rln-v1.md).
+More details are available in the [technical overview](../32/rln-v1.md#technical-overview).
+
+### Architecture Overview
+
+Zerokit follows a layered architecture where
+the core RLN logic is implemented once in Rust and
+exposed through platform-specific bindings.
+The protocol layer handles zero-knowledge proof generation and verification,
+Merkle tree operations,
+and cryptographic primitives.
+This core is wrapped by three interface layers:
+native Rust for direct library integration,
+FFI for C-compatible bindings consumed by languages (such as C and Nim),
+and WASM for browser and Node.js environments.
+All three interfaces maintain functional parity and
+share identical serialization formats for inputs and outputs.
+
+```text
+      ┌─────────────────────────────────────────────────────┐
+      │                  Application Layer                  │
+      └──────────┬───────────────┬───────────────┬──────────┘
+                 │               │               │
+          ┌──────▼───────┐ ┌─────▼─────┐ ┌───────▼─────┐
+          │    FFI API   │ │ WASM API  │ │   Rust API  │
+          │   (C/Nim/..) │ │ (Browser) │ │   (Native)  │
+          └──────┬───────┘ └─────┬─────┘ └───────┬─────┘
+                 └───────────────┼───────────────┘
+                                 │
+                       ┌─────────▼─────────┐
+                       │   RLN Protocol    │
+                       │   (Rust Core)     │
+                       └───────────────────┘
+```
+
+### Supported Features
+
+Zerokit provides compile-time feature flags that
+control Merkle tree storage backends,
+operational modes,
+and parallelization.
+
+#### Merkle Tree Backends
+
+`fullmerkletree` allocates the complete tree structure in memory.
+This backend provides the fastest performance but consumes the most memory.
+
+`optimalmerkletree` uses sparse HashMap storage that only allocates nodes as needed.
+This backend balances performance and memory efficiency.
+
+`pmtree` persists the tree to disk using a sled database.
+This backend enables state durability across process restarts.
+
+#### Operational Modes
+
+`stateless` disables the internal Merkle tree.
+Applications MUST provide the Merkle root and
+membership proof externally when generating proofs.
+
+When `stateless` is not enabled,
+the library operates in stateful mode and
+requires one of the Merkle tree backends.
+
+#### Parallelization
+
+`parallel` enables rayon-based parallel computation for
+proof generation and tree operations.
+
+This flag SHOULD be enabled for end-user clients where
+fastest individual proof generation time is required.
+For server-side proof services handling multiple concurrent requests,
+this flag SHOULD be disabled and
+applications SHOULD use dedicated worker threads per proof instead.
+The worker thread approach provides significantly higher throughput for
+concurrent proof generation.
+
+## The API
+
+### Overview
+
+The API exposes functional interfaces with strongly-typed parameters.
+All three platform bindings share the same function signatures,
+differing only in language-specific conventions.
+Function signatures documented below are from the Rust perspective.
+
+- Rust: <https://github.com/vacp2p/zerokit/blob/master/rln/src/public.rs>
+- FFI: <https://github.com/vacp2p/zerokit/tree/master/rln/src/ffi>
+- WASM: <https://github.com/vacp2p/zerokit/tree/master/rln-wasm>
+
+### Initialization
+
+`RLN::new(tree_depth, tree_config)` creates a new RLN instance by loading circuit resources from the default folder.
+The `tree_config` parameter accepts multiple types via the `TreeConfigInput` trait: a JSON string,
+a direct config object (with pmtree feature), or an empty string for defaults.
+Not available in WASM. Not available when `stateless` feature is enabled.
+
+`RLN::new()` creates a new stateless RLN instance by loading circuit resources from the default folder.
+Only available when `stateless` feature is enabled. Not available in WASM.
+
+`RLN::new_with_params(tree_depth, zkey_data, graph_data, tree_config)` creates a new RLN instance
+with pre-loaded circuit parameters passed as byte vectors.
+The `tree_config` parameter accepts multiple types via the `TreeConfigInput` trait.
+Not available in WASM. Not available when `stateless` feature is enabled.
+
+`RLN::new_with_params(zkey_data, graph_data)` creates a new stateless RLN instance with pre-loaded circuit parameters.
+Only available when `stateless` feature is enabled. Not available in WASM.
+
+`RLN::new_with_params(zkey_data)` creates a new stateless RLN instance for WASM with pre-loaded zkey data.
+Graph data is not required as witness calculation is handled externally in WASM environments.
+Only available in WASM with `stateless` feature enabled.
+
+### Key Generation
+
+`keygen()` generates a random identity keypair returning `(identity_secret, id_commitment)`.
+
+`seeded_keygen(seed)` generates a deterministic identity keypair
+from a seed returning `(identity_secret, id_commitment)`.
+
+`extended_keygen()` generates a random extended identity keypair
+returning `(identity_trapdoor, identity_nullifier, identity_secret, id_commitment)`.
+
+`extended_seeded_keygen(seed)` generates a deterministic extended identity keypair
+from a seed returning `(identity_trapdoor, identity_nullifier, identity_secret, id_commitment)`.
+
+### Merkle Tree Management
+
+All tree management functions are only available when
+`stateless` feature is NOT enabled.
+
+`set_tree(tree_depth)` initializes the internal Merkle tree with the specified depth.
+Leaves are set to the default zero value.
+
+`set_leaf(index, leaf)` sets a leaf value at the specified index.
+
+`get_leaf(index)` returns the leaf value at the specified index.
+
+`set_leaves_from(index, leaves)` sets multiple leaves starting from the specified index.
+Updates `next_index` to `max(next_index, index + n)`.
+If n leaves are passed, they will be set at positions `index`, `index+1`, ..., `index+n-1`.
+
+`init_tree_with_leaves(leaves)` resets the tree state to default and initializes it
+with the provided leaves starting from index 0.
+This resets the internal `next_index` to 0 before setting the leaves.
+
+`atomic_operation(index, leaves, indices)` atomically inserts leaves starting from index
+and removes leaves at the specified indices.
+Updates `next_index` to `max(next_index, index + n)` where n is the number of leaves inserted.
+
+`set_next_leaf(leaf)` sets a leaf at the next available index and increments `next_index`.
+The leaf is set at the current `next_index` value, then `next_index` is incremented.
+
+`delete_leaf(index)` sets the leaf at the specified index to the default zero value.
+Does not change the internal `next_index` value.
+
+`leaves_set()` returns the number of leaves that have been set in the tree.
+
+`get_root()` returns the current Merkle tree root.
+
+`get_subtree_root(level, index)` returns the root of a subtree at the specified level and index.
+
+`get_merkle_proof(index)` returns the Merkle proof for the leaf at the specified index as `(path_elements, identity_path_index)`.
+
+`get_empty_leaves_indices()` returns indices of leaves set to zero up to the final leaf that was set.
+
+`set_metadata(metadata)` stores arbitrary metadata in the RLN object for application use.
+This metadata is not used by the RLN module.
+
+`get_metadata()` returns the metadata stored in the RLN object.
+
+`flush()` closes the connection to the Merkle tree database.
+Should be called before dropping the RLN object when using persistent storage.
+
+### Witness Construction
+
+`RLNWitnessInput::new(identity_secret, user_message_limit, message_id, path_elements, identity_path_index, x, external_nullifier)` constructs
+a witness input for proof generation. Validates that `message_id < user_message_limit`.
+
+### Witness Calculation
+
+For native (non-WASM) environments, witness calculation is handled internally by the proof generation functions.
+The circuit witness is computed from the `RLNWitnessInput` and passed to the zero-knowledge proof system.
+
+For WASM environments, witness calculation must be performed externally using a JavaScript witness calculator.
+The workflow is:
+
+1. Create a `WasmRLNWitnessInput` with the required parameters
+2. Export to JSON format using `toBigIntJson()` method
+3. Pass the JSON to an external JavaScript witness calculator
+4. Use the calculated witness with `generate_rln_proof_with_witness`
+
+The witness calculator computes all intermediate values required by the RLN circuit.
+
+### Proof Generation
+
+`generate_zk_proof(witness)` generates a Groth16 zkSNARK proof from a witness.
+Extract proof values separately using `proof_values_from_witness`.
+Not available in WASM.
+
+`generate_rln_proof(witness)` generates a complete RLN proof returning both the zkSNARK proof and proof values as `(proof, proof_values)`.
+This combines proof generation and proof values extraction.
+Not available in WASM.
+
+`generate_rln_proof_with_witness(calculated_witness, witness)` generates an RLN proof using
+a pre-calculated witness from an external witness calculator.
+The `calculated_witness` should be a `Vec<BigInt>` obtained from the external witness calculator.
+Returns `(proof, proof_values)`.
+This is the primary proof generation method for WASM where witness calculation is handled by JavaScript.
+
+### Proof Verification
+
+`verify_zk_proof(proof, proof_values)` verifies only the zkSNARK proof without root or signal validation.
+Returns `true` if the proof is valid.
+
+`verify_rln_proof(proof, proof_values, x)` verifies the proof against the internal Merkle tree root and
+validates that `x` matches the proof signal.
+Returns an error if verification fails (invalid proof, invalid root, or invalid signal).
+Only available when `stateless` feature is NOT enabled.
+
+`verify_with_roots(proof, proof_values, x, roots)` verifies the proof against a set of acceptable roots and
+validates the signal.
+If the roots slice is empty, root verification is skipped. Returns an error if verification fails.
+
+### Slashing
+
+`recover_id_secret(proof_values_1, proof_values_2)` recovers the identity secret from two proof values
+that share the same external nullifier.
+Used to detect and penalize rate limit violations.
+
+### Hash Utilities
+
+`poseidon_hash(inputs)` computes the Poseidon hash of the input field elements.
+
+`hash_to_field_le(input)` hashes arbitrary bytes to a field element using little-endian byte order.
+
+`hash_to_field_be(input)` hashes arbitrary bytes to a field element using big-endian byte order.
+
+### Serialization Utilities
+
+`rln_witness_to_bytes_le` / `rln_witness_to_bytes_be` serializes an RLN witness to bytes.
+
+`bytes_le_to_rln_witness` / `bytes_be_to_rln_witness` deserializes bytes to an RLN witness.
+
+`rln_proof_to_bytes_le` / `rln_proof_to_bytes_be` serializes an RLN proof to bytes.
+
+`bytes_le_to_rln_proof` / `bytes_be_to_rln_proof` deserializes bytes to an RLN proof.
+
+`rln_proof_values_to_bytes_le` / `rln_proof_values_to_bytes_be` serializes proof values to bytes.
+
+`bytes_le_to_rln_proof_values` / `bytes_be_to_rln_proof_values` deserializes bytes to proof values.
+
+`fr_to_bytes_le` / `fr_to_bytes_be` serializes a field element to 32 bytes.
+
+`bytes_le_to_fr` / `bytes_be_to_fr` deserializes 32 bytes to a field element.
+
+`vec_fr_to_bytes_le` / `vec_fr_to_bytes_be` serializes a vector of field elements to bytes.
+
+`bytes_le_to_vec_fr` / `bytes_be_to_vec_fr` deserializes bytes to a vector of field elements.
+
+### WASM-Specific Notes
+
+WASM bindings wrap the Rust API with JavaScript-compatible types. Key differences:
+
+- Field elements are wrapped as `WasmFr` with `fromBytesLE`, `fromBytesBE`, `toBytesLE`, `toBytesBE` methods.
+- Vectors of field elements use `VecWasmFr` with `push`, `get`, `length` methods.
+- Identity generation uses `Identity.generate()` and `Identity.generateSeeded(seed)` static methods.
+- Extended identity uses `ExtendedIdentity.generate()` and `ExtendedIdentity.generateSeeded(seed)`.
+- Witness input uses `WasmRLNWitnessInput` constructor and `toBigIntJson()` for witness calculator integration.
+- Proof generation requires external witness calculation via `generateRLNProofWithWitness(calculatedWitness, witness)`.
+- When `parallel` feature is enabled, call `initThreadPool()` to initialize the thread pool.
+
+### FFI-Specific Notes
+
+FFI bindings use C-compatible types with the `ffi_` prefix. Key differences:
+
+- Field elements are wrapped as `CFr` with corresponding conversion functions.
+- Results use `CResult` or `CBoolResult` structs with `ok` and `err` fields.
+- Memory must be explicitly freed using `ffi_*_free` functions.
+- Vectors use `repr_c::Vec` with `ffi_vec_*` helper functions.
+- Configuration is passed via file path to a JSON configuration file.
+
+## Usage Patterns
+
+This section describes common deployment scenarios and
+the recommended API combinations for each.
+
+### Stateful with Changing Root
+
+Applies when membership changes over time with members joining and slashing continuously.
+
+Applications MUST maintain a sliding window of recent roots externally.
+When members are added or removed via `set_leaf`, `delete_leaf`, or `atomic_operation`,
+capture the new root using `get_root` and append it to the history buffer.
+Verify incoming proofs using `verify_with_roots` with the root history buffer,
+accepting proofs valid against any recent root.
+
+The window size depends on network propagation delays and epoch duration.
+
+### Stateful with Fixed Root
+
+Applies when membership is established once and remains static during operation.
+
+Initialize the tree using `init_tree_with_leaves` with the complete membership set.
+No root history is required.
+Verify proofs using `verify_rln_proof` which checks against the internal tree root directly.
+
+### Stateless
+
+Applies when membership state is managed externally,
+such as by a smart contract or relay network.
+
+Enable the `stateless` feature flag.
+Obtain Merkle proofs and valid roots from the external source.
+Pass externally provided `path_elements` and `identity_path_index` to `RLNWitnessInput::new`.
+Verify using `verify_with_roots` with externally provided roots.
+
+### WASM Browser Integration
+
+WASM environments require external witness calculation.
+Use `WasmRLNWitnessInput::toBigIntJson()` to export the witness for
+JavaScript witness calculators,
+then pass the result to `generateRLNProofWithWitness`.
+
+When `parallel` feature is enabled,
+call `initThreadPool()` before proof operations.
+This requires COOP/COEP headers for SharedArrayBuffer support.
+
+#### Epoch and Rate Limit Configuration
+
+The external nullifier is computed as `poseidon_hash([epoch, rln_identifier])`.
+Each application SHOULD use a unique `rln_identifier` to
+prevent cross-application nullifier collisions.
+
+The `user_message_limit` in the rate commitment determines messages allowed per epoch.
+The `message_id` must be less than `user_message_limit` and
+should increment with each message.
+Applications MUST persist the `message_id` counter to avoid violations after restarts.
+
+## Security/Privacy Considerations
+
+The security of Zerokit depends on the correct implementation of the RLN-V2 protocol
+and the underlying zero-knowledge proof system.
+Applications MUST ensure that:
+
+- Identity secrets are kept confidential and never transmitted or logged
+- The `message_id` counter is properly persisted to prevent accidental rate limit violations
+- External nullifiers are constructed correctly to prevent cross-application attacks
+- Merkle tree roots are validated when using stateless mode
+- Circuit parameters (zkey and graph data) are obtained from trusted sources
+
+When using the `parallel` feature in WASM,
+applications MUST serve content with appropriate COOP/COEP headers to
+enable SharedArrayBuffer support securely.
+
+The slashing mechanism exposes identity secrets when rate limits are violated.
+Applications SHOULD educate users about this risk and
+implement safeguards to prevent accidental violations.
+
+## References
+
+### Normative
+
+- [32/RLN-V1](../32/rln-v1.md) - Rate Limit Nullifier V1 specification
+
+### Informative
+
+- [Zerokit GitHub Repository](https://github.com/vacp2p/zerokit) - Reference implementation
+- [RLN-V2 Specification](./rln-v2.md) - Rate Limit Nullifier V2 protocol
+- [Sled Database](https://sled.rs) - Embedded database used for persistent Merkle tree storage
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

waku/deprecated/fault-tolerant-store.md

@@ -2,7 +2,7 @@
 slug: 21
 title: 21/WAKU2-FAULT-TOLERANT-STORE
 name: Waku v2 Fault-Tolerant Store
-status: draft
+status: deleted
 editor: Sanaz Taheri <sanaz@status.im>
 contributors:
 ---

waku/informational/23/topics.md

@@ -8,17 +8,18 @@ editor: Oskar Thoren <oskarth@titanproxy.com>
 contributors:
   - Hanno Cornelius <hanno@status.im>
   - Daniel Kaiser <danielkaiser@status.im>
+  - Filip Dimitrijevic <filip@status.im>
 ---
 
 This document outlines recommended usage of topic names in Waku v2.
-In [10/WAKU2 spec](../../standards/core/10/waku2.md) there are two types of topics:
+In [10/WAKU2 spec](/waku/standards/core/10/waku2.md) there are two types of topics:
 
-- pubsub topics, used for routing
+- Pubsub topics, used for routing
 - Content topics, used for content-based filtering
 
 ## Pubsub Topics
 
-Pubsub topics are used for routing of messages (see [11/WAKU2-RELAY](../../standards/core/11/relay.md)),
+Pubsub topics are used for routing of messages (see [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)),
 and can be named implicitly by Waku sharding (see [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)).
 This document comprises recommendations for explicitly naming pubsub topics
 (e.g. when choosing *named sharding* as specified in [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)).
@@ -32,7 +33,7 @@ Pubsub topics SHOULD follow the following structure:
 This namespaced structure makes compatibility, discoverability,
 and automatic handling of new topics easier.
 
-The first two parts indicate
+The first two parts indicate:
 
 1) it relates to the Waku protocol domain, and
 2) the version is 2.
@@ -42,15 +43,15 @@ in a hierarchical way as well.
 
 > *Note*: In previous versions of this document, the structure was `/waku/2/{topic-name}/{encoding}`.
 The now deprecated `/{encoding}` was always set to `/proto`,
-which indicated that the [data field](../../standards/core/11/RELAY.md/#protobuf-definition)
+which indicated that the [data field](/waku/standards/core/11/relay.md#protobuf-definition)
 in pubsub is serialized/encoded as protobuf.
 The inspiration for this format was taken from
 [Ethereum 2 P2P spec](https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/p2p-interface.md#topics-and-messages).
-However, because the payload of messages transmitted over [11/WAKU2-RELAY](../../standards/core/11/relay.md)
-must be a [14/WAKU2-MESSAGE](../../standards/core/14/message.md),
+However, because the payload of messages transmitted over [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
+must be a [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md),
 which specifies the wire format as protobuf,`/proto` is the only valid encoding.
 This makes the `/proto` indication obsolete.
-The encoding of the `payload` field of a Waku Message
+The encoding of the `payload` field of a WakuMessage
 is indicated by the `/{encoding}` part of the content topic name.
 Specifying an encoding is only significant for the actual payload/data field.
 Waku preserves this option by allowing to specify an encoding
@@ -94,18 +95,19 @@ This indicates explicitly that the network traffic has been partitioned into 10
 
 The other type of topic that exists in Waku v2 is a content topic.
 This is used for content based filtering.
-See [14/WAKU2-MESSAGE spec](../../standards/core/14/message.md)
+See [14/WAKU2-MESSAGE spec](/waku/standards/core/14/message.md)
 for where this is specified.
 Note that this doesn't impact routing of messages between relaying nodes,
-but it does impact how request/reply protocols such as
-[12/WAKU2-FILTER](../../standards/core/12/filter.md) and
-[13/WAKU2-STORE](../../standards/core/13/store.md) are used.
+but it does impact using request/reply protocols such as
+[12/WAKU2-FILTER](/waku/standards/core/12/filter.md) and
+[13/WAKU2-STORE](/waku/standards/core/13/store.md).
 
 This is especially useful for nodes that have limited bandwidth,
 and only want to pull down messages that match this given content topic.
 
 Since all messages are relayed using the relay protocol regardless of content topic,
-you MAY use any content topic you wish without impacting how messages are relayed.
+you MAY use any content topic you wish
+without impacting how messages are relayed.
 
 ### Content Topic Format
 
@@ -121,28 +123,38 @@ As an example, here's the content topic used for an upcoming testnet:
 ### Content Topic Naming Recommendations
 
 Application names SHOULD be unique to avoid conflicting issues with other protocols.
-Applications SHOULD specify their version (if applicable) in the version field.
+Application version (if applicable) SHOULD be specified in the version field.
 The `{content-topic-name}` portion of the content topic is up to the application,
 and depends on the problem domain.
 It can be hierarchical, for instance to separate content, or
 to indicate different bandwidth and privacy guarantees.
 The encoding field indicates the serialization/encoding scheme
-for the [WakuMessage payload](../../standards/core/14/message.md/#payloads) field.
+for the [WakuMessage payload](/waku/standards/core/14/message.md#payloads) field.
 
 ### Content Topic usage guidelines
 
-Applications SHOULD be mindful while designing/using content topics so that a bloat of content-topics does not happen.
-A content-topic bloat causes performance degradation in Store and Filter protocols while trying to retrieve messages.
+Applications SHOULD be mindful while designing/using content topics
+so that a bloat of content-topics does not happen.
+A content-topic bloat causes performance degradation in Store
+and Filter protocols while trying to retrieve messages.
 
-Store queries have been noticed to be considerably slow (e.g doubling of response-time when content-topic count is increased from 10 to 100) when a lot of content-topics are involved in a single query.
-Similarly number of filter subscriptions increase, which increases complexity on client side to maintain and manage these subscriptions.
+Store queries have been noticed to be considerably slow
+(e.g doubling of response-time when content-topic count is increased from 10 to 100)
+when a lot of content-topics are involved in a single query.
+Similarly, a number of filter subscriptions increase,
+which increases complexity on client side to maintain
+and manage these subscriptions.
 
-Applications SHOULD analyze the query/filter criteria for fetching messages from the network and select/design content topics to match such filter criteria.
-e.g: even though applications may want to segregate messages into different sets based on some application logic, if those sets of messages are always fetched/queried together from the network, then all those messages SHOULD use a single content-topic.
+Applications SHOULD analyze the query/filter criteria for fetching messages from the network
+and select/design content topics to match such filter criteria.
+e.g: even though applications may want to segregate messages into different sets
+based on some application logic,
+if those sets of messages are always fetched/queried together from the network,
+then all those messages SHOULD use a single content-topic.
 
 ## Differences with Waku v1
 
-In [5/WAKU1](../../deprecated/5/waku0.md) there is no actual routing.
+In [5/WAKU1](/waku/deprecated/5/waku0.md) there is no actual routing.
 All messages are sent to all other nodes.
 This means that we are implicitly using the same pubsub topic
 that would be something like:
@@ -155,7 +167,7 @@ Topics in Waku v1 correspond to Content Topics in Waku v2.
 
 ### Bridging Waku v1 and Waku v2
 
-To bridge Waku v1 and Waku v2 we have a [15/WAKU-BRIDGE](../../standards/core/15/bridge.md).
+To bridge Waku v1 and Waku v2 we have a [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md).
 For mapping Waku v1 topics to Waku v2 content topics,
 the following structure for the content topic SHOULD be used:
 
@@ -166,9 +178,9 @@ the following structure for the content topic SHOULD be used:
 The `<4bytes-waku-v1-topic>` SHOULD be the lowercase hex representation
 of the 4-byte Waku v1 topic.
 A `0x` prefix SHOULD be used.
-`/rfc26` indicates that the bridged content is encoded according to RFC [26/WAKU2-PAYLOAD](../../standards/application/26/payload.md).
-See [15/WAKU-BRIDGE](../../standards/core/15/bridge.md) for a description
-of the bridged fields.
+`/rfc26` indicates that the bridged content is encoded according to RFC [26/WAKU2-PAYLOAD](/waku/standards/application/26/payload.md).
+See [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md)
+for a description of the bridged fields.
 
 This creates a direct mapping between the two protocols.
 For example:
@@ -184,13 +196,13 @@ Copyright and related rights waived via
 
 ## References
 
-- [10/WAKU2 spec](../../standards/core/10/waku2.md)
-- [11/WAKU2-RELAY](../../standards/core/11/relay.md)
+- [10/WAKU2 spec](/waku/standards/core/10/waku2.md)
+- [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
 - [RELAY-SHARDING](https://github.com/waku-org/specs/blob/master/standards/core/relay-sharding.md)
 - [Ethereum 2 P2P spec](https://github.com/ethereum/eth2.0-specs/blob/dev/specs/phase0/p2p-interface.md#topics-and-messages)
-- [14/WAKU2-MESSAGE](../../standards/core/14/message.md)
-- [12/WAKU2-FILTER](../../standards/core/12/filter.md)
-- [13/WAKU2-STORE](../../standards/core/13/store.md)
-- [6/WAKU1](../../deprecated/5/waku0.md)
-- [15/WAKU-BRIDGE](../../standards/core/15/bridge.md)
-- [26/WAKU-PAYLOAD](../../standards/application/26/payload.md)
+- [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md)
+- [12/WAKU2-FILTER](/waku/standards/core/12/filter.md)
+- [13/WAKU2-STORE](/waku/standards/core/13/store.md)
+- [6/WAKU1](/waku/deprecated/5/waku0.md)
+- [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md)
+- [26/WAKU-PAYLOAD](/waku/standards/application/26/payload.md)

waku/informational/27/peers.md

@@ -5,6 +5,7 @@ name: Waku v2 Client Peer Management Recommendations
 status: draft
 editor: Hanno Cornelius <hanno@status.im>
 contributors:
+ - Filip Dimitrijevic <filip@status.im>
 ---
 
 `27/WAKU2-PEERS` describes a recommended minimal set of peer storage and
@@ -18,7 +19,8 @@ or the ability to store peer data on disk to resume state after a client restart
 Peer _management_ is a closely related concept and
 refers to the set of actions a client MAY choose to perform
 based on its knowledge of its connected peers,
-e.g. triggering reconnects/disconnects, keeping certain connections alive, etc.
+e.g. triggering reconnects/disconnects,
+keeping certain connections alive, etc.
 
 ## Peer store
 
@@ -55,7 +57,7 @@ disconnected gracefully.
 - **`Connected`**: The client is actively connected to this peer.
 
 This list does not preclude clients from tracking more advanced connectivity metadata,
-such as a peer's blacklist status (see [`18/WAKU2-SWAP`](../../standards/application/18/swap.md)).
+such as a peer's blacklist status (see [`18/WAKU2-SWAP`](/waku/deprecated/18/swap.md)).
 
 ### Persistence
 
@@ -91,8 +93,8 @@ This requires keeping track of the [last time each peer was disconnected](#track
 
 A Waku v2 client MAY choose to implement a keep-alive mechanism to certain peers.
 If a client chooses to implement keep-alive on a connection,
-it SHOULD do so by sending periodic [libp2p pings](https://docs.libp2p.io/concepts/protocols/#ping)
-as per `10/WAKU2` [client recommendations](../../standards/core/10/waku2.md/#recommendations-for-clients).
+it SHOULD do so by sending periodic [libp2p pings](https://docs.libp2p.io/concepts/fundamentals/protocols/#ping)
+as per `10/WAKU2` [client recommendations](/waku/standards/core/10/waku2.md#recommendations-for-clients).
 The recommended period between pings SHOULD be _at most_ 50%
 of the shortest idle connection timeout for the specific client and transport.
 For example, idle TCP connections often times out after 10 to 15 minutes.
@@ -111,9 +113,9 @@ Copyright and related rights waived via
 - [`Peer ID`](https://docs.libp2p.io/concepts/peer-id/)
 - [`multiaddrs`](https://docs.libp2p.io/concepts/addressing/)
 - [`protocol IDs`](https://docs.libp2p.io/concepts/protocols/#protocol-ids)
-- [`11/WAKU2-RELAY`](../../standards/core/11/relay.md)
-- [`13/WAKU2-STORE`](../../standards/core/13/store.md)
-- [`18/WAKU2-SWAP`](../../standards/application/18/swap.md)
-- [backing off period](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#prune-backoff-and-peer-exchange)
-- [libp2p pings](https://docs.libp2p.io/concepts/protocols/#ping)
-- [`10/WAKU2` client recommendations](../../standards/core/10/waku2.md/#recommendations-for-clients)
+- [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md)
+- [`13/WAKU2-STORE`](/waku/standards/core/13/store.md)
+- [`18/WAKU2-SWAP`](/waku/deprecated/18/swap.md)
+- [backing off period](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md/#prune-backoff-and-peer-exchange)
+- [libp2p pings](https://docs.libp2p.io/concepts/fundamentals/protocols/#ping)
+- [`10/WAKU2` client recommendations](/waku/standards/core/10/waku2.md#recommendations-for-clients)

waku/informational/29/config.md

@@ -5,6 +5,7 @@ name: Waku v2 Client Parameter Configuration Recommendations
 status: draft
 editor: Hanno Cornelius <hanno@status.im>
 contributors:
+ - Filip Dimitrijevic <filip@status.im>
 ---
 
 `29/WAKU2-CONFIG` describes the RECOMMENDED values
@@ -12,7 +13,7 @@ to assign to configurable parameters for Waku v2 clients.
 Since Waku v2 is built on [libp2p](https://github.com/libp2p/specs),
 most of the parameters and reasonable defaults are derived from there.
 
-Waku v2 relay messaging is specified in [`11/WAKU2-RELAY`](../../standards/core/11/relay.md),
+Waku v2 relay messaging is specified in [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md),
 a minor extension of the [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md).
 GossipSub behaviour is controlled by a series of adjustable parameters.
 Waku v2 clients SHOULD configure these parameters to the recommended values below.
@@ -26,7 +27,7 @@ We repeat them here with RECOMMMENDED values for `11/WAKU2-RELAY` implementation
 |----------------------|-------------------------------------------------------|-------------------|
 | `D`                  | The desired outbound degree of the network            | 6                 |
 | `D_low`              | Lower bound for outbound degree                       | 4                 |
-| `D_high`             | Upper bound for outbound degree                       | 8                |
+| `D_high`             | Upper bound for outbound degree                       | 8                 |
 | `D_lazy`             | (Optional) the outbound degree for gossip emission    | `D`               |
 | `heartbeat_interval` | Time between heartbeats                               | 1 second          |
 | `fanout_ttl`         | Time-to-live for each topic's fanout state            | 60 seconds        |
@@ -36,9 +37,10 @@ We repeat them here with RECOMMMENDED values for `11/WAKU2-RELAY` implementation
 
 ## GossipSub v1.1 parameters
 
-GossipSub v1.1 extended GossipSub v1.0 and introduced [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters).
-We repeat the global parameters here with RECOMMMENDED values
-for `11/WAKU2-RELAY` implementations.
+GossipSub v1.1 extended GossipSub v1.0 and
+introduced [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters).
+We repeat the global parameters here
+with RECOMMMENDED values for `11/WAKU2-RELAY` implementations.
 
 | Parameter      | Description                                                            | RECOMMENDED value |
 |----------------|------------------------------------------------------------------------|-------------------|
@@ -73,7 +75,7 @@ Copyright and related rights waived via
 ## References
 
 - [libp2p](https://github.com/libp2p/specs)
-- [11/WAKU2-RELAY](../../standards/core/11/relay.md)
+- [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
 - [libp2p GossipSub protocol](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md)
 - [corresponding libp2p specification](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.0.md#parameters)
 - [several new parameters](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#overview-of-new-parameters)

waku/informational/30/adaptive-nodes.md

@@ -5,6 +5,7 @@ name: Adaptive nodes
 status: draft
 editor: Oskar Thorén <oskarth@titanproxy.com>
 contributors:
+ - Filip Dimitrijevic <filip@status.im>
 ---
 
 This is an informational spec that show cases the concept of adaptive nodes.
@@ -12,7 +13,8 @@ This is an informational spec that show cases the concept of adaptive nodes.
 ## Node types - a continuum
 
 We can look at node types as a continuum,
-from more restricted to less restricted, fewer resources to more resources.
+from more restricted to less restricted,
+fewer resources to more resources.
 
 ![Node types - a continuum](./images/adaptive_node_continuum2.png)
 
@@ -58,8 +60,8 @@ Each node can choose which protocols to support, depending on its resources and
 
 ![Protocol selection](./images/adaptive_node_protocol_selection2.png)
 
-In the case of protocols like [11/WAKU2-RELAY](../../standards/core/11/relay.md)
-etc (12, 13, 19, 21) these correspond to Libp2p protocols.
+Protocols like [11/WAKU2-RELAY](/waku/standards/core/11/relay.md),
+as well as [12], [13], [19], and [21], correspond to libp2p protocols.
 
 However, other protocols like 16/WAKU2-RPC
 (local HTTP JSON-RPC), 25/LIBP2P-DNS-DISCOVERY,
@@ -77,13 +79,15 @@ We can better visualize the network with some illustrative examples.
 
 ### Topology and topics
 
-The first one shows an example topology with different PubSub topics
+This illustration shows an example topology with different PubSub topics
 for the relay protocol.
 
 ![Waku Network visualization](./images/adaptive_node_network_topology_protocols2.png)
 
 ### Legend
 
+This illustration shows an example of content topics a node is interested in.
+
 ![Waku Network visualization legend](./images/adaptive_node_network_topology_protocols_legend.png)
 
 The dotted box shows what content topics (application-specific)
@@ -99,7 +103,8 @@ a topic in Waku v1 (Status chat), WalletConnect, and SuperRare community.
 This is a separate component with its own topology.
 
 Behavior and interaction with other protocols specified in Vac RFCs,
-e.g. 25/LIBP2P-DNS-DISCOVERY, 15/WAKU-BRIDGE, etc.
+e.g. [25/LIBP2P-DNS-DISCOVERY](/vac/25/libp2p-dns-discovery.md)
+and [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md).
 
 ### Node Cross Section
 
@@ -110,8 +115,11 @@ shows how the connections look different for different protocols.
 
 ## Copyright
 
-Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+Copyright and related rights waived via
+[CC0](https://creativecommons.org/publicdomain/zero/1.0/).
 
 ## References
 
-- [11/WAKU2-RELAY](../../standards/core/11/relay.md)
+- [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
+- [25/LIBP2P-DNS-DISCOVERY](/vac/25/libp2p-dns-discovery.md)
+- [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md)

waku/standards/application/20/toy-eth-pm.md

@@ -10,29 +10,38 @@ contributors:
 
 **Content Topics**:
 
-- Public Key Broadcast: `/eth-pm/1/public-key/proto`,
-- Private Message: `/eth-pm/1/private-message/proto`.
+- Public Key Broadcast: `/eth-pm/1/public-key/proto`
+- Private Message: `/eth-pm/1/private-message/proto`
+
+## Abstract
 
 This specification explains the Toy Ethereum Private Message protocol
 which enables a peer to send an encrypted message to another peer
-using the Waku v2 network, and the peer's Ethereum address.
-
-The main purpose of this specification
-is to demonstrate how Waku v2 can be used for encrypted messaging purposes,
-using Ethereum accounts for identity.
-This protocol caters for Web3 wallets restrictions,
-allowing it to be implemented only using standard Web3 API.
-In the current state,
-the protocol has privacy and features [limitations](#limitations),
-has not been audited and hence is not fit for production usage.
-We hope this can be an inspiration for developers
-wishing to build on top of Waku v2.
+over the Waku network using the peer's Ethereum address.
 
 ## Goal
 
-Alice wants to send an encrypted message to Bob, where only Bob can decrypt the message.
+Alice wants to send an encrypted message to Bob,
+where only Bob can decrypt the message.
 Alice only knows Bob's Ethereum Address.
 
+The goal of this specification
+is to demonstrate how Waku can be used for encrypted messaging purposes,
+using Ethereum accounts for identity.
+This protocol caters to Web3 wallet restrictions,
+allowing it to be implemented using standard Web3 API.
+In the current state,
+Toy Ethereum Private Message, ETH-PM, has privacy and features [limitations](#limitations),
+has not been audited and hence is not fit for production usage.
+We hope this can be an inspiration for developers
+wishing to build on top of Waku.
+
+## Design Requirements
+
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
+“SHOULD NOT”, “RECOMMENDED”, “MAY”, and
+“OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
 ## Variables
 
 Here are the variables used in the protocol and their definition:
@@ -42,19 +51,17 @@ Here are the variables used in the protocol and their definition:
 - `B'` is Bob's Encryption Public Key, for which `b'` is the private key.
 - `M` is the private message that Alice sends to Bob.
 
-## Design Requirements
-
 The proposed protocol MUST adhere to the following design requirements:
 
-1. Alice knows Bob's Ethereum address,
-2. Bob is willing to participate to Eth-PM, and publishes `B'`,
-3. Bob's ownership of `B'` MUST be verifiable,
-4. Alice wants to send message `M` to Bob,
-5. Bob SHOULD be able to get `M` using [10/WAKU2 spec](../../core/10/waku2.md),
-6. Participants only have access to their Ethereum Wallet via the Web3 API,
-7. Carole MUST NOT be able to read `M`'s content
-even if she is storing it or relaying it,
-8. [Waku Message Version 1](../26/payload.md) Asymmetric Encryption
+1. Alice knows Bob's Ethereum address
+2. Bob is willing to participate to Eth-PM, and publishes `B'`
+3. Bob's ownership of `B'` MUST be verifiable
+4. Alice wants to send message `M` to Bob
+5. Bob SHOULD be able to get `M` using [10/WAKU2](waku/standards/core/10/waku2.md)
+6. Participants only have access to their Ethereum Wallet via the Web3 API
+7. Carole MUST NOT be able to read `M`'s content,
+even if she is storing it or relaying it
+8. [Waku Message Version 1](waku/standards/application/26/payload.md) Asymmetric Encryption
 is used for encryption purposes.
 
 ## Limitations
@@ -72,14 +79,14 @@ If Bob's private key is compromised, past and future messages could be decrypted
 A solution combining regular [X3DH](https://www.signal.org/docs/specifications/x3dh/)
 bundle broadcast with [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/)
 encryption would remove these limitations;
-See the [Status secure transport spec](https://specs.status.im/spec/5)
+See the [Status secure transport specification](status/deprecated/secure-transport.md)
 for an example of a protocol that achieves this in a peer-to-peer setting.
 
 Bob MUST decide to participate in the protocol before Alice can send him a message.
-This is discussed in more in details in
+This is discussed in more detail in
 [Consideration for a non-interactive/uncoordinated protocol](#consideration-for-a-non-interactiveuncoordinated-protocol)
 
-## The protocol
+## The Protocol
 
 ### Generate Encryption KeyPair
 
@@ -100,7 +107,7 @@ Bob MUST sign `B'` using `B`.
 
 To prove ownership of the Encryption Public Key,
 Bob must sign it using [EIP-712](https://eips.ethereum.org/EIPS/eip-712) v3,
-meaning calling `eth_signTypedData_v3` on his Wallet's API.
+meaning calling `eth_signTypedData_v3` on his wallet's API.
 
 Note: While v4 also exists, it is not available on all wallets and
 the features brought by v4 is not needed for the current use case.
@@ -156,9 +163,9 @@ message PublicKeyMessage {
 }
 ```
 
-This MUST be wrapped in a Waku Message version 0,
+This MUST be wrapped in a [14/WAKU-MESSAGE](/waku/standards/core/14/message.md) version 0,
 with the Public Key Broadcast content topic.
-Finally, Bob SHOULD publish the message on Waku v2.
+Finally, Bob SHOULD publish the message on Waku.
 
 ## Consideration for a non-interactive/uncoordinated protocol
 
@@ -169,7 +176,7 @@ it is not enough in itself to deduce Bob's Public Key.
 This is why the protocol dictates that Bob MUST send his Public Key first,
 and Alice MUST receive it before she can send him a message.
 
-Moreover, nim-waku, the reference implementation of [13/WAKU2-STORE](../../core/13/store.md),
+Moreover, nwaku, the reference implementation of [13/WAKU2-STORE](/waku/standards/core/13/store.md),
 stores messages for a maximum period of 30 days.
 This means that Bob would need to broadcast his public key
 at least every 30 days to be reachable.
@@ -201,7 +208,7 @@ Note that these would resolve a UX issue
 only if a sender wants to proceed with _air drops_.
 
 Indeed, if Bob does not publish his Public Key in the first place
-then it can be an indication that he simply does not participate in this protocol
+then it MAY be an indication that he does not participate in this protocol
 and hence will not receive messages.
 
 However, these solutions would be helpful
@@ -221,7 +228,7 @@ Another improvement would be for Bob not having to re-publish his public key
 every 30 days or less.
 Similarly to above,
 if Bob stops publishing his public key
-then it may be an indication that he does not participate in the protocol anymore.
+then it MAY be an indication that he does not participate in the protocol anymore.
 
 In any case,
 the protocol could be modified to store the Public Key in a more permanent storage,
@@ -229,19 +236,19 @@ such as a dedicated smart contract on the blockchain.
 
 ## Send Private Message
 
-Alice MAY monitor the Waku v2 to collect Ethereum Address and
+Alice MAY monitor the Waku network to collect Ethereum Address and
 Encryption Public Key tuples.
 Alice SHOULD verify that the `signature`s of `PublicKeyMessage`s she receives
 are valid as per EIP-712.
 She SHOULD drop any message without a signature or with an invalid signature.
 
 Using Bob's Encryption Public Key,
-retrieved via [10/WAKU2 spec](../../core/10/waku2.md),
+retrieved via [10/WAKU2](/waku/standards/core/10/waku2.md),
 Alice MAY now send an encrypted message to Bob.
 
 If she wishes to do so,
 Alice MUST encrypt her message `M` using Bob's Encryption Public Key `B'`,
-as per [26/WAKU-PAYLOAD Asymmetric Encryption specs](../26/payload.md/#asymmetric).
+as per [26/WAKU-PAYLOAD Asymmetric Encryption specs](waku/standards/application/26/payload.md/#asymmetric).
 
 Alice SHOULD now publish this message on the Private Message content topic.
 
@@ -251,11 +258,11 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 
 ## References
 
-- [10/WAKU2 spec](../../core/10/waku2.md)
-- [Waku Message Version 1](../26/payload.md)
+- [10/WAKU2](/waku/standards/core/10/waku2.md)
+- [Waku Message Version 1](waku/standards/application/26/payload.md)
 - [X3DH](https://www.signal.org/docs/specifications/x3dh/)
 - [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/)
-- [Status secure transport spec](https://specs.status.im/spec/5)
+- [Status secure transport specification](status/deprecated/secure-transport.md)
 - [EIP-712](https://eips.ethereum.org/EIPS/eip-712)
-- [13/WAKU2-STORE](../../core/13/store.md)
+- [13/WAKU2-STORE](/waku/standards/core/13/store.md)
 - [The Graph](https://thegraph.com/)

waku/standards/application/26/payload.md

@@ -5,39 +5,65 @@ name: Waku Message Payload Encryption
 status: draft
 editor: Oskar Thoren <oskarth@titanproxy.com>
 contributors:
+- Oskar Thoren <oskarth@titanproxy.com>
 ---
 
+## Abstract
+
 This specification describes how Waku provides confidentiality, authenticity, and
 integrity, as well as some form of unlinkability.
 Specifically, it describes how encryption, decryption and
-signing works in [6/WAKU1](../../legacy/6/waku1.md) and
-in [10/WAKU2 spec](../../core/10/waku2.md) with [14/WAKU-MESSAGE version 1](../../core/14/message.md/#version1).
+signing works in [6/WAKU1](waku/standards/legacy/6/waku1.md) and
+in [10/WAKU2](waku/standards/core/10/waku2.md) with [14/WAKU-MESSAGE](waku/standards/core/14/message.md/#version1).
 
-This specification effectively replaces [7/WAKU-DATA](../../legacy/7/data.md)
-as well as [6/WAKU1 Payload encryption](../../legacy/6/waku1.md/#payload-encryption)
-but written in a way that is agnostic and self-contained for Waku v1 and Waku v2.
+This specification effectively replaces [7/WAKU-DATA](waku/standards/legacy/7/data.md)
+as well as [6/WAKU1 Payload encryption](waku/standards/legacy/6/waku1.md/#payload-encryption)
+but written in a way that is agnostic and self-contained for [6/WAKU1](waku/standards/legacy/6/waku1.md) and [10/WAKU2](waku/standards/core/10/waku2.md).
 
 Large sections of the specification originate from
 [EIP-627: Whisper spec](https://eips.ethereum.org/EIPS/eip-627) as well from
 [RLPx Transport Protocol spec (ECIES encryption)](https://github.com/ethereum/devp2p/blob/master/rlpx.md#ecies-encryption)
 with some modifications.
 
+## Specification
+
+The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
+“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and
+“OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+For [6/WAKU1](waku/standards/legacy/6/waku1.md),
+the `data` field is used in the [waku envelope](waku/standards/legacy/6/waku1.md#abnf-specification)
+and the field MAY contain the encrypted payload.
+
+For [10/WAKU2](waku/standards/core/10/waku2.md),
+the `payload` field is used in `WakuMessage`
+and MAY contain the encrypted payload.
+
+The fields that are concatenated and
+encrypted as part of the `data` (Waku legacy) or
+`payload` (Waku) field are:
+
+- `flags`
+- `payload-length`
+- `payload`
+- `padding`
+- `signature`
+
 ## Design requirements
 
 - *Confidentiality*:
-The adversary should not be able to learn what data is being sent from one Waku node
+The adversary SHOULD NOT be able to learn what data is being sent from one Waku node
 to one or several other Waku nodes.
 - *Authenticity*:
-The adversary should not be able to cause Waku endpoint
+The adversary SHOULD NOT be able to cause Waku endpoint
 to accept data from any third party as though it came from the other endpoint.
 - *Integrity*:
-The adversary should not be able to cause a Waku endpoint to
+The adversary SHOULD NOT be able to cause a Waku endpoint to
 accept data that has been tampered with.
 
 Notable, *forward secrecy* is not provided for at this layer.
 If this property is desired,
-a more fully featured secure communication protocol can be used on top,
-such as [Status 5/SECURE-TRANSPORT](https://specs.status.im/spec/5).
+a more fully featured secure communication protocol can be used on top.
 
 It also provides some form of *unlinkability* since:
 
@@ -58,25 +84,6 @@ ECIES is using the following cryptosystem:
 - MAC: HMAC with SHA-256
 - AES: AES-128-CTR
 
-## Specification
-
-For [6/WAKU1](../../legacy/6/waku1.md),
-the `data` field is used in the `waku envelope`,
-and the field MAY contain the encrypted payload.
-
-For [10/WAKU2 spec](../../core/10/waku2.md),
-the `payload` field is used in `WakuMessage` and
-MAY contain the encrypted payload.
-
-The fields that are concatenated and
-encrypted as part of the `data` (Waku v1) / `payload` (Waku v2) field are:
-
-- flags
-- payload-length
-- payload
-- padding
-- signature
-
 ### ABNF
 
 Using [Augmented Backus-Naur form (ABNF)](https://tools.ietf.org/html/rfc5234)
@@ -101,7 +108,7 @@ signature       = 65OCTET
 
 data            = flags payload-length payload padding [signature]
 
-; This field is called payload in Waku v2
+; This field is called payload in Waku
 payload         = data
 ```
 
@@ -109,7 +116,7 @@ payload         = data
 
 Those unable to decrypt the payload/data are also unable to access the signature.
 The signature, if provided,
-is the ECDSA signature of the Keccak-256 hash of the unencrypted data
+SHOULD be the ECDSA signature of the Keccak-256 hash of the unencrypted data
 using the secret key of the originator identity.
 The signature is serialized as the concatenation of the `r`, `s` and `v` parameters
 of the SECP-256k1 ECDSA signature, in that order.
@@ -129,7 +136,7 @@ Symmetric encryption uses AES-256-GCM for
 The output of encryption is of the form (`ciphertext`, `tag`, `iv`)
 where `ciphertext` is the encrypted message,
 `tag` is a 16 byte message authentication tag and
-`iv` is a 12 byte initialization vector  (nonce).
+`iv` is a 12 byte initialization vector (nonce).
 The message authentication `tag` and
 initialization vector `iv` field MUST be appended to the resulting `ciphertext`,
 in that order.
@@ -144,7 +151,7 @@ Asymmetric encryption uses the standard Elliptic Curve Integrated Encryption Sch
 #### ECIES
 
 This section originates from the [RLPx Transport Protocol spec](https://github.com/ethereum/devp2p/blob/master/rlpx.md#ecies-encryption)
-spec with minor modifications.
+specification with minor modifications.
 
 The cryptosystem used is:
 
@@ -177,11 +184,11 @@ then obtains the plaintext as `m = AES(kE, iv || c)`.
 
 ### Padding
 
-The padding field is used to align data size,
+The `padding` field is used to align data size,
 since data size alone might reveal important metainformation.
 Padding can be arbitrary size.
-However, it is recommended that the size of Data Field
-(excluding the IV and tag) before encryption (i.e. plain text)
+However, it is recommended that the size of `data` field
+(excluding the `iv` and `tag`) before encryption (i.e. plain text)
 SHOULD be a multiple of 256 bytes.
 
 ### Decoding a message
@@ -196,13 +203,13 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 
 ## References
 
-1. [6/WAKU1](../../legacy/6/waku1.md)
-2. [10/WAKU2 spec](../../core/10/waku2.md)
-3. [14/WAKU-MESSAGE version 1](../../core/14/message.md/#version1)
-4. [7/WAKU-DATA](../../legacy/7/data.md)
+1. [6/WAKU1](waku/standards/legacy/6/waku1.md)
+2. [10/WAKU2 spec](waku/standards/core/10/waku2.md)
+3. [14/WAKU-MESSAGE version 1](waku/standards/core/14/message.md/#version1)
+4. [7/WAKU-DATA](waku/standards/legacy/7/data.md)
 5. [EIP-627: Whisper spec](https://eips.ethereum.org/EIPS/eip-627)
 6. [RLPx Transport Protocol spec (ECIES encryption)](https://github.com/ethereum/devp2p/blob/master/rlpx.md#ecies-encryption)
-7. [Status 5/SECURE-TRANSPORT](https://specs.status.im/spec/5)
+7. [Status 5/SECURE-TRANSPORT](status/deprecated/secure-transport.md)
 8. [Augmented Backus-Naur form (ABNF)](https://tools.ietf.org/html/rfc5234)
 9. [Ethereum "Yellow paper": Appendix F Signing transactions](https://ethereum.github.io/yellowpaper/paper.pdf)
 10. [authenticated encryption](https://en.wikipedia.org/wiki/Authenticated_encryption)

waku/standards/application/53/x3dh.md

@@ -7,11 +7,12 @@ category: Standards Track
 tags: waku-application
 editor: Aaryamann Challani <p1ge0nh8er@proton.me>
 contributors:
-- Andrea Piana <andreap@status.im>
-- Pedro Pombeiro <pedro@status.im>
-- Corey Petty <corey@status.im>
-- Oskar Thorén <oskarth@titanproxy.com>
-- Dean Eigenmann <dean@status.im>
+ - Andrea Piana <andreap@status.im>
+ - Pedro Pombeiro <pedro@status.im>
+ - Corey Petty <corey@status.im>
+ - Oskar Thorén <oskarth@titanproxy.com>
+ - Dean Eigenmann <dean@status.im>
+ - Filip Dimitrijevic <filip@status.im>
 ---
 
 ## Abstract
@@ -38,7 +39,7 @@ without other nodes network being able to read their messages.
 which provide assurances that session keys will not be compromised
 even if the private keys of the participants are compromised.
 Specifically, past messages cannot be decrypted by a third-party
-who manages to get a hold of a private key.
+who manages to obtain those private key.
 
 - **Secret channel** describes a communication channel
 where a Double Ratchet algorithm is in use.
@@ -73,7 +74,7 @@ The main cryptographic protocol is a Double Ratchet protocol,
 which is derived from the
 [Off-the-Record protocol](https://otr.cypherpunks.ca/Protocol-v3-4.1.1.html),
 using a different ratchet.
-[The Waku v2 protocol](../../core/10/waku2.md)
+[The Waku v2 protocol](/waku/standards/core/10/waku2.md)
 subsequently encrypts the message payload, using symmetric key encryption.
 Furthermore, the concept of prekeys
 (through the use of [X3DH](https://signal.org/docs/specifications/x3dh/))
@@ -234,38 +235,41 @@ Where:
     ([reference wire format](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L47))
 
 ```protobuf
-    message X3DHHeader {
-      // Alice's ephemeral key `EK_A`
-      bytes key = 1;
-      // Bob's bundle signed prekey
-      bytes id = 4;
-    }
+message X3DHHeader {
+  // Alice's ephemeral key `EK_A`
+  bytes key = 1;
+  // Bob's bundle signed prekey
+  bytes id = 4;
+}
 ```
 
 - `DR_header`: Double ratchet header ([reference wire format](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L31)).
 Used when Bob's public bundle is available:
 
 ``` protobuf
-    message DRHeader {
-      // Alice's current ratchet public key (as mentioned in [DR spec section 2.2](https://signal.org/docs/specifications/doubleratchet/#symmetric-key-ratchet))
-      bytes key = 1;
-      // number of the message in the sending chain
-      uint32 n = 2;
-      // length of the previous sending chain
-      uint32 pn = 3;
-      // Bob's bundle ID
-      bytes id = 4;
-    }
+message DRHeader {
+  // Alice's current ratchet public key
+  bytes key = 1;
+  // number of the message in the sending chain
+  uint32 n = 2;
+  // length of the previous sending chain
+  uint32 pn = 3;
+  // Bob's bundle ID
+  bytes id = 4;
+}
 ```
 
+Alice's current ratchet public key (above) is mentioned in
+[DR spec section 2.2](https://signal.org/docs/specifications/doubleratchet/#symmetric-key-ratchet)
+
 - `DH_header`: Diffie-Hellman header (used when Bob's bundle is not available):
     ([reference wire format](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L42))
 
 ``` protobuf
-    message DHHeader {
-      // Alice's compressed ephemeral public key.
-      bytes key = 1;
-    }
+message DHHeader {
+  // Alice's compressed ephemeral public key.
+  bytes key = 1;
+}
 ```
 
 #### 3. Chain key update
@@ -286,7 +290,7 @@ The message key MUST be used to encrypt the next message to be sent.
 1. Inherits the security considerations of [X3DH](https://signal.org/docs/specifications/x3dh/#security-considerations)
 and [Double Ratchet](https://signal.org/docs/specifications/doubleratchet/#security-considerations).
 
-2. Inherits the security considerations of the [Waku v2 protocol](../../core/10/waku2.md).
+2. Inherits the security considerations of the [Waku v2 protocol](/waku/standards/core/10/waku2.md).
 
 3. The protocol is designed to be used in a decentralized manner, however,
 it is possible to use a centralized server to serve prekey bundles.
@@ -299,7 +303,8 @@ It is possible to link messages signed by the same keypair.
 
 ## Copyright
 
-Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+Copyright and related rights waived via
+[CC0](https://creativecommons.org/publicdomain/zero/1.0/).
 
 ## References
 
@@ -308,7 +313,7 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 - [Signal's Double Ratchet](https://signal.org/docs/specifications/doubleratchet/)
 - [Protobuf](https://developers.google.com/protocol-buffers/)
 - [Off-the-Record protocol](https://otr.cypherpunks.ca/Protocol-v3-4.1.1.html)
-- [The Waku v2 protocol](../../core/10/waku2.md)
+- [The Waku v2 protocol](/waku/standards/core/10/waku2.md)
 - [HKDF](https://www.rfc-editor.org/rfc/rfc5869)
 - [2/ACCOUNT](https://specs.status.im/spec/2#x3dh-prekey-bundles)
 - [reference wire format](https://github.com/status-im/status-go/blob/a904d9325e76f18f54d59efc099b63293d3dcad3/services/shhext/chat/encryption.proto#L12)

waku/standards/application/54/x3dh-sessions.md

@@ -7,11 +7,12 @@ category: Standards Track
 tags: waku-application
 editor: Aaryamann Challani <p1ge0nh8er@proton.me>
 contributors:
-- Andrea Piana <andreap@status.im>
-- Pedro Pombeiro <pedro@status.im>
-- Corey Petty <corey@status.im>
-- Oskar Thorén <oskarth@titanproxy.com>
-- Dean Eigenmann <dean@status.im>
+ - Andrea Piana <andreap@status.im>
+ - Pedro Pombeiro <pedro@status.im>
+ - Corey Petty <corey@status.im>
+ - Oskar Thorén <oskarth@titanproxy.com>
+ - Dean Eigenmann <dean@status.im>
+ - Filip Dimitrijevic <filip@status.im>
 ---
 
 ## Abstract
@@ -20,7 +21,7 @@ This document specifies how to manage sessions based on an X3DH key exchange.
 This includes how to establish new sessions,
 how to re-establish them, how to maintain them, and how to close them.
 
-[53/WAKU2-X3DH](../53/x3dh.md) specifies the Waku `X3DH` protocol
+[53/WAKU2-X3DH](/waku/standards/application/53/x3dh.md) specifies the Waku `X3DH` protocol
 for end-to-end encryption.
 Once two peers complete an X3DH handshake, they SHOULD establish an X3DH session.
 
@@ -80,12 +81,11 @@ of the shared secret encoded in hexadecimal format.
 
 ```js
 sharedKey, err := ecies.ImportECDSA(myPrivateKey).GenerateShared(
-      ecies.ImportECDSAPublic(theirPublicKey),
-      16,
-      16,
+    ecies.ImportECDSAPublic(theirPublicKey),
+    16,
+    16,
 )
 
-
 hexEncodedKey := hex.EncodeToString(sharedKey)
 
 var hash []byte = keccak256(hexEncodedKey)
@@ -183,7 +183,7 @@ which will notify the receiving end not to include the device in any further com
 
 ## Security Considerations
 
-1. Inherits all security considerations from [53/WAKU2-X3DH](../53/x3dh.md).
+1. Inherits all security considerations from [53/WAKU2-X3DH](/waku/standards/application/53/x3dh.md).
 
 ### Recommendations
 
@@ -194,9 +194,10 @@ which will notify the receiving end not to include the device in any further com
 
 ## Copyright
 
-Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+Copyright and related rights waived via
+[CC0](https://creativecommons.org/publicdomain/zero/1.0/).
 
 ## References
 
-1. [53/WAKU2-X3DH](../53/x3dh.md)
-2. [Signal's Sesame Algorithm](https://signal.org/docs/specifications/sesame/)
+- [53/WAKU2-X3DH](/waku/standards/application/53/x3dh.md)
+- [Signal's Sesame Algorithm](https://signal.org/docs/specifications/sesame/)

waku/standards/core/10/waku2.md

@@ -14,9 +14,9 @@ contributors:
 
 ## Abstract
 
-Waku v2 is family of modular peer-to-peer protocols for secure communication.
+Waku is a family of modular peer-to-peer protocols for secure communication.
 The protocols are designed to be secure, privacy-preserving, censorship-resistant
-and being able to run in resource restricted environments.
+and being able to run in resource-restricted environments.
 At a high level, it implements Pub/Sub over [libp2p](https://github.com/libp2p/specs)
 and adds a set of capabilities to it.
 These capabilities are things such as:
@@ -24,27 +24,27 @@ These capabilities are things such as:
 (ii) adaptive nodes, allowing for heterogeneous nodes to contribute to the network
 (iii) preserving bandwidth usage for resource-restriced devices
 
-This makes Waku ideal for running a p2p protocol on mobile and
-in similarly restricted environments.
+This makes Waku ideal for running a p2p protocol on mobile devices and
+other similar restricted environments.
 
-Historically, it has its roots in [6/WAKU1](../../legacy/6/waku1.md),
+Historically, it has its roots in [6/WAKU1](/waku/standards/legacy/6/waku1.md),
 which stems from [Whisper](https://eips.ethereum.org/EIPS/eip-627),
 originally part of the Ethereum stack.
-However, Waku v2 acts more as a thin wrapper for PubSub and has a different API.
+However, Waku acts more as a thin wrapper for Pub/Sub and has a different API.
 It is implemented in an iterative manner where initial focus
 is on porting essential functionality to libp2p.
 See [rough road map (2020)](https://vac.dev/waku-v2-plan) for more historical context.
 
-## Motivation and goals
+## Motivation and Goals
 
-Waku as a family of protocols is designed to have a set of properties
+Waku, as a family of protocols, is designed to have a set of properties
 that are useful for many applications:
 
 1.**Useful for generalized messaging.**
 
 Many applications require some form of messaging protocol to communicate
 between different subsystems or different nodes.
-This messaging can be human-to-human or machine-to-machine or a mix.
+This messaging can be human-to-human, machine-to-machine or a mix.
 Waku is designed to work for all these scenarios.
 
 2.**Peer-to-peer.**
@@ -62,7 +62,7 @@ Applications often run in restricted environments,
 where resources or the environment is restricted in some fashion.
 For example:
 
-- Limited bandwidth, CPU, memory, disk, battery, etc
+- Limited bandwidth, CPU, memory, disk, battery, etc.
 - Not being publicly connectable
 - Only being intermittently connected; mostly-offline
 
@@ -72,7 +72,7 @@ For example:
 
 - Pseudonymity and not being tied to any personally identifiable information (PII)
 - Metadata protection in transit
-- Various forms of unlinkability, etc
+- Various forms of unlinkability, etc.
 
 5.**Modular design.**
 
@@ -89,25 +89,31 @@ For example:
 - Stronger guarantees for spam protection vs economic registration cost
 
 For more on the concept of adaptive nodes and what this means in practice,
-please see the [30/ADAPTIVE-NODES](../../../informational/30/adaptive-nodes.md) spec.
+please see the [30/ADAPTIVE-NODES](/waku/informational/30/adaptive-nodes.md) spec.
 
-## Network interaction domains
+## Specification
+
+The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
+“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and
+“OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+### Network Interaction Domains
 
 While Waku is best thought of as a single cohesive thing,
 there are three network interaction domains:
 
 (a) gossip domain
 (b) discovery domain
-(c) req/resp domain
+(c) request/response domain
 
-### Protocols and identifiers
+#### Protocols and Identifiers
 
-Since Waku v2 is built on top of libp2p, many protocols have a libp2p protocol identifier.
+Since Waku is built on top of libp2p, many protocols have a libp2p protocol identifier.
 The current main [protocol identifiers](https://docs.libp2p.io/concepts/protocols/)
 are:
 
 1. `/vac/waku/relay/2.0.0`
-2. `/vac/waku/store/2.0.0-beta4`
+2. `/vac/waku/store-query/3.0.0`
 3. `/vac/waku/filter/2.0.0-beta1`
 4. `/vac/waku/lightpush/2.0.0-beta1`
 
@@ -117,19 +123,19 @@ Since these aren't negotiated libp2p protocols,
 they are referred to by their RFC ID.
 For example:
 
-- [14/WAKU2-MESSAGE](../14/message.md) and
-[26/WAKU-PAYLOAD](../../application/26/payload.md) for message payloads
-- [23/WAKU2-TOPICS](../../../informational/23/topics.md) and
-[27/WAKU2-PEERS](../../../informational/27/peers.md) for recommendations around usage
+- [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md) and
+[26/WAKU-PAYLOAD](/waku/standards/application/26/payload.md) for message payloads
+- [23/WAKU2-TOPICS](/waku/informational/23/topics.md) and
+[27/WAKU2-PEERS](/waku/informational/27/peers.md) for recommendations around usage
 
 There are also more experimental libp2p protocols such as:
 
-1. `/vac/waku/swap/2.0.0-beta1`
-2. `/vac/waku/waku-rln-relay/2.0.0-alpha1`
+1. `/vac/waku/waku-rln-relay/2.0.0-alpha1`
+2. `/vac/waku/peer-exchange/2.0.0-alpha1`
 
-These protocols and their semantics are elaborated on in their own specs.
+The semantics of these protocols are referred to by RFC ID [17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md) and [34/WAKU2-PEER-EXCHANGE](/waku/standards/core/34/peer-exchange.md).
 
-### Use of libp2p and protobuf
+#### Use of libp2p and Protobuf
 
 Unless otherwise specified,
 all protocols are implemented over libp2p and use Protobuf by default.
@@ -139,23 +145,24 @@ libp2p protocols prefix binary message payloads with
 the length of the message in bytes.
 This length integer is encoded as a [protobuf varint](https://developers.google.com/protocol-buffers/docs/encoding#varints).
 
-### Gossip domain
+#### Gossip Domain
 
 Waku is using gossiping to disseminate messages throughout the network.
 
 **Protocol identifier**: `/vac/waku/relay/2.0.0`
 
-See [11/WAKU2-RELAY](../11/relay.md) spec for more details.
+See [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) specification for more details.
 
-For an experimental privacy-preserving economic spam protection mechanism, see [17/WAKU2-RLN-RELAY](../17/rln-relay.md).
+For an experimental privacy-preserving economic spam protection mechanism,
+see [17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md).
 
-See [23/WAKU2-TOPICS](../../../informational/23/topics.md)
-for more information about recommended topic usage.
+See [23/WAKU2-TOPICS](/waku/informational/23/topics.md)
+for more information about the recommended topic usage.
 
-### Direct use of libp2p protocols
+#### Direct use of libp2p protocols
 
 In addition to `/vac/waku/*` protocols,
-Waku v2 MAY directly use the following libp2p protocols:
+Waku MAY directly use the following libp2p protocols:
 
 - [libp2p ping protocol](https://docs.libp2p.io/concepts/protocols/#ping)
 with protocol id
@@ -164,14 +171,14 @@ with protocol id
 /ipfs/ping/1.0.0
 ```
 
-for liveness checks between peers, or to keep peer-to-peer connections alive.
+for liveness checks between peers, or
+to keep peer-to-peer connections alive.
 
 - [libp2p identity and identity/push](https://docs.libp2p.io/concepts/protocols/#identify)
 with protocol IDs
 
 ```text
 /ipfs/id/1.0.0
-
 ```
 
 and
@@ -182,167 +189,166 @@ and
 
 respectively, as basic means for capability discovery.
 These protocols are anyway used by the libp2p connection
-establishment layer Waku v2 is built on.
+establishment layer Waku is built on.
 We plan to introduce a new Vac capability discovery protocol
 with better anonymity properties and more functionality.
 
 #### Transports
 
-Waku v2 is built in top of libp2p, and like libp2p it strives to be transport agnostic.
+Waku is built in top of libp2p, and like libp2p it strives to be transport agnostic.
 We define a set of recommended transports in order to achieve a baseline of
 interoperability between clients.
-
 This section describes these recommended transports.
 
 Waku client implementations SHOULD support the TCP transport.
-
 Where TCP is supported it MUST be enabled for both dialing and listening,
 even if other transports are available.
 
-Waku v2 nodes where the environment do not allow to use TCP directly,
+Waku nodes running in environments that do not allow the use of TCP directly,
 MAY use other transports.
 
-A Waku v2 node SHOULD support secure websockets for bidirectional communication streams,
+A Waku node SHOULD support secure websockets for bidirectional communication streams,
 for example in a web browser context.
 
 A node MAY support unsecure websockets if required by the application or
 running environment.
 
-### Discovery domain
+### Discovery Domain
 
-#### Discovery methods
+#### Discovery Methods
 
-Waku v2 can retrieve a list of nodes to connect to using DNS-based discovery
+Waku can retrieve a list of nodes to connect to using DNS-based discovery
 as per [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459).
 While this is a useful way of bootstrapping connection to a set of peers,
 it MAY be used in conjunction with an [ambient peer discovery](https://docs.libp2p.io/concepts/publish-subscribe/#discovery)
-procedure to find still other nodes to connect to,
+procedure to find other nodes to connect to,
 such as [Node Discovery v5](https://github.com/ethereum/devp2p/blob/8fd5f7e1c1ec496a9d8dc1640a8548b8a8b5986b/discv5/discv5.md).
-More ambient peer discovery methods are being tested for Waku v2,
-and will be specified for wider adoption.
 It is possible to bypass the discovery domain by specifying static nodes.
 
 #### Use of ENR
 
 [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)
 describes the usage of [EIP-778 ENR (Ethereum Node Records)](https://eips.ethereum.org/EIPS/eip-778)
-for Waku v2 discovery purposes.
+for Waku discovery purposes.
 It introduces two new ENR fields, `multiaddrs` and
-`waku2`, that a Waku v2 node MAY use for discovery purposes.
-These fields MUST be used under certain conditions, as set out in the spec.
-Both EIP-1459 DNS-based discovery and Node Discovery v5 operates on ENR,
-and it's reasonable to expect even wider utility for ENR in Waku v2 networks in future.
+`waku2`, that a Waku node MAY use for discovery purposes.
+These fields MUST be used under certain conditions, as set out in the specification.
+Both EIP-1459 DNS-based discovery and Node Discovery v5 operate on ENR,
+and it's reasonable to expect even wider utility for ENR in Waku networks in the future.
 
-### Request/Reply domain
+### Request/Response Domain
 
 In addition to the Gossip domain,
-Waku provides a set of Request/Reply protocols.
+Waku provides a set of request/response protocols.
 They are primarily used in order to get Waku to run in resource restricted environments,
 such as low bandwidth or being mostly offline.
 
-#### Historical message support
+#### Historical Message Support
 
-**Protocol identifier***: `/vac/waku/store/2.0.0-beta4`
+**Protocol identifier***: `/vac/waku/store-query/3.0.0`
 
 This is used to fetch historical messages for mostly offline devices.
-See [13/WAKU2-STORE spec](../13/store.md) spec for more details.
+See [13/WAKU2-STORE spec](/waku/standards/core/13/store.md) specification for more details.
 
 There is also an experimental fault-tolerant addition to the store protocol
 that relaxes the high availability requirement.
-See [21/WAKU2-FT-STORE](../../application/21/fault-tolerant-store.md)
+See [21/WAKU2-FAULT-TOLERANT-STORE](/waku/standards/application/21/fault-tolerant-store.md)
 
-#### Content filtering
+#### Content Filtering
 
 **Protocol identifier***: `/vac/waku/filter/2.0.0-beta1`
 
-This is used to make fetching of a subset of messages more bandwidth preserving.
-See [12/WAKU2-FILTER](../12/filter.md) spec for more details.
+This is used to preserve more bandwidth when fetching a subset of messages.
+See [12/WAKU2-FILTER](/waku/standards/core/12/filter.md) specification for more details.
 
-#### Light push
+#### LightPush
 
 **Protocol identifier***: `/vac/waku/lightpush/2.0.0-beta1`
 
 This is used for nodes with short connection windows and
 limited bandwidth to publish messages into the Waku network.
-See [19/WAKU2-LIGHTPUSH](../19/lightpush.md) spec for more details.
+See [19/WAKU2-LIGHTPUSH](/waku/standards/core/19/lightpush.md) specification for more details.
 
-#### Other protocols
+#### Other Protocols
 
 The above is a non-exhaustive list,
 and due to the modular design of Waku,
 there may be other protocols here that provide a useful service to the Waku network.
 
-### Overview of protocol interaction
+### Overview of Protocol Interaction
 
 See the sequence diagram below for an overview of how different protocols interact.
 
-![Overview of how protocols interact in Waku v2.](./images/overview.png)
+![Overview of how protocols interact in Waku.](./images/overview.png)
 
 0. We have six nodes, A-F.
 The protocols initially mounted are indicated as such.
 The PubSub topics `pubtopic1` and
 `pubtopic2` is used for routing and
 indicates that it is subscribed to messages on that topic for relay,
-see [11/WAKU2-RELAY](../11/relay.md) for details.
-Ditto for [13/WAKU2-STORE](../13/store.md)
+see [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) for details.
+Ditto for [13/WAKU2-STORE](/waku/standards/core/13/store.md)
 where it indicates that these messages are persisted on that node.
 
 1. Node A creates a WakuMessage `msg1` with a ContentTopic `contentTopic1`.
-See [14/WAKU2-MESSAGE](../14/message.md) for more details.
+See [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md) for more details.
 If WakuMessage version is set to 1,
-we use the [6/WAKU1](../../legacy/6/waku1.md) compatible `data` field with encryption.
-See [7/WAKU-DATA](../../legacy/7/data.md) for more details.
+we use the [6/WAKU1](/waku/standards/legacy/6/waku1.md) compatible `data` field with encryption.
+See [7/WAKU-DATA](/waku/standards/legacy/7/data.md) for more details.
 
 2. Node F requests to get messages filtered by PubSub topic `pubtopic1` and
 ContentTopic `contentTopic1`.
 Node D subscribes F to this filter and
 will in the future forward messages that match that filter.
-See [12/WAKU2-FILTER](../12/filter.md) for more details.
+See [12/WAKU2-FILTER](/waku/standards/core/12/filter.md) for more details.
 
 3. Node A publishes `msg1` on `pubtopic1` and
-subscribes to that relay topic pick it up.
+subscribes to that relay topic.
 It then gets relayed further from B to D, but
 not C since it doesn't subscribe to that topic.
-See [11/WAKU2-RELAY](../11/relay.md).
+See [11/WAKU2-RELAY](/waku/standards/core/11/relay.md).
 
 4. Node D saves `msg1` for possible later retrieval by other nodes.
-See [13/WAKU2-STORE](../13/store.md).
+See [13/WAKU2-STORE](/waku/standards/core/13/store.md).
 
-5. Node D also pushes `msg1` to F, as it has previously subscribed F to this filter.
-See [12/WAKU2-FILTER](../12/filter.md).
+5. Node D also pushes `msg1` to F,
+as it has previously subscribed F to this filter.
+See [12/WAKU2-FILTER](/waku/standards/core/12/filter.md).
 
 6. At a later time, Node E comes online.
-It then requests messages matching `pubtopic1` and `contentTopic1` from Node D.
-Node D responds with messages meeting this (and possibly other) criteria. See [13/WAKU2-STORE](../13/store.md).
+It then requests messages matching `pubtopic1` and
+`contentTopic1` from Node D.
+Node D responds with messages meeting this (and possibly other) criteria.
+See [13/WAKU2-STORE](/waku/standards/core/13/store.md).
 
 ## Appendix A: Upgradability and Compatibility
 
-### Compatibility with Waku v1
+### Compatibility with Waku Legacy
 
-Waku v1 and Waku v2 are different protocols all together.
+[6/WAKU1](/waku/standards/legacy/6/waku1.md) and Waku are different protocols all together.
 They use a different transport protocol underneath;
-Waku v1 is devp2p RLPx based while Waku v2 uses libp2p.
+[6/WAKU1](/waku/standards/legacy/6/waku1.md) is devp2p RLPx based while Waku uses libp2p.
 The protocols themselves also differ as does their data format.
 Compatibility can be achieved only by using a bridge
 that not only talks both devp2p RLPx and libp2p,
 but that also transfers (partially) the content of a packet from one version
 to the other.
 
-See [15/WAKU-BRIDGE](../15/bridge.md) for details on a bidirectional bridge mode.
+See [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md) for details on a bidirectional bridge mode.
 
 ## Appendix B: Security
 
-Each protocol layer of Waku v2 provides a distinct service and
+Each protocol layer of Waku provides a distinct service and
 is associated with a separate set of security features and concerns.
-Therefore, the overall security of Waku v2
+Therefore, the overall security of Waku
 depends on how the different layers are utilized.
 In this section,
-we overview the security properties of Waku v2 protocols
+we overview the security properties of Waku protocols
 against a static adversarial model which is described below.
 Note that a more detailed security analysis of each Waku protocol
 is supplied in its respective specification as well.
 
-## Primary Adversarial Model
+### Primary Adversarial Model
 
 In the primary adversarial model,
 we consider adversary as a passive entity that attempts to collect information
@@ -357,11 +363,11 @@ between arbitrary pairs of peers
 (unless the adversary is one end of the communication).
 Specifically, the communication channels are assumed to be secure.
 
-## Security Features
+### Security Features
 
-### Pseudonymity
+#### Pseudonymity
 
-Waku v2 by default guarantees pseudonymity for all of the protocol layers
+Waku by default guarantees pseudonymity for all of the protocol layers
 since parties do not have to disclose their true identity
 and instead they utilize libp2p `PeerID` as their identifiers.
 While pseudonymity is an appealing security feature,
@@ -369,7 +375,7 @@ it does not guarantee full anonymity since the actions taken under the same pseu
 i.e., `PeerID` can be linked together and
 potentially result in the re-identification of the true actor.
   
-### Anonymity / Unlinkability
+#### Anonymity / Unlinkability
 
 At a high level,
 anonymity is the inability of an adversary in linking an actor
@@ -384,19 +390,19 @@ hence count as PII.
 Notice that users' actions can be traced through their PIIs
 (e.g., signatures) and hence result in their re-identification risk.
 As such, we seek anonymity by avoiding linkability between actions and
-the actors / actors' PII. Concerning anonymity, Waku v2 provides the following features:
+the actors / actors' PII. Concerning anonymity, Waku provides the following features:
 
 **Publisher-Message Unlinkability**:
 This feature signifies the unlinkability of a publisher
 to its published messages in the 11/WAKU2-RELAY protocol.
-The [Publisher-Message Unlinkability](../11/relay.md/#security-analysis)
+The [Publisher-Message Unlinkability](/waku/standards/core/11/relay.md/#security-analysis)
 is enforced through the `StrictNoSign` policy due to which the data fields
 of pubsub messages that count as PII for the publisher must be left unspecified.
 
 **Subscriber-Topic Unlinkability**:
 This feature stands for the unlinkability of the subscriber
 to its subscribed topics in the 11/WAKU2-RELAY protocol.
-The [Subscriber-Topic Unlinkability](../11/relay.md/#security-analysis)
+The [Subscriber-Topic Unlinkability](/waku/standards/core/11/relay.md/#security-analysis)
 is achieved through the utilization of a single PubSub topic.
 As such, subscribers are not re-identifiable from their subscribed topic IDs
 as the entire network is linked to the same topic ID.
@@ -405,7 +411,7 @@ where k is proportional to the system size (number of subscribers).
 Note that there is no hard limit on the number of the pubsub topics, however,
 the use of one topic is recommended for the sake of anonymity.
 
-### Spam protection
+#### Spam protection
 
 This property indicates that no adversary can flood the system
 (i.e., publishing a large number of messages in a short amount of time),
@@ -413,19 +419,19 @@ either accidentally or deliberately, with any kind of message
 i.e. even if the message content is valid or useful.
 Spam protection is partly provided in `11/WAKU2-RELAY`
 through the [scoring mechanism](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/gossipsub-v1.1.md#spam-protection-measures)
- rovided for by GossipSub v1.1.
+provided for by GossipSub v1.1.
 At a high level,
 peers utilize a scoring function to locally score the behavior
 of their connections and remove peers with a low score.
   
-### Data confidentiality, Integrity, and Authenticity
+#### Data confidentiality, Integrity, and Authenticity
 
 Confidentiality can be addressed through data encryption whereas integrity and
 authenticity are achievable through digital signatures.
-These features are provided for in [14/WAKU2-MESSAGE (version 1)](../14/message.md/#version-1)`
+These features are provided for in [14/WAKU2-MESSAGE (version 1)](/waku/standards/core/14/message.md/#version-1)`
 through payload encryption as well as encrypted signatures.
 
-## Security Considerations
+### Security Considerations
 
 Lack of anonymity/unlinkability in the protocols involving direct connections
 including `13/WAKU2-STORE` and `12/WAKU2-FILTER` protocols:
@@ -454,51 +460,51 @@ the security features of each layer-->
 
 ### Implementation Matrix
 
-There are multiple implementations of Waku v2 and its protocols:
+There are multiple implementations of Waku and its protocols:
 
 - [nim-waku (Nim)](https://github.com/status-im/nim-waku/)
 - [go-waku (Go)](https://github.com/status-im/go-waku/)
 - [js-waku (NodeJS and Browser)](https://github.com/status-im/js-waku/)
 
-Below you can find an overview of the specs that they implement
-as they relate to Waku v2.
-This includes Waku v1 specs, as they are used for bridging between the two networks.
+Below you can find an overview of the specifications that they implement
+as they relate to Waku.
+This includes Waku legacy specifications, as they are used for bridging between the two networks.
 
 | Spec | nim-waku (Nim) | go-waku (Go) | js-waku (Node JS) | js-waku (Browser JS) |
 | ---- | -------------- | ------------ | ----------------- | -------------------- |
-|[6/WAKU1](../../legacy/6/waku1.md)|✔||||
-|[7/WAKU-DATA](../../legacy/7/data.md)|✔|✔|||
-|[8/WAKU-MAIL](../../legacy/8/mail.md)|✔||||
-|[9/WAKU-RPC](../../legacy/9/rpc.md)|✔||||
-|[10/WAKU2](../10/waku2.md)|✔|🚧|🚧|🚧|
-|[11/WAKU2-RELAY](../11/relay.md)|✔|✔|✔|✔|
-|[12/WAKU2-FILTER](../12/filter.md)|✔|✔|||
-|[13/WAKU2-STORE](../13/store.md)|✔|✔|✔\*|✔\*|
-|[14/WAKU2-MESSAGE](../14/message.md))|✔|✔|✔|✔|
-|[15/WAKU2-BRIDGE](../15/bridge.md)|✔||||
-|[16/WAKU2-RPC](../16/rpc.md)|✔||||
-|[17/WAKU2-RLN-RELAY](../17/rln-relay.md)|🚧||||
-|[18/WAKU2-SWAP](../../application/18/swap.md)|🚧||||
-|[19/WAKU2-LIGHTPUSH](../19/lightpush.md)|✔|✔|✔\**|✔\**|
-|[21/WAKU2-FAULT-TOLERANT-STORE](../../application/21/fault-tolerant-store.md)|✔|✔|||
+|[6/WAKU1](/waku/standards/legacy/6/waku1.md)|✔||||
+|[7/WAKU-DATA](/waku/standards/legacy/7/data.md)|✔|✔|||
+|[8/WAKU-MAIL](/waku/standards/legacy/8/mail.md)|✔||||
+|[9/WAKU-RPC](/waku/standards/legacy/9/rpc.md)|✔||||
+|[10/WAKU2](/waku/standards/core/10/waku2.md)|✔|🚧|🚧|✔|
+|[11/WAKU2-RELAY](/waku/standards/core/11/relay.md)|✔|✔|✔|✔|
+|[12/WAKU2-FILTER](/waku/standards/core/12/filter.md)|✔|✔|||
+|[13/WAKU2-STORE](/waku/standards/core/13/store.md)|✔|✔|✔\*|✔\*|
+|[14/WAKU2-MESSAGE](/waku/standards/core/14/message.md))|✔|✔|✔|✔|
+|[15/WAKU2-BRIDGE](/waku/standards/core/15/bridge.md)|✔||||
+|[16/WAKU2-RPC](/waku/deprecated/16/rpc.md)|✔||||
+|[17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md)|🚧||||
+|[18/WAKU2-SWAP](/waku/standards/application/18/swap.md)|🚧||||
+|[19/WAKU2-LIGHTPUSH](/waku/standards/core/19/lightpush.md)|✔|✔|✔\**|✔\**|
+|[21/WAKU2-FAULT-TOLERANT-STORE](/waku/standards/application/21/fault-tolerant-store.md)|✔|✔|||
 
-*js-waku implements [13/WAKU2-STORE](../13/store.md) as a querying node only.
-**js-waku only implements [19/WAKU2-LIGHTPUSH](../19/lightpush.md) requests.
+*js-waku implements [13/WAKU2-STORE](/waku/standards/core/13/store.md) as a querying node only.
+**js-waku only implements [19/WAKU2-LIGHTPUSH](/waku/standards/core/19/lightpush.md) requests.
 
-### Recommendations for clients
+### Recommendations for Clients
 
-To implement a minimal Waku v2 client,
+To implement a minimal Waku client,
 we recommend implementing the following subset in the following order:
 
-- [10/WAKU2](../10/waku2.md) - this spec
-- [11/WAKU2-RELAY](../11/relay.md) - for basic operation
-- [14/WAKU2-MESSAGE](../14/message.md) - version 0 (unencrypted)
-- [13/WAKU2-STORE](../13/store.md) - for historical messaging (query mode only)
+- [10/WAKU2](/waku/standards/core/10/waku2.md) - this specification
+- [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) - for basic operation
+- [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md) - version 0 (unencrypted)
+- [13/WAKU2-STORE](/waku/standards/core/13/store.md) - for historical messaging (query mode only)
 
-To get compatibility with Waku v1:
+To get compatibility with Waku Legacy:
 
-- [7/WAKU-DATA](../../legacy/7/data.md)
-- [14/WAKU2-MESSAGE](../14/message.md) - version 1 (encrypted with `7/WAKU-DATA`)
+- [7/WAKU-DATA](/waku/standards/legacy/7/data.md)
+- [14/WAKU2-MESSAGE](/waku/standards/14/message.md) - version 1 (encrypted with `7/WAKU-DATA`)
 
 For an interoperable keep-alive mechanism:
 
@@ -507,13 +513,14 @@ with periodic pings to connected peers
 
 ## Appendix D: Future work
 
-The following features are currently experimental and under research and
-initial implementation:
+The following features are currently experimental,
+under research and initial implementations:
+
+**Economic Spam Resistance**:
 
-**Economic Spam resistance**:
 We aim to enable an incentivized spam protection technique
 to enhance `11/WAKU2-RELAY` by using rate limiting nullifiers.
-More details on this can be found in [17/WAKU2-RLN-RELAY](../17/rln-relay.md).
+More details on this can be found in [17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md).
 In this advanced method,
 peers are limited to a certain rate of messaging per epoch and
 an immediate financial penalty is enforced for spammers who break this rate.
@@ -522,7 +529,7 @@ an immediate financial penalty is enforced for spammers who break this rate.
 Denial of service signifies the case where an adversarial node
 exhausts another node's service capacity (e.g., by making a large number of requests)
 and makes it unavailable to the rest of the system.
-DoS attack is to be mitigated through the accounting model as described in [18/WAKU2-SWAP](../../application/18/swap.md).
+DoS attack is to be mitigated through the accounting model as described in [18/WAKU2-SWAP](/waku/deprecated/18/swap.md).
 In a nutshell, peers have to pay for the service they obtain from each other.
 In addition to incentivizing the service provider,
 accounting also makes DoS attacks costly for malicious peers.
@@ -531,7 +538,7 @@ The accounting model can be used in `13/WAKU2-STORE` and
 
 Additionally, this gives node operators who provide a useful service to the network
 an incentive to perform that service.
-See [18/WAKU2-SWAP](../../application/18/swap.md)
+See [18/WAKU2-SWAP](/waku/deprecated/18/swap.md)
 for more details on this piece of work.
 
 ## Copyright
@@ -542,31 +549,31 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 
 1. [libp2p specs](https://github.com/libp2p/specs)
 
-2. [6/WAKU1](../../legacy/6/waku1.md)
+2. [6/WAKU1](/waku/standards/legacy/6/waku1.md)
 
 3. [Whisper spec (EIP627)](https://eips.ethereum.org/EIPS/eip-627)
 
 4. [Waku v2 plan](https://vac.dev/waku-v2-plan)
 
-5. [30/ADAPTIVE-NODES](../../../informational/30/adaptive-nodes.md)
+5. [30/ADAPTIVE-NODES](/waku/informational/30/adaptive-nodes.md)
 
 6. [Protocol Identifiers](https://docs.libp2p.io/concepts/protocols/)
 
-7. [14/WAKU2-MESSAGE](../14/message.md)
+7. [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md)
 
-8. [26/WAKU-PAYLOAD](../../application/26/payload.md)
+8. [26/WAKU-PAYLOAD](/waku/standards/application/26/payload.md)
 
-9. [23/WAKU2-TOPICS](../../../informational/23/topics.md)
+9. [23/WAKU2-TOPICS](/waku/informational/23/topics.md)
 
-10. [27/WAKU2-PEERS](../../../informational/27/peers.md)
+10. [27/WAKU2-PEERS](/waku/informational/27/peers.md)
 
 11. [bi-directional binary stream](https://docs.libp2p.io/concepts/protocols/)
 
 12. [Protobuf varint encoding](https://developers.google.com/protocol-buffers/docs/encoding#varints)
 
-13. [11/WAKU2-RELAY spec](../11/relay.md)
+13. [11/WAKU2-RELAY spec](/waku/standards/core/11/relay.md)
 
-14. [17/WAKU2-RLN-RELAY](../17/rln-relay.md)
+14. [17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md)
 
 15. [EIP-1459](https://eips.ethereum.org/EIPS/eip-1459)
 
@@ -578,17 +585,17 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 
 19. [EIP-778 ENR (Ethereum Node Records)](https://eips.ethereum.org/EIPS/eip-778)
 
-20. [13/WAKU2-STORE spec](../13/store.md)
+20. [13/WAKU2-STORE spec](/waku/standards/core/13/store.md)
 
-21. [21/WAKU2-FT-STORE](../../application/21/ft-store.md)
+21. [21/WAKU2-FT-STORE](/waku/standards/application/21/ft-store.md)
 
-22. [12/WAKU2-FILTER](../12/filter.md)
+22. [12/WAKU2-FILTER](/waku/standards/core/12/filter.md)
 
-23. [19/WAKU2-LIGHTPUSH](../19/lightpush.md)
+23. [19/WAKU2-LIGHTPUSH](/waku/standards/core/19/lightpush.md)
 
-24. [7/WAKU-DATA](../../legacy/7/data.md)
+24. [7/WAKU-DATA](/waku/standards/legacy/7/data.md)
 
-25. [15/WAKU-BRIDGE](../15/bridge.md)
+25. [15/WAKU-BRIDGE](/waku/standards/core/15/bridge.md)
 
 26. [k-anonymity](https://www.privitar.com/blog/k-anonymity-an-introduction/)
 
@@ -600,12 +607,12 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 
 30. [js-waku (NodeJS and Browser)](https://github.com/status-im/js-waku/)
 
-31. [8/WAKU-MAIL](../../legacy/8/mail.md)
+31. [8/WAKU-MAIL](/waku/standards/legacy/8/mail.md)
 
-32. [9/WAKU-RPC](../../legacy/9/rpc.md)
+32. [9/WAKU-RPC](/waku/standards/legacy/9/rpc.md)
 
-33. [16/WAKU2-RPC](../16/rpc.md)
+33. [16/WAKU2-RPC](waku/deprecated/16/rpc.md)
 
-34. [18/WAKU2-SWAP spec](../../application/18/swap.md)
+34. [18/WAKU2-SWAP spec](waku/deprecated/18/swap.md)
 
 35. [21/WAKU2-FAULT-TOLERANT-STORE](../../application/21/fault-tolerant-store.md)

waku/standards/core/12/filter.md

@@ -13,61 +13,54 @@ contributors:
   - Ebube Ud <ebube@status.im>
 ---
 
-previous versions: [00](./previous-versions00)
-
----
-
-`WakuFilter` is a protocol that enables subscribing to messages that a peer receives.
-This is a more lightweight version of `WakuRelay`
-specifically designed for bandwidth restricted devices.
-This is due to the fact that light nodes subscribe to full-nodes and
-only receive the messages they desire.
-
-## Content filtering
+previous versions: [00](/waku/standards/core/12/previous-versions/00/filter.md)
 
 **Protocol identifiers**:
 
 - _filter-subscribe_: `/vac/waku/filter-subscribe/2.0.0-beta1`
 - _filter-push_: `/vac/waku/filter-push/2.0.0-beta1`
 
-Content filtering is a way to do [message-based
-filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering).
-Currently the only content filter being applied is on `contentTopic`. This
-corresponds to topics in Waku v1.
+---
 
-## Rationale
+## Abstract
 
-Unlike the `store` protocol for historical messages, this protocol allows for
-native lower latency scenarios such as instant messaging. It is thus
-complementary to it.
+This specification describes the `12/WAKU2-FILTER` protocol,
+which enables a client to subscribe to a subset of real-time messages from a Waku peer.
+This is a more lightweight version of [11/WAKU2-RELAY](/waku/standards/core/11/relay.md),
+useful for bandwidth restricted devices.
+This is often used by nodes with lower resource limits to subscribe to full Relay nodes and
+only receive the subset of messages they desire,
+based on content topic interest.
 
-Strictly speaking, it is not just doing basic request response, but performs
-sender push based on receiver intent. While this can be seen as a form of light
-pub/sub, it is only used between two nodes in a direct fashion. Unlike the
-Gossip domain, this is meant for light nodes which put a premium on bandwidth.
+## Motivation
+
+Unlike the [13/WAKU2-STORE](/waku/standards/core/13/store.md) protocol
+for historical messages, this protocol allows for native lower latency scenarios,
+such as instant messaging.
+It is thus complementary to it.
+
+Strictly speaking, it is not just doing basic request-response, but
+performs sender push based on receiver intent.
+While this can be seen as a form of light publish/subscribe,
+it is only used between two nodes in a direct fashion. Unlike the
+Gossip domain, this is suitable for light nodes which put a premium on bandwidth.
 No gossiping takes place.
 
-It is worth noting that a light node could get by with only using the `store`
-protocol to query for a recent time window, provided it is acceptable to do
-frequent polling.
+It is worth noting that a light node could get by with only using the
+[13/WAKU2-STORE](/waku/standards/core/13/store.md) protocol to
+query for a recent time window, provided it is acceptable to do frequent polling.
 
-## Design Requirements
+## Semantics
 
-The effectiveness and reliability of the content filtering service enabled by  
-`WakuFilter` protocol rely on the _high availability_ of the full nodes
-as the service providers.
-To this end, full nodes must feature _high uptime_
-(to persistently listen and capture the network messages)
-as well as _high Bandwidth_ (to provide timely message delivery to the light nodes).
+The key words “MUST”, “MUST NOT”, “REQUIRED”,
+“SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and
+“OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
 
-## Security Consideration
+### Content filtering
 
-Note that while using `WakuFilter` allows light nodes to save bandwidth,
-it comes with a privacy cost in the sense that they need to
-disclose their liking topics to the full nodes to retrieve the relevant messages.
-Currently, anonymous subscription is not supported by the `WakuFilter`, however,
-potential solutions in this regard are sketched
-below in [Future Work](#future-work) section.
+Content filtering is a way to do
+[message-based filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering).
+Currently the only content filter being applied is on `contentTopic`.
 
 ### Terminology
 
@@ -76,33 +69,11 @@ refers to any piece of data that can be used to uniquely identify a user.
 For example, the signature verification key, and
 the hash of one's static IP address are unique for each user and hence count as PII.
 
-## Adversarial Model
-
-Any node running the `WakuFilter` protocol
-i.e., both the subscriber node and the queried node are considered as an adversary.
-Furthermore, we consider the adversary as a passive entity
-that attempts to collect information from other nodes to conduct an attack but
-it does so without violating protocol definitions and instructions.
-For example, under the passive adversarial model,
-no malicious node intentionally hides the messages
-matching to one's subscribed content filter
-as it is against the description of the `WakuFilter` protocol.
-
-The following are not considered as part of the adversarial model:
-
-- An adversary with a global view of all the nodes and their connections.
-- An adversary that can eavesdrop on communication links
-between arbitrary pairs of nodes (unless the adversary is one end of the communication).
-In specific, the communication channels are assumed to be secure.
-
 ### Protobuf
 
 ```protobuf
 syntax = "proto3";
 
-// 12/WAKU2-FILTER rfc: https://rfc.vac.dev/spec/12/
-package waku.filter.v2;
-
 // Protocol identifier: /vac/waku/filter-subscribe/2.0.0-beta1
 message FilterSubscribeRequest {
   enum FilterSubscribeType {
@@ -145,7 +116,6 @@ in its registered subscriptions.
 
 Since a filter service node is consuming resources to provide this service,
 it MAY account for usage and adapt its service provision to certain clients.
-An incentive mechanism is currently planned but underspecified.
 
 #### Filter Subscribe Request
 
@@ -156,8 +126,8 @@ Each request MUST include a `filter_subscribe_type`, indicating the type of requ
 
 #### Filter Subscribe Response
 
-In return to any `FilterSubscribeRequest`,
-a filter service node SHOULD respond with a `FilterSubscribeResponse`
+When responding to a `FilterSubscribeRequest`,
+a filter service node SHOULD send a `FilterSubscribeResponse`
 with a `requestId` matching that of the request.
 This response MUST contain a `status_code` indicating if the request was successful
 or not.
@@ -178,41 +148,43 @@ conditional to the selected `filter_subscribe_type`.
 If the request contains filter criteria,
 it MUST contain a `pubsub_topic`
 and the `content_topics` set MUST NOT be empty.
-A `WakuMessage` matches filter criteria
+A [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md) matches filter criteria
 when its `content_topic` is in the `content_topics` set
 and it was published on a matching `pubsub_topic`.
 
 #### Filter Subscribe Types
 
-The following filter subscribe types are defined:
+The filter-subscribe types are defined as follows:
 
 ##### SUBSCRIBER_PING
 
 A filter client that sends a `FilterSubscribeRequest` with
-`filter_subscribe_type` set to `SUBSCRIBER_PING`
-requests that the service node SHOULD indicate if it has any active subscriptions
+`filter_subscribe_type` set to `SUBSCRIBER_PING`,
+requests that the filter service node SHOULD indicate if it has any active subscriptions
 for this client.
 The filter client SHOULD exclude any filter criteria from the request.
-The filter service node SHOULD respond with a success code
+The filter service node SHOULD respond with a success `status_code`
 if it has any active subscriptions for this client
-or an error code if not.
+or an error `status_code` if not.
 The filter service node SHOULD ignore any filter criteria in the request.
 
 ##### SUBSCRIBE
 
 A filter client that sends a `FilterSubscribeRequest` with
 `filter_subscribe_type` set to `SUBSCRIBE`
-requests that the service node SHOULD push messages matching this filter to the client.
+requests that the filter service node SHOULD push messages
+matching this filter to the client.
 The filter client MUST include the desired filter criteria in the request.
 A client MAY use this request type to _modify_ an existing subscription
 by providing _additional_ filter criteria in a new request.
 A client MAY use this request type to _refresh_ an existing subscription
 by providing _the same_ filter criteria in a new request.
-The filter service node SHOULD respond with a success code
+The filter service node SHOULD respond with a success `status_code`
 if it successfully honored this request
-or an error code if not.
-The filter service node SHOULD respond with an error code and discard the request
-if the subscribe request does not contain valid filter criteria,
+or an error `status_code` if not.
+The filter service node SHOULD respond with an error `status_code` and
+discard the request if the `FilterSubscribeRequest`
+does not contain valid filter criteria,
 i.e. both a `pubsub_topic` _and_ a non-empty `content_topics` set.
 
 ##### UNSUBSCRIBE
@@ -226,11 +198,11 @@ it desires to unsubscribe from in the request.
 A client MAY use this request type to _modify_ an existing subscription
 by providing _a subset of_ the original filter criteria
 to unsubscribe from in a new request.
-The filter service node SHOULD respond with a success code
+The filter service node SHOULD respond with a success `status_code`
 if it successfully honored this request
-or an error code if not.
-The filter service node SHOULD respond with an error code and discard the request
-if the unsubscribe request does not contain valid filter criteria,
+or an error `status_code` if not.
+The filter service node SHOULD respond with an error `status_code` and
+discard the request if the unsubscribe request does not contain valid filter criteria,
 i.e. both a `pubsub_topic` _and_ a non-empty `content_topics` set.
 
 ##### UNSUBSCRIBE_ALL
@@ -241,8 +213,8 @@ requests that the service node SHOULD _stop_ pushing messages
 matching _any_ filter to the client.
 The filter client SHOULD exclude any filter criteria from the request.
 The filter service node SHOULD remove any existing subscriptions for this client.
-It SHOULD respond with a success code if it successfully honored this request
-or an error code if not.
+It SHOULD respond with a success `status_code` if it successfully honored this request
+or an error `status_code` if not.
 
 ### Filter-Push
 
@@ -253,7 +225,8 @@ matching registered subscriptions to this client.
 A filter service node SHOULD push all messages
 matching the filter criteria in a registered subscription
 to the subscribed filter client.
-These [`WakuMessage`s](../14/message.md) are likely to come from [`11/WAKU2-RELAY`](../11/relay.md),
+These [`WakuMessage`s](/waku/standards/core/14/message.md)
+are likely to come from [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md),
 but there MAY be other sources or protocols where this comes from.
 This is up to the consumer of the protocol.
 
@@ -264,7 +237,7 @@ for a period of time,
 the filter service node MAY choose to stop pushing messages to the client and
 remove its subscription.
 This period is up to the service node implementation.
-We consider `1 minute` to be a reasonable default.
+It is RECOMMENDED to set `1 minute` as a reasonable default.
 
 #### Message Push
 
@@ -280,9 +253,35 @@ A filter client SHOULD verify that each `MessagePush` it receives
 originated from a service node where the client has an active subscription
 and that it matches filter criteria belonging to that subscription.
 
----
+### Adversarial Model
 
-## Future Work
+Any node running the `WakuFilter` protocol
+i.e., both the subscriber node and
+the queried node are considered as an adversary.
+Furthermore, we consider the adversary as a passive entity
+that attempts to collect information from other nodes to conduct an attack but
+it does so without violating protocol definitions and instructions.
+For example, under the passive adversarial model,
+no malicious node intentionally hides the messages
+matching to one's subscribed content filter
+as it is against the description of the `WakuFilter` protocol.
+
+The following are not considered as part of the adversarial model:
+
+- An adversary with a global view of all the nodes and their connections.
+- An adversary that can eavesdrop on communication links
+between arbitrary pairs of nodes (unless the adversary is one end of the communication).
+In specific, the communication channels are assumed to be secure.
+
+### Security Considerations
+
+Note that while using `WakuFilter` allows light nodes to save bandwidth,
+it comes with a privacy cost in the sense that they need to
+disclose their liking topics to the full nodes to retrieve the relevant messages.
+Currently, anonymous subscription is not supported by the `WakuFilter`, however,
+potential solutions in this regard are discussed below.
+
+#### Future Work
 <!-- Alternative title: Filter-subscriber unlinkability -->
 **Anonymous filter subscription**:
 This feature guarantees that nodes can anonymously subscribe for a message filter
@@ -318,25 +317,6 @@ Examples of such 2PC protocols are
 [Oblivious Transfers](https://link.springer.com/referenceworkentry/10.1007%2F978-1-4419-5906-5_9#:~:text=Oblivious%20transfer%20(OT)%20is%20a,information%20the%20receiver%20actually%20obtains.)
 and one-way Private Set Intersections (PSI).
 
-## Changelog
-
-### Next
-
-- Added initial threat model and security analysis.
-
-### 2.0.0-beta2
-
-Initial draft version. Released [2020-10-28](https://github.com/vacp2p/specs/commit/5ceeb88cee7b918bb58f38e7c4de5d581ff31e68)
-
-- Fix: Ensure contentFilter is a repeated field, on implementation
-- Change: Add ability to unsubscribe from filters.
-Make `subscribe` an explicit boolean indication.
-Edit protobuf field order to be consistent with libp2p.
-
-### 2.0.0-beta1
-
-Initial draft version. Released [2020-10-05](https://github.com/vacp2p/specs/commit/31857c7434fa17efc00e3cd648d90448797d107b)
-
 ## Copyright
 
 Copyright and related rights waived via
@@ -344,13 +324,14 @@ Copyright and related rights waived via
 
 ## References
 
-- [message-based
-filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering)
-- [`WakuMessage`s](../14/message.md)
-- [`11/WAKU2-RELAY`](../11/relay.md)
+- [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
+- [message-based filtering](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering)
+- [13/WAKU2-STORE](/waku/standards/core/13/store.md)
+- [14/WAKU2-MESSAGE](/waku/standards/core/14/message.md)
 - [Oblivious Transfers](https://link.springer.com/referenceworkentry/10.1007%2F978-1-4419-5906-5_9#:~:text=Oblivious%20transfer%20(OT)%20is%20a,information%20the%20receiver%20actually%20obtains)
-- previous versions: [00](./previous-versions00)
+- 12/WAKU2-FILTER previous version: [00](waku/standards/core/12/previous-versions/00/filter.md)
+
+### Informative
 
 1. [Message Filtering (Wikipedia)](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern#Message_filtering)
-
 2. [Libp2p PubSub spec - topic validation](https://github.com/libp2p/specs/tree/master/pubsub#topic-validation)

waku/standards/core/12/previous-versions/00/filter.md

@@ -4,6 +4,7 @@ title: 12/WAKU2-FILTER
 name: Waku v2 Filter
 status: draft
 tags: waku-core
+version: v00
 editor: Hanno Cornelius <hanno@status.im>
 contributors:
   - Dean Eigenmann <dean@status.im>
@@ -11,9 +12,8 @@ contributors:
   - Sanaz Taheri <sanaz@status.im>
   - Ebube Ud <ebube@status.im>
 ---
-version: 00
 
----
+
 `WakuFilter` is a protocol that enables subscribing to messages that a peer receives.
 This is a more lightweight version of `WakuRelay`
 specifically designed for bandwidth restricted devices.

waku/standards/core/13/store.md

@@ -2,6 +2,7 @@
 slug: 13
 title: 13/WAKU2-STORE
 name: Waku Store Query
+status: draft
 tags: waku-core
 version: 01
 editor: Hanno Cornelius <hanno@status.im>
@@ -11,7 +12,7 @@ contributors:
   - Aaryamann Challani <p1ge0nh8er@proton.me>
   - Sanaz Taheri <sanaz@status.im>
 ---
-Previous version: [00](waku/standards/core/13/previous-versions/00/store.md)
+Previous version: [00](/waku/standards/core/13/previous-versions/00/store.md)
 
 ## Abstract
 

waku/standards/core/14/message.md

@@ -2,7 +2,7 @@
 slug: 14
 title: 14/WAKU2-MESSAGE
 name: Waku v2 Message
-status: draft
+status: stable
 category: Standards Track
 tags: waku/core-protocol
 editor: Hanno Cornelius <hanno@status.im>
@@ -16,15 +16,17 @@ contributors:
 
 ## Abstract
 
-Waku v2 is a family of modular peer-to-peer protocols for secure communication.
+[10/WAKU2](/waku/standards/core/10/waku2.md) is a family of modular peer-to-peer protocols
+for secure communication.
 These protocols are designed to be secure, privacy-preserving,
 and censorship-resistant and can run in resource-restricted environments.
-At a high level, Waku v2 implements a Pub/Sub messaging pattern over libp2p and
+At a high level,
+[10/WAKU2](/waku/standards/core/10/waku2.md) implements a publish/subscribe messaging pattern over libp2p and
 adds capabilities.
 
-The present document specifies the Waku v2 message format,
-a way to encapsulate the messages sent with specific information security goals,
-and Whisper/Waku v1 backward compatibility.
+The present document specifies the [10/WAKU2](/waku/standards/core/10/waku2.md) message format.
+A way to encapsulate the messages sent with specific information security goals,
+and Whisper/[6/WAKU1](/waku/standards/legacy/6/waku1.md) backward compatibility.
 
 ## Motivation
 
@@ -32,7 +34,7 @@ When sending messages over Waku, there are multiple requirements:
 
 - One may have a separate encryption layer as part of the application.
 - One may want to provide efficient routing for resource-restricted devices.
-- One may want to provide compatibility with [Waku v1 envelopes](../../legacy/6/waku1.md).
+- One may want to provide compatibility with [6/WAKU1](/waku/standards/legacy/6/waku1.md) envelopes.
 - One may want encrypted payloads by default.
 - One may want to provide unlinkability to get metadata protection.
 
@@ -40,16 +42,20 @@ This specification attempts to provide for these various requirements.
 
 ## Semantics
 
+The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
+“SHOULD NOT”, “RECOMMENDED”, “MAY”, and
+“OPTIONAL” in this document are to be interpreted as described in [2119](https://www.ietf.org/rfc/rfc2119.txt).
+
 ### Waku Message
 
-A Waku message is constituted by the combination of data payload and
+A `WakuMessage` is constituted by the combination of data payload and
 attributes that, for example, a *publisher* sends to a *topic* and
 is eventually delivered to *subscribers*.
 
-Waku message attributes are key-value pairs of metadata associated with a message.
-And the message data payload is the part of the transmitted Waku message
+The `WakuMessage` attributes are key-value pairs of metadata associated with a message.
+The message data payload is the part of the transmitted `WakuMessage`
 that is the actual message information.
-The data payload is also treated as a Waku message attribute for convenience.
+The data payload is also treated as a `WakuMessage` attribute for convenience.
 
 ### Message Attributes
 
@@ -57,13 +63,13 @@ The data payload is also treated as a Waku message attribute for convenience.
 
 - The `content_topic` attribute MUST specify a string identifier
 that can be used for content-based filtering,
-as described in [23/WAKU2-TOPICS](../../../informational/23/topics.md).
+as described in [23/WAKU2-TOPICS](/waku/informational/23/topics.md).
 
 - The `meta` attribute, if present,
 contains an arbitrary application-specific variable-length byte array
 with a maximum length limit of 64 bytes.
 This attribute can be utilized to convey supplementary details
-to various Waku protocols,
+to various [10/WAKU2](/waku/standards/core/10/waku2.md) protocols,
 thereby enabling customized processing based on its contents.
 
 - The `version` attribute, if present,
@@ -75,15 +81,18 @@ signifies the time at which the message was generated by its sender.
 This attribute MAY contain the Unix epoch time in nanoseconds.
 If the attribute is omitted, it SHOULD be interpreted as timestamp 0.
 
+- The `rate_limit_proof` attribute, if present,
+contains a rate limit proof encoded as per [17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md).
+
 - The `ephemeral` attribute, if present, signifies the transient nature of the message.
-For example, an ephemeral message SHOULD not be persisted by the Waku network.
+For example, an ephemeral message SHOULD not be persisted by other nodes on the same network.
 If this attribute is set to `true`, the message SHOULD be interpreted as ephemeral.
 If, instead, the attribute is omitted or set to `false`,
 the message SHOULD be interpreted as non-ephemeral.
 
 ## Wire Format
 
-The Waku message wire format is specified using [protocol buffers v3](https://developers.google.com/protocol-buffers/).
+The `WakuMessage` wire format is specified using [protocol buffers v3](https://developers.google.com/protocol-buffers/).
 
 ```protobuf
 syntax = "proto3";
@@ -94,6 +103,7 @@ message WakuMessage {
   optional uint32 version = 3;
   optional sint64 timestamp = 10;
   optional bytes meta = 11;
+  optional bytes rate_limit_proof = 21;
   optional bool ephemeral = 31;
 }
 ```
@@ -102,7 +112,7 @@ An example proto file following this specification can be found [here (vacp2p/wa
 
 ## Payload encryption
 
-The Waku message payload MAY be encrypted.
+The `WakuMessage` payload MAY be encrypted.
 The message `version` attribute indicates
 the schema used to encrypt the payload data.
 
@@ -112,28 +122,28 @@ the schema used to encrypt the payload data.
   at the application layer.
 
 - **Version 1:**
-The payload SHOULD be encrypted using Waku v1 payload encryption specified in [26/WAKU-PAYLOAD](../../application/26/payload.md).
+The payload SHOULD be encrypted using [6/WAKU1](/waku/standards/legacy/6/waku1.md) payload encryption specified in [26/WAKU-PAYLOAD](/waku/standards/application/26/payload.md).
 This provides asymmetric and symmetric encryption.
 The key agreement is performed out of band.
 And provides an encrypted signature and padding for some form of unlinkability.
 
 - **Version 2:**
 The payload SHOULD be encoded according to [WAKU2-NOISE](https://github.com/waku-org/specs/blob/master/standards/application/noise.md).
-Waku Noise protocol provides symmetric encryption and asymmetric key exchange.
+The Waku Noise protocol provides symmetric encryption and asymmetric key exchange.
 
 Any `version` value not included in this list is reserved for future specification.
 And, in this case, the payload SHOULD be interpreted as unencrypted by the Waku layer.
 
-## Whisper/Waku v1 envelope compatibility
+## Whisper/[6/WAKU1](/waku/standards/legacy/6/waku1.md) envelope compatibility
 
-Whisper/Waku v1 envelopes are compatible with Waku v2 messages format.
+Whisper/[6/WAKU1](/waku/standards/legacy/6/waku1.md) envelopes are compatible with Waku messages format.
 
-- Whisper/Waku v1 `topic` field
-SHOULD be mapped to Waku v2 message's `content_topic` attribute.
-- Whisper/Waku v1 `data` field SHOULD be mapped to Waku v2 message's `payload` attribute.
+- Whisper/[6/WAKU1](/waku/standards/legacy/6/waku1.md) `topic` field
+SHOULD be mapped to Waku message's `content_topic` attribute.
+- Whisper/[6/WAKU1](/waku/standards/legacy/6/waku1.md) `data` field SHOULD be mapped to Waku message's `payload` attribute.
 
-Waku v2 implements a pub/sub messaging pattern over libp2p.
-This makes redundant some Whisper/Waku v1 envelope fields
+[10/WAKU2](/waku/standards/core/10/waku2.md) implements a publish/subscribe messaging pattern over libp2p.
+This makes some Whisper/[6/WAKU1](/waku/standards/legacy/6/waku1.md) envelope fields redundant
 (e.g., `expiry`, `ttl`, `topic`, etc.), so they can be ignored.
 
 ## Deterministic message hashing
@@ -144,7 +154,7 @@ and languages.
 It is also unstable across different builds with schema changes due to unknown fields.
 
 To overcome this interoperability limitation,
-a Waku v2 message's hash MUST be computed following this schema:
+a [10/WAKU2](/waku/standards/core/10/waku2.md) message's hash MUST be computed following this schema:
 
 ```js
 message_hash = sha256(concat(pubsub_topic, message.payload, message.content_topic, message.meta, message.timestamp))
@@ -164,7 +174,7 @@ coupled with using a SHA-2 (256-bit) hashing algorithm.
 
 ### Test vectors
 
-Waku message hash computation (`meta` size of 12 bytes):
+The `WakuMessage` hash computation (`meta` size of 12 bytes):
 
 ```js
 pubsub_topic = "/waku/2/default-waku/proto" (0x2f77616b752f322f64656661756c742d77616b752f70726f746f)
@@ -176,7 +186,7 @@ message.timestamp = 0x175789bfa23f8400
 message_hash = 0x64cce733fed134e83da02b02c6f689814872b1a0ac97ea56b76095c3c72bfe05
 ```
 
-Waku message hash computation (`meta` size of 64 bytes):
+The `WakuMessage` hash computation (`meta` size of 64 bytes):
 
 ```js
 pubsub_topic = "/waku/2/default-waku/proto" (0x2f77616b752f322f64656661756c742d77616b752f70726f746f)
@@ -188,7 +198,7 @@ message.timestamp = 0x175789bfa23f8400
 message_hash = 0x7158b6498753313368b9af8f6e0a0a05104f68f972981da42a43bc53fb0c1b27
 ```
 
-Waku message hash computation (`meta` attribute not present):
+The `WakuMessage` hash computation (`meta` attribute not present):
 
 ```js
 pubsub_topic = "/waku/2/default-waku/proto" (0x2f77616b752f322f64656661756c742d77616b752f70726f746f)
@@ -200,7 +210,7 @@ message.timestamp = 0x175789bfa23f8400
 message_hash = 0xa2554498b31f5bcdfcbf7fa58ad1c2d45f0254f3f8110a85588ec3cf10720fd8
 ```
 
-Waku message hash computation (`payload` length 0):
+The `WakuMessage` hash computation (`payload` length 0):
 
 ```js
 pubsub_topic = "/waku/2/default-waku/proto" (0x2f77616b752f322f64656661756c742d77616b752f70726f746f)
@@ -217,28 +227,29 @@ message_hash = 0x483ea950cb63f9b9d6926b262bb36194d3f40a0463ce8446228350bd44e96de
 ### Confidentiality, integrity, and authenticity
 
 The level of confidentiality, integrity, and
-authenticity of the Waku message payload is discretionary.
+authenticity of the `WakuMessage` payload is discretionary.
 Accordingly, the application layer shall utilize the encryption and
-signature schemes supported by Waku v2 to meet the application-specific privacy needs.
+signature schemes supported by [10/WAKU2](/waku/standards/core/10/waku2.md),
+to meet the application-specific privacy needs.
 
 ### Reliability of the `timestamp` attribute
 
-The Waku message `timestamp` attribute is set by the sender.
+The message `timestamp` attribute is set by the sender.
 Therefore, because message timestamps aren’t independently verified,
 this attribute is prone to exploitation and misuse.
 It should not solely be relied upon for operations such as message ordering.
-For example, a malicious actor can arbitrarily set the `timestamp` of a Waku message
+For example, a malicious actor can arbitrarily set the `timestamp` of a `WakuMessage`
 to a high value so that it always shows up as the most recent message
 in a chat application.
-Applications using Waku messages’ `timestamp` attribute
-are recommended to use additional methods for more robust message ordering.
+Applications using [10/WAKU2](/waku/standards/core/10/waku2.md) messages’ `timestamp` attribute
+are RECOMMENDED to use additional methods for more robust message ordering.
 An example of how to deal with message ordering against adversarial message timestamps
 can be found in the Status protocol,
-see [62/STATUS-PAYLOADS](../../../../status/62/payloads.md/#clock-vs-timestamp-and-message-ordering).
+see [62/STATUS-PAYLOADS](/status/62/payloads.md/#clock-vs-timestamp-and-message-ordering).
 
 ### Reliability of the `ephemeral` attribute
 
-The Waku message `ephemeral` attribute is set by the sender.
+The message `ephemeral` attribute is set by the sender.
 Since there is currently no incentive mechanism
 for network participants to behave correctly,
 this attribute is inherently insecure.
@@ -251,8 +262,12 @@ Copyright and related rights waived via [CC0](https://creativecommons.org/public
 
 ## References
 
-- [6/WAKU1](../../legacy/6/waku1.md)
-- [Google Protocol buffers v3](https://developers.google.com/protocol-buffers/)
-- [26/WAKU-PAYLOAD](../../application/26/payload.md)
+- [10/WAKU2](/waku/standards/core/10/waku2.md)
+- [6/WAKU1](/waku/standards/legacy/6/waku1.md)
+- [23/WAKU2-TOPICS](/waku/informational/23/topics.md)
+- [17/WAKU2-RLN-RELAY](/waku/standards/core/17/rln-relay.md)
+- [64/WAKU2-NETWORK](/waku/standards/core/64/network.md)
+- [protocol buffers v3](https://developers.google.com/protocol-buffers/)
+- [26/WAKU-PAYLOAD](/waku/standards/application/26/payload.md)
 - [WAKU2-NOISE](https://github.com/waku-org/specs/blob/master/standards/application/noise.md)
-- [62/STATUS-PAYLOADS](../../../../status/62/payloads.md/#clock-vs-timestamp-and-message-ordering)
+- [62/STATUS-PAYLOADS](/status/62/payloads.md/#clock-vs-timestamp-and-message-ordering)

waku/standards/core/31/enr.md

@@ -0,0 +1,189 @@
+---
+slug: 31
+title: 31/WAKU2-ENR
+name: Waku v2 usage of ENR
+status: draft
+tags: [waku/core-protocol]
+editor: Franck Royer <franck@status.im>
+contributors:
+---
+
+## Abstract
+
+This specification describes the usage of the ENR (Ethereum Node Records)
+format for [10/WAKU2](../10/waku2.md) purposes.
+The ENR format is defined in [EIP-778](https://eips.ethereum.org/EIPS/eip-778) [[3]](#references).
+
+This specification is an extension of EIP-778,
+ENR used in Waku MUST adhere to both EIP-778 and 31/WAKU2-ENR.
+
+## Motivation
+
+EIP-1459 with the usage of ENR has been implemented [[1]](#references) [[2]](#references) as a discovery protocol for Waku.
+
+EIP-778 specifies a number of pre-defined keys.
+However, the usage of these keys alone does not allow for certain transport capabilities to be encoded,
+such as Websocket.
+Currently, Waku nodes running in a browser only support websocket transport protocol.
+Hence, new ENR keys need to be defined to allow for the encoding of transport protocol other than raw TCP.
+
+### Usage of Multiaddr Format Rationale
+
+One solution would be to define new keys such as `ws` to encode the websocket port of a node.
+However, we expect new transport protocols to be added overtime such as quic.
+Hence, this would only provide a short term solution until another specification would need to be added.
+
+Moreover, secure websocket involves SSL certificates.
+SSL certificates are only valid for a given domain and ip,
+so an ENR containing the following information:
+
+- secure websocket port
+- ipv4 fqdn
+- ipv4 address
+- ipv6 address
+
+Would carry some ambiguity: Is the certificate securing the websocket port valid for the ipv4 fqdn?
+the ipv4 address?
+the ipv6 address?
+
+The [10/WAKU2](../10/waku2.md) protocol family is built on the [libp2p](https://github.com/libp2p/specs) protocol stack.
+Hence, it uses [multiaddr](https://github.com/multiformats/multiaddr) to format network addresses.
+
+Directly storing one or several multiaddresses in the ENR would fix the issues listed above:
+
+- multiaddr is self-describing and support addresses for any network protocol:
+  No new specification would be needed to support encoding other transport protocols in an ENR.
+- multiaddr contains both the host and port information,
+allowing the ambiguity previously described to be resolved.
+
+## Wire Format
+
+### `multiaddrs` ENR key
+
+We define a `multiaddrs` key.
+
+- The value MUST be a list of binary encoded multiaddr prefixed by their size.
+- The size of the multiaddr MUST be encoded in a Big Endian unsigned 16-bit integer.
+- The size of the multiaddr MUST be encoded in 2 bytes.
+- The `secp256k1` value MUST be present on the record;
+  `secp256k1` is defined in [EIP-778](https://eips.ethereum.org/EIPS/eip-778) and
+  contains the compressed secp256k1 public key.
+- The node's peer id SHOULD be deduced from the `secp256k1` value.
+- The multiaddresses SHOULD NOT contain a peer id except for circuit relay addresses
+- For raw TCP & UDP connections details,
+ [EIP-778](https://eips.ethereum.org/EIPS/eip-778) pre-defined keys SHOULD be used;
+  The keys `tcp`, `udp`, `ip` (and `tcp6`, `udp6`, `ip6` for IPv6)
+  are enough to convey all necessary information;
+- To save space, `multiaddrs` key SHOULD only be used for connection details that cannot be represented using the [EIP-778](https://eips.ethereum.org/EIPS/eip-778) pre-defined keys.
+- The 300 bytes size limit as defined by [EIP-778](https://eips.ethereum.org/EIPS/eip-778) still applies;
+  In practice, it is possible to encode 3 multiaddresses in ENR, more or
+  less could be encoded depending on the size of each multiaddress.
+
+### Usage
+
+#### Many connection types
+
+Alice is a Waku node operator, she runs a node that supports inbound connection for the following protocols:
+
+- TCP 10101 on `1.2.3.4`
+- UDP 20202 on `1.2.3.4`
+- TCP 30303 on `1234:5600:101:1::142`
+- UDP 40404 on `1234:5600:101:1::142`
+- Secure Websocket on `wss://example.com:443/`
+- QUIC on `quic://quic.example.com:443/`
+- A circuit relay address `/ip4/1.2.3.4/tcp/55555/p2p/QmRelay/p2p-circuit/p2p/QmAlice`
+
+Alice SHOULD structure the ENR for her node as follows:
+
+| key          | value                                                                                                                                                               |
+| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `tcp`        | `10101`                                                                                                                                                             |
+| `udp`        | `20202`                                                                                                                                                             |
+| `tcp6`       | `30303`                                                                                                                                                             |
+| `udp6`       | `40404`                                                                                                                                                             |
+| `ip`         | `1.2.3.4`                                                                                                                                                           |
+| `ip6`        | `1234:5600:101:1::142`                                                                                                                                              |
+| `secp256k1`  | Alice's compressed secp256k1 public key, 33 bytes                                                                                                                   |
+| `multiaddrs` | `len1 \| /dns4/example.com/tcp/443/wss \| len2 \| /dns4/quic.examle.com/tcp/443/quic \| len3 \| /ip4/1.2.3.4/tcp/55555/p2p/QmRelay` |
+
+Where `multiaddrs`:
+
+- `|` is the concatenation operator,
+- `len1` is the length of `/dns4/example.com/tcp/443/wss` byte representation,
+- `len2` is the length of `/dns4/quic.examle.com/tcp/443/quic` byte representation.
+- `len3` is the length of `/ip4/1.2.3.4/tcp/55555/p2p/QmRelay` byte representation.
+ Notice that the `/p2p-circuit` component is not stored, but,
+ since circuit relay addresses are the only one containing a `p2p` component,
+it's safe to assume that any address containing this component is a circuit relay address.
+Decoding this type of multiaddresses would require appending the `/p2p-circuit` component.
+
+#### Raw TCP only
+
+Bob is a node operator that runs a node that supports inbound connection for the following protocols:
+
+- TCP 10101 on `1.2.3.4`
+
+Bob SHOULD structure the ENR for his node as follows:
+
+| key         | value                                           |
+| ----------- | ----------------------------------------------- |
+| `tcp`       | `10101`                                         |
+| `ip`        | `1.2.3.4`                                       |
+| `secp256k1` | Bob's compressed secp256k1 public key, 33 bytes |
+
+As Bob's node's connection details can be represented with EIP-778's pre-defined keys only,
+it is not needed to use the `multiaddrs` key.
+
+### Limitations
+
+Supported key type is `secp256k1` only.
+
+Support for other elliptic curve cryptography such as `ed25519` MAY be used.
+
+### `waku2` ENR key
+
+We define a `waku2` field key:
+
+- The value MUST be an 8-bit flag field,
+  where bits set to `1` indicate `true` and
+  bits set to `0` indicate `false` for the relevant flags.
+- The flag values already defined are set out below,
+  with `bit 7` the most significant bit and `bit 0` the least significant bit.
+
+| bit 7   | bit 6   | bit 5   | bit 4   | bit 3       | bit 2    | bit 1   | bit 0   |
+| ------- | ------- | ------- | ------- | ----------- | -------- | ------- | ------- |
+| `undef` | `undef` | `undef` | `sync` | `lightpush` | `filter` | `store` | `relay` |
+
+- In the scheme above, the flags `sync`, `lightpush`, `filter`, `store` and
+  `relay` correlates with support for protocols with the same name.
+  If a protocol is not supported, the corresponding field MUST be set to `false`.
+  Indicating positive support for any specific protocol is OPTIONAL,
+  though it MAY be required by the relevant application or discovery process.
+- Flags marked as `undef` is not yet defined.
+  These SHOULD be set to `false` by default.
+
+### Key Usage
+
+- A Waku node MAY choose to populate the `waku2` field for enhanced discovery capabilities,
+  such as indicating supported protocols.
+  Such a node MAY indicate support for any specific protocol by setting the corresponding flag to `true`.
+- Waku nodes that want to participate in [Node Discovery Protocol v5](https://github.com/vacp2p/rfc-index/blob/main/waku/standards/core/33/discv5.md) [[4]](#references), however,
+  MUST implement the `waku2` key with at least one flag set to `true`.
+- Waku nodes that discovered other participants using Discovery v5,
+  MUST filter out participant records that do not implement this field or
+  do not have at least one flag set to `true`.
+- In addition, such nodes MAY choose to filter participants on specific flags
+ (such as supported protocols),
+  or further interpret the `waku2` field as required by the application.
+
+## Copyright
+
+Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## References
+
+- [1](../10/waku2.md)
+- [2](https://github.com/status-im/nim-waku/pull/690)
+- [3](https://github.com/vacp2p/rfc/issues/462#issuecomment-943869940)
+- [4](https://eips.ethereum.org/EIPS/eip-778)
+- [5](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md)

waku/standards/core/33/discv5.md

@@ -4,7 +4,8 @@ title: 33/WAKU2-DISCV5
 name: Waku v2 Discv5 Ambient Peer Discovery
 status: draft
 editor: Daniel Kaiser <danielkaiser@status.im>
-contributors:
+contributors: 
+ - Filip Dimitrijevic <filip@status.im>
 ---
 
 ## Abstract
@@ -12,7 +13,7 @@ contributors:
 `33/WAKU2-DISCV5` specifies a modified version of
 [Ethereum's Node Discovery Protocol v5](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md)
 as a means for ambient node discovery.
-[10/WAKU2](../10/waku2.md) uses the `33/WAKU2-DISCV5` ambient node discovery network
+[10/WAKU2](/waku/standards/core/10/waku2.md) uses the `33/WAKU2-DISCV5` ambient node discovery network
 for establishing a decentralized network of interconnected Waku2 nodes.
 In its current version,
 the `33/WAKU2-DISCV5` discovery network
@@ -24,7 +25,7 @@ compared to the total number of Ethereum nodes.
 ## Disclaimer
 
 This version of `33/WAKU2-DISCV5` has a focus on timely deployment
-of an efficient discovery method for [10/WAKU2](../10/waku2.md).
+of an efficient discovery method for [10/WAKU2](/waku/standards/core/10/waku2.md).
 Establishing a separate discovery network is in line with this focus.
 However, we are aware of potential resilience problems
 (see section on security considerations) and
@@ -33,11 +34,11 @@ and researching hybrid approaches.
 
 ## Background and Rationale
 
-[11/WAKU2-RELAY](../11/relay.md) assumes the existence of a network of Waku2 nodes.
+[11/WAKU2-RELAY](/waku/standards/core/11/relay.md) assumes the existence of a network of Waku2 nodes.
 For establishing and growing this network,
-new nodes trying to join the Waku2 network need a means of discovering nodes
-within the network.
-[10/WAKU2](../10/waku2.md) supports the following discovery methods
+new nodes trying to join the Waku2 network
+need a means of discovering nodes within the network.
+[10/WAKU2](/waku/standards/core/10/waku2.md) supports the following discovery methods
 in order of increasing decentralization
 
 * hard coded bootstrap nodes
@@ -45,7 +46,7 @@ in order of increasing decentralization
 * [`34/WAKU2-PEER-EXCHANGE`](/waku/standards/core/34/peer-exchange.md)
 * `33/WAKU2-DISCV5` (specified in this document)
 
-The purpose of ambient node discovery within [10/WAKU2](../10/waku2.md)
+The purpose of ambient node discovery within [10/WAKU2](/waku/standards/core/10/waku2.md)
 is discovering Waku2 nodes in a decentralized way.
 The unique selling point of `33/WAKU2-DISCV5` is its holistic view of the network,
 which allows avoiding hotspots and allows merging the network after a split.
@@ -62,7 +63,7 @@ during which the querying node was offline.
 
 `33/WAKU2-DISCV5` spans an overlay network separate from the
 [GossipSub](https://github.com/libp2p/specs/blob/master/pubsub/gossipsub/README.md)
-network [11/WAKU2-RELAY](../11/relay.md) builds on.
+network [11/WAKU2-RELAY](/waku/standards/core/11/relay.md) builds on.
 Because it is a P2P network on its own, it also depends on bootstrap nodes.
 Having a separate discovery network reduces load on the bootstrap nodes,
 because the actual work is done by randomly discovered nodes.
@@ -204,9 +205,9 @@ raises research questions that we will address in future stages of our discv5 ro
 
 ## References
 
-1. [10/WAKU2](../10/waku2.md)
+1. [10/WAKU2](/waku/standards/core/10/waku2.md)
 2. [`34/WAKU2-PEER-EXCHANGE`](/waku/standards/core/34/peer-exchange.md)
-3. [11/WAKU2-RELAY](../11/relay.md)
+3. [11/WAKU2-RELAY](/waku/standards/core/11/relay.md)
 4. [WAKU2-ENR](https://github.com/waku-org/specs/blob/master/standards/core/enr.md)
 5. [Node Discovery Protocol v5 (`discv5`)](https://github.com/ethereum/devp2p/blob/master/discv5/discv5.md)
 6. [`discv5` semantics](https://github.com/ethereum/devp2p/blob/master/discv5/discv5-theory.md).

waku/standards/core/66/metadata.md

@@ -3,27 +3,32 @@ slug: 66
 title: 66/WAKU2-METADATA
 name: Waku Metadata Protocol
 status: draft
-editor: Alvaro Revuelta <alrevuelta@status.im>
+editor: Franck Royer <franck@status.im>
 contributors:
+  - Filip Dimitrijevic <filip@status.im>
+  - Alvaro Revuelta <alrevuelta@status.im>
 ---
 
 ## Abstract
 
 This specification describes the metadata
-that can be associated with a [10/WAKU2](../10/waku2.md) node.
+that can be associated with a [10/WAKU2](/waku/standards/core/10/waku2.md) node.
 
 ## Metadata Protocol
 
-Waku specifies a req/resp protocol that provides information about the node's medatadata.
-Such metadata is meant to be used by the node to decide if a peer is worth connecting
-or not.
+The keywords “MUST”, // List style “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”,
+“NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).
+
+Waku specifies a req/resp protocol that provides information about the node's capabilities.
+Such metadata MAY be used by other peers for subsequent actions such as light protocol requests or disconnection.
+
 The node that makes the request,
 includes its metadata so that the receiver is aware of it,
-without requiring an extra interaction.
+without requiring another round trip.
 The parameters are the following:
 
 * `clusterId`: Unique identifier of the cluster that the node is running in.
-* `shards`: Shard indexes that the node is subscribed to.
+* `shards`: Shard indexes that the node is subscribed to via [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md).
 
 ***Protocol Identifier***
 
@@ -47,10 +52,56 @@ message WakuMetadataResponse {
 }
 ```
 
+## Implementation Suggestions
+
+### Triggering Metadata Request
+
+A node SHOULD proceed with metadata request upon first connection to a remote node.
+A node SHOULD use the remote node's libp2p peer id as identifier for this heuristic.
+
+A node MAY proceed with metadata request upon reconnection to a remote peer.
+
+A node SHOULD store the remote peer's metadata information for future reference.
+A node MAY implement a TTL regarding a remote peer's metadata, and refresh it upon expiry by initiating another metadata request.
+It is RECOMMENDED to set the TTL to 6 hours.
+
+A node MAY trigger a metadata request after receiving an error response from a remote note
+stating they do not support a specific cluster or shard.
+For example, when using a request-response service such as [`19/WAKU2-LIGHTPUSH`](/waku/standards/core/19/lightpush.md).
+
+### Providing Cluster Id
+
+A node MUST include their cluster id into their metadata payload.
+It is RECOMMENDED for a node to operate on a single cluster id.
+
+### Providing Shard Information
+
+* Nodes that mount [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md) MAY include the shards they are subscribed to in their metadata payload.
+* Shard-relevant services are message related services,
+  such as [`13/WAKU2-STORE`](/waku/standards/core/13/store.md), [12/WAKU2-FILTER](/waku/standards/core/12/filter.md)
+  and [`19/WAKU2-LIGHTPUSH`](/waku/standards/core/19/lightpush.md)
+  but not [`34/WAKU2-PEER-EXCHANGE`](/waku/standards/core/34/peer-exchange.md)
+* Nodes that mount [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md) and a shard-relevant service SHOULD include the shards they are subscribed to in their metadata payload.
+* Nodes that do not mount [`11/WAKU2-RELAY`](/waku/standards/core/11/relay.md) SHOULD NOT include any shard information
+
+### Using Cluster Id
+
+When reading the cluster id of a remote peer, the local node MAY disconnect if their cluster id is different from the remote peer.
+
+### Using Shard Information
+
+It is NOT RECOMMENDED to disconnect from a peer based on the fact that their shard information is different from the local node.
+
+Ahead of doing a shard-relevant request,
+a node MAY use the previously received metadata shard information to select a peer that support the targeted shard.
+
+For non-shard-relevant requests, a node SHOULD NOT discriminate a peer based on medata shard information.
+
 ## Copyright
 
-Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).
+Copyright and related rights waived via
+[CC0](https://creativecommons.org/publicdomain/zero/1.0/).
 
 ## References
 
-* [10/WAKU2](../10/waku2.md)
+* [10/WAKU2](/waku/standards/core/10/waku2.md)