changenow fixes and update fixed rate to be more accurate in displaying rates

This commit is contained in:
julian 2022-09-08 10:56:29 -06:00
parent 9061b601c7
commit 0710b63129
6 changed files with 414 additions and 53 deletions

View file

@ -0,0 +1,163 @@
import 'package:decimal/decimal.dart';
import 'package:stackwallet/utilities/logger.dart';
enum CNEstimateType { direct, reverse }
enum CNFlowType implements Comparable<CNFlowType> {
standard("standard"),
fixedRate("fixed-rate");
const CNFlowType(this.value);
final String value;
@override
int compareTo(CNFlowType other) => value.compareTo(other.value);
}
class CNExchangeEstimate {
/// Ticker of the currency you want to exchange
final String fromCurrency;
/// Network of the currency you want to exchange
final String fromNetwork;
/// Ticker of the currency you want to receive
final String toCurrency;
/// Network of the currency you want to receive
final String toNetwork;
/// Type of exchange flow. Enum: ["standard", "fixed-rate"]
final CNFlowType flow;
/// Direction of exchange flow. Use "direct" value to set amount for
/// currencyFrom and get amount of currencyTo. Use "reverse" value to set
/// amount for currencyTo and get amount of currencyFrom.
/// Enum: ["direct", "reverse"]
final CNEstimateType type;
/// (Optional) Use rateId for fixed-rate flow. If this field is true, you
/// could use returned field "rateId" in next method for creating transaction
/// to freeze estimated amount that you got in this method. Current estimated
/// amount would be valid until time in field "validUntil"
final String? rateId;
/// Date and time before estimated amount would be freezed in case of using
/// rateId. If you set param "useRateId" to true, you could use returned field
/// "rateId" in next method for creating transaction to freeze estimated
/// amount that you got in this method. Estimated amount would be valid until
/// this date and time
final String? validUntil;
/// Dash-separated min and max estimated time in minutes
final String? transactionSpeedForecast;
/// Some warnings like warnings that transactions on this network
/// take longer or that the currency has moved to another network
final String? warningMessage;
/// Exchange amount of fromCurrency (in case when type=reverse it is an
/// estimated value)
final Decimal fromAmount;
/// Exchange amount of toCurrency (in case when type=direct it is an
/// estimated value)
final Decimal toAmount;
CNExchangeEstimate({
required this.fromCurrency,
required this.fromNetwork,
required this.toCurrency,
required this.toNetwork,
required this.flow,
required this.type,
this.rateId,
this.validUntil,
this.transactionSpeedForecast,
this.warningMessage,
required this.fromAmount,
required this.toAmount,
});
factory CNExchangeEstimate.fromJson(Map<String, dynamic> json) {
try {
final flow = CNFlowType.values
.firstWhere((element) => element.value == json["flow"]);
final type = CNEstimateType.values
.firstWhere((element) => element.name == json["type"]);
return CNExchangeEstimate(
fromCurrency: json["fromCurrency"] as String,
fromNetwork: json["fromNetwork"] as String,
toCurrency: json["toCurrency"] as String,
toNetwork: json["toNetwork"] as String,
flow: flow,
type: type,
rateId: json["rateId"] as String?,
validUntil: json["validUntil"] as String?,
transactionSpeedForecast: json["transactionSpeedForecast"] as String?,
warningMessage: json["warningMessage"] as String?,
fromAmount: Decimal.parse(json["fromAmount"].toString()),
toAmount: Decimal.parse(json["toAmount"].toString()),
);
} catch (e, s) {
Logging.instance
.log("Failed to parse: $json \n$e\n$s", level: LogLevel.Fatal);
rethrow;
}
}
Map<String, dynamic> toJson() {
return {
"fromCurrency": fromCurrency,
"fromNetwork": fromNetwork,
"toCurrency": toCurrency,
"toNetwork": toNetwork,
"flow": flow,
"type": type,
"rateId": rateId,
"validUntil": validUntil,
"transactionSpeedForecast": transactionSpeedForecast,
"warningMessage": warningMessage,
"fromAmount": fromAmount,
"toAmount": toAmount,
};
}
CNExchangeEstimate copyWith({
String? fromCurrency,
String? fromNetwork,
String? toCurrency,
String? toNetwork,
CNFlowType? flow,
CNEstimateType? type,
String? rateId,
String? validUntil,
String? transactionSpeedForecast,
String? warningMessage,
Decimal? fromAmount,
Decimal? toAmount,
}) {
return CNExchangeEstimate(
fromCurrency: fromCurrency ?? this.fromCurrency,
fromNetwork: fromNetwork ?? this.fromNetwork,
toCurrency: toCurrency ?? this.toCurrency,
toNetwork: toNetwork ?? this.toNetwork,
flow: flow ?? this.flow,
type: type ?? this.type,
rateId: rateId ?? this.rateId,
validUntil: validUntil ?? this.validUntil,
transactionSpeedForecast:
transactionSpeedForecast ?? this.transactionSpeedForecast,
warningMessage: warningMessage ?? this.warningMessage,
fromAmount: fromAmount ?? this.fromAmount,
toAmount: toAmount ?? this.toAmount,
);
}
@override
String toString() {
return "EstimatedExchangeAmount: ${toJson()}";
}
}

