Add docs/sdks.md — public overview of the SDK suite#3
Add docs/sdks.md — public overview of the SDK suite#3pimfeltkamp wants to merge 5 commits intomainfrom
Conversation
Single-page reference documenting the six official language SDKs and the CLI: install commands, auth snippet per language, shared error taxonomy, rate-limit behaviour, tag-prefix conventions, and the minimum runtimes each SDK targets. Cross-links to VERSIONING.md and the OpenAPI spec. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Cryptohopper now ships seven language SDKs. The Dart SDK matches the Ruby/Rust/PHP shape with full coverage of all 18 public API domains from day one and is published from cryptohopper-dart-sdk. Also bumps the CLI's listed version from 0.5.0-alpha.1 to 0.5.1-alpha.1 to reflect the security fix that landed in the previous loop iteration. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Cryptohopper now ships eight language SDKs. The Swift SDK is consumed via Swift Package Manager directly from the git tag (no central registry), same publishing pattern as Go. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The CLI shipped 0.6.0-alpha.1 in the previous iteration with new strategy + exchange-catalog commands. Keep the table in sync. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Pre-existing SDKs in the org I missedWhile auditing the org for iter-41, I discovered three public repos that overlap with what
Overlap with this PR's content
Suggested follow-ups (separate PRs, your call which to land)
I deliberately didn't make these changes here to avoid forcing a re-review of an already-reviewed PR. Happy to follow up with separate PRs once you confirm the positioning. Action also relevant to this PR's other audiences
|
Merge-order note: version column will be stale after the auth-fix releases shipThe "Version" column lists
Plus the Two options
I'd lean (1) — the bookkeeping is small and the install commands stay safe. Happy to do (2) if you'd rather batch it. Or (3): drop the version column entirely and rely on the registry-link badges next to each package name to show the current version automatically. (3) is the most maintenance-free option — let me know if you want me to push a commit for it. I deliberately didn't unilaterally amend this PR — the choice between (1)/(2)/(3) depends on whether you'd rather optimise for review-time or for long-term doc maintenance. Cross-reference |
The new cryptohopper-kotlin-sdk lands at parity with the other official SDKs (full coverage of all 18 public API domains, same error taxonomy, OkHttp transport, kotlinx.coroutines). Adds: - Kotlin row to the at-a-glance table (com.cryptohopper:cryptohopper) - 'Cryptohopper ships official clients for nine languages' (was eight) - 'sent in the access-token HTTP header' added to the intro paragraph so readers don't have to hunt for the header name - Install snippets for Dart, Swift, and Kotlin in the Installing block Cross-reference: see https://github.com/cryptohopper/cryptohopper-kotlin-sdk for the new SDK.
|
Pushed a follow-up commit adding the new Same merge-order note from earlier still applies: the version column is alpha.1 across the board; will need a follow-up bump to alpha.2 after the auth-fix releases ship. |
1 participant
Summary
Creates
docs/sdks.mdas the single public landing page for the six language SDKs and the CLI.Why
New — no existing doc covers the SDK suite as a whole. Third-party devs either browse the org page or guess at registry names. This doc:
Test plan
Follow-ups (not this PR)