Skip to content

feat(antd-py): gRPC external-signer prepare/finalize parity with REST - #171

Merged
Nic-dorman merged 1 commit into
mainfrom
nic/v2-284-antd-py-grpc-external-signer
May 28, 2026
Merged

feat(antd-py): gRPC external-signer prepare/finalize parity with REST#171
Nic-dorman merged 1 commit into
mainfrom
nic/v2-284-antd-py-grpc-external-signer

Conversation

@Nic-dorman

Copy link
Copy Markdown
Collaborator

Summary

Replaces the three NotImplementedError stubs on GrpcClient / AsyncGrpcClient for prepare_upload / prepare_data_upload / finalize_upload with real implementations, and adds four new methods mirroring the REST client surface. Sync + async parity.

Depends on #140 (antd-side UploadService + chunks prepare/finalize).

Methods

method purpose
prepare_upload(path, visibility=None) external-signer prepare for a file
prepare_upload_public(path) convenience wrapper for visibility="public"
prepare_data_upload(data, visibility=None) external-signer prepare for in-memory bytes
finalize_upload(upload_id, tx_hashes) finalize wave-batch upload
finalize_merkle_upload(upload_id, winner_pool_hash, store_data_map=False) finalize merkle-batch upload
prepare_chunk_upload(data) single-chunk external-signer prepare
finalize_chunk_upload(upload_id, tx_hashes) -> str single-chunk finalize, returns address

14 total method impls (7 each on sync and async clients).

Wallet stubs (wallet_address / wallet_balance / wallet_approve) are out of scope here — they belong to the separate WalletService-over-gRPC work and will land in a follow-up PR.

Proto regen

python scripts/generate_proto.py regenerated all stubs under src/antd/_proto/antd/v1/:

  • New upload_pb2.py / upload_pb2.pyi / upload_pb2_grpc.py
  • chunks_pb2.* gain PrepareChunk / FinalizeChunk
  • common_pb2.* adds PaymentEntry
  • Other *_pb2_grpc.py files: header-only protobuf-version diff

Implementation notes

  • New self._upload = upload_pb2_grpc.UploadServiceStub(...) field on both clients.
  • Helpers _prepare_upload_result_from_resp, _finalize_upload_result_from_resp, _prepare_chunk_result_from_resp map proto messages to the existing REST-style dataclasses. Merkle fields (depth, pool_commitments, merkle_payment_timestamp) populated only when payment_type == "merkle".

Tests

New tests/test_grpc_client.py:

  • In-process mock servers: grpc.server (sync) and grpc.aio.server (async), one per test on random 127.0.0.1:0 port.
  • MockChunkServicer covers PrepareChunk (new + already-stored) and FinalizeChunk (echo upload_id).
  • New MockUploadServicer covers PrepareFileUpload / PrepareDataUpload / FinalizeUpload with visibility round-trip via upload_id encoding and merkle vs wave-batch branches.
  • 20 test cases parallel to the antd-rust / antd-go suites.

Gates passed on dev2

  • pytest tests/ — 81/81 passing (61 existing + 20 new)
  • antd-py has no CI workflow and no ruff/mypy config in pyproject.toml; the dev2 sweep is the gate (per project convention).
  • Pre-existing E402 warnings in _grpc.py (imports after helpers) are the file's prior style; not introduced by this PR.

Supersedes #143 (force-push after daemon merge auto-closed the original PR).

Replaces the three `NotImplementedError` stubs on `GrpcClient` /
`AsyncGrpcClient` for `prepare_upload` / `prepare_data_upload` /
`finalize_upload` with real implementations, and adds four new methods
mirroring the REST client surface:

* `prepare_upload(path, visibility=None)` + `prepare_upload_public(path)`
* `prepare_data_upload(data, visibility=None)`
* `finalize_upload(upload_id, tx_hashes)` (wave-batch)
* `finalize_merkle_upload(upload_id, winner_pool_hash, store_data_map=False)`
* `prepare_chunk_upload(data)` (new, no prior stub)
* `finalize_chunk_upload(upload_id, tx_hashes) -> str` (new)

Sync + async parity (14 method impls total).

Wallet stubs (`wallet_address` / `wallet_balance` / `wallet_approve`) are
out of scope here — they belong to the separate WalletService-over-gRPC
work and will land in a follow-up.

Proto regen:

* `python scripts/generate_proto.py` regenerated all stubs under
  `src/antd/_proto/antd/v1/`. New `upload_pb2.py` / `upload_pb2.pyi` /
  `upload_pb2_grpc.py`. `chunks_pb2.*` gain `PrepareChunk` /
  `FinalizeChunk`. `common_pb2.*` adds `PaymentEntry`. Other `*_pb2_grpc.py`
  files have header-only protobuf-version diffs.

