wownero-lws/src/rpc/light_wallet.h

// Copyright (c) 2018-2020, The Monero Project
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of
//    conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
//    of conditions and the following disclaimer in the documentation and/or other
//    materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be
//    used to endorse or promote products derived from this software without specific
//    prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#pragma once

#include <boost/optional/optional.hpp>
#include <cstdint>
#include <string>
#include <utility>
#include <vector>

#include "common/expect.h" // monero/src
#include "crypto/crypto.h" // monero/src
#include "db/data.h"
#include "rpc/rates.h"
#include "util/fwd.h"
#include "wire/json/fwd.h"

namespace lws
{
namespace rpc
{
  //! Read/write uint64 value as JSON string.
  enum class safe_uint64 : std::uint64_t {};
  void read_bytes(wire::json_reader&, safe_uint64&);
  void write_bytes(wire::json_writer&, safe_uint64);

  //! Read an array of uint64 values as JSON strings.
  struct safe_uint64_array
  {
    std::vector<std::uint64_t> values; // so this can be passed to another function without copy
  };
  void read_bytes(wire::json_reader&, safe_uint64_array&);


  struct account_credentials
  {
    lws::db::account_address address;
    crypto::secret_key key;
  };
  void read_bytes(wire::json_reader&, account_credentials&);


  struct transaction_spend
  {
    transaction_spend() = delete;
    lws::db::output::spend_meta_ meta;
    lws::db::spend possible_spend;
  };
  void write_bytes(wire::json_writer&, const transaction_spend&);


  struct get_address_info_response
  {
    get_address_info_response() = delete;
    safe_uint64 locked_funds;
    safe_uint64 total_received;
    safe_uint64 total_sent;
    std::uint64_t scanned_height;
    std::uint64_t scanned_block_height;
    std::uint64_t start_height;
    std::uint64_t transaction_height;
    std::uint64_t blockchain_height;
    std::vector<transaction_spend> spent_outputs;
    expect<lws::rates> rates;
  };
  void write_bytes(wire::json_writer&, const get_address_info_response&);


  struct get_address_txs_response
  {
    get_address_txs_response() = delete;
    struct transaction
    {
      transaction() = delete;
      db::output info;
      std::vector<transaction_spend> spends;
      std::uint64_t spent;
    };

    safe_uint64 total_received;
    std::uint64_t scanned_height;
    std::uint64_t scanned_block_height;
    std::uint64_t start_height;
    std::uint64_t transaction_height;
    std::uint64_t blockchain_height;
    std::vector<transaction> transactions;
  };
  void write_bytes(wire::json_writer&, const get_address_txs_response&);


  struct get_random_outs_request
  {
    get_random_outs_request() = delete;
    std::uint64_t count;
    safe_uint64_array amounts;
  };
  void read_bytes(wire::json_reader&, get_random_outs_request&);

  struct get_random_outs_response
  {
    get_random_outs_response() = delete;
    std::vector<random_ring> amount_outs;
  };
  void write_bytes(wire::json_writer&, const get_random_outs_response&);


  struct get_unspent_outs_request
  {
    get_unspent_outs_request() = delete;
    safe_uint64 amount;
    boost::optional<safe_uint64> dust_threshold;
    boost::optional<std::uint32_t> mixin;
    boost::optional<bool> use_dust;
    account_credentials creds;
  };
  void read_bytes(wire::json_reader&, get_unspent_outs_request&);

  struct get_unspent_outs_response
  {
    get_unspent_outs_response() = delete;
    std::uint64_t per_kb_fee;
    std::uint64_t fee_mask;
    safe_uint64 amount;
    std::vector<std::pair<db::output, std::vector<crypto::key_image>>> outputs;
    crypto::secret_key user_key;
  };
  void write_bytes(wire::json_writer&, const get_unspent_outs_response&);


  struct import_response
  {
    import_response() = delete;
    safe_uint64 import_fee;
    const char* status;
    bool new_request;
    bool request_fulfilled;
  };
  void write_bytes(wire::json_writer&, const import_response&);


  struct login_request
  {
    login_request() = delete;
    account_credentials creds;
    bool create_account;
    bool generated_locally;
  };
  void read_bytes(wire::json_reader&, login_request&);

  struct login_response
  {
    login_response() = delete;
    bool new_address;
    bool generated_locally;
  };
  void write_bytes(wire::json_writer&, login_response);


  struct submit_raw_tx_request
  {
    submit_raw_tx_request() = delete;
    std::string tx;
  };
  void read_bytes(wire::json_reader&, submit_raw_tx_request&);

  struct submit_raw_tx_response
  {
    submit_raw_tx_response() = delete;
    const char* status;
  };
  void write_bytes(wire::json_writer&, submit_raw_tx_response);
} // rpc
} // lws