cryptos 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 821b977f9586beced716c6274e4c4de1b2bd59eacb2ca2d1f00ba7555cda7a46
-  data.tar.gz: aef2d8dcd9b5ef0155925df43d89fb8738fe09cfa1e99d9d78065a82ee3bcf6c
+  metadata.gz: 4443865be6e4d80fd14379b9a069cc5c2de35c1d9ef805bfdc63fc1c8f58dab3
+  data.tar.gz: 2f7af68e8ecd589d0239f7d998d491017950a7b24b7e50e64e5909a35c2832b7
 SHA512:
-  metadata.gz: cc3b5bc76776036438e1bb65efa1988f7fd0c8c12adcd57feab46bf94103086a024b5e92b7774891e27eaa9ed330b48ea7e841ddd87bbe5e816d2762f2cee353
-  data.tar.gz: 51fb82e5739d2a160f7968dcc8fa37f72b805614e85407051789b3b060c08a49a8153e9cba83f212a8aa236c5325f3a2f7ff05ca91cc2b42c650924a2e8c22f6
+  metadata.gz: 8e68269fc968d716d372284dc3685d69155dcdb0fe31f22e5a8f5af7156a4950a87019f8ab667136da914b379d36498e69d6696e43b3b4f3d6a05c5fe955db6d
+  data.tar.gz: 4d7014a5f7b23eef84a2aa6b61d3804878a29d26316c95ce1a8be8016f02119685494c196e9114af7b78a2848af4a365cee0d2bc6d3dea66ae52b87a85c81fe5

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
 
 env:
   global:
-    - CC_TEST_REPORTER_ID=38c8686e073a8123e72d8f7c580edbfae244922662e6202e9a964152b6b234a0
+    - CC_TEST_REPORTER_ID=0574ba014fdce356c974c3b8e6e74ea6b07079b9355c35b391b8e17e72aec5c1
 
 apt_packages:
   - bitcoind

data/CHANGELOG.md

@@ -1 +1,33 @@
-# CryptoCrafts changelog
+        # Changelog
+
+        All notable changes to this project will be documented in this file.
+
+        The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+        and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+        ## [Unreleased]
+        ### Added
+        - Atomic swap between Bitcoin and Litecoin
+        ### Changed
+        ### Removed
+
+        ## [0.0.3] - 2018-12-11
+        ### Added
+        - LICENSE, changelog, Github template files
+        ### Changed
+        - Rename project to Cryptos-ruby
+        - Fixes in README, gemspec files
+
+        ## [0.0.2] - 2018-12-01
+        ### Added
+        - Bitcoin/Litecoin transactions
+        - Automated tests with regtest mode
+        - Travis, CodeClimate integration
+        ### Changed
+        - Refactoring big old base files
+
+        ## [0.0.1] - 2018-11-26
+        ### Added
+        - Elliptic curves math, digital signature algorithm
+        - Generate private / public keys
+        - Generate Bitcoin/Litecoin addresses

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cryptos (0.0.2)
+    cryptos (0.0.3)
       hashie
       httparty
 

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Iulian Costan
+
+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/README.md

