Skip to content

Rewrite the README for the 3.0 alpha - #51

Merged
neto737 merged 1 commit into
mainfrom
docs/3.0-alpha-readme
Oct 30, 2026
Merged

neto737 merged 1 commit into
mainfrom
docs/3.0-alpha-readme

Conversation

@neto737

@neto737 neto737 commented Oct 30, 2026

Copy link
Copy Markdown
Owner

Rewrites the README for the 3.0 alpha. The README on main still described 2.x (BitGoSDK, BitGoExpress, CurrencyCode, PHP 7.4), and none of its examples could run against main. Packagist shows the README of a tag, so it has to be right before 3.0.0-alpha.1.

What it covers

  • Pre-release warning: this is an alpha and its API may change. It can't send coins yet. Production users stay on 2.3.x, and the warning links to the 2.x branch README.
  • Install: composer require neto737/bitgosdk-php:^3.0@alpha guzzlehttp/guzzle, and what happens when Composer asks to trust php-http/discovery (see ADR 0003).
  • Quick start: Config::testnet(), new BitGo(), coin(), wallet(), get(), then creating and listing addresses.
  • Setting a timeout: passing your own Guzzle or Symfony client. A discovered Guzzle client has no timeout.
  • What's covered, as a table of every handle and verb, plus what isn't in the alpha yet.
  • Usage: arguments and extra, CoinCode, pagination, Amount, errors (with a table of the exceptions), retries, lastResponse(), receiving webhooks, and security notes.
  • TLS: a note on cURL error 60, which PHP on Windows often hits with no CA bundle, and how to fix it without turning verification off.
  • Contributing: updated for composer check with Rector, the mock PSR-18 client and docs/adr/.

Credits, the support section and the license are unchanged.

How the examples were checked

  • Every usage example ran in order against a mock PSR-18 client, and each sent the request it describes.
  • PHPStan level 8 is clean on the examples. This caught one $data['balanceString'] read that needed ?? '0', since the field is optional in the documented shape.
  • The timeout examples ran against BitGo testnet with real Guzzle 7 and Symfony HttpClient, and with a client found by discovery. A fake token got BitGo's 401 as an AuthenticationException in all three.
  • No 2.x class or method appears in any example.

Docs only, so there's no CHANGELOG entry.

… quick start that runs, timeouts, errors, retries, amounts and what isn't covered yet.
@codecov

codecov Bot commented Oct 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (d56b1a4) to head (8f6ab12).

Additional details and impacted files
@@             Coverage Diff             @@
##                main       #51   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       159       159           
===========================================
  Files             16        16           
  Lines            370       370           
===========================================
  Hits             370       370           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@neto737
neto737 merged commit 2e77ced into main Oct 30, 2026
13 checks passed
@neto737
neto737 deleted the docs/3.0-alpha-readme branch October 30, 2026 07:35
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