API reference¶

This section lists the primary modules and public classes exposed by the SDK. Each entry is generated automatically from the source docstrings.

Core modules¶

`ovrl_sdk.client`	Async helpers for Horizon/Soroban operations tied to the OVRL asset.
`ovrl_sdk.config`	Network presets and configuration objects for the OVRL SDK.
`ovrl_sdk.constants`	OVRL token metadata and shared constants for the SDK.
`ovrl_sdk.exceptions`	Custom exception types for the OVRL SDK (Apache-2.0).
`ovrl_sdk.soroban`	Soroban-specific helpers for contract workflows in the OVRL SDK.
`ovrl_sdk.types`	Lightweight dataclasses modeling responses for the OVRL SDK.

Key entry points¶

Client¶

class ovrl_sdk.client.OVRLClient(*, network=NetworkConfig(name='testnet', horizon_url='https://horizon-testnet.stellar.org', passphrase=stellar_sdk.Network.TESTNET_NETWORK_PASSPHRASE, soroban_rpc_url='https://rpc-testnet.stellar.org', friendbot_url='https://friendbot.stellar.org'), base_fee=200, aiohttp_client=None)[source]¶

Bases: object

Async-first helper that wraps Horizon/Soroban flows for the OVRL token.

The client wires up the correct network endpoints, asset metadata, quoting helpers, and transaction builders so developers can bootstrap accounts, create trustlines, send payments, inspect history, and perform swaps without re-learning the raw stellar-sdk surface. Instantiate it with a NetworkPresets value (or custom config) and reuse the object across your async tasks.

Parameters:

network (NetworkConfig)
base_fee (int)
aiohttp_client (Optional[AiohttpClient])

async close()[source]¶

Dispose the internally owned HTTP client, if any.

Returns:: None. Provided for symmetry with async context managers.
Return type:: None

async load_account(account_id)[source]¶

Load an account from Horizon or raise OVRLError if missing.

Parameters:: account_id (str) – Public key to fetch from Horizon.
Returns:: The Horizon account wrapper returned by stellar-sdk.
Raises:: OVRLError – When the account cannot be found.

async ensure_friendbot(account_id)[source]¶

Invoke the configured Friendbot endpoint for a target account.

Parameters:: account_id (str) – Public key that should receive the Friendbot funding.
Returns:: Parsed JSON response from Friendbot (status, tx hash, etc.).
Raises:: FriendbotError – If Friendbot is unavailable or responds with an error.
Return type:: dict[str, Any]

async inspect_account(account_id)[source]¶

Return summarized account status including trustline and balance details.

Parameters:: account_id (str) – Public key to inspect.
Returns:: AccountStatus snapshot describing existence, trustline, and balance.
Return type:: AccountStatus

asset_metadata()[source]¶

Return static metadata describing the OVRL asset.

Returns:: AssetMetadata with code, issuer, max supply, decimals, etc.
Return type:: AssetMetadata

async get_ovrl_balance(account_id)[source]¶

Fetch the OVRL balance snapshot for the given Stellar account.

Parameters:: account_id (str) – Public key whose OVRL balance should be fetched.
Returns:: BalanceSnapshot describing limit, balance, and liabilities.
Raises:: OVRLError – If the account lacks an OVRL trustline.
Return type:: BalanceSnapshot

async get_asset_stats()[source]¶

Retrieve Horizon-reported aggregate statistics for OVRL.

Returns:: AssetStats representing supply, holders, liquidity pools, etc.
Return type:: AssetStats

async get_circulating_supply()[source]¶

Compute circulating supply after subtracting token-owned wallets.

Returns:: Decimal supply excluding issuer-controlled holdings.
Return type:: Decimal

async has_trustline(account_id)[source]¶

Check whether the account already holds a trustline for OVRL.

Parameters:: account_id (str) – Public key to inspect.
Returns:: True if the trustline exists, otherwise False.
Return type:: bool

async ensure_trustline(secret, *, limit='100000000000')[source]¶

Create a trustline if missing and return whether one was added.

Parameters:

secret (str) – Secret key that should sign the change-trust operation.
limit (str) – Optional limit to apply to the trustline.

Returns:

True if a new trustline was created, False when it already existed.

Return type:

bool

async bootstrap_account(*, account_secret, funding_secret=None, starting_balance='2', trustline_limit='100000000000')[source]¶

Ensure the account exists, is funded, and has the OVRL trustline.

Parameters:

