osbc 0.1.5

data/lib/outerspace/blockchain/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Outerspace
+  module Blockchain
+    VERSION = "0.1.1"
+  end
+end

data/lib/outerspace/blockchain.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "blockchain/version"
+
+module Outerspace
+  module Blockchain
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/tasks/compose.rake

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "rake"
+
+namespace :compose do
+  task :install do
+    puts "Installing Blockchain and Database Containers"
+    system "sudo docker compose build"
+    puts "Creating Database"
+    system "sudo docker compose run --rm web rails db:create"
+    puts "Migrating Database"
+    system "sudo docker compose run --rm web rails db:migrate"
+    puts "Seeding Database"
+    system "sudo docker compose run --rm web rails db:seed"
+    puts "Stopping Containers"
+    system "sudo docker compose down"
+    puts "Installing Blockchain and Database Containers... Done!"
+    puts "This already setup your database with some initial values"
+    puts "Start the containers with command: rake compose:up"
+    puts "Stop the containers with command: rake compose:down"
+    puts "Restart the containers with command: rake compose:restart"
+    puts "Clean up the containers with command: rake compose:clean_all"
+    puts "Test your containers with command: rake compose:test"
+    puts "Build the containers againg with command: rake compose:build"
+    puts "rake compose_db command documentation at README.md to see database commands usage examples"
+    puts "See the development and test log files in Rails default logs folder when using compose:up"
+    puts "-----------------------------------------------------------------------------------"
+    puts "Access the web server on port 80."
+    puts "http://localhost"
+    puts "Look at README.md for more details."
+  end
+
+  task :build do
+    puts "Building Compose..."
+    system "sudo docker compose build"
+    puts "Building Compose... Done!"
+  end
+
+  task :up do
+    puts "Running Compose..."
+    system "sudo docker compose up -d --remove-orphans"
+    puts "Running Compose... Done!"
+  end
+
+  task :down do
+    puts "Stopping Compose..."
+    system "sudo docker compose down"
+    puts "Stopping Compose... Done!"
+  end
+
+  task :db_detach do
+    puts "Running Database Detached..."
+    system "sudo docker compose up -d db"
+    puts "Running Database Detached... Done!"
+  end
+
+  task :redis_detach do
+    puts "Running Redis Detached..."
+    system "sudo docker compose up -d redis"
+    puts "Running Redis Detached... Done!"
+  end
+
+  task :back_detach do
+    puts "Running Backend Detached..."
+    system "sudo docker compose up -d --remove-orphans db redis sidekiq"
+    puts "Running Backend Detached... Done!"
+  end
+
+  task :restart do
+    puts "Restarting Compose..."
+    puts "Stopping Compose..."
+    system "sudo docker compose down"
+    puts "Stopping Compose... Done!"
+    puts "Running Compose..."
+    system "sudo docker compose up -d --remove-orphans"
+    puts "Restarting Compose... Done!"
+  end
+
+  task :clean_all do
+    puts "Cleaning Images..."
+    puts "Stopping Compose..."
+    system "sudo docker compose down"
+    puts "Stopping Compose... Done!"
+    puts "Removing Compose..."
+    system "sudo docker compose rm -v"
+    puts "Removing Compose... Done!"
+    puts "Removing Containers..."
+    system "sudo docker rm -f $(sudo docker ps -a -q)"
+    puts "Removing Containers... Done!"
+    puts "Cleaning Images... Done!"
+  end
+end

