Skip to main content

SatRank SDK for autonomous agents on Bitcoin Lightning. Discover, score, and pay Lightning-native HTTP services.

Project description

satrank — Python SDK

Python client for SatRank. One verb — fulfill() — that discovers, pays, and reports a Lightning-native HTTP service in a single call with a hard budget guarantee.

Install

pip install satrank                 # core
pip install "satrank[nwc]"          # + Nostr Wallet Connect driver

Python 3.10+.

Quickstart

import asyncio
from satrank import SatRank
from satrank.wallet import LndWallet

async def main() -> None:
    async with SatRank(
        api_base="https://satrank.dev",
        wallet=LndWallet(
            rest_endpoint="https://127.0.0.1:8080",
            macaroon_hex="...",  # admin macaroon (hex)
        ),
        caller="my-agent",
    ) as sr:
        result = await sr.fulfill(
            intent={"category": "data/weather", "keywords": ["paris"]},
            budget_sats=50,
        )
        print(result["response_body"] if result["success"] else result["error"])

asyncio.run(main())

Discovery only (no wallet)

async with SatRank(api_base="https://satrank.dev", caller="explorer") as sr:
    cats = await sr.list_categories()
    res = await sr.resolve_intent(category="data/weather", limit=10)
    for c in res["candidates"]:
        print(c["rank"], c.get("price_sats"), c.get("service_name"))

Wallet drivers

  • LndWallet — LND REST, macaroon auth.
  • NwcWallet — NIP-47 Nostr Wallet Connect (needs satrank[nwc]).
  • LnurlWallet — LNbits-style HTTP wallets.

See docs/sdk/wallet-drivers.md in the repo.

Documentation

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

satrank-1.0.5.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

satrank-1.0.5-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file satrank-1.0.5.tar.gz.

File metadata

  • Download URL: satrank-1.0.5.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.6

File hashes

Hashes for satrank-1.0.5.tar.gz
Algorithm Hash digest
SHA256 4615fdc5e3256ba5d872eee6560d495f1fdad68c4cd13fbcae76246b63628bc5
MD5 b836f3374b4673a4bf325fe0d16c1874
BLAKE2b-256 4f3f238c9d3c91b87f920025c710ef561862a1da831da178bb05ab81441f5eca

See more details on using hashes here.

File details

Details for the file satrank-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: satrank-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.6

File hashes

Hashes for satrank-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2e759f35312deb62c3bd2be5231704e8e5563bfe0f4a97c094a3e071bf79e62d
MD5 51baa0a7e3ea508f702e66f4ff82ecdd
BLAKE2b-256 853ebb08ab5e0e4498861dd2c511b332f3673e5511c42b5627790065776c60a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page