account_secret (str) – Secret for the account to initialize.
funding_secret (str | None) – Optional sponsor for account creation when Friendbot is absent.
starting_balance (str) – Lumens sent when creating the account.
trustline_limit (str) – Limit applied to the OVRL trustline.

Returns:

AccountStatus after the bootstrap workflow completes.

Return type:

AccountStatus

async create_trustline(secret, *, limit='100000000000')[source]¶

Submit a change-trust operation for OVRL with the specified limit.

Parameters:

secret (str) – Secret key that will sign the transaction.
limit (str) – Maximum OVRL balance allowed on the trustline.

Returns:

TransactionResult describing the submitted envelope.

Return type:

TransactionResult

async create_account(*, funding_secret, destination, starting_balance='2')[source]¶

Create and fund a new Stellar account via a direct create-account op.

Parameters:

funding_secret (str) – Secret key that pays for the new account.
destination (str) – Public key to create.
starting_balance (str) – Lumens to send in the create-account op.

Returns:

TransactionResult describing the submitted envelope.

Return type:

TransactionResult

async ensure_account(account_id, *, funding_secret=None, starting_balance='2')[source]¶

Guarantee that an on-ledger account exists via Friendbot or a funding key.

Parameters:

account_id (str) – Public key that must exist.
funding_secret (str | None) – Optional sponsor secret when Friendbot is unavailable.
starting_balance (str) – Lumens used if a create-account operation is required.

Returns:

True when a new account was created, False if it already existed.

Return type:

bool

async pay(*, source_secret, destination, amount, memo=None)[source]¶

Send a simple OVRL payment with an optional memo.

Parameters:

source_secret (str) – Secret key that signs and pays for the transfer.
destination (str) – Recipient account ID.
amount (str) – Amount of OVRL to send (string amount for Stellar SDK).
memo (str | None) – Optional text memo.

Returns:

TransactionResult for the submitted payment transaction.

Return type:

TransactionResult

async send_path_payment(*, source_secret, destination, send_max, dest_amount, path=None)[source]¶

Send OVRL through a strict-receive path payment.

Parameters:

source_secret (str) – Secret key that signs the transaction.
destination (str) – Recipient account ID.
send_max (str) – Maximum OVRL you are willing to spend.
dest_amount (str) – Destination amount that must be received.
path (Iterable[stellar_sdk.Asset] | None) – Optional iterable of intermediary Asset hops.

Returns:

TransactionResult for the submitted swap transaction.

Return type:

TransactionResult

async batch_pay(*, source_secret, payouts, memo=None, chunk_size=100)[source]¶

Chunk and submit multiple payment operations in batches.

Parameters:

source_secret (str) – Secret key funding the batched operations.
payouts (Sequence[PaymentIntent | dict]) – Sequence of dicts or PaymentIntent objects.
memo (str | None) – Optional memo applied to each batch transaction.
chunk_size (int) – Maximum payment operations per transaction (<=100).

Returns:

List of TransactionResult objects, one per submitted transaction.

Return type:

List[TransactionResult]

async list_payments_page(account_id, *, limit=10, only_ovrl=True, order='desc', cursor=None, payment_types=None)[source]¶

Return a single page of payments for the account with cursor metadata.

Parameters:

account_id (str) – Account whose payment history should be fetched.
limit (int) – Number of records per page (max 200 per Horizon).
only_ovrl (bool) – Filter to OVRL payments only when True.
order (str) – “asc” or “desc” order for paging.
cursor (str | None) – Optional paging token to resume from.
payment_types (Sequence[str] | None) – Optional Horizon type filters.

Returns:

PaymentPage containing typed records and the next cursor.

Return type:

PaymentPage

async list_payments(account_id, *, limit=10, only_ovrl=True, order='desc', cursor=None, payment_types=None)[source]¶

Return payment records without pagination metadata.

Parameters:

account_id (str) – Account whose payment history will be read.
limit (int) – Maximum records per fetch (<=200 per Horizon).
only_ovrl (bool) – When True, filter records to OVRL payments.
order (str) – “asc” or “desc” ordering.
cursor (str | None) – Optional paging token to resume from.
payment_types (Sequence[str] | None) – Optional Horizon payment type filters.

Returns:

List of PaymentRecord objects.

Return type:

List[PaymentRecord]

async summarize_payments(account_id, *, limit=100, only_ovrl=True, payment_types=None, max_pages=10, cursor=None)[source]¶

Summarize total count/amount across multiple payment pages.

Parameters:

