+
+
+
+
+
+
+
+ ' + + '' + + _("Hide Search Matches") + + "
" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/v0.6.2/commands/cluster.html b/v0.6.2/commands/cluster.html new file mode 100644 index 00000000..6d584ac7 --- /dev/null +++ b/v0.6.2/commands/cluster.html @@ -0,0 +1,169 @@ + + + + +
+
+
+
+
+ 
+ 
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/commands/run.html b/v0.6.2/commands/run.html
new file mode 100644
index 00000000..6b6a6215
--- /dev/null
+++ b/v0.6.2/commands/run.html
@@ -0,0 +1,169 @@
+
+
+
+
+
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/genindex.html b/v0.6.2/genindex.html
new file mode 100644
index 00000000..48424044
--- /dev/null
+++ b/v0.6.2/genindex.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ Local Development
+
+
+
+
+ 
+ 
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/index.html b/v0.6.2/index.html
new file mode 100644
index 00000000..2310bf4d
--- /dev/null
+++ b/v0.6.2/index.html
@@ -0,0 +1,186 @@
+
+
+
+
+ Index
+ +
+
+
+
+
+
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/methoddocs/exceptions.html b/v0.6.2/methoddocs/exceptions.html
new file mode 100644
index 00000000..47b9dbc4
--- /dev/null
+++ b/v0.6.2/methoddocs/exceptions.html
@@ -0,0 +1,169 @@
+
+
+
+
+
+
+
+
+
+
+
+User Guides
+ +
+
+CLI Reference
+ +
+
+
+ Python Reference
+ +
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/methoddocs/main.html b/v0.6.2/methoddocs/main.html
new file mode 100644
index 00000000..66257c77
--- /dev/null
+++ b/v0.6.2/methoddocs/main.html
@@ -0,0 +1,171 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ silverback.exceptions
+
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/methoddocs/middlewares.html b/v0.6.2/methoddocs/middlewares.html
new file mode 100644
index 00000000..b86f4135
--- /dev/null
+++ b/v0.6.2/methoddocs/middlewares.html
@@ -0,0 +1,171 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ silverback.main
+The silverback.main module contains the high-level implementation of the the user’s
+Silverback application, meant to be used to expose method handlers and other functionality.
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/methoddocs/runner.html b/v0.6.2/methoddocs/runner.html
new file mode 100644
index 00000000..439d8bfa
--- /dev/null
+++ b/v0.6.2/methoddocs/runner.html
@@ -0,0 +1,171 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ silverback.middlewares
+The silverback.middlewares module contains middleware intended to improve the usability of
+silverback as a whole, and add integrations for the silverback platform as well.
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/methoddocs/subscriptions.html b/v0.6.2/methoddocs/subscriptions.html
new file mode 100644
index 00000000..f1276ced
--- /dev/null
+++ b/v0.6.2/methoddocs/subscriptions.html
@@ -0,0 +1,171 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ silverback.runner
+The silverback.runner module contains implementations for running Silverback apps in a variety
+of different scenarios and trigger methods.
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/methoddocs/utils.html b/v0.6.2/methoddocs/utils.html
new file mode 100644
index 00000000..e2a059fc
--- /dev/null
+++ b/v0.6.2/methoddocs/utils.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ silverback.subscriptions
+The silverback.subscriptions module contains an implementation of a Websocket subscription queue,
+used for connected to an RPC node via websockets that implements the eth_subscribe RPC method.
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/objects.inv b/v0.6.2/objects.inv
new file mode 100644
index 00000000..4d50270b
Binary files /dev/null and b/v0.6.2/objects.inv differ
diff --git a/v0.6.2/search.html b/v0.6.2/search.html
new file mode 100644
index 00000000..ea9c0e67
--- /dev/null
+++ b/v0.6.2/search.html
@@ -0,0 +1,114 @@
+
+
+
+
+
+
+
+
+
+
+
+
+ silverback.utils
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/searchindex.js b/v0.6.2/searchindex.js
new file mode 100644
index 00000000..2f7110fd
--- /dev/null
+++ b/v0.6.2/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Adding Environment Variables": [[10, "adding-environment-variables"]], "Bot Events": [[9, "bot-events"]], "Bot State": [[9, "bot-state"]], "Building your Bot": [[10, "building-your-bot"]], "CLI Reference": [[2, null]], "Cloud Platform": [[0, null]], "Connecting to your Cluster": [[10, "connecting-to-your-cluster"]], "Controlling your Bot": [[10, "controlling-your-bot"]], "Creating a Bot": [[9, "creating-a-bot"]], "Creating a Cluster": [[10, "creating-a-cluster"]], "Dependencies": [[11, "dependencies"]], "Deploying Bots": [[10, null]], "Deploying your Bot": [[9, "deploying-your-bot"], [10, "deploying-your-bot"]], "Developing Bots": [[9, null]], "Development": [[11, "development"]], "Distributed Execution": [[9, "distributed-execution"]], "Docker Usage": [[11, "docker-usage"]], "Documentation": [[11, "documentation"]], "Installation": [[11, "installation"]], "Local Development": [[1, null]], "Monitoring your Bot": [[10, "monitoring-your-bot"]], "New Block Events": [[9, "new-block-events"]], "New Event Logs": [[9, "new-event-logs"]], "Prerequisites": [[9, "prerequisites"]], "Private Container Registries": [[10, "private-container-registries"]], "Project structure": [[9, "project-structure"]], "Python Reference": [[2, null]], "Quick Start": [[11, null]], "Quick Usage": [[11, "quick-usage"]], "Running your Bot": [[9, "running-your-bot"]], "Setting Up Your Environment": [[11, "setting-up-your-environment"]], "Signing Transactions": [[9, "signing-transactions"]], "Startup and Shutdown": [[9, "startup-and-shutdown"]], "Testing your Bot": [[9, "testing-your-bot"]], "User Guides": [[2, null]], "Viewing Measured Metrics": [[10, "viewing-measured-metrics"]], "Worker Events": [[9, "worker-events"]], "Worker State": [[9, "worker-state"]], "silverback.exceptions": [[3, null]], "silverback.main": [[4, null]], "silverback.middlewares": [[5, null]], "silverback.runner": [[6, null]], "silverback.subscriptions": [[7, null]], "silverback.utils": [[8, null]], "via pip": [[11, "via-pip"]], "via setuptools": [[11, "via-setuptools"]]}, "docnames": ["commands/cluster", "commands/run", "index", "methoddocs/exceptions", "methoddocs/main", "methoddocs/middlewares", "methoddocs/runner", "methoddocs/subscriptions", "methoddocs/utils", "userguides/development", "userguides/platform", "userguides/quickstart"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["commands/cluster.rst", "commands/run.rst", "index.rst", "methoddocs/exceptions.md", "methoddocs/main.md", "methoddocs/middlewares.md", "methoddocs/runner.md", "methoddocs/subscriptions.md", "methoddocs/utils.md", "userguides/development.md", "userguides/platform.md", "userguides/quickstart.md"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [4, 9, 10, 11], "0": 9, "0x0bc529c00c6401aef6d220be8c6ea1667f6ad93": 11, "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48": 11, "1": [9, 11], "10": [10, 11], "11": 11, "127": 9, "15": 10, "18": 11, "1inch": 11, "2": 9, "3": [9, 10, 11], "30": 10, "6": 11, "6379": 9, "A": 11, "And": 9, "As": [10, 11], "At": 10, "Be": 11, "For": [9, 10], "If": [9, 10, 11], "In": [9, 10, 11], "It": [9, 10, 11], "Such": 9, "The": [4, 5, 6, 7, 9, 10, 11], "Then": [9, 10], "There": 9, "These": [9, 10, 11], "To": [9, 10, 11], "__init__": 9, "abil": 10, "abl": 9, "abort": 10, "about": [9, 10, 11], "abov": 9, "access": [9, 10], "account": [9, 10, 11], "acct": 9, "across": 9, "action": [9, 10], "activ": 11, "actual": [9, 10], "ad": 9, "add": [5, 9, 10], "additon": 9, "address": [9, 11], "adjust": 10, "advanc": 10, "after": 10, "again": [9, 10, 11], "against": 11, "alchemi": [9, 11], "alia": 10, "all": [9, 10], "allow": 10, "almost": 9, "alreadi": 10, "also": [9, 10, 11], "alwai": 9, "amount": [9, 10], "an": [7, 9, 10, 11], "ani": [9, 10, 11], "annot": 9, "anoth": [9, 11], "anyon": 10, "anyth": 9, "ap": [9, 10, 11], "ape_alchemi": 11, "apeworx": [10, 11], "api": [9, 10, 11], "app": 6, "appear": 10, "applic": [4, 10], "appriopi": 10, "ar": [9, 10, 11], "arbitrari": 9, "around": 10, "asid": 11, "ask": 9, "assist": 10, "assum": 10, "asynchron": 9, "attempt": [10, 11], "auth": 10, "auto": [10, 11], "autodetect": 9, "autom": [9, 11], "automat": [9, 10, 11], "avail": [9, 10], "avoid": 9, "aw": [9, 10], "awar": 11, "back": [9, 10], "backend": 9, "backtest": 9, "base": 11, "been": 9, "befor": [9, 10], "begin": 10, "behavior": [9, 11], "bespok": 10, "blk": 9, "block": 11, "block_handl": 9, "blockchain": 10, "bot": [2, 11], "bota": [10, 11], "botb": [10, 11], "botc": [10, 11], "both": 11, "break": 11, "broker": [9, 10, 11], "build": [9, 11], "call": [9, 10, 11], "can": [9, 10, 11], "cancel": 10, "cannot": 10, "capabl": 9, "captur": 9, "care": [9, 10], "case": [9, 11], "caus": 11, "cd": 11, "certain": 10, "chain": [9, 11], "chang": [9, 10, 11], "check": [9, 10, 11], "checkout": 11, "choic": 9, "choos": 11, "circl": 11, "clariti": 9, "class": [9, 10], "cleanli": 9, "cleanup": 9, "cli": [9, 10], "client": 9, "clone": 11, "close": [9, 10], "cloud": [2, 9, 10, 11], "code": [9, 10], "collect": 10, "com": 11, "come": 9, "command": [9, 10, 11], "comment": 11, "commit": 9, "common": 11, "complet": 9, "complex": [9, 11], "complic": [9, 11], "compon": 9, "comput": 9, "concept": 10, "condit": 10, "config": 10, "configur": [9, 10, 11], "confirm": 11, "conflict": 11, "connect": [7, 9], "contact": 10, "contain": [4, 5, 6, 7, 9, 11], "container": [9, 10], "context": 9, "continu": 11, "contract": [9, 10, 11], "contribut": 11, "control": 9, "copi": 11, "correct": 10, "correctli": 11, "could": 9, "creat": 11, "create_t": 9, "creation": 11, "credenti": 10, "critic": [10, 11], "current": 10, "custom": 11, "d": 9, "dai": 10, "dashboard": 11, "data": [9, 10, 11], "databas": [9, 10], "datafram": 9, "date": 11, "db": 9, "de": 10, "debug": 10, "decim": 11, "decor": 9, "dedic": [9, 10], "deep": 9, "def": 9, "default": [9, 10, 11], "defin": 9, "definit": [9, 10], "delet": 10, "depend": [9, 10], "deploi": [2, 11], "deploy": [9, 10, 11], "deposit": 11, "desir": [10, 11], "detail": [9, 10], "detect": 9, "determin": [9, 10], "dev": 11, "develop": [2, 10], "df": 9, "differ": [6, 10], "difficulti": 10, "directori": [9, 10, 11], "distinct": 10, "distinctli": 9, "do": [9, 10, 11], "docker": 10, "dockerfil": [10, 11], "document": 9, "doe": 9, "doesn": 10, "don": 10, "done": [9, 10], "down": 10, "download": 10, "dure": [9, 10], "e": 9, "each": [9, 10, 11], "easi": 9, "easili": 9, "ecosystem": 11, "effect": 10, "els": 9, "emit": 9, "enabl": [9, 11], "encount": [9, 10], "encourag": 9, "ensur": [9, 10, 11], "enter": 10, "environ": 9, "error": [9, 10, 11], "etc": [9, 10], "eth": 11, "eth_subscrib": 7, "ethereum": [9, 11], "etherscan": 10, "event": 11, "ever": 10, "everi": 9, "everyth": [9, 10], "exactli": 10, "exampl": [9, 10, 11], "excel": 11, "except": [2, 11], "exec_event1": 11, "exec_event2": 11, "execut": [10, 11], "exeuct": 10, "exist": [10, 11], "expect": [9, 11], "experi": [9, 10], "experienc": 10, "expir": 10, "export": 9, "expos": 4, "extend": 10, "fact": 10, "fail": 11, "failur": [9, 10], "fairli": 9, "familar": 11, "favorit": 10, "featur": 11, "feel": 10, "figur": 10, "file": [9, 11], "fill": 10, "final": [9, 10, 11], "financ": 11, "find": 9, "first": 10, "flag": 11, "flexibl": 10, "folder": [9, 11], "follow": [9, 10, 11], "format": 10, "framework": 11, "from": [9, 10, 11], "full": 10, "fulli": [10, 11], "function": [4, 9, 10, 11], "fund": [9, 10], "further": 9, "g": 9, "gener": [10, 11], "get": [9, 10, 11], "git": 11, "github": [10, 11], "give": [10, 11], "given": [9, 11], "go": [9, 10, 11], "gracefulli": 10, "graphic": 10, "greater": 11, "group": [10, 11], "guid": [9, 10], "ha": [9, 10], "had": 9, "handl": [9, 11], "handle_new_block": 9, "handle_on_shutdown": 9, "handle_on_startup": 9, "handle_on_worker_shutdown": 9, "handle_on_worker_startup": 9, "handle_token_transfer_ev": 9, "handler": [4, 9], "haramb": 11, "have": [9, 10, 11], "haven": 10, "health": 10, "heavier": 9, "heavili": 11, "help": [9, 10], "here": 9, "hidden": 11, "high": [4, 9], "higher": 9, "highli": 9, "histor": 9, "home": 11, "hook": 9, "host": [10, 11], "hour": 10, "how": [9, 10, 11], "howev": [9, 10], "http": [10, 11], "i": [9, 10, 11], "id": 11, "imag": [10, 11], "immedi": 10, "implement": [4, 6, 7], "import": [9, 10], "improv": 5, "includ": [9, 10, 11], "independ": 11, "index": 10, "individu": [9, 10, 11], "info": [10, 11], "inform": [9, 10, 11], "infrastructur": 10, "init": [9, 11], "initi": 9, "insid": 9, "instal": 9, "instanc": [9, 10], "instanti": 9, "instead": 9, "integr": 5, "intend": 5, "interact": 9, "interfac": 11, "involv": 11, "io": 10, "isol": 10, "issu": 11, "item": 9, "its": 9, "job": 9, "just": [9, 10], "keep": [9, 10], "kei": [9, 10, 11], "kept": 10, "keyfil": 9, "know": 10, "larg": [9, 11], "last": 11, "last_block_process": 9, "last_block_seen": 9, "lastli": 10, "later": 10, "latest": [10, 11], "lead": 9, "learn": [9, 11], "let": [9, 10, 11], "level": 4, "leverag": 11, "librari": 11, "like": [9, 10, 11], "limit": 9, "liquid": 11, "list": [10, 11], "listen": 11, "listqueuebrok": 9, "live": 11, "load": [9, 10], "local": [2, 9, 10], "locat": 9, "log": [10, 11], "logic": 9, "login": 10, "long": 9, "longer": 10, "look": [9, 10, 11], "lose": 9, "made": [9, 10], "mai": [9, 10, 11], "main": 2, "mainnet": [9, 11], "maintain": [9, 10], "make": [9, 10, 11], "malici": 10, "manag": 10, "manner": 9, "manual": 10, "mean": [9, 10, 11], "meant": [4, 10], "measur": 11, "memori": [9, 11], "messag": 9, "metadata": 10, "method": [4, 6, 7, 9, 10, 11], "metric": 9, "middlewar": 2, "might": [9, 10, 11], "minut": 10, "miss": 9, "missingprojectkeyerror": 11, "mode": 9, "modifi": 10, "modul": [4, 5, 6, 7, 9, 10], "monitor": 11, "more": [9, 10, 11], "most": [9, 11], "mount": 11, "move": 9, "multipl": 9, "must": [9, 10, 11], "my_bot": 9, "myevent": 9, "mymethod": 9, "name": [9, 10, 11], "necessari": [9, 10], "need": [9, 10, 11], "network": [9, 10, 11], "never": 10, "new": [10, 11], "newli": [10, 11], "next": 11, "node": 7, "none": [9, 10], "nor": 9, "nosql": 9, "note": [9, 10], "notif": 10, "now": 9, "object": [9, 11], "obtain": 10, "occur": [10, 11], "okai": 9, "on_": 9, "on_shutdown": 9, "on_startup": 9, "on_worker_shutdown": 9, "on_worker_startup": 9, "onc": [9, 10, 11], "one": [9, 11], "onli": [9, 10, 11], "oper": 10, "option": [9, 11], "orchestr": 10, "order": [9, 11], "organ": 10, "other": [4, 9, 10], "our": [9, 10], "out": [9, 10, 11], "own": [9, 11], "owner": 10, "packag": [9, 10, 11], "page": 9, "pai": 10, "paramet": [9, 10], "perform": 9, "permiss": 10, "phase": 10, "pip": 9, "place": 11, "plaintext": 10, "platform": [2, 5, 9, 10, 11], "pleas": [10, 11], "plugin": [9, 10, 11], "point": 10, "pool": 11, "popul": 9, "popular": 11, "possibl": 10, "pre": 9, "prefer": 10, "prepar": 11, "prevent": 10, "previou": 11, "primari": 9, "problem": 10, "process": 9, "process_histori": 9, "produc": 10, "product": 9, "program": 9, "project": [10, 11], "proper": [9, 11], "properli": [9, 10, 11], "provid": [9, 10, 11], "provis": [9, 10], "publish": [9, 11], "pull": 11, "purpos": 10, "push": [10, 11], "pwd": 11, "py": [9, 10, 11], "python": [9, 10, 11], "python3": 11, "quantiti": 9, "queri": 9, "question": 11, "queue": [7, 9], "queue_nam": 9, "quick": [2, 10], "rais": 9, "rate": 9, "re": 10, "read": [9, 11], "readi": 10, "readm": 11, "realli": 9, "recent": 11, "recommend": 9, "record": 9, "redeploi": 10, "redi": [9, 10], "redisasyncresultbackend": 9, "refer": [9, 10], "referenc": 10, "refund": 10, "regist": 11, "rel": 9, "relat": 10, "releas": 11, "reli": [9, 11], "remain": 10, "rememb": [9, 10], "remot": 9, "remov": 10, "replac": 11, "report": 10, "repositori": 11, "reqistri": 9, "request": 11, "requir": [9, 10, 11], "resid": 9, "resourc": 9, "respond": 11, "rest": 9, "restart": 10, "result": 9, "retri": 10, "return": 9, "reusabl": 9, "revers": 10, "review": 10, "right": 10, "risk": 9, "root": [9, 11], "rpc": [7, 10], "run": [6, 10, 11], "runner": [2, 9], "runtim": [9, 10], "safe": 10, "same": 9, "saw": 10, "scenario": 6, "script": [9, 11], "sdk": 11, "seamlessli": 9, "search": [9, 10, 11], "section": 11, "see": [9, 10, 11], "segreg": [9, 10], "send": [9, 10], "sender": 9, "sens": 10, "separ": [9, 10, 11], "sepolia": 9, "seri": 10, "serializ": 9, "servic": 10, "set": [9, 10], "setup": [9, 11], "share": [9, 10], "should": [9, 10, 11], "show": [9, 10], "shown": 9, "shut": 10, "shutdown": 10, "sign": 10, "signal": 9, "signatur": 9, "signer": [9, 10], "silverback": [2, 9, 10, 11], "silverback_broker_class": 9, "silverback_broker_kwarg": 9, "silverback_result_backend_class": 9, "silverback_result_backend_uri": 9, "silverbackbot": [9, 11], "similarli": 9, "simpl": [9, 11], "simplest": 9, "sinc": 9, "so": [9, 10, 11], "some": [9, 10, 11], "someth": 9, "sometim": 9, "sophist": 11, "special": 11, "specif": [9, 10], "specifi": 9, "sql": 9, "stai": 10, "start": [2, 9, 10], "start_block": 9, "startup": 10, "startup_st": 9, "state": [10, 11], "statu": 10, "stem": 11, "step": 10, "stop": [10, 11], "store": [9, 10], "stream": 10, "streamlin": 9, "structur": 10, "stuff": 9, "subcommand": 10, "subprocess": 9, "subscript": 2, "substat": 9, "success": 10, "successfulli": 10, "suddenli": 9, "suggest": [9, 10, 11], "sum": 9, "suppli": 11, "support": 11, "sure": [10, 11], "swap": 11, "symbol": 11, "sync": 9, "system": 10, "t": [9, 10], "tabl": 9, "take": [9, 10], "task": [9, 10, 11], "taskiq": [9, 10], "taskiq_redi": 9, "taskiqdepend": 9, "team": 10, "telegram": [9, 11], "testnet": 9, "than": 9, "thank": 10, "thei": 10, "them": [9, 10], "therefor": 10, "thi": [9, 10, 11], "thing": [9, 11], "those": [9, 10], "thought": 9, "threadsaf": 9, "through": 9, "throughli": 9, "time": [9, 10], "timelin": 10, "todo": [9, 10], "togeth": 10, "token": [9, 11], "tokenlist": 11, "topic": 10, "traceback": 11, "track": 10, "trackabl": 9, "trade": 11, "transact": 10, "transfer": 9, "transit": 10, "treat": [10, 11], "trigger": [6, 9, 10], "trust": 9, "try": 10, "two": 11, "type": [9, 11], "u": 9, "ui": 10, "unacknowledg": 10, "under": [9, 10, 11], "understand": [9, 10], "unfamiliar": 10, "unless": 10, "unlock": 11, "until": 10, "up": [9, 10], "updat": [9, 10, 11], "update_t": 9, "upload": 10, "upon": 9, "url": [9, 10], "us": [4, 7, 9, 10, 11], "usabl": 5, "usd": 11, "usdc": 11, "use_t": 9, "user": [4, 10, 11], "userguid": [9, 11], "usual": 10, "util": [2, 10], "valid": [9, 10], "valu": [9, 10], "var": 10, "variabl": 9, "varieti": 6, "veri": 9, "version": 11, "via": [7, 9, 10], "virtual": 11, "visit": [10, 11], "volum": [9, 11], "vulner": 10, "w": [9, 10], "wa": 9, "wai": 9, "want": [9, 10, 11], "warn": 11, "we": [9, 10, 11], "web3_alchemy_api_kei": 11, "web3_alchemy_project_id": 11, "web3_ethereum_mainnet_alchemy_api_kei": 11, "web3_ethereum_mainnet_alchemy_project_id": 11, "websit": 10, "websocket": [7, 11], "welcom": 11, "well": [5, 9, 10, 11], "what": [9, 10, 11], "when": [9, 10, 11], "where": 9, "which": [9, 10], "while": [9, 10], "who": 10, "whole": 5, "wish": 9, "within": 10, "without": [9, 10, 11], "won": 9, "work": [9, 10, 11], "worth": 11, "would": [9, 11], "write": 9, "yearn": 11, "yet": [10, 11], "yfi": 11, "you": [9, 10, 11], "yourself": 11}, "titles": ["Cloud Platform", "Local Development", "<no title>", "silverback.exceptions", "silverback.main", "silverback.middlewares", "silverback.runner", "silverback.subscriptions", "silverback.utils", "Developing Bots", "Deploying Bots", "Quick Start"], "titleterms": {"ad": 10, "block": 9, "bot": [9, 10], "build": 10, "cli": 2, "cloud": 0, "cluster": 10, "connect": 10, "contain": 10, "control": 10, "creat": [9, 10], "depend": 11, "deploi": [9, 10], "develop": [1, 9, 11], "distribut": 9, "docker": 11, "document": 11, "environ": [10, 11], "event": 9, "except": 3, "execut": 9, "guid": 2, "instal": 11, "local": 1, "log": 9, "main": 4, "measur": 10, "metric": 10, "middlewar": 5, "monitor": 10, "new": 9, "pip": 11, "platform": 0, "prerequisit": 9, "privat": 10, "project": 9, "python": 2, "quick": 11, "refer": 2, "registri": 10, "run": 9, "runner": 6, "set": 11, "setuptool": 11, "shutdown": 9, "sign": 9, "silverback": [3, 4, 5, 6, 7, 8], "start": 11, "startup": 9, "state": 9, "structur": 9, "subscript": 7, "test": 9, "transact": 9, "up": 11, "usag": 11, "user": 2, "util": 8, "variabl": 10, "via": 11, "view": 10, "worker": 9, "your": [9, 10, 11]}})
\ No newline at end of file
diff --git a/v0.6.2/userguides/development.html b/v0.6.2/userguides/development.html
new file mode 100644
index 00000000..a6199a42
--- /dev/null
+++ b/v0.6.2/userguides/development.html
@@ -0,0 +1,464 @@
+
+
+
+
+ Search
+ + + + ++ Searching for multiple words only shows matches that contain + all words. +
+ + + ++ + + + + +
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/userguides/platform.html b/v0.6.2/userguides/platform.html
new file mode 100644
index 00000000..3d76ed94
--- /dev/null
+++ b/v0.6.2/userguides/platform.html
@@ -0,0 +1,365 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Developing Bots
+In this guide, we are going to show you more details on how to build an bot with Silverback.
+Prerequisites
+You should have a python project with Silverback installed.
+You can install Silverback via pip install silverback
Project structure
+There are 3 suggested ways to structure your project. In the root directory of your project:
+-
+
Create a
bot.pyfile. This is the simplest way to define your bot project.
+Create a
bots/folder. Then develop bots in this folder as separate scripts (Do not include a init.py file).
+Create a
bot/folder with a__init__.pyfile that will include the instantiation of yourSilverbackBot()object.
+
The silverback cli automatically searches for python scripts to run as bots in specific locations relative to the root of your project.
+It will also be able to detect the scripts inside your bots/ directory and let you run those by name (in case you have multiple bots in your project).
If silverback finds a module named bot in the root directory of the project, then it will use that by default.
+
+Note
+It is suggested that you create the instance of your SilverbackBot() object by naming the variable bot, since silverback will autodetect that variable name when loading your script file.
Another way you can structure your bot is to create a bot folder and define a runner inside of that folder as __init__.py.
If you have a more complicated project that requires multiple bots, naming each bot their own individual name is okay to do, and we encourage you to locate them under the bots/ folder relative to the root of your project.
+This will work fairly seamlessly with the rest of the examples shown in this guide.
To run a bot, as long as your project directory follows the suggestions above by using a bot module, you can run it easily with:
silverback run --network your:network:of:choice
+If your bot’s module name is example.py (for example), you can run it like this:
silverback run example --network your:network:of:choice
+If the variable that you call the SilverbackBot() object is something other than bot, you can specific that by adding :{variable-name}:
silverback run example:my_bot --network your:network:of:choice
+We will automatically detect all scripts under the bots/ folder automatically, but if your bot resides in a location other than bots/ then you can use this to run it:
silverback run folder.example:bot --network your:network:of:choice
+Note that with a bot/__init__.py setup, silverback will also autodetect it, and you can run it with:
silverback run --network your:network:of:choice
+
+
+Note
+It is suggested that you develop your bots as scripts to keep your deployments simple.
+If you have a deep understanding of containerization, and have specific needs, you can set your bots up however you’d like, and then create your own container definitions for deployments to publish to your reqistry of choice.
+For the most streamlined experience, develop your bots as scripts, and avoid relying on local packages
+(e.g. do not include an __init__.py file inside your bots/ directory, and do not use local modules inside bots/ for reusable code).
+If you follow these suggestions, your Silverback deployments will be easy to use and require almost no thought.
Creating a Bot
+Creating a Silverback Bot is easy, to do so initialize the silverback.SilverbackBot class:
from silverback import SilverbackBot
+
+bot = SilverbackBot()
+The SilverbackBot class handles state and configuration.
+Through this class, we can hook up event handlers to be executed each time we encounter a new block or each time a specific event is emitted.
+Initializing the bot creates a network connection using the Ape configuration of your local project, making it easy to add a Silverback bot to your project in order to perform automation of necessary on-chain interactions required.
However, by default an bot has no configured event handlers, so it won’t be very useful.
+This is where adding event handlers is useful via the bot.on_ method.
+This method lets us specify which event will trigger the execution of our handler as well as which handler to execute.
New Block Events
+To add a block handler, you will do the following:
+from ape import chain
+
+@bot.on_(chain.blocks)
+def handle_new_block(block):
+ ...
+Inside of handle_new_block you can define any logic that you want to handle each new block detected by the silverback client.
+You can return any serializable data structure from this function and that will be stored in the results database as a trackable metric for the execution of this handler.
+Any errors you raise during this function will get captured by the client, and recorded as a failure to handle this block.
New Event Logs
+Similarly to blocks, you can handle events emitted by a contract by adding an event handler:
+from ape import Contract
+
+TOKEN = Contract(<your token address here>)
+
+@bot.on_(TOKEN.Transfer)
+def handle_token_transfer_events(transfer):
+ ...
+Inside of handle_token_transfer_events you can define any logic that you want to handle each new transfer event that gets emitted by TOKEN.Transfer detected by the silverback client.
+Again, you can return any serializable data structure from this function and that will be stored in the results database as a trackable metric for the execution of this handler.
+Any errors you raise during this function will get captured by the client, and recorded as a failure to handle this transfer event log.
Startup and Shutdown
+Worker Events
+If you have heavier resources you want to load during startup, or want to initialize things like database connections, you can add a worker startup function like so:
+@bot.on_worker_startup()
+def handle_on_worker_startup(state):
+ # Connect to DB, set initial state, etc
+ ...
+
+@bot.on_worker_shutdown()
+def handle_on_worker_shutdown(state):
+ # cleanup resources, close connections cleanly, etc
+ ...
+This function comes a parameter state that you can use for storing the results of your startup computation or resources that you have provisioned.
It’s import to note that this is useful for ensuring that your workers (of which there can be multiple) have the resources necessary to properly handle any updates you want to make in your handler functions, such as connecting to the Telegram API, an SQL or NoSQL database connection, or something else. This function will run on every worker process.
+New in 0.2.0: These events moved from on_startup() and on_shutdown() for clarity.
Worker State
+The state variable is also useful as this can be made available to each handler method so other stateful quantities can be maintained for other uses. Each distributed worker has its own instance of state.
To access the state from a handler, you must annotate context as a dependency like so:
from typing import Annotated
+from taskiq import Context, TaskiqDepends
+
+@bot.on_(chain.blocks)
+def block_handler(block, context: Annotated[Context, TaskiqDepends()]):
+ # Access state via context.state
+ ...
+Bot Events
+You can also add an bot startup and shutdown handler that will be executed once upon every bot startup. This may be useful for things like processing historical events since the bot was shutdown or other one-time actions to perform at startup.
+@bot.on_startup()
+def handle_on_startup(startup_state):
+ # Process missed events, etc
+ # process_history(start_block=startup_state.last_block_seen)
+ # ...or startup_state.last_block_processed
+ ...
+
+
+@bot.on_shutdown()
+def handle_on_shutdown():
+ # Record final state, etc
+ ...
+Changed in 0.2.0: The behavior of the @bot.on_startup() decorator and handler signature have changed. It is now executed only once upon bot startup and worker events have moved on @bot.on_worker_startup().
Bot State
+Sometimes it is very useful to have access to values in a shared state across your workers.
+For example you might have a value or complex reference type that you wish to update during one of your tasks, and read during another.
+Silverback provides bot.state to help with these use cases.
For example, you might want to pre-populate a large dataframe into state on startup, keeping that dataframe in sync with the chain through event logs, +and then use that data to determine a signal under which you want trigger transactions to commit back to the chain. +Such an bot might look like this:
+@bot.on_startup()
+def create_table(startup_state):
+ df = contract.MyEvent.query(..., start_block=startup_state.last_block_processed)
+ ... # Do some further processing on df
+ bot.state.table = df
+
+
+@bot.on_(contract.MyEvent)
+def update_table(log):
+ bot.state.table = ... # Update using stuff from `log`
+
+
+@bot.on_(chain.blocks)
+def use_table(blk):
+ if bot.state.table[...].mean() > bot.state.table[...].sum():
+ # Trigger your bot to send a transaction from `bot.signer`
+ contract.myMethod(..., sender=bot.signer)
+ ...
+
+
+Warning
+You can use bot.state to store any python variable type, however note that the item is not networked nor threadsafe so it is not recommended to have multiple tasks write to the same value in state at the same time.
+
+Note
+Bot startup and bot runtime event triggers (e.g. block or event container) are handled distinctly and can be trusted not to execute at the same time.
+Signing Transactions
+If configured, your bot with have bot.signer which is an Ape account that can sign arbitrary transactions you ask it to.
+To learn more about signing transactions with Ape, see the documentation.
+
+Warning
+While not recommended, you can use keyfile accounts for automated signing. +See this guide to learn more about how to do that.
+Running your Bot
+Once you have programmed your bot, it’s really useful to be able to run it locally and validate that it does what you expect it to do.
+To run your bot locally, we have included a really useful cli command run that takes care of connecting to the proper network, configuring signers (using your local Ape accounts), and starting up the bot client and in-memory task queue workers.
# Run your bot on the Ethereum Sepolia testnet, with your own signer:
+$ silverback run my_bot --network :sepolia --account acct-name
+
+
+Note
+my_bot:bot is not required for silverback run if you follow the suggested folder structure at the start of this page, you can just call it via my_bot.
It’s important to note that signers are optional, if not configured in the bot then bot.signer will be None.
+You can use this in your bot to enable a “test execution” mode, something like this:
# Compute some metric that might lead to creating a transaction
+if bot.signer:
+ # Execute a transaction via `sender=bot.signer`
+else:
+ # Log what the transaction *would* have done, had a signer been enabled
+
+
+Warning
+If you configure your bot to use a signer, and that signer signs anything given to it, remember that you can lose substational amounts of funds if you deploy this to a production network. +Always test your bots throughly before deploying, and always use a dedicated key for production signing with your bot in a remote setting.
+
+
+Note
+It is highly suggested to use a dedicated cloud signer plugin, such as ape-aws for signing transactions in a cloud environment.
+Use segregated keys and limit your risk by controlling the amount of funds that key has access to at any given time.
Distributed Execution
+Using only the silverback run ... command in a default configuration executes everything in one process and the job queue is completely in-memory with a shared state.
+In some high volume environments, you may want to deploy your Silverback bot in a distributed configuration using multiple processes to handle the messages at a higher rate.
The primary components are the client and workers. The client handles Silverback events (blocks and contract event logs) and creates jobs for the workers to process in an asynchronous manner.
+For this to work, you must configure a TaskIQ broker capable of distributed processing. +Additonally, it is highly suggested you should also configure a TaskIQ result backend in order to process and store the results of executing tasks.
+
+
+Note
+Without configuring a result backend, Silverback may not work as expected since your tasks will now suddenly return None instead of the actual result.
For instance, with taskiq_redis you could do something like this for the client:
export SILVERBACK_BROKER_CLASS="taskiq_redis:ListQueueBroker"
+export SILVERBACK_BROKER_KWARGS='{"queue_name": "taskiq", "url": "redis://127.0.0.1:6379"}'
+export SILVERBACK_RESULT_BACKEND_CLASS="taskiq_redis:RedisAsyncResultBackend"
+export SILVERBACK_RESULT_BACKEND_URI="redis://127.0.0.1:6379"
+
+silverback run --network :mainnet:alchemy
+And then the worker process with 2 worker subprocesses:
+export SILVERBACK_BROKER_CLASS="taskiq_redis:ListQueueBroker"
+export SILVERBACK_BROKER_KWARGS='{"url": "redis://127.0.0.1:6379"}'
+export SILVERBACK_RESULT_BACKEND_CLASS="taskiq_redis:RedisAsyncResultBackend"
+export SILVERBACK_RESULT_BACKEND_URI="redis://127.0.0.1:6379"
+
+silverback worker -w 2
+The client will send tasks to the 2 worker subprocesses, and all task queue and results data will be go through Redis.
+Testing your Bot
+TODO: Add backtesting mode w/ silverback test
Deploying your Bot
+Check out the Platform Deployment Userguide for more information on how to deploy your bot to the Silverback Platform.
+
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/v0.6.2/userguides/quickstart.html b/v0.6.2/userguides/quickstart.html
new file mode 100644
index 00000000..ce44d8fc
--- /dev/null
+++ b/v0.6.2/userguides/quickstart.html
@@ -0,0 +1,346 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Deploying Bots
+In this guide, we are going to show you more details on how to deploy your application to the Silverback Platform.
+Creating a Cluster
+The Silverback Platform runs your Bots on dedicated managed application Clusters. +These Clusters will take care to orchestrate infrastructure, monitor, run your triggers, and collect metrics for your applications. +Each Cluster is bespoke for an individual or organization, and isolates your applications from others on different infrastructure.
+Before we deploy our Bot, we have to create a Cluster. +If you haven’t yet, please sign up for Silverback at https://silverback.apeworx.io.
+Once you have signed up, you can actually create (and pay for) your Clusters from the Silverback CLI utility by first
+logging in to the Platform using silverback login,
+and then using silverback cluster new to follow the steps necessary to deploy it.
+
+Note
+The Platform UI will let you create and manage Clusters using a graphical experience, which may be preferred. +The CLI experience is for those working locally who don’t want to visit the website, or are locally developing their applications.
+Once you have created your Cluster, you have to fund it so it is made available for your use.
+To do that, use the silverback cluster pay create command to fund your newly created cluster.
+Please note that provisioning your cluster will take time, and it may take up to an hour for it to be ready.
+Check back after 10-15 minutes using the silverback cluster info command to see when it’s ready.
At any point after the Cluster is funded, you can fund it with more funds via silverback cluster pay add-time
+command to extend the timeline that the Cluster is kept around for.
+Note that it is possible for anyone to add more time to the Cluster, at any time and for any amount.
If that timeline expires, the Platform will automatically de-provision your infrastructure, and it is not possible to reverse this! +The Platform may send you notifications when your Stream is close to expiring, but it is up to you to remember to fill it so it doesn’t. +Note that your data collection will stay available for up to 30 days allowing you the ability to download any data you need.
+Lastly, if you ever feel like you no longer need your Cluster, you can cancel the funding for it and get a refund of the remaining funds.
+If you are the owner of the Stream, you can do this via the silverback cluster pay cancel command.
+Only the owner may do this, so if you are not the owner you should contact them to have them do that action for you.
Connecting to your Cluster
+To connect to a cluster, you can use commands from the silverback cluster subcommand group.
+For instance, to list all your available bots on your cluster, use silverback cluster bots list.
+To obtain general information about your cluster, just use silverback cluster info,
+or silverback cluster health to see the current status of your Cluster.
If you have no bots, we will first have to containerize our Bots and upload them to a container registry that our Cluster is configured to access.
+
+
+Note
+Building a container for your application can be an advanced topic, we have included the silverback build subcommand to help assist in generating Dockerfiles.
Building your Bot
+To build your container definition(s) for your bot(s), you can use the silverback build command. This command searches your bots directory for python modules, then auto-generates Dockerfiles.
For example, if your directory is structured as suggested in development, and your bots/ directory looks like this:
bots/
+├── botA.py
+├── botB.py
+├── botC.py
+Then you can use silverback build --generate to generate 3 separate Dockerfiles for those bots, and start trying to build them.
Those Dockerfiles will appear under .silverback-images/ as follows:
silverback build --generate
+This method will generate 3 Dockerfiles:
+.silverback-images/
+├── Dockerfile.botA
+├── Dockerfile.botB
+├── Dockerfile.botC
+You can retry you builds using the following (assuming you don’t modify the structure of your project):
+silverback build
+You can then push your image to your registry using:
+docker push your-registry-url/project/botA:latest
+TODO: The ApeWorX team has github actions definitions for building, pushing and deploying.
+If you are unfamiliar with docker and container registries, you can use the [[github-action]].
+You do not need to build using this command if you use the github action, but it is there to help you if you are having problems figuring out how to build and run your bot images on the cluster successfully.
+TODO: Add how to debug containers using silverback run w/ taskiq-redis broker
Adding Environment Variables
+Once you have created your bot application container image, you might know of some environment variables the image requires to run properly.
+Thanks to it’s flexible plugin system, ape plugins may also require specific environment variables to load as well.
+Silverback Clusters include an environment variable management system for exactly this purpose,
+which you can manage using silverback cluster vars subcommand.
The environment variable management system makes use of a concept called “Variable Groups” which are distinct collections of environment variables meant to be used together. +These variable groups will help in managing the runtime environment of your Bots by allowing you to segregate different variables depending on each bot’s needs.
+To create an environment group, use the silverback cluster vars new command and give it a name and a set of related variables.
+For instance, it may make sense to make a group of variables for your favorite Ape plugins or services, such as RPC Providers, Blockchain Data Indexers, Etherscan, etc.
+You might have a database connection that you want all your bots to access.
+
+Warning
+All environment variables in Silverback Clusters are private, meaning they cannot be viewed after they are uploaded. +However, your Bots will have full access to their values from within their runtime environment, so be careful that you fully understand what you are sharing with your bots.
+Also, understand your build dependencies within your container and make sure you are not using any vulnerable or malicious packages.
+NEVER upload your private key in a plaintext format!
+Use Ape Account Plugins such as ape-aws to safely manage access to your hosted keys.
+
+Note
+The Etherscan plugin will not function without an API key in the cloud environment.
+This will likely create errors running your applications if you use Ape’s Contract class.
To list your Variable Groups, use silverback cluster vars list.
+To see information about a specific Variable Group, including the Environment Variables it includes, use silverback cluster vars info
+To remove a variable group, use silverback cluster vars remove,
+
+Note
+You can only remove a Variable Group if it is not referenced by any existing Bot.
+Once you have created all the Variable Group(s) that you need to operate your Bot, you can reference these groups by name when adding your Bot to the cluster.
+Private Container Registries
+If you are using a private container registry to store your images, you will need to provide your bot with the necessary credentials to access it.
+First you will need to add your credentials to the cluster with the silverback cluster registry auth new command.
Then you can provide the name of these credentials when creating your bot with the silverback cluster bots new or silverback cluster bots update commands.
Deploying your Bot
+You are finally ready to deploy your bot on the Cluster and get it running!
+To deploy your Bot, use the silverback cluster bots new command and give your bot a name,
+container image, network to run on, an account alias (if you want to sign transactions w/ bot.signer),
+and any environment Variable Group(s) the bot needs.
+If everything validates successfully, the Cluster will begin orchestrating your deployment for you.
You should monitor the deployment and startup of your bot to make sure it enters the RUNNING state successfully.
+You can do this using the silverback cluster bots health command.
+
+Note
+It usually takes a minute or so for your bot to transition from PROVISIONING to STARTUP to the RUNNING state. +If there are any difficulties in downloading your container image, provisioning your desired infrastructure, or if your application encounters an error during the STARTUP phase, +the Bot will not enter into the RUNNING state and will be shut down gracefully into the STOPPED state.
+Once in the STOPPED state, you can make any adjustments to the environment Variable Group(s) or other runtime parameters in the Bot config;
+or, you can make code changes and deploy a new image for the Bot to use.
+Once ready, you can use the silverback cluster bots start command to re-start your Bot.
If at any time you want to view the configuration of your bot, you can do so using the silverback cluster bots info command.
+You can also update metadata or configuration of your bot using the silverback cluster bots update command.
+Lastly, if you want to shutdown and delete your bot, you can do so using the silverback cluster bots remove command.
+
+Note
+Configuration updates do not redeploy your Bots automatically, you must manually stop and restart your bots for changes to take effect.
+
+
+Warning
+Removing a Bot will immediately trigger a SHUTDOWN if the Bot is not already STOPPED.
+Monitoring your Bot
+Once your bot is successfully running in the RUNNING state, you can monitor your bot with a series of commands
+under the silverback cluster bots subcommand group.
+We already saw how you can use the silverback cluster bots list command to see all bots managed by your Cluster (running or not).
To see runtime health information about a specific bot, again use the silverback cluster bots health command.
+You can view the logs that a specific bot is generating using the silverback cluster bots logs command.
+Lastly, you can view unacknowledged errors that your bot has experienced while in the RUNNING state
+using the silverback cluster bots errors command.
+
+Warning
+Once in the RUNNING state, your Bot will not stop running unless it experiences a certain amount of errors in quick succession. +Any task execution that experiences an error will abort execution (and therefore not produce any metrics) but the Bot will not shutdown.
+All errors encountered during task exeuction are reported to the Cluster for later review by any users with appriopiate access.
+Tasks do not retry (by default), but updates to bot.state are maintained up until the point an error occurs.
It is important to keep track of these errors and ensure that none of them are in fact critical to the operation of your Bot, +and to take corrective or preventative action if it is determined that it should be treated as a more critical failure condition.
+
+
+Note
+Your Bots can also be monitored from the Platform UI at https://silverback.apeworx.io.
+Controlling your Bot
+As we already saw, once a Bot is configured in a Cluster, we can control it using commands from the silverback cluster bots subcommand group.
+For example, we can attempt to start a Bot that is not currently running (after making configuration or code changes)
+using the silverback cluster bots start command.
+We can also stop a bot using silverback cluster bots stop that is currently in the RUNNING state if we desire.
+
+Note
+Controlling your bots can be done from the Platform UI at https://silverback.apeworx.io, if you have the right permissions to do so.
+TODO: Updating runtime parameters
+Viewing Measured Metrics
+TODO: Downloading metrics from your Bot
+
+
+
+
+
+
+
+ silverback
+
+
+
+
+
+ silverback
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
+
+
+
+
+
+
+
+
+
+
+via
+
+
+
+
+via
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Quick Start
+Silverback lets you create and deploy your own Python bots that respond to on-chain events. +The Silverback library leverages the Ape development framework as well as it’s ecosystem of plugins and packages to enable you to develop simple-yet-sophisticated automated bots that can listen and respond to live chain data.
+Silverback bots are excellent for use cases that involve continuously monitoring and responding to on-chain events, such as newly confirmed blocks or contract event logs.
+Some examples of these types of bots:
+-
+
Monitoring new pool creations, and depositing liquidity
+Measuring trading activity of popular pools
+Listening for large swaps to update a telegram group
+
Documentation
+Please read the development userguide for more information on how to develop a bot.
+Dependencies
+-
+
python3 version 3.10 or greater, python3-dev
+
Installation
+Silverback relies heavily on the Ape development framework, so it’s worth it to familarize yourself with how to install Ape and it’s plugins using the Ape installation userguide.
+
+
+Note
+It is suggested that you use a virtual environment of your choosing, and then install the Silverback package via one of the following options.
+via pip
+You can install the latest release via pip:
pip install silverback
+via setuptools
+You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/silverback.git silverback
+cd silverback
+python3 setup.py install
+Quick Usage
+Checkout the example to see how to use the library.
+
+
+Note
+The example makes use of the Ape Tokens plugin. +Be sure to properly configure your environment for the USDC and YFI tokens on Ethereum mainnet.
+To run your bot against a live network, this SDK includes a simple bot command you can use via:
+$ silverback run example --network :mainnet:alchemy
+
+
+Note
+This bot uses an in-memory task broker by default. +If you want to learn more about what that means, please visit the development userguide.
+
+
+Note
+It is suggested that you create a bots/ folder in the root of your project.
+Silverback will automatically register files in this folder as separate bots that can be run via the silverback run command.
+
+Note
+It is also suggested that you treat this as a scripts folder, and do not include an init.py +If you have a complicated project, follow the previous example to ensure you run the bot correctly.
+
+
+Note
+A final suggestion would be to name your SilverbackBot object bot. Silverback automatically searches
+for this object name when running. If you do not do so, once again, ensure you replace example with
+example:<name-of-object> the previous example.
To auto-generate Dockerfiles for your bots, from the root of your project, you can run:
+silverback build
+This will place the generated dockerfiles in a special directory in the root of your project.
+As an example, if you have a bots directory that looks like:
+bots/
+├── botA.py
+├── botB.py
+├── botC.py
+This method will generate 3 Dockerfiles:
+.silverback-images/
+├── Dockerfile.botA
+├── Dockerfile.botB
+├── Dockerfile.botC
+These Dockerfiles can be deployed with the docker push command documented in the next section so you can use it in cloud-based deployments.
+
+Note
+As an aside, if your bots/ directory is a python package, you will cause conflicts with the dockerfile generation feature. This method will warn you that you are generating bots for a python package, but will not stop you from doing so. If you choose to generate dockerfiles, the user should be aware that it will only copy each individual file into the Dockerfile, and will not include any supporting python functionality. Each python file is expected to run independently. If you require more complex bots, you will have to build a custom docker image.
+Docker Usage
+$ docker run --volume $PWD:/home/harambe/project --volume ~/.tokenlists:/home/harambe/.tokenlists apeworx/silverback:latest run example --network :mainnet
+
+
+Note
+The Docker image we publish uses Python 3.11.
+Setting Up Your Environment
+Running the Quick Usage and Docker Usage with the provided example will fail if you do not have a fully-configured environment.
+Most common issues when using the SDK stem from the proper configuration of Ape plugins to unlock the behavior you desire.
You should use a provider that supports websockets to run silverback.
+If you want to use a hosted provider with websocket support like Alchemy to run this example, you will need a Alchemy API key for Ethereum mainnet.
+If you attempt to run the Docker Usage command without supplying this key, you will get the following error:
$ docker run --volume $PWD:/home/harambe/project --volume ~/.tokenlists:/home/harambe/.tokenlists apeworx/silverback:latest run example --network :mainnet:alchemy
+Traceback (most recent call last):
+ ...
+ape_alchemy.exceptions.MissingProjectKeyError: Must set one of $WEB3_ALCHEMY_PROJECT_ID, $WEB3_ALCHEMY_API_KEY, $WEB3_ETHEREUM_MAINNET_ALCHEMY_PROJECT_ID, $WEB3_ETHEREUM_MAINNET_ALCHEMY_API_KEY.
+Go to Alchemy, create an account, then create an bot in their dashboard, and copy the API Key.
+Another requirement for the command from Docker Usage to run the given example is that it uses ape-tokens plugin to look up token interfaces by symbol.
+In order for this to work, you should have installed and configured that plugin using a token list that includes both YFI and USDC on Ethereum mainnet.
+Doing this will give you a ~/.tokenlists hidden folder in your home folder that you must mount into the docker container with the following flag:
... --volume ~/.tokenlists:/home/harambe/.tokenlists ...
+
+
+Note
+It is suggested to install the 1inch tokenlist via ape tokens install tokens.1inch.eth.
+See the ape-tokens README for more information.
To check that both of the tokens exist in your configured tokenlist, you can execute this command:
+$ ape tokens token-info YFI
+ Symbol: YFI
+ Name: yearn.finance
+ Chain ID: 1
+ Address: 0x0bc529c00C6401aEF6D220BE8C6Ea1667F6Ad93e
+ Decimals: 18
+
+$ ape tokens token-info USDC
+ Symbol: USDC
+ Name: Circle USD
+ Chain ID: 1
+ Address: 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48
+ Decimals: 6
+
+
+Note
+If you want, you can comment out the two functions exec_event1 and exec_event2 that handle the contract log events from these contracts if you do not have the configured tokenlist, then your command should work.
Development
+This project is under active development in preparation of the release of the Silverback Platform. +Things might not be in their final state and breaking changes may occur. +Comments, questions, criticisms and pull requests are welcomed.
+See Contributing for more information.
+