bitcoin-p2p 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 912b3329e673276821ab88a78f8c2dadd75158325bcd70a9ffeddb4e1362a195
+  data.tar.gz: ac7bce6b03bfa60c58d99823f432a6d8c388b8ed3b9967728122e74c3eab0a89
+SHA512:
+  metadata.gz: dc99e62b73c210889a25557098c6d4fa60c48c6ec6e31a5c57c8e1076364c84b31db3046e640cc7525b1840297941386ba18e061d8a2aecba978834f81e294bc
+  data.tar.gz: 63302fdb95e862c891c3b130e2f7bfde424acd55c42d8d472b6ad6c6e924bd5e8305555a27c6c5e5ce59e80d1d2b041bbe11cc95a706b79df5b041db4a920cdf

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+bitcon-p2p

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at azuchi@chaintope.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bitcoin-p2p.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 azuchi
+
+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

@@ -0,0 +1,57 @@
+# Bitcoin P2P message REPL tool
+
+`bitcoin-p2p` is an irb-based tool for interactively exchanging P2P messages with Bitcoin nodes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitcoin-p2p'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bitcoin-p2p
+
+## Usage
+
+Start `bitcoin-p2p` by specifying the address and network of the node to connect to.
+
+    $ bitcoin-p2p -h localhost -n signet
+    > connected! You can send version message.
+
+Once connected, you can use the [bitcoinrb message class](https://github.com/chaintope/bitcoinrb/wiki/P2P-Message) 
+to construct a P2P message and use the `send_message` method to send that message to the other party.
+For example, the handshake can be done as follows:
+
+    > ver = Bitcoin::Message::Vresion.new
+    => #<Bitcoin::Message::Version:0x00005590317410f0 @version=70013, @services=8, @timestamp=1611462693, @local_addr=#<Bitcoin::Message::NetworkAddr:0x0000559031738ae0 @time=1611462693, @ip_addr=#<IPAddr: IPv4:127.0.0.1/255.255.255.255>, @port=3...
+    > send_message(ver)
+    => send message data: 0a03cf4076657273696f6e00000000006700000093cb71427d110100080000000000000025f80c6000000000080000000000000000000000000000000000ffff7f00000195bd080000000000000000000000000000000000ffff7f00000195bd519f0f6807576b1c112f626974636f696e72623a302e362e302f0000000000
+    ...
+    =>  receive version. payload: {"version"=>70016, "services"=>1097, "timestamp"=>1611462696, "local_addr"=>{"time"=>nil, "ip_addr"=>#<IPAddr: IPv6:0000:0000:0000:0000:0000:0000:0000:0000/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>, "port"=>0, "services"=>0}, "remote_addr"=>{"time"=>nil, "ip_addr"=>#<IPAddr: IPv6:0000:0000:0000:0000:0000:0000:0000:0000/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>, "port"=>0, "services"=>1033}, "nonce"=>5555482496462444166, "user_agent"=>"/Satoshi:0.21.0/", "start_height"=>21843, "relay"=>true}
+    > ack Bitcoin::Message::VerAck.new
+    => #<Bitcoin::Message::VerAck:0x00005590316342c0> 
+    > send_message(ack)
+    => send message data: 0a03cf4076657261636b000000000000000000005df6e0e2
+
+Note, You will be able to send other messages, but if the message you send does not comply with the specifications or 
+violates the policy of the other party, you will be disconnected. 
+In this case, a message will be displayed on the console saying `=> connection is closed. Please stop.`, so end with `stop`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bitcoin-p2p. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/bitcoin-p2p/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bitcoin::P2p project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bitcoin-p2p/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/bitcoin-p2p

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require 'bitcoin'
+require 'bitcoin/p2p'
+require 'optparse'
+require 'irb'
+
+# Parse command line params.
+cli = Bitcoin::P2P::Option.new
+cli.parse
+
+# Initialize network parameter.
+Bitcoin.chain_params = cli.network
+port = Bitcoin.chain_params.default_port
+
+def send_message(message)
+  msg = message.is_a?(Bitcoin::Message::Base) ? message.to_pkt : message.htb
+  puts " => send message data: #{msg.bth}"
+  @conn.send_data(msg)
+end
+
+def stop
+  @node.exit
+  @console.exit
+end
+
+@console = Thread.new do
+  IRB.start
+end
+
+@node = Thread.new do
+  EM.run do
+    @conn = EM.connect(cli.host, port, Bitcoin::P2P::Handler)
+  end
+end
+
+@node.join
+@console.join

data/bitcoin-p2p.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/bitcoin/p2p/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bitcoin-p2p"
+  spec.version       = Bitcoin::P2P::VERSION
+  spec.authors       = ["azuchi"]
+  spec.email         = ["azuchi@chaintope.com"]
+
+  spec.summary       = %q{Bitcoin p2p message repl tool.}
+  spec.description   = %q{Bitcoin p2p message repl tool.}
+  spec.homepage      = "https://github.com/azuchi/bitcoin-p2p"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage 
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'bitcoinrb'
+end

data/lib/bitcoin/p2p.rb

@@ -0,0 +1,11 @@
+require "bitcoin/p2p/version"
+
+module Bitcoin
+  module P2P
+    class Error < StandardError; end
+
+    autoload :Handler, 'bitcoin/p2p/handler'
+    autoload :Option, 'bitcoin/p2p/option'
+
+  end
+end

data/lib/bitcoin/p2p/handler.rb

@@ -0,0 +1,97 @@
+module Bitcoin
+  module P2P
+
+    module Handler
+
+      def post_init
+        puts "> connected! You can send version message."
+      end
+
+      def receive_data(data)
+        begin
+          parse(data)
+        rescue Bitcoin::Message::Error => e
+          puts "invalid header magic. #{e.message}"
+        end
+      end
+
+      def parse(message)
+        @message ||= ''
+        @message += message
+        command, payload, rest = parse_header
+        return unless command
+        msg = decode_msg(command, payload)
+        puts
+        puts " => receive #{command}. #{msg.to_h}"
+        @message = ""
+        parse(rest) if rest && rest.bytesize > 0
+      end
+
+      def parse_header
+        head_magic = Bitcoin.chain_params.magic_head
+        return if @message.nil? || @message.size < Bitcoin::MESSAGE_HEADER_SIZE
+
+        magic, command, length, checksum = @message.unpack('a4A12Va4')
+        raise Bitcoin::Message::Error, "invalid header magic. #{magic.bth}" unless magic.bth == head_magic
+
+        payload = @message[Bitcoin::MESSAGE_HEADER_SIZE...(Bitcoin::MESSAGE_HEADER_SIZE + length)]
+        return if payload.size < length
+        raise Bitcoin::Message::Error, "header checksum mismatch. #{checksum.bth}" unless Bitcoin.double_sha256(payload)[0...4] == checksum
+
+        rest = @message[(Bitcoin::MESSAGE_HEADER_SIZE + length)..-1]
+        [command, payload, rest]
+      end
+
+      def decode_msg(command, payload = nil)
+        case command
+        when Bitcoin::Message::Version::COMMAND
+          Bitcoin::Message::Version.parse_from_payload(payload)
+        when Bitcoin::Message::VerAck::COMMAND
+          Bitcoin::Message::VerAck.new
+        when Bitcoin::Message::GetAddr::COMMAND
+          Bitcoin::Message::GetAddr.new
+        when Bitcoin::Message::Addr::COMMAND
+          Bitcoin::Message::Addr.parse_from_payload(payload)
+        when Bitcoin::Message::SendHeaders::COMMAND
+          Bitcoin::Message::SendHeaders.new
+        when Bitcoin::Message::FeeFilter::COMMAND
+          Bitcoin::Message::FeeFilter.parse_from_payload(payload)
+        when Bitcoin::Message::Ping::COMMAND
+          Bitcoin::Message::Ping.parse_from_payload(payload)
+        when Bitcoin::Message::Pong::COMMAND
+          Bitcoin::Message::Pong.parse_from_payload(payload)
+        when Bitcoin::Message::GetHeaders::COMMAND
+          Bitcoin::Message::GetHeaders.parse_from_payload(payload)
+        when Bitcoin::Message::Headers::COMMAND
+          Bitcoin::Message::Headers.parse_from_payload(payload)
+        when Bitcoin::Message::Block::COMMAND
+          Bitcoin::Message::Block.parse_from_payload(payload)
+        when Bitcoin::Message::Tx::COMMAND
+          Bitcoin::Message::Tx.parse_from_payload(payload)
+        when Bitcoin::Message::NotFound::COMMAND
+          Bitcoin::Message::NotFound.parse_from_payload(payload)
+        when Bitcoin::Message::MemPool::COMMAND
+          Bitcoin::Message::MemPool.new
+        when Bitcoin::Message::Reject::COMMAND
+          Bitcoin::Message::Reject.parse_from_payload(payload)
+        when Bitcoin::Message::SendCmpct::COMMAND
+          Bitcoin::Message::SendCmpct.parse_from_payload(payload)
+        when Bitcoin::Message::Inv::COMMAND
+          Bitcoin::Message::Inv.parse_from_payload(payload)
+        when Bitcoin::Message::MerkleBlock::COMMAND
+          Bitcoin::Message::MerkleBlock.parse_from_payload(payload)
+        when Bitcoin::Message::CmpctBlock::COMMAND
+          Bitcoin::Message::CmpctBlock.parse_from_payload(payload)
+        when Bitcoin::Message::GetData::COMMAND
+          Bitcoin::Message::GetData.parse_from_payload(payload)
+        end
+      end
+
+      def unbind
+        puts "\n => connection is closed. please stop."
+      end
+
+    end
+
+  end
+end

data/lib/bitcoin/p2p/option.rb

@@ -0,0 +1,43 @@
+module Bitcoin
+  module P2P
+
+    class Option
+
+      attr_accessor :host
+      attr_accessor :network
+
+      def parse
+        op = OptionParser.new do |opts|
+          opts.banner = "Usage: bitcoin-p2p -h <host> -n <network>"
+
+          opts.on("-h host", "--host host", "IP address of the connection destination.") do |v|
+            self.host = v
+          end
+
+          opts.on("-n network", "--network network", "Network to connect to.(mainnet or testnet or signet)") do |v|
+            self.network = v.to_sym
+          end
+
+          [host, network]
+        end
+
+        begin
+          puts op.parse(ARGV)
+          unless host
+            puts "Specify the host to connect to via -h option."
+            exit(1)
+          end
+          unless %w(mainnet testnet signet).include?(network.to_s)
+            puts "The network option must be either mainnet, testnet, or signet."
+            exit(1)
+          end
+        rescue OptionParser::InvalidOption => e
+          puts e.message
+        end
+
+        4.times {ARGV.shift}
+      end
+
+    end
+  end
+end

data/lib/bitcoin/p2p/version.rb

@@ -0,0 +1,5 @@
+module Bitcoin
+  module P2P
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: bitcoin-p2p
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- azuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitcoinrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Bitcoin p2p message repl tool.
+email:
+- azuchi@chaintope.com
+executables:
+- bitcoin-p2p
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bitcoin-p2p
+- bitcoin-p2p.gemspec
+- lib/bitcoin/p2p.rb
+- lib/bitcoin/p2p/handler.rb
+- lib/bitcoin/p2p/option.rb
+- lib/bitcoin/p2p/version.rb
+homepage: https://github.com/azuchi/bitcoin-p2p
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/azuchi/bitcoin-p2p
+  source_code_uri: https://github.com/azuchi/bitcoin-p2p
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Bitcoin p2p message repl tool.
+test_files: []