account_id (str) – Public key whose history should be summarized.
limit (int) – Page size forwarded to Horizon.
only_ovrl (bool) – Restrict to OVRL-denominated payments.
payment_types (Sequence[str] | None) – Optional Horizon payment type filters.
max_pages (int) – Maximum number of pages to fetch.
cursor (str | None) – Optional paging token to resume from.

Returns:

Aggregated PaymentSummary value.

Return type:

PaymentSummary

async list_top_holders(*, limit=10)[source]¶

Return the richest OVRL accounts along with their balances.

Parameters:: limit (int) – Maximum number of holders to return.
Returns:: Sorted list of BalanceSnapshot objects.
Return type:: List[BalanceSnapshot]

async payment_watcher(account_id, *, only_ovrl=True, poll_interval=5.0, limit=10, max_rounds=None, start_cursor=None, replay_most_recent=True, payment_types=None)[source]¶

Poll for new payments, yielding records incrementally.

Parameters:

account_id (str) – Account to watch.
only_ovrl (bool) – When True, skip non-OVRL payments.
poll_interval (float) – Seconds to sleep between Horizon polls.
limit (int) – Page size per poll.
max_rounds (int | None) – Optional number of polls before stopping.
start_cursor (str | None) – Optional cursor to resume from.
replay_most_recent (bool) – Whether to emit the latest page before polling forward.
payment_types (Sequence[str] | None) – Optional Horizon payment type filters.

Yields:

PaymentRecord objects as new payments appear.

Return type:

AsyncIterator[PaymentRecord]

async get_account_overview(account_id)[source]¶

Fetch raw account JSON from Horizon and normalize into AccountOverview.

Parameters:: account_id (str) – Public key to load via Horizon.
Returns:: AccountOverview representing the latest Horizon payload.
Return type:: AccountOverview

async quote_paths_to_ovrl(destination_amount, *, source_assets=None)[source]¶

Enumerate strict-receive paths that deliver the requested OVRL amount.

Parameters:

destination_amount (str) – Desired amount of OVRL (string amount accepted by Horizon).
source_assets (Sequence[stellar_sdk.Asset] | None) – Optional list of assets to use when sourcing the payment.

Returns:

List of PathQuote objects ordered by efficiency.

Return type:

List[PathQuote]

async quote_paths_from_ovrl(send_amount, *, destination_assets=None)[source]¶

Enumerate strict-send paths that spend OVRL into target assets.

Parameters:

send_amount (str) – Amount of OVRL to spend.
destination_assets (Sequence[stellar_sdk.Asset] | None) – Optional asset whitelist for the destination.

Returns:

List of PathQuote objects ordered by destination amount.

Return type:

List[PathQuote]

async get_transaction(tx_hash)[source]¶

Fetch a transaction via Horizon or raise if not found.

Parameters:: tx_hash (str) – Transaction hash to retrieve.
Returns:: Parsed Horizon transaction JSON payload.
Raises:: OVRLError – If the transaction cannot be found.
Return type:: dict[str, Any]

async wait_for_transaction(tx_hash, *, timeout=30, poll_interval=2)[source]¶

Poll Horizon until the transaction appears or timeout occurs.

Parameters:

tx_hash (str) – Transaction hash to wait for.
timeout (float) – Maximum seconds to wait.
poll_interval (float) – Delay between consecutive polls.

Returns:

Horizon transaction JSON once the record is available.

Raises:

OVRLError – If the timeout elapses before the transaction is found.

Return type:

dict[str, Any]

async submit_envelope_xdr(envelope_xdr)[source]¶

Submit a base64-encoded envelope XDR using Horizon.

Parameters:: envelope_xdr (str) – Base64-encoded transaction envelope.
Returns:: TransactionResult describing Horizon’s response.
Return type:: TransactionResult

async submit_with_retry(envelope, *, attempts=3, backoff_seconds=2.0)[source]¶

Submit a built envelope with retry/backoff semantics.

Parameters:

envelope (stellar_sdk.TransactionEnvelope) – Prepared envelope to submit.
attempts (int) – Number of submission attempts before failing.
backoff_seconds (float) – Base backoff used between retries.

Returns:

TransactionResult on success.

Raises:

OVRLError – If attempts is invalid or submission ultimately fails.

Return type:

TransactionResult

async fetch_home_domain_toml()[source]¶

Download and parse the asset home-domain stellar.toml.

Returns:: Parsed TOML dictionary.
Raises:: OVRLError – When the file cannot be fetched or parsed.
Return type:: dict[str, Any]

async validate_home_domain()[source]¶

