Class: Bitcoin::Message::HeaderAndShortIDs

Inherits:
Object
  • Object
show all
Defined in:
lib/bitcoin/message/header_and_short_ids.rb

Overview

BIP-152 Compact Block’s data format. github.com/bitcoin/bips/blob/master/bip-0152.mediawiki#HeaderAndShortIDs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(header, nonce, short_ids = [], prefilled_txn = []) ⇒ HeaderAndShortIDs

Returns a new instance of HeaderAndShortIDs.



14
15
16
17
18
19
20
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 14

def initialize(header, nonce, short_ids = [], prefilled_txn = [])
  @header = header
  @nonce = nonce
  @short_ids = short_ids
  @prefilled_txn = prefilled_txn
  @siphash_key = Bitcoin.sha256(header.to_payload << [nonce].pack('q*'))[0...16]
end

Instance Attribute Details

#header ⇒ Object

Returns the value of attribute header.



8
9
10
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 8

def header
  @header
end

#nonce ⇒ Object

Returns the value of attribute nonce.



9
10
11
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 9

def nonce
  @nonce
end

#prefilled_txn ⇒ Object

Returns the value of attribute prefilled_txn.



11
12
13
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 11

def prefilled_txn
  @prefilled_txn
end

#short_ids ⇒ Object

Returns the value of attribute short_ids.



10
11
12
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 10

def short_ids
  @short_ids
end

#siphash_key ⇒ Object

Returns the value of attribute siphash_key.



12
13
14
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 12

def siphash_key
  @siphash_key
end

Class Method Details

.parse_from_payload(payload) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 22

def self.parse_from_payload(payload)
  buf = StringIO.new(payload)
  header = Bitcoin::BlockHeader.parse_from_payload(buf.read(80))
  nonce = buf.read(8).unpack1('q*')
  short_ids_len = Bitcoin.unpack_var_int_from_io(buf)
  short_ids = short_ids_len.times.map do
     buf.read(6).reverse.bth.to_i(16)
  end
  prefilled_txn_len = Bitcoin.unpack_var_int_from_io(buf)
  prefilled_txn = prefilled_txn_len.times.map do
    PrefilledTx.parse_from_io(buf)
  end
  self.new(header, nonce, short_ids, prefilled_txn)
end

Instance Method Details

#short_id(txid) ⇒ Integer

calculate short transaction id which specified by BIP-152.

Parameters:

  • txid (String) —

    a transaction id

Returns:

  • (Integer) —

    6 bytes short transaction id.



50
51
52
53
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 50

def short_id(txid)
  hash = SipHash.digest(siphash_key, txid.htb.reverse).to_even_length_hex
  [hash].pack('H*')[2...8].bth.to_i(16)
end

#to_payload ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/bitcoin/message/header_and_short_ids.rb', line 37

def to_payload
  p = header.to_payload
  p << [nonce].pack('q*')
  p << Bitcoin.pack_var_int(short_ids.size)
  p << short_ids.map{|id|sprintf('%12x', id).htb.reverse}.join
  p << Bitcoin.pack_var_int(prefilled_txn.size)
  p << prefilled_txn.map(&:to_payload).join
  p
end