refactor(configuration): Support Bridgechains & Custom Configurations (#105)

The current implementation only allows use with Devnet unless values are manually changed in `/src`.

This PR enables network configuration via the public api.
(Devnet, Mainnet, Testnet, and Custom Networks (bridgechains).

Specifically this PR does the following:
- Creates a Configuration class.
- Creates Fee and Network Manager children for the Configuration class.
- Allows passing a `Configuration to` Transaction Builder with a default value of `Devnet` & `StaticFees` (non-breaking).
- Adds a FeePolicy-type.
- Adds a Fee class (container for fee policies).
- Adds a Networks class (container for preset networks).
- Updates the TransactionTypes enum.
- Improves the `Network` class and Network implementions.
- Updates the `Slot` class to reflect changes (non-breaking).
- Updates Transaction-related classes to reflect updates (non-breaking).
- Adds tests for all changes.
- Updates the Arduino IDE script.
- Updates `.ino` Arduino sketches with Configuration examples.
- Updates documentation with Configuration examples.
- Updates the `keywords.txt` file to reflect changes.
- Updates the changelog.
- Updates version to `v.0.6.0`.

Author: sleepdefic1t

.circleci/script_arduino.sh

@@ -7,5 +7,6 @@ mv ~/project/* ~/Arduino/libraries/cpp-crypto
 
 arduino-cli lib install "ArduinoJson@6.10.0"
 arduino-cli lib install "BIP66"
+arduino-cli lib install "micro-ecc"
 
 arduino-cli compile --output temp.bin -b esp32:esp32:esp32 ~/Arduino/libraries/cpp-crypto/examples/arduino/ESP32/ESP32.ino --debug

CHANGELOG.md

@@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [0.6.0] - 2019-07-01
+
+### Added
+
+- added Bridgechain support ([#105])
 
 ### Changed
 

docs/cpp.md

@@ -16,6 +16,79 @@ This project is still under development. This page will get more content as the
 * [macOS >= 10.10](#OS)  
 * [Windows >= 7](#OS)  
 
+### ARK Transactions
+
+#### Devnet
+
+```cpp
+const auto DevnetTransaction = Builder::buildTransfer(
+        "D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib",
+        100000000ULL,
+        "this is a devnet transaction",
+        "this is a top secret passphrase",
+        "this is a top secret passphrase too");
+```
+
+#### Mainnet
+
+```cpp
+const Configuration MainnetConfiguration(Networks::Mainnet());
+
+const auto MainnetTransaction = Builder::buildTransfer(
+        "D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib",
+        100000000ULL,
+        "this is a mainnet transaction",
+        "this is a top secret passphrase",
+        "this is a top secret passphrase too",
+        MainnetConfiguration);
+```
+
+#### BridgeChain Transaction
+
+```cpp
+static const Network MyBridgechainNetwork = {
+  "16c891512149d6d3ff1b70e65900936140bf853a4ae79b5515157981dcc706df",
+  1, 0x53, 0xaa,
+  "2019-04-12T13:00:00.000Z"
+};
+
+const Configuration MyBridgechainConfiguration(MyBridgechainNetwork);
+
+const auto MyBridgechainTransaction = Builder::buildTransfer(
+        "D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib",
+        100000000ULL,
+        "this is a custom bridgechain transaction",
+        "this is a top secret passphrase",
+        "this is a top secret passphrase too",
+        MyBridgechainConfiguration);
+```
+
+
+#### With custom Fees
+
+```cpp
+static const Network MyBridgechainNetwork = {
+  "16c891512149d6d3ff1b70e65900936140bf853a4ae79b5515157981dcc706df",
+  1, 0x53, 0xaa,
+  "2019-04-12T13:00:00.000Z"
+};
+
+const FeePolicy MyCustomFees = {
+  900000000ULL, 800000000ULL, 700000000ULL, 600000000ULL, 500000000ULL,
+  400000000ULL, 300000000ULL, 200000000ULL, 100000000ULL, 0ULL
+};
+
+ßconst Configuration MyBridgechainConfiguration(MyBridgechainNetwork,
+                                                MyCustomFees);
+
+const auto MyBridgechainTransaction = Builder::buildTransfer(
+        "D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib",
+        100000000ULL,
+        "",
+        "this is a top secret passphrase",
+        "",
+        MyBridgechainConfiguration);
+```
 
 ### Sign
 

examples/arduino/ESP32/ESP32.ino

@@ -31,13 +31,40 @@
 /****************************************/
 
 void checkCrypto() {
+
+  /**
+   * Create a BridgeChain transaction, tailored for your custom network.
+   */
+  static const Network MyBridgechainNetwork = {
+    "16c891512149d6d3ff1b70e65900936140bf853a4ae79b5515157981dcc706df",
+    1, 0x53, 0xaa,
+    "2019-04-12T13:00:00.000Z"
+  };
+
+  const Configuration MyBridgechainConfiguration(MyBridgechainNetwork);
+
+  auto myBridgechainTransaction = Builder::buildTransfer(
+          "D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib",
+          100000000ULL,
+          "this is a custom bridgechain transaction",
+          "this is a top secret passphrase",
+          "this is a top secret passphrase too",
+          MyBridgechainConfiguration);
+
+    Serial.print("\nBridgechain Transaction: ");
+    Serial.println(myBridgechainTransaction.toJson().c_str());
+
+  /**/
+
+  /********************/
+
   /**
    * This is how you can check the default 'Network' "Transaction 'Fees' by type.
    * In this example, it should return a 'uint64_t' integer of '10000000' as the default 'Fee' for a 'Transaction' of 'Type' '0'. 
    */
-    Ark::Crypto::Configuration::Fee fee;
-    unsigned long typeZeroTransactionFee = fee.get(0);
-    Serial.print("\n Type 0 default Transaction Fee: ");
+    Configuration config;
+    unsigned long typeZeroTransactionFee = config.getFee(0);
+    Serial.print("\nType 0 default Transaction Fee: ");
     Serial.println(typeZeroTransactionFee); // The response is a 'uint64_t' integer.
 
   /**/

examples/arduino/ESP8266/ESP8266.ino

@@ -31,13 +31,39 @@
 /****************************************/
 
 void checkCrypto() {
+  /**
+   * Create a BridgeChain transaction, tailored for your custom network.
+   */
+  static const Network MyBridgechainNetwork = {
+    "16c891512149d6d3ff1b70e65900936140bf853a4ae79b5515157981dcc706df",
+    1, 0x53, 0xaa,
+    "2019-04-12T13:00:00.000Z"
+  };
+
+  const Configuration MyBridgechainConfiguration(MyBridgechainNetwork);
+
+  auto myBridgechainTransaction = Builder::buildTransfer(
+          "D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib",
+          100000000ULL,
+          "this is a custom bridgechain transaction",
+          "this is a top secret passphrase",
+          "this is a top secret passphrase too",
+          MyBridgechainConfiguration);
+
+    Serial.print("\nBridgechain Transaction: ");
+    Serial.println(myBridgechainTransaction.toJson().c_str());
+
+  /**/
+
+  /********************/
+
   /**
    * This is how you can check the default 'Network' "Transaction 'Fees' by type.
    * In this example, it should return a 'uint64_t' integer of '10000000' as the default 'Fee' for a 'Transaction' of 'Type' '0'. 
    */
-    Ark::Crypto::Configuration::Fee fee;
-    unsigned long typeZeroTransactionFee = fee.get(0);
-    Serial.print("\n Type 0 default Transaction Fee: ");
+    Configuration config;
+    unsigned long typeZeroTransactionFee = config.getFee(0);
+    Serial.print("\nType 0 default Transaction Fee: ");
     Serial.println(typeZeroTransactionFee); // The response is a 'uint64_t' integer.
 
   /**/

extras/ARDUINO_IDE.sh

@@ -38,22 +38,20 @@ EXTRAS_BACKUP_DIR=${EXTRAS_DIR}/BACKUP
 SRC_LIB_DIR=${SRC_DIR}/lib
 EXTRAS_LIB_DIR=${EXTRAS_BACKUP_DIR}/lib
 
-EXTRAS_IDENTITIES_DIR=${EXTRAS_BACKUP_DIR}/identities
+SRC_COMMON_DIR=${SRC_DIR}/common
+INCLUDE_COMMON_DIR=${INCLUDE_CRYPTO_DIR}/common
 
-INCLUDE_CONFIGURATION_DIR=${INCLUDE_CRYPTO_DIR}/configuration
-SRC_CONFIGURATION_DIR=${SRC_DIR}/configuration
+SRC_DEFAULTS_DIR=${SRC_DIR}/defaults
+INCLUDE_DEFAULTS_DIR=${INCLUDE_CRYPTO_DIR}/defaults
 
-INCLUDE_ENUMS_DIR=${INCLUDE_CRYPTO_DIR}/enums
-SRC_ENUMS_DIR=${SRC_DIR}/enums
-
-INCLUDE_HELPERS_DIR=${INCLUDE_CRYPTO_DIR}/helpers
 SRC_HELPERS_DIR=${SRC_DIR}/helpers
+INCLUDE_HELPERS_DIR=${INCLUDE_CRYPTO_DIR}/helpers
 
-INCLUDE_ENCODING_DIR=${INCLUDE_HELPERS_DIR}/encoding
 SRC_ENCODING_DIR=${SRC_HELPERS_DIR}/encoding
+INCLUDE_ENCODING_DIR=${INCLUDE_HELPERS_DIR}/encoding
 
-INCLUDE_IDENTITIES_DIR=${INCLUDE_CRYPTO_DIR}/identities
 SRC_IDENTITIES_DIR=${SRC_DIR}/identities
+INCLUDE_IDENTITIES_DIR=${INCLUDE_CRYPTO_DIR}/identities
 
 INCLUDE_NETWORKS_DIR=${INCLUDE_CRYPTO_DIR}/networks
 SRC_NETWORKS_DIR=${SRC_DIR}/networks
@@ -100,16 +98,15 @@ if [[ -d ${INCLUDE_DIR} ]]; then
   echo -e "Moving 'arkCrypto.h' to 'src' directory.\n"
   mv ${INCLUDE_CRYPTO_DIR}/arkCrypto.h ${SRC_DIR}
 
-  echo -e "Moving 'configuration' headers.\n"
-  mv ${INCLUDE_CONFIGURATION_DIR}/fee.h     ${SRC_CONFIGURATION_DIR}
-  mv ${INCLUDE_CONFIGURATION_DIR}/network.h ${SRC_CONFIGURATION_DIR}
-
-  echo "Creating 'enums' folder 🗂"
-  mkdir ${SRC_ENUMS_DIR}
+  echo -e "Moving 'common' headers.\n"
+  mv ${INCLUDE_COMMON_DIR}/configuration.hpp  ${SRC_COMMON_DIR}
+  mv ${INCLUDE_COMMON_DIR}/fee_policy.hpp     ${SRC_COMMON_DIR}
+  mv ${INCLUDE_COMMON_DIR}/network.hpp        ${SRC_COMMON_DIR}
 
-  echo -e "Moving 'enums' headers.\n"
-  mv ${INCLUDE_ENUMS_DIR}/fees.h  ${SRC_ENUMS_DIR}
-  mv ${INCLUDE_ENUMS_DIR}/types.h ${SRC_ENUMS_DIR}
+  echo -e "Moving 'defaults' headers.\n"
+  mv ${INCLUDE_DEFAULTS_DIR}/fee_policies.hpp       ${SRC_DEFAULTS_DIR}
+  mv ${INCLUDE_DEFAULTS_DIR}/static_fees.hpp        ${SRC_DEFAULTS_DIR}
+  mv ${INCLUDE_DEFAULTS_DIR}/transaction_types.hpp  ${SRC_DEFAULTS_DIR}
 
   echo -e "Moving 'helpers' headers.\n"
   mkdir ${SRC_ENCODING_DIR}
@@ -122,24 +119,25 @@ if [[ -d ${INCLUDE_DIR} ]]; then
   mv ${INCLUDE_IDENTITIES_DIR}/wif.h        ${SRC_IDENTITIES_DIR}
 
   echo -e "Moving 'networks' headers.\n"
-  mv ${INCLUDE_NETWORKS_DIR}/abstractnetwork.h  ${SRC_NETWORKS_DIR}
-  mv ${INCLUDE_NETWORKS_DIR}/devnet.h           ${SRC_NETWORKS_DIR}
-  mv ${INCLUDE_NETWORKS_DIR}/mainnet.h          ${SRC_NETWORKS_DIR}
-  mv ${INCLUDE_NETWORKS_DIR}/testnet.h          ${SRC_NETWORKS_DIR}
+  mv ${INCLUDE_NETWORKS_DIR}/networks.hpp ${SRC_NETWORKS_DIR}
+  mv ${INCLUDE_NETWORKS_DIR}/devnet.hpp   ${SRC_NETWORKS_DIR}
+  mv ${INCLUDE_NETWORKS_DIR}/mainnet.hpp  ${SRC_NETWORKS_DIR}
+  mv ${INCLUDE_NETWORKS_DIR}/testnet.hpp  ${SRC_NETWORKS_DIR}
 
   echo -e "Moving 'transactions' headers.\n"
   mv ${INCLUDE_TRANSACTIONS_DIR}/builder.h      ${SRC_TRANSACTIONS_DIR}
   mv ${INCLUDE_TRANSACTIONS_DIR}/deserializer.h ${SRC_TRANSACTIONS_DIR}
   mv ${INCLUDE_TRANSACTIONS_DIR}/serializer.h   ${SRC_TRANSACTIONS_DIR}
   mv ${INCLUDE_TRANSACTIONS_DIR}/transaction.h  ${SRC_TRANSACTIONS_DIR}
 
-  echo -e "Backing up, moving, and removing relevant modules from the 'lib' directory.\n"
+  echo -e "Backing up, moving, and removing dependencies from the 'src/lib' directory.\n"
+  mkdir ${EXTRAS_BACKUP_DIR}
   mv ${SRC_LIB_DIR}/ArduinoJson ${EXTRAS_BACKUP_DIR}
+  mv ${SRC_LIB_DIR}/BIP66       ${EXTRAS_BACKUP_DIR}
   mv ${SRC_LIB_DIR}/uECC        ${EXTRAS_BACKUP_DIR}
   mv ${SRC_LIB_DIR}/bcl         ${SRC_DIR}
   mv ${SRC_LIB_DIR}/date        ${SRC_DIR}
   mv ${SRC_LIB_DIR}/rfc6979     ${SRC_DIR}
-  mv ${SRC_LIB_DIR}/stl         ${SRC_DIR}
 
   echo -e "Moving Docs to the './extras' directory.\n"
   mv ${PROJECT_ROOT}/docs ${EXTRAS_DIR}
@@ -161,8 +159,8 @@ else
   echo -e "Creating the 'include' directory tree 🗂\n"
   mkdir ${INCLUDE_DIR}
   mkdir ${INCLUDE_CRYPTO_DIR}
-  mkdir ${INCLUDE_CONFIGURATION_DIR}
-  mkdir ${INCLUDE_ENUMS_DIR}
+  mkdir ${INCLUDE_COMMON_DIR}
+  mkdir ${INCLUDE_DEFAULTS_DIR}
   mkdir ${INCLUDE_HELPERS_DIR}
   mkdir ${INCLUDE_ENCODING_DIR}
   mkdir ${INCLUDE_IDENTITIES_DIR}
@@ -172,13 +170,15 @@ else
   echo -e "Moving 'arkCrypto.h' back to the 'include/cpp-crypto/' directory.\n"
   mv ${SRC_DIR}/arkCrypto.h ${INCLUDE_CRYPTO_DIR}
 
-  echo -e "Moving 'configuration' headers.\n"
-  mv ${SRC_CONFIGURATION_DIR}/fee.h     ${INCLUDE_CONFIGURATION_DIR}
-  mv ${SRC_CONFIGURATION_DIR}/network.h ${INCLUDE_CONFIGURATION_DIR}
+  echo -e "Moving 'common' headers.\n"
+  mv ${SRC_COMMON_DIR}/configuration.hpp  ${INCLUDE_COMMON_DIR}
+  mv ${SRC_COMMON_DIR}/fee_policy.hpp     ${INCLUDE_COMMON_DIR}
+  mv ${SRC_COMMON_DIR}/network.hpp        ${INCLUDE_COMMON_DIR}
 
-  echo -e "Moving 'enums' headers.\n"
-  mv ${SRC_ENUMS_DIR}/fees.h  ${INCLUDE_ENUMS_DIR}
-  mv ${SRC_ENUMS_DIR}/types.h ${INCLUDE_ENUMS_DIR}
+  echo -e "Moving 'defaults' headers.\n"
+  mv ${SRC_DEFAULTS_DIR}/fee_policies.hpp       ${INCLUDE_DEFAULTS_DIR}
+  mv ${SRC_DEFAULTS_DIR}/static_fees.hpp        ${INCLUDE_DEFAULTS_DIR}
+  mv ${SRC_DEFAULTS_DIR}/transaction_types.hpp  ${INCLUDE_DEFAULTS_DIR}
 
   echo -e "Moving 'helpers/encoding' headers.\n"
   mv ${SRC_ENCODING_DIR}/hex.h ${INCLUDE_ENCODING_DIR}
@@ -191,10 +191,10 @@ else
   mv ${SRC_IDENTITIES_DIR}/wif.h        ${INCLUDE_IDENTITIES_DIR}
 
   echo -e "Moving 'networks' headers.\n"
-  mv ${SRC_NETWORKS_DIR}/abstractnetwork.h  ${INCLUDE_NETWORKS_DIR}
-  mv ${SRC_NETWORKS_DIR}/devnet.h           ${INCLUDE_NETWORKS_DIR}
-  mv ${SRC_NETWORKS_DIR}/mainnet.h          ${INCLUDE_NETWORKS_DIR}
-  mv ${SRC_NETWORKS_DIR}/testnet.h          ${INCLUDE_NETWORKS_DIR}
+  mv ${SRC_NETWORKS_DIR}/networks.hpp ${INCLUDE_NETWORKS_DIR}
+  mv ${SRC_NETWORKS_DIR}/devnet.hpp   ${INCLUDE_NETWORKS_DIR}
+  mv ${SRC_NETWORKS_DIR}/mainnet.hpp  ${INCLUDE_NETWORKS_DIR}
+  mv ${SRC_NETWORKS_DIR}/testnet.hpp  ${INCLUDE_NETWORKS_DIR}
 
   echo -e "Moving 'transactions' headers.\n"
   mv ${SRC_TRANSACTIONS_DIR}/builder.h      ${INCLUDE_TRANSACTIONS_DIR}
@@ -205,17 +205,16 @@ else
   echo -e "Restoring the 'lib' directory.\n"
   mkdir ${SRC_LIB_DIR}
   mv ${EXTRAS_BACKUP_DIR}/ArduinoJson ${SRC_LIB_DIR}
+  mv ${EXTRAS_BACKUP_DIR}/BIP66       ${SRC_LIB_DIR}
   mv ${EXTRAS_BACKUP_DIR}/uECC        ${SRC_LIB_DIR}
   mv ${SRC_DIR}/bcl                   ${SRC_LIB_DIR}
   mv ${SRC_DIR}/date                  ${SRC_LIB_DIR}
   mv ${SRC_DIR}/rfc6979               ${SRC_LIB_DIR}
-  mv ${SRC_DIR}/stl                   ${SRC_LIB_DIR}
 
   echo -e "Moving Docs back to the project root directory.\n"
   mv ${EXTRAS_DIR}/docs  ${PROJECT_ROOT}
 
   echo -e "Removing old directories 🗑\n"
-  rm -rf ${SRC_ENUMS_DIR}
   rm -rf ${EXTRAS_BACKUP_DIR}
 
   echo -e "****************************************\n"

keywords.txt

@@ -8,24 +8,24 @@
 
 Ark	KEYWORD1
 Crypto	KEYWORD1
-Configuration	KEYWORD1
-Enums	KEYWORD1
+common	KEYWORD1
+defaults	KEYWORD1
 Identities	KEYWORD1
-Networks	KEYWORD1
+managers	KEYWORD1
 Transactions	KEYWORD1
 Utils	KEYWORD1
 
-Fee	KEYWORD1
+Configuration	KEYWORD1
+FeePolicy	KEYWORD1
 Network	KEYWORD1
 
-Fees	KEYWORD1
-Types	KEYWORD1
-
 Address	KEYWORD1
 PrivateKey	KEYWORD1
 PublicKey	KEYWORD1
 WIF	KEYWORD1
 
+Networks	KEYWORD1
+
 Builder	KEYWORD1
 Deserializer	KEYWORD1
 Serializer	KEYWORD1
@@ -42,6 +42,10 @@ Slot	KEYWORD1
 # Constants (LITERAL1)
 #######################################
 
+Fees	KEYWORD1
+StaticFeePolicy	KEYWORD1
+TransactionTypes	KEYWORD1
+
 Devnet	LITERAL1
 Mainnet	LITERAL1
 Testnet	LITERAL1

library.json

@@ -7,7 +7,7 @@
     "type": "git",
     "url": "https://github.com/ArkEcosystem/Cpp-Crypto.git"
   },
-  "version": "0.5.0",
+  "version": "0.6.0",
   "authors": [
     {
       "name": "Ark Ecosystem",

library.properties

@@ -1,5 +1,5 @@
 name=Ark-Cpp-Crypto
-version=0.5.0
+version=0.6.0
 author=Ark Ecosystem
 maintainer=Ark Ecosystem
 sentence=A simple Cryptography Implementation in C++ for the ARK Blockchain.