Skip to content

Latest commit

 

History

History
897 lines (679 loc) · 57.7 KB

CHANGELOG.md

File metadata and controls

897 lines (679 loc) · 57.7 KB

Changelog

Pending

1.0.0

We are excited to announce the release of version 1.0.0 of the Java Stellar SDK! This marks a significant milestone in the project's development, representing the culmination of extensive work and valuable community feedback since the alpha and beta releases.

This version is identical in functionality to 1.0.0-rc0. If you are upgrading from an older version, please make sure to review the change logs of all previous versions in our CHANGELOG.md, as there have been significant changes throughout the 1.0.0 development cycle. We would like to express our sincere gratitude to everyone who provided feedback, reported issues, and contributed to making this release possible. Your involvement has been instrumental in shaping and improving the SDK.

This release marks our official adoption of semantic versioning, providing more predictability for future updates. Breaking changes will now only be introduced in major version updates.

There are two PRs here that demonstrate how to upgrade to the latest version; you can check them out if needed:

Please continue to share your experiences and report any issues you encounter. Your feedback remains vital for the continued improvement of the SDK.

1.0.0-rc0

The following are the changes since version 1.0.0-beta1. If you are upgrading from an older version, please also refer to the change logs of previous versions, especially 1.0.0-alpha0.

In addition, there are two PRs here that demonstrate how to upgrade to the latest version; you can check them out if needed:

