From 929df62d80ed3837a7d01bfc942d32d3b1219e65 Mon Sep 17 00:00:00 2001 From: Bryan White Date: Wed, 20 Nov 2024 14:50:40 +0100 Subject: [PATCH] [Docs] Add risks & misbehavior sub-section to on-chain actors (#862) ## Summary Adds "Risks & Misbehavior" sub-section to the "Protocol" > "Pocket Network Actors" > "On-Chain Actors" section: ![image](https://github.com/user-attachments/assets/23e35b6e-bbfa-4704-ab6c-3e7b2253c41b) ## Issue - #612 ## Type of change Select one or more from the following: - [ ] New feature, functionality or library - [ ] Consensus breaking; add the `consensus-breaking` label if so. See #791 for details - [ ] Bug fix - [ ] Code health or cleanup - [x] Documentation - [ ] Other (specify) ## Testing - [x] **Documentation**: `make docusaurus_start`; only needed if you make doc changes - [ ] **Unit Tests**: `make go_develop_and_test` - [ ] **LocalNet E2E Tests**: `make test_e2e` - [ ] **DevNet E2E Tests**: Add the `devnet-test-e2e` label to the PR. ## Sanity Checklist - [ ] I have tested my changes using the available tooling - [ ] I have commented my code - [ ] I have performed a self-review of my own code; both comments & source code - [ ] I create and reference any new tickets, if applicable - [ ] I have left TODOs throughout the codebase, if applicable --------- Co-authored-by: Daniel Olshansky --- docusaurus/docs/protocol/actors/actors.md | 32 +++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/docusaurus/docs/protocol/actors/actors.md b/docusaurus/docs/protocol/actors/actors.md index 2c91820c1..8df87e84e 100644 --- a/docusaurus/docs/protocol/actors/actors.md +++ b/docusaurus/docs/protocol/actors/actors.md @@ -7,6 +7,7 @@ sidebar_position: 1 - [Overview](#overview) - [On-Chain Actors](#on-chain-actors) + - [Risks \& Misbehavior](#risks--misbehavior) - [Off-Chain Actors](#off-chain-actors) ## Overview @@ -55,6 +56,37 @@ They can thought of as a `record`, a `registration` or a piece of `state` at a certain point in time. They have an `address`, an `account`, a `balance` and often also have a `stake`. +### Risks & Misbehavior + +:::warning +This is an open work in progress and an active area of research. +::: + +```mermaid +mindmap + (On-Chain Actors) + Gateway + Risks + Intentional overservicing + Off-chain only? + Misbehavior + Low volume exploit + On-chain, there are few/any? expectations of gateway actors; basically a registry to track gateways and application delegations + On-chain, we cannot robustly distinguish requests sent by gateways from those sent by applications acting sovereignly + Application + Risks + Insufficient funds to pay for services received + Intentional overservicing + Misbehavior + Low volume exploit + Supplier + Risks + Service/quality degredation + Misbehavior + No or low quality responses to valid requests for service + Invalid/missing proofs +``` + ## Off-Chain Actors Off-Chain actors are all the operators that make up Pocket Network. They are the