Skip to content
Snippets Groups Projects
Select Git revision
  • main default protected
  • feature/messages
  • feature/events
  • 1.5.0
  • 1.4.0
  • 1.3.0
  • 1.2.0
  • 1.1.1
  • 1.1.0
  • 1.0.1
  • 1.0.0
  • 1.0.0-rc2
  • 1.0.0-rc1
13 results

qubicj

  • Clone with SSH
  • Clone with HTTPS
  • qubicj

    QubicJ aims to provide Java infrastructure for interacting within the Qubic framework. It consists out of several modules.

    • qubicj-computor-api ... contains code for communicating with qubic nodes (computors).
    • qubicj-vanity-id ... contains a tool for generating vanity IDs.
    • qubicj-shell ... console application for wallet operations and accessing qubic nodes.
    • ... more to come ...

    See readme files in submodules for detailed information. The application submodules are demos for how to use the qubicj computor api.

    Getting started

    For compiling and running you need to have at least Java 21 and maven (maven is optional, you can also use the mvnw maven wrapper in the qubicj directory). Only Linux is supported, but it should be able to build and run on all operating systems that have Java available.

    1. IMPORTANT: Install shared library
    2. Build qubicj

    If you only want to use the qubicj-computor-api in your own project then you do not need to build it but simply need to include the dependency in your project. See submodule documentation.

    Build

    You need to install the qubic-parent and qubicj-computor-api submodule locally for the other submodules to build. To do this, execute the following command in the outermost qubicj folder:

    ./mvnw clean install

    This builds the parent and all modules and runs the tests.

    Support

    For support contact me in the qubic discord => user: o.mio aka mio. Feel free to open issues for feature requests and bugs.

    Contributing

    Contributions are welcome. If you contribute code you agree on licensing it under the projects license and guarantee that the code is your own and free of copyright issues. You agree that the owner of this project can use your code and is allowed to use it under another proprietary license as well (for dual licensing). If you contribute you need to agree to these conditions. For example do that in a commit to this README file and state it in the commit message explicitly.

    License

    This software (qubicj and all of its submodules) is licensed under the GNU Affero General Public License (AGPL). See LICENSE for details. If you have special needs contact me for dual licensing.

    The logo is a modified version of the official bash logo. See Logo Repository and License.