stack_wallet/lib/models/isar/exchange_cache/currency.dart

/* 
 * This file is part of Stack Wallet.
 * 
 * Copyright (c) 2023 Cypher Stack
 * All Rights Reserved.
 * The code is distributed under GPLv3 license, see LICENSE file for details.
 * Generated by Cypher Stack on 2023-05-26
 *
 */

import 'package:isar/isar.dart';
import 'package:stackwallet/models/isar/exchange_cache/pair.dart';
import 'package:stackwallet/supported_coins.dart';

part 'currency.g.dart';

@Collection(accessor: "currencies")
class Currency {
  Id? id;

  @Index()
  final String exchangeName;

  /// Currency ticker
  @Index(composite: [
    CompositeIndex("exchangeName"),
    CompositeIndex("name"),
  ])
  final String ticker;

  /// Currency name
  final String name;

  /// Currency network
  final String network;

  /// Currency logo url
  final String image;

  /// external id if it exists
  final String? externalId;

  /// Indicates if a currency is a fiat currency (EUR, USD)
  final bool isFiat;

  /// Indicates if a currency is available on a fixed-rate flow
  @enumerated
  final SupportedRateType rateType;

  /// (Optional - based on api call) Indicates whether the pair is
  /// currently supported by change now
  final bool? isAvailable;

  @Index()
  final bool isStackCoin;

  final String? tokenContract;

  @ignore
  bool get supportsFixedRate =>
      rateType == SupportedRateType.fixed || rateType == SupportedRateType.both;

  @ignore
  bool get supportsEstimatedRate =>
      rateType == SupportedRateType.estimated ||
      rateType == SupportedRateType.both;

  Currency({
    required this.exchangeName,
    required this.ticker,
    required this.name,
    required this.network,
    required this.image,
    this.externalId,
    required this.isFiat,
    required this.rateType,
    this.isAvailable,
    required this.isStackCoin,
    required this.tokenContract,
  });

  factory Currency.fromJson(
    Map<String, dynamic> json, {
    required String exchangeName,
    required SupportedRateType rateType,
  }) {
    try {
      final ticker = (json["ticker"] as String).toUpperCase();

      return Currency(
        exchangeName: exchangeName,
        ticker: ticker,
        name: json["name"] as String,
        network: json["network"] as String? ?? "",
        image: json["image"] as String,
        externalId: json["externalId"] as String?,
        isFiat: json["isFiat"] as bool,
        rateType: rateType,
        isAvailable: json["isAvailable"] as bool?,
        isStackCoin:
            json["isStackCoin"] as bool? ?? Currency.checkIsStackCoin(ticker),
        tokenContract: json["tokenContract"] as String?,
      )..id = json["id"] as int?;
    } catch (e) {
      rethrow;
    }
  }

  Map<String, dynamic> toJson() {
    final map = {
      "id": id,
      "exchangeName": exchangeName,
      "ticker": ticker,
      "name": name,
      "network": network,
      "image": image,
      "externalId": externalId,
      "isFiat": isFiat,
      "rateType": rateType,
      "isAvailable": isAvailable,
      "isStackCoin": isStackCoin,
      "tokenContract": tokenContract,
    };

    return map;
  }

  Currency copyWith({
    Id? id,
    String? exchangeName,
    String? ticker,
    String? name,
    String? network,
    String? image,
    String? externalId,
    bool? isFiat,
    SupportedRateType? rateType,
    bool? isAvailable,
    bool? isStackCoin,
    String? tokenContract,
  }) {
    return Currency(
      exchangeName: exchangeName ?? this.exchangeName,
      ticker: ticker ?? this.ticker,
      name: name ?? this.name,
      network: network ?? this.network,
      image: image ?? this.image,
      externalId: externalId ?? this.externalId,
      isFiat: isFiat ?? this.isFiat,
      rateType: rateType ?? this.rateType,
      isAvailable: isAvailable ?? this.isAvailable,
      isStackCoin: isStackCoin ?? this.isStackCoin,
      tokenContract: tokenContract ?? this.tokenContract,
    )..id = id ?? this.id;
  }

  @override
  String toString() {
    return "Currency: ${toJson()}";
  }

  static bool checkIsStackCoin(String ticker) {
    try {
      SupportedCoins.getCryptoCurrencyForTicker(ticker);
      return true;
    } catch (_) {
      return false;
    }
  }
}