-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Update xrpl-dev-portal to use xrpl-py 2.0 #1933
Conversation
Link check report. 467248 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467248 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467248 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
How does this PR relate to #1639? Is this a companion or replacement for that one? |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
@mDuo13 This would be a replacement for that PR. I didn't realize we'd created a renamed |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
2 similar comments
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
2 similar comments
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467249 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
I went through and ran every modified snippet to verify they would work with xrpl-py-2.0. All did what was expected (noticed a couple small fixes doing that which were in the last couple commits) |
Link check report. 467253 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467253 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467253 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 467253 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
Link check report. 495049 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks very thorough and nicely showcases the improvements in xrpl-py 2.0. I removed one import that was rendered redundant by the changes; otherwise, looks great!
Link check report. 495071 links checked. Preview: https://XRPLF.github.io/xrpl-dev-portal/pr-preview/xrpl-py-2.0/ |
In preparation for breaking changes to the xrpl-py library, this PR updates the code samples & tutorials in order to follow new best practices.
This should NOT be merged until xrpl-py 2.0 is released. (This will be set as a draft PR until that point)
This PR may be most digestible if read on a commit-by-commit basis. Most commits only migrate one of these breaking changes.
Breaking Changes
Updates to function names for signing/submitting:
send_reliable_submission
is nowsubmit_and_wait
submit_and_wait
can also handle theautofill
andsign
steps automatically (similar to howsubmit_and_wait
works with xrpl.js)submit_transaction
is nowsubmit
safe_sign_and_submit_transaction
is nowsign_and_submit
wallet
parameter here has been moved afterclient
to be consistent withsubmit_and_wait
safe_sign_transaction
is nowsign
safe_sign_and_autofill_transaction
is nowautofill_and_sign
wallet
parameter here has been moved afterclient
to be consistent withsubmit_and_wait
Wallet
Classsequence
fieldclassic_address
toaddress
and made it read-onlyAccountSetFlags
AccountSetAsfFlags
now contains Account Set Flags with theASF...
prefix.AccountSetFlags
now is exclusively transaction flags.Core Keypairs
generate_seed
method to take a hex string instead of a UTF-8 stringsign
was made synchronous instead of asynchronous (moving a fee check out).