contracthashtool 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ea9a50c8b3de136a68cb441d43095480f5a56a6
-  data.tar.gz: 4d4289f4a76d6798e9915c4a0f4f845c57539e4f
+  metadata.gz: 08284e65956a5805962806d2f4ba2748d792655c
+  data.tar.gz: 9a2aa606c96675f60d95ef93329256526ec098cc
 SHA512:
-  metadata.gz: cd2dd769fb0e97861e4af5cc90ee490663ed43d982b4a1892b751b8babee6b6eed7ed4a39a364ecc50a066d431217df89410f1c563d8c929c639f6d22d23b415
-  data.tar.gz: b55a653977efabc2c6dbc92ab1fff871943bf1ca2450aef613938214c96996764ce8520de51c0ed696a174ea977288ad73536a66e3d0330c3b41122c09a42aef
+  metadata.gz: c330b0fb70042dc4c010e07ce86b21304cb6418fab35f2f096990b051c83ec1c89f05bb895193e2caf765588f97702bb8a9388ed13b6435177bcb08d7195323a
+  data.tar.gz: 615298ef744d2d9dd860e73d9375307cc86ba4cece7eaf8d7eb649076fbf5778851a69b060f94f7962809e2348b5302e77255e6d5fba1d587ab663a7c6c69dfa

data/README.md

@@ -1,6 +1,8 @@
-# Contracthashtool
+# contracthashtool-ruby
 
-Ruby port of https://github.com/Blockstream/contracthashtool
+Ruby port of: https://github.com/Blockstream/contracthashtool
+
+See also Appendix A of: https://blockstream.com/sidechains.pdf
 
 ## Installation
 
@@ -26,22 +28,52 @@ require 'bitcoin'
 
 Bitcoin.network = :testnet3
 
-r = '5121038695b28f1649c711aedb1fec8df54874334cfb7ddf31ba3132a94d00bdc9715251ae'
-p = 'cMcpaCT6pHkyS4347i4rSmecaQtLiu1eH28NWmBiePn8bi6N4kzh'
-a = 'mqWkEAFeQdrQvyaWNRn5vijPJeiQAjtxL2'
-n = '3a11be476485a6273fad4a0e09117d42'
+# Example parameters from the original tool's usage().
+
+redeem_script_template = '5121038695b28f1649c711aedb1fec8df54874334cfb7ddf31ba3132a94d00bdc9715251ae'
+payee_address = 'mqWkEAFeQdrQvyaWNRn5vijPJeiQAjtxL2'
+nonce_hex = '3a11be476485a6273fad4a0e09117d42'
+private_key_wif = 'cMcpaCT6pHkyS4347i4rSmecaQtLiu1eH28NWmBiePn8bi6N4kzh'
+
+# Someone wanting to send funds to the sidechain would call this
+# to calculate a P2SH address to send to. They would then send the
+# MDFs (mutually distrusting functionaries) the target address
+# and nonce so they are able to locate the subsequent transaction.
+# The caller would then send the desired amount of coin to the P2SH
+# address to initiate the peg protocol.
+
+nonce, redeem_script, p2sh_address =
+  Contracthashtool.generate(redeem_script_template, payee_address, nonce_hex)
+
+puts "nonce: #{nonce}"
+puts "P2SH address: #{p2sh_address}"
+puts "new redeem script: #{redeem_script}"
+
+# Each MDF would call this to derive a private key to redeem the
+# cross-chain seed transaction after the confirmation period lapses.
+# They would then presumably create and sign a transaction on the
+# sidechain paying the desired amount of sidecoin to the target address.
+# And then we've succeeded in executing one direction of a federated peg.
+# Rinse, wash, and repeat to go back.
+
+key = Contracthashtool.claim(private_key_wif, payee_address, nonce)
+puts "new privkey: #{key.to_base58}"
 
-nonce, p2sh_address = Contracthashtool.generate(r,a,n)
-puts "nonce: #{nonce}, address: #{p2sh_address}"
+# Verify homomorphic derivation was successful.
 
