Merge pull request #225 from ArkEcosystem/release/1.1.0

release: 1.1.0

.github/workflows/test/clang_format.sh

@@ -1,4 +1,4 @@
-#!/bin/bash -ex
+#!/usr/bin/env bash
 
 grep -nr '\s$' src test .gitignore 2>&1 > /dev/null
 if $?; then

CHANGELOG.md

@@ -5,35 +5,41 @@ 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).
 
-## [1.0.0] - 2020-02-13
+## [1.1.0] - 2020-03-06
 
-## [1.0.0-arduino] - 2020-02-13
+### Added
+-   added Delegate Resignation Builder and Tests ([#207])
 
 ### Changed
--   break up unit tests to support platforms with limited RAM ([#172])
--   removed use of monolithic `arkCrypto.h` header ([#190])
+-   improved transaction builder ([#215])
+-   improved building as a project dependency ([#206])
+
+### Fixed
+-   make htlc claim secret a 32-byte hash ([#212])
+
+## [1.0.0] - 2020-02-13
 
 ### Added
 -   added AIP-11 support for Core v.2.6 Transactions ([#198])
 
+### Changed
+-   removed use of monolithic `arkCrypto.h` header ([#190])
+-   break up unit tests to support platforms with limited RAM ([#172])
+
 ### Fixed
--   fixed `transaction::to_array` tests on ESP8266 ([#178])
 -   fixed `transaction::to_json` tests on ESP8266 ([#180])
+-   fixed `transaction::to_array` tests on ESP8266 ([#178])
 
 ## [0.7.0] - 2019-10-08
 
-## [0.7.0-arduino] - 2019-10-08
-
 ### Changed
--   improved coverage and formatting ([#121])
+-   moved external libraries out of source tree ([#156])
 -   refactored utils implementation ([#133])
+-   improved coverage and formatting ([#121])
 -   refactored Identities implementation. ([#120])
--   moved external libraries out of source tree ([#156])
 
 ## [0.6.0] - 2019-07-16
 
-## [0.6.0-arduino] - 2019-07-16
-
 ### Added
 -   added Bridgechain support ([#105])
 
@@ -56,9 +62,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 -   changed to BIP66 lib for DER ser/des ([#88])
 -   updated vendorField to support 255 bytes in Core v2.4 ([#84])
+-   improved Windows support ([#83])
 -   updated ArduinoJson package to version v.6.10.0 ([#76])
 -   updated tests to use Core fixtures ([#74])
--   improved Windows support ([#83])
 
 ### Fixed
 -   properly handle 0 ARKtoshi Transaction amounts ([#85])
@@ -71,33 +77,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [0.3.0] - 2019-02-16
 
-## [0.3.0-arduino] - 2019-02-16
-
 ### Added
 -   Arduino CircleCI config ([#61])
 
 ### Changed
--   updated `keywords.txt` ([#64])
--   updated `./library.json` package export settings ([#64])
--   removed unnecessary files and external packages to `./src/lib/` ([#64])
--   moved `./docs` to `./extras` in arduino builds ([#64])
--   updated `ARDUINO_IDE.sh` script to reflect `lib/` changes ([#64])
+-   updated Arduino-related files ([#64])
 -   automated `ARDUINO_IDE.sh` script ([#60])
 
 ## [0.2.0] - 2019-02-07
 
 ### Added
--   Added `toJson()` method to `Transaction` class ([#54])
 -   Added `ArduinoJson` dependency and Arduino Sketch paths to `library.json` ([#55])
+-   Added `toJson()` method to `Transaction` class ([#54])
 
 ### Changed
--   Removed unused Arduino Adapter Header ([#50])
--   Renamed `Helpers` class to avoid naming collision with Cpp-Client `Helpers` ([#51])
 -   Refactored Timestamps & `Slots` to use milliseconds and avoid integer overflow ([#53])
+-   Renamed `Helpers` class to avoid naming collision with Cpp-Client `Helpers` ([#51])
+-   Removed unused Arduino Adapter Header ([#50])
 
 ### Fixed
--   Fixed the way the Arduino IDE Script restores converted directories ([#49])
 -   Corrected PIO Builds to determine dependency versions explicitly ([#52])
+-   Fixed the way the Arduino IDE Script restores converted directories ([#49])
 
 [#49]: https://github.com/ArkEcosystem/cpp-crypto/pull/49
 [#50]: https://github.com/ArkEcosystem/cpp-crypto/pull/50
@@ -111,7 +111,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [#61]: https://github.com/ArkEcosystem/cpp-crypto/pull/61
 [#64]: https://github.com/ArkEcosystem/cpp-crypto/pull/64
 [0.3.0]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.2.0...0.3.0
-[0.3.0-arduino]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.3.0-arduino
 [#69]: https://github.com/ArkEcosystem/cpp-crypto/pull/69
 [#70]: https://github.com/ArkEcosystem/cpp-crypto/pull/70
 [0.3.1]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.3.0...0.3.1
@@ -131,17 +130,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 [#105]: https://github.com/ArkEcosystem/cpp-crypto/pull/105
 [#111]: https://github.com/ArkEcosystem/cpp-crypto/pull/111
 [0.6.0]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.5.0...0.6.0
-[0.6.0-arduino]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.3.0-arduino...0.6.0-arduino
 [#120]: https://github.com/ArkEcosystem/cpp-crypto/pull/120
 [#121]: https://github.com/ArkEcosystem/cpp-crypto/pull/121
 [#133]: https://github.com/ArkEcosystem/cpp-crypto/pull/133
 [#156]: https://github.com/ArkEcosystem/cpp-crypto/pull/156
 [0.7.0]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.6.0...0.7.0
-[0.7.0-arduino]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.6.0-arduino...0.7.0-arduino
 [#172]: https://github.com/ArkEcosystem/cpp-crypto/pull/172
 [#178]: https://github.com/ArkEcosystem/cpp-crypto/pull/178
 [#180]: https://github.com/ArkEcosystem/cpp-crypto/pull/180
 [#190]: https://github.com/ArkEcosystem/cpp-crypto/pull/190
 [#198]: https://github.com/ArkEcosystem/cpp-crypto/pull/198
-[1.0.0]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.7.0-arduino...1.0.0
-[1.0.0-arduino]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.7.0-arduino...1.0.0-arduino
+[1.0.0]: https://github.com/ArkEcosystem/cpp-crypto/compare/0.7.0...1.0.0
+[#206]: https://github.com/ArkEcosystem/cpp-crypto/pull/206
+[#207]: https://github.com/ArkEcosystem/cpp-crypto/pull/207
+[#212]: https://github.com/ArkEcosystem/cpp-crypto/pull/212
+[#215]: https://github.com/ArkEcosystem/cpp-crypto/pull/215
+[1.1.0]: https://github.com/ArkEcosystem/cpp-crypto/compare/1.0.0...1.1.0

build.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 rm -dfr build
 mkdir build

cmake/External.cmake

@@ -4,7 +4,7 @@
 # ------------------------------------------------------------------------------
 
 # Copy the configuration
-configure_file(${CMAKE_SOURCE_DIR}/cmake/extern/ArduinoJson.txt.in
+configure_file(${CMAKE_INSTALL_PREFIX}/cmake/extern/ArduinoJson.txt.in
                ${EXTERNAL_LIBRARY_DIR}/arduinojson/CMakeLists.txt)
 
 # Configure the Cmake build
@@ -38,7 +38,7 @@ include_directories(${ARDUINO_JSON_SOURCE_DIR})
 # ------------------------------------------------------------------------------
 
 # Copy the configuration
-configure_file(${CMAKE_SOURCE_DIR}/cmake/extern/BCL.txt.in
+configure_file(${CMAKE_INSTALL_PREFIX}/cmake/extern/BCL.txt.in
                ${EXTERNAL_LIBRARY_DIR}/bcl/CMakeLists.txt)
 
 # Configure the Cmake build
@@ -81,7 +81,7 @@ include_directories(${EXTERNAL_LIBRARY_DIR}/bcl/src/src)
 # ------------------------------------------------------------------------------
 
 # Copy the configuration
-configure_file(${CMAKE_SOURCE_DIR}/cmake/extern/BIP66.txt.in
+configure_file(${CMAKE_INSTALL_PREFIX}/cmake/extern/BIP66.txt.in
                ${EXTERNAL_LIBRARY_DIR}/bip66/CMakeLists.txt)
 
 # Configure the Cmake build
@@ -115,7 +115,7 @@ include_directories(${EXTERNAL_LIBRARY_DIR}/bip66/src/)
 # ------------------------------------------------------------------------------
 
 # Copy the configuration
-configure_file(${CMAKE_SOURCE_DIR}/cmake/extern/uECC.txt.in
+configure_file(${CMAKE_INSTALL_PREFIX}/cmake/extern/uECC.txt.in
                ${EXTERNAL_LIBRARY_DIR}/uecc/CMakeLists.txt)
 
 # Configure the Cmake build
@@ -158,4 +158,8 @@ set(EXTERNAL_LIBRARY_SOURCE
     ${UECC_SOURCE}
     CACHE INTERNAL "External Lib Binary Files")
 
+set(EXTERNAL_LIBRARY_INCLUDE
+    ${ARDUINO_JSON_SOURCE_DIR}
+    CACHE INTERNAL "External Lib Include Dirs")
+
 # ------------------------------------------------------------------------------

docs/INSTALL_ARDUINO.MD

@@ -237,12 +237,12 @@ void createBridgechainTransaction() {
     const Configuration cfg(BridgechainNetwork);
 
     // Use the Transaction Builder to make a transaction.
-    const auto bridgechainTransaction = builder::Transfer()
+    const auto bridgechainTransaction = builder::Transfer(cfg)
             .recipientId("D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib")
             .vendorField("this is a custom bridgechain transaction")
             .sign(Passphrase)
             .secondSign(SecondPassphrase)
-            .build(cfg);
+            .build();
 
     // Create and Print the Json representation of the Transaction.
     const auto transactionJson = bridgechainTransaction.toJson();

docs/cpp.md

@@ -26,7 +26,6 @@ This project is still under development. This page will get more content as the
 ```cpp
 // Default Configuration is Devnet
 const auto transaction = builder::Transfer()
-        .type(0)
         .nonce(1)
         .senderPublicKey(fixtures::PublicKeyBytes.data())
         .vendorField("this is a devnet transaction")
@@ -41,20 +40,19 @@ const auto transaction = builder::Transfer()
 ### Mainnet
 
 ```cpp
-// Use the Configuration Class to create a Mainnet Transaction
-const Configuration mainnetCfg(Mainnet);
+// Also pass the Network as a builder constructor argument
 
-const auto transaction = builder::Transfer()
-        .type(0)
+#include "networks/mainnet.hpp"
+
+const auto transaction = builder::Transfer(Mainnet)
         .nonce(1)
-        .senderPublicKey(fixtures::PublicKeyBytes.data())
         .vendorField("this is a devnet transaction")
         .amount(100000000ULL)
         .expiration(0)
         .recipientId("D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib")
         .sign("this is a top secret passphrase")
         .secondSign("this is a top secret passphrase too")
-        .build(mainnetCfg);
+        .build();
 ```
 
 ### BridgeChain Transaction
@@ -77,17 +75,15 @@ const uint8_t radiansRecipient[] = {
     65, 29,  252, 105, 181, 76,  127, 233, 1,  233, 29,
     90, 154, 183, 131, 136, 100, 94,  36,  39, 234 };
 
-auto transaction = builder::Transfer()
-        .type(0)
+auto transaction = builder::Transfer(radiansCfg)
         .nonce(1)
-        .senderPublicKey(senderPublicKeyBytes.data())
         .vendorField("this is a Radians transaction")
         .amount(100000000ULL)
         .expiration(0)
         .recipientId(radiansRecipient)
         .sign("this is a top secret passphrase")
         .secondSign("this is a top secret passphrase too")
-        .build(radiansCfg);
+        .build();
 ```
 
 ### With custom Fees
@@ -106,17 +102,15 @@ const FeePolicy customFees = {
 
 const Configuration customCfg(Radians, MyCustomFees);
 
-auto transaction = builder::Transfer()
-        .type(0)
+auto transaction = builder::Transfer(customCfg)
         .nonce(1)
-        .senderPublicKey(senderPublicKeyBytes.data())
         .vendorField("this is a Radians transaction")
         .amount(100000000ULL)
         .expiration(0)
         .recipientId(radiansRecipient)
         .sign("this is a top secret passphrase")
         .secondSign("this is a top secret passphrase too")
-        .build(customCfg);
+        .build();
 ```
 
 ### Sign a Transactions
@@ -539,12 +533,12 @@ void createBridgechainTransaction() {
     const Configuration cfg(BridgechainNetwork);
 
     // Use the Transaction Builder to make a transaction.
-    const auto bridgechainTransaction = builder::Transfer()
+    const auto bridgechainTransaction = builder::Transfer(cfg)
             .recipientId("D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib")
             .vendorField("this is a custom bridgechain transaction")
             .sign(Passphrase)
             .secondSign(SecondPassphrase)
-            .build(cfg);
+            .build();
 
     // Create and Print the Json representation of the Transaction.
     const auto transactionJson = bridgechainTransaction.toJson();

examples/arduino/ESP32/ESP32.ino

@@ -181,12 +181,12 @@ void createBridgechainTransaction() {
     const Configuration cfg(BridgechainNetwork);
 
     // Use the Transaction Builder to make a transaction.
-    const auto bridgechainTransaction = builder::Transfer()
+    const auto bridgechainTransaction = builder::Transfer(cfg)
             .recipientId("D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib")
             .vendorField("this is a custom bridgechain transaction")
             .sign(Passphrase)
             .secondSign(SecondPassphrase)
-            .build(cfg);
+            .build();
 
     // Create and Print the Json representation of the Transaction.
     const auto transactionJson = bridgechainTransaction.toJson();

examples/arduino/ESP8266/ESP8266.ino

@@ -160,11 +160,11 @@ void createBridgechainTransaction() {
     const Configuration cfg(BridgechainNetwork);
 
     // Use the Transaction Builder to make a transaction.
-    const auto bridgechainTransaction = builder::Transfer()
+    const auto bridgechainTransaction = builder::Transfer(cfg)
             .recipientId("D61mfSggzbvQgTUe6JhYKH2doHaqJ3Dyib")
             .vendorField("this is a custom bridgechain transaction")
             .sign(Passphrase)
-            .build(cfg);
+            .build();
 
     // Create and Print the Json representation of the Transaction.
     const auto transactionJson = bridgechainTransaction.toJson();