bat_helper.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef BRAVELEDGER_BAT_HELPER_H_
#define BRAVELEDGER_BAT_HELPER_H_

#include <string>
#include <vector>
#include <map>
#include <functional>

#include "bat_helper_platform.h"
#include "static_values.h"

namespace braveledger_bat_helper {

  struct REQUEST_CREDENTIALS_ST {
    REQUEST_CREDENTIALS_ST();
    ~REQUEST_CREDENTIALS_ST();

    std::string proof_;
    std::string requestType_;
    std::string request_body_currency_;
    std::string request_body_label_;
    std::string request_body_publicKey_;
    std::string request_body_octets_;
    std::string request_headers_digest_;
    std::string request_headers_signature_;
  };

  struct UNSIGNED_TX {
    UNSIGNED_TX();
    ~UNSIGNED_TX();

    std::string amount_;
    std::string currency_;
    std::string destination_;
  };

  struct RECONCILE_PAYLOAD_ST {
    RECONCILE_PAYLOAD_ST();
    ~RECONCILE_PAYLOAD_ST();

    std::string requestType_;
    std::string request_signedtx_headers_digest_;
    std::string request_signedtx_headers_signature_;
    UNSIGNED_TX request_signedtx_body_;
    std::string request_signedtx_octets_;
    std::string request_viewingId_;
    std::string request_surveyorId_;
  };

  struct WALLET_INFO_ST {
    WALLET_INFO_ST();
    WALLET_INFO_ST(const WALLET_INFO_ST&);
    ~WALLET_INFO_ST();

    //load from json string
    bool loadFromJson(const std::string & json);

    std::string paymentId_;
    std::string addressBAT_;
    std::string addressBTC_;
    std::string addressCARD_ID_;
    std::string addressETH_;
    std::string addressLTC_;
    std::vector<uint8_t> keyInfoSeed_;
  };

  struct TRANSACTION_BALLOT_ST {
    TRANSACTION_BALLOT_ST();
    ~TRANSACTION_BALLOT_ST();

    //load from json string
    bool loadFromJson(const std::string & json);

    std::string publisher_;
    unsigned int offset_ = 0u;
  };

  struct TRANSACTION_ST {
    TRANSACTION_ST();
    TRANSACTION_ST(const TRANSACTION_ST& transaction);
    ~TRANSACTION_ST();

    //load from json string
    bool loadFromJson(const std::string & json);

    std::string viewingId_;
    std::string surveyorId_;
    std::string contribution_fiat_amount_;
    std::string contribution_fiat_currency_;
    std::map<std::string, double> contribution_rates_;
    std::string contribution_altcurrency_;
    std::string contribution_probi_;
    std::string contribution_fee_;
    std::string submissionStamp_;
    std::string submissionId_;
    std::string anonizeViewingId_;
    std::string registrarVK_;
    std::string masterUserToken_;
    std::vector<std::string> surveyorIds_;
    std::string satoshis_;
    std::string altCurrency_;
    std::string probi_;
    unsigned int votes_ = 0u;
    std::vector<TRANSACTION_BALLOT_ST> ballots_;
  };

  struct BALLOT_ST {
    BALLOT_ST();
    BALLOT_ST(const BALLOT_ST& ballot);
    ~BALLOT_ST();

    // Load from json string
    bool loadFromJson(const std::string & json);

    std::string viewingId_;
    std::string surveyorId_;
    std::string publisher_;
    unsigned int offset_ = 0u;
    std::string prepareBallot_;
    std::string proofBallot_;
    uint64_t delayStamp_ = 0u;
  };

  struct BATCH_VOTES_INFO_ST {
    BATCH_VOTES_INFO_ST();
    BATCH_VOTES_INFO_ST(const BATCH_VOTES_INFO_ST&);
    ~BATCH_VOTES_INFO_ST();

    // Load from json string
    bool loadFromJson(const std::string & json);

    std::string surveyorId_;
    std::string proof_;
  };

  struct BATCH_VOTES_ST {
    BATCH_VOTES_ST();
    BATCH_VOTES_ST(const BATCH_VOTES_ST&);
    ~BATCH_VOTES_ST();

