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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

canary documentation #881

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CANARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

- what is a canary order, what it does and what is its purpose?
canary is a simple order that sets a non-zero amount with a 0 io ratio, this means that the strat just gives money to the bot unconditionally, there's a timer on the ensure so it doesn't insta-drain itself, this can be used to check that the bot clears, e.g. after making changes or bringing up a new bot etc. to make sure that the infra is working correctly.

- where to find the strat?
https://github.com/rainlanguage/rain.dex.pubstrats/blob/main/src/infra/canary.rain

- additional info
canary orders are like any other orders, but they clear once every `cooldown` period, so if they happen to not clear for any reason the bot's exec kpi alert will go off, notifying that infra is possibly not working correctly, besides these there is nothing special about canaries.
now that bot has self fudning owned vaults option, one can specify the canary vault in the bot's env vars and bot will redeposit into the specified vault once the it goes below the specified threshold, this is not specific to canaries, but any vault can be set to be refunded. for more info about this, check bot's [README](https://github.com/rainlanguage/arb-bot/blob/master/README.md), but can simply set self fund vaults by follwoing example:
```sh
SELF_FUND_ORDERS=token1,vaultId1,threshold,toptupamount;token2,vaultId2,threshold,toptupamount;...
```
Loading