Ensure Horizon’s recorded home domain matches the TOML contents.

Returns:: True when the home domain configuration is valid.
Raises:: OVRLError – When Horizon or TOML data disagree.
Return type:: bool

async get_fee_stats()[source]¶

Return the latest Horizon-reported fee statistics.

Returns:: FeeStats parsed from Horizon.
Return type:: FeeStats

async quote_ovrl_price(*, counter_asset=stellar_sdk.Asset, amount='1')[source]¶

Return the per-unit counter-asset value for OVRL.

Parameters:

counter_asset (stellar_sdk.Asset) – Asset used to price OVRL (defaults to USD).
amount (str | Decimal) – Amount of OVRL used to compute the quote.

Returns:

Decimal price per OVRL (counter_asset / OVRL).

Return type:

Decimal

async quote_ovrl_to_asset(amount, *, counter_asset=stellar_sdk.Asset)[source]¶

Quote how much of the counter asset is received for the OVRL amount.

Parameters:

amount (str | Decimal) – Amount of OVRL to convert.
counter_asset (stellar_sdk.Asset) – Asset that should be received.

Returns:

Decimal representing the destination amount.

Return type:

Decimal

async quote_asset_to_ovrl(amount, *, source_asset=stellar_sdk.Asset)[source]¶

Quote how much OVRL can be received for a counter-asset amount.

Parameters:

amount (str | Decimal) – Counter asset amount to spend.
source_asset (stellar_sdk.Asset) – Asset being sold.

Returns:

Decimal amount of OVRL that can be purchased.

Return type:

Decimal

async ovrl_to_usd(amount)[source]¶

Convert an OVRL amount into the default USD asset.

Parameters:: amount (str | Decimal) – OVRL amount to convert.
Returns:: Decimal amount of USD received.
Return type:: Decimal

async usd_to_ovrl(amount)[source]¶

Convert the default USD asset amount into OVRL.

Parameters:: amount (str | Decimal) – USD amount to convert.
Returns:: Decimal representing how much OVRL can be purchased.
Return type:: Decimal

async swap_from_ovrl(*, source_secret, destination, amount, counter_asset=stellar_sdk.Asset, memo=None)[source]¶

Execute a strict-send swap spending OVRL into a counter asset.

Parameters:

source_secret (str) – Secret key authorizing the payment.
destination (str) – Recipient account for the destination asset.
amount (str | Decimal) – Amount of OVRL to swap.
counter_asset (stellar_sdk.Asset) – Asset that should be received.
memo (str | None) – Optional memo text.

Returns:

TransactionResult referencing the submitted transaction.

Return type:

TransactionResult

async swap_to_ovrl(*, source_secret, destination, ovrl_amount, source_asset=stellar_sdk.Asset, memo=None)[source]¶

Execute a strict-receive swap delivering OVRL.

Parameters:

source_secret (str) – Secret key authorizing the payment.
destination (str) – Recipient account for the OVRL.
ovrl_amount (str | Decimal) – Amount of OVRL required at destination.
source_asset (stellar_sdk.Asset) – Asset to spend.
memo (str | None) – Optional memo text.

Returns:

TransactionResult referencing the submitted transaction.

Return type:

TransactionResult

static format_price(amount, *, currency='USD', style='symbol', precision=2, notation='standard', trim_trailing=True)[source]¶

Format a numeric value with currency styling and optional grouped/compact notation.

Parameters:

amount (str | Decimal) – Numeric amount (string or Decimal) to format.
currency (str) – ISO currency code used for symbol/code output.
style (str) – symbol (default), code, or plain text rendering.
precision (int) – Decimal places to display (>=0).
notation (str) – standard, grouped, or compact for thousands abbreviations.
trim_trailing (bool) – When True, drop redundant trailing zeros.

Returns:

Formatted currency string.

Raises:

OVRLError – If unsupported precision/style/notation values are provided.

Return type:

str

soroban()[source]¶

Return a lazy-initialized Soroban toolkit tied to this client.

Returns:: SorobanToolkit wired to the client’s network configuration.
Raises:: SorobanUnavailableError – If the current network lacks a Soroban RPC endpoint.

Soroban helpers¶

class ovrl_sdk.soroban.SorobanTokenClient(client, contract_id, *, scale=7, toolkit=None)[source]¶

High-level helpers for invoking the Soroban token interface (balance/transfer/etc).

Parameters:

client (OVRLClient)
contract_id (str)
scale (int)
toolkit (Optional[SorobanToolkit])

async balance(*, secret, account_id)[source]¶

