feat: improve StrKey.
#702
Merged
Conversation
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
- feat: add `isValidEd25519SecretSeed`, `isValidPreAuthTx` and `isValidSha256Hash` to `StrKey` class, these functions can be used to validate the corresponding strkey. - feat: add med25519 public key support to `StrKey`. - refactor!: the following functions in `StrKey` are marked as deprecated, they will be removed in the next major release; please refer to the documentation for each function to see the corresponding replacement functions: - `StrKey#encodeEd25519PublicKey(AccountID)` - `StrKey#encodeMuxedAccount(MuxedAccount)` - `StrKey#decodeMuxedAccount(String)` - `StrKey#encodeToXDRAccountId(String)` - `StrKey#encodeToXDRMuxedAccount(String)`
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## add-protocol23-support #702 +/- ##
=========================================================
Coverage ? 80.46%
Complexity ? 1247
=========================================================
Files ? 213
Lines ? 4961
Branches ? 416
=========================================================
Hits ? 3992
Misses ? 713
Partials ? 256
🚀 New features to boost your workflow:
|
- feat: add `isValidEd25519SecretSeed`, `isValidPreAuthTx` and `isValidSha256Hash` to `StrKey` class, these functions can be used to validate the corresponding strkey. - feat: add med25519 public key support to `StrKey`. - refactor!: the following functions in `StrKey` are marked as deprecated, they will be removed in the next major release; please refer to the documentation for each function to see the corresponding replacement functions: - `StrKey#encodeEd25519PublicKey(AccountID)` - `StrKey#encodeMuxedAccount(MuxedAccount)` - `StrKey#decodeMuxedAccount(String)` - `StrKey#encodeToXDRAccountId(String)` - `StrKey#encodeToXDRMuxedAccount(String)`
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the StrKey utility with new validation methods, adds full support for med25519 (“M…”) public keys, and refactors legacy XDR encoding/decoding calls to use MuxedAccount and KeyPair APIs.
- Added
isValid*methods (seed, preauth tx, SHA-256 hash, contract, liquidity pool, claimable balance, Ed25519, med25519) plusencodeMed25519PublicKey/decodeMed25519PublicKeyinStrKey. - Deprecated old StrKey encode/decode methods (
encodeEd25519PublicKey(AccountID),encodeMuxedAccount,decodeMuxedAccount,encodeToXDRAccountId,encodeToXDRMuxedAccount) ahead of the next major release. - Updated XDR conversion across operations and transaction classes to replace
StrKey-based calls withMuxedAccountandKeyPair.fromAccountId.
Reviewed Changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 2 comments.
Show a summary per file
| File or Package | Description |
|---|---|
| src/main/java/org/stellar/sdk/StrKey.java | Introduced validation methods and med25519 support; deprecated legacy StrKey encode/decode. |
| src/test/java/org/stellar/sdk/StrKeyTest.java | Added tests for many new isValid* methods and med25519 public key support. |
| src/main/java/org/stellar/sdk/operations/* | Replaced all StrKey.encode*/decode* XDR calls with MuxedAccount and KeyPair. |
| src/main/java/org/stellar/sdk/MuxedAccount.java | Overhauled constructor and getAddress to handle med25519; removed legacy StrKey use. |
| src/main/java/org/stellar/sdk/Server.java | Updated memo-required logic to use StrKey.isValidMed25519PublicKey instead of hashMemoId. |
| CHANGELOG.md | Documented new features and breaking changes. |
Comments suppressed due to low confidence (2)
src/main/java/org/stellar/sdk/StrKey.java:58
- Add unit tests for isValidEd25519PublicKey to ensure correct validation behavior for valid and invalid G... account IDs.
public static boolean isValidEd25519PublicKey(String accountID) {
src/main/java/org/stellar/sdk/StrKey.java:281
- Add unit tests for isValidLiquidityPool and isValidClaimableBalance to cover valid and invalid L... and B... identifiers.
public static boolean isValidLiquidityPool(String liquidityPoolId) {
| SetTrustLineFlagsOp op = new SetTrustLineFlagsOp(); | ||
|
|
||
| op.setTrustor(StrKey.encodeToXDRAccountId(this.trustor)); | ||
| op.setTrustor(KeyPair.fromAccountId(this.trustor).getXdrAccountId()); |
There was a problem hiding this comment.
[nitpick] The conversion from a string account ID to XDR AccountID is repeated across operations; consider extracting this into a shared utility method (e.g., toXdrAccountId) to reduce duplication.
| this.accountId = StrKey.encodeEd25519PublicKey(ed25519PublicKey); | ||
| this.muxedId = new BigInteger(1, muxedIdBytes); | ||
| } else { | ||
| throw new IllegalArgumentException("Invalid address"); |
There was a problem hiding this comment.
Include the invalid address in the exception message to make debugging easier, for example: Invalid address: " + address.
Suggested change
| throw new IllegalArgumentException("Invalid address"); | |
| throw new IllegalArgumentException("Invalid address: " + address); |
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.
isValidEd25519SecretSeed,isValidPreAuthTxandisValidSha256HashtoStrKeyclass, these functions can be used to validate the corresponding strkey.StrKey.StrKeyare marked as deprecated, they will be removed in the next major release; please refer to the documentation for each function to see the corresponding replacement functions:StrKey#encodeEd25519PublicKey(AccountID)StrKey#encodeMuxedAccount(MuxedAccount)StrKey#decodeMuxedAccount(String)StrKey#encodeToXDRAccountId(String)StrKey#encodeToXDRMuxedAccount(String)