Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevinheavey/solders
A high-performance Python toolkit for Solana, written in Rust
https://github.com/kevinheavey/solders
blockchain defi nft pyo3 python rust solana
Last synced: about 1 month ago
JSON representation
A high-performance Python toolkit for Solana, written in Rust
- Host: GitHub
- URL: https://github.com/kevinheavey/solders
- Owner: kevinheavey
- License: apache-2.0
- Created: 2021-12-29T01:20:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T10:17:11.000Z (about 2 months ago)
- Last Synced: 2024-05-15T23:55:43.977Z (about 2 months ago)
- Topics: blockchain, defi, nft, pyo3, python, rust, solana
- Language: Rust
- Homepage: https://kevinheavey.github.io/solders/
- Size: 4.74 MB
- Stars: 153
- Watchers: 4
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-solana - Solders
- awesome-stars - kevinheavey/solders - `★177` A high-performance Python toolkit for Solana, written in Rust (Rust)
README
---
[](https://badge.fury.io/py/solders)
[](https://github.com/kevinheavey/solders/blob/main/LICENSE)
# Solders
`solders` is a high-performance Python toolkit for Solana, written in Rust. It provides robust solutions to the following problems:
- Core SDK stuff: keypairs, pubkeys, signing and serializing transactions - that sort of thing.
- RPC stuff: building requests and parsing responses (no networking stuff - if you want help with that,
[solana-py](https://michaelhly.github.io/solana-py/rpc/async_api/) is your friend).
- Integration testing stuff: the `solders.bankrun` module is an alternative to `solana-test-validator` that's much more convenient and **much** faster. It's based on [solana-program-test](https://crates.io/crates/solana-program-test) if you know that is.
## What about solana-py?
`solders` and `solana-py` are good friends. `solana-py` uses `solders` under the hood extensively in its
core API and RPC API. The main differences are:
- `solders` doesn't have functions to actually interact with the RPC server (though `solana-py` does use the RPC code from `solders`).
- `solders` doesn't provide SPL Token and SPL Memo clients.
- `solana-py` may not have support for all the RPC requests and responses provided by `solders`.
- `solana-py` doesn't have anything like the `bankrun` testing kit.
Since `solana-py` uses `solders` under the hood and they don't duplicate each other's features, you should just use whichever library you need.
## Installation
```
pip install solders
```
Note: Requires Python >= 3.7.
## Example Usage
```python
>>> from solders.message import Message
>>> from solders.keypair import Keypair
>>> from solders.instruction import Instruction
>>> from solders.hash import Hash
>>> from solders.transaction import Transaction
>>> from solders.pubkey import Pubkey
>>> program_id = Pubkey.default()
>>> arbitrary_instruction_data = bytes([1])
>>> accounts = []
>>> instruction = Instruction(program_id, arbitrary_instruction_data, accounts)
>>> payer = Keypair()
>>> message = Message([instruction], payer.pubkey())
>>> blockhash = Hash.default() # replace with a real blockhash
>>> tx = Transaction([payer], message, blockhash)
```
## Development
### Setup
1. Install [poetry](https://python-poetry.org/)
2. Install dev dependencies:
```
poetry install
```
3. Activate the poetry shell:
```sh
poetry shell
```
### Testing
1. Run `maturin develop` to compile the Rust code.
2. Run `make fmt`, `make lint`, and `make test`.