data/lib/tasks/compose_db.rake

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "rake"
+
+namespace :compose_db do
+  task :drop do
+    puts "Dropping Database..."
+    system("sudo docker compose run --rm web rake db:drop")
+    puts "Dropping Database... Done!"
+  end
+
+  task :rollback do
+    puts "Rolling Back Database..."
+    system("sudo docker compose run --rm web rails db:rollback")
+    puts "Rolling Back Database... Done!"
+  end
+
+  task :complete_setup do
+    puts "Setting up Database..."
+    system("sudo docker compose run --rm web rake db:create")
+    system("sudo docker compose run --rm web rake db:migrate")
+    system("sudo docker compose run --rm web rake db:seed")
+    puts "Setting up Database... Done!"
+  end
+
+  task :setup do
+    puts "Setting up and seeding Database..."
+    system("sudo docker compose run --rm web rake db:setup")
+    puts "Setting up and seeding Database... Done!"
+  end
+
+  task :create do
+    puts "Creating Database..."
+    system("sudo docker compose run --rm web rake db:create")
+    puts "Creating Database... Done!"
+  end
+
+  task :migrate do
+    puts "Running Migration..."
+    system("sudo docker compose run --rm web rake db:migrate")
+    puts "Running Migration... Done!"
+  end
+
+  task :seed do
+    puts "Running Seed..."
+    system("sudo docker compose run --rm web rake db:seed")
+    puts "Running Seed... Done!"
+  end
+
+  task :reset_setup do
+    puts "Resettting Database..."
+    system("sudo docker compose run --rm web rake db:drop")
+    system("sudo docker compose run --rm web rake db:setup")
+    puts "Resetting up Database... Done!"
+  end
+
+  task :reset do
+    puts "Resetting Database..."
+    system("sudo docker compose run --rm web rake db:drop")
+    system("sudo docker compose run --rm web rake db:create")
+    system("sudo docker compose run --rm web rake db:migrate")
+    system("sudo docker compose run --rm web rake db:seed")
+    puts "Resetting Compose... Done!"
+  end
+
+  task :force_reset do
+    puts "Running Compose Down"
+    system("rake compose:down")
+    system("rake compose_db:reset")
+  end
+end

data/lib/tasks/compose_logs.rake

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "rake"
+
+namespace :compose_logs do
+  task :web do
+    puts "Showing Web Logs..."
+    system "sudo docker compose logs web"
+    puts "Showing Web Logs... Done!"
+  end
+
+  task :db do
+    puts "Showing Database Logs..."
+    system "sudo docker compose logs db"
+    puts "Showing Database Logs... Done!"
+  end
+
+  task :redis do
+    puts "Showing Redis Logs..."
+    system "sudo docker compose logs redis"
+    puts "Showing Redis Logs... Done!"
+  end
+
+  task :sidekiq do
+    puts "Showing Sidekiq Logs..."
+    system "sudo docker compose logs sidekiq"
+    puts "Showing Sidekiq Logs... Done!"
+  end
+
+  task :all do
+    puts "Showing All Logs..."
+    system "sudo docker compose logs"
+    puts "Showing All Logs... Done!"
+  end
+
+  task :tail_web do
+    puts "Tailing Web Logs..."
+    system "sudo docker compose logs -f web"
+    puts "Tailing Web Logs... Done!"
+  end
+
+  task :tail_db do
+    puts "Tailing Database Logs..."
+    system "sudo docker compose logs -f db"
+    puts "Tailing Database Logs... Done!"
+  end
+
+  task :tail_redis do
+    puts "Tailing Redis Logs..."
+    system "sudo docker compose logs -f redis"
+    puts "Tailing Redis Logs... Done!"
+  end
+
+  task :tail_sidekiq do
+    puts "Tailing Sidekiq Logs..."
+    system "sudo docker compose logs -f sidekiq"
+    puts "Tailing Sidekiq Logs... Done!"
+  end
+
+  task :tail_all do
+    puts "Tailing All Logs..."
+    system "sudo docker compose logs -f"
+    puts "Tailing All Logs... Done!"
+  end
+
+  task :follow_web do
+    puts "Following Web Logs..."
+    system "sudo docker compose logs -f web"
+    puts "Following Web Logs... Done!"
+  end
+
+  task :follow_db do
+    puts "Following Database Logs..."
+    system "sudo docker compose logs -f db"
+    puts "Following Database Logs... Done!"
+  end
+
+  task :follow_redis do
+    puts "Following Redis Logs..."
+    system "sudo docker compose logs -f redis"
+    puts "Following Redis Logs... Done!"
+  end
+
+  task :follow_sidekiq do
+    puts "Following Sidekiq Logs..."
+    system "sudo docker compose logs -f sidekiq"
+    puts "Following Sidekiq Logs... Done!"
+  end
+
+  task :follow_all do
+    puts "Following All Logs..."
+    system "sudo docker compose logs -f"
+    puts "Following All Logs... Done!"
+  end
+end

