Skip to main content

Nukez SDK — agent-native storage with cryptographic verification

Project description

PyNukez

Persistent storage for AI agents. Store anything, get a cryptographic receipt. pynukez does not move funds — you pay out-of-band and hand us the tx signature to confirm.

PyPI Python License

pip install pynukez         # Core SDK (Solana Ed25519 envelope signing)
pip install pynukez[evm]    # + secp256k1 envelope signing for EVM-paid lockers

Requires Python 3.9+.

How it works

  1. request_storage() asks the gateway for a quote. You receive payment instructions — address, amount, asset, chain.
  2. You execute the transfer yourself — wallet, CLI, another tool, a hardware signer, whatever. pynukez does not touch your funds.
  3. confirm_storage(pay_req_id, tx_sig=<your_tx_sig>) closes the loop and returns a receipt.
  4. Use the receipt to provision a locker and upload / download / verify files.

The SDK signs API envelopes (Ed25519 for Solana-paid lockers, secp256k1 for EVM-paid lockers) so the gateway can prove requests came from the locker's owner or an authorized operator. That's all the cryptography it does.

30-Second Example

from pynukez import Nukez

client = Nukez(keypair_path="~/.config/solana/id.json")

# 1. Ask for payment instructions
request = client.request_storage(units=1)
print(request.next_step)
# -> "Transfer 0.001 SOL to <addr> on solana-devnet,
#     then call confirm_storage(pay_req_id='...', tx_sig=<your_tx_signature>)"

# 2. Execute the transfer yourself (wallet, CLI, etc.), capture the tx signature.
tx_sig = "..."  # from your wallet / RPC / CLI

# 3. Close the loop with the gateway
receipt = client.confirm_storage(request.pay_req_id, tx_sig=tx_sig)

# 4. Use the receipt
client.provision_locker(receipt.id)
urls = client.create_file(receipt.id, "notes.txt")
client.upload_bytes(urls.upload_url, b"Hello!")
data = client.download_bytes(urls.download_url)  # b"Hello!"

Async version

from pynukez import AsyncNukez

async with AsyncNukez(keypair_path="~/.config/solana/id.json") as client:
    request = await client.request_storage(units=1)
    # ... execute the transfer externally ...
    receipt = await client.confirm_storage(request.pay_req_id, tx_sig=tx_sig)
    # ... same methods as sync, just awaited

Quick Reference

What you want Code
Buy storage (quote) request = client.request_storage(units=1)
Confirm payment receipt = client.confirm_storage(request.pay_req_id, tx_sig=<your_tx_sig>)
Setup locker client.provision_locker(receipt.id)
Store bytes urls = client.create_file(receipt.id, "file.txt") then client.upload_bytes(urls.upload_url, data)
Store file client.upload_file_path(receipt.id, "/path/to/file.pdf")
Batch upload client.bulk_upload_paths(receipt.id, [{"filepath": "a.pdf"}, {"filepath": "b.txt"}])
Store directory client.upload_directory(receipt.id, "/path/to/dir", pattern="*.pdf", recursive=True)
Confirm hash client.confirm_file(receipt.id, "file.txt", confirm_url=urls.confirm_url)
Get data data = client.download_bytes(urls.download_url)
List files files = client.list_files(receipt.id)
Delete file client.delete_file(receipt.id, "file.txt")
Verify result = client.verify_storage(receipt.id)
Attest att = client.attest(receipt.id)
Merkle proof proof = client.get_merkle_proof(receipt.id, "file.txt")
Files manifest client.get_files_manifest(receipt.id)
Locker record client.get_locker_record(receipt.id)
Delegate client.add_operator(receipt.id, operator_pubkey)
Viewer link client.get_owner_viewer_url(receipt.id)

Sandboxed App Uploads

If your agent runs in a proxied app sandbox (for example, /mnt/data path restrictions), path uploads can fail even when locker auth is valid.

Use the sandbox ingest flow instead:

job = client.sandbox_create_ingest_job(
    receipt_id=receipt.id,
    files=[{"filename": "image.png", "content_type": "image/png"}],
)

client.sandbox_append_ingest_part(
    receipt_id=receipt.id,
    job_id=job["job_id"],
    file_id=job["files"][0]["file_id"],
    part_no=0,
    payload_b64="<chunk-0-base64>",
    is_last=True,
)

result = client.sandbox_complete_ingest_job(
    receipt_id=receipt.id,
    job_id=job["job_id"],
)

Convenience helpers are available:

  • client.sandbox_upload_bytes(...)
  • client.sandbox_upload_base64(...)
  • client.sandbox_upload_file_path(...)

Important: if a valid receipt_id already exists, reuse it. Do not purchase storage again unless explicitly requested.


Important

Save your receipt.id — you need it for everything.

# First time
receipt = client.confirm_storage(...)
print(receipt.id)  # Save this string somewhere!

# Later — fresh process, reconstructed client:
client.bind_receipt(receipt)          # or: bind_receipt(receipt_id=..., owner_identity=...)
files = client.list_files(receipt.id)

confirm_storage() primes per-receipt state automatically in the same process. Across kernel restarts, subprocesses, or receipts loaded from disk/DB, call bind_receipt(receipt) before owner-only ops (add_operator, remove_operator) — on dual-key clients, the SDK refuses to guess which signer to use and raises ReceiptStateNotBoundError instead.


Going to Production

Change one line:

# Devnet (testing)
client = Nukez(keypair_path="~/.config/solana/id.json", network="devnet")

# Mainnet (production)
client = Nukez(keypair_path="~/.config/solana/id.json", network="mainnet-beta")

Common Issues

Problem Fix
"Transaction not found" The tx hasn't propagated yet. Wait a few seconds and retry confirm_storage()
"URL expired" Call client.get_file_urls(receipt_id, filename) for fresh URLs
"File not found" Check client.list_files(receipt_id) to see what exists
ReceiptStateNotBoundError Call client.bind_receipt(receipt) before the op (cross-session / fresh-client flows)
AuthenticationError: Envelope sig_alg '...' incompatible with ... network Dual-key client picked wrong signer — call client.bind_receipt(receipt) first

Links


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

pynukez-4.0.0.tar.gz (114.8 kB view details)

Uploaded Source

Built Distribution

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

pynukez-4.0.0-py3-none-any.whl (97.0 kB view details)

Uploaded Python 3

File details

Details for the file pynukez-4.0.0.tar.gz.

File metadata

  • Download URL: pynukez-4.0.0.tar.gz
  • Upload date:
  • Size: 114.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pynukez-4.0.0.tar.gz
Algorithm Hash digest
SHA256 aca013e6e6dc4a706eb1474093ca073433d823b65861db314cbf051ee0c0056e
MD5 e485625c2ebb0b4cbdbdc8d909d8702a
BLAKE2b-256 b0210829a7e71a4cc5b683029eeca069e43e87fa81f4957a11fab7576b576629

See more details on using hashes here.

Provenance

The following attestation bundles were made for pynukez-4.0.0.tar.gz:

Publisher: publish.yml on ZlaylowZ/pynukez

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pynukez-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: pynukez-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 97.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pynukez-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbe1ac4cd5075bafcacf4ad3507a80fae3f5026215ce342f3dc4a5fe10470c17
MD5 b23c76d614628df97cf608c0ee08242a
BLAKE2b-256 49bfe6854588dfc5f583991e8159947c06cb0403f4af89e84a7ad703b8576499

See more details on using hashes here.

Provenance

The following attestation bundles were made for pynukez-4.0.0-py3-none-any.whl:

Publisher: publish.yml on ZlaylowZ/pynukez

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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