Skip to content

Draft: refresh SDK and daemon docs for current setup, retrieval, and storage flow#7

Draft
JimCollinson wants to merge 7 commits intomainfrom
docs/ant-sdk-drift-2026-04-07
Draft

Draft: refresh SDK and daemon docs for current setup, retrieval, and storage flow#7
JimCollinson wants to merge 7 commits intomainfrom
docs/ant-sdk-drift-2026-04-07

Conversation

@JimCollinson
Copy link
Copy Markdown
Collaborator

@JimCollinson JimCollinson commented Apr 7, 2026

Summary

  • refresh daemon setup, run-as-daemon, and mainnet guidance for the current direct-wallet and external-signer configuration
  • update the REST, gRPC, MCP, and JavaScript SDK reference pages for current upload response fields, payment_vault_address, and daemon timeout/concurrency flags
  • restructure the SDK and daemon getting-started flow so readers can start antd read-only, retrieve existing data from the network first, then branch into default-network writes, external signers, or a local devnet
  • add a dedicated Retrieve Data from the Network Getting Started page and wire it into navigation and the deeper read-only guide
  • rename the onboarding pages and cross-links so the sequence now reads cleanly as Build with the SDKs -> Start the Local Daemon -> Retrieve Data from the Network -> Store Data on the Network -> Use the CLI -> Build Directly in Rust
  • update embed-a-node.md, manage-keys.md, and related guides to match the current ant-node crate release and CLI usage

Why

Recent merged ant-sdk, ant-client, and ant-node changes moved these docs out of sync around payment vault configuration, upload result models, daemon runtime options, and the practical onboarding flow for the SDK route. This draft PR brings the technical details back in line with merged truth and makes the first-run daemon path progress from health check to retrieval before upload payment choices, without inventing an install path that does not exist yet.

Source Refs

  • ant-sdk: bf541ccd4ae1fd3e174fb7b5bb21deef38d999ce
  • ant-client: eb29e99937b1aedba02db04e1ae59bd923b424a3
  • ant-node: d3f5ba969b8ccf98ca0c50b661a3762aec904634

Review Focus

  • confirm EVM_PAYMENT_VAULT_ADDRESS now replaces the older daemon payment env names everywhere this batch touches
  • confirm file and directory upload responses plus prepare and finalize examples match the current REST, gRPC, and MCP behavior
  • confirm the ant-node crate version, custom EVM note, and ant CLI invocation examples reflect the merged source-of-truth behavior
  • confirm the getting-started flow now separates source-build requirements from optional upload configuration, exposes a clear read-only retrieval branch, and uses clearer page titles and link labels throughout the onboarding sequence

Bring the daemon, external-signer, and reference pages back in line with merged ant-sdk and ant-node changes so reviewers can assess the current behavior from one draft PR.
@JimCollinson JimCollinson changed the title Update SDK signer docs and node embed guidance Draft: refresh SDK and daemon docs for current upload and config flow Apr 16, 2026
@JimCollinson JimCollinson marked this pull request as draft April 16, 2026 12:41
@JimCollinson
Copy link
Copy Markdown
Collaborator Author

@claude Please review this draft PR against current merged truth in ant-sdk, ant-client, and ant-node.
Focus on:

  • factual accuracy of the docs changes
  • incorrect or stale env var names, field names, commands, or examples
  • missing doc updates that should have been included in this batch
  • whether any changed verification blocks look wrong or incomplete
    Please pay particular attention to:
  • EVM_PAYMENT_VAULT_ADDRESS replacing older daemon payment env names
  • REST, gRPC, and MCP upload response fields
  • external-signer prepare/finalize flow, including payment_type, payment_vault_address, tx_hashes, and winner_pool_hash
  • ant CLI invocation examples and flag ordering
  • embed-a-node.md guidance, including the ant-node crate version and custom EVM config note
    Please give findings first, with file paths and line references where possible. If you find no issues, say that explicitly and mention any residual risks or gaps.

@claude
Copy link
Copy Markdown

claude bot commented Apr 16, 2026

Claude encountered an error —— View job


PR Review in Progress

  • Read all 12 changed files
  • Check git diff against origin/main
  • Verify EVM_PAYMENT_VAULT_ADDRESS usage across changed files
  • Verify REST, gRPC, MCP upload response fields
  • Verify external-signer prepare/finalize flow fields
  • Verify ant CLI invocation examples and flag ordering
  • Verify embed-a-node.md crate version and EVM config note
  • Check verification blocks for correctness
  • Compile findings and post review

Document the wave-batch versus Merkle chunk threshold and the fixed candidate count in pool commitments so integrators can predict and validate the two-phase payment flow.
Keep the source-build truth for antd, but lead readers through read-only startup before branching into default-network writes or a local devnet so the getting-started flow stays clear and gradual.
@JimCollinson JimCollinson changed the title Draft: refresh SDK and daemon docs for current upload and config flow Draft: refresh SDK and daemon docs for current setup and upload flow Apr 16, 2026
Introduce a read-only Getting Started page, wire it into the daemon flow, and make retrieval the first follow-on before upload setup so the SDK route progresses from health check to retrieval before payment decisions.
Rename the Getting Started pages around the SDK, CLI, Rust, daemon, retrieval, and write flows so the sequence reads cleanly, and clarify that read-only retrieval needs an existing public address unless you create one first.
@JimCollinson JimCollinson changed the title Draft: refresh SDK and daemon docs for current setup and upload flow Draft: refresh SDK and daemon docs for current setup, retrieval, and storage flow Apr 16, 2026
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