@@ -1,11 +1,29 @@
-# Cryptos
-[![Build Status](https://travis-ci.org/icostan/cryptos.svg?branch=master)](https://travis-ci.org/icostan/cryptos)
-[![Maintainability](https://api.codeclimate.com/v1/badges/d929c152bff4fe5be78f/maintainability)](https://codeclimate.com/github/icostan/cryptos/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/d929c152bff4fe5be78f/test_coverage)](https://codeclimate.com/github/icostan/cryptos/test_coverage)
+# Cryptos-ruby
+
+[![Build Status](https://travis-ci.org/icostan/cryptos-ruby.svg?branch=master)](https://travis-ci.org/icostan/cryptos-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3e4566b45ebc3f887cef/maintainability)](https://codeclimate.com/github/icostan/cryptos-ruby/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3e4566b45ebc3f887cef/test_coverage)](https://codeclimate.com/github/icostan/cryptos-ruby/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/cryptos.svg)](https://badge.fury.io/rb/cryptos)
 
-Cryptos project is meant to provide an unified Ruby API to work with different crypto-currencies but the ultimate goal is to support atomic-swaps between any two coins.
+### The Why - the vision and goals
+
+  * I believe there are none of very few Ruby implementations and support for different crypto technologies
+  * I like to craft my own wallets, transactions, block explorers in all shapes and forms
+  * I dream to execute atomic swaps between any crypto coins out there
+
+### The How - the actions
+
+  * Implementing basic cryptography from scratch - elliptic curves math, digital signature schemes, etc
+  * Building a simple and easy to use Ruby API
+  * Lean and continuous improvment along the way (aka adding more coins) while I understand more advanced concepts: pairing cryptography
+
+### The What - the features
 
+  * Generate private and public keys
+  * Generate addresses for Bitcoin, Litecoin, Ethereum and much more
+  * Create transaction to spend standard inputs or more complex multisig, hashed timelock contracts
+  * Execute atomic swaps between Bitcoin and Litecoin, more to come
+  * TODO: Create, import, export wallets
 
 ## Installation
 
@@ -36,7 +54,7 @@ Alright, let's begin, first thing first, lets generate private and public keys:
  => #<Cryptos::PublicKey:0x00007f8cc105ed58 @private_key=#<Cryptos::PrivateKey:0x00007f8cc10c0ad0 @value=1991485315816438798044329630916774278846523543844864946402119577704095054145, @order=115792089237316195423570985008687907852837564279074904382605163141518161494337>, @x=107779388491921327681974754398507503201871466663959093103394577491037829153768, @y=78060352001932916201234328232450653863791592111885208305671830584742527863131>
 ```
 
-Based in publik key above lets create a Bitcoin address:
+Based on public key above lets create a Bitcoin address:
 
 ```ruby
 2.5.3 :003 > from_address = Cryptos::Bitcoin::Address.new public_key
@@ -53,7 +71,7 @@ brew install bitcoin
 apt-get install bitcoin
 
 # start Bitcoin daemon in regtest mode
-bitcoin-cli -regtest -printtoconsole
+bitcoind -regtest -printtoconsole
 ```
 
 Now we create a simple Cli connector that will communicate to underlying bitcoin daemon.
@@ -79,7 +97,7 @@ Generate and import destination address to send BTC to then check that it has no
  => #<Cryptos::Bitcoin::Address:0x00007f8cc134f2b0 @public_key=#<Cryptos::PublicKey:0x00007f8cc128fa78 @private_key=#<Cryptos::PrivateKey:0x00007f8cc128faa0 @value=104555233989943463494354097619221894829574308702717051161491781222000198727347, @order=115792089237316195423570985008687907852837564279074904382605163141518161494337>, @x=1402024405898287938501468401055931693243587868828983898835308320263377717122, @y=89146164815925753866667564550747587615674131412309491381641677989226156891240>, @testnet=true>
 2.5.3 :008 > to_address.import cli
  => true
-2.5.3 :009 > cli.get_received_by_address to_address
+2.5.3 :009 > to_address.get_balance cli
  => "0.00000000"
 ```
 

data/TODOs.org

@@ -8,3 +8,13 @@
   * deterministic signature (https://tools.ietf.org/html/rfc6979)
   * refactor elliptic curve module, extract to classes
   * implement #to_s method for all classes, right now they are too verbose
+  * refactor: add input#sign and mark input as signed
+  * atomic swaps:
+    * happy path - successful redeem both coins
+    * sad path - no redeem, broadcast refund transactions
+    * error paths - redeem with invalid secret, refund before locktime
+    * refactor: simplify swap interfaces
+  * bitcoin:
+    * add address type to constructor
+    * support segwit address
+  * add ZCash support

data/bin/run

@@ -1,19 +1,40 @@
 #!/usr/bin/env ruby
 
+require 'bundler/setup'
+require 'cryptos'
+
+cli = Cryptos::Connectors::Cli.new
+
+puts 'Generating private key...'
 private_key = Cryptos::PrivateKey.generate
+
+puts 'Generating public key...'
 public_key = Cryptos::PublicKey.new private_key
+
+puts 'Generating source address...'
 from_address = Cryptos::Bitcoin::Address.new public_key
-cli = Cryptos::Connectors::Cli.new
 from_address.import cli
+
+puts 'Mine 101 blocks...'
 cli.generate_to_address from_address, blocks: 101
+
+puts 'Generating destination address...'
 to_address = Cryptos::Bitcoin::Address.new Cryptos::PublicKey.new Cryptos::PrivateKey.generate
 to_address.import cli
-cli.get_received_by_address to_address
+to_address.get_balance cli
+
+puts 'Create transaction...'
 input = Cryptos::Input.from_utxo cli, from_address
 output = Cryptos::Output.p2pkh to_address, 123_456_789
 change = Cryptos::Output.p2pkh_change from_address, input, output
 transaction = Cryptos::Transaction.from_ioc input, output, change
+
+puts 'Sign and broadcast transaction...'
 transaction.sign_single_input from_address
 transaction.broadcast cli
+
+puts 'Mine next block...'
 cli.generate blocks: 1
-cli.get_received_by_address to_address
+
+puts 'Check destination balance...'
+puts to_address.get_balance cli

data/cryptos.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Crypto craft your own transactions}
   spec.description   = %q{The easiest way to craft your own transactions for multiple crypto currencies}
-  spec.homepage      = 'https://github.com/icostan/cryptos'
+  spec.homepage      = 'https://github.com/icostan/cryptos-ruby'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
     spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = 'https://github.com/icostan/cryptos.git'
-    spec.metadata['changelog_uri'] = 'https://github.com/icostan/cryptos/blob/master/CHANGELOG'
+    spec.metadata['source_code_uri'] = 'https://github.com/icostan/cryptos-ruby.git'
+    spec.metadata['changelog_uri'] = 'https://github.com/icostan/cryptos-ruby/blob/master/CHANGELOG'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'

data/lib/cryptos/address.rb

@@ -43,6 +43,10 @@ module Cryptos
       cli.import_address self
     end
 
+    def get_balance(cli)
+      cli.get_received_by_address self
+    end
+
     def to_s
       p2pkh
     end

data/lib/cryptos/output.rb

@@ -17,6 +17,11 @@ module Cryptos
       Output.p2pkh address, change_value
     end
 
+    def self.atomic_swap(secret_hash, to_address, locktime, from_address, amount)
+      swap_script = Cryptos::Script.swap secret_hash, to_address, locktime, from_address
+      Output.new amount, Cryptos::Script.p2sh(swap_script)
+    end
+
     def serialize
       script_hex = script_pubkey.to_hex
       long_to_hex(value) + byte_to_hex(hex_size(script_hex)) + script_hex

data/lib/cryptos/script.rb

@@ -3,20 +3,29 @@ module Cryptos
     include Utils::Hexas, Utils::Hashes
 
     OPCODES = {
-      'OP_0' =>  0x00,
-      'OP_1' =>  0x51,
-      'OP_2' =>  0x52,
-      'OP_DUP' =>  0x76,
-      'OP_HASH160' =>  0xA9,
+      'OP_0' => 0x00,
+      'OP_PUSHDATA1' => 0x4c,
+      'OP_1' => 0x51,
+      'OP_2' => 0x52,
+      'OP_IF' => 0x63,
+      'OP_ELSE' => 0x67,
+      'OP_ENDIF' => 0x68,
+      'OP_DROP' => 0x75,
+      'OP_DUP' => 0x76,
       'OP_EQUAL' =>  0x87,
-      'OP_EQUALVERIFY' =>  0x88,
-      'OP_CHECKSIG' =>  0xAC,
-      'OP_CHECKMULTISIG' => 0xAE
+      'OP_EQUALVERIFY' => 0x88,
+      'OP_RIPEMD160' => 0xA6,
+      'OP_HASH160' => 0xA9,
+      'OP_CHECKSIG' => 0xAC,
+      'OP_CHECKMULTISIG' => 0xAE,
+      'OP_CHECKLOCKTIMEVERIFY' => 0xB1,
+      'OP_CHECKSEQUENCEVERIFY' => 0xB2,
     }.freeze
 
     attr_reader :script
 
-    # scriptSig for pay-to-pubkey-hash outputs
+    # ScriptSig for pay-to-pubkey-hash outputs
+    #
     # @param der - signature in der format
     # @param public_key - the public key
     # @return script - a Script object holding scriptSig
@@ -26,7 +35,12 @@ module Cryptos
 
     # scriptSig for pay-to-multisig-hash outputs
     def self.sig_multisig(der1, der2, redeem_script)
-      new "OP_0 #{der1.serialize} #{der2.serialize} #{redeem_script.serialize}"
+      new "OP_0 #{der1.serialize} #{der2.serialize} #{redeem_script.to_hex}"
+    end
+
+    # scriptSig for atomic swaps
+    def self.sig_swap(der, public_key, secret, redeem_script)
+      new "#{der.serialize} #{public_key.to_sec} #{secret} OP_1 #{redeem_script.to_hex}"
     end
 
     def self.p2pkh(address_or_hex)
@@ -47,12 +61,25 @@ module Cryptos
       new "OP_2 #{address1.public_key.to_sec} #{address2.public_key.to_sec} OP_2 OP_CHECKMULTISIG"
     end
 
+    def self.swap(secret_hash, to_address, locktime, from_address)
+      new %{
+        OP_IF
+          OP_RIPEMD160 #{secret_hash} OP_EQUALVERIFY
+          OP_DUP OP_HASH160 #{to_address.to_hash160}
+        OP_ELSE
+          #{locktime} OP_CHECKLOCKTIMEVERIFY OP_DROP
+          OP_DUP OP_HASH160 #{from_address.to_hash160}
+        OP_ENDIF
+        OP_EQUALVERIFY OP_CHECKSIG
+      }.delete("\n").squeeze ' '
+    end
+
     def self.bare(script)
       new script
     end
 
     def initialize(script)
-      @script = script
+      @script = script.strip
     end
 
     def to_hash160
@@ -86,7 +113,11 @@ module Cryptos
     def data(token)
       bin_size = data_size token
       # TODO: data size is defined as 1-9 bytes
-      byte_to_hex(bin_size) + token
+      if bin_size > 0x4b
+        opcode('OP_PUSHDATA1') + byte_to_hex(bin_size) + token
+      else
+        byte_to_hex(bin_size) + token
+      end
     end
 
     def data_size(token)

data/lib/cryptos/transaction.rb

@@ -60,6 +60,18 @@ module Cryptos
       serialize
     end
 
+    def sign_atomic_swap(secret, secret_hash, to_address, locktime, from_address, sighash_type = 0x01)
+      redeem_script = Cryptos::Script.swap secret_hash, to_address, locktime, from_address
+      bytes_string = signature_hash redeem_script, sighash_type
+
+      r, s = ecdsa_sign to_address.public_key.private_key.value, bytes_string
+      der = Cryptos::Der.new r: r, s: s
+      sig_swap = Script.sig_swap der, to_address.public_key, secret, redeem_script
+      inputs[0].script_sig = sig_swap
+
+      serialize
+    end
+
     def broadcast(cli)
       cli.send_raw_transaction serialize
     end

data/lib/cryptos/utils/hashes.rb

@@ -7,6 +7,10 @@ module Cryptos
         Digest::SHA256.hexdigest([data].pack('H*'))
       end
 
+      def ripemd160(data)
+        Digest::RMD160.hexdigest([data].pack('H*'))
+      end
+
       def hash160(data)
         sha256 = Digest::SHA256.digest([data].pack('H*'))
         Digest::RMD160.hexdigest sha256

data/lib/cryptos/version.rb

@@ -1,3 +1,3 @@
 module Cryptos
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptos
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Iulian Costan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -143,6 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -151,6 +153,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - TODOs.org
@@ -181,13 +184,13 @@ files:
 - lib/cryptos/utils/hashes.rb
 - lib/cryptos/utils/hexas.rb
 - lib/cryptos/version.rb
-homepage: https://github.com/icostan/cryptos
+homepage: https://github.com/icostan/cryptos-ruby
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/icostan/cryptos
-  source_code_uri: https://github.com/icostan/cryptos.git
-  changelog_uri: https://github.com/icostan/cryptos/blob/master/CHANGELOG
+  homepage_uri: https://github.com/icostan/cryptos-ruby
+  source_code_uri: https://github.com/icostan/cryptos-ruby.git
+  changelog_uri: https://github.com/icostan/cryptos-ruby/blob/master/CHANGELOG
 post_install_message: 
 rdoc_options: []
 require_paths: