feat!: add support for specifying custom messages for scanned outputs in libwallet #3871
Conversation
This file contains 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
… in lib wallet This PR adds the ability for clients to specify custom text messages to be added to outputs that are recovered or one-sided payments that are scanned from the blockchain. These messages were hardcoded before by clients should be able to specify their own so that localized messages can be provided in the future. The PR adds the ability to specify these messages when constucting the Utxo Scanner Service and also provides the interface to update these messages while the wallet is running. In the FFI interface the `wallet_start_recovery` method was updated to accept a custom Recovery Output message. For the One-Sided payment custom message the `wallet_set_one_sided_payment_message` method was added to allow the client to set the One sided payment message after the Wallet has been created. While working on this PR it was noted that the testing harness for the Utxo Scanner Service needed some updating and needed tests added that tested the the One-sided payment scanning. While writing these tests a bug was found in the Utxo Scanning logic that meant the tip clock was only scanned every second block that was received. This bug was fixed.
philipr-za
commented
Feb 25, 2022
| @@ -207,42 +206,76 @@ where TBackend: WalletBackend + 'static | |||
| loop { | |||
| let tip_header = self.get_chain_tip_header(&mut client).await?; | |||
| let tip_header_hash = tip_header.hash(); | |||
| let start_block = self.get_start_scanned_block(tip_header.height, &mut client).await?; | |||
| let last_scanned_block = self.get_last_scanned_block(tip_header.height, &mut client).await?; | |||
There was a problem hiding this comment.
This file's updates were fixing the bug in scanning one-sided payments.
delta1
approved these changes
Feb 28, 2022
| let source_public_key = self.resources.node_identity.public_key().clone(); | ||
| // Because we do not know the source public key we are making it the default key of zeroes to make it clear this | ||
| // value is a placeholder. | ||
| let source_public_key = CommsPublicKey::default(); |
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.
Description
This PR adds the ability for clients to specify custom text messages to be added to outputs that are recovered or one-sided payments that are scanned from the blockchain.
These messages were hardcoded before by clients should be able to specify their own so that localized messages can be provided in the future. The PR adds the ability to specify these messages when constucting the Utxo Scanner Service and also provides the interface to update these messages while the wallet is running.
In the FFI interface the
wallet_start_recoverymethod was updated to accept a custom Recovery Output message. For the One-Sided payment custom message thewallet_set_one_sided_payment_messagemethod was added to allow the client to set the One sided payment message after the Wallet has been created.How Has This Been Tested?
While working on this PR it was noted that the testing harness for the Utxo Scanner Service needed some updating and needed tests added that tested the the One-sided payment scanning. While writing these tests a bug was found in the Utxo Scanning logic that meant the tip block was only scanned every second block that was received. This bug was fixed