feat: add changelogs and readmes (#192)

* feat(all): add changelogs to all crates missing * feat: update TOML files and changelogs for first agents release * feat(docs): add readmes to agents + RUNNING-AGENTS.md * feat(docs): add AGENT-OPERATIONS.md * feat(docs): adds RUNNING-WATCHER.md * docs(watcher): explain watcher funding amounts: * fix(docs): add linebreak * feat(docs): port agent gas values to configuration/gas * fix(docs): remove all doc file ports * fix(docs): remove refs to running agents docs in agent readmes * fix(docs): only link repos to root
nomad-xyz · Jun 6, 2022 · 952f150 · 952f150
1 parent bad5648
commit 952f150
Show file tree

Hide file tree

Showing 22 changed files with 138 additions and 8 deletions.
diff --git a/accumulator/CHANGELOG.md b/accumulator/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/accumulator/Cargo.toml b/accumulator/Cargo.toml
@@ -4,9 +4,8 @@ version = "0.1.0"
 edition = "2021"
 authors = ["James Prestwich <[email protected]>", "The Nomad Developers <[email protected]>"]
 description = "Nomad sparse merle tree"
-repository = "https://github.com/nomad-xyz/rust/accumulator"
+repository = "https://github.com/nomad-xyz/rust"
 license = "MIT OR Apache-2.0"
-
 exclude = [
     "*.sh",
     ".git*"

diff --git a/agents/kathy/CHANGELOG.md b/agents/kathy/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/agents/kathy/Cargo.toml b/agents/kathy/Cargo.toml
@@ -1,8 +1,15 @@
 [package]
 name = "kathy"
 version = "0.1.0"
-authors = ["James Prestwich <james@prestwi.ch>"]
+authors = ["James Prestwich <james@nomad.xyz>", "Luke Tchang <[email protected]>"]
 edition = "2021"
+description = "Nomad kathy agent"
+repository = "https://github.com/nomad-xyz/rust"
+license = "MIT OR Apache-2.0"
+exclude = [
+    "*.sh",
+    ".git*"
+]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

diff --git a/agents/kathy/README.md b/agents/kathy/README.md
@@ -0,0 +1,3 @@
+## Kathy Agent
+
+Kathy is strictly used in development and staging environments for testing purposes. The role of kathy is to enqueue randomly generated cross-chain messages to the home contract.
diff --git a/agents/processor/CHANGELOG.md b/agents/processor/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/agents/processor/Cargo.toml b/agents/processor/Cargo.toml
@@ -1,8 +1,15 @@
 [package]
 name = "processor"
 version = "0.1.0"
-authors = ["anna-caroll <[email protected]>"]
+authors = ["Luke Tchang <[email protected]>", "James Prestwich <[email protected]>"]
 edition = "2021"
+description = "Nomad processor agent"
+repository = "https://github.com/nomad-xyz/rust"
+license = "MIT OR Apache-2.0"
+exclude = [
+    "*.sh",
+    ".git*"
+]
 
 [dependencies]
 tokio = { version = "1.0.1", features = ["rt", "macros"] }

diff --git a/agents/processor/README.md b/agents/processor/README.md
@@ -0,0 +1,12 @@
+## Processor Agent
+
+The processor proves the validity of pending messages and sends them to end recipients.
+
+It is an off-chain actor that does the following:
+
+- Observe the home
+- Maintain local merkle tree with all leaves
+- Observe 1 or more replicas
+- Maintain list of messages corresponding to each leaf
+- Generate and submit merkle proofs for pending (unproven) messages
+- Dispatch proven messages to end recipients
diff --git a/agents/relayer/CHANGELOG.md b/agents/relayer/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/agents/relayer/Cargo.toml b/agents/relayer/Cargo.toml
@@ -1,8 +1,15 @@
 [package]
 name = "relayer"
 version = "0.1.0"
-authors = ["ltchang <[email protected]>"]
+authors = ["Luke Tchang <[email protected]>", "James Prestwich <[email protected]>"]
 edition = "2021"
+description = "Nomad relayer agent"
+repository = "https://github.com/nomad-xyz/rust"
+license = "MIT OR Apache-2.0"
+exclude = [
+    "*.sh",
+    ".git*"
+]
 
 [dependencies]
 tokio = { version = "1.0.1", features = ["rt", "macros"] }

diff --git a/agents/relayer/README.md b/agents/relayer/README.md
@@ -0,0 +1,10 @@
+## Relayer Agent
+
+The relayer forwards updates from the home to one or more replicas.
+
+It is an off-chain actor that does the following:
+
+- Observe the home
+- Observe 1 or more replicas
+- Polls home for new signed updates (since replica's current root) and submits them to replica
+- Polls replica for confirmable updates (that have passed their optimistic time window) and confirms if available (updating replica's current root)
diff --git a/agents/updater/CHANGELOG.md b/agents/updater/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/agents/updater/Cargo.toml b/agents/updater/Cargo.toml
@@ -1,8 +1,15 @@
 [package]
 name = "updater"
 version = "0.1.0"
-authors = ["James Prestwich <[email protected]>"]
+authors = ["James Prestwich <[email protected]>", "Luke Tchang <[email protected]>"]
 edition = "2021"
+description = "Nomad updater agent"
+repository = "https://github.com/nomad-xyz/rust"
+license = "MIT OR Apache-2.0"
+exclude = [
+    "*.sh",
+    ".git*"
+]
 
 [dependencies]
 tokio = { version = "1.0.1", features = ["rt", "macros"] }

diff --git a/agents/updater/README.md b/agents/updater/README.md
@@ -0,0 +1,9 @@
+## Updater Agent
+
+The updater is responsible for signing attestations of new roots.
+
+It is an off-chain actor that does the following:
+
+- Observe the home chain contract
+- Sign attestations to new roots
+- Publish the signed attestation to the home chain
diff --git a/agents/watcher/CHANGELOG.md b/agents/watcher/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/agents/watcher/Cargo.toml b/agents/watcher/Cargo.toml
@@ -1,8 +1,15 @@
 [package]
 name = "watcher"
 version = "0.1.0"
-authors = ["Luke Tchang <[email protected]>"]
+authors = ["Luke Tchang <[email protected]>", "James Prestwich <[email protected]>"]
 edition = "2021"
+description = "Nomad watcher agent"
+repository = "https://github.com/nomad-xyz/rust"
+license = "MIT OR Apache-2.0"
+exclude = [
+    "*.sh",
+    ".git*"
+]
 
 [dependencies]
 tokio = { version = "1.0.1", features = ["rt", "macros"] }

diff --git a/agents/watcher/README.md b/agents/watcher/README.md
@@ -0,0 +1,12 @@
+## Watcher Agent
+
+The watcher observes the Updater's interactions with the Home contract (by watching the Home contract) and reacts to malicious or faulty attestations. It also observes any number of replicas to ensure the Updater does not bypass the Home and go straight to a replica.
+
+It is an off-chain actor that does the following:
+
+- Observe the home
+- Observe 1 or more replicas
+- Maintain a DB of seen updates
+- Submit double-update proofs
+- Submit invalid update proofs
+- If configured, issue an emergency halt transaction
diff --git a/chains/nomad-ethereum/CHANGELOG.md b/chains/nomad-ethereum/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/configuration/Cargo.toml b/configuration/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.1.0-rc.24"
 edition = "2021"
 authors = ["James Prestwich <[email protected]>", "The Nomad Developers <[email protected]>"]
 description = "Nomad project configuration file utilities"
-repository = "https://github.com/nomad-xyz/rust/configuration"
+repository = "https://github.com/nomad-xyz/rust"
 license = "MIT OR Apache-2.0"
 exclude = [
     "*.sh",

diff --git a/nomad-base/CHANGELOG.md b/nomad-base/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/nomad-core/CHANGELOG.md b/nomad-core/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog
diff --git a/nomad-test/CHANGELOG.md b/nomad-test/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Changelog
+
+### Unreleased
+
+- adds a changelog