Ensure comments actually update in a transaction log #656
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.
Motivation
When a field is provided in an API, we expect that field to be leveraged. Specifically, in this case, the
submit_transaction
API wasn't using the provided comment to update the comment field in an existing transaction log.In this PR
We update the comment both when signing the transaction, and when submitting it.
Test Plan
To run the rust test suite (including the test added in this PR), copy the consensus_enclave.css file to your current working directory, and then run
tools/test.sh
Manually, you can exercise the scenario by doing the following
build_transaction
APItransaction_log_id
from the responseget_transaction_log
API using thetransaction_log_id
from Step 2get_transaction_log
's response is an empty stringsubmit_transaction
API, and specify the optional parametercomment
to be a string of your choiceget_transaction_log
API using thetransaction_log_id
from Step 2 and observe your new comment!