Deprecate `Synchronizer.sendToAddress` and `Synchronizer.shieldFunds`

This commit is contained in:
Jack Grigg 2024-02-21 01:15:01 +00:00
parent df9e0ea424
commit a5208c4a93
4 changed files with 10 additions and 0 deletions

View File

@ -14,6 +14,10 @@ shielding funds, and then creating transactions from a proposal. The intermediat
proposal can be used to determine the required fee, before committing to producing proposal can be used to determine the required fee, before committing to producing
transactions. transactions.
The old `Synchronizer.sendToAddress` and `Synchronizer.shieldFunds` APIs have been
deprecated, and will be removed in 2.1.0 (which will create multiple transactions
at once for some recipients).
# 2.0.10 - 2024-02-12 # 2.0.10 - 2024-02-12
## Added ## Added

View File

@ -209,6 +209,7 @@ public protocol Synchronizer: AnyObject {
/// ///
/// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws /// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws
/// `SynchronizerErrors.notPrepared`. /// `SynchronizerErrors.notPrepared`.
@available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.")
func sendToAddress( func sendToAddress(
spendingKey: UnifiedSpendingKey, spendingKey: UnifiedSpendingKey,
zatoshi: Zatoshi, zatoshi: Zatoshi,
@ -222,6 +223,7 @@ public protocol Synchronizer: AnyObject {
/// ///
/// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws /// If `prepare()` hasn't already been called since creating of synchronizer instance or since the last wipe then this method throws
/// `SynchronizerErrors.notPrepared`. /// `SynchronizerErrors.notPrepared`.
@available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.")
func shieldFunds( func shieldFunds(
spendingKey: UnifiedSpendingKey, spendingKey: UnifiedSpendingKey,
memo: Memo, memo: Memo,

View File

@ -103,6 +103,7 @@ extension ClosureSDKSynchronizer: ClosureSynchronizer {
} }
} }
@available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.")
public func sendToAddress( public func sendToAddress(
spendingKey: UnifiedSpendingKey, spendingKey: UnifiedSpendingKey,
zatoshi: Zatoshi, zatoshi: Zatoshi,
@ -115,6 +116,7 @@ extension ClosureSDKSynchronizer: ClosureSynchronizer {
} }
} }
@available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.")
public func shieldFunds( public func shieldFunds(
spendingKey: UnifiedSpendingKey, spendingKey: UnifiedSpendingKey,
memo: Memo, memo: Memo,

View File

@ -99,6 +99,7 @@ extension CombineSDKSynchronizer: CombineSynchronizer {
} }
} }
@available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.")
public func sendToAddress( public func sendToAddress(
spendingKey: UnifiedSpendingKey, spendingKey: UnifiedSpendingKey,
zatoshi: Zatoshi, zatoshi: Zatoshi,
@ -110,6 +111,7 @@ extension CombineSDKSynchronizer: CombineSynchronizer {
} }
} }
@available(*, deprecated, message: "Upcoming SDK 2.1 will create multiple transactions at once for some recipients.")
public func shieldFunds( public func shieldFunds(
spendingKey: UnifiedSpendingKey, spendingKey: UnifiedSpendingKey,
memo: Memo, memo: Memo,