From 7fb21d3e10c18da9593300bbd5257ee595a4ef0d Mon Sep 17 00:00:00 2001 From: shakezula Date: Tue, 25 Apr 2023 15:50:29 -0600 Subject: [PATCH 1/3] [ADR] Initial commit for Rename Fishermen ADR --- ADRs/ADR0005-rename-fishermen.md | 50 ++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 ADRs/ADR0005-rename-fishermen.md diff --git a/ADRs/ADR0005-rename-fishermen.md b/ADRs/ADR0005-rename-fishermen.md new file mode 100644 index 0000000..f2bfc1c --- /dev/null +++ b/ADRs/ADR0005-rename-fishermen.md @@ -0,0 +1,50 @@ +# Rename Fishermen + +* Status: Proposed +* Deciders: Protocol Eng. Team +* Date: 2023-04-24 + +## Context and Problem Statement + +Fishermen is a canonically used term in blockchain spaces. In POKT Network, Fishermen are actors responsible for monitoring & reporting the behavior of Service nodes. However, the term Fishermen is ambiguous, overloaded, and doesn't describe its responsibilities in the protocol without additional context. None of other POKT actor roles have a maritime or sea based theme, further adding to the confusion. Additionally, pluralization preferences and spelling of `fishermen` is an ongoing issue in the codebase. For example, there are TODO comments about renaming `fisherman` to `fishermen`. + +## Decision Drivers + +- Clarity in names is important +- Uniformity in pluralization and spelling +- Gender neutrality + +## Considered Options + +- Auditor +- Checker +- Verifier +- Sampler + +## Decision Outcome + +_Decision pending_. + +### Positive Consequences + +- It is clearer what the actor is called who checks and samples relay data. + +### Negative Consequences + +- Whitepaper, protocol, documentation, and code-level changes are necessary to accomplish this name change. + +## Pros and Cons of the Options + +### Option 1: Auditor + +### Option 2: Checker + +### Option 3: Verifier + +### Option 4: Sampler + +### Option 5: Watcher + +## Links + +[Pokadot Network - Fishermen Deprecated](https://wiki.polkadot.network/docs/learn-availability#fishermen-deprecated) From 3b15ca2c878c5a0f868e95936283c4c71f9d87b7 Mon Sep 17 00:00:00 2001 From: shakezula Date: Tue, 25 Apr 2023 15:57:45 -0600 Subject: [PATCH 2/3] [ADR] updates --- ADRs/ADR0005-rename-fishermen.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/ADRs/ADR0005-rename-fishermen.md b/ADRs/ADR0005-rename-fishermen.md index f2bfc1c..3cfa7dc 100644 --- a/ADRs/ADR0005-rename-fishermen.md +++ b/ADRs/ADR0005-rename-fishermen.md @@ -1,12 +1,12 @@ # Rename Fishermen -* Status: Proposed -* Deciders: Protocol Eng. Team -* Date: 2023-04-24 +* Status: Draft +* Deciders: Protocol Network Team +* Date: 2023-04-25 ## Context and Problem Statement -Fishermen is a canonically used term in blockchain spaces. In POKT Network, Fishermen are actors responsible for monitoring & reporting the behavior of Service nodes. However, the term Fishermen is ambiguous, overloaded, and doesn't describe its responsibilities in the protocol without additional context. None of other POKT actor roles have a maritime or sea based theme, further adding to the confusion. Additionally, pluralization preferences and spelling of `fishermen` is an ongoing issue in the codebase. For example, there are TODO comments about renaming `fisherman` to `fishermen`. +Fishermen is a canonically used term in [blockchain technology](https://wiki.polkadot.network/docs/learn-availability#fishermen-deprecated). In POKT Network, Fishermen are actors responsible for monitoring & reporting the behavior of Service nodes. However, the term Fishermen is ambiguous, overloaded, and doesn't describe its responsibilities in the protocol without additional context. None of other POKT actor roles have a maritime or sea based theme, further adding to the confusion. Additionally, pluralization preferences and spelling of `fishermen` is an ongoing issue in the codebase. For example, there are TODO comments about renaming `fisherman` to `fishermen`. ## Decision Drivers @@ -23,7 +23,7 @@ Fishermen is a canonically used term in blockchain spaces. In POKT Network, Fish ## Decision Outcome -_Decision pending_. +_Decision pending further discussion & community input_. ### Positive Consequences @@ -41,10 +41,14 @@ _Decision pending_. ### Option 3: Verifier +- Bad, because it's very close to Validator. + ### Option 4: Sampler ### Option 5: Watcher +- Good, because there's precedent. + ## Links -[Pokadot Network - Fishermen Deprecated](https://wiki.polkadot.network/docs/learn-availability#fishermen-deprecated) +- [Pokadot Network - Fishermen Deprecated](https://wiki.polkadot.network/docs/learn-availability#fishermen-deprecated) From 52d9cd1e1d0d8368eb70c8d6646cc38cdc967591 Mon Sep 17 00:00:00 2001 From: shakezula Date: Tue, 25 Apr 2023 16:10:40 -0600 Subject: [PATCH 3/3] [ADR] updates --- ADRs/ADR0005-rename-fishermen.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ADRs/ADR0005-rename-fishermen.md b/ADRs/ADR0005-rename-fishermen.md index 3cfa7dc..d5bccbb 100644 --- a/ADRs/ADR0005-rename-fishermen.md +++ b/ADRs/ADR0005-rename-fishermen.md @@ -20,6 +20,7 @@ Fishermen is a canonically used term in [blockchain technology](https://wiki.pol - Checker - Verifier - Sampler +- Watcher ## Decision Outcome