Metadata-Version: 2.1
Name: strledger
Version: 0.9.0
Summary: Ledger Hardware Wallet Stellar Python bindings.
Home-page: https://github.com/lightsail-network/strledger
License: MIT
Keywords: stellar,ledger
Author: overcat
Author-email: 4catcode@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Typing :: Typed
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: ledgerwallet (>=0.5.1,<0.6.0)
Requires-Dist: stellar-sdk (>=12.0.0,<13.0.0)
Project-URL: Bug Tracker, https://github.com/lightsail-network/strledger/issues
Project-URL: Documentation, https://github.com/lightsail-network/strledger
Project-URL: Repository, https://github.com/lightsail-network/strledger
Description-Content-Type: text/markdown

# strledger - Ledger Hardware Wallet Stellar Python bindings.

![example](https://github.com/lightsail-network/strledger/blob/main/img/example.png)

## Installation
```shell
pip install -U strledger
```

## Cli Usage
```text
Usage: strledger [OPTIONS] COMMAND [ARGS]...

  Stellar Ledger commands.

  This project is built on the basis of ledgerwallet, you can check ledgerwallet for
  more features.

Options:
  -v, --verbose  Display exchanged APDU.
  --help         Show this message and exit.

Commands:
  app-info     Get Stellar app configuration info.
  get-address  Get Stellar public address.
  sign-auth    Sign a base64-encoded soroban authorization (HashIDPreimage).
  sign-hash    Sign a hex encoded hash.
  sign-tx      Sign a base64-encoded transaction envelope.
  version      Get strledger version info.
```

## Library Usage

```python
from strledger import StrLedger

client = StrLedger()
# Use the Stellar Python SDK to build a transaction, see https://github.com/StellarCN/py-stellar-base
transaction_envelope = ...
client.sign_transaction(transaction_envelope=transaction_envelope, keypair_index=0)
print(f"signed tx: {transaction_envelope.to_xdr()}")
```
