diff --git a/latest/.buildinfo b/latest/.buildinfo index 5818901d..32905845 100644 --- a/latest/.buildinfo +++ b/latest/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ccb6ed74fa352cc8fbfede0bd0036fd7 +config: ac89d44b62bac8d6bc3661d438dc9349 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/latest/.doctrees/commands/run.doctree b/latest/.doctrees/commands/run.doctree index d3fa1b41..03efa2d2 100644 Binary files a/latest/.doctrees/commands/run.doctree and b/latest/.doctrees/commands/run.doctree differ diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle index 6d578455..87a218cb 100644 Binary files a/latest/.doctrees/environment.pickle and b/latest/.doctrees/environment.pickle differ diff --git a/latest/.doctrees/methoddocs/application.doctree b/latest/.doctrees/methoddocs/application.doctree index 41d8c191..58f56767 100644 Binary files a/latest/.doctrees/methoddocs/application.doctree and b/latest/.doctrees/methoddocs/application.doctree differ diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree index 8d5de86a..8e3e7e56 100644 Binary files a/latest/.doctrees/methoddocs/exceptions.doctree and b/latest/.doctrees/methoddocs/exceptions.doctree differ diff --git a/latest/.doctrees/methoddocs/middlewares.doctree b/latest/.doctrees/methoddocs/middlewares.doctree index e2f4dab2..957f807c 100644 Binary files a/latest/.doctrees/methoddocs/middlewares.doctree and b/latest/.doctrees/methoddocs/middlewares.doctree differ diff --git a/latest/.doctrees/methoddocs/runner.doctree b/latest/.doctrees/methoddocs/runner.doctree index dddfd42d..21b156bb 100644 Binary files a/latest/.doctrees/methoddocs/runner.doctree and b/latest/.doctrees/methoddocs/runner.doctree differ diff --git a/latest/.doctrees/methoddocs/subscriptions.doctree b/latest/.doctrees/methoddocs/subscriptions.doctree index 6d838ad7..85b37122 100644 Binary files a/latest/.doctrees/methoddocs/subscriptions.doctree and b/latest/.doctrees/methoddocs/subscriptions.doctree differ diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree index a8fb2709..9005c130 100644 Binary files a/latest/.doctrees/methoddocs/utils.doctree and b/latest/.doctrees/methoddocs/utils.doctree differ diff --git a/latest/commands/run.html b/latest/commands/run.html index d319b3e6..194a57a0 100644 --- a/latest/commands/run.html +++ b/latest/commands/run.html @@ -50,6 +50,7 @@ + @@ -135,7 +136,7 @@

run

Override the default network and provider. (see ape networks list for options)

Options:
-

:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::test | :local:test | ethereum::test | ethereum:local:test | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | :local | ethereum:local | ethereum

+

:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum

