blockworks-foundation
/
pyth-crosschain
mirror of https://github.com/blockworks-foundation/pyth-crosschain.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
pyth-crosschain/express_relay/sdk/python
History
Anirudh Suresh e394f56468
fix: precommit fixes (#1377) 
* config pre-commit

* poetry auto install in pre commit

---------

Co-authored-by: ani <ani@Anirudhs-MBP.cable.rcn.com>
 		2024-03-21 11:42:31 -04:00
..
express_relay Express relay python searcher (#1319) 2024-03-15 15:08:48 -04:00
README.md Express relay python searcher (#1319) 2024-03-15 15:08:48 -04:00
mypy.ini Express relay python searcher (#1319) 2024-03-15 15:08:48 -04:00
poetry.lock fix: precommit fixes (#1377) 2024-03-21 11:42:31 -04:00
pyproject.toml Express relay python searcher (#1319) 2024-03-15 15:08:48 -04:00

README.md

Express Relay Python SDK

Utility library for searchers and protocols to interact with the Express Relay API.

The SDK includes searcher-side utilities and protocol-side utilities. The searcher-side utilities include a basic Searcher client for connecting to the Express Relay server as well as an example SimpleSearcher class that provides a simple workflow for assessing and bidding on liquidation opportunities.

Searcher

Installation

poetry

$ poetry add express-relay

Quickstart

To run the simple searcher script, navigate to python/ and run

$ python3 -m express_relay.searcher.examples.simple_searcher --private-key <PRIVATE_KEY_HEX_STRING> --chain-id development --verbose --server-url https://per-staging.dourolabs.app/

This simple example runs a searcher that queries the Express Relay liquidation server for available liquidation opportunities and naively submits a bid on each available opportunity.