Skip to main content

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.

Installation

poetry

$ poetry add express-relay

Development

You can use anchorpy to generate a Python client of the Express Relay program.

anchorpy only works with the old Anchor IDL standard. You will need to use anchor 0.29.0: make sure you modify anchor_version in Anchor.toml to 0.29.0 and run anchor idl parse --file to generate the IDL.

You can generate the Python client from the IDL via:

poetry run anchorpy client-gen express_relay/idl/idlExpressRelay.json express_relay/svm/generated/express_relay --program-id PytERJFhAKuNNuaiXkApLfWzwNwSNDACpigT3LwQfou

Quickstart

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

Evm

$ poetry run python3 -m express_relay.searcher.examples.simple_searcher_evm \
--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.

Svm

$ poetry run python3 -m express_relay.searcher.examples.simple_searcher_svm \
--endpoint-express-relay https://per-staging.dourolabs.app/ \
--chain-id development-solana \
--private-key-json-file <PATH_TO_JSON_FILE> \
--endpoint-svm https://api.mainnet-beta.solana.com \
--bid 10000000 # Bid amount in lamports

Release files for express-relay 0.28.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for express-relay 0.28.0
File Size Uploaded
express_relay-0.28.0.tar.gz 40.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for express-relay 0.28.0
File Interpreter ABI Platform
express_relay-0.28.0-py3-none-any.whl Python 3 none any Details

Total release size: 114.6 kB

Release files / express_relay-0.28.0.tar.gz

Download URL express_relay-0.28.0.tar.gz
Size 40.5 kB
Tags Source
SHA-256 checksum
How to use checksums
23e96a5eafba959d158a3710263d010b8a36cda7e28ab6b2172652864627627f
BLAKE2b-256 checksum
How to use checksums
f76349fb79b3223f2f32bb532949fdd814be2e1bb234ec0180636bad207ca363
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.11.12 Linux/6.8.0-1027-azure

Release files / express_relay-0.28.0-py3-none-any.whl

Download URL express_relay-0.28.0-py3-none-any.whl
Size 74.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8added87b4e696d65d380c2736563723b133e2bc7118f0cb21859258532ec640
BLAKE2b-256 checksum
How to use checksums
b31ad0f4c6d40cf441b0925f5225cbda07e7dff7fee304d0ba70c0f733d44947
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.11.12 Linux/6.8.0-1027-azure
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page