#Blockchain - A blockchain prototype to understand the concept
This project allows you to have a blockchain with minimum features. It is a Symfony 4.1 project. Feel free to test.
#Requirements
- VM Memory available >= 2048
- PHP 7.1
- sqlite3
- composer - Dependency Manager for PHP
- ext-pdo-sqlite
- ext-sqlite3
- ext-xml
#Install - Not using Vagrant
If you are not going to use Vagrant - that setups the application for you -, ensure that you have in your local machine all the needed features (see Requirements).
$ git clone https://github.com/filipefernandes007/blockchain
$ cd blockchain
$ composer self-update
$ composer install
$ composer run-app#Bonus
A Vagrant file if you prefer. Just run:
$ vagrant up#Troubleshooting with Vagrant
During my tests, i found the bellow message:
"Vagrant was unable to mount VirtualBox shared folders. This is usually because the filesystem "vboxsf" is not available. This filesystem is made available via the VirtualBox Guest Additions and kernel module. Please verify that these guest additions are properly installed in the guest. This is not a bug in Vagrant and is usually caused by a faulty Vagrant box. For context, the command attempted was: mount -t vboxsf -o dmode=777,fmode=666,uid=1000,gid=1000 var_www /var/www The error output from the command was: No such device"
If it is the case, don't worry, just run this command:
$ vagrant reloadIf you see the same message again, go to this link. There are several and good approaches to follow.
#Run application
Now start the application if you haven't yet - it does not start automatically, but if you want, uncomment the php bin/console server:run 192.168.33.91:8000 command in your Vagrant file to do so next time you 'reload' Vagrant).
In Vagrant:
$ vagrant ssh
$ cd var/www
$ composer run-vagrant-app # OR php bin/console server:run 192.168.33.91:8000 In your local machine:
$ composer run-app #Unit tests
You can run tests with bash command composer test
The unit tests interact with a test database : app_test.db. All your API requests will interact with dev database : app_dev.db
composer test also launches doctrine fixtures and purges app_test.db
for your convenience.
###Troubleshooting
Apply php bin/console cache:clear if you get this message after composer test :
"Remaining deprecation notices (1) 1x: The "Sensio\Bundle\FrameworkExtraBundle\Configuration\Route" annotation is deprecated since version 5.2. Use "Symfony\Component\Routing\Annotation\Route" instead. "
#API
In order to test blockchain and besides Unit Tests, there are routes to address blockchain and his blocks:
Name Method Scheme Host Path
block_api_get GET ANY ANY /api/block/{id}
block_api_all GET ANY ANY /api/block/all/{blockchainId}
blockchain_api_add POST ANY ANY /api/blockchain
blockchain_api_get GET ANY ANY /api/blockchain/{id}
blockchain_api_all GET ANY ANY /api/blockchain
blockchain_api_all_pagination GET ANY ANY /api/blockchain/page/{page}
blockchain_api_add_block POST ANY ANY /api/blockchain/block
blockchain_api_blocks GET ANY ANY /api/blockchain/{id}/blocks
Enjoy!