Olive Solana Python SDK
The supported async Python client for market makers quoting Olive Solana options.
It implements only the native /maker/v1/ws protocol—there is no EVM or legacy
compatibility layer.
ManagedMaker is the recommended API. Maker code supplies entry premium or exit
amount and funding source; the SDK validates requests, binds canonical quote
fields, allocates durable quote IDs and entry nonces, signs through a local/HSM callback,
persists before submission, reconnects, and durably routes lifecycle events.
Install
# From this repository:
pip install -e "packages/python-sdk[postgres]"
# After the distribution is published:
pip install "olive-solana-sdk[postgres]"
Python 3.11 or newer is required. Apply the packaged
schemas/postgres-maker-store-v1.sql with the maker's migration role and use
schema_mode="verify" in production. The default migration mode is intended for
development. InMemoryMakerStore is test-only.
The exact migration is also available programmatically with
postgres_maker_store_schema() so deployment tooling does not need to locate
the installed wheel's data directory.
Managed maker quickstart
import asyncio
import os
from olive_solana import (
DeploymentIdentity,
LocalKeypairMakerSigner,
ManagedMaker,
ManagedMakerEventHandlers,
ManagedMakerOptions,
PostgresMakerStore,
)
async def main() -> None:
signer = LocalKeypairMakerSigner.from_json_file(
os.environ["OLIVE_QUOTE_SIGNER_KEYPAIR"]
)
store = PostgresMakerStore(
os.environ["DATABASE_URL"], schema_mode="verify"
)
async def entry(rfq):
premium = await price_entry(rfq.request)
return (
rfq.decline("outside_risk_limits")
if premium is None
else rfq.quote(premium_usdc=premium)
)
async def exit_(rfq):
amount = await price_exit(rfq.request)
return (
rfq.decline("outside_risk_limits")
if amount is None
else rfq.quote(
exit_amount_usdc=amount,
usdc_source=os.environ["OLIVE_EXIT_USDC_SOURCE"],
)
)
maker = ManagedMaker(
ManagedMakerOptions(
url=os.environ["OLIVE_MAKER_WS_URL"],
maker_config=os.environ["OLIVE_MAKER_CONFIG"],
expected_deployment=DeploymentIdentity(
program_id=os.environ["OLIVE_PROGRAM_ID"],
genesis_hash=os.environ["OLIVE_GENESIS_HASH"],
chain_tag=os.environ["OLIVE_CHAIN_TAG"],
),
signer=signer,
store=store,
topics=("btc", "sol"),
products=(0, 1),
on_entry_rfq=entry,
on_exit_rfq=exit_,
events=ManagedMakerEventHandlers(
# Selection is feedback, not execution.
on_entry_selected=record_selection,
# Only finalized fills trigger hedging/reconciliation.
on_entry_filled=hedge_finalized_entry,
on_exit_filled=reconcile_finalized_exit,
on_funding_required=alert_funding,
on_default=page_risk,
on_settlement=record_settlement,
),
)
)
try:
await maker.run()
finally:
await store.close()
asyncio.run(main())
The local keypair in this quickstart is for laptop tests or a tightly controlled
key-file deployment. Production remote/HSM integrations use
CallbackMakerSigner and never pass private-key bytes to the maker process:
from olive_solana import CallbackMakerSigner, SignerContext
async def sign_with_remote_provider(
digest: bytes,
context: SignerContext,
) -> bytes:
if len(digest) != 32:
raise ValueError("expected a 32-byte Olive digest")
signature = await remote_provider.sign_ed25519(
key_id="olive-quote-signer",
message=digest,
audit_context={"purpose": context.purpose},
)
if len(signature) != 64:
raise ValueError("expected a 64-byte Ed25519 signature")
return signature
signer = CallbackMakerSigner(
public_key="<remote Ed25519 public key in canonical base58>",
callback=sign_with_remote_provider,
)
The callback signs the supplied raw 32-byte SHA-256(preimage) digest with
ordinary Ed25519 and returns the raw 64-byte signature. Do not hash again, sign
encoded text/the full preimage, or use Ed25519ph. The remote public key may be
the finalized on-chain MakerConfig.quoteSigner.
An empty topic or product collection subscribes to everything authorized by
maker.hello. Keep takeover_existing_session=False for ordinary starts; enable
it only for an intentional failover.
Operational preflight
The doctor authenticates without subscribing, taking over a live maker, or submitting quotes. Its convenience CLI intentionally uses a local test keypair:
olive-maker-doctor --topics btc,sol --products 0,1 \
--exit-sources "$OLIVE_EXIT_USDC_SOURCE"
olive-maker-doctor --json > maker-doctor.json
Connection and deployment values default from OLIVE_MAKER_WS_URL,
OLIVE_MAKER_CONFIG, OLIVE_PROGRAM_ID, OLIVE_GENESIS_HASH,
OLIVE_CHAIN_TAG, and OLIVE_QUOTE_SIGNER_KEYPAIR.
Remote/HSM deployments MUST NOT export their private key to use the CLI. Call
run_maker_doctor(MakerDoctorOptions(..., signer=signer)) programmatically with
the same CallbackMakerSigner used by the managed maker, and retain
report.to_dict() as the machine-readable preflight record.
Wire types and schema
The complete required/optional DTO catalog is published at
maker-websocket-v1.schema.json
and included in the wheel at
olive_solana/schemas/maker-websocket-v1.schema.json. Python exports typed RFQ,
quote, selected, filled, decline, and error/result shapes from olive_solana.
Missing required fields fail before maker callbacks run; unknown additive server
fields are preserved, while outbound quotes remain strict. The normative
semantics and signing preimages are in the
Maker WebSocket API v1.
Reliability contract
- Wire integers remain canonical decimal strings.
- Entry nonces are durable; V6 exit quotes have no wire nonce and are replay-safe because a successful exit closes the bound position.
- Complete quote, digest, and signature are committed before submission.
- Restart retries only the exact stored quote and signature.
- Durable events are stored before
event.ack; local handler completion is persisted independently. quote.selectedandexit_quote.selectedare not fills. Only finalizedtrade.filledandexit.filledare canonical execution signals.- Signatures and private signer data are never included in SDK status events.
The low-level MakerWsClient remains available for makers requiring custom
orchestration. Releases must pass the shared fixture/digest suite and all
fail-closed maker conformance scenarios.
Development
python -m venv .venv
.venv/bin/pip install -e ".[dev]"
.venv/bin/ruff check .
.venv/bin/mypy src
.venv/bin/pytest
.venv/bin/python -m build
Release
PyPI releases use trusted publishing from
.github/workflows/publish-python-sdk.yml; no long-lived API token is stored in
GitHub. Configure the PyPI publisher for repository macols77/olive, workflow
publish-python-sdk.yml, and environment pypi. Pushing a tag that exactly
matches python-sdk-v<pyproject version> builds, checks, and uploads both the
wheel and source distribution. Protect the pypi environment with required
reviewer approval. A failed release can be retried from GitHub Actions with
Run workflow by supplying the same existing tag; the workflow checks out
that tag and verifies it exactly matches the package version before publishing.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file olive_solana_sdk-0.1.1.tar.gz.
File metadata
- Download URL: olive_solana_sdk-0.1.1.tar.gz
- Upload date:
- Size: 50.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ea4e539aac5e263e7f015cd62cbc2e6bd60dcf318e9fc5e9e1ce9b0a941005e0
|
|
| MD5 |
3ca2d1b46b96792f43bc0c120d4f789e
|
|
| BLAKE2b-256 |
4ea1d6ac2f649f8617305dbe36c2d5c2a1b499b6df2d73565ea8b0f5286c1c56
|
Provenance
The following attestation bundles were made for olive_solana_sdk-0.1.1.tar.gz:
Publisher:
publish-python-sdk.yml on macols77/olive
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
olive_solana_sdk-0.1.1.tar.gz -
Subject digest:
ea4e539aac5e263e7f015cd62cbc2e6bd60dcf318e9fc5e9e1ce9b0a941005e0 - Sigstore transparency entry: 2580908324
- Sigstore integration time:
-
Permalink:
macols77/olive@a43f668ffff13199d84eb6b586ec1e892df2d193 -
Branch / Tag:
refs/tags/python-sdk-v0.1.1 - Owner: https://github.com/macols77
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python-sdk.yml@a43f668ffff13199d84eb6b586ec1e892df2d193 -
Trigger Event:
push
-
Statement type:
File details
Details for the file olive_solana_sdk-0.1.1-py3-none-any.whl.
File metadata
- Download URL: olive_solana_sdk-0.1.1-py3-none-any.whl
- Upload date:
- Size: 52.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b8471e9b9c7f759409df495829abfb51a8889c816c5eb70e0f3539ffb0628c5
|
|
| MD5 |
02fb36036f080d2601fd2e8c80ed2477
|
|
| BLAKE2b-256 |
d15a144f0de5f4f243c3708fc5666b8df3d311edb45a17b17a96887bed5eb6dd
|
Provenance
The following attestation bundles were made for olive_solana_sdk-0.1.1-py3-none-any.whl:
Publisher:
publish-python-sdk.yml on macols77/olive
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
olive_solana_sdk-0.1.1-py3-none-any.whl -
Subject digest:
7b8471e9b9c7f759409df495829abfb51a8889c816c5eb70e0f3539ffb0628c5 - Sigstore transparency entry: 2580908335
- Sigstore integration time:
-
Permalink:
macols77/olive@a43f668ffff13199d84eb6b586ec1e892df2d193 -
Branch / Tag:
refs/tags/python-sdk-v0.1.1 - Owner: https://github.com/macols77
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-python-sdk.yml@a43f668ffff13199d84eb6b586ec1e892df2d193 -
Trigger Event:
push
-
Statement type: