Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

canary documentation #881

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

canary documentation #881

wants to merge 1 commit into from

Conversation

rouzwelt
Copy link
Contributor

@rouzwelt rouzwelt commented Sep 23, 2024

Motivation

resolves rainlanguage/arb-bot#199

Solution

Checks

By submitting this for review, I'm confirming I've done the following:

  • made this PR as small as possible
  • unit-tested any new functionality
  • linked any relevant issues or PRs

@rouzwelt rouzwelt added the documentation Improvements or additions to documentation label Sep 23, 2024
@rouzwelt rouzwelt self-assigned this Sep 23, 2024
@@ -0,0 +1,13 @@
# Canary strat
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't really understand why this doc is here, in the root of the ob repo

or who it is for?

@rouzwelt originally i asked you to setup a canary, which is already documented in the strat in pubstrats in basically paraphrasing exactly what is here


# The canary order does nothing except run on a cooldown.
#
# It is useful only to show that orders clear on some network. If the canary is
# deployed and does not run, it means that there are no solvers monitoring the
# network, or at least not the raindex contract that the canary is deployed on.
#
# The canary is basically a stripped back version of the sampler. It runs but
# doesn't sample anything.

i'd expect to see docs that explain what was missing in your understanding when i asked you about it @rouzwelt and probably somewhere related to the infra they are for

@dcatki
Copy link
Contributor

dcatki commented Oct 27, 2024

@rouzwelt whats the status of this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document and apply process of using canary strats to test bot operation
3 participants