From 2873c032024411fc8a2ff28f0ffae4a5d3e04877 Mon Sep 17 00:00:00 2001 From: Dalena Date: Thu, 10 Oct 2024 11:19:00 -0500 Subject: [PATCH] fix: bot python reference --- docs/methoddocs/application.md | 10 ---------- docs/methoddocs/main.md | 10 ++++++++++ docs/userguides/development.md | 2 +- docs/userguides/platform.md | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) delete mode 100644 docs/methoddocs/application.md create mode 100644 docs/methoddocs/main.md diff --git a/docs/methoddocs/application.md b/docs/methoddocs/application.md deleted file mode 100644 index 7d7d70e5..00000000 --- a/docs/methoddocs/application.md +++ /dev/null @@ -1,10 +0,0 @@ -# silverback.application - -The `silverback.application` module contains the high-level implementation of the the user's -Silverback application, meant to be used to expose method handlers and other functionality. - -```{eval-rst} -.. automodule:: silverback.application - :members: - :show-inheritance: -``` diff --git a/docs/methoddocs/main.md b/docs/methoddocs/main.md new file mode 100644 index 00000000..d140c9a9 --- /dev/null +++ b/docs/methoddocs/main.md @@ -0,0 +1,10 @@ +# 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. + +```{eval-rst} +.. automodule:: silverback.main + :members: + :show-inheritance: +``` diff --git a/docs/userguides/development.md b/docs/userguides/development.md index 9e33c6d5..91f24759 100644 --- a/docs/userguides/development.md +++ b/docs/userguides/development.md @@ -79,7 +79,7 @@ from silverback import SilverbackBot bot = SilverbackBot() ``` -The SilverbackBot class handles state and configuration. +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. diff --git a/docs/userguides/platform.md b/docs/userguides/platform.md index d538739b..844a4686 100644 --- a/docs/userguides/platform.md +++ b/docs/userguides/platform.md @@ -152,7 +152,7 @@ Then you can provide the name of these credentials when creating your bot with t 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`][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/ `app.signer`), +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. @@ -197,7 +197,7 @@ Once in the RUNNING state, your Bot will not stop running unless it experiences 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 `app.state` are maintained up until the point an error occurs. +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.