Getting started

Installation

pip install ovrl-sdk

For local development:

pip install -e .[dev]

Configuration

Set these environment variables before running the examples or your own scripts.

Variable	Purpose
OVRL_SECRET	Primary secret key that signs transactions.
OVRL_DESTINATION	Destination account for payment flows.
OVRL_NETWORK	Optional; PUBLIC / TESTNET / FUTURENET.
OVRL_CONTRACT_ID	Soroban token contract identifier for advanced flows.

See examples/shared.py for a helper that validates the configuration and lazily loads Friendbot funding when available.

Bootstrap an account

"""Bootstrap an OVRL account and trustline, then inspect the resulting status."""

from __future__ import annotations

import asyncio

from stellar_sdk import Keypair

from examples.shared import optional_env, ovrl_client, require_env


async def main() -> None:
    """Ensure the caller account exists, is funded, and holds the OVRL trustline."""

    secret = require_env("OVRL_SECRET")
    funding_secret = optional_env("OVRL_FUNDING_SECRET")
    keypair = Keypair.from_secret(secret)

    async with ovrl_client() as client:
        metadata = client.asset_metadata()
        print(f"OVRL issuer: {metadata.issuer} | max supply: {metadata.max_supply}")

        before = await client.inspect_account(keypair.public_key)
        print(
            "Before bootstrap -> exists=%s trustline=%s"
            % (before.exists, before.has_trustline)
        )

        status = await client.bootstrap_account(
            account_secret=secret,
            funding_secret=funding_secret,
        )
        print(
            "After bootstrap  -> exists=%s trustline=%s friendbot=%s"
            % (status.exists, status.has_trustline, status.needs_friendbot)
        )

        if status.balance:
            print(
                f"OVRL balance: {status.balance.balance} / limit {status.balance.limit or 'unbounded'}"
            )
        else:
            print("OVRL trustline created; balance 0.0")


if __name__ == "__main__":
    asyncio.run(main())

The script:

1. Funds an account via Friendbot (or a sponsor secret).

2. Establishes the OVRL trustline.

3. Returns an AccountStatus summary with balances and trustline info.

Next steps

• Browse the API reference reference for low-level helpers.

• Explore examples/ for payments, quoting, monitoring, and Soroban flows.

• Enable sphinx.ext.autodoc in your own docs to reuse these docstrings.