Update

  • feat: add support for Soroban PRC's getLedgers API interface. (#660)
  • fix: fix the data validation of StrKey class. (#664)

Breaking changes

  • refactor!: change the type of AbstractTransaction.MIN_BASE_FEE from int to long. (#657)
  • refactor!: rename TransactionPreconditions.isValid to TransactionPreconditions.validate. (#666)
  • refactor!: if seed is not present, calling Keypair.sign throws IllegalStateException. (#662)
  • refactor!: StrKeyException has been removed, use IllegalArgumentException instead. When you call functions like Keypair.fromAccountId, this exception will also be thrown if invalid data is passed in. (#663)
  • refactor!: AssetCodeLengthInvalidException has been removed, use IllegalArgumentException instead. (#667)
  • refactor!: MalformedAddressException has been removed, use IllegalArgumentException instead. (#668)

1.0.0-beta1

The following are the changes since version 1.0.0-beta0. If you are upgrading from an older version, please also refer to the change logs of previous versions, especially 1.0.0-alpha0.

Update

  • refactor: refactor SSEStream, make it more reliable. (#652)
  • refactor: add pagingToken back to GetEventsResponse.EventInfo. This is to ensure compatibility with older versions of Soroban-RPC. We still recommend using the GetEventsResponse.cursor field after upgrading Soroban-RPC. (#655)

1.0.0-beta0

This is the first release that supports Protocol 22. While the network has not upgraded yet, you can start integrating the new features into your codebase if you want a head start.

The following are the changes since version 1.0.0-alpha0. If you are upgrading from an older version, please also refer to the change logs of previous versions, especially 1.0.0-alpha0.

Update

  • feat: support constructors in contract creation via InvokeHostFunctionOperation.createContractOperationBuilder.
  • feat: add support for Soroban PRC's getVersionInfo API.
  • feat: add txHash to GetTransactionResponse and GetTransactionsResponse.Transaction.

Breaking changes

  • refactor!: remove the constructor from KeyPair, use KeyPair.fromSecretSeed or KeyPair.fromAccountId instead.
  • fix!: fix bug with signing auth entries in multi-sig scenarios.
  • feat!: support constructors in contract creation via InvokeHostFunctionOperation.createContractOperationBuilder, the signature of the function has been changed.
  • refactor!: remove amount and numAccounts from AssetResponse.
  • refactor!: remove cost from SimulateTransactionResponse, the correct resource costs can now be retrieved from the transactionData.
  • refactor!: remove pagingToken from GetEventsResponse.EventInfo, use GetEventsResponse.cursor instead.
  • refactor!: The protocolVersion in the response is now represented as an Integer.

1.0.0-alpha0

We are thrilled to announce the release of version 1.0.0-beta0 for java-stellar-sdk, which has been in development for nearly a decade. This release marks a significant milestone in our journey, as we have made substantial changes and improvements to enhance the functionality and usability of our software.

Please be aware that this release introduces breaking changes. We understand that this may cause inconvenience, but we believe these changes are necessary to rectify past design decisions and lay a solid foundation for the project's future. We have been cautious about introducing breaking changes in previous releases, but we feel this is the right time to make these important adjustments.

If you encounter any issues or have questions regarding the changes, please don't hesitate to submit an issue on our GitHub repository. Alternatively, you can reach out to me directly on the Stellar Dev Discord server. We value your feedback and are committed to addressing any concerns you may have.

Moving forward, we will be adopting semantic versioning starting from the official release of this version. This means that breaking changes will only be introduced in major version updates, providing more stability and predictability for our users.

It's important to note that this is an alpha release and should not be used in production environments. The purpose of this release is to gather feedback, identify and address any remaining issues, and ensure the stability and reliability of the software before the official release.

We appreciate your understanding and support as we work towards delivering a more robust and efficient solution. Thank you for being a part of our community, and we look forward to your continued engagement as we shape the future of this project together.

Update

  • feat: add support for Soroban PRC's getTransactions and getFeeStats API.
  • feat: add support for Horizon's transaction_async API.
  • feat: optimize RequestTimeoutException, when a timeout occurs, if the server returns some information, you can read them.
  • feat: add Asset.createNonNativeAsset(String, String) and Asset.createNativeAsset().
  • feat: add MuxedAccount class to represent a multiplexed account on Stellar's network.
  • feat: Add Server.loadAccount to load the Account object used for building transactions, supporting MuxedAccount.
  • feat: Add support for MuxedAccount to SorobanServer.getAccount.
  • feat: FeeBumpTransaction supports transactions that include Soroban operations.
  • feat: added a series of functions to parse xdr in the response.
  • fix: When calling TransactionBuilder.build(), the Soroban resource fee will be included in the fee of the built transaction.
  • fix: fix the issue where invoking SorobanServer.prepareTransaction for transactions that have already set SorobanData could result in unexpected high fees.
  • chore: Display the original definition in the XDR class documentation.
  • chore: add some examples, you can find them in the examples directory.
  • chore: bump dependencies.

Breaking changes

  • refactor!: Refactored the handling of exceptions.
    • Moved the Exception classes to the org.stellar.sdk.exception and org.stellar.sdk.federation.exception packages.
    • Most of the exceptions inherit from SdkException, and SdkException inherits from RuntimeException. Please refer to the following link to understand why we use unchecked exceptions: Why unchecked exceptions?
    • Renamed SorobanRpcErrorResponse to SorobanRpcException.
    • FormatException has been renamed to StrKeyException. When encode or decode strkey fails, StrKeyFormatException will be thrown.
    • Detailed the possible exceptions that may be thrown in the documentation.
    • In the previous code, there were instances where RuntimeException was directly thrown. We have now replaced these with more appropriate exceptions such as IllegalArgumentException.
  • refactor!: removed the check for network passphrase in Server, which means we will no longer verify if the network passphrase of transactions matches that of the Server, NetworkMismatchException has been removed.
  • refactor!: moved the Operation classes to the org.stellar.sdk.operations package.
  • refactor!: KeyPair.getSecretSeed returns null if the keypair does not contain a secret key.
  • refactor!: due to the lack of maintenance for net.i2p.crypto:eddsa, we have migrated to org.bouncycastle:bcprov-jdk18on. The constructor of KeyPair has changed, but you generally won't be affected by this change.
  • refactor!: refactor asset classes. LiquidityPoolParameters, LiquidityPoolConstantProductParameters, AssetTypePoolShare, LiquidityPoolShareChangeTrustAsset and LiquidityPoolShareTrustLineAsset have been removed. Use ChangeTrustAsset and TrustLineAsset instead.
  • refactor!: Server.submitTransactionXdr and Server.submitTransaction now return TransactionResponse instead of SubmitTransactionResponse. An exception will be thrown when the transaction submission fails. Please refer to the documentation for more information.
  • refactor!: Server.root() now returns RootRequestBuilder.
  • refactor!: In AllowTrustOperation, authorizeToMaintainLiabilities has been removed and the type of authorize has been changed to TrustLineEntryFlag. Please refer to the documentation for details.
  • refactor!: Previously, operations could be constructed through many methods; now, we have standardized them. Here is an example, please refer to the documentation for more details: 
    ClawbackClaimableBalanceOperation op = ClawbackClaimableBalanceOperation.builder()
  .balanceId(balanceId)
  .sourceAccount(source)
  .build();
  • refactor!: TransactionBuilder.IncrementedSequenceNumberFunc has been removed.
  • refactor!: Transaction.Builder has been removed, use TransactionBuilder instead.
  • refactor!: Asset.getType() returns org.stellar.sdk.xdr.AssetType instead of String.
  • refactor!: FeeBumpTransaction.Builder has been removed, use FeeBumpTransaction#createWithBaseFee(String, long, Transaction) or FeeBumpTransaction#createWithFee(String, long, Transaction) instead.
  • refactor!: FeeBumpTransaction.getFeeAccount has been removed, use FeeBumpTransaction.getFeeSource instead.
  • refactor!: remove AccountConverter, this means that we no longer support disabling support for MuxedAccount.
  • refactor!: refactor the way of constructing Predicate.Or and Predicate.And. The inner inside has been removed, and in its place are left and right, used to represent two predicates.
  • refactor!: Refactored response classes.
    • Utilized wrapper classes, such as replacing int with Integer, long with Long, boolean with Boolean, etc.
    • If a field is a list, we now use List instead of arrays.
    • The types of some fields have been modified.
    • Removed some methods.
    • Some field names have been changed to maintain consistency with the Horizon API.
    • Removed all functions that return Optional value.
  • refactor!: remove rateLimitLimit, rateLimitRemaining, and rateLimitReset from the Response. Horizon does not return these fields.
  • refactor!: TransactionBuilder#TransactionBuilder(Transaction) has been removed, because the TransactionBuilder constructed from the transaction may be inconsistent with what the user expects.
  • refactor!: remove LiquidityPoolID. Use String to represent the liquidity pool ID.
  • refactor!: LiquidityPoolWithdrawOperation#LiquidityPoolWithdrawOperation(AssetAmount, AssetAmount, String) has been removed. Use LiquidityPoolWithdrawOperation#LiquidityPoolWithdrawOperation(Asset, BigDecimal, Asset, BigDecimal, BigDecimal) instead.
  • refactor!: LiquidityPoolDepositOperation#LiquidityPoolDepositOperation(AssetAmount, AssetAmount, Price, Price) has been removed. Use LiquidityPoolDepositOperation#LiquidityPoolDepositOperation(Asset, BigDecimal, Asset, BigDecimal, Price, Price) instead.
  • refactor!: the type of the following field has been changed from String to BigDecimal.
    • ChangeTrustOperation.limit
    • ClawbackOperation.amount
    • CreateAccountOperation.startingBalance
    • CreateClaimableBalanceOperation.amount
    • CreatePassiveSellOfferOperation.amount
    • LiquidityPoolDepositOperation.maxAmountA and LiquidityPoolDepositOperation.maxAmountB
    • LiquidityPoolWithdrawOperation.amount, LiquidityPoolWithdrawOperation.minAmountA, and LiquidityPoolWithdrawOperation.minAmountB
    • ManageBuyOfferOperation.amount
    • ManageSellOfferOperation.amount
    • PathPaymentStrictReceiveOperation.sendMax and PathPaymentStrictReceiveOperation.destAmount
    • PathPaymentStrictSendOperation.sendAmount and PathPaymentStrictSendOperation.destMin
    • PaymentOperation.amount
  • refactor!: TransactionPreconditions#TransactionPreconditions(LedgerBounds, Long, BigInteger, long, List, TimeBounds) has been removed, use TransactionPreconditions#TransactionPreconditions(TimeBounds, LedgerBounds, Long, BigInteger, long, List) instead.
  • refactor!: The Federation has been refactored, please use Federation#resolveAddress(String) and Federation#resolveAccountId(String, String) now.
  • refactor!: Set the default value of TransactionPreconditions.extraSigners to new ArrayList<>(), it is not nullable.

0.44.1

Update

  • fix: fix SSEStream unpredictably throws unwanted IOException("Canceled"). (#650)

0.44.0

Update

  • feat: add support for Soroban-RPC v21. (#593)
  • chore: include org.stellar.sdk.xdr in docs. (#594)

0.43.2

Update

0.43.1

Update

  • Migrate the project from stellar/java-stellar-sdk to lightsail-network/stellar-stellar-sdk.
  • Update org.stellar.sdk.responses, add missing fields. (#570)
  • Add Asset.getContractId() for calculating the id of the asset contract. (#574)
  • Publish the publication to Maven Central. (#580)
  • Build the project with JDK 21. (#580)
  • Optimize the way of parsing memo in TransactionResponse. (#582)

0.43.0

Update

  • Support resource leeway parameter when simulating Soroban transactions. (#561)
  • Support for the new, optional diagnosticEventsXdr field on the SorobanServer.sendTransaction method. (#564)
  • Remove deprecated classes and methods. (#565)
  • Fix the hashCode and equals methods in Transaction and FeeBumpTransaction. (#566)
  • Add TransactionBuilder#TransactionBuilder(Transaction) constructor. (#567)
  • Add toString, hashCode, and equals methods to most classes. (#562)
  • Bump dependencies. (#569)

Breaking changes

  • Fix the hashCode and equals methods in Transaction and FeeBumpTransaction, now they will compare based on the signatureBase(). (#566)
  • The types of the following fields have changed. (#560)
    field before now
    GetEventsRequest.startLedger String Long
    GetEventsResponse.EventInfo.ledger Integer Long
    GetLatestLedgerResponse.protocolVersion Integer Long
  • The following classes and methods have been marked as deprecated in previous releases, and now they have been removed. (#565)
    • AccountResponse.Signer#getAccountId() has been removed, use AccountResponse.Signer#getKey() instead.
    • OffersRequestBuilder#forAccount(String) has been removed, use OffersRequestBuilder#forSeller(String) instead.
    • RootResponse#getProtocolVersion() has been removed, use RootResponse#getCurrentProtocolVersion() instead.
    • SetOptionsOperationResponse#getSigner() has been removed, use SetOptionsOperationResponse#getSignerKey() instead.
    • Transaction.Builder has been removed, use TransactionBuilder instead.
    • TransactionBuilder#buildTimeBounds(long, long) has been removed, use TimeBounds#TimeBounds(long, long) instead.
    • TransactionBuilder#addTimeBounds(TimeBounds) has been removed, use TransactionBuilder#addPreconditions(TransactionPreconditions) instead.

0.42.0

  • Make StrKey public, this allows users to conveniently encode and decode Stellar keys to/from strings. (#548)
  • Add support for muxed accounts in PaymentOperationResponse. (#550)
  • Improve the reliability of SSEStream. Now, it will restart when necessary. (#555)
  • Add the response code and body to SubmitTransactionUnknownResponseException. (#556)

Breaking changes

  • Update LedgerResponse and AccountResponse, remove outdated fields, and add missing fields. (#549)
  • Use Price instead of String to represent prices. Change the type of CreatePassiveSellOfferOperation.price, ManageBuyOfferOperation.price, and ManageBuyOfferOperation.price from String to Price, this fixes the issue of incorrect operations parsed in certain specific scenarios. (#554)
  • Update the SDK to the stable Protocol 20 release: #553
    • The BumpFootprintExpirationOperation is now ExtendFootprintTTLOperation and its ledgersToExpire field is now named extendTo, but it serves the same purpose.
    • The InvokeHostFunctionOperation.createTokenContractOperationBuilder is now InvokeHostFunctionOperation.createStellarAssetContractOperationBuilder.
    • SorobanDataBuilder.setRefundableFee is now setResourceFee.
    • The RPC endpoint structure has changed, check #552 for more details.

0.41.1

  • Add org.stellar.sdk.spi.SdkProvider, users can implement this interface to provide their own implementation of the SDK. We provide an Android specific implementation, if you are integrating this SDK into an Android project, be sure to check it out. (#543)
  • Fix issues where the validity of the encoded strkey is not verified in certain scenarios. (#541)
  • Fix the issue of javadocJar not including documentation. (#539)
  • Publish sourcesJar to the GitHub Release page. (#539)

0.41.0

  • Add support for Soroban Preview 11. (#530)
  • New effects have been added to support Protocol 20 (Soroban) (#535):
    • ContractCredited occurs when a Stellar asset moves into its corresponding Stellar Asset Contract instance
    • ContractDebited occurs when a Stellar asset moves out of its corresponding Stellar Asset Contract instance
  • Add helper functions to sign authorization entries. (#537)

Breaking changes

  • Bump dependencies & Remove unnecessary dependencies like guava. (#523)

  • No longer provide a shadow jar that contains embedded, relocated third-party dependencies. (#528) Instead the default stellar-sdk.jar and the com.github.stellar:java-stellar-sdk:{version} dependency are now packaged as 'thin library' jar, having no embedded dependencies.

    • if your project used stellar-sdk.jar directly on classpath loader, will need to obtain the .jar for each dependency version listed in build.gradle.kts and include all in your project classpath, or consider downloading the 'uber' jar from the published artifacts on repo https://jitpack.io/com/github/stellar/java-stellar-sdk/{version}/java-stellar-sdk-{version}-uber.jar

    • if your project utilizes dependency management for build such as gradle/maven, then you can choose from the following artifacts using the dependency classifier:

      implementation("com.github.stellar:java-stellar-sdk:{version}") // thin jar
implementation("com.github.stellar:java-stellar-sdk:{version}:uber") // uber jar
implementation("com.github.stellar:java-stellar-sdk:{version}:javadoc") // javadoc jar
implementation("com.github.stellar:java-stellar-sdk:{version}:sources") // sources jar

    • When using the 'thin' jar in dependency management, it will automatically fetch dependencies transitively. If your project declares dependencies that are also declared here, then your project will override the preferences of this project and may cause runtime conflict.

    • When using the 'uber' jar in dependency management or as .jar in classpath , be aware that it does not relocate the dependent packages.

  • Utils.claimableBalanceIdToXDR and Utils.xdrToClaimableBalanceId have been removed. (#503)

  • The types of the following fields have changed. (#498)

    field before now
    LedgerBounds.minLedger int long
    LedgerBounds.maxLedger int long
    MemoId.id long BigInteger
    TimeBounds.minTime long BigInteger
    TimeBounds.maxTime long BigInteger
    TransactionBuilder.baseFee int long
    TransactionPreconditions.TIMEOUT_INFINITE long BigInteger
    TransactionPreconditions.minSeqAge Long BigInteger
    TransactionPreconditions.minSeqLedgerGap int long

0.41.0-beta.3

  • Fix the bug in Transaction.isSorobanTransaction to accommodate BumpFootprintExpirationOperation. (#518)

0.41.0-beta.0

  • Add support for Soroban Preview 10. (#490)
  • Correct the data type of certain fields to store the expected design values. (#497)
  • Add source account comparison to ClawbackClaimableBalanceOperation, LiquidityPoolWithdrawOperation, and LiquidityPoolDepositOperation for equality check. (#484)
  • Add basic implementation of liquidity_pools?account (#426)

0.40.1

  • Fix the issue of unable to parse liquidity_pool_revoked effect properly. (#521)
  • Define cursor, order and limit in AssetsRequestBuilder object. (#522)
  • Add basic implementation of liquidity_pools?account (#426)
  • Add source account comparison to ClawbackClaimableBalanceOperation, LiquidityPoolWithdrawOperation, and LiquidityPoolDepositOperation for equality check. (#484)

0.40.0

  • Add strkey support for contract ids (#471)
  • Fix NPE in KeyPair.equals() method (#474)
  • Avoid to have unexpected exception on status code 429 TooManyRequests (#433)

0.39.0

  • Add SubmitTransactionResponse.ResultCodes.innerTransactionResultCode (#466)

0.38.0

  • Fix android crashing related to okhttp3 (#457)

0.37.2

  • Fix the deployment CI that uploads the jar to the GitHub release [2]. (#453)

0.37.1

  • Fix the deployment CI that uploads the jar to the GitHub release. (#452)

0.37.0

  • Fix missing auth_clawback_enabled field in AccountResponse class. (#449)

0.36.0

  • Fix bug in KeyPair.fromSecretSeed(char[] seed). (#447)
  • Shade kotlin dependencies to prevent 'Duplicate class' errors. (#448)

0.35.0

  • Update JDK compatibility version from Java 1.6 to Java 1.8 and bump the version of few libraries (#444):
    • com.squareup.okhttp3 from v3.11.0 to v4.10.0.
    • commons-io:commons-io from v2.6 to v2.11.0.
    • junit:junit from v4.12 to v4.13.2.
    • org.threeten:threetenbp from v1.4.4 to v1.6.0.
    • org.mockito:mockito-core from v2.21.0 to v4.6.1.
    • javax.xml.bind:jaxb-api from v2.3.0 to v2.3.1.

0.34.2

  • Bump gson version from v2.8.5 to v2.9.0. (#443)

0.34.1

  • Fix the Sep10Challenge.verifyTransactionSignatures method to handle/ignore signers that are not ed25519 compliant. (#440)

0.34.0

  • Add memo to Sep10Challenge.newChallenge() and Sep10Challenge.readChallengeTransaction. (#435)

0.33.0

  • Update TransactionResponse to include new Protocol 19 Preconditions (#428).
  • Fix asset compare to when asset code are equals (#424).
  • LiquidityPoolIDDeserializer is missing from the PageDeserializer. (#422)

0.32.0

  • Update XDR definitions and auto-generated classes to support upcoming protocol 19 release (#416).
  • Extend StrKey implementation to handle CAP 40 Payload Signer.
  • Extended Transaction submission settings, additional new Preconditions can be added now, refer to CAP 21 Transaction Preconditions.

Breaking changes

  • org.stellar.sdk.Transaction.Builder
    • deprecated addTimeBounds() use addPreconditions() instead
    • deprecated setTimeout() use addPreconditions() instead
    • deprecated Transaction.Builder use TransactionBuilder instead
  • org.stellar.sdk.Transaction
    • getSignatures() returns an ImmutableList of signatures, do NOT add signatures to the collection returned. use addSignature(DecoratedSignature signature) instead.

0.31.0

  • Fixed NPE on TrustlineCreatedEffectResponse.getAsset() for liquidity pool asset type. Consolidated Asset factory creation pattern, made consistent for all asset types including native, alpha4, alpha12, liquidity pool shares. (#398).

Breaking changes

  • org.stellar.sdk.Asset.createNonNativeAsset() is now private. (#398).
  • org.stellar.sdk.responses.effects.TrustlineCUDResponse, removed non-default public constructor, it wasn't needed. (#398).
  • Muxed accounts are now supported by default. Previously we added opt in support for muxed accounts. But now we are changing the default behavior so that muxed accounts are rendered using their 'M' address encoding (#399).

0.30.0

  • Fix missing Liquidity Pool ID in AccountResponse Balance (#379).
  • Fix null pointer when calling ChangeTrustOperationResponse.getAsset() for LiquidityPool trust line (#378).
  • Changed the access modifiers of the inner static classes of AccountResponse to public (#390).
  • Use the new ClaimableBalance Predicate AbsBeforeEpoch field to avoid parsing errors on potential large dates in AbsBefore (#394).

Breaking changes

  • Changed offer ids to be represented in requests and response models as long data type. (#386).
  • Changed all MuxedId attributes to be of data type java.math.BigInteger in request and response models (#388).

0.29.0

  • Fixed bug in parsing liquidity pool operation and effect responses (#373).

0.28.0

  • Added support for 'client_domain' ManageData operations in SEP 10 challenges (#368).

0.27.1-beta

  • Add 5 minute grace period to SEP-10 challenge parsing function (#366).

0.27.0-beta

0.26.0

  • Add opt-in support for SEP23 M-strkeys for MuxedAccounts
  • Add getClaimableBalanceId() method to Transaction class which returns the claimable balance id for a given operation.
  • Add support for additional _muxed and _muxed_id optional fields in Horizon's JSON responses (available since Horizon 2.4, following what's described in SEP 23).

0.25.0

  • Added TransactionsRequestBuilder.forClaimableBalance(), and OperationsRequestBuilder.forClaimableBalance().
  • Added support for new accounts, balances, claimable_balances_amount, and num_claimable_balances fields on Assets.

0.24.0

Deprecations

  • Operation allow_trust is deprecated in favor of set_trust_line_flags (although it will still be supported by the network)

  • Effects trustline_authorized, trustline_authorized_to_maintain_liabilities and trustline_deauthorized are deprecated in favor of trustline_flags_updated. Note how we intentionally didn't add a new trustline_authorized_clawback_enabled effect.

For uniformity, the allow_trust operation will start producing trustline_flags_updated from this release.

For now trustline_authorized, trustline_authorized_to_maintain_liabilities and trustline_deauthorized will continue to be emitted as a result of the allow_trust operation but in the future we may stop doing so.

Deprecated New class
org.stellar.sdk.AllowTrustOperation org.stellar.sdk.SetTrustlineFlagsOperation
org.stellar.sdk.responses.operations.AllowTrustOperationResponse org.stellar.sdk.responses.operations.SetTrustLineFlagsOperationResponse
org.stellar.sdk.responses.effects.TrustlineAuthorizedEffectResponse org.stellar.sdk.responses.effects.TrustlineFlagsUpdatedEffectResponse
org.stellar.sdk.responses.effects.TrustlineAuthorizedToMaintainLiabilitiesEffectResponse org.stellar.sdk.responses.effects.TrustlineFlagsUpdatedEffectResponse
org.stellar.sdk.responses.effects.TrustlineDeauthorizedEffectResponse org.stellar.sdk.responses.effects.TrustlineFlagsUpdatedEffectResponse

Changes

New Operations

  • clawback implemented in org.stellar.sdk.ClawbackOperation claws back a trustline from a given asset holder.

  • clawback_claimable_balance implemented in org.stellar.sdk.ClawbackClaimableBalanceOperation claws back a claimable balance.

  • set_trust_line_flags implemented in org.stellar.sdk.SetTrustlineFlagsOperation modifies a trustline's flags. This operation should be used instead of org.stellar.sdk.AllowTrustOperation.

New effects

  • trustline_flags_updated implemented in org.stellar.sdk.responses.effects.TrustlineFlagsUpdatedEffectResponse, with the following fields:

    • Asset fields (like explained in the operations above):
      • asset_type
      • asset_code
      • asset_issuer
    • trustor - account whose trustline the effect refers to
    • authorized_flag - true to indicate the flag is set, field ommited if not set
    • authorized_to_maintain_liabilites - true to indicate the flag is set, field ommited if not set
    • clawback_enabled_flag - true to indicate that the flag is set, field ommitted if not set

  • claimable_balance_clawed_back implemented in org.stellar.sdk.responses.effects.ClaimableBalanceClawedBackEffectResponse, with the following fields:

    • balance_id - claimable balance identifer of the claimable balance clawed back

0.23.0

Breaking change

  • Updates the SEP-10 utility function parameters to support SEP-10 v3.1 (#319)
    • A new required webAuthDomain parameter was added to the following functions
      • Sep10Challenge#newChallenge(KeyPair, Network, String, String, String, TimeBounds)
      • Sep10Challenge#readChallengeTransaction(String, String, Network, String, String)
      • Sep10Challenge#readChallengeTransaction(String, String, Network, String[], String)
      • Sep10Challenge#verifyChallengeTransactionSigners(String, String, Network, String, String, Set)
      • Sep10Challenge#verifyChallengeTransactionSigners(String, String, Network, String[], String, Set)
      • Sep10Challenge#verifyChallengeTransactionThreshold(String, String, Network, String[], String, int, Set)
      • Sep10Challenge#verifyChallengeTransactionThreshold(String, String, Network, String, String, int, Set)
    • The webAuthDomain parameter is expected to match the value of the Manage Data operation with the 'web_auth_domain' key, if present.

0.22.1

  • Fix several bugs in revoke operations. (#317)

0.22.0

  • The XDR classes have been regenerated using the latest version of xdrgen which provides the following two features:

    • Builder static inner classes to unions and structs
    • Constructors for typedefs

0.21.2

  • Update challenge transaction helpers for SEP-0010 v3.0.0. (#308)
  • Fix the decoding of balanceId in org.stellar.sdk.ClaimClaimableBalanceOperation. (#310)

0.21.1

  • Fix NullPointerException in org.stellar.sdk.responses.operations.RevokeSponsorshipOperationResponse accessor methods.

0.21.0

Breaking change

  • Change the type of offerId from java.lang.Integer to java.lang.Long to align with the 64-bit size of offer IDs. (#303).

    This change affects the following fields:

    • org.stellar.sdk.responses.operations.CreatePassiveSellOfferOperationResponse.offerId
    • org.stellar.sdk.responses.operations.ManageBuyOfferOperationResponse.offerId
    • org.stellar.sdk.responses.operations.ManageSellOfferOperationResponse.offerId

0.20.0

  • Update challenge transaction helpers for SEP-0010 v2.1.0. (#300).
    • Remove verification of domain name.
    • Allow additional manage data operations that have the source account set as the server key.

0.19.0

Add

  • Add support for claimable balances (#295). Extend server class to allow loading claimable balances from Horizon. The following functions are available:
server.claimableBalances();
server.claimableBalances().forClaimant(claimant);
server.claimableBalances().forSponsor(sponsorId);
server.claimableBalances().forAsset(asset);
server.claimableBalances().claimableBalance(balanceId);

  • Add the following attributes to AccountResponse (#295):

    • Optional<String> getSponsor()
    • Integer getNumSponsoring()
    • Integer getNumSponsored()

  • Add the optional attribute Optional<String> getSponsor() to AccountResponse.Signer, AccountResponse.Balance, ClaimableBalanceResponse, and OfferResponse (#295).

  • Add sponsor filtering support for offers and accounts (#295).

    • server.offers().forSponsor(accountID)
    • server.accounts().forSponsor(accountID)

  • Extend operation responses to support new operations (#295).

    • create_claimable_balance with the following fields:
      • asset - asset available to be claimed (in canonical form),
      • amount - amount available to be claimed,
      • claimants - list of claimants with predicates (see below):
        • destination - destination account ID,
        • predicate - predicate required to claim a balance (see below).
    • claim_claimable_balance with the following fields:
      • balance_id - unique ID of balance to be claimed,
      • claimant - account ID of a claimant.
    • begin_sponsoring_future_reserves with the following fields:
      • sponsored_id - account ID for which future reserves will be sponsored.
    • end_sponsoring_future_reserves with the following fields:
      • begin_sponsor - account sponsoring reserves.
    • revoke_sponsorship with the following fields:
      • account_id - if account sponsorship was revoked,
      • claimable_balance_id - if claimable balance sponsorship was revoked,
      • data_account_id - if account data sponsorship was revoked,
      • data_name - if account data sponsorship was revoked,
      • offer_id - if offer sponsorship was revoked,
      • trustline_account_id - if trustline sponsorship was revoked,
      • trustline_asset - if trustline sponsorship was revoked,
      • signer_account_id - if signer sponsorship was revoked,
      • signer_key - if signer sponsorship was revoked.

  • Extend effect responses to support new effects (#295).

    • claimable_balance_created with the following fields:
      • balance_id - unique ID of claimable balance,
      • asset - asset available to be claimed (in canonical form),
      • amount - amount available to be claimed.
    • claimable_balance_claimant_created with the following fields:
      • balance_id - unique ID of a claimable balance,
      • asset - asset available to be claimed (in canonical form),
      • amount - amount available to be claimed,
      • predicate - predicate required to claim a balance (see below).
    • claimable_balance_claimed with the following fields:
      • balance_id - unique ID of a claimable balance,
      • asset - asset available to be claimed (in canonical form),
      • amount - amount available to be claimed,
    • account_sponsorship_created with the following fields:
      • sponsor - sponsor of an account.
    • account_sponsorship_updated with the following fields:
      • new_sponsor - new sponsor of an account,
      • former_sponsor - former sponsor of an account.
    • account_sponsorship_removed with the following fields:
      • former_sponsor - former sponsor of an account.
    • trustline_sponsorship_created with the following fields:
      • sponsor - sponsor of a trustline.
    • trustline_sponsorship_updated with the following fields:
      • new_sponsor - new sponsor of a trustline,
      • former_sponsor - former sponsor of a trustline.
    • trustline_sponsorship_removed with the following fields:
      • former_sponsor - former sponsor of a trustline.
    • claimable_balance_sponsorship_created with the following fields:
      • sponsor - sponsor of a claimable balance.
    • claimable_balance_sponsorship_updated with the following fields:
      • new_sponsor - new sponsor of a claimable balance,
      • former_sponsor - former sponsor of a claimable balance.
    • claimable_balance_sponsorship_removed with the following fields:
      • former_sponsor - former sponsor of a claimable balance.
    • signer_sponsorship_created with the following fields:
      • signer - signer being sponsored.
      • sponsor - signer sponsor.
    • signer_sponsorship_updated with the following fields:
      • signer - signer being sponsored.
      • former_sponsor - the former sponsor of the signer.
      • new_sponsor - the new sponsor of the signer.
    • signer_sponsorship_removed with the following fields:
      • former_sponsor - former sponsor of a signer.

Breaking changes

  • Replace Sep10Challenge.newChallenge()'s String anchorName parameter with String domainName
  • Add String domainName parameter to Sep10Challenge.readChallengeTransaction(), Sep10Challenge.verifyChallengeTransactionSigners(), and Sep10Challenge.verifyChallengeTransactionThreshold()

SEP-10 now requires clients to verify the SIGNING_KEY included in the TOML file of the service requiring authentication is used to sign the challenge and that the challenge's Manage Data operation key includes the requested service's home domain. These checks ensure the challenge cannot be used in a relay attack.

The breaking changes described above support the added SEP-10 2.0 requirements for both servers and clients.

0.18.0

  • Generate V1 transaction envelopes when constructing new Transaction instances (#285).
  • Allow FeeBumpTransaction instances to wrap V0 transactions (#285).

0.17.0

  • Rollback support for SEP23 (Muxed Account StrKey) (#282).

0.16.0

0.15.0

  • Add SEP0029 (memo required) support. (#272)

    Extends Server.submitTransaction to always run a memo required check before sending the transaction. If any of the destinations require a memo and the transaction doesn't include one, then an AccountRequiresMemoError will be thrown.

    You can skip this check by passing a true skipMemoRequiredCheck value to Server.submitTransaction:

    server.submitTransaction(tx, true)

    The check runs for each operation of type:

    • payment
    • pathPaymentStrictReceive
    • pathPaymentStrictSend
    • mergeAccount

    If the transaction includes a memo, then memo required checking is skipped.

    See SEP0029 for more information about memo required check.

0.14.0

  • Update challenge transaction helpers for SEP-10 v1.3.0 (#263).
  • Add support for /accounts end-point with ?signer and ?asset filters (#261).
  • Add support for /offers end-point with query parameters (#261).
  • Regenerate the XDR definitions to include MetaV2 support (#261).

0.13.0

  • Horizon v0.24.0 added a fee_charged and max_fee object with information about max bid and actual fee paid for each transaction.
  • We are removing ``*_all_accepted_fee` fields in favor of the new keys, making it easier for people to understand the meaning the fields.

0.12.0

  • Represent memo text contents as bytes because a memo text may not be valid UTF-8 string (#257).
  • Validate name length when constructing org.stellar.sdk.ManageDataOperation instances.
  • Validate home domain length when constructing org.stellar.sdk.SetOptionsOperation instances.

0.11.0

  • Fix bug in org.stellar.sdk.requests.OperationsRequestBuilder.operation(long operationId). The method submitted an HTTP request to Horizon with the following path, /operation/ , but the correct path is /operations/
  • Rename org.stellar.sdk.requests.PathsRequestBuilder to org.stellar.sdk.requests.StrictReceivePathsRequestBuilder
  • Add sourceAssets() to org.stellar.sdk.requests.StrictReceivePathsRequestBuilder which allows a list of assets to be provided instead of a source account
  • Add org.stellar.sdk.requests.StrictSendPathsRequestBuilder which is the request builder for the /paths/strict-send endpoint
  • Removed deprecated classes: org.stellar.sdk.PathPaymentOperation and org.stellar.sdk.responses.operations.PathPaymentOperationResponse
  • The fee_paid field in the Horizon transaction response will be removed when Horizon 0.25 is released. The fee_paid field has been replaced by max_fee, which defines the maximum fee the source account is willing to pay, and fee_charged, which defines the fee that was actually paid for a transaction. Consequently, getFeePaid() has been removed from org.stellar.sdk.responses.Transaction and has been replaced with getMaxFee() and getFeeCharged().

0.10.0

Deprecations

The following methods are deprecated and will be removed in 0.11.0. Please switch to new methods and classes.

Deprecated New method/class
org.stellar.sdk.PathPaymentOperation org.stellar.sdk.PathPaymentStrictReceiveOperation
org.stellar.sdk.responses.operations.PathPaymentOperationResponse org.stellar.sdk.responses.operations.PathPaymentStrictReceiveOperationResponse

Changes

  • Add helper method to generate SEP 10 challenge
  • Stellar Protocol 12 compatibility.
  • Include path property in path payment operation responses.
  • Provide includeTransactions() method for constructing operations requests which include transaction data in the operations response.
  • Provide includeTransactions() method for constructing payments requests which include transaction data in the payments response.

0.9.0

  • Use strings to represent account ids instead of KeyPair instances because account ids will not necessarily be valid public keys. If you try to parse an invalid public key into a KeyPair you will encounter an exception. To prevent exceptions when parsing horizon responses it is better to represent account ids as strings

0.8.0

  • Removed deprecated methods and classes listed in the 0.7.0 changelog entry
  • Configure network at the transaction and server level rather than using a singleton to determine which network to use globally.
  • Implement hashCode() and equals() on Stellar classes and XDR generated classes
  • Add streaming for account Offers
  • Add callback to handle SSE failures

0.7.0

Deprecations

The following methods are deprecated and will be removed in 0.8.0. Please switch to new methods and classes.

Deprecated New method/class
org.stellar.sdk.Server#operationFeeStats org.stellar.sdk.Server#feeStats
org.stellar.sdk.requests.OperationFeeStatsRequestBuilder org.stellar.sdk.requests.FeeStatsRequestBuilder
org.stellar.sdk.responses.OperationFeeStatsResponse org.stellar.sdk.responses.FeeStatsResponse
org.stellar.sdk.responses.operations.CreatePassiveOfferOperationResponse org.stellar.sdk.responses.operations.CreatePassiveSellOfferOperationResponse
org.stellar.sdk.responses.operations.ManageOfferOperationResponse org.stellar.sdk.responses.operations.ManageOfferSellOperationResponse
org.stellar.sdk.CreatePassiveOfferOperation org.stellar.sdk.CreatePassiveSellOfferOperation
org.stellar.sdk.ManageOfferOperation org.stellar.sdk.ManageSellOfferOperation

Changes

  • Stellar Protocol 11 compatibility (#199).
  • Compatibility with Horizon API updates (#205).
  • Add Support for InflationOperation in Operation.fromXdr (#194).
  • Fixed exception thrown from ManageOfferOperation.fromXDR for some offers (#188).
  • Send Horizon client fingerprint (#190).
  • Server now implements Closeable interface (#182).
  • Fixed /order_book endpoint streaming.

0.6.0

  • Horizon 0.17.0 features (#180)
  • Enable setting custom base fee (#177)

0.5.0

  • Horizon 0.16.0 features (#172)
  • Allow no signatures in Transaction.toEnvelopeXdr (#164)
  • Fix dependencies shadowing (#173)

0.4.1

  • Fixed streaming issues.

0.4.0

  • Breaking change Transaction.Builder requires setTimeout method to be called.
  • Added Horizon 0.15.0 features.
  • Improved streaming code and dependencies (thanks @jillesvangurp!).
  • SEP-0005 derivation (thanks @westonal!).

0.3.2

  • Non ed25519 keys are now supported in all responses (fixes #126):
    • SetOptionsOperationResponse.getSigner is deprecated. Please use SetOptionsOperationResponse.getSignerKey.
    • AccountResponse.Signer.getAccountId is deprecated. Please use AccountResponse.Signer.getKey.
  • Fixed PathPaymentOperationResponse.getSourceAsset method (#125).

0.3.1

  • Fixed condition check in TimeBounds when maxTime is equal 0.

0.3.0

  • Protocol V10 updates:
    • BumpSequence operation support (CAP-0001,
    • Asset liabilities (CAP-0003,
    • New Horizon fields and effects.
    • Updated XDR classes.
  • Transaction now has methods to create it from previously built TransactionEnvelope.
  • Improved Server.submitTransaction method, now throws exception for timeouts.

0.2.2

  • Fixed MemoReturnHash#toXdr() method.
  • Patch for Horizon Timeout responses (SubmitTransactionResponse.getEnvelopeXdr() and SubmitTransactionResponse.getResultXdr()).

0.2.1

  • Full compatibility with Horizon 0.13.0 API.
  • Fixed Page.getNextPage #66.

0.2.0

  • Java SDK now works in Android!
  • Price constructor is now public.
  • Added support for new endpoints and fields added in Horizon v0.12.0.

0.1.14

  • Fixed pad() method in XdrInputStream.
  • Added utf8 string support for XdrDataInputStream and XdrDataOutputStream.
  • Fixed AllowTrustOperation.Builder for ASSET_TYPE_CREDIT_ALPHANUM12 assets.

0.1.13

  • KeyPair.sign now throws RuntimeException when KeyPair object does not contain a secret key.
  • SubmitTransactionResponse.getOfferIdFromResult if offer was taken and tx_result does not contain offer ID.

0.1.12

  • Regenerated XDR classes:
    • XdrDataOutputStream class is now padding opaque data.
    • XdrDataInputStream class is now throwing an IOException when padding bytes are not zeros.
    • Made methods that shouldn't be used outside of XdrDataOutputStream and XdrDataInputStream classes private.
    • Removed unused imports and variables.

0.1.11

  • Added ability to set TimeBounds using Transaction.Builder
  • Implemented /order_book and /order_book/trades requests.

0.1.10

  • Fixed a bug in AssetDeserializer.
  • Fixed a bug in TransactionResponse.

0.1.9

  • Support for new signer types: sha256Hash, preAuthTx.
  • Breaking change Network must be explicitly selected. Previously testnet was a default network.

0.1.8

  • New location of stellar.toml file

0.1.7

  • Support for ManageData operation (c5faa15),
  • AccountFlag enum (4b67e2d).

0.1.6

  • Fixed a bug in OffersRequestBuilder.execute(URI uri) (799f0df).

0.1.5

  • Offers for Accounts (d5225bc),
  • Add Helper methods for SubmitTransactionResponse (6d14284).

0.1.4

0.1.3

  • Added ResultCodes to SubmitTransactionResponse (79e2260).

0.1.2

  • Rate limiting data in responses (e0ee7f1).
  • Fixed a bug in Transaction.Builder.build() (657c720).

0.1.1

  • Transaction.Builder.addOperation is now thread safe (248a4a1).
  • Added hashCode method for Asset classes (ab822e5).
  • FederationResponse constructor is now public. (c4c5a4d).
  • Updates to javadoc.

0.1.0