refactoring, added max supply to coin creation tx

Author: edwardstock

.circleci/config.yml

@@ -39,7 +39,7 @@ jobs:
             - conan-dir-{{ checksum "conanfile.py" }}
       - run: conan install gtest/1.8.1@bincrafters/stable
       - run: conan install toolbox/3.1.1@edwardstock/latest
-      - run: conan install bip39/2.0.0@edwardstock/latest
+      - run: conan install bip39/2.0.1@edwardstock/latest
       - run: conan install boost/1.70.0@conan/stable
       - run:
           name: Configuring

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.10)
 project(minter_tx
-        VERSION 0.6.0
+        VERSION 0.6.1
         DESCRIPTION "Minter Transaction Maker"
         LANGUAGES CXX
         )

README.md

@@ -53,7 +53,7 @@ For more information, see official [docs](https://docs.conan.io/en/latest/gettin
 ## Use as conan dependency without manually build
 You can just add to your conanfile.txt dependency:
 
-`minter_tx/0.6.0@minter/latest`
+`minter_tx/0.6.1@minter/latest`
 
 CMakeLists.txt
 ```cmake

RELEASE.md

@@ -1,5 +1,9 @@
 # Release notes
 
+## 0.6.1
+ - Added max supply to create coin transaction
+ - Unified strings in transactions. No more c-style strings, now only std::string
+
 ## 0.6.0
  - Fixed build for macos (removed LIBCPP_DEBUG flag)
  - Updated examples:

include/minter/tx/check_tx.h

@@ -30,8 +30,17 @@ namespace minter {
 
 class MINTER_TX_API check_tx {
 public:
+    /// \brief Create proof for new check. Proof is require to redeem check, as proof is a check "password"
+    /// \param address sender address
+    /// \param pass password in bytes
+    /// \return proof bytes
     static dev::bytes_data make_proof(const address_t& address, const dev::bytes& pass);
+
+    /// \brief Decodes check
+    /// \param check_data hash: McAAABBBCCC.....
+    /// \return decoded check transaction
     static check_tx decode(const std::string& check_data);
+
     static check_tx decode(const minter::check_t& check);
 
     check_tx()

include/minter/tx/tx_builder.h

@@ -24,26 +24,44 @@ class MINTER_TX_API tx_builder {
         : m_tx(std::move(tx)) {
     }
     ~tx_builder() = default;
+
+    /// Base transaction data
+
+    tx_builder& set_nonce(const std::string& num);
     tx_builder& set_nonce(const dev::bigint& num);
-    tx_builder& set_nonce(const char* num);
+
+    /// \brief Network identifier. Declared in autogenerated header minter/minter_tx_config.h
+    /// \see minter::testnet - for testnet
+    /// \see minter::mainnet - for mainnet
+    /// \param id
+    /// \return
     tx_builder& set_chain_id(uint8_t id);
+
     tx_builder& set_gas_price(const std::string& amountNormalized);
     tx_builder& set_gas_price(const dev::bigdec18& amountNormalized);
     tx_builder& set_gas_price(const dev::bigint& amount);
+
     tx_builder& set_gas_coin(const std::string& coin);
-    tx_builder& set_gas_coin(const char* coin);
-    tx_builder& set_payload(const dev::bytes& payload);
-    tx_builder& set_payload(dev::bytes&& payload);
+
     tx_builder& set_payload(const std::string& payload);
     tx_builder& set_payload(std::string&& payload);
-    tx_builder& set_payload(const char* payload);
-    tx_builder& set_service_data(const dev::bytes& payload);
-    tx_builder& set_service_data(dev::bytes&& payload);
+    tx_builder& set_payload(const dev::bytes& payload);
+    tx_builder& set_payload(dev::bytes&& payload);
+
     tx_builder& set_service_data(const std::string& payload);
     tx_builder& set_service_data(std::string&& payload);
-    tx_builder& set_service_data(const char* payload);
+    tx_builder& set_service_data(const dev::bytes& payload);
+    tx_builder& set_service_data(dev::bytes&& payload);
+
+    /// \brief Type of signature.
+    /// \param type can be single or multi. Can be casted to uint8_t
+    /// \see minter::signature_type::single
+    /// \see minter::signature_type::multi
+    /// \return
     tx_builder& set_signature_type(minter::signature_type type);
 
+    /// Typed transaction data
+
     std::shared_ptr<minter::tx_send_coin> tx_send_coin();
     std::shared_ptr<minter::tx_sell_coin> tx_sell_coin();
     std::shared_ptr<minter::tx_sell_all_coins> tx_sell_all_coins();

include/minter/tx/tx_buy_coin.h

@@ -26,15 +26,13 @@ class MINTER_TX_API tx_buy_coin : public virtual minter::tx_data {
     std::string get_coin_to_sell() const;
     dev::bigdec18 get_max_value_to_sell() const;
 
-    tx_buy_coin& set_coin_to_buy(const char* coin);
     tx_buy_coin& set_coin_to_buy(const std::string& coin);
-    tx_buy_coin& set_value_to_buy(const char* valueDec);
-    tx_buy_coin& set_value_to_buy(const dev::bigdec18& valueDec);
-    tx_buy_coin& set_value_to_buy(const dev::bigint& valueRaw);
-    tx_buy_coin& set_coin_to_sell(const char* coin);
+    tx_buy_coin& set_value_to_buy(const std::string& value);
+    tx_buy_coin& set_value_to_buy(const dev::bigdec18& value);
+    tx_buy_coin& set_value_to_buy(const dev::bigint& value);
     tx_buy_coin& set_coin_to_sell(const std::string& coin);
-    tx_buy_coin& set_max_value_to_sell(const char* valueDec);
-    tx_buy_coin& set_max_value_to_sell(const dev::bigdec18& valueDec);
+    tx_buy_coin& set_max_value_to_sell(const std::string& value);
+    tx_buy_coin& set_max_value_to_sell(const dev::bigdec18& value);
     tx_buy_coin& set_max_value_to_sell(const dev::bigint& value);
 
 private:

include/minter/tx/tx_create_coin.h

@@ -21,33 +21,63 @@ class MINTER_TX_API tx_create_coin : public virtual minter::tx_data {
     dev::bytes encode() override;
     void decode(const dev::bytes& data) override;
 
-    tx_create_coin& set_name(const char* coin_name);
+    /// \brief common coin name, example Bitcoin BTC
+    /// \param coin_name
+    /// \return
     tx_create_coin& set_name(const std::string& coin_name);
-    tx_create_coin& set_ticker(const char* coin_symbol);
+    /// \brief ticker name, example BTC
+    /// \param coin_symbol
+    /// \return
     tx_create_coin& set_ticker(const std::string& coin_symbol);
-    tx_create_coin& set_initial_amount(const char* amount);
+    /// \brief Initial coin amount in decimal string representation
+    /// \param amount decimal string
+    /// \return
+    tx_create_coin& set_initial_amount(const std::string& amount);
+    /// \brief Initial coin amount in bigdecimal
+    /// \param amount bigdecimal representation
+    /// \return
     tx_create_coin& set_initial_amount(const dev::bigdec18& amount);
+    /// \brief Initial coin amount in bigint representation (PIPs)
+    /// \param amount bigint
+    /// \return
     tx_create_coin& set_initial_amount(const dev::bigint& amount);
-    tx_create_coin& set_initial_reserve(const char* amount);
+    /// \brief Initial reserve in decimal string
+    /// \param amount decimal string
+    /// \return
+    tx_create_coin& set_initial_reserve(const std::string& amount);
+    /// \brief Initial reserve in big decimal
+    /// \param amount bigdecimal
+    /// \return
     tx_create_coin& set_initial_reserve(const dev::bigdec18& amount);
+    /// \brief Initial reserve in PIPs
+    /// \param amount
+    /// \return
     tx_create_coin& set_initial_reserve(const dev::bigint& amount);
     /// \brief
     /// \param crr Min value: 10, max = 100
     /// \return
     tx_create_coin& set_crr(unsigned crr);
+    /// \brief Coin purchase will not be possible if the limit is exceeded.
+    /// \param max_supply decimal string
+    /// \return self
+    tx_create_coin& set_max_supply(const std::string& max_supply);
+    tx_create_coin& set_max_supply(const dev::bigint& max_supply);
+    tx_create_coin& set_max_supply(const dev::bigdec18& max_supply);
 
     std::string get_name() const;
     std::string get_ticker() const;
     dev::bigdec18 get_initial_amount() const;
     dev::bigdec18 get_initial_reserve() const;
     unsigned get_crr() const;
+    dev::bigdec18 get_max_supply() const;
 
 private:
     std::string m_name;
     std::string m_ticker;
     dev::bigint m_initial_amount;
     dev::bigint m_initial_reserve;
     dev::bigint m_crr;
+    dev::bigint m_max_supply;
 };
 
 } // namespace minter

include/minter/tx/tx_declare_candidacy.h

@@ -30,8 +30,9 @@ class MINTER_TX_API tx_declare_candidacy : public virtual minter::tx_data {
     /// \param commission from 10 to 100 percent
     /// \return
     tx_declare_candidacy& set_commission(unsigned commission);
-    tx_declare_candidacy& set_coin(const char* coin);
-    tx_declare_candidacy& set_stake(const char* amount);
+    tx_declare_candidacy& set_coin(const std::string& coin);
+    tx_declare_candidacy& set_stake(const std::string& amount);
+    tx_declare_candidacy& set_stake(const dev::bigint& amount);
     tx_declare_candidacy& set_stake(const dev::bigdec18& amount);
 
     const minter::data::address& get_address() const;

include/minter/tx/tx_deeplink.h

@@ -17,7 +17,7 @@ namespace minter {
 
 class tx_deeplink {
 public:
-    static std::shared_ptr<minter::tx_deeplink> decode(const char* encoded_hex);
+    static std::shared_ptr<minter::tx_deeplink> decode(const std::string& encoded_hex);
     static std::shared_ptr<minter::tx_deeplink> decode(const dev::bytes& tx);
     static std::shared_ptr<minter::tx_deeplink> decode(const dev::bytes_data& tx);