Esterv.Iota.Account

Table of Contents

• Installing the library
  • From source code
  • From GitHub releases
• Adding the libraries to your CMake project
• API reference
• Using the QML modules
• Examples
• Contributing

This repo implements a singleton called Account that can produce deterministic addresses from a seed. The seed can be given to the Singleton by binary seed or by Mnemonic sentences following Bip-39. The singleton also produce a random mnemonic sentence following Bip-39 with 24 English words. The repo can produce a QML Module with types for addresses, and key pairs generation for Iota.

Installing the library

From source code

git clone https://github.com/EddyTheCo/account.git 
 
mkdir build
cd build
qt-cmake -G Ninja -DCMAKE_INSTALL_PREFIX=installDir -DCMAKE_BUILD_TYPE=Release -DBUILD_EXAMPLES=OFF -DQTDEPLOY=OFF -DUSE_QML=OFF -DBUILD_DOCS=OFF ../account
 
cmake --build . 
 
cmake --install . 

where installDir is the installation path, QTDEPLOY install the examples and Qt dependencies using the cmake-deployment-api. Setting the USE_QML variable produce or not the QML module. One can choose to build or not the examples and the documentation with the BUILD_EXAMPLES and BUILD_DOCS variables.

From GitHub releases

Download the releases from this repo.

Adding the libraries to your CMake project

include(FetchContent)
FetchContent_Declare(
    IotaAccount 
    GIT_REPOSITORY https://github.com/EddyTheCo/account.git
    GIT_TAG vMAJOR.MINOR.PATCH 
    FIND_PACKAGE_ARGS MAJOR.MINOR CONFIG  
    )
FetchContent_MakeAvailable(IotaAccount)
 
target_link_libraries(<target> <PRIVATE|PUBLIC|INTERFACE> IotaAccount::account)

If want to use the QML module also add

$<$<STREQUAL:$<TARGET_PROPERTY:IotaAccount::account,TYPE>,STATIC_LIBRARY>:IotaAccount::accountplugin>

API reference

You can read the API reference, or generate it yourself like

cmake -DBUILD_DOCS=ON ../
cmake --build . --target doxygen_docs

Using the QML modules

One needs to make available to the QML engine the different modules by setting the QML import path.

1. In your main function engine.addImportPath("qrc:/esterVtech.com/imports"); to use the resource file.
2. Set the environment variable like export QML_IMPORT_PATH=installDir/CMAKE_INSTALL_LIBDIR where CMAKE_INSTALL_LIBDIR is where Esterv folder was created.

Examples

The [examples](examples) folder shows the use of the different custom types provided by the QML module.

One can also play with the types here

Contributing

We appreciate any contribution!

You can open an issue or request a feature. You can open a PR to the develop branch and the CI/CD will take care of the rest. Make sure to acknowledge your work, and ideas when contributing.