    // Load from json string
    bool loadFromJson(const std::string & json);

    std::string publisher_;
    std::vector<BATCH_VOTES_INFO_ST> batchVotesInfo_;
  };

  struct GRANT {
    GRANT();
    ~GRANT();
    std::string altcurrency;
    std::string probi;
    uint64_t expiryTime;
  };

  struct WALLET_PROPERTIES_ST {
    WALLET_PROPERTIES_ST();
    ~WALLET_PROPERTIES_ST();
    WALLET_PROPERTIES_ST(const WALLET_PROPERTIES_ST& properties);

    //load from json string
    bool loadFromJson(const std::string & json);

    std::string altcurrency_;
    std::string probi_;
    double balance_;
    std::map<std::string, double> rates_;
    std::vector<double> parameters_choices_;
    std::vector<double> parameters_range_;
    unsigned int parameters_days_;
    std::vector<GRANT> grants_;
  };

  struct CLIENT_STATE_ST {
    CLIENT_STATE_ST();
    CLIENT_STATE_ST(const CLIENT_STATE_ST&);
    ~CLIENT_STATE_ST();

    // Load from json string
    bool loadFromJson(const std::string & json);

    WALLET_INFO_ST walletInfo_;
    WALLET_PROPERTIES_ST walletProperties_;
    uint64_t bootStamp_ = 0u;
    uint64_t reconcileStamp_ = 0u;
    std::string personaId_;
    std::string userId_;
    std::string registrarVK_;
    std::string masterUserToken_;
    std::string preFlight_;
    std::string fee_currency_;
    std::string settings_= AD_FREE_SETTINGS;
    double fee_amount_ = .0;
    unsigned int days_ = 0u;
    std::vector<TRANSACTION_ST> transactions_;
    std::vector<BALLOT_ST> ballots_;
    std::string ruleset_;
    std::string rulesetV2_;
    std::vector<BATCH_VOTES_ST> batch_;
  };

  struct PUBLISHER_STATE_ST {
    PUBLISHER_STATE_ST();
    ~PUBLISHER_STATE_ST();

    //load from json string
    bool loadFromJson(const std::string & json);

    unsigned int min_pubslisher_duration_ = braveledger_ledger::_default_min_pubslisher_duration;  // In milliseconds
    unsigned int min_visits_ = 1u;
    bool allow_non_verified_ = true;
  };

  struct PUBLISHER_ST {
    PUBLISHER_ST();
    ~PUBLISHER_ST();
    bool operator<(const PUBLISHER_ST& rhs) const;

    std::string id_;
    uint64_t duration_ = 0u;
    double score_ = .0;
    unsigned int visits_ = 0;
    unsigned int percent_ = 0;
    double weight_ = .0;
  };

  struct WINNERS_ST {
    WINNERS_ST();
    ~WINNERS_ST();

    PUBLISHER_ST publisher_data_;
    unsigned int votes_ = 0;
  };

  struct SURVEYOR_INFO_ST {
    SURVEYOR_INFO_ST();
    ~SURVEYOR_INFO_ST();

    std::string surveyorId_;
  };

  struct SURVEYOR_ST {
    SURVEYOR_ST();
    ~SURVEYOR_ST();

    //load from json string
    bool loadFromJson(const std::string & json);

    std::string signature_;
    std::string surveyorId_;
    std::string surveyVK_;
    std::string registrarVK_;
    std::string surveySK_;
  };

  // The struct is serialized/deserialized from/into JSON as part of MEDIA_PUBLISHER_INFO
  struct TWITCH_EVENT_INFO {
    TWITCH_EVENT_INFO();
    TWITCH_EVENT_INFO(const TWITCH_EVENT_INFO&);
    ~TWITCH_EVENT_INFO();

    std::string event_;
    std::string time_;
    std::string status_;
  };

  struct MEDIA_PUBLISHER_INFO {
    MEDIA_PUBLISHER_INFO();
    MEDIA_PUBLISHER_INFO(const MEDIA_PUBLISHER_INFO&);
    ~MEDIA_PUBLISHER_INFO();