Return the contract-level token balance for account_id.

Parameters:

secret (str) – Secret key used for authentication (read-only call still signs).
account_id (str) – Account whose balance should be returned.

Returns:

Decimal balance using the configured scale, or None when unset.

Return type:

Decimal | None

async transfer(*, secret, destination, amount)[source]¶

Transfer tokens from the caller to destination using Soroban.

Parameters:

secret (str) – Secret key initiating the transfer.
destination (str) – Recipient Stellar address.
amount (str) – Human-readable token amount respecting the configured scale.

Returns:

SorobanInvocation describing the submitted transaction.

Return type:

SorobanInvocation

async allowance(*, secret, owner, spender)[source]¶

Return the approved allowance between owner and spender.

Parameters:

secret (str) – Secret key used to authorize the simulation request.
owner (str) – Account that granted allowance.
spender (str) – Account allowed to spend on behalf of owner.

Returns:

Decimal allowance or None when no approval exists.

Return type:

Decimal | None

async approve(*, secret, spender, amount, expiration_ledger=None)[source]¶

Approve the spender to withdraw up to amount tokens.

Parameters:

secret (str) – Owner’s secret key.
spender (str) – Account that will receive the allowance.
amount (str | Decimal) – Maximum amount the spender can withdraw.
expiration_ledger (int | None) – Optional ledger after which the approval expires.

Returns:

SorobanInvocation describing the approval transaction.

Return type:

SorobanInvocation

async mint(*, secret, destination, amount)[source]¶

Mint new tokens to destination (requires contract permissions).

Parameters:

secret (str) – Secret key with mint authority.
destination (str) – Recipient account for the minted amount.
amount (str | Decimal) – Amount to mint (string or Decimal).

Returns:

SorobanInvocation referencing the mint transaction.

Return type:

SorobanInvocation

async burn(*, secret, amount)[source]¶

Burn tokens from the caller’s balance.

Parameters:

secret (str) – Secret key whose balance will decrease.
amount (str | Decimal) – Amount to burn.

Returns:

SorobanInvocation referencing the burn transaction.

Return type:

SorobanInvocation

Data models¶

Lightweight dataclasses modeling responses for the OVRL SDK.

Defines high-level records for balances, payments, quotes, pagination, and transaction summaries returned by the async client. License: Apache-2.0. Authors: Overlumens (github.com/overlumens) and Md Mahedi Zaman Zaber (github.com/zaber-dev).

class ovrl_sdk.types.AccountOverview(account_id, sequence, subentry_count, last_modified_ledger, balances, signers)[source]

Bases: object

Lightweight wrapper around the Horizon account payload.

Parameters:

account_id (str)
sequence (str)
subentry_count (int)
last_modified_ledger (int | None)
balances (List[dict])
signers (List[dict])

account_id: str

sequence: str

subentry_count: int

last_modified_ledger: int | None

balances: List[dict]

signers: List[dict]

class ovrl_sdk.types.AccountStatus(account_id, exists, has_trustline, overview, balance, needs_friendbot)[source]

Bases: object

High-level status report produced by OVRLClient.inspect_account.

Parameters:

account_id (str)
exists (bool)
has_trustline (bool)
overview (AccountOverview | None)
balance (BalanceSnapshot | None)
needs_friendbot (bool)

account_id: str

exists: bool

has_trustline: bool

overview: AccountOverview | None

balance: BalanceSnapshot | None

needs_friendbot: bool

class ovrl_sdk.types.AssetMetadata(code, issuer, home_domain, max_supply, issuer_locked, decimal_scale)[source]

Bases: object

Static attributes describing the OVRL asset.

Parameters:

code (str)
issuer (str)
home_domain (str)
max_supply (Decimal)
issuer_locked (bool)
decimal_scale (int)

code: str

issuer: str

home_domain: str

max_supply: Decimal

issuer_locked: bool

decimal_scale: int

class ovrl_sdk.types.AssetStats(amount, num_accounts, num_claimable_balances, claimable_balances_amount, liquidity_pools_amount, num_liquidity_pools, home_domain, last_modified_ledger, flags)[source]

Bases: object

Aggregated Horizon stats for OVRL (supply, holders, flags).

Parameters:

amount (Decimal)
num_accounts (int)
num_claimable_balances (int)
claimable_balances_amount (Decimal)
liquidity_pools_amount (Decimal)
num_liquidity_pools (int)
home_domain (str | None)
last_modified_ledger (int | None)
flags (Dict[str, bool])

