Refactor API for Consistency and Usability #252
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.
Fixes #245
Refactor API for Consistency and Usability
Description
This PR refactors several key Appkit APIs to improve consistency, readability, and usability. The changes aim to align naming conventions across builders and reduce the need for manual collection conversions.
Changes
1.
BoxOperationsRefactoring (Breaking Change)Renamed configuration methods to match the
UnsignedTransactionBuilderand general builder patterns. The "with" prefix has been removed in favor of more concise names.withAmountToSpend->valuewithTokensToSpend->tokenswithFeeAmount->feewithAttachment->attachmentwithMaxInputBoxesToSelect->maxInputBoxeswithMessage->messagewithInputBoxesLoader->inputBoxesLoader2.
UnsignedTransactionBuilderEnhancementsAdded
List-based overloads for keys methods to avoid the need for converting Lists to Arrays manually.addInputs(List<InputBox>)addDataInputs(List<InputBox>)addOutputs(List<OutBox>)tokensToBurn(List<ErgoToken>)3.
AddressStandardizationStandardized conversion methods to use the
toprefix, aligning withtoErgoContractandtoPropositionBytes.toP2PK()andtoP2S().asP2PK()andasP2S().4.
OutBoxBuilderImprovementtokens(). This makes the builder pattern more robust when building dynamic token lists.Verification
TxBuilderSpec,AnonymousAccessSpec,AppkitProvingInterpreterSpec,BabelFeeSpec) to reflect the API changes.