Unit test keystore #3151
Merged
Unit test keystore #3151
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
benma
force-pushed
the
unit-test-keystore
branch
2 times, most recently
from
2a82e50 to
7a9bc0d
Compare
keystore.go, especially the BTC sign function, is untested and quite long/complicated. bitbox02-api-go has simulator tests, for reference: https://github.com/BitBoxSwiss/bitbox02-api-go/blob/0e6a62c1fcf54ebaace25f90f1ab67530fedf171/api/firmware/device_test.go#L165. If the keystore signing code lived in the bitbox02-api-go repo, we could more easily test it, and potential third parties would also have an easier time integrating the BitBox. As a first step, we add simulator tests to the bitbox-wallet-app repo for bitbox02/keystore.go, which would enable us to safely refactor the code so we can eventually move it to bitbox02-api-go. The code to download and run simulators was copied from bitbox02-api-go: https://github.com/BitBoxSwiss/bitbox02-api-go/blob/0e6a62c1fcf54ebaace25f90f1ab67530fedf171/api/firmware/device_test.go#L48
Reduces the need for the costly GetAccountAddress(), which was used to gather input address infos three times per input during signing instead of only once: 1. when creating the spendable UTXO set in sign.go 2. when needing the info to feed the keypath info to the keystore (bitbox02/keystore.go) 3. when needing to create the sigscript/witness after signing (bitbox02/keystore.go) identify output addresses. This makes TxProposal a little bit more similar to a PSBT It also helps to move us closer to a tx structure resembling PSBTs.
"Finalize" is a term used in PSBTs to complete the transaction after signing by inserting the relevant witnesses.
benma
force-pushed
the
unit-test-keystore
branch
from
15c4b8f to
123953b
Compare
Beerosagos
approved these changes
Feb 11, 2025
| ) | ||
|
|
||
| var ( | ||
| log = logging.Get().WithGroup("simulator tx sign test") |
There was a problem hiding this comment.
tiny nit: I'd suggest simulator tx signing test. At first read I intended sign as +/- and thought it was a mistake :D
| @@ -36,7 +35,7 @@ import ( | |||
| ) | |||
|
|
|||
| // PreviousOutputs represents a UTXO set. It also implements `txscript.PrevOutputFetcher`. | |||
| type PreviousOutputs map[wire.OutPoint]*transactions.SpendableOutput | |||
| type PreviousOutputs map[wire.OutPoint]UTXO | |||
There was a problem hiding this comment.
Do you think it would be possible to "merge" the UTXO and the SpendableOutput structs to simplify the code? Probably OT for this PR, anyway
There was a problem hiding this comment.
Don't think so, as the transactions package with SpendableOutput does not have access to the Address instance, which is part of UTXO.
| @@ -16,18 +16,18 @@ | |||
| package bitbox02 | |||
|
|
|||
| import ( | |||
| "github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/coin" | |||
| coinpkg "github.com/BitBoxSwiss/bitbox-wallet-app/backend/coins/coin" | |||
There was a problem hiding this comment.
Because in keystore_simulator_test there is a global var coin now which clashes. Could also rename the var, doesn't matter much I think.
Including a check if the BitBox02 identified it as a send-to-self.
benma
force-pushed
the
unit-test-keystore
branch
from
123953b to
e2ef679
Compare
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.
No description provided.