README.md

Algorand Module

Algorand module ensure smart contracts integration with humhub-modules-xcoin.

Table of content

• Overview
• Development
  • Installation
  • Testing

Overview

Algorand module represents a connector between Xcoin and Blockchain Smart Contract.

This module will not be functional without Xcoin Module, in order to install this latter check its documentation.

---

Principal calls made through this module :

• POST /coin/transfer to transfer coins
• POST /coin/balance to get a wallet balance
• GET /api/getAlgoBalance to get a wallet AlgoBalance
• POST /asset to create an asset
• POST /wallet to create wallet

Development

Installation

Two ways are possible :

• External Installation (recommended for development purpose) :

  Clone the module outside your Humhub root directory for example in a folder called modules :

     $ cd modules 
     $ git clone https://github.com/Coinsence/humhub-modules-alogrand.git
  

  Configure Autoload path by adding this small code block in the humhub_root_direcotry/protected/config/common.php file :

return [
	'params' => [
		'moduleAutoloadPaths' => ['/path/to/modules'],
	],
];

• Internal Installation (recommended for direct usage purpose) :

  Just clone the module directly under humhub_root_direcotry/protected/humhub/modules

=> Either ways you need to enable the module through through Browse online tab in the Administration menu under modules section.

Testing

TBD