Client (`src/antd/_grpc.py`):

* New `self._upload = upload_pb2_grpc.UploadServiceStub(...)` field on
  both clients.
* Helpers `_prepare_upload_result_from_resp`, `_finalize_upload_result_from_resp`,
  `_prepare_chunk_result_from_resp` map proto messages to the existing
  REST-style dataclasses. Merkle fields (`depth`, `pool_commitments`,
  `merkle_payment_timestamp`) populated only when `payment_type == "merkle"`.

Tests (`tests/test_grpc_client.py`):

* New file: in-process mock servers using `grpc.server` (sync) and
  `grpc.aio.server` (async). `MockChunkServicer` covers
  `PrepareChunk` / `FinalizeChunk`; new `MockUploadServicer` covers
  `PrepareFileUpload` / `PrepareDataUpload` / `FinalizeUpload`.
* 20 test cases parallel to the antd-rust / antd-go suites, covering
  visibility forwarded/omitted, wave-batch vs merkle, `data_map_address`
  presence on public, merkle `store_data_map` toggle, chunk already-stored
  short-circuit, chunk finalize body forwarding. Both sync and async
  paths.

Gates on dev2:

* `pytest tests/` — 81/81 passing (61 existing + 20 new).
* No ruff/mypy config exists in the project (dev2 sweep is the gate);
  pytest is the only enforced check.

Depends on the antd-side daemon PR landing first.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Nic-dorman
Nic-dorman merged commit 1ffc132 into main May 28, 2026
@Nic-dorman
Nic-dorman deleted the nic/v2-284-antd-py-grpc-external-signer branch May 28, 2026 16:52
Nic-dorman added a commit that referenced this pull request May 28, 2026
Closes the gRPC parity gap with REST: external-signer (UploadService +
chunks PrepareChunk/FinalizeChunk) and WalletService are now reachable
over gRPC, plus stream-download stubs return honest UNIMPLEMENTED/501
instead of pretending. All 11 gRPC-capable SDKs follow with matching
fan-out.

## Additive (antd daemon)

- gRPC UploadService + chunks prepare/finalize — external-signer two-phase
  upload + single-chunk publish over gRPC, mirroring REST 1:1 (#140)
- gRPC WalletService — GetAddress / GetBalance / Approve, parity with
  REST /v1/wallet/* (#154)
- /v1/data/prepare now honors visibility for public DataMap chunk
  bundling via data_prepare_upload_with_visibility (#138)

## Fixes (antd daemon)

- Stream-download stubs (DataServiceStub.StreamDownload, REST
  /v1/data/stream/*) now return UNIMPLEMENTED / 501 honestly rather
  than empty success (#155)

## SDK fan-out — external-signer (gRPC prepare/finalize)

All 11 gRPC-capable SDKs replace their stub raises with real gRPC calls
to the new UploadService + ChunkService PrepareChunk/FinalizeChunk RPCs:

- antd-rust (#169), antd-go (#170), antd-py (#171), antd-java (#172),
  antd-kotlin (#173), antd-csharp (#174), antd-ruby (#175),
  antd-dart (#176), antd-swift (#177), antd-cpp (#178),
  antd-elixir (#179)

## SDK fan-out — WalletService

Same 11 SDKs gain walletAddress / walletBalance / walletApprove over gRPC:

- antd-rust (#180), antd-go (#181), antd-py (#182), antd-java (#183),
  antd-kotlin (#184), antd-csharp (#185), antd-ruby (#186),
  antd-dart (#187), antd-swift (#188), antd-cpp (#189),
  antd-elixir (#190)

## SDK examples + build fixes

- antd-ruby: payForQuotes tuple args as Hash for eth-0.5.13
  compatibility (#131)
- antd-go + ant-dev: add 03-chunks + 06-private-data examples;
  renumber 03-files to 04-files (#132)
- antd-java + antd-cpp: close async client surface gaps (#133)
- ant-dev: pull antd[rest,grpc] extras so 08_grpc example runs out
  of the box (#134)
- antd-js + antd-py + antd-go READMEs: surface external-signer
  methods + 07 example (#135)
- antd-elixir: 07_external_signer example via cast shell-out (#136)
- antd-swift: 07_external_signer example + fix FinalizeUploadDTO
  optional address (#137)
- antd-php: empty tx_hashes serializes as JSON object on finalize
  (#139)

## FFI

- ant-ffi refresh against current ant-core API + Swift xcframework
  build pipeline (#150)
- Android AAR build pipeline (#156)

## Infra

- CI: auto-tag Go submodules on umbrella release tag push (#129)
- Deploy: publish multi-arch withautonomi/antd image from ant-sdk
  release (#130)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant