Ape SDK for the Silverback platform
Project description
Quick Start
Silverback lets you create and deploy your own Python bots that respond to on-chain events. The Silverback library leverages the Ape development framework as well as it's ecosystem of plugins and packages to enable you to develop simple-yet-sophisticated automated applications that can listen and respond to live chain data.
Silverback applications are excellent for use cases that involve continuously monitoring and responding to on-chain events, such as newly confirmed blocks or contract event logs.
Some examples of these types of applications:
- Monitoring new pool creations, and depositing liquidity
- Measuring trading activity of popular pools
- Listening for large swaps to update a telegram group
Documentation
Read the development userguide to learn more how to develop an application.
Dependencies
- python3 version 3.10 or greater, python3-dev
Installation
Silverback relies heavily on the Ape development framework, so it's worth it to familarize yourself with how to install Ape and it's plugins using the Ape installation userguide.
via pip
You can install the latest release via pip:
pip install silverback
via setuptools
You can clone the repository and use setuptools for the most up-to-date version:
git clone https://github.com/ApeWorX/silverback.git silverback
cd silverback
python3 setup.py install
Quick Usage
Checkout the example to see how to use the library.
To run your bot against a live network, this SDK includes a simple runner you can use via:
$ silverback run "example:app" --network :mainnet:alchemy
NOTE: The example is designed to work with Python 3.10+, and we suggest using 3.11+ for speed.
Docker Usage
$ docker run --volume $PWD:/home/harambe/project --volume ~/.tokenlists:/home/harambe/.tokenlists apeworx/silverback:latest run "example:app" --network :mainnet:alchemy
NOTE: The Docker image we publish uses Python 3.11
Development
This project is in development and should be considered a beta. Things might not be in their final state and breaking changes may occur. Comments, questions, criticisms and pull requests are welcomed.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file silverback-0.5.0.tar.gz.
File metadata
- Download URL: silverback-0.5.0.tar.gz
- Upload date:
- Size: 81.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 56207b4d7a7edebb776fb472b1c359befbb5fc7f98d49d23f7f9345e506cfb78 |
|
| MD5 | 6c61b95216abe2b2b12aa0d4e6d31497 |
|
| BLAKE2b-256 | fdfefe1bfa91d0eab178891d26beb48151fcd55c9362934ebd6e053d9766751b |
File details
Details for the file silverback-0.5.0-py3-none-any.whl.
File metadata
- Download URL: silverback-0.5.0-py3-none-any.whl
- Upload date:
- Size: 30.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 061128f1e22f57ffd60eab8015d02ac8f9d414327585fe5b6f026fd78860a02c |
|
| MD5 | 9871434b9147437fcb9be4e759096fa4 |
|
| BLAKE2b-256 | e1662fe0410734c498f3b99d323bd804ea243f03fc8cfa92abf04bc7aa84e852 |
