Skip to content

13.0.0-beta

Pre-release
Pre-release
Compare
Choose a tag to compare
@jopmiddelkamp jopmiddelkamp released this 25 Oct 09:15
· 1 commit to master since this release
db5e9a9

Release Notes for Version 13.0.0-beta

Overview

This release adds support for Protocol 22, introduces new features, updates existing functionalities, and includes several breaking changes. Please review the breaking changes section carefully before upgrading to ensure compatibility with your applications.

Full Changelog: Compare 12.1.1...13.0.0-beta

What's New

  • Protocol 22 Support: Updated the XDR schemes to support Protocol 22.
  • Transaction Hash (TxHash): Added TxHash (a hex-encoded transaction hash string) to GetTransactionResponse and GetTransactionsResponse via TransactionInfo.
  • Soroban Function Support: Added support for SOROBAN_AUTHORIZED_FUNCTION_TYPE_CREATE_CONTRACT_V2_HOST_FN through CreateContractV2HostFunction.
  • New Constructor: Introduced a LedgerKeyClaimableBalance constructor that accepts a string parameter.
  • Asynchronous Transaction Submission: Added the SubmitTransactionAsync function for asynchronous transaction processing.
  • Reference Links Update: Updated outdated reference links in the documentation.
  • Unit Tests Update: Enhanced Soroban unit tests for better coverage and reliability.

Breaking Changes

Data Type Modifications

  • TransactionInfo.CreatedAt Field:
    • Changed the data type from long to string. This affects GetTransactionResponse and GetTransactionsResponse indirectly via TransactionInfo.
  • OperationResponse.CreatedAt and TransactionResponse.CreatedAt Fields:
    • Changed the data type from string to DateTime.
  • DestinationAsset and SourceAsset Fields:
    • In PathPaymentStrictReceiveOperationResponse, changed the data type from AssetTypeCreditAlphaNum to Asset.

Removed Fields

  • Amount and NumAccounts:
    • Removed from AssetResponse.
  • Cost:
    • Removed from SimulateTransactionResponse.
  • PagingToken:
    • Removed from GetEventsResponse.EventInfo and replaced with GetEventsResponse.Cursor.

API Changes

  • Soroban Constructors in Contract Creation:
    • Added an extra parameter arguments to CreateContractOperation to support Soroban constructors via CreateContractV2HostFunction.
    • The arguments parameter has been added to the FromAsset and FromAddress static factory methods within CreateContractOperation.

Identifier Renaming for Consistency

  • Renamed identifiers to align with standard naming conventions:
    • ID changed to Id.
    • BP changed to Bp.
    • TTL changed to Ttl.

Upgrade Instructions

  • Review Breaking Changes: Carefully read through the breaking changes and adjust your code accordingly.
  • Update Data Types: Modify any code that interacts with the changed data types to ensure compatibility.
  • Refactor Removed Fields: Remove any dependencies on fields that have been eliminated.
  • Adjust API Usage: Update your implementation to accommodate the API changes, especially if you utilize contract creation functions.
  • Rename Identifiers: Refactor your codebase to use the new identifier names to prevent any conflicts or errors.

Conclusion

We appreciate your attention to these updates and are confident that these changes will enhance your development experience. If you encounter any issues or have questions you can create an issue or start a discussion on this repo.


Full Changelog: Compare 12.1.1...13.0.0-beta