# Solana Trader Python Client
Provides a Python SDK for bloXroute's Solana Trader API.
## Installation
```
$ pip install bxsolana-trader
```
## Usage
This library supports HTTP, websockets, and GRPC interfaces. You can use it with
a context manager or handle open/closing yourself.
For any methods involving transaction creation you will need to provide your
Solana private key. You can provide this via the environment variable
`PRIVATE_KEY`, or specify it via the provider configuration if you want to load
it with some other mechanism. See samples for more information.
As a general note on this: methods named `post_*` (e.g. `post_order`) typically
do not sign/submit the transaction, only return the raw unsigned transaction.
This isn't very useful to most users (unless you want to write a signer in a
different language), and you'll typically want the similarly named `submit_*`
methods (e.g. `submit_order`). These methods generate, sign, and submit the
transaction all at once.
You will also need your bloXroute authorization header to use these endpoints. By default, this is loaded from the
`AUTH_HEADER` environment variable.
Context manager:
```python
from bxsolana import provider
async with provider.http() as api:
print(await api.get_orderbook(market="ETHUSDT"))
async with provider.ws() as api:
async for update in api.get_orderbooks_stream(market="ETHUSDT"):
print(update)
```
Manual:
```python
import bxsolana
from bxsolana import provider
p = provider.grpc()
api = await bxsolana.trader_api(p)
try:
await api.get_orderbook(market="ETHUSDT")
finally:
await p.close()
```
Refer to the `examples/` for more info.
## Development
bloXroute Solana Trader API's interfaces are primarily powered by protobuf, so you will
need to install it for your system: https://grpc.io/docs/protoc-installation/
In order to install local version of bxsolana_trader_proto dependency
you can build the solana-trader-proto/python directory using these commands
```
$ cd ~/solana-trader-proto/
upgrade the version in pyproject.toml
$ make proto-build-api-python
$ cd python
you can also push the package to pypi
$ rm -rf python/dist/
$ python3 -m build
$ python3 -m twine upload --repository pypi dist/*
and install the package locally now
$ pip install dist/bxsolana-trader-proto-0.0.42.tar.gz
now you can update the depdendency in solana-trader-client-python
update the version of bxsolana-trader-proto in setup.cfg
and run
$ pip install -r requirements.txt
```
Clone project and install dependencies:
```
$ git clone https://github.com/bloXroute-Labs/solana-trader-client-python.git
$ cd solana-trader-client-python
$ pip install -r requirements.txt
```
Run tests:
```
$ make test
Linting:
```
$ make lint
```
MIT License
Copyright (c) 2022 bloXroute Labs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/bloXroute-Labs/solana-trader-client-python",
"name": "bxsolana-trader",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "serum, solana, blockchain, trader, grpc, stream",
"author": "bloXroute Labs",
"author_email": "support@bloxroute.com",
"download_url": "https://files.pythonhosted.org/packages/ac/c3/959554006fe73872dd55c71b5ae751db3bdafbcf1016d04169c6f0d7aaa8/bxsolana_trader-2.1.1.tar.gz",
"platform": null,
"description": "# Solana Trader Python Client\n\nProvides a Python SDK for bloXroute's Solana Trader API.\n\n## Installation\n\n```\n$ pip install bxsolana-trader\n```\n\n## Usage\n\nThis library supports HTTP, websockets, and GRPC interfaces. You can use it with\na context manager or handle open/closing yourself.\n\nFor any methods involving transaction creation you will need to provide your \nSolana private key. You can provide this via the environment variable \n`PRIVATE_KEY`, or specify it via the provider configuration if you want to load \nit with some other mechanism. See samples for more information. \nAs a general note on this: methods named `post_*` (e.g. `post_order`) typically \ndo not sign/submit the transaction, only return the raw unsigned transaction. \nThis isn't very useful to most users (unless you want to write a signer in a \ndifferent language), and you'll typically want the similarly named `submit_*` \nmethods (e.g. `submit_order`). These methods generate, sign, and submit the\ntransaction all at once.\n\nYou will also need your bloXroute authorization header to use these endpoints. By default, this is loaded from the \n`AUTH_HEADER` environment variable.\n\nContext manager:\n\n```python\nfrom bxsolana import provider\n\nasync with provider.http() as api:\n print(await api.get_orderbook(market=\"ETHUSDT\"))\n \nasync with provider.ws() as api:\n async for update in api.get_orderbooks_stream(market=\"ETHUSDT\"):\n print(update)\n```\n\nManual:\n\n```python\nimport bxsolana\n\nfrom bxsolana import provider\n\np = provider.grpc()\napi = await bxsolana.trader_api(p)\n\ntry:\n await api.get_orderbook(market=\"ETHUSDT\")\nfinally:\n await p.close()\n```\n\nRefer to the `examples/` for more info.\n\n## Development\n\nbloXroute Solana Trader API's interfaces are primarily powered by protobuf, so you will \nneed to install it for your system: https://grpc.io/docs/protoc-installation/\n\nIn order to install local version of bxsolana_trader_proto dependency\n\nyou can build the solana-trader-proto/python directory using these commands\n\n\n```\n $ cd ~/solana-trader-proto/\n \n upgrade the version in pyproject.toml\n \n \n $ make proto-build-api-python\n $ cd python\n \n you can also push the package to pypi \n $ rm -rf python/dist/\n $ python3 -m build\n $ python3 -m twine upload --repository pypi dist/*\n \n \n and install the package locally now\n $ pip install dist/bxsolana-trader-proto-0.0.42.tar.gz\n \n now you can update the depdendency in solana-trader-client-python\n update the version of bxsolana-trader-proto in setup.cfg\n and run \n $ pip install -r requirements.txt\n \n\n```\n\nClone project and install dependencies:\n\n```\n$ git clone https://github.com/bloXroute-Labs/solana-trader-client-python.git\n$ cd solana-trader-client-python\n$ pip install -r requirements.txt\n```\n\nRun tests:\n\n```\n$ make test\n\nLinting:\n```\n$ make lint\n```\n\nMIT License\n\nCopyright (c) 2022 bloXroute Labs\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK for bloXroute's Solana Trader API",
"version": "2.1.1",
"project_urls": {
"Homepage": "https://github.com/bloXroute-Labs/solana-trader-client-python"
},
"split_keywords": [
"serum",
" solana",
" blockchain",
" trader",
" grpc",
" stream"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "22169a73b23bdb8e0f467df1cf31fbf2b08bd53849cb6717ac907e25f3e32f46",
"md5": "4444298716466058f51aac75323a8af5",
"sha256": "73104b41c5ad5f1c313a8cb9eced2b6db079b539e1f20f01cbb2413715692676"
},
"downloads": -1,
"filename": "bxsolana_trader-2.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4444298716466058f51aac75323a8af5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 34042,
"upload_time": "2024-05-01T13:07:14",
"upload_time_iso_8601": "2024-05-01T13:07:14.359627Z",
"url": "https://files.pythonhosted.org/packages/22/16/9a73b23bdb8e0f467df1cf31fbf2b08bd53849cb6717ac907e25f3e32f46/bxsolana_trader-2.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "acc3959554006fe73872dd55c71b5ae751db3bdafbcf1016d04169c6f0d7aaa8",
"md5": "986572c52c93778cc05518932a1112f0",
"sha256": "eab14f1b1b147b36a9eb060d9f33c095cfe7d5bf499838605e47be73b7f37627"
},
"downloads": -1,
"filename": "bxsolana_trader-2.1.1.tar.gz",
"has_sig": false,
"md5_digest": "986572c52c93778cc05518932a1112f0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26865,
"upload_time": "2024-05-01T13:07:16",
"upload_time_iso_8601": "2024-05-01T13:07:16.396943Z",
"url": "https://files.pythonhosted.org/packages/ac/c3/959554006fe73872dd55c71b5ae751db3bdafbcf1016d04169c6f0d7aaa8/bxsolana_trader-2.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 13:07:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bloXroute-Labs",
"github_project": "solana-trader-client-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "bxsolana-trader"
}
JSON
