CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

5.1.1 - 2020-09-01

This release contains updated dependencies for stability and security.

5.1.0 - 2020-08-17

Added

• A new method, sendWithDetails, is exposed on the XRPClient and XpringClient, allowing memo data to be attached to the transaction when sending XRP.

• A new method enableDepositAuth is added to XRPClient which enables Deposit Authorization for the specified XRPL account. (See https://xrpl.org/depositauth.html)

5.0.1 - 2020-08-01

This release contains updated dependencies for stability and security.

5.0.0 - 2020-07-15

Removed

• XRPTransaction.account and XRPTransaction.sourceTag were deprecated for two releases and have been removed. Please use the X-address encoded field sourceXAddress instead.
• XRPPayment.destination and XRPPayment.destinationTag were deprecated for two releases and have been removed. Please use the X-address encoded field destinationXAddress instead.

4.0.0 - 2020-06-25

This new release contains production ready classes for PayID.

Breaking Changes

• PayIDClient is no longer bound to a single network at initialization time. Instead, networks are passed to the class as method parameters.

Added

• A new method, cryptoAddress(for:on:callbackQueue:completion:), replaces address(for:callbackQueue:completion:) method in PayIDClient.
• A new method, cryptoAddress(for:on:), replaces address(for:), method in PayIDClient.
• A new method, allAddresses(for:callbackQueue:completion:), is added to PayIDClient.
• A new method, allAddresses(for:), is added to PayIDClient.
• A new parameter, callbackQueue is added to PayIDClient's address(for:completion) method.
• A new method, address(for:) is added to PayIDClient to provide synchronous resolution functionality.
• A new parameter, callbackQueue is added to XRPPayIDClient's xrpAddress(for:completion) method.
• A new method, xrpAddress(for:) is added to XRPPayIDClient to provide synchronous resolution functionality.
• A new parameter, callbackQueue is added to XpringClient's send(_:to:from:completion) method.
• A new method, send(_:to:from:) is added to XpringClient to provide synchronous send functionality.

Removed

• The network parameter in PayIDClient's initializer is removed.
• address(for:callbackQueue:completion:) is removed from PayIDClient.
• address(for:) is removed from PayIDClient.

3.2.2 - 2020-06-18

Fixed

• Destination tags were being dropped from payments. This release fixes the issue.

3.2.1 - 2020-06-16

Added

• XRPPayment and XRPTransaction now contain X-address representations of their address and tag fields. (See https://xrpaddress.info/)
• A new method on PayIDClient, address(for:), provides a synchronous implementation of address(for:completion:).
• A new parameter, callbackQueue, in PayIDClient's address(for:callbackQueue:completion:) allows callers to specify the queue to run the callback on.

Deprecated

• XRPTransaction.account and XRPTransaction.sourceTag are deprecated. Please use the X-address encoded field sourceXAddress instead.
• XRPPayment.destination and XRPPayment.destinationTag are deprecated.
  Please use the X-address encoded field destinationXAddress instead.

3.2.0 - 2020-06-04

Added

• A new method, getPayment, added to XRPClient for retrieving payment transactions by hash.
• A new class, DefaultILPCLient, provides the functionality of DefaultIlpClient under an idiomatic name.
• A new class, ILPClient, provides the functionality of IlpClient under an idiomatic name.
• A new protocol, ILPClientDecorator, provides the functionality of IlpClientDecorator under an idiomatic name.
• A new enum, ILPError, provides the functionality of IlpError under an idiomatic name.
• A new class, ILPNetworkBalanceClient, provides the functionality of IlpNetworkBalanceClient under an idiomatic name.
• A new class, ILPNetworkPaymentClient, provides the functionality of IlpNetworkPaymentClient under an idiomatic name.
• A new class, ILPCredentials, provides the functionality of IlpCredentials under an idiomatic name.

Deprecated

• DefaultIlpClient is now deprecated. Please use DefaultILPClient instead.
• IlpClient is now deprecated. Please use ILPClient instead.
• IlpClientDecorator is now deprecated. Please use ILPClientDecorator instead.
• IlpError is now deprecated. Please use ILPError instead.
• IlpNetworkBalanceClient is now deprecated. Please use ILPNetworkBalanceClient instead.
• IlpNetworkPaymentClient is now deprecated. Please use ILPNetworkPaymentClient instead.
• IlpCredentials is now deprecated. Please use ILPCredentials instead.

3.1.1 - 2020-05-15

This fix release contains minor updates and performance improvements.

3.1.0 - May 6, 2020

Added

• xrpToDrops and dropsToXrp conversion utilities added to Utils

3.0.0 - March 27, 2020

This release contains serveral breaking changes that are required in order to:

• Support more protocols than just XRP Ledger (ILP, etc)
• Migrate the library to use the rippled node directly

Please note the changes and deprecations below.

Removed

• All legacy services are removed from XpringKit. All RPC's go through rippled's protocol buffer API.
• getTransactionStatus is removed. Please use getPaymentStatus instead.

Changed

• XRPClient requires a new parameter in its constructor that identifies the network it is attached to.
• XRPClient now uses rippled's protocol buffer API rather than the legacy API. Users who wish to use the legacy API should pass false for useNewProtocolBuffers in the constructor.
• IlpClient methods now throw IlpErrors if something goes wrong during the call (either client side or server side). This is only breaking if users are handling special error cases, which were previously RPCErrors

Added

• A new getPaymentStatus is added which retrieves the status of payment transactions.

Deprecated

• getTransactionStatus is deprecated. Please use getPaymentStatus instead.

2.0.0 - March 19, 2020

• Add a new paymentHistory method to XRPClient. This method allows clients to retrieve payment history for an address.
• XpringClient is removed from XpringKit. This class has been deprecated since 1.5.0. Clients should use XRPClient instead.
• Introduces a breaking change to IlpClient API.
  • IlpClient.getBalance now returns an AccountBalance instead of a protobuf generated GetBalanceResponse.
  • IlpClient.send has been changed to IlpClient.sendPayment to better align with other versions of the Xpring SDK
  • IlpClient.sendPayment now consumes a PaymentRequest instead of individual parameters, and now returns a PaymentResult instead of a protobuf generated SendPaymentResponse
• Fixed a bug in DefaultIlpClient. "Bearer " prefix was not being prepended to auth tokens, which caused authentication issues on Hermes.
  • "Bearer " prefix now gets prepended to auth tokens, if it is not already there

1.5.0 - March 9, 2020

This version introduces a public API to retrieve balances and send payments over ILP. Additionally, the deployment target for XpringKit is now explicitly set to macOS 10.13 and higher.

Changed

• XpringClient has been renamed to XRPClient, along with all associated classes, and should be used going forward. Top-level class XpringClient still exists alongside XRPClient and will be deprecated in the future.
• getTransactionStatus will now return TransactionStatus.unknown if the transaction hash provided references a transaction that is a partial payment or a non payment transaction. This behavior is only enabled when using the rippled protocol buffer implementation.

1.4.0 - Feb 28, 2020

This version uses new protocol buffers from rippled which have breaking changes in them. Specifically, the breaking changes include:

• Re-ordering and repurposing of fields in order to add additional layers of abstraction
• Change package from rpc.v1 to org.xrpl.rpc.v1

This change is transparent to public API users. However, clients will need to connect to a rippled node which is built at any commit after #3254.

1.3.0 - Feb 4, 2020