data/lib/tasks/compose_test.rake

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rake"
+
+namespace :compose_test do
+  task :all do
+    puts "Running Test..."
+    system "sudo docker compose run --rm web bundle exec rspec"
+    puts "Running Test... Done!"
+  end
+
+  task :clean_test do
+    puts "Running Clean Test..."
+    system "rake compose:clean_all"
+    puts "Cleaning Compose Images... Done!"
+    puts "Running Tests ..."
+    system "sudo docker compose run --rm web bundle exec rspec"
+    puts "Running Clean Test... Done!"
+  end
+
+  task :controllers do
+    puts "Running Controllers Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/controllers"
+    puts "Running Controllers Test... Done!"
+  end
+
+  task :models do
+    puts "Running Models Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/models"
+    puts "Running Models Test... Done!"
+  end
+
+  task :requests do
+    puts "Running Requests Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/requests"
+    puts "Running Requests Test... Done!"
+  end
+
+  task :helpers do
+    puts "Running Helpers Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/helpers"
+    puts "Running Helpers Test... Done!"
+  end
+
+  task :mailers do
+    puts "Running Mailers Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/mailers"
+    puts "Running Mailers Test... Done!"
+  end
+
+  task :routing do
+    puts "Running Routing Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/routing"
+    puts "Running Routing Test... Done!"
+  end
+
+  task :views do
+    puts "Running Views Test..."
+    system "sudo docker compose run --rm web bundle exec rspec spec/views"
+    puts "Running Views Test... Done!"
+  end
+end

data/mining_concept.ipynb

