ambersive/ardor

Make use of the ardor blockchain from within your laravel application.

v0.1.1 2020-10-04 18:38 UTC

README

Maintainability Build Status

This package for Laravel provides an integration to the ardor blockchain. For information about the changes please have a look into the CHANGELOG.md.

This project was ranked at 5th place at the Ardor Community Hackathon.

[!!! ATTENTION: This project is still work in progress !!!]

About

Ever wished to be a blockchain developer? With this package this wish can become true. This package aims to be the conntector to the PHP world and provides a simple interface to interact with the ardor blockchain. This specific blockchain is special because it offers a wide angle of possiblities. From token generation to messaging and selling digital goods.

Installation

composer require ambersive/ardor

than publish the config via:

php artisan vendor:publish --tag=ardor

Useage

This package contains multiple classes for the interaction with the blockchain endpoint. But all classes are based on the same communication layer. Before you can start please create a wallet (= account) on the ardor blockchain and add those information in config file.

Otherwise you can set those information on the fly:

Config::set('ardor.node', 'https://testardor.jelurida.com/');
Config::set('ardor.wallet', 'ARDOR-DAZJ-VVSM-552M-8K459');
Config::set('ardor.secret', 'orange welcome begun powerful lonely government cast figure add quit wife loser');

If you want to get the account detail for example you would recieve those information by making the following call:

use \AMBERSIVE\Ardor\Classes\ArdorAccountsHandler;
use \AMBERSIVE\Ardor\Models\ArdorAccount;

public function returnAcccountData():ArdorAccount {

    $ardor = new ArdorAccountsHandler();
    $account = $ardor->getAccount('ARDOR-DAZJ-VVSM-552M-8K459');

}

But there are quite more possible methods and calls (including the possiblity to create bundlers and custom contracts). For further information just go to the documentation.

What makes this package special?

Well it is the only package for the ardor blockchain out there and we provide some sugar on top like

Local signing of transactions

This integration aso provides a way to use local signing while using the endpoints. Further information in the advanced section of the documentation (here).

Documentation

The Documentation for all supported endpoints and methods also tries to offer a deeper look into the ardor blockchain technology.

Please feel free to contact us if you have issues or questions regarding this package.

Security Vulnerabilities

If you discover a security vulnerability within this package, please send an e-mail to Manuel Pirker-Ihl via manuel.pirker-ihl@ambersive.com. All security vulnerabilities will be promptly addressed.

License

This package is open-sourced software licensed under the MIT license.