Skip to content

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

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

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

Conversation

@Nic-dorman

Copy link
Copy Markdown
Collaborator

Summary

Adds 7 new methods on GrpcClient mirroring the existing REST Client's external-signer surface, so consumers can swap a REST Client for a GrpcClient without code change in the prepare/finalize flow.

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

Methods added

method purpose
PrepareUpload(ctx, path) external-signer prepare for a file (private)
PrepareUploadPublic(ctx, path) external-signer prepare for a file, DataMap bundled
PrepareDataUpload(ctx, data) external-signer prepare for in-memory bytes
FinalizeUpload(ctx, uploadID, txHashes, storeDataMap) finalize wave-batch upload
FinalizeMerkleUpload(ctx, uploadID, winnerPoolHash, storeDataMap) finalize merkle-batch upload
PrepareChunkUpload(ctx, content) single-chunk external-signer prepare
FinalizeChunkUpload(ctx, uploadID, txHashes) single-chunk finalize, returns address

Proto regen

All .pb.go files regenerated under antd-go/proto/antd/v1/:

  • New upload.pb.go + upload_grpc.pb.go
  • chunks.pb.go + chunks_grpc.pb.go gain PrepareChunk / FinalizeChunk shapes
  • common.pb.go adds PaymentEntry
  • Other files: header-only version diff from regenerating with the current protoc

Implementation notes

  • New upload pb.UploadServiceClient field on GrpcClient, constructed in NewGrpcClient.
  • prepareResponseToResult helper maps proto PrepareUploadResponse to the REST-style *PrepareUploadResult, populating merkle fields (Depth, PoolCommitments, MerklePaymentTimestamp) only when payment_type == "merkle".

Tests

  • mockChunkService gains PrepareChunk (new + already-stored short-circuit) and FinalizeChunk (echoes upload_id into address).
  • New mockUploadService covers wave-batch + merkle response shapes, visibility round-trip via upload_id encoding, and store_data_map true/false branches.
  • 12 new Test* cases parallel to the antd-rust suite, covering visibility forwarded/omitted, wave-batch vs merkle, data_map_address presence on public, merkle store_data_map toggle, chunk already-stored short-circuit, and chunk finalize body forwarding.

Gates passed on dev2

  • go vet clean
  • golangci-lint run --timeout 5m clean
  • gofmt -l — clean on touched files (models.go has pre-existing nits unrelated to this PR)
  • go test -race -count=1 — all pass
  • govulncheck — no new vulnerabilities

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

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

* `PrepareUpload(ctx, path)` / `PrepareUploadPublic(ctx, path)`
* `PrepareDataUpload(ctx, data)`
* `FinalizeUpload(ctx, uploadID, txHashes, storeDataMap)` (wave-batch)
* `FinalizeMerkleUpload(ctx, uploadID, winnerPoolHash, storeDataMap)`
* `PrepareChunkUpload(ctx, content)` / `FinalizeChunkUpload(ctx, uploadID, txHashes)`

All call into the new `UploadService` and the extended `ChunkService`
RPCs added on the daemon side. Consumers can swap a REST `Client` for a
`GrpcClient` without code change in the external-signer flow.

Proto regen:

* All `.pb.go` files regenerated under `antd-go/proto/antd/v1/`. New
  `upload.pb.go` + `upload_grpc.pb.go`; `chunks.pb.go` + `chunks_grpc.pb.go`
  gain `PrepareChunk` / `FinalizeChunk` shapes; `common.pb.go` adds
  `PaymentEntry`. Other files: header-only version diff.

Client (`grpc_client.go`):

* New `upload pb.UploadServiceClient` field on `GrpcClient`, constructed in
  `NewGrpcClient`.
* `prepareResponseToResult` helper maps proto `PrepareUploadResponse` to the
  REST-style `*PrepareUploadResult`, only populating merkle fields
  (`Depth`, `PoolCommitments`, `MerklePaymentTimestamp`) when
  `payment_type == "merkle"`.

Tests (`grpc_client_test.go`):

* `mockChunkService` gains `PrepareChunk` / `FinalizeChunk` (new + already-stored
  short-circuit + echo upload_id).
* New `mockUploadService` covers wave-batch + merkle response shapes,
  visibility round-trip via upload_id encoding, and `store_data_map`
  true/false branches.
* 12 new `Test*` cases parallel to the antd-rust suite, covering visibility
  forwarded/omitted, wave-batch vs merkle, data_map_address presence,
  merkle store_data_map toggle, chunk already-stored short-circuit, and
  chunk finalize body forwarding.

Gates passed on dev2:

* `go vet` clean
* `golangci-lint run` clean
* `go test -race -count=1` — all pass (new tests + existing)
* `govulncheck` — no new vulnerabilities (3 pre-existing transitive,
  none called by our code)

Depends on the antd-side PR (UploadService + chunks prepare/finalize) to
land first so consumers building from a published antd binary get the
matching wire shape.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Nic-dorman
Nic-dorman merged commit f01ad5d into main May 28, 2026
4 checks passed
@Nic-dorman
Nic-dorman deleted the nic/v2-284-antd-go-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