Go to file
silas 7e22864f54
Including Bandit
2022-01-09 17:57:35 +00:00
.github/workflows Including Bandit 2022-01-09 17:57:35 +00:00
.vscode Fixed some settings for venv. 2021-10-13 18:42:02 +01:00
bin Renamed version command mango-explorer-version to avoid naming conflict. 2022-01-06 18:00:50 +00:00
data Fixed incorrect market index for MATIC-PERP on devnet.2. 2022-01-08 17:38:48 +00:00
docs Added --hedging-action-threshold documentation. 2021-12-24 11:29:45 +00:00
mango Found an account where our calculations didn't match reality, so fixed bug and added it to testdata. 2022-01-08 17:34:32 +00:00
scripts Fixed problem parsing price information in random taker script. 2021-12-27 15:50:01 +00:00
tests Found an account where our calculations didn't match reality, so fixed bug and added it to testdata. 2022-01-08 17:34:32 +00:00
.dockerignore Updated git+docker ignore files. 2021-11-18 18:37:13 +00:00
.envrc Added MaximumQuantityElement and MinimumQuantityElement. 2021-11-18 12:51:57 +00:00
.flake8 Preliminary use of DataFrame calculations on Accounts. 2022-01-06 16:34:18 +00:00
.gitignore Added .venv to ignored list. 2021-11-18 18:52:35 +00:00
.mypy.ini Added some experimental JSON output for feedback. 2021-11-19 17:36:25 +00:00
Dockerfile Added faster calculation for transaction size - running it and original method together for now for comparison. 2021-11-17 17:27:42 +00:00
LICENSE Initial import. 2021-04-14 16:51:39 +01:00
Makefile Refactor of code to work with mypy --strict 2021-11-09 13:23:36 +00:00
README.md Merge pull request #22 from AaronCritchley/patch-1 2021-12-30 16:07:55 +00:00
poetry.lock Updated dependencies. 2021-12-13 17:31:35 +00:00
pyproject.toml v3.2.15 2022-01-08 17:40:24 +00:00

README.md

🥭 Mango Explorer

⚠ Warning

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Introduction

mango-explorer provides Python code to interface with Mango Markets, along with a functional marketmaker.

Installation

PyPI

mango-explorer is available as a Python package on Pypi and can be installed as:

pip install mango-explorer

(Other ways of installing it or adding it as a dependency are available and will depend on the particular tools you are using.)

mango-explorer is also available as a docker container with the name opinionatedgeek/mango-explorer-v3.

Branches

The latest version of the code is in the main branch on Github.

Code to integrate with Version 2 of Mango is in the v2 branch.

Example

Here's a brief but complete example of how to place and cancel an order. This example is runnable in your browser!

import decimal
import mango
import os
import time

# Load the wallet from the environment variable 'KEYPAIR'. (Other mechanisms are available.)
wallet = mango.Wallet(os.environ.get("KEYPAIR"))

# Create a 'devnet' Context
context = mango.ContextBuilder.build(cluster_name="devnet")

# Load the wallet's account
group = mango.Group.load(context)
accounts = mango.Account.load_all_for_owner(context, wallet.address, group)
account = accounts[0]

# Load the market
stub = context.market_lookup.find_by_symbol("SOL-PERP")
market = mango.ensure_market_loaded(context, stub)

market_operations = mango.create_market_operations(context, wallet, account, market, dry_run=False)

print("Initial order book:\n\t", market_operations.load_orderbook())
print("Your current orders:\n\t", market_operations.load_my_orders())

# Go on - try to buy 1 SOL-PERP contract for $10.
order = mango.Order.from_basic_info(side=mango.Side.BUY,
                                    price=decimal.Decimal(10),
                                    quantity=decimal.Decimal(1),
                                    order_type=mango.OrderType.POST_ONLY)
placed_order = market_operations.place_order(order)
print("\n\nPlaced order:\n\t", placed_order)

print("\n\nSleeping for 10 seconds...")
time.sleep(10)

print("\n\nOrder book (including our new order):\n", market_operations.load_orderbook())
print("Your current orders:\n\t", market_operations.load_my_orders())

cancellation_signatures = market_operations.cancel_order(placed_order)
print("\n\nCancellation signature:\n\t", cancellation_signatures)

print("\n\nSleeping for 10 seconds...")
time.sleep(10)

print("\n\nOrder book (without our order):\n", market_operations.load_orderbook())
print("Your current orders:\n\t", market_operations.load_my_orders())

Many more examples are provided in a separate Github repo and can be run in your browser (no installation required!) at Binder.

Running the marketmaker

There is a Marketmaking Quickstart - a walkthrough of setting up and running the marketmaker on devnet, from setting up the account, depositing tokens, to running the marketmaker itself.

It can take around 30 minutes to run through.

Requirements:

  • A server with docker installed

Note This walkthrough is devnet-only so no actual funds are used or at-risk.

References

Support

🥭 Mango Markets support is available at: Docs | Discord | Twitter | Github | Email