Extend `MktPair` doc string to refer to binance pairs

basic_buy_bot
Tyler Goodlet 2023-06-12 14:04:09 -04:00
parent aa49c38d55
commit 8220bd152e
1 changed files with 27 additions and 0 deletions

View File

@ -207,6 +207,33 @@ class MktPair(Struct, frozen=True):
<dst>/<src>.<expiry>.<con_info_1>.<con_info_2>. -> .<venue>.<broker> <dst>/<src>.<expiry>.<con_info_1>.<con_info_2>. -> .<venue>.<broker>
^ -- optional tokens ------------------------------- ^ ^ -- optional tokens ------------------------------- ^
Notes:
------
Some venues provide a different semantic (which we frankly find
confusing and non-general) such as "base" and "quote" asset.
For example this is how `binance` defines the terms:
https://binance-docs.github.io/apidocs/websocket_api/en/#public-api-definitions
https://binance-docs.github.io/apidocs/futures/en/#public-endpoints-info
- *base* asset refers to the asset that is the *quantity* of a symbol.
- *quote* asset refers to the asset that is the *price* of a symbol.
In other words the "quote" asset is the asset that the market
is pricing "buys" *in*, and the *base* asset it the one that the market
allows you to "buy" an *amount of*. Put more simply the *quote*
asset is our "source" asset and the *base* asset is our "destination"
asset.
This defintion can be further understood reading our
`.brokers.binance.api.Pair` type wherein the
`Pair.[quote/base]AssetPrecision` field determines the (transfer)
transaction precision available per asset; i.e. the satoshis
unit in bitcoin for representing the minimum size of a
transaction that can take place on the blockchain.
''' '''
dst: str | Asset dst: str | Asset
# "destination asset" (name) used to buy *to* # "destination asset" (name) used to buy *to*