refactor(experimental): add a function to assert a transaction has a blockhash lifetime #1908
Conversation
| function isBlockhashLifetimeTransaction( | ||
| transaction: BaseTransaction | (BaseTransaction & ITransactionWithBlockhashLifetime) | ||
| ): transaction is BaseTransaction & ITransactionWithBlockhashLifetime { | ||
| return ( | ||
| 'lifetimeConstraint' in transaction && | ||
| typeof transaction.lifetimeConstraint.blockhash === 'string' && | ||
| typeof transaction.lifetimeConstraint.lastValidBlockHeight === 'bigint' | ||
| ); | ||
| } | ||
|
|
||
| export function assertIsBlockhashLifetimeTransaction( | ||
| transaction: BaseTransaction | (BaseTransaction & ITransactionWithBlockhashLifetime) | ||
| ): asserts transaction is BaseTransaction & ITransactionWithBlockhashLifetime { | ||
| if (!isBlockhashLifetimeTransaction(transaction)) { | ||
| // TODO: Coded error. | ||
| throw new Error('Transaction is not a blockhash transaction'); | ||
| } | ||
| assertIsBlockhash(transaction.lifetimeConstraint.blockhash); | ||
| } |
There was a problem hiding this comment.
I'm not sure if it's on purpose but the logic of the isX and assertIsX functions is not the same. Passing a transaction with an invalid base58 blockhash will work for isX but fail for assertIsIx.
To make them the same, we could push that conditional to the assertIsX function and just do a try/catch on the isX function.
There was a problem hiding this comment.
Good point, thanks! I've refactored to move all the logic to the isX function, which makes them symmetrical as you say and also mirrors the durable nonce equivalent.
…blockhash lifetime
mcintyre94
force-pushed
the
assert-blockhash-tx
branch
from
e585ba9 to
3eb4a81
Compare
Agreed, renamed to that! |
| ): transaction is BaseTransaction & ITransactionWithBlockhashLifetime { | ||
| const lifetimeConstraintShapeMatches = | ||
| 'lifetimeConstraint' in transaction && | ||
| typeof transaction.lifetimeConstraint.blockhash === 'string' && |
There was a problem hiding this comment.
You could use assertIsBlockhash here, but meh.
|
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |
This PR adds a new function
assertIsBlockhashLifetimeTransactionwhich narrows the type of a transaction toBaseTransaction & ITransactionWithBlockhashLifetime, if the transaction contains a valid blockhash lifetime constraintIt mirrors the behaviour of the existing
assertIsDurableNonceTransactionMy specific use case for this is using the default transaction confirmer with a deserialized transaction. The default transaction confirmer requires the
lastValidBlockHeightfield of the lifetime constraint:solana-web3.js/packages/library/src/transaction-confirmation.ts
Lines 40 to 47 in 8f39c90
By asserting that the deserialized transaction has a valid blockhash lifetime constraint, we can satisfy this requirement and that of any other code that requires a blockhash lifetime on the transaction.