amount: Decimal

num_accounts: int

num_claimable_balances: int

claimable_balances_amount: Decimal

liquidity_pools_amount: Decimal

num_liquidity_pools: int

home_domain: str | None

last_modified_ledger: int | None

flags: Dict[str, bool]

class ovrl_sdk.types.BalanceSnapshot(account_id, asset_code, asset_issuer, balance, limit, buying_liabilities, selling_liabilities)[source]

Bases: object

Represents a point-in-time OVRL balance pulled from Horizon.

Parameters:

account_id (str)
asset_code (str)
asset_issuer (str)
balance (Decimal)
limit (Decimal | None)
buying_liabilities (Decimal)
selling_liabilities (Decimal)

account_id: str

asset_code: str

asset_issuer: str

balance: Decimal

limit: Decimal | None

buying_liabilities: Decimal

selling_liabilities: Decimal

class ovrl_sdk.types.FeeStats(last_ledger, last_ledger_base_fee, ledger_capacity_usage, min_accepted_fee, mode_accepted_fee, p10_accepted_fee, p50_accepted_fee, p95_accepted_fee, p99_accepted_fee)[source]

Bases: object

Snapshot of Horizon fee percentile metrics.

Parameters:

last_ledger (int)
last_ledger_base_fee (int)
ledger_capacity_usage (Decimal)
min_accepted_fee (int)
mode_accepted_fee (int)
p10_accepted_fee (int)
p50_accepted_fee (int)
p95_accepted_fee (int)
p99_accepted_fee (int)

last_ledger: int

last_ledger_base_fee: int

ledger_capacity_usage: Decimal

min_accepted_fee: int

mode_accepted_fee: int

p10_accepted_fee: int

p50_accepted_fee: int

p95_accepted_fee: int

p99_accepted_fee: int

class ovrl_sdk.types.PathQuote(destination_amount, source_amount, path_assets=<factory>, source_asset_code=None, source_asset_issuer=None, destination_asset_code=None, destination_asset_issuer=None)[source]

Bases: object

Normalized strict send/receive path quote for logging or decision making.

Parameters:

destination_amount (Decimal)
source_amount (Decimal)
path_assets (Sequence[str])
source_asset_code (str | None)
source_asset_issuer (str | None)
destination_asset_code (str | None)
destination_asset_issuer (str | None)

destination_amount: Decimal

source_amount: Decimal

path_assets: Sequence[str]

source_asset_code: str | None

source_asset_issuer: str | None

destination_asset_code: str | None

destination_asset_issuer: str | None

class ovrl_sdk.types.PaymentIntent(destination, amount, source=None, memo=None)[source]

Bases: object

Declarative payout description consumed by OVRLClient.batch_pay.

Parameters:

destination (str)
amount (Decimal | str)
source (str | None)
memo (str | None)

destination: str

amount: Decimal | str

source: str | None

memo: str | None

class ovrl_sdk.types.PaymentPage(records, next_cursor, record_count, total_amount)[source]

Bases: object

Single page of payment history plus pagination metadata.

Parameters:

records (List[PaymentRecord])
next_cursor (str | None)
record_count (int)
total_amount (Decimal)

records: List[PaymentRecord]

next_cursor: str | None

record_count: int

total_amount: Decimal

class ovrl_sdk.types.PaymentRecord(id, source, destination, amount, asset_code, asset_issuer, created_at, memo=None, paging_token=None)[source]

Bases: object

Typed version of a payment response returned by Horizon.

Parameters:

id (str)
source (str)
destination (str | None)
amount (Decimal)
asset_code (str)
asset_issuer (str | None)
created_at (str)
memo (str | None)
paging_token (str | None)

id: str

source: str

destination: str | None

amount: Decimal

asset_code: str

asset_issuer: str | None

created_at: str

memo: str | None

paging_token: str | None

class ovrl_sdk.types.PaymentSummary(record_count, total_amount, last_cursor)[source]

Bases: object

Aggregate stats produced by OVRLClient.summarize_payments.

Parameters:

record_count (int)
total_amount (Decimal)
last_cursor (str | None)

record_count: int

total_amount: Decimal

last_cursor: str | None

class ovrl_sdk.types.TransactionResult(hash, envelope_xdr=None, result_xdr=None)[source]

Bases: object

Minimal structure describing a submitted transaction hash/XDR blobs.

Parameters:

hash (str)
envelope_xdr (str | None)
result_xdr (str | None)

hash: str

envelope_xdr: str | None

result_xdr: str | None