P-chain - Tx builder cleanup #2718
Conversation
abi87
requested review from
danlaine,
dhrubabasu and
StephenButtolph
as code owners
|
|
||
| // Returns a shared memory where GetDatabase returns a database | ||
| // where [recipientKey] has a balance of [amt] | ||
| fundedSharedMemory := func(peerChain ids.ID, assets map[ids.ID]uint64) atomic.SharedMemory { |
There was a problem hiding this comment.
this a clean way to setup the shared memory when we want to build an importTx. Pulled the function out of the test to be reused in other tests
| @@ -965,44 +987,23 @@ func TestDurangoDisabledTransactions(t *testing.T) { | |||
| { | |||
| name: "AddValidatorTx", | |||
| buildTx: func(env *environment) *txs.Tx { | |||
| ins, unstakedOuts, stakedOuts, signers, err := env.utxosHandler.Spend( | |||
There was a problem hiding this comment.
This is what I mean by building a tx "manually". The tx is supposed to pass verification, so we really should use the txBuilder to do that. This also shorten the test
| }, | ||
| }, | ||
| { | ||
| name: "ImportTx", | ||
| setupTest: func(env *environment) (txs.UnsignedTx, [][]*secp256k1.PrivateKey, state.Diff, *types.JSONByteSlice) { | ||
| setupTest: func(env *environment, memoField []byte) (*txs.Tx, state.Diff) { |
There was a problem hiding this comment.
This test is really the reason why I added memo fields in the txBuilder functions.
With the activation of Durango, we zeroed memo fields, so it may seem weird that I introduce them back.
However txBuilder is going to become a test package and we may want to be able to setup memos in tests.
There was a problem hiding this comment.
So txtBuilder will become test-only? What would be the use case for using memos in tests? It might be helpful to document your intent, maybe as part of a txBuilder README?
There was a problem hiding this comment.
Currently memo fields are disabled, but we may consider reintroducing them once we properly price txs (with dynamic fees). Historically they were not as important on the P-chain as they are on the X-chain (where we chose not to zero them).
I think generally we want to allow maximal flexibility in building txs, especially in UTs.
Note for instance that with Durango activation we won't need to specify StartTime in any of the AddValidator/Delegator txs but we still explicitly pass start time in the builder signature.
Not sure I understand what should go in the README here?
| ins, unstakedOuts, stakedOuts, signers, err := utxoHandler.Spend( | ||
| vm.state, | ||
| keys, | ||
| primaryTx, err := vm.txBuilder.NewAddPermissionlessValidatorTx( |
There was a problem hiding this comment.
some more "manually built" txs that we can cleanup
| }, | ||
| }, | ||
| { | ||
| name: "ImportTx", | ||
| setupTest: func(env *environment) (txs.UnsignedTx, [][]*secp256k1.PrivateKey, state.Diff, *types.JSONByteSlice) { | ||
| setupTest: func(env *environment, memoField []byte) (*txs.Tx, state.Diff) { |
There was a problem hiding this comment.
So txtBuilder will become test-only? What would be the use case for using memos in tests? It might be helpful to document your intent, maybe as part of a txBuilder README?
Why this should be merged
The upcoming work on dynamic fees will change they way we fund P-chain transactions.
This is much easier to be done and reviewed if we use txBuilder package as much as possible in UTs, instead of trying to build txs "manually".
Also we have ideas to eventually make txBuilder a test only package and use the wallet as the way to build and func transactions. This PR simplifies the upcoming changes
How this works
Make utxo.Spend and utxo.Authorized be called only in:
How this was tested
CI