    //load from json string
    bool loadFromJson(const std::string & json);

    std::string publisherName_;
    std::string publisherURL_;
    std::string favIconURL_;
    std::string channelName_;
    std::string publisher_;
    TWITCH_EVENT_INFO twitchEventInfo_;
  };

  struct BATCH_PROOF {
    BATCH_PROOF();
    ~BATCH_PROOF();

    TRANSACTION_ST transaction_;
    BALLOT_ST ballot_;
  };

  struct CURRENT_RECONCILE {
    CURRENT_RECONCILE();
    ~CURRENT_RECONCILE();

    std::string viewingId_;
    std::string anonizeViewingId_;
    std::string registrarVK_;
    std::string preFlight_;
    std::string masterUserToken_;
    SURVEYOR_INFO_ST surveyorInfo_;
    uint64_t timestamp_ = 0u;
    std::map<std::string, double> rates_;
    std::string amount_;
    std::string currency_;
  };

  using GetMediaPublisherInfoSignature = void(uint64_t, const braveledger_bat_helper::MEDIA_PUBLISHER_INFO&);
  using SaveVisitSignature = void(const std::string&, uint64_t);
  using GetMediaPublisherInfoCallback = std::function<GetMediaPublisherInfoSignature>;
  using SaveVisitCallback = std::function<SaveVisitSignature>;

  bool getJSONValue(const std::string& fieldName, const std::string& json, std::string & value);

  bool getJSONList(const std::string& fieldName, const std::string& json, std::vector<std::string> & value);

  bool getJSONWalletInfo(const std::string& json, WALLET_INFO_ST& walletInfo,
    std::string& fee_currency, double& fee_amount, unsigned int& days);

  bool getJSONPublisherVerified(const std::string& json, bool& verified);

  bool getJSONUnsignedTx(const std::string& json, UNSIGNED_TX& unsignedTx);

  bool getJSONTransaction(const std::string& json, TRANSACTION_ST& transaction);

  bool getJSONRates(const std::string& json, std::map<std::string, double>& rates);

  bool getJSONTwitchProperties(const std::string& json, std::vector<std::map<std::string, std::string>>& parts);

  bool getJSONBatchSurveyors(const std::string& json, std::vector<std::string>& surveyors);

  std::vector<uint8_t> generateSeed();

  std::vector<uint8_t> getHKDF(const std::vector<uint8_t>& seed);

  void getPublicKeyFromSeed(const std::vector<uint8_t>& seed, std::vector<uint8_t>& publicKey, std::vector<uint8_t>& secretKey);

  std::string uint8ToHex(const std::vector<uint8_t>& in);

  std::string stringify(std::string* keys, std::string* values, const unsigned int& size);

  std::string stringifyRequestCredentialsSt(const REQUEST_CREDENTIALS_ST& request_credentials);

  std::string stringifyReconcilePayloadSt(const RECONCILE_PAYLOAD_ST& reconcile_payload);

  std::string stringifyUnsignedTx(const UNSIGNED_TX& unsignedTx);

  std::string stringifyBatch(std::vector<BATCH_VOTES_INFO_ST> payload);

  std::vector<uint8_t> getSHA256(const std::string& in);

  std::string getBase64(const std::vector<uint8_t>& in);

  bool getFromBase64(const std::string& in, std::vector<uint8_t> & out);

  // Sign using ed25519 algorithm
  std::string sign(std::string* keys, std::string* values, const unsigned int& size,
      const std::string& keyId, const std::vector<uint8_t>& secretKey);

  uint64_t currentTime();

  void getUrlQueryParts(const std::string& query, std::map<std::string, std::string>& parts);

  void getTwitchParts(const std::string& query, std::vector<std::map<std::string, std::string>>& parts);

  std::string getMediaId(const std::map<std::string, std::string>& data, const std::string& type);

  std::string getMediaKey(const std::string& mediaId, const std::string& type);

  uint64_t getMediaDuration(const std::map<std::string, std::string>& data, const std::string& mediaKey, const std::string& type);
}  // namespace braveledger_bat_helper

#endif  // BRAVELEDGER_BAT_HELPER_H_