Repository navigation
Rewrite the README for the 3.0 alpha - #51
Merged
Merged
Conversation
… quick start that runs, timeouts, errors, retries, amounts and what isn't covered yet.
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites the README for the 3.0 alpha. The README on
mainstill described 2.x (BitGoSDK,BitGoExpress,CurrencyCode, PHP 7.4), and none of its examples could run againstmain. Packagist shows the README of a tag, so it has to be right before3.0.0-alpha.1.What it covers
2.xbranch README.composer require neto737/bitgosdk-php:^3.0@alpha guzzlehttp/guzzle, and what happens when Composer asks to trustphp-http/discovery(see ADR 0003).Config::testnet(),new BitGo(),coin(),wallet(),get(), then creating and listing addresses.extra,CoinCode, pagination,Amount, errors (with a table of the exceptions), retries,lastResponse(), receiving webhooks, and security notes.cURL error 60, which PHP on Windows often hits with no CA bundle, and how to fix it without turning verification off.composer checkwith Rector, the mock PSR-18 client anddocs/adr/.Credits, the support section and the license are unchanged.
How the examples were checked
$data['balanceString']read that needed?? '0', since the field is optional in the documented shape.AuthenticationExceptionin all three.Docs only, so there's no CHANGELOG entry.