@@ -0,0 +1,284 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Mining Concept\n",
+    "- Every user will have a **randomized acceptable word list**\n",
+    "- This word list will have three classes of words\n",
+    "1. Common words\n",
+    "2. Symbol Sequence\n",
+    "3. Number Sequence\n",
+    "\n",
+    "<p> \n",
+    "When a user want to mine a block, the user will open a ticket in the server\n",
+    "and after the ticket is open, the user will start to mine the block\n",
+    "</p> \n",
+    "\n",
+    "<p>\n",
+    "The mine will depend of the contract signatures that will be formed by the server using the word list of the user\n",
+    "</p>\n",
+    "\n",
+    "\n",
+    "## Steps to mine a block:\n",
+    "\n",
+    "1. The user will open a TICKET in the server\n",
+    "2. The server will send a message to the user to start mining if the POOL is open\n",
+    "3. The users will load the RANDOM WORD LIST provided by the server API\n",
+    "4. The user have to use 1 common word, 1 symbol sequence and 1 number sequence, randomize the characters\n",
+    "5. Transform the chartacters in a SHA256 hash\n",
+    "6. Transform the block info in before ticket opened in a SHA256 hash\n",
+    "5. Transform (Chars SHA256 hash + block info hash) in a SHA256 hash - or - send only the chars SHA256 hash\n",
+    "6. If the hash is valid, the user will send the hash to the server\n",
+    "7. The server will check if the hash is valid\n",
+    "8. If the hash is valid, check if the same transactions have the same block state confirmation\n",
+    "9. If this transactions was not confirmed at this point at block history the server will add the user signature to the transaction contract\n",
+    "10. The block only can be hashed when the minimum number of contracts valids with minimum number of signatures is reached\n",
+    "11. The server will use the signature timeline to determine what transactions will be added to the block\n",
+    "12. The server will calculate the master hash after confirm all valid contracts signatures\n",
+    "13. The server will add the block to the blockchain and create a new one with last block unconfirmed transactions but completely unsigned\n",
+    "13. The server will start a open/closed pool cycle\n",
+    "14. The server will send a message to the user to start mining when the POOL is open and user has a ticket\n",
+    "<p>\n",
+    "The timestamps of the signatures will be usefull to version the block, checking it as a timeline\n",
+    "</p>\n",
+    "\n",
+    "**The miners will be rewarded with the block reward distributed by the number of signatures**\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import pandas as pd\n",
+    "import numpy as np\n",
+    "import matplotlib.pyplot as plt\n",
+    "import seaborn as sns\n",
+    "import datetime\n",
+    "import hashlib\n",
+    "import itertools\n",
+    "import requests as re"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "551e86307dfaddeb02f0326ec1667eac3257817b41ae8916531a06fbcdf9148c\n"
+     ]
+    },
+    {
+     "data": {
+      "text/plain": [
+       "(['her', 'number', 'it', 'at'],\n",
+       " ['0654', '1523', '2307', '5890'],\n",
+       " ['@(#$¨@#¨$@¨$$¨@(#$)', '$#$¨@*#$¨$(@#)', '@#$%^&*()_', ')@#$%^&*('])"
+      ]
+     },
+     "execution_count": 2,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "key = '9e8b3f4bf92577861e06e3bc84a809794dd6a7ab9da1070a78eb763b3399595a'\n",
+    "secret = 'a239c12ecc42911ecbc3b23a9539976caaa60f7d40028dea17cb67cc538c21bd'\n",
+    "\n",
+    "headers = {\n",
+    "    'X-Api-Key': key,\n",
+    "    'X-Api-Secret': secret,\n",
+    "}\n",
+    "\n",
+    "\n",
+    "transactions = re.get('http://localhost/api/v1/tr_to_mine', headers=headers)\n",
+    "\n",
+    "transactions = str(transactions.json())\n",
+    "\n",
+    "transactions_hash = hashlib.sha256(transactions.encode('utf-8')).hexdigest()\n",
+    "\n",
+    "print(transactions_hash)\n",
+    "\n",
+    "accepted_sequences = re.get('http://localhost/api/v1/info_to_mine', headers=headers)\n",
+    "\n",
+    "accepted_sequences = accepted_sequences.json()\n",
+    "\n",
+    "accepted_sequences\n",
+    "\n",
+    "def parse_accepted_sequences(accepted_sequences):\n",
+    "    words = accepted_sequences['words']\n",
+    "    numbers = accepted_sequences['number_sequences']\n",
+    "    symbols = accepted_sequences['symbol_sequences']\n",
+    "    return words, numbers, symbols\n",
+    "\n",
+    "words, numbers, symbols = parse_accepted_sequences(accepted_sequences)\n",
+    "\n",
+    "words, numbers, symbols"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def all_combinations(acceptable_words, acceptable_number_sequences, acceptables_symbol_sequences):\n",
+    "    combinations = []\n",
+    "    for comb in itertools.product(acceptable_words, acceptable_number_sequences, acceptables_symbol_sequences):\n",
+    "        combinations.append(''.join(comb))\n",
+    "    return combinations\n",
+    "\n",
+    "def hash_combinations(combinations, transactions_hash, run_on=0):\n",
+    "    hash_list = []\n",
+    "    counter = 0\n",
+    "    for combination in combinations:\n",
+    "        for comb in itertools.permutations(combination):\n",
+    "            counter += 1\n",
+    "            if counter > run_on:\n",
+    "                random_hash = hashlib.sha256(''.join(comb).encode('utf-8')).hexdigest()\n",
+    "                hash_list.append(hashlib.sha256((transactions_hash + random_hash).encode('utf-8')).hexdigest())\n",
+    "            if len(hash_list) == 1000000:\n",
+    "                return hash_list"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def calculate_hash_rate(acceptable_w, acceptable_n, acceptables_s, transactions_hash, run_on=0):\n",
+    "    start = datetime.datetime.now()\n",
+    "    all_combs = all_combinations(acceptable_w, acceptable_n, acceptables_s)\n",
+    "    hash_list = hash_combinations(all_combs, transactions_hash)\n",
+    "    end = datetime.datetime.now()\n",
+    "    total_seconds = (end - start).total_seconds()\n",
+    "    hash_rate = len(hash_list) / total_seconds\n",
+    "    return hash_rate, start, end, total_seconds, hash_list\n",
+    "\n",
+    "def benchmark_table(hash_rate, start, end, total_seconds, hash_list):\n",
+    "    hash_list_table = pd.DataFrame({\n",
+    "        'hash': hash_list,\n",
+    "    })\n",
+    "    hash_rate_table = pd.DataFrame({\n",
+    "        'Hash rate': [hash_rate, hash_rate / 1000, hash_rate / 1000000, hash_rate / 1000000000],\n",
+    "        'Unit': ['h/s', 'kh/s', 'Mh/s', 'Gh/s']\n",
+    "    })\n",
+    "    time_table = pd.DataFrame({\n",
+    "        'Time': [start, end, total_seconds],\n",
+    "        'Unit': ['start', 'end', 'total_seconds'],\n",
+    "    })\n",
+    "    return hash_rate_table, time_table, hash_list_table"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "hash_rate, start, end, total_seconds, hash_list = calculate_hash_rate(words, numbers, symbols, transactions_hash)\n",
+    "hash_rate_table, time_table, hash_list_table = benchmark_table(hash_rate, start, end, total_seconds, hash_list)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "hash_list_table"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "time_table"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "hash_rate_table"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "def plot_hash_rate(hash_rate_table):\n",
+    "    hash_rate_table.plot(x='Unit', y='Hash rate', kind='bar', logy=True)\n",
+    "    plt.show()\n",
+    "\n",
+    "plot_hash_rate(hash_rate_table)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'message': 'Contract assigned'}"
+      ]
+     },
+     "execution_count": 10,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "hash_to_send = '99893b819abfa80498f244fddd080f570cecdc994199d5c6a8148141401cdff1'\n",
+    "\n",
+    "params = { 'user_confirmation_hash' : hash_to_send }\n",
+    "confirm_request = re.post('http://localhost/api/v1/confirm_block', headers=headers, params=params)\n",
+    "\n",
+    "confirm_request.json()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3.9.2 64-bit",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.2"
+  },
+  "orig_nbformat": 4,
+  "vscode": {
+   "interpreter": {
+    "hash": "916dbcbb3f70747c44a77c7bcd40155683ae19c65e1c03b4aa3499c5328201f1"
+   }
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

data/outerspace-blockchain.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "lib/outerspace/blockchain/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "outerspace-blockchain"
+  spec.version = Outerspace::Blockchain::VERSION
+  spec.authors = ["JesusGautamah"]
+  spec.email = ["lima.jesuscc@gmail.com"]
+
+  spec.summary = "Blockchain implementation in Ruby"
+  spec.description = "Blockchain implementation in Ruby using Rails and Docker"
+  spec.homepage = "https://outerspace-blockchain.herokuapp.com/"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.3"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/outerspace-coding/outerspace-blockchain"
+  spec.metadata["changelog_uri"] = "https://github.com/outerspace-coding/outerspace-blockchain/blob/main/CHANGELOG.md"
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "bundler", "~> 2.2"
+  spec.add_runtime_dependency "rails", "~> 7.0.4"
+  spec.add_runtime_dependency "pg", "~> 1.4"
+  spec.add_runtime_dependency "puma", "~> 5.0"
+  spec.add_runtime_dependency "importmap-rails", "~> 1.1"
+  spec.add_runtime_dependency "tailwindcss-rails", "~> 2.0"
+  spec.add_runtime_dependency "rubocop-rails", "~> 2.16"
+  spec.add_runtime_dependency "rubocop-rspec", "~> 2.13"
+  spec.add_runtime_dependency "sidekiq", "~> 6.5"
+  spec.add_runtime_dependency "devise", "~> 4.8"
+  spec.add_runtime_dependency "rspec-rails", "~> 6.0"
+  spec.add_runtime_dependency "factory_bot_rails", "~> 6.2"
+  spec.add_runtime_dependency "faker", "~> 2.23"
+  spec.add_runtime_dependency "simplecov", "~> 0.21"
+  spec.add_runtime_dependency "selenium-webdriver", "~> 4.5"
+  spec.add_runtime_dependency "sprockets-rails", "~> 3.4"
+  spec.add_runtime_dependency "webdrivers", "~> 5.2"
+  spec.add_runtime_dependency "turbo-rails", "~> 1.3"
+  spec.add_runtime_dependency "stimulus-rails", "~> 1.1"
+  spec.add_runtime_dependency "jbuilder", "~> 2.11"
+end