Skip to content

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

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

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

Conversation

@Nic-dorman

Copy link
Copy Markdown
Collaborator

Summary

Adds 7 new methods on Antd::GrpcClient mirroring the existing REST Antd::Client external-signer surface. Consumers can now swap Antd::Client for Antd::GrpcClient without code change in the prepare/finalize flow.

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

Methods

method purpose
prepare_upload(path, visibility:) external-signer prepare for a file
prepare_upload_public(path) convenience wrapper for visibility: "public"
prepare_data_upload(data, visibility:) 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:) finalize merkle-batch upload
prepare_chunk_upload(data) single-chunk external-signer prepare
finalize_chunk_upload(upload_id, tx_hashes) single-chunk finalize, returns address

Proto regen

grpc_tools_ruby_protoc -I../antd/proto --ruby_out=lib --grpc_out=lib antd/v1/{common,health,data,chunks,files,upload}.proto:

  • New upload_pb.rb / upload_services_pb.rb.
  • chunks_pb.rb / chunks_services_pb.rb gain PrepareChunk / FinalizeChunk.
  • common_pb.rb adds PaymentEntry.

Implementation notes

  • New @upload_stub = Antd::V1::UploadService::Stub.new(...) field on GrpcClient.
  • Private build_prepare_upload_result(resp) helper maps PrepareUploadResponse proto into the existing PrepareUploadResult struct, populating merkle-only fields (depth, pool_commitments, merkle_payment_timestamp) only when payment_type == "merkle".

Tests

test/test_grpc_client.rb:

  • FakeGrpc::ChunkStub gains prepare_chunk (new + already-stored short-circuit) and finalize_chunk (echoes upload_id into address).
  • New FakeGrpc::UploadStub covers prepare_file_upload / prepare_data_upload / finalize_upload with visibility round-trip via upload_id encoding and merkle vs wave-batch branches.
  • build_fake_client / build_error_client updated to inject @upload_stub.
  • 12 new test cases parallel to the antd-rust / antd-go / antd-py / antd-java / antd-kotlin / antd-csharp suites.

Gates on dev2

  • All 12 new tests pass
  • Pre-existing baseline has 4 failures in the cost mocks (test_data_cost, test_file_cost, etc.) where the fake cost stub returns a partial OpenStruct; unrelated to this PR (verified by running tests on the parent commit).

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

Adds 7 new methods on `Antd::GrpcClient` mirroring the existing REST
`Antd::Client` external-signer surface:

* `prepare_upload(path, visibility:)` / `prepare_upload_public(path)`
* `prepare_data_upload(data, visibility:)`
* `finalize_upload(upload_id, tx_hashes)` (wave-batch)
* `finalize_merkle_upload(upload_id, winner_pool_hash, store_data_map:)`
* `prepare_chunk_upload(data)` / `finalize_chunk_upload(upload_id, tx_hashes)`

Consumers can now swap `Antd::Client` for `Antd::GrpcClient` without
code change in the external-signer flow.

Proto regen:

* `grpc_tools_ruby_protoc -I../antd/proto --ruby_out=lib --grpc_out=lib
  antd/v1/{common,health,data,chunks,files,upload}.proto`
* New `upload_pb.rb` / `upload_services_pb.rb`. `chunks_pb.rb` /
  `chunks_services_pb.rb` gain `PrepareChunk` / `FinalizeChunk`
  messages and RPCs. `common_pb.rb` adds `PaymentEntry`.

Client (`lib/antd/grpc_client.rb`):

* New `@upload_stub = Antd::V1::UploadService::Stub.new(...)` field.
* Private `build_prepare_upload_result(resp)` helper maps the
  `PrepareUploadResponse` proto into the `PrepareUploadResult` struct,
  populating the merkle-only fields (`depth`, `pool_commitments`,
  `merkle_payment_timestamp`) only when `payment_type == "merkle"`.

Tests (`test/test_grpc_client.rb`):

* `FakeGrpc::ChunkStub` gains `prepare_chunk` (new + already-stored
  short-circuit) and `finalize_chunk` (echoes `upload_id`).
* New `FakeGrpc::UploadStub` covers `prepare_file_upload` /
  `prepare_data_upload` / `finalize_upload` with visibility round-trip
  via `upload_id` encoding and merkle vs wave-batch branches.
* `build_fake_client` / `build_error_client` updated to inject
  `@upload_stub`.
* 12 new test cases parallel to the antd-rust / antd-go / antd-py /
  antd-java / antd-kotlin / antd-csharp suites.

Gates on dev2:

* `bundle exec ruby -Ilib -Itest test/test_grpc_client.rb` — 12 new
  cases pass; 4 pre-existing baseline failures in the cost mocks are
  unrelated to this PR (verified by running on the parent commit).

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 f67bdea into main May 28, 2026
@Nic-dorman
Nic-dorman deleted the nic/v2-284-antd-ruby-grpc-external-signer branch May 28, 2026 16:53
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