osbc 0.1.5

data/Gemfile.lock

@@ -0,0 +1,343 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4)
+      actionpack (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activesupport (= 7.0.4)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.4)
+      actionpack (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activerecord-import (1.4.1)
+      activerecord (>= 4.2)
+    activestorage (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activesupport (= 7.0.4)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    bcrypt (3.1.18)
+    bindex (0.8.1)
+    bootsnap (1.13.0)
+      msgpack (~> 1.2)
+    builder (3.2.4)
+    capybara (3.37.1)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    childprocess (4.1.0)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.3.0)
+    crass (1.0.6)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    devise (4.8.1)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 4.1.0)
+      responders
+      warden (~> 1.2.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.11.0)
+    factory_bot (6.2.1)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.2.0)
+      factory_bot (~> 6.2.0)
+      railties (>= 5.0.0)
+    faker (2.23.0)
+      i18n (>= 1.8.11, < 2)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    importmap-rails (1.1.5)
+      actionpack (>= 6.0.0)
+      railties (>= 6.0.0)
+    io-console (0.5.11)
+    irb (1.4.2)
+      reline (>= 0.3.0)
+    jbuilder (2.11.5)
+      actionview (>= 5.0.0)
+      activesupport (>= 5.0.0)
+    json (2.5.1)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    msgpack (1.6.0)
+    net-imap (0.3.1)
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.2)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
+    orm_adapter (0.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pg (1.4.4)
+    public_suffix (5.0.0)
+    puma (5.6.5)
+      nio4r (~> 2.0)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.4)
+      actioncable (= 7.0.4)
+      actionmailbox (= 7.0.4)
+      actionmailer (= 7.0.4)
+      actionpack (= 7.0.4)
+      actiontext (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activemodel (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4)
+    rails-controller-testing (1.0.5)
+      actionpack (>= 5.0.1.rc1)
+      actionview (>= 5.0.1.rc1)
+      activesupport (>= 5.0.1.rc1)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.8.0)
+    regexp_parser (2.6.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    responders (3.0.1)
+      actionpack (>= 5.0)
+      railties (>= 5.0)
+    rexml (3.2.5)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-rails (6.0.0)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.11)
+      rspec-expectations (~> 3.11)
+      rspec-mocks (~> 3.11)
+      rspec-support (~> 3.11)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.22.0)
+      parser (>= 3.1.1.0)
+    rubocop-rails (2.16.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    selenium-webdriver (4.5.0)
+      childprocess (>= 0.5, < 5.0)
+      rexml (~> 3.2, >= 3.2.5)
+      rubyzip (>= 1.2.2, < 3.0)
+      websocket (~> 1.0)
+    shoulda-matchers (5.2.0)
+      activesupport (>= 5.2.0)
+    sidekiq (6.5.7)
+      connection_pool (>= 2.2.5)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    slim (4.1.0)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    slim-rails (3.5.1)
+      actionpack (>= 3.1)
+      railties (>= 3.1)
+      slim (>= 3.0, < 5.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    stimulus-rails (1.1.0)
+      railties (>= 6.0.0)
+    tailwindcss-rails (2.0.14-x86_64-linux)
+      railties (>= 6.0.0)
+    temple (0.8.2)
+    thor (1.2.1)
+    tilt (2.0.11)
+    timeout (0.3.0)
+    turbo-rails (1.3.1)
+      actionpack (>= 6.0.0)
+      activejob (>= 6.0.0)
+      railties (>= 6.0.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+    web-console (4.2.0)
+      actionview (>= 6.0.0)
+      activemodel (>= 6.0.0)
+      bindex (>= 0.4.0)
+      railties (>= 6.0.0)
+    webdrivers (5.2.0)
+      nokogiri (~> 1.6)
+      rubyzip (>= 1.3.0)
+      selenium-webdriver (~> 4.0)
+    websocket (1.2.9)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.6.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord-import
+  bootsnap (~> 1.13)
+  capybara (~> 3.37)
+  database_cleaner-active_record (~> 2.0)
+  debug (~> 1.6)
+  devise (~> 4.8)
+  factory_bot_rails (~> 6.2)
+  faker (~> 2.23)
+  importmap-rails (~> 1.1)
+  jbuilder (~> 2.11)
+  pg (~> 1.4)
+  puma (~> 5.6)
+  rails (~> 7.0)
+  rails-controller-testing (~> 1.0)
+  rspec-rails (~> 6.0)
+  rubocop-rails (~> 2.16)
+  rubocop-rspec (~> 2.13)
+  selenium-webdriver (~> 4.5)
+  shoulda-matchers (~> 5.0)
+  sidekiq (~> 6.5)
+  simplecov (~> 0.21)
+  slim-rails (~> 3.5)
+  sprockets-rails (~> 3.4)
+  stimulus-rails (~> 1.1)
+  tailwindcss-rails (~> 2.0)
+  turbo-rails (~> 1.3)
+  tzinfo-data
+  web-console (~> 4.2)
+  webdrivers (~> 5.2)
+
+RUBY VERSION
+   ruby 3.0.3p157
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Igor Lima de Jesus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 JesusGautamah
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Procfile

@@ -0,0 +1,3 @@
+web: bin/rails server
+css: bin/rails tailwindcss:watch
+sidekiq: bundle exec sidekiq -C config/sidekiq.yml

data/Procfile.dev

@@ -0,0 +1,2 @@
+web: bin/rails server -p 80 -b 0.0.0.0
+css: bin/rails tailwindcss:watch

data/README.md

@@ -0,0 +1,185 @@
+# <img src="https://outerspace-coding.herokuapp.com/assets/pq-70825bc795d25668cf4f11b06b990ed0d1c2cae887acce0625e5059226a7946a.png" width="25" height="25"> Outerspace Blockchain
+<!-- Outerspace Logo -->
+### A Ruby implementation of web blockchain framework.
+#### Developed using TDD (Test Driven Development).
+#### Github Actions CI/CD pipeline.
+#### Chrome Selenium tests are used to test the blockchain in a browser and its interaction with the blockchain.
+#### Chrome Selenium are included in the docker compose without any additional setup.
+#### Simplecov is used to test code coverage.
+
+#### Rails Engine is used to create the blockchain.
+#### Tailwind CSS is used to style the blockchain web interface.
+
+#### Rspec is used to test the blockchain.
+
+## System dependencies
+    1. Docker
+    2. Postgresql
+    3. Ruby
+    4. Redis
+
+* Ruby 3.0.3
+* Compose Version 3.3
+* Docker Image: ruby:3.0.3
+
+* [Installation](#installation)
+    - [Docker](#docker) https://docs.docker.com/engine/install/
+    - [RVM](#rvm) https://rvm.io/rvm/install
+    - [Redis](#redis) https://redis.io/download
+    - [Postgres](#postgres) https://www.postgresql.org/download/
+    - [Rails](#rails) https://guides.rubyonrails.org/getting_started.html
+
+### Compile OSBC from source
+========================
+<!-- Compile OSBC from source -->
+Compile the gem from source with the following commands:
+```bash
+git clone 
+cd outerspace-blockchain
+bundle install
+```
+
+### Run OSBC
+========================
+<!-- Run OSBC -->
+Run the gem with the following command:
+```bash
+bin/osbc
+```
+
+### Installation
+========================
+<!-- Installation -->
+Build and install the gem with the following commands:
+```bash
+gem build osbc.gemspec
+gem install osbc-GENERATED_VERSION.gem
+```
+
+Use the gem with the following command:
+```bash
+osbc PATH_TO_GENERATE_BLOCKCHAIN
+``` 
+## RVM Commands to install Ruby 3.0.3 and Compile the Gem
+* `rvm install 3.0.3`
+* `rvm use 3.0.3`
+* `rvm gemset create outerspace`
+* `rvm gemset use outerspace`
+* `gem install bundler`
+* `bundle install`
+## Environment Variables
+The application has a .env file in root folder with the following environment variables:
+
+    FIRST_CHAIN_NAME=YOUR_CHAIN_NAME
+    FIRST_CHAIN_MAINTAINER=YOUR_NAME
+    CONTRACTS_LIMIT=100
+    SIGNATURES_LIMIT=5
+## Configuration
+### Rake tasks
+
+This application has rake tasks to help you with the development process with docker.
+The tasks are:
+#### Docker actions
+* `rake compose:install` - build docker compose and migrate the database
+* `rake compose:build` - build docker compose services
+* `rake compose:up` - start the docker compose services
+* `rake compose:down` - stop the docker compose services
+* `rake compose:db_detach` - detach the database from the docker compose services
+* `rake compose:redis_detach` - detach the redis from the docker compose services
+* `rake compose:back_detach` - detach the backend(redis, sidekiq, db) from the docker compose services
+* `rake compose:restart` - restart the docker compose services
+* `rake compose:clean_all` - clean all docker compose services
+#### Database actions
+* `rake compose_db:migrate` - migrate the database
+* `rake compose_db:reset` - reset the database
+* `rake compose_db:drop` - drop the database
+* `rake compose_db:create` - create the database
+* `rake compose_db:seed` - seed the database
+* `rake compose_db:rollback` - rollback the database
+* `rake compose_db:setup` - setup the database
+* `rake compose_db:complete_setup` - complete setup the database
+* `rake compose_db:reset_setup` - drop and setup the database
+* `rake compose_db:reset` - reset the database
+
+### Tests actions
+* `rake compose_test:all` - run all tests
+* `rake compose_test:clean_all` - run all tests after cleaning docker compose services
+* `rake compose_test:controllers` - run controllers tests
+* `rake compose_test:models` - run models tests
+* `rake compose_test:requests` - run requests tests
+* `rake compose_test:helpers` - run helpers tests
+* `rake compose_test:mailers` - run mailers tests
+* `rake compose_test:routing` - run routing tests
+* `rake compose_test:views` - run views tests
+
+### LOGS actions
+* `rake compose_logs:web` - show web logs
+* `rake compose_logs:db` - show db logs
+* `rake compose_logs:redis` - show redis logs
+* `rake compose_logs:sidekiq` - show sidekiq logs
+* `rake compose_logs:all` - show all logs
+* `rake compose_logs:tail_web` - tail web logs
+* `rake compose_logs:tail_db` - tail db logs
+* `rake compose_logs:tail_redis` - tail redis logs
+* `rake compose_logs:tail_sidekiq` - tail sidekiq logs
+* `rake compose_logs:tail_all` - tail all logs
+* `rake compose_logs:follow_web` - follow web logs
+* `rake compose_logs:follow_db` - follow db logs
+* `rake compose_logs:follow_redis` - follow redis logs
+* `rake compose_logs:follow_sidekiq` - follow sidekiq logs
+* `rake compose_logs:follow_all` - follow all logs
+
+## Start the blockchain
+````bash
+$ rake compose:up
+````
+### Access the blockchain web interface
+http://localhost
+
+## Mining Concept
+- Every user will have a **randomized acceptable word list**
+- This word list will have three classes of words
+1. Common words
+2. Symbol Sequence
+3. Number Sequence
+
+<p> 
+When a user want to mine a block, the user will open a ticket in the server
+and after the ticket is open, the user will start to mine the block
+</p> 
+
+<p>
+The mine will depend of the contract signatures that will be formed by the server using the word list of the user
+</p>
+
+
+## Steps to mine a block:
+
+1. The user will open a TICKET in the server
+2. The server will send a message to the user to start mining if the POOL is open
+3. The users will load the RANDOM WORD LIST provided by the server API
+4. The user have to use 1 common word, 1 symbol sequence and 1 number sequence, randomize the characters
+5. Transform the chartacters in a SHA256 hash
+6. Transform the block info in before ticket opened in a SHA256 hash
+5. Transform (Chars SHA256 hash + block info hash) in a SHA256 hash
+6. If the hash is valid, the user will send the hash to the server
+7. The server will check if the hash is valid
+8. If the hash is valid, check if the same transactions have the same block state confirmation
+9. If this transactions was not confirmed at this point at block history the server will add the user signature to the transaction contract
+10. The block only can be hashed when the minimum number of contracts valids with minimum number of signatures is reached
+11. The server will use the signature timeline to determine what transactions will be added to the block
+12. The server will calculate the master hash after confirm all valid contracts signatures
+13. The server will add the block to the blockchain and create a new one with last block unconfirmed transactions but completely unsigned
+13. The server will start a open/closed pool cycle
+14. The server will send a message to the user to start mining when the POOL is open and user has a ticket
+<p>
+The timestamps of the signatures will be usefull to version the block, checking it as a timeline
+</p>
+
+**The miners will be rewarded with the block reward distributed by the number of signatures**
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/outerspace-coding/outerspace-blockchain
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+* [LICENSE](LICENSE) - MIT License

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler"
+Bundler::GemHelper.install_tasks name: "outerspace-blockchain"
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link_tree ../../javascript .js
+//= link_tree ../../../vendor/javascript .js
+//= link_tree ../builds