diff --git a/latest/genindex.html b/latest/genindex.html index 2d40f06d..5ccb79eb 100644 --- a/latest/genindex.html +++ b/latest/genindex.html @@ -47,6 +47,7 @@ + diff --git a/latest/index.html b/latest/index.html index e37bdc2e..cb119434 100644 --- a/latest/index.html +++ b/latest/index.html @@ -49,6 +49,7 @@ + diff --git a/latest/methoddocs/application.html b/latest/methoddocs/application.html index 59dc7ae4..8eda5b82 100644 --- a/latest/methoddocs/application.html +++ b/latest/methoddocs/application.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/exceptions.html b/latest/methoddocs/exceptions.html index 96236e5f..3caa0116 100644 --- a/latest/methoddocs/exceptions.html +++ b/latest/methoddocs/exceptions.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/middlewares.html b/latest/methoddocs/middlewares.html index de51e2bc..d283d876 100644 --- a/latest/methoddocs/middlewares.html +++ b/latest/methoddocs/middlewares.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/runner.html b/latest/methoddocs/runner.html index 505feb14..b5141e1c 100644 --- a/latest/methoddocs/runner.html +++ b/latest/methoddocs/runner.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/subscriptions.html b/latest/methoddocs/subscriptions.html index 0dcaaeaf..4ba3c598 100644 --- a/latest/methoddocs/subscriptions.html +++ b/latest/methoddocs/subscriptions.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/utils.html b/latest/methoddocs/utils.html index 4fe73caa..31ef206d 100644 --- a/latest/methoddocs/utils.html +++ b/latest/methoddocs/utils.html @@ -49,6 +49,7 @@ + diff --git a/latest/py-modindex.html b/latest/py-modindex.html index 67413fcf..e675d648 100644 --- a/latest/py-modindex.html +++ b/latest/py-modindex.html @@ -50,6 +50,7 @@ + diff --git a/latest/search.html b/latest/search.html index cd1b14e6..c2abd406 100644 --- a/latest/search.html +++ b/latest/search.html @@ -50,6 +50,7 @@ + diff --git a/latest/searchindex.js b/latest/searchindex.js index 0c0459a6..af0e1dc6 100644 --- a/latest/searchindex.js +++ b/latest/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["commands/run", "index", "methoddocs/application", "methoddocs/exceptions", "methoddocs/middlewares", "methoddocs/runner", "methoddocs/subscriptions", "methoddocs/utils", "userguides/development", "userguides/quickstart"], "filenames": ["commands/run.rst", "index.md", "methoddocs/application.md", "methoddocs/exceptions.md", "methoddocs/middlewares.md", "methoddocs/runner.md", "methoddocs/subscriptions.md", "methoddocs/utils.md", "userguides/development.md", "userguides/quickstart.md"], "titles": ["run", "Silverback Docs", "silverback.application", "silverback.exceptions", "silverback.middlewares", "silverback.runner", "silverback.subscriptions", "silverback.utils", "Developing a Silverback Application", "Quick Start"], "terms": {"silverback": [0, 9], "applic": [0, 1, 3, 5, 9], "client": [0, 4, 5, 8], "option": [0, 2, 8], "path": 0, "v": 0, "verbos": 0, "lvl": 0, "One": 0, "error": [0, 2, 8], "warn": 0, "success": 0, "info": 0, "debug": 0, "network": [0, 5, 8, 9], "overrid": [0, 2], "default": [0, 2, 8], "provid": [0, 5], "see": [0, 9], "ap": [0, 8, 9], "list": 0, "mainnet": [0, 8, 9], "geth": 0, "ethereum": [0, 8], "goerli": 0, "sepolia": [0, 8], "test": 0, "local": [0, 8], "account": [0, 8], "runner": [0, 1, 8, 9], "an": [0, 2, 3, 6, 7, 9], "import": [0, 2, 8], "str": [0, 2, 3], "format": 0, "modul": [0, 2, 4, 5, 6], "customrunn": 0, "x": 0, "max": 0, "except": [0, 1, 4], "max_except": [0, 5], "argument": 0, "requir": [0, 8], "quick": 1, "start": [1, 2, 8], "develop": 1, "run": [1, 5, 9], "middlewar": 1, "subscript": 1, "util": 1, "The": [2, 4, 5, 6, 8, 9], "contain": [2, 3, 4, 5, 6], "high": [2, 8], "level": 2, "implement": [2, 5, 6], "user": [2, 3], "": [2, 4, 8, 9], "meant": 2, "us": [2, 5, 6, 8, 9], "expos": 2, "method": [2, 5, 6, 8], "handler": [2, 8], "other": [2, 8], "function": [2, 4, 8], "class": [2, 4, 5, 6, 8], "silverbackapp": [2, 5, 8], "set": [2, 8], "none": [2, 8], "base": [2, 3, 4, 5, 6], "manageraccessmixin": [2, 4, 5], "singleton": 2, "must": [2, 8], "initi": [2, 8], "prior": 2, "usag": 2, "exampl": [2, 8, 9], "from": [2, 8], "app": [2, 5, 8, 9], "connect": [2, 5, 6, 8], "ha": [2, 8], "been": [2, 8], "can": [2, 8, 9], "call": [2, 4], "broker": [2, 4, 5, 8], "e": 2, "g": 2, "on_": [2, 8], "get_block_handl": 2, "asynctaskiqdecoratedtask": 2, "get": [2, 8], "access": [2, 8], "block": [2, 7, 9], "event": [2, 5, 9], "return": [2, 4, 8], "decor": [2, 8], "task": [2, 4, 5, 8], "one": [2, 7, 8], "creat": [2, 3, 9], "type": [2, 8, 9], "get_event_handl": 2, "event_target": 2, "checksumaddress": 2, "event_nam": 2, "paramet": [2, 4, 8], "addresstyp": 2, "contract": [2, 8, 9], "address": [2, 8], "target": 2, "name": [2, 8], "emit": [2, 8], "get_shutdown_handl": 2, "silverback_shutdown": 2, "get_startup_handl": 2, "silverback_startup": 2, "blockcontain": 2, "contractev": 2, "new_block_timeout": 2, "int": [2, 5], "start_block": [2, 8], "handl": [2, 8], "union": 2, "sourc": 2, "watch": 2, "timeout": 2, "i": [2, 4, 8, 9], "accept": 2, "whatev": 2, "ar": [2, 5, 8, 9], "poll": 2, "number": 2, "process": [2, 4, 5, 8], "latest": [2, 9], "rais": [2, 5, 8], "invalidcontainertypeerror": [2, 3], "If": [2, 5, 8], "configur": [2, 5, 8], "on_shutdown": [2, 8], "callabl": 2, "code": 2, "execut": [2, 4, 5], "worker": [2, 4], "shutdown": [2, 3], "def": [2, 8], "do_something_on_shutdown": 2, "record": [2, 8], "final": [2, 8, 9], "state": [2, 9], "on_startup": [2, 8], "upon": [2, 8], "startup": 2, "restart": 2, "after": [2, 4], "do_something_on_startup": 2, "startup_st": [2, 8], "reprocess": 2, "miss": [2, 8], "on_worker_shutdown": [2, 8], "everi": [2, 8], "updat": [2, 8, 9], "some": [2, 8, 9], "extern": 2, "servic": 2, "perhap": 2, "inform": 2, "on_worker_startup": [2, 8], "provis": [2, 8], "resourc": [2, 8], "add": [2, 4, 8], "thing": [2, 8, 9], "circuitbreak": 3, "messag": [3, 4, 8], "silverbackexcept": 3, "custom": 3, "trigger": [3, 5, 8], "duplicatehandlererror": 3, "handler_typ": 3, "halt": [3, 5], "importfromstringerror": 3, "ani": [3, 7, 8], "nowebsocketavailableerror": 3, "apeexcept": 3, "runtim": 3, "fault": 3, "intend": 4, "improv": 4, "usabl": 4, "whole": 4, "integr": 4, "platform": 4, "well": [4, 8, 9], "silverbackmiddlewar": 4, "arg": [4, 5], "kwarg": [4, 5], "taskiqmiddlewar": 4, "async": [4, 5], "on_error": 4, "taskiqmessag": 4, "result": [4, 8], "taskiqresult": 4, "baseexcept": 4, "thi": [4, 8, 9], "when": 4, "found": 4, "incom": 4, "valu": [4, 6, 7], "post_execut": 4, "hook": [4, 8], "complet": [4, 8], "side": 4, "It": [4, 8], "current": 4, "post_sav": 4, "post": 4, "save": 4, "result_backend": 4, "pre_execut": 4, "befor": [4, 8], "which": [4, 8], "mean": 4, "pars": 4, "taskiq": [4, 8], "modifi": 4, "pre_send": 4, "send": 4, "right": 4, "sent": 4, "varieti": 5, "differ": 5, "scenario": 5, "baserunn": 5, "3": [5, 9], "abc": 5, "assembl": 5, "Will": 5, "listen": [5, 9], "against": [5, 9], "context": [5, 8], "them": 5, "kick": 5, "over": 5, "pollingrunn": 5, "singl": 5, "live": [5, 9], "basic": 5, "memori": [5, 8], "queue": [5, 6, 8], "websocketrunn": [5, 8], "websocket": [5, 6], "rpc": 6, "node": 6, "via": [6, 8], "eth_subscrib": 6, "subscriptiontyp": 6, "enum": 6, "enumer": 6, "async_wrap_it": 7, "iter": 7, "asynciter": 7, "wrap": 7, "asynchron": [7, 8], "hexbytes_dict": 7, "data": [7, 8, 9], "dict": 7, "convert": 7, "hex": 7, "string": 7, "flat": 7, "dictionari": 7, "hexbyt": 7, "In": 8, "guid": 8, "we": 8, "go": 8, "show": 8, "you": [8, 9], "more": [8, 9], "detail": 8, "how": [8, 9], "build": 8, "should": [8, 9], "have": 8, "python": [8, 9], "project": [8, 9], "instal": 8, "pip": 8, "easi": 8, "do": 8, "so": [8, 9], "through": 8, "up": [8, 9], "each": 8, "time": 8, "encount": 8, "specif": 8, "make": 8, "bot": [8, 9], "order": 8, "perform": 8, "autom": [8, 9], "necessari": 8, "chain": [8, 9], "interact": 8, "howev": 8, "won": 8, "t": 8, "veri": 8, "where": 8, "ad": 8, "let": [8, 9], "u": 8, "specifi": 8, "our": 8, "To": [8, 9], "follow": 8, "handle_new_block": 8, "insid": 8, "defin": 8, "logic": 8, "want": 8, "detect": 8, "serializ": 8, "structur": 8, "store": 8, "databas": 8, "trackabl": 8, "metric": 8, "dure": 8, "captur": 8, "failur": 8, "similarli": 8, "token": 8, "here": 8, "transfer": 8, "handle_token_transfer_ev": 8, "again": 8, "heavier": 8, "load": 8, "like": 8, "handle_on_worker_startup": 8, "db": 8, "etc": 8, "handle_on_worker_shutdown": 8, "cleanup": 8, "close": 8, "cleanli": 8, "come": 8, "comput": 8, "note": 8, "ensur": 8, "multipl": 8, "properli": 8, "telegram": [8, 9], "api": 8, "sql": 8, "nosql": 8, "someth": 8, "els": 8, "0": 8, "2": 8, "These": 8, "move": 8, "clariti": 8, "variabl": 8, "also": 8, "made": 8, "avail": 8, "quantiti": 8, "maintain": 8, "its": 8, "own": [8, 9], "instanc": 8, "annot": 8, "depend": 8, "taskiqdepend": 8, "block_handl": 8, "onc": 8, "mai": [8, 9], "histor": 8, "sinc": 8, "wa": 8, "action": 8, "handle_on_startup": 8, "process_histori": 8, "last_block_seen": 8, "last_block_process": 8, "handle_on_shutdown": 8, "chang": [8, 9], "behavior": 8, "signatur": 8, "now": 8, "onli": 8, "program": 8, "realli": 8, "abl": 8, "valid": 8, "doe": 8, "what": 8, "expect": 8, "includ": [8, 9], "cli": 8, "command": 8, "take": 8, "care": 8, "proper": 8, "signer": 8, "testnet": 8, "my_bot": 8, "acct": 8, "enabl": [8, 9], "mode": 8, "might": [8, 9], "lead": 8, "transact": 8, "sender": 8, "would": 8, "done": 8, "had": 8, "sign": 8, "anyth": 8, "given": 8, "rememb": 8, "lose": 8, "substat": 8, "amount": 8, "fund": 8, "product": 8, "alwai": 8, "throughli": 8, "defualt": 8, "everyth": 8, "job": 8, "share": 8, "volum": [8, 9], "environ": 8, "higher": 8, "rate": 8, "primari": 8, "compon": 8, "manner": 8, "For": 8, "work": 8, "capabl": 8, "taskiq_redi": 8, "could": 8, "export": 8, "silverback_broker_class": 8, "listqueuebrok": 8, "silverback_broker_uri": 8, "redi": 8, "127": 8, "1": 8, "6379": 8, "alchemi": [8, 9], "And": 8, "subprocess": 8, "w": 8, "all": 8, "todo": 8, "backtest": 8, "packag": [8, 9], "deploy": 8, "deploi": 9, "your": 9, "respond": 9, "librari": 9, "leverag": 9, "framework": 9, "ecosystem": 9, "plugin": 9, "simpl": 9, "yet": 9, "sophist": 9, "excel": 9, "case": 9, "involv": 9, "continu": 9, "monitor": 9, "newli": 9, "confirm": 9, "log": 9, "new": 9, "pool": 9, "creation": 9, "deposit": 9, "liquid": 9, "measur": 9, "trade": 9, "activ": 9, "popular": 9, "larg": 9, "swap": 9, "group": 9, "read": 9, "userguid": 9, "learn": 9, "python3": 9, "version": 9, "8": 9, "greater": 9, "dev": 9, "reli": 9, "heavili": 9, "worth": 9, "familar": 9, "yourself": 9, "releas": 9, "clone": 9, "repositori": 9, "most": 9, "date": 9, "git": 9, "http": 9, "github": 9, "com": 9, "apeworx": 9, "cd": 9, "setup": 9, "py": 9, "checkout": 9, "sdk": 9, "pwd": 9, "home": 9, "haramb": 9, "tokenlist": 9, "consid": 9, "beta": 9, "break": 9, "occur": 9, "comment": 9, "question": 9, "critic": 9, "pull": 9, "request": 9, "welcom": 9}, "objects": {"silverback": [[2, 0, 0, "-", "application"], [3, 0, 0, "-", "exceptions"], [4, 0, 0, "-", "middlewares"], [5, 0, 0, "-", "runner"], [6, 0, 0, "-", "subscriptions"], [7, 0, 0, "-", "utils"]], "silverback.application": [[2, 1, 1, "", "SilverbackApp"]], "silverback.application.SilverbackApp": [[2, 2, 1, "", "get_block_handler"], [2, 2, 1, "", "get_event_handler"], [2, 2, 1, "", "get_shutdown_handler"], [2, 2, 1, "", "get_startup_handler"], [2, 2, 1, "", "on_"], [2, 2, 1, "", "on_shutdown"], [2, 2, 1, "", "on_startup"], [2, 2, 1, "", "on_worker_shutdown"], [2, 2, 1, "", "on_worker_startup"]], "silverback.exceptions": [[3, 3, 1, "", "CircuitBreaker"], [3, 3, 1, "", "DuplicateHandlerError"], [3, 3, 1, "", "Halt"], [3, 3, 1, "", "ImportFromStringError"], [3, 3, 1, "", "InvalidContainerTypeError"], [3, 3, 1, "", "NoWebsocketAvailableError"], [3, 3, 1, "", "SilverbackException"]], "silverback.middlewares": [[4, 1, 1, "", "SilverbackMiddleware"]], "silverback.middlewares.SilverbackMiddleware": [[4, 2, 1, "", "on_error"], [4, 2, 1, "", "post_execute"], [4, 2, 1, "", "post_save"], [4, 2, 1, "", "pre_execute"], [4, 2, 1, "", "pre_send"]], "silverback.runner": [[5, 1, 1, "", "BaseRunner"], [5, 1, 1, "", "PollingRunner"], [5, 1, 1, "", "WebsocketRunner"]], "silverback.runner.BaseRunner": [[5, 2, 1, "", "run"]], "silverback.runner.WebsocketRunner": [[5, 2, 1, "", "run"]], "silverback.subscriptions": [[6, 1, 1, "", "SubscriptionType"]], "silverback.utils": [[7, 4, 1, "", "async_wrap_iter"], [7, 4, 1, "", "hexbytes_dict"]], "run": [[0, 5, 1, "cmdoption-run-account", "--account"], [0, 5, 1, "cmdoption-run-x", "--max-exceptions"], [0, 5, 1, "cmdoption-run-network", "--network"], [0, 5, 1, "cmdoption-run-runner", "--runner"], [0, 5, 1, "cmdoption-run-v", "--verbosity"], [0, 5, 1, "cmdoption-run-v", "-v"], [0, 5, 1, "cmdoption-run-x", "-x"], [0, 5, 1, "cmdoption-run-arg-PATH", "PATH"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["std", "cmdoption", "program option"]}, "titleterms": {"run": [0, 8], "silverback": [1, 2, 3, 4, 5, 6, 7, 8], "doc": 1, "user": 1, "guid": 1, "cli": 1, "refer": 1, "python": 1, "applic": [2, 8], "except": 3, "middlewar": 4, "runner": 5, "subscript": 6, "util": 7, "develop": [8, 9], "prerequisit": 8, "creat": 8, "an": 8, "new": 8, "block": 8, "event": 8, "log": 8, "startup": 8, "shutdown": 8, "worker": 8, "state": 8, "your": 8, "distribut": 8, "execut": 8, "test": 8, "deploi": 8, "platform": 8, "quick": 9, "start": 9, "document": 9, "depend": 9, "instal": 9, "via": 9, "pip": 9, "setuptool": 9, "usag": 9, "docker": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"run": [[0, "run"], [0, "run"]], "Silverback Docs": [[1, "silverback-docs"]], "User Guides": [[1, null]], "CLI Reference": [[1, null]], "Python Reference": [[1, null]], "silverback.application": [[2, "silverback-application"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverback.middlewares": [[4, "silverback-middlewares"]], "silverback.runner": [[5, "silverback-runner"]], "silverback.subscriptions": [[6, "silverback-subscriptions"]], "silverback.utils": [[7, "module-silverback.utils"]], "Developing a Silverback Application": [[8, "developing-a-silverback-application"]], "Prerequisites": [[8, "prerequisites"]], "Creating an Application": [[8, "creating-an-application"]], "New Block Events": [[8, "new-block-events"]], "New Event Logs": [[8, "new-event-logs"]], "Startup and Shutdown": [[8, "startup-and-shutdown"]], "Worker Events": [[8, "worker-events"]], "Worker State": [[8, "worker-state"]], "Application Events": [[8, "application-events"]], "Running your Application": [[8, "running-your-application"]], "Distributed Execution": [[8, "distributed-execution"]], "Testing your Application": [[8, "testing-your-application"]], "Deploying to the Silverback Platform": [[8, "deploying-to-the-silverback-platform"]], "Quick Start": [[9, "quick-start"]], "Documentation": [[9, "documentation"]], "Dependencies": [[9, "dependencies"]], "Installation": [[9, "installation"]], "via pip": [[9, "via-pip"]], "via setuptools": [[9, "via-setuptools"]], "Quick Usage": [[9, "quick-usage"]], "Docker Usage": [[9, "docker-usage"]], "Development": [[9, "development"]]}, "indexentries": {"--account": [[0, "cmdoption-run-account"]], "--max-exceptions": [[0, "cmdoption-run-x"]], "--network": [[0, "cmdoption-run-network"]], "--runner": [[0, "cmdoption-run-runner"]], "--verbosity": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-v": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-x": [[0, "cmdoption-run-x"]], "path": [[0, "cmdoption-run-arg-PATH"]], "run command line option": [[0, "cmdoption-run-0"], [0, "cmdoption-run-account"], [0, "cmdoption-run-arg-PATH"], [0, "cmdoption-run-network"], [0, "cmdoption-run-runner"], [0, "cmdoption-run-v"], [0, "cmdoption-run-x"]], "silverbackapp (class in silverback.application)": [[2, "silverback.application.SilverbackApp"]], "get_block_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_block_handler"]], "get_event_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_event_handler"]], "get_shutdown_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_shutdown_handler"]], "get_startup_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_startup_handler"]], "module": [[2, "module-silverback.application"], [3, "module-silverback.exceptions"], [4, "module-silverback.middlewares"], [5, "module-silverback.runner"], [6, "module-silverback.subscriptions"], [7, "module-silverback.utils"]], "on_() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_"]], "on_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_shutdown"]], "on_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_startup"]], "on_worker_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_shutdown"]], "on_worker_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_startup"]], "silverback.application": [[2, "module-silverback.application"]], "circuitbreaker": [[3, "silverback.exceptions.CircuitBreaker"]], "duplicatehandlererror": [[3, "silverback.exceptions.DuplicateHandlerError"]], "halt": [[3, "silverback.exceptions.Halt"]], "importfromstringerror": [[3, "silverback.exceptions.ImportFromStringError"]], "invalidcontainertypeerror": [[3, "silverback.exceptions.InvalidContainerTypeError"]], "nowebsocketavailableerror": [[3, "silverback.exceptions.NoWebsocketAvailableError"]], "silverbackexception": [[3, "silverback.exceptions.SilverbackException"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverbackmiddleware (class in silverback.middlewares)": [[4, "silverback.middlewares.SilverbackMiddleware"]], "on_error() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.on_error"]], "post_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_execute"]], "post_save() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_save"]], "pre_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_execute"]], "pre_send() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_send"]], "silverback.middlewares": [[4, "module-silverback.middlewares"]], "baserunner (class in silverback.runner)": [[5, "silverback.runner.BaseRunner"]], "pollingrunner (class in silverback.runner)": [[5, "silverback.runner.PollingRunner"]], "websocketrunner (class in silverback.runner)": [[5, "silverback.runner.WebsocketRunner"]], "run() (silverback.runner.baserunner method)": [[5, "silverback.runner.BaseRunner.run"]], "run() (silverback.runner.websocketrunner method)": [[5, "silverback.runner.WebsocketRunner.run"]], "silverback.runner": [[5, "module-silverback.runner"]], "subscriptiontype (class in silverback.subscriptions)": [[6, "silverback.subscriptions.SubscriptionType"]], "silverback.subscriptions": [[6, "module-silverback.subscriptions"]], "async_wrap_iter() (in module silverback.utils)": [[7, "silverback.utils.async_wrap_iter"]], "hexbytes_dict() (in module silverback.utils)": [[7, "silverback.utils.hexbytes_dict"]], "silverback.utils": [[7, "module-silverback.utils"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["commands/run", "index", "methoddocs/application", "methoddocs/exceptions", "methoddocs/middlewares", "methoddocs/runner", "methoddocs/subscriptions", "methoddocs/utils", "userguides/development", "userguides/quickstart"], "filenames": ["commands/run.rst", "index.md", "methoddocs/application.md", "methoddocs/exceptions.md", "methoddocs/middlewares.md", "methoddocs/runner.md", "methoddocs/subscriptions.md", "methoddocs/utils.md", "userguides/development.md", "userguides/quickstart.md"], "titles": ["run", "Silverback Docs", "silverback.application", "silverback.exceptions", "silverback.middlewares", "silverback.runner", "silverback.subscriptions", "silverback.utils", "Developing a Silverback Application", "Quick Start"], "terms": {"silverback": [0, 9], "applic": [0, 1, 3, 5, 9], "client": [0, 4, 5, 8], "option": [0, 2, 8], "path": 0, "v": 0, "verbos": 0, "lvl": 0, "One": 0, "error": [0, 2, 8], "warn": 0, "success": 0, "info": 0, "debug": 0, "network": [0, 5, 8, 9], "overrid": [0, 2], "default": [0, 2, 8], "provid": [0, 5], "see": [0, 9], "ap": [0, 8, 9], "list": 0, "mainnet": [0, 8, 9], "geth": 0, "ethereum": [0, 8], "goerli": 0, "sepolia": [0, 8], "local": [0, 8], "test": 0, "account": [0, 8], "runner": [0, 1, 8, 9], "an": [0, 2, 3, 6, 7, 9], "import": [0, 2, 8], "str": [0, 2, 3], "format": 0, "modul": [0, 2, 4, 5, 6], "customrunn": 0, "x": 0, "max": 0, "except": [0, 1, 4], "max_except": [0, 5], "argument": 0, "requir": [0, 8], "quick": 1, "start": [1, 2, 8], "develop": 1, "run": [1, 5, 9], "middlewar": 1, "subscript": 1, "util": 1, "The": [2, 4, 5, 6, 8, 9], "contain": [2, 3, 4, 5, 6], "high": [2, 8], "level": 2, "implement": [2, 5, 6], "user": [2, 3], "": [2, 4, 8, 9], "meant": 2, "us": [2, 5, 6, 8, 9], "expos": 2, "method": [2, 5, 6, 8], "handler": [2, 8], "other": [2, 8], "function": [2, 4, 8], "class": [2, 4, 5, 6, 8], "silverbackapp": [2, 5, 8], "set": [2, 8], "none": [2, 8], "base": [2, 3, 4, 5, 6], "manageraccessmixin": [2, 4, 5], "singleton": 2, "must": [2, 8], "initi": [2, 8], "prior": 2, "usag": 2, "exampl": [2, 8, 9], "from": [2, 8], "app": [2, 5, 8, 9], "connect": [2, 5, 6, 8], "ha": [2, 8], "been": [2, 8], "can": [2, 8, 9], "call": [2, 4], "broker": [2, 4, 5, 8], "e": 2, "g": 2, "on_": [2, 8], "get_block_handl": 2, "asynctaskiqdecoratedtask": 2, "get": [2, 8], "access": [2, 8], "block": [2, 7, 9], "event": [2, 5, 9], "return": [2, 4, 8], "decor": [2, 8], "task": [2, 4, 5, 8], "one": [2, 7, 8], "creat": [2, 3, 9], "type": [2, 8, 9], "get_event_handl": 2, "event_target": 2, "checksumaddress": 2, "event_nam": 2, "paramet": [2, 4, 8], "addresstyp": 2, "contract": [2, 8, 9], "address": [2, 8], "target": 2, "name": [2, 8], "emit": [2, 8], "get_shutdown_handl": 2, "silverback_shutdown": 2, "get_startup_handl": 2, "silverback_startup": 2, "blockcontain": 2, "contractev": 2, "new_block_timeout": 2, "int": [2, 5], "start_block": [2, 8], "handl": [2, 8], "union": 2, "sourc": 2, "watch": 2, "timeout": 2, "i": [2, 4, 8, 9], "accept": 2, "whatev": 2, "ar": [2, 5, 8, 9], "poll": 2, "number": 2, "process": [2, 4, 5, 8], "latest": [2, 9], "rais": [2, 5, 8], "invalidcontainertypeerror": [2, 3], "If": [2, 5, 8], "configur": [2, 5, 8], "on_shutdown": [2, 8], "callabl": 2, "code": 2, "execut": [2, 4, 5], "worker": [2, 4], "shutdown": [2, 3], "def": [2, 8], "do_something_on_shutdown": 2, "record": [2, 8], "final": [2, 8, 9], "state": [2, 9], "on_startup": [2, 8], "upon": [2, 8], "startup": 2, "restart": 2, "after": [2, 4], "do_something_on_startup": 2, "startup_st": [2, 8], "reprocess": 2, "miss": [2, 8], "on_worker_shutdown": [2, 8], "everi": [2, 8], "updat": [2, 8, 9], "some": [2, 8, 9], "extern": 2, "servic": 2, "perhap": 2, "inform": 2, "on_worker_startup": [2, 8], "provis": [2, 8], "resourc": [2, 8], "add": [2, 4, 8], "thing": [2, 8, 9], "circuitbreak": 3, "messag": [3, 4, 8], "silverbackexcept": 3, "custom": 3, "trigger": [3, 5, 8], "duplicatehandlererror": 3, "handler_typ": 3, "halt": [3, 5], "importfromstringerror": 3, "ani": [3, 7, 8], "nowebsocketavailableerror": 3, "apeexcept": 3, "runtim": 3, "fault": 3, "intend": 4, "improv": 4, "usabl": 4, "whole": 4, "integr": 4, "platform": 4, "well": [4, 8, 9], "silverbackmiddlewar": 4, "arg": [4, 5], "kwarg": [4, 5], "taskiqmiddlewar": 4, "async": [4, 5], "on_error": 4, "taskiqmessag": 4, "result": [4, 8], "taskiqresult": 4, "baseexcept": 4, "thi": [4, 8, 9], "when": 4, "found": 4, "incom": 4, "valu": [4, 6, 7], "post_execut": 4, "hook": [4, 8], "complet": [4, 8], "side": 4, "It": [4, 8], "current": 4, "post_sav": 4, "post": 4, "save": 4, "result_backend": 4, "pre_execut": 4, "befor": [4, 8], "which": [4, 8], "mean": 4, "pars": 4, "taskiq": [4, 8], "modifi": 4, "pre_send": 4, "send": 4, "right": 4, "sent": 4, "varieti": 5, "differ": 5, "scenario": 5, "baserunn": 5, "3": [5, 9], "abc": 5, "assembl": 5, "Will": 5, "listen": [5, 9], "against": [5, 9], "context": [5, 8], "them": 5, "kick": 5, "over": 5, "pollingrunn": 5, "singl": 5, "live": [5, 9], "basic": 5, "memori": [5, 8], "queue": [5, 6, 8], "websocketrunn": [5, 8], "websocket": [5, 6], "rpc": 6, "node": 6, "via": [6, 8], "eth_subscrib": 6, "subscriptiontyp": 6, "enum": 6, "enumer": 6, "async_wrap_it": 7, "iter": 7, "asynciter": 7, "wrap": 7, "asynchron": [7, 8], "hexbytes_dict": 7, "data": [7, 8, 9], "dict": 7, "convert": 7, "hex": 7, "string": 7, "flat": 7, "dictionari": 7, "hexbyt": 7, "In": 8, "guid": 8, "we": 8, "go": 8, "show": 8, "you": [8, 9], "more": [8, 9], "detail": 8, "how": [8, 9], "build": 8, "should": [8, 9], "have": 8, "python": [8, 9], "project": [8, 9], "instal": 8, "pip": 8, "easi": 8, "do": 8, "so": [8, 9], "through": 8, "up": [8, 9], "each": 8, "time": 8, "encount": 8, "specif": 8, "make": 8, "bot": [8, 9], "order": 8, "perform": 8, "autom": [8, 9], "necessari": 8, "chain": [8, 9], "interact": 8, "howev": 8, "won": 8, "t": 8, "veri": 8, "where": 8, "ad": 8, "let": [8, 9], "u": 8, "specifi": 8, "our": 8, "To": [8, 9], "follow": 8, "handle_new_block": 8, "insid": 8, "defin": 8, "logic": 8, "want": 8, "detect": 8, "serializ": 8, "structur": 8, "store": 8, "databas": 8, "trackabl": 8, "metric": 8, "dure": 8, "captur": 8, "failur": 8, "similarli": 8, "token": 8, "here": 8, "transfer": 8, "handle_token_transfer_ev": 8, "again": 8, "heavier": 8, "load": 8, "like": 8, "handle_on_worker_startup": 8, "db": 8, "etc": 8, "handle_on_worker_shutdown": 8, "cleanup": 8, "close": 8, "cleanli": 8, "come": 8, "comput": 8, "note": 8, "ensur": 8, "multipl": 8, "properli": 8, "telegram": [8, 9], "api": 8, "sql": 8, "nosql": 8, "someth": 8, "els": 8, "0": 8, "2": 8, "These": 8, "move": 8, "clariti": 8, "variabl": 8, "also": 8, "made": 8, "avail": 8, "quantiti": 8, "maintain": 8, "its": 8, "own": [8, 9], "instanc": 8, "annot": 8, "depend": 8, "taskiqdepend": 8, "block_handl": 8, "onc": 8, "mai": [8, 9], "histor": 8, "sinc": 8, "wa": 8, "action": 8, "handle_on_startup": 8, "process_histori": 8, "last_block_seen": 8, "last_block_process": 8, "handle_on_shutdown": 8, "chang": [8, 9], "behavior": 8, "signatur": 8, "now": 8, "onli": 8, "program": 8, "realli": 8, "abl": 8, "valid": 8, "doe": 8, "what": 8, "expect": 8, "includ": [8, 9], "cli": 8, "command": 8, "take": 8, "care": 8, "proper": 8, "signer": 8, "testnet": 8, "my_bot": 8, "acct": 8, "enabl": [8, 9], "mode": 8, "might": [8, 9], "lead": 8, "transact": 8, "sender": 8, "would": 8, "done": 8, "had": 8, "sign": 8, "anyth": 8, "given": 8, "rememb": 8, "lose": 8, "substat": 8, "amount": 8, "fund": 8, "product": 8, "alwai": 8, "throughli": 8, "defualt": 8, "everyth": 8, "job": 8, "share": 8, "volum": [8, 9], "environ": 8, "higher": 8, "rate": 8, "primari": 8, "compon": 8, "manner": 8, "For": 8, "work": 8, "capabl": 8, "taskiq_redi": 8, "could": 8, "export": 8, "silverback_broker_class": 8, "listqueuebrok": 8, "silverback_broker_uri": 8, "redi": 8, "127": 8, "1": 8, "6379": 8, "alchemi": [8, 9], "And": 8, "subprocess": 8, "w": 8, "all": 8, "todo": 8, "backtest": 8, "packag": [8, 9], "deploy": 8, "deploi": 9, "your": 9, "respond": 9, "librari": 9, "leverag": 9, "framework": 9, "ecosystem": 9, "plugin": 9, "simpl": 9, "yet": 9, "sophist": 9, "excel": 9, "case": 9, "involv": 9, "continu": 9, "monitor": 9, "newli": 9, "confirm": 9, "log": 9, "new": 9, "pool": 9, "creation": 9, "deposit": 9, "liquid": 9, "measur": 9, "trade": 9, "activ": 9, "popular": 9, "larg": 9, "swap": 9, "group": 9, "read": 9, "userguid": 9, "learn": 9, "python3": 9, "version": 9, "8": 9, "greater": 9, "dev": 9, "reli": 9, "heavili": 9, "worth": 9, "familar": 9, "yourself": 9, "releas": 9, "clone": 9, "repositori": 9, "most": 9, "date": 9, "git": 9, "http": 9, "github": 9, "com": 9, "apeworx": 9, "cd": 9, "setup": 9, "py": 9, "checkout": 9, "sdk": 9, "pwd": 9, "home": 9, "haramb": 9, "tokenlist": 9, "consid": 9, "beta": 9, "break": 9, "occur": 9, "comment": 9, "question": 9, "critic": 9, "pull": 9, "request": 9, "welcom": 9}, "objects": {"silverback": [[2, 0, 0, "-", "application"], [3, 0, 0, "-", "exceptions"], [4, 0, 0, "-", "middlewares"], [5, 0, 0, "-", "runner"], [6, 0, 0, "-", "subscriptions"], [7, 0, 0, "-", "utils"]], "silverback.application": [[2, 1, 1, "", "SilverbackApp"]], "silverback.application.SilverbackApp": [[2, 2, 1, "", "get_block_handler"], [2, 2, 1, "", "get_event_handler"], [2, 2, 1, "", "get_shutdown_handler"], [2, 2, 1, "", "get_startup_handler"], [2, 2, 1, "", "on_"], [2, 2, 1, "", "on_shutdown"], [2, 2, 1, "", "on_startup"], [2, 2, 1, "", "on_worker_shutdown"], [2, 2, 1, "", "on_worker_startup"]], "silverback.exceptions": [[3, 3, 1, "", "CircuitBreaker"], [3, 3, 1, "", "DuplicateHandlerError"], [3, 3, 1, "", "Halt"], [3, 3, 1, "", "ImportFromStringError"], [3, 3, 1, "", "InvalidContainerTypeError"], [3, 3, 1, "", "NoWebsocketAvailableError"], [3, 3, 1, "", "SilverbackException"]], "silverback.middlewares": [[4, 1, 1, "", "SilverbackMiddleware"]], "silverback.middlewares.SilverbackMiddleware": [[4, 2, 1, "", "on_error"], [4, 2, 1, "", "post_execute"], [4, 2, 1, "", "post_save"], [4, 2, 1, "", "pre_execute"], [4, 2, 1, "", "pre_send"]], "silverback.runner": [[5, 1, 1, "", "BaseRunner"], [5, 1, 1, "", "PollingRunner"], [5, 1, 1, "", "WebsocketRunner"]], "silverback.runner.BaseRunner": [[5, 2, 1, "", "run"]], "silverback.runner.WebsocketRunner": [[5, 2, 1, "", "run"]], "silverback.subscriptions": [[6, 1, 1, "", "SubscriptionType"]], "silverback.utils": [[7, 4, 1, "", "async_wrap_iter"], [7, 4, 1, "", "hexbytes_dict"]], "run": [[0, 5, 1, "cmdoption-run-account", "--account"], [0, 5, 1, "cmdoption-run-x", "--max-exceptions"], [0, 5, 1, "cmdoption-run-network", "--network"], [0, 5, 1, "cmdoption-run-runner", "--runner"], [0, 5, 1, "cmdoption-run-v", "--verbosity"], [0, 5, 1, "cmdoption-run-v", "-v"], [0, 5, 1, "cmdoption-run-x", "-x"], [0, 5, 1, "cmdoption-run-arg-PATH", "PATH"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["std", "cmdoption", "program option"]}, "titleterms": {"run": [0, 8], "silverback": [1, 2, 3, 4, 5, 6, 7, 8], "doc": 1, "user": 1, "guid": 1, "cli": 1, "refer": 1, "python": 1, "applic": [2, 8], "except": 3, "middlewar": 4, "runner": 5, "subscript": 6, "util": 7, "develop": [8, 9], "prerequisit": 8, "creat": 8, "an": 8, "new": 8, "block": 8, "event": 8, "log": 8, "startup": 8, "shutdown": 8, "worker": 8, "state": 8, "your": 8, "distribut": 8, "execut": 8, "test": 8, "deploi": 8, "platform": 8, "quick": 9, "start": 9, "document": 9, "depend": 9, "instal": 9, "via": 9, "pip": 9, "setuptool": 9, "usag": 9, "docker": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"run": [[0, "run"], [0, "run"]], "Silverback Docs": [[1, "silverback-docs"]], "User Guides": [[1, null]], "CLI Reference": [[1, null]], "Python Reference": [[1, null]], "silverback.application": [[2, "silverback-application"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverback.middlewares": [[4, "silverback-middlewares"]], "silverback.runner": [[5, "silverback-runner"]], "silverback.subscriptions": [[6, "silverback-subscriptions"]], "silverback.utils": [[7, "module-silverback.utils"]], "Developing a Silverback Application": [[8, "developing-a-silverback-application"]], "Prerequisites": [[8, "prerequisites"]], "Creating an Application": [[8, "creating-an-application"]], "New Block Events": [[8, "new-block-events"]], "New Event Logs": [[8, "new-event-logs"]], "Startup and Shutdown": [[8, "startup-and-shutdown"]], "Worker Events": [[8, "worker-events"]], "Worker State": [[8, "worker-state"]], "Application Events": [[8, "application-events"]], "Running your Application": [[8, "running-your-application"]], "Distributed Execution": [[8, "distributed-execution"]], "Testing your Application": [[8, "testing-your-application"]], "Deploying to the Silverback Platform": [[8, "deploying-to-the-silverback-platform"]], "Quick Start": [[9, "quick-start"]], "Documentation": [[9, "documentation"]], "Dependencies": [[9, "dependencies"]], "Installation": [[9, "installation"]], "via pip": [[9, "via-pip"]], "via setuptools": [[9, "via-setuptools"]], "Quick Usage": [[9, "quick-usage"]], "Docker Usage": [[9, "docker-usage"]], "Development": [[9, "development"]]}, "indexentries": {"--account": [[0, "cmdoption-run-account"]], "--max-exceptions": [[0, "cmdoption-run-x"]], "--network": [[0, "cmdoption-run-network"]], "--runner": [[0, "cmdoption-run-runner"]], "--verbosity": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-v": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-x": [[0, "cmdoption-run-x"]], "path": [[0, "cmdoption-run-arg-PATH"]], "run command line option": [[0, "cmdoption-run-0"], [0, "cmdoption-run-account"], [0, "cmdoption-run-arg-PATH"], [0, "cmdoption-run-network"], [0, "cmdoption-run-runner"], [0, "cmdoption-run-v"], [0, "cmdoption-run-x"]], "silverbackapp (class in silverback.application)": [[2, "silverback.application.SilverbackApp"]], "get_block_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_block_handler"]], "get_event_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_event_handler"]], "get_shutdown_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_shutdown_handler"]], "get_startup_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_startup_handler"]], "module": [[2, "module-silverback.application"], [3, "module-silverback.exceptions"], [4, "module-silverback.middlewares"], [5, "module-silverback.runner"], [6, "module-silverback.subscriptions"], [7, "module-silverback.utils"]], "on_() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_"]], "on_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_shutdown"]], "on_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_startup"]], "on_worker_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_shutdown"]], "on_worker_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_startup"]], "silverback.application": [[2, "module-silverback.application"]], "circuitbreaker": [[3, "silverback.exceptions.CircuitBreaker"]], "duplicatehandlererror": [[3, "silverback.exceptions.DuplicateHandlerError"]], "halt": [[3, "silverback.exceptions.Halt"]], "importfromstringerror": [[3, "silverback.exceptions.ImportFromStringError"]], "invalidcontainertypeerror": [[3, "silverback.exceptions.InvalidContainerTypeError"]], "nowebsocketavailableerror": [[3, "silverback.exceptions.NoWebsocketAvailableError"]], "silverbackexception": [[3, "silverback.exceptions.SilverbackException"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverbackmiddleware (class in silverback.middlewares)": [[4, "silverback.middlewares.SilverbackMiddleware"]], "on_error() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.on_error"]], "post_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_execute"]], "post_save() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_save"]], "pre_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_execute"]], "pre_send() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_send"]], "silverback.middlewares": [[4, "module-silverback.middlewares"]], "baserunner (class in silverback.runner)": [[5, "silverback.runner.BaseRunner"]], "pollingrunner (class in silverback.runner)": [[5, "silverback.runner.PollingRunner"]], "websocketrunner (class in silverback.runner)": [[5, "silverback.runner.WebsocketRunner"]], "run() (silverback.runner.baserunner method)": [[5, "silverback.runner.BaseRunner.run"]], "run() (silverback.runner.websocketrunner method)": [[5, "silverback.runner.WebsocketRunner.run"]], "silverback.runner": [[5, "module-silverback.runner"]], "subscriptiontype (class in silverback.subscriptions)": [[6, "silverback.subscriptions.SubscriptionType"]], "silverback.subscriptions": [[6, "module-silverback.subscriptions"]], "async_wrap_iter() (in module silverback.utils)": [[7, "silverback.utils.async_wrap_iter"]], "hexbytes_dict() (in module silverback.utils)": [[7, "silverback.utils.hexbytes_dict"]], "silverback.utils": [[7, "module-silverback.utils"]]}}) \ No newline at end of file diff --git a/latest/userguides/development.html b/latest/userguides/development.html index 184dad73..8cfcea74 100644 --- a/latest/userguides/development.html +++ b/latest/userguides/development.html @@ -50,6 +50,7 @@ + diff --git a/latest/userguides/quickstart.html b/latest/userguides/quickstart.html index fd041ffe..84135302 100644 --- a/latest/userguides/quickstart.html +++ b/latest/userguides/quickstart.html @@ -50,6 +50,7 @@ +