-key = Contracthashtool.claim(p,a,n)
-puts "new privkey: #{key.to_base58}
+signature = key.sign_message("derp")
+script = Bitcoin::Script.new([redeem_script].pack("H*"))
+pubkey = Bitcoin::Key.new(nil, script.get_multisig_pubkeys.first.unpack("H*").first)
+raise "nope" unless pubkey.verify_message(signature, "derp")
 ```
 
-## Contributing
+<pre>
+<code>
+$ bundle exec ruby test.rb
+nonce: 3a11be476485a6273fad4a0e09117d42
+P2SH address: 2MvGPFfDXbJZyH79u187VNZbuCgyRBhcdsw
+new redeem script: 512102944aba05d40d8df1724f8ab2f5f3a58d052d26aedc93e175534cb782becc8ff751ae
+new privkey: cSBD8yM62R82RfbugiGK8Lui9gdMB81NtZBckxe5YxRsDSKySwHK
+</code>
+</pre>
 
-1. Fork it ( https://github.com/[my-github-username]/contracthashtool/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/contracthashtool.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["andy.alness@gmail.com"]
   spec.summary       = %q{Ruby port of contracthashtool}
   spec.description   = %q{Ruby port of Blockstream's contracthashtool for federated peg support}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/aalness/contracthashtool-ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 
-  spec.add_dependency "bitcoin-ruby"
-  spec.add_dependency "ffi"
+  spec.add_dependency "bitcoin-ruby", "~> 0.0", ">= 0.0.6"
+  spec.add_dependency "ffi", "~> 1.9"
 end

data/lib/contracthashtool.rb

@@ -6,13 +6,13 @@ require "ffi"
 module Contracthashtool
 
   # generate a contract address
-  def self.generate(redeem_script_hex, payee_address, nonce_hex=nil)
+  def self.generate(redeem_script_hex, payee_address_or_ascii, nonce_hex=nil)
     redeem_script = Bitcoin::Script.new([redeem_script_hex].pack("H*"))
     raise "only multisig redeem scripts are currently supported" unless redeem_script.is_multisig?
-    nonce_hex, data = compute_data(payee_address, nonce_hex)
+    nonce_hex, data = compute_data(payee_address_or_ascii, nonce_hex)
 
     derived_keys = []
-    group = OpenSSL::PKey::EC::Group.new('secp256k1')
+    group = OpenSSL::PKey::EC::Group.new("secp256k1")
     redeem_script.get_multisig_pubkeys.each do |pubkey|
       tweak = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("SHA256"), pubkey, data).to_i(16)
       raise "order exceeded, pick a new nonce" if tweak >= group.order
@@ -26,19 +26,19 @@ module Contracthashtool
     end
 
     m = redeem_script.get_signatures_required
-    p2sh_script = Bitcoin::Script.to_p2sh_multisig_script(m, *derived_keys)[0]
+    p2sh_script, redeem_script = Bitcoin::Script.to_p2sh_multisig_script(m, *derived_keys)
 
-    [ nonce_hex, Bitcoin::Script.new(p2sh_script).get_p2sh_address ]
+    [ nonce_hex, redeem_script.unpack("H*")[0], Bitcoin::Script.new(p2sh_script).get_p2sh_address ]
   end
 
   # claim a contract
-  def self.claim(private_key_wif, payee_address, nonce_hex)
+  def self.claim(private_key_wif, payee_address_or_ascii, nonce_hex)
     key = Bitcoin::Key.from_base58(private_key_wif)
-    data = compute_data(payee_address, nonce_hex)[1]
+    data = compute_data(payee_address_or_ascii, nonce_hex)[1]
 
     pubkey = [key.pub].pack("H*")
     tweak = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("SHA256"), pubkey, data).to_i(16)
-    group = OpenSSL::PKey::EC::Group.new('secp256k1')
+    group = OpenSSL::PKey::EC::Group.new("secp256k1")
     raise "order exceeded, verify parameters" if tweak >= group.order
 
     derived_key = (tweak + key.priv.to_i(16)) % group.order
@@ -46,25 +46,30 @@ module Contracthashtool
   end
 
   # compute HMAC data
-  def self.compute_data(address, nonce_hex)
+  def self.compute_data(address_or_ascii, nonce_hex)
     nonce = nonce_hex ? [nonce_hex].pack("H32") : SecureRandom.random_bytes(16)
-    hash160 = [Bitcoin.hash160_from_address(address)].pack("H*")
-    address_type = Bitcoin.address_type(address)
-    case address_type
-    when :hash160
-      address_type = "P2PH"
-    when :p2sh
-      address_type = "P2SH"
+    if Bitcoin.valid_address?(address_or_ascii)
+      address_type = Bitcoin.address_type(address_or_ascii)
+      case address_type
+      when :hash160
+        address_type = "P2PH"
+      when :p2sh
+        address_type = "P2SH"
+      else
+        raise "unsupported address type #{address_type}"
+      end
+      contract_bytes = [Bitcoin.hash160_from_address(address_or_ascii)].pack("H*")
     else
-      raise "unsuppoorted address type #{address_type}"
+      address_type = "TEXT"
+      contract_bytes = address_or_ascii
     end
-    [ nonce.unpack("H*")[0], address_type + nonce + hash160 ]
+    [ nonce.unpack("H*")[0], address_type + nonce + contract_bytes ]
   end
 
   # lifted from https://github.com/GemHQ/money-tree
   module EC_ADD
     extend ::FFI::Library
-    ffi_lib 'ssl'
+    ffi_lib "ssl"
 
     NID_secp256k1 = 714
     POINT_CONVERSION_COMPRESSED = 2

data/lib/contracthashtool/version.rb

@@ -1,3 +1,3 @@
 module Contracthashtool
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contracthashtool
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andy Alness
@@ -42,30 +42,36 @@ dependencies:
   name: bitcoin-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.9'
 description: Ruby port of Blockstream's contracthashtool for federated peg support
 email:
 - andy.alness@gmail.com
@@ -81,7 +87,7 @@ files:
 - contracthashtool.gemspec
 - lib/contracthashtool.rb
 - lib/contracthashtool/version.rb
-homepage: ''
+homepage: https://github.com/aalness/contracthashtool-ruby
 licenses:
 - MIT
 metadata: {}