Nukez SDK — agent-native storage with cryptographic verification
Project description
PyNukez
Persistent storage for AI agents. Store anything, receive a cryptographic receipt, and confirm payment with the transaction signature from your own wallet, CLI, or signing workflow. PyNukez never executes transfers or takes custody of keys.
pip install pynukez
Native support for both Solana and Monad blockchains. Thus, this includes support for Ed25519 and secp256k1 keypairs. The entire PyNukez library is designed and built for direct integration with agentic systems. The landmark agentic storage protocol is optimized for use by autonomous agents. Compatible with any model provider, agentic platform, or other integrations.
Requires Python 3.9+.
How it works
request_storage()asks the gateway for a quote. You receive payment instructions — address, amount, asset, chain.- You execute the transfer with your own wallet, CLI, hardware signer, or signing workflow. PyNukez never touches funds or custody keys.
confirm_storage(pay_req_id, tx_sig=<your_tx_sig>)closes the loop and returns a receipt.- Use the receipt to provision a locker and upload / download / verify files.
The PyNukez SDK does not execute blockchain payments. That boundary is intentional: payment keys stay in the wallet, CLI, signer, or custody system you choose. Please visit https://nukez.xyz/docs/pynukez/helpers for examples and external helpers to facilitate cryptographic operations for agentic workflows.
30-Second Example
from pynukez import Nukez
# Instantiate an instance of the Nukez class.
# keypair_path is optional. When set, PyNukez uses this local keypair only
# to sign gateway envelopes for protected locker/file calls; PyNukez does
# not use it to execute cryptographic payment transfers.
client = Nukez(
keypair_path="~/.config/solana/id.json", # optional local signer path
)
# Request the x402 payment instructions from the Nukez gateway.
# Pass the preferred storage provider and quantity of storage units.
# If no storage provider is set, PyNukez defaults to "gcs".
request = client.request_storage(units=1, provider="gcs")
# Print details for next step
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", # optional local signer path
) 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") |
| Receipt hash | check = client.verify_receipt_hash(receipt.id) |
| 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
- Full SDK Reference — Every method, type, and error documented
- Examples — Working code you can copy
- PyPI — Published releases
- GitHub — Source code, issues, releases
- Contributing — Dev setup and PR workflow
License
MIT
Project details
Release history Release notifications | RSS feed
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 pynukez-4.0.7.tar.gz.
File metadata
- Download URL: pynukez-4.0.7.tar.gz
- Upload date:
- Size: 126.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a0753e940eff89d9b7c6934cbda3ed4badd1785d1fa02375569373468a5c0b89
|
|
| MD5 |
97efb0c1f887556d6fbbfe42bb5ce16e
|
|
| BLAKE2b-256 |
604b3c6716dc12ff7a997acaefc39ab8c38d4ab051529a39405293e0bf29beba
|
Provenance
The following attestation bundles were made for pynukez-4.0.7.tar.gz:
Publisher:
publish.yml on Nukez-xyz/pynukez
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pynukez-4.0.7.tar.gz -
Subject digest:
a0753e940eff89d9b7c6934cbda3ed4badd1785d1fa02375569373468a5c0b89 - Sigstore transparency entry: 1435933221
- Sigstore integration time:
-
Permalink:
Nukez-xyz/pynukez@d2659f045799e401c8418ce1435cbb2f28614e36 -
Branch / Tag:
refs/tags/v4.0.7 - Owner: https://github.com/Nukez-xyz
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@d2659f045799e401c8418ce1435cbb2f28614e36 -
Trigger Event:
release
-
Statement type:
File details
Details for the file pynukez-4.0.7-py3-none-any.whl.
File metadata
- Download URL: pynukez-4.0.7-py3-none-any.whl
- Upload date:
- Size: 104.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82003f218dd3d41ec1eb8a3dadcbdd3887d3ffdec52f161d12b4305515a683e0
|
|
| MD5 |
e3faf887be7f19eb7d4754e9fb7936b3
|
|
| BLAKE2b-256 |
6472710d14ff7fc964fbf3fe1ace6b211bcc020558f859d5ee47b69f4988560f
|
Provenance
The following attestation bundles were made for pynukez-4.0.7-py3-none-any.whl:
Publisher:
publish.yml on Nukez-xyz/pynukez
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
pynukez-4.0.7-py3-none-any.whl -
Subject digest:
82003f218dd3d41ec1eb8a3dadcbdd3887d3ffdec52f161d12b4305515a683e0 - Sigstore transparency entry: 1435933227
- Sigstore integration time:
-
Permalink:
Nukez-xyz/pynukez@d2659f045799e401c8418ce1435cbb2f28614e36 -
Branch / Tag:
refs/tags/v4.0.7 - Owner: https://github.com/Nukez-xyz
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@d2659f045799e401c8418ce1435cbb2f28614e36 -
Trigger Event:
release
-
Statement type: