This repository was archived by the owner on Jan 14, 2026. It is now read-only.
feat: add note field support and input transaction ID retrieval#30
Merged
feat: add note field support and input transaction ID retrieval#30
Conversation
Add the ability to set a custom note on the user-signed input transaction and retrieve its transaction ID for tracking purposes. Changes: - Add optional `note` config to SwapComposerConfig and newSwap() - Add `getInputTransactionId()` method to SwapComposer - Track the input transaction index during swap processing - Add comprehensive tests for note configuration and ID retrieval The note is only applied to the user-signed payment or asset transfer transaction (not pre-signed or middleware transactions). The transaction ID is available after calling buildGroup(), sign(), or execute().
Document the new transaction tracking features: - Add 'Transaction Tracking' section with usage example - Add 'note' parameter to newSwap() API reference table - Add 'getInputTransactionId()' to SwapComposer methods table
github-actions bot
added a commit
that referenced
this pull request
Dec 15, 2025
# [1.6.0](v1.5.0...v1.6.0) (2025-12-15) ### Features * add note field support and input transaction ID retrieval ([#30](#30)) ([904dbcc](904dbcc))
Contributor
|
🎉 This PR is included in version 1.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
This adds the ability to set a custom note on the user-signed input transaction and retrieve its transaction ID for tracking purposes. This is useful for applications that need to track specific swap transactions by embedding a tracking identifier in the note field and then looking up the transaction by ID.
Changes
New Features
noteconfiguration option - Added to bothSwapComposerConfigandnewSwap()to set a custom note on the user-signed input transaction (payment or asset transfer)getInputTransactionId()method - Added toSwapComposerto retrieve the transaction ID of the user-signed input transaction after the group has been builtImplementation Details
signature === false), not pre-signed or middleware transactionsbuildGroup(),sign(), orexecute()Files Changed
packages/deflex/src/composer.ts- Core implementationpackages/deflex/src/client.ts- Pass-through innewSwap()factory methodpackages/deflex/tests/composer.test.ts- Comprehensive test coveragepackages/deflex/README.md- Documentation updatesUsage Example