View file

@ -113,7 +113,7 @@ class EstimatedRateExchangeFormState extends ChangeNotifier {
await _updateMinFromAmount(shouldNotifyListeners: shouldNotifyListeners);
await updateRate();
await updateRate(shouldNotifyListeners: shouldNotifyListeners);
debugPrint(
"_updated TO: _from=${_from!.ticker} _to=${_to!.ticker} _fromAmount=$_fromAmount _toAmount=$_toAmount rate:$rate");
@ -138,7 +138,7 @@ class EstimatedRateExchangeFormState extends ChangeNotifier {
await _updateMinFromAmount(shouldNotifyListeners: shouldNotifyListeners);
await updateRate();
await updateRate(shouldNotifyListeners: shouldNotifyListeners);
debugPrint(
"_updated FROM: _from=${_from!.ticker} _to=${_to!.ticker} _fromAmount=$_fromAmount _toAmount=$_toAmount rate:$rate");
@ -182,7 +182,7 @@ class EstimatedRateExchangeFormState extends ChangeNotifier {
}
_fromAmount = newFromAmount;
await updateRate();
await updateRate(shouldNotifyListeners: shouldNotifyListeners);
if (shouldNotifyListeners) {
notifyListeners();
@ -256,7 +256,7 @@ class EstimatedRateExchangeFormState extends ChangeNotifier {
}
}
Future<void> updateRate() async {
Future<void> updateRate({bool shouldNotifyListeners = false}) async {
rate = null;
final amount = _fromAmount;
final minAmount = _minFromAmount;
@ -275,5 +275,8 @@ class EstimatedRateExchangeFormState extends ChangeNotifier {
_toAmount = amt;
}
}
if (shouldNotifyListeners) {
notifyListeners();
}
}
}

View file

@ -1,27 +1,44 @@
import 'package:decimal/decimal.dart';
import 'package:flutter/cupertino.dart';
import 'package:stackwallet/models/exchange/change_now/cn_exchange_estimate.dart';
import 'package:stackwallet/models/exchange/change_now/fixed_rate_market.dart';
import 'package:stackwallet/services/change_now/change_now.dart';
import 'package:stackwallet/utilities/logger.dart';
class FixedRateExchangeFormState extends ChangeNotifier {
Decimal? _fromAmount;
Decimal? _toAmount;
FixedRateMarket? _market;
FixedRateMarket? get market => _market;
CNExchangeEstimate? _estimate;
CNExchangeEstimate? get estimate => _estimate;
Decimal? get rate {
if (_estimate == null) {
return null;
} else {
return (_estimate!.toAmount / _estimate!.fromAmount)
.toDecimal(scaleOnInfinitePrecision: 12);
}
}
Future<void> swap(FixedRateMarket reverseFixedRateMarket) async {
final Decimal? tmp = _fromAmount;
_fromAmount = _toAmount;
_toAmount = tmp;
await updateMarket(reverseFixedRateMarket, true);
await updateMarket(reverseFixedRateMarket, false);
await updateRateEstimate(CNEstimateType.direct);
_toAmount = _estimate?.toAmount ?? Decimal.zero;
notifyListeners();
}
String get fromAmountString =>
_fromAmount == null ? "-" : _fromAmount!.toStringAsFixed(8);
_fromAmount == null ? "" : _fromAmount!.toStringAsFixed(8);
String get toAmountString =>
_toAmount == null ? "-" : _toAmount!.toStringAsFixed(8);
_toAmount == null ? "" : _toAmount!.toStringAsFixed(8);
Future<void> updateMarket(
FixedRateMarket? market,
@ -37,7 +54,7 @@ class FixedRateExchangeFormState extends ChangeNotifier {
if (_fromAmount! <= Decimal.zero) {
_toAmount = Decimal.zero;
} else {
_toAmount = (_fromAmount! * _market!.rate) - _market!.minerFee;
await updateRateEstimate(CNEstimateType.direct);
}
}
}
@ -48,10 +65,10 @@ class FixedRateExchangeFormState extends ChangeNotifier {
}
String get rateDisplayString {
if (_market == null) {
if (_market == null || _estimate == null) {
return "N/A";
} else {
return "1 ${_market!.from.toUpperCase()} ~${_market!.rate.toStringAsFixed(8)} ${_market!.to.toUpperCase()}";
return "1 ${_estimate!.fromCurrency.toUpperCase()} ~${rate!.toStringAsFixed(8)} ${_estimate!.toCurrency.toUpperCase()}";
}
}
@ -78,14 +95,10 @@ class FixedRateExchangeFormState extends ChangeNotifier {
Decimal newToAmount,
bool shouldNotifyListeners,
) async {
if (_market != null) {
_fromAmount = (newToAmount / _market!.rate)
.toDecimal(scaleOnInfinitePrecision: 12) +
_market!.minerFee;
}
_toAmount = newToAmount;
if (shouldNotifyListeners) {
await updateRateEstimate(CNEstimateType.reverse);
notifyListeners();
}
}
@ -94,12 +107,10 @@ class FixedRateExchangeFormState extends ChangeNotifier {
Decimal newFromAmount,
bool shouldNotifyListeners,
) async {
if (_market != null) {
_toAmount = (newFromAmount * _market!.rate) - _market!.minerFee;
}
_fromAmount = newFromAmount;
if (shouldNotifyListeners) {
await updateRateEstimate(CNEstimateType.direct);
notifyListeners();
}
}
@ -115,4 +126,53 @@ class FixedRateExchangeFormState extends ChangeNotifier {
notifyListeners();
}
}
Future<void> updateRateEstimate(CNEstimateType direction) async {
if (market != null) {
Decimal? amount;
// set amount based on trade estimate direction
switch (direction) {
case CNEstimateType.direct:
if (_fromAmount != null
// &&
// market!.min >= _fromAmount! &&
// _fromAmount! <= market!.max
) {
amount = _fromAmount!;
}
break;
case CNEstimateType.reverse:
if (_toAmount != null
// &&
// market!.min >= _toAmount! &&
// _toAmount! <= market!.max
) {
amount = _toAmount!;
}
break;
}
if (amount != null && market != null && amount > Decimal.zero) {
final response = await ChangeNow.instance.getEstimatedExchangeAmountV2(
fromTicker: market!.from,
toTicker: market!.to,
fromOrTo: direction,
flow: CNFlowType.fixedRate,
amount: amount,
);
if (response.value != null) {
// update estimate if response succeeded
_estimate = response.value;
_toAmount = _estimate?.toAmount;
_fromAmount = _estimate?.fromAmount;
notifyListeners();
} else if (response.exception != null) {
Logging.instance.log("updateRateEstimate(): ${response.exception}",
level: LogLevel.Warning);
}
}
}
}
}

View file

@ -7,6 +7,7 @@ import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_svg/flutter_svg.dart';
import 'package:flutter_svg/svg.dart';
import 'package:stackwallet/models/exchange/change_now/available_floating_rate_pair.dart';
import 'package:stackwallet/models/exchange/change_now/cn_exchange_estimate.dart';
import 'package:stackwallet/models/exchange/change_now/currency.dart';
import 'package:stackwallet/models/exchange/change_now/fixed_rate_market.dart';
import 'package:stackwallet/models/exchange/incomplete_exchange.dart';
@ -1011,6 +1012,24 @@ class _ExchangeViewState extends ConsumerState<ExchangeView> {
final to = availableCurrencies.firstWhere(
(e) => e.ticker == toTicker);
final newFromAmount =
Decimal.tryParse(_sendController.text);
if (newFromAmount != null) {
await ref
.read(
estimatedRateExchangeFormProvider)
.setFromAmountAndCalculateToAmount(
newFromAmount, false);
} else {
await ref
.read(
estimatedRateExchangeFormProvider)
.setFromAmountAndCalculateToAmount(
Decimal.zero, false);
_receiveController.text = "";
}
await ref
.read(estimatedRateExchangeFormProvider)
.updateTo(to, false);
@ -1055,6 +1074,23 @@ class _ExchangeViewState extends ConsumerState<ExchangeView> {
} catch (_) {
market = null;
}
final newFromAmount =
Decimal.tryParse(_sendController.text);
if (newFromAmount != null) {
await ref
.read(fixedRateExchangeFormProvider)
.setFromAmountAndCalculateToAmount(
newFromAmount, false);
} else {
await ref
.read(fixedRateExchangeFormProvider)
.setFromAmountAndCalculateToAmount(
Decimal.zero, false);
_receiveController.text = "";
}
await ref
.read(fixedRateExchangeFormProvider)
.updateMarket(market, false);
@ -1233,11 +1269,12 @@ class _ExchangeViewState extends ConsumerState<ExchangeView> {
final response = await ref
.read(changeNowProvider)
.getEstimatedFixedRateExchangeAmount(
.getEstimatedExchangeAmountV2(
fromTicker: fromTicker,
toTicker: toTicker,
fromAmount: sendAmount,
useRateId: true,
fromOrTo: CNEstimateType.direct,
amount: sendAmount,
flow: CNFlowType.fixedRate,
);
bool? shouldCancel;
@ -1314,15 +1351,14 @@ class _ExchangeViewState extends ConsumerState<ExchangeView> {
}
String rate =
"1 $fromTicker ~${ref.read(fixedRateExchangeFormProvider).market!.rate.toStringAsFixed(8)} $toTicker";
"1 $fromTicker ~${ref.read(fixedRateExchangeFormProvider).rate!.toStringAsFixed(8)} $toTicker";
final model = IncompleteExchangeModel(
sendTicker: fromTicker,
receiveTicker: toTicker,
rateInfo: rate,
sendAmount: sendAmount,
receiveAmount:
response.value!.estimatedAmount,
receiveAmount: response.value!.toAmount,
rateId: response.value!.rateId,
rateType: rateType,
);

View file

@ -6,6 +6,7 @@ import 'package:flutter/services.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:flutter_svg/svg.dart';
import 'package:stackwallet/models/exchange/change_now/available_floating_rate_pair.dart';
import 'package:stackwallet/models/exchange/change_now/cn_exchange_estimate.dart';
import 'package:stackwallet/models/exchange/change_now/currency.dart';
import 'package:stackwallet/models/exchange/change_now/fixed_rate_market.dart';
import 'package:stackwallet/models/exchange/incomplete_exchange.dart';
@ -1436,11 +1437,12 @@ class _WalletInitiatedExchangeViewState
final response = await ref
.read(changeNowProvider)
.getEstimatedFixedRateExchangeAmount(
.getEstimatedExchangeAmountV2(
fromTicker: fromTicker,
toTicker: toTicker,
fromAmount: sendAmount,
useRateId: true,
fromOrTo: CNEstimateType.direct,
amount: sendAmount,
flow: CNFlowType.fixedRate,
);
bool? shouldCancel;
@ -1518,15 +1520,14 @@ class _WalletInitiatedExchangeViewState
}
String rate =
"1 $fromTicker ~${ref.read(fixedRateExchangeFormProvider).market!.rate.toStringAsFixed(8)} $toTicker";
"1 $fromTicker ~${ref.read(fixedRateExchangeFormProvider).rate!.toStringAsFixed(8)} $toTicker";
final model = IncompleteExchangeModel(
sendTicker: fromTicker,
receiveTicker: toTicker,
rateInfo: rate,
sendAmount: sendAmount,
receiveAmount:
response.value!.estimatedAmount,
receiveAmount: response.value!.toAmount,
rateId: response.value!.rateId,
rateType: rateType,
);

View file

@ -6,6 +6,7 @@ import 'package:http/http.dart' as http;
import 'package:stackwallet/external_api_keys.dart';
import 'package:stackwallet/models/exchange/change_now/available_floating_rate_pair.dart';
import 'package:stackwallet/models/exchange/change_now/change_now_response.dart';
import 'package:stackwallet/models/exchange/change_now/cn_exchange_estimate.dart';
import 'package:stackwallet/models/exchange/change_now/currency.dart';
import 'package:stackwallet/models/exchange/change_now/estimated_exchange_amount.dart';
import 'package:stackwallet/models/exchange/change_now/exchange_transaction.dart';
@ -17,6 +18,7 @@ class ChangeNow {
static const String scheme = "https";
static const String authority = "api.changenow.io";
static const String apiVersion = "/v1";
static const String apiVersionV2 = "/v2";
ChangeNow._();
static final ChangeNow _instance = ChangeNow._();
@ -29,6 +31,10 @@ class ChangeNow {
return Uri.https(authority, apiVersion + path, params);
}
Uri _buildUriV2(String path, Map<String, dynamic>? params) {
return Uri.https(authority, apiVersionV2 + path, params);
}
Future<dynamic> _makeGetRequest(Uri uri) async {
final client = this.client ?? http.Client();
try {
@ -47,6 +53,27 @@ class ChangeNow {
}
}
Future<dynamic> _makeGetRequestV2(Uri uri, String apiKey) async {
final client = this.client ?? http.Client();
try {
final response = await client.get(
uri,
headers: {
// 'Content-Type': 'application/json',
'x-changenow-api-key': apiKey,
},
);
final parsed = jsonDecode(response.body);
return parsed;
} catch (e, s) {
Logging.instance
.log("_makeRequestV2($uri) threw: $e\n$s", level: LogLevel.Error);
rethrow;
}
}
Future<dynamic> _makePostRequest(
Uri uri,
Map<String, String> body,
@ -283,37 +310,109 @@ class ChangeNow {
}
}
// old v1 version
/// This API endpoint returns fixed-rate estimated exchange amount of
/// [toTicker] cryptocurrency to receive for [fromAmount] of [fromTicker]
Future<ChangeNowResponse<EstimatedExchangeAmount>>
getEstimatedFixedRateExchangeAmount({
// Future<ChangeNowResponse<EstimatedExchangeAmount>>
// getEstimatedFixedRateExchangeAmount({
// required String fromTicker,
// required String toTicker,
// required Decimal fromAmount,
// // (Optional) Use rateId for fixed-rate flow. If this field is true, you
// // could use returned field "rateId" in next method for creating transaction
// // to freeze estimated amount that you got in this method. Current estimated
// // amount would be valid until time in field "validUntil"
// bool useRateId = true,
// String? apiKey,
// }) async {
// Map<String, dynamic> params = {
// "api_key": apiKey ?? kChangeNowApiKey,
// "useRateId": useRateId.toString(),
// };
//
// final uri = _buildUri(
// "/exchange-amount/fixed-rate/${fromAmount.toString()}/${fromTicker}_$toTicker",
// params,
// );
//
// try {
// // simple json object is expected here
// final json = await _makeGetRequest(uri);
//
// try {
// final value = EstimatedExchangeAmount.fromJson(
// Map<String, dynamic>.from(json as Map));
// return ChangeNowResponse(value: value);
// } catch (_) {
// return ChangeNowResponse(
// exception: ChangeNowException(
// "Failed to serialize $json",
// ChangeNowExceptionType.serializeResponseError,
// ),
// );
// }
// } catch (e, s) {
// Logging.instance.log(
// "getEstimatedFixedRateExchangeAmount exception: $e\n$s",
// level: LogLevel.Error);
// return ChangeNowResponse(
// exception: ChangeNowException(
// e.toString(),
// ChangeNowExceptionType.generic,
// ),
// );
// }
// }
/// Get estimated amount of [toTicker] cryptocurrency to receive
/// for [fromAmount] of [fromTicker]
Future<ChangeNowResponse<CNExchangeEstimate>> getEstimatedExchangeAmountV2({
required String fromTicker,
required String toTicker,
required Decimal fromAmount,
// (Optional) Use rateId for fixed-rate flow. If this field is true, you
// could use returned field "rateId" in next method for creating transaction
// to freeze estimated amount that you got in this method. Current estimated
// amount would be valid until time in field "validUntil"
bool useRateId = true,
required CNEstimateType fromOrTo,
required Decimal amount,
String? fromNetwork,
String? toNetwork,
CNFlowType flow = CNFlowType.standard,
String? apiKey,
}) async {
Map<String, dynamic> params = {
"api_key": apiKey ?? kChangeNowApiKey,
"useRateId": useRateId.toString(),
Map<String, dynamic>? params = {
"fromCurrency": fromTicker,
"toCurrency": toTicker,
"flow": flow.value,
"type": fromOrTo.name,
};
final uri = _buildUri(
"/exchange-amount/fixed-rate/${fromAmount.toString()}/${fromTicker}_$toTicker",
params,
);
switch (fromOrTo) {
case CNEstimateType.direct:
params["fromAmount"] = amount.toString();
break;
case CNEstimateType.reverse:
params["toAmount"] = amount.toString();
break;
}
if (fromNetwork != null) {
params["fromNetwork"] = fromNetwork;
}
if (toNetwork != null) {
params["toNetwork"] = toNetwork;
}
if (flow == CNFlowType.fixedRate) {
params["useRateId"] = "true";
}
final uri = _buildUriV2("/exchange/estimated-amount", params);
try {
// simple json object is expected here
final json = await _makeGetRequest(uri);
final json = await _makeGetRequestV2(uri, apiKey ?? kChangeNowApiKey);
try {
final value = EstimatedExchangeAmount.fromJson(
Map<String, dynamic>.from(json as Map));
final value =
CNExchangeEstimate.fromJson(Map<String, dynamic>.from(json as Map));
return ChangeNowResponse(value: value);
} catch (_) {
return ChangeNowResponse(
@ -324,8 +423,7 @@ class ChangeNow {
);
}
} catch (e, s) {
Logging.instance.log(
"getEstimatedFixedRateExchangeAmount exception: $e\n$s",
Logging.instance.log("getEstimatedExchangeAmountV2 exception: $e\n$s",
level: LogLevel.Error);
return ChangeNowResponse(
exception: ChangeNowException(