Skip to content
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

[#397] Add ZIP 321 URI parser #1409

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

pacu
Copy link
Contributor

@pacu pacu commented Mar 9, 2024

adds a transaction proposal API for URI strings

Closes #397

Add proposeFulfillingPaymentUri to changelog

Note
This code review checklist is intended to serve as a starting point for the author and reviewer, although it may not be appropriate for all types of changes (e.g. fixing a spelling typo in documentation). For more in-depth discussion of how we think about code review, please see Code Review Guidelines.

Author

  • Self-review your own code in GitHub's web interface1
  • Add automated tests as appropriate
  • Update the manual tests2 as appropriate
  • Check the code coverage3 report for the automated tests
  • Update documentation as appropriate (e.g README.md, Architecture.md, etc.)
  • Run the demo app and try the changes
  • Pull in the latest changes from the main branch and squash your commits before assigning a reviewer4

Reviewer

  • Check the code with the Code Review Guidelines checklist
  • Perform an ad hoc review5
  • Review the automated tests
  • Review the manual tests
  • Review the documentation, README.md, Architecture.md, etc. as appropriate
  • Run the demo app and try the changes6

Footnotes

  1. Code often looks different when reviewing the diff in a browser, making it easier to spot potential bugs.

  2. While we aim for automated testing of the SDK, some aspects require manual testing. If you had to manually test
    something during development of this pull request, write those steps down.

  3. While we are not looking for perfect coverage, the tool can point out potential cases that have been missed. Code coverage can be generated with: ./gradlew check for Kotlin modules and ./gradlew connectedCheck -PIS_ANDROID_INSTRUMENTATION_TEST_COVERAGE_ENABLED=true for Android modules.

  4. Having your code up to date and squashed will make it easier for others to review. Use best judgement when squashing commits, as some changes (such as refactoring) might be easier to review as a separate commit.

  5. In addition to a first pass using the code review guidelines, do a second pass using your best judgement and experience which may identify additional questions or comments. Research shows that code review is most effective when done in multiple passes, where reviewers look for different things through each pass.

  6. While the CI server runs the demo app to look for build failures or crashes, humans running the demo app are
    more likely to notice unexpected log messages, UI inconsistencies, or bad output data. Perform this step last, after verifying the code changes are safe to run locally.

@true-jared true-jared added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 16, 2024
@pacu pacu force-pushed the feature/proposal-from-uri branch from 919aa65 to 1c221b8 Compare July 17, 2024 21:19
@pacu
Copy link
Contributor Author

pacu commented Jul 17, 2024

@HonzaR I rebased the PR

@HonzaR
Copy link
Collaborator

HonzaR commented Sep 23, 2024

Hi @pacu, can you rebase it one more time, please?

@pacu
Copy link
Contributor Author

pacu commented Sep 23, 2024

@HonzaR Rebased!

@HonzaR
Copy link
Collaborator

HonzaR commented Sep 24, 2024

Thanks for the update @pacu. We need to change the FFI implementation, as we got several build errors. See the CI output. Can you take a look into it, please?

@pacu
Copy link
Contributor Author

pacu commented Sep 26, 2024

@HonzaR what do you want me to do with this error?

> Task :detektAll FAILED
/home/runner/work/zcash-android-wallet-sdk/zcash-android-wallet-sdk/sdk-lib/src/main/java/cash/z/ecc/android/sdk/internal/transaction/TransactionEncoder.kt:11:20: Interface 'TransactionEncoder' with '11' functions detected. Defined threshold inside interfaces is set to '11' [TooManyFunctions]

@HonzaR
Copy link
Collaborator

HonzaR commented Sep 27, 2024

@HonzaR what do you want me to do with this error?

> Task :detektAll FAILED
/home/runner/work/zcash-android-wallet-sdk/zcash-android-wallet-sdk/sdk-lib/src/main/java/cash/z/ecc/android/sdk/internal/transaction/TransactionEncoder.kt:11:20: Interface 'TransactionEncoder' with '11' functions detected. Defined threshold inside interfaces is set to '11' [TooManyFunctions]

I just suppressed it, as there is no quick solution for such a warning. Thank you for rebasing the PR!

Copy link
Collaborator

@HonzaR HonzaR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I pushed a few commits. As part of one of the commits, I improved error handling for the existing proposal functions. Other than that, it looks good to me. Thank you for these changes! I bring someone from the core team to check the FFI part, too.

Copy link
Contributor

@nuttycom nuttycom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flushing high-level initial comments.

Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK with suggestions.

@HonzaR HonzaR requested a review from nuttycom October 1, 2024 10:26
Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK. Comments are non-blocking.

Copy link
Contributor

@daira daira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK 5cb6d99

Copy link
Contributor

@nuttycom nuttycom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK fe7920c

adds a transaction proposal API for URI strings

Closes Electric-Coin-Company#397

Add `proposeFulfillingPaymentUri` to changelog

Fix lib.rs compile errors

Changelog update

Suppress detekt warning

Fix ktlint warnings

Improve proposal functions error reporting

Simple get-proposal-from-uri Demo app use case

Add ZIP 321 Uri examples

Changelog update

Address review comments

Address FFI review comment
@pacu pacu force-pushed the feature/proposal-from-uri branch from 5cb6d99 to a2871a3 Compare October 2, 2024 15:45
@pacu
Copy link
Contributor Author

pacu commented Oct 2, 2024

@HonzaR I squashed it

@HonzaR HonzaR merged commit a13af0a into Electric-Coin-Company:main Oct 3, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ZIP 321 URI parser
5 participants