Class: Bitcoin::Script

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

Defined Under Namespace

Classes: ScriptOpcodeError

Constant Summary collapse

OP_0 =
0
OP_FALSE =
0
OP_1 =
81
OP_TRUE =
81
OP_2 =
0x52
OP_3 =
0x53
OP_4 =
0x54
OP_5 =
0x55
OP_6 =
0x56
OP_7 =
0x57
OP_8 =
0x58
OP_9 =
0x59
OP_10 =
0x5a
OP_11 =
0x5b
OP_12 =
0x5c
OP_13 =
0x5d
OP_14 =
0x5e
OP_15 =
0x5f
OP_16 =
0x60
OP_PUSHDATA0 =
0
OP_PUSHDATA1 =
76
OP_PUSHDATA2 =
77
OP_PUSHDATA4 =
78
OP_PUSHDATA_INVALID =

0xEE

238
OP_NOP =
97
OP_DUP =
118
OP_HASH160 =
169
OP_EQUAL =
135
OP_VERIFY =
105
OP_EQUALVERIFY =
136
OP_CHECKSIG =
172
OP_CHECKSIGVERIFY =
173
OP_CHECKMULTISIG =
174
OP_CHECKMULTISIGVERIFY =
175
OP_TOALTSTACK =
107
OP_FROMALTSTACK =
108
OP_TUCK =
125
OP_SWAP =
124
OP_BOOLAND =
154
OP_ADD =
147
OP_SUB =
148
OP_GREATERTHANOREQUAL =
162
OP_DROP =
117
OP_HASH256 =
170
OP_SHA256 =
168
OP_SHA1 =
167
OP_RIPEMD160 =
166
OP_NOP1 =
176
OP_NOP2 =
177
OP_NOP3 =
178
OP_NOP4 =
179
OP_NOP5 =
180
OP_NOP6 =
181
OP_NOP7 =
182
OP_NOP8 =
183
OP_NOP9 =
184
OP_NOP10 =
185
OP_CODESEPARATOR =
171
OP_MIN =
163
OP_MAX =
164
OP_2OVER =
112
OP_2ROT =
113
OP_2SWAP =
114
OP_IFDUP =
115
OP_DEPTH =
116
OP_1NEGATE =
79
OP_WITHIN =
165
OP_NUMEQUAL =
156
OP_NUMEQUALVERIFY =
157
OP_LESSTHAN =
159
OP_LESSTHANOREQUAL =
161
OP_GREATERTHAN =
160
OP_NOT =
145
OP_0NOTEQUAL =
146
OP_ABS =
144
OP_1ADD =
139
OP_1SUB =
140
OP_NEGATE =
143
OP_BOOLOR =
155
OP_NUMNOTEQUAL =
158
OP_RETURN =
106
OP_OVER =
120
OP_IF =
99
OP_NOTIF =
100
OP_ELSE =
103
OP_ENDIF =
104
OP_PICK =
121
OP_SIZE =
130
OP_VER =
98
OP_ROLL =
122
OP_ROT =
123
OP_2DROP =
109
OP_2DUP =
110
OP_3DUP =
111
OP_NIP =
119
OP_CAT =
126
OP_SUBSTR =
127
OP_LEFT =
128
OP_RIGHT =
129
OP_INVERT =
131
OP_AND =
132
OP_OR =
133
OP_XOR =
134
OP_2MUL =
141
OP_2DIV =
142
OP_MUL =
149
OP_DIV =
150
OP_MOD =
151
OP_LSHIFT =
152
OP_RSHIFT =
153
OP_INVALIDOPCODE =
0xff
OPCODES =
Hash[*constants.grep(/^OP_/).map{|i| [const_get(i), i.to_s]
OPCODES_ALIAS =
{
  "OP_TRUE"  => OP_1,
  "OP_FALSE" => OP_0,
  "OP_EVAL" => OP_NOP1,
  "OP_CHECKHASHVERIFY" => OP_NOP2,
}
DISABLED_OPCODES =
[
  OP_CAT, OP_SUBSTR, OP_LEFT, OP_RIGHT, OP_INVERT,
  OP_AND, OP_OR, OP_XOR, OP_2MUL, OP_2DIV, OP_MUL,
  OP_DIV, OP_MOD, OP_LSHIFT, OP_RSHIFT
]
OP_2_16 =
(82..96).to_a
OPCODES_PARSE_BINARY =
{}
OPCODES_PARSE_STRING =
{}
SIGHASH_TYPE =
{ all: 1, none: 2, single: 3, anyonecanpay: 128 }
OPCODES_METHOD =

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(input_script, previous_output_script = nil) ⇒ Script

create a new script. bytes is typically input_script + output_script



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/bitcoin/script.rb', line 158

def initialize(input_script, previous_output_script=nil)
  @raw_byte_sizes = [input_script.bytesize, previous_output_script ? previous_output_script.bytesize : 0]

  @raw = if previous_output_script
           input_script + [ Bitcoin::Script::OP_CODESEPARATOR ].pack("C") + previous_output_script
         else
           input_script
         end

  @chunks = parse(input_script)

  if previous_output_script
    @script_codeseparator_index = @chunks.size
    @chunks << Bitcoin::Script::OP_CODESEPARATOR
    @chunks += parse(previous_output_script)
  end

  @stack, @stack_alt, @exec_stack = [], [], []
  @last_codeseparator_index = 0
  @do_exec = true
end

Instance Attribute Details

#chunksObject (readonly)

Returns the value of attribute chunks.



155
156
157
# File 'lib/bitcoin/script.rb', line 155

def chunks
  @chunks
end

#debugObject (readonly)

Returns the value of attribute debug.



155
156
157
# File 'lib/bitcoin/script.rb', line 155

def debug
  @debug
end

#rawObject (readonly)

Returns the value of attribute raw.



155
156
157
# File 'lib/bitcoin/script.rb', line 155

def raw
  @raw
end

Class Method Details

.add_sig_to_multisig_script_sig(sig, script_sig) ⇒ Object

take a multisig script sig (or p2sh multisig script sig) and add another signature to it after the OP_0. Used to sign a tx by multiple parties. Signatures must be in the same order as the pubkeys in the output script being redeemed.



716
717
718
719
720
# File 'lib/bitcoin/script.rb', line 716

def self.add_sig_to_multisig_script_sig(sig, script_sig)
  signature = sig + [SIGHASH_TYPE[:all]].pack("C*")
  offset = script_sig.empty? ? 0 : 1
  script_sig.insert(offset, pack_pushdata(signature))
end

.binary_from_string(script_string) ⇒ Object

raw script binary of a string representation



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/bitcoin/script.rb', line 364

def self.binary_from_string(script_string)
  buf = ""
  script_string.split(" ").each{|i|
    i = if opcode = OPCODES_PARSE_STRING[i]
      opcode
    else
      case i
      when /OP_PUSHDATA/             # skip
      when /OP_(.+)$/;               raise ScriptOpcodeError, "#{i} not defined!"
      when /\(opcode\-(\d+)\)/;      $1.to_i
      when "(opcode";                # skip  # fix invalid opcode parsing
      when /^(\d+)\)/;               $1.to_i # fix invalid opcode parsing
      when /(\d+):(\d+):(.+)?/
        pushdata, len, data = $1.to_i, $2.to_i, $3
        pack_pushdata_align(pushdata, len, [data].pack("H*"))
      else
        data = [i].pack("H*")
        pack_pushdata(data)
      end
    end

    buf << if i.is_a?(Fixnum)
             i < 256 ? [i].pack("C") : [OpenSSL::BN.new(i.to_s,10).to_hex].pack("H*")
           else
             i
           end if i
  }
  buf
end

.decode_OP_N(opcode) ⇒ Object

Converts OP_0,1,2,…,16 into 0, 1, 2, …, 16. Returns nil for other opcodes.



786
787
788
789
790
791
792
793
794
795
# File 'lib/bitcoin/script.rb', line 786

def self.decode_OP_N(opcode)
  if opcode == OP_0
    return 0
  end
  if opcode.is_a?(Fixnum) && opcode >= OP_1 && opcode <= OP_16
    return opcode - (OP_1 - 1);
  else
    nil
  end
end

.drop_signatures(script_pubkey, drop_signatures) ⇒ Object



468
469
470
471
# File 'lib/bitcoin/script.rb', line 468

def self.drop_signatures(script_pubkey, drop_signatures)
  script = new(script_pubkey).to_string.split(" ").delete_if{|c| drop_signatures.include?(c) }.join(" ")
  script_pubkey = binary_from_string(script)
end

.from_string(script_string) ⇒ Object

script object of a string representation



357
358
359
# File 'lib/bitcoin/script.rb', line 357

def self.from_string(script_string)
  new(binary_from_string(script_string))
end

.is_canonical_pubkey?(pubkey) ⇒ Boolean

Returns:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'lib/bitcoin/script.rb', line 1349

def self.is_canonical_pubkey?(pubkey)
  return false if pubkey.bytesize < 33 # "Non-canonical public key: too short"
  case pubkey[0]
  when "\x04"
    return false if pubkey.bytesize != 65 # "Non-canonical public key: invalid length for uncompressed key"
  when "\x02", "\x03"
    return false if pubkey.bytesize != 33 # "Non-canonical public key: invalid length for compressed key"
  else
    return false # "Non-canonical public key: compressed nor uncompressed"
  end
  true
end

.is_canonical_signature?(sig) ⇒ Boolean

Returns:



1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
# File 'lib/bitcoin/script.rb', line 1364

def self.is_canonical_signature?(sig)
  return false if sig.bytesize < 9 # Non-canonical signature: too short
  return false if sig.bytesize > 73 # Non-canonical signature: too long

  s = sig.unpack("C*")

  hash_type = s[-1] & (~(SIGHASH_TYPE[:anyonecanpay]))
  return false if hash_type < SIGHASH_TYPE[:all]   ||  hash_type > SIGHASH_TYPE[:single] # Non-canonical signature: unknown hashtype byte

  return false if s[0] != 0x30 # Non-canonical signature: wrong type
  return false if s[1] != s.size-3 # Non-canonical signature: wrong length marker

  # TODO: add/port rest from bitcoind

  true
end

.pack_pushdata(data) ⇒ Object



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/bitcoin/script.rb', line 320

def self.pack_pushdata(data)
  size = data.bytesize

  if data.bitcoin_pushdata
    size = data.bitcoin_pushdata_length
    pack_pushdata_align(data.bitcoin_pushdata, size, data)
  else
    head = if size < OP_PUSHDATA1
             [size].pack("C")
           elsif size <= 0xff
             [OP_PUSHDATA1, size].pack("CC")
           elsif size <= 0xffff
             [OP_PUSHDATA2, size].pack("Cv")
           #elsif size <= 0xffffffff
           else
             [OP_PUSHDATA4, size].pack("CV")
           end
    head + data
  end
end

.pack_pushdata_align(pushdata, len, data) ⇒ Object



341
342
343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/bitcoin/script.rb', line 341

def self.pack_pushdata_align(pushdata, len, data)
  case pushdata
  when OP_PUSHDATA1
    [OP_PUSHDATA1, len].pack("CC") + data
  when OP_PUSHDATA2
    [OP_PUSHDATA2, len].pack("Cv") + data
  when OP_PUSHDATA4
    [OP_PUSHDATA4, len].pack("CV") + data
  when OP_PUSHDATA_INVALID
    data
  else # OP_PUSHDATA0
    [len].pack("C") + data
  end
end

.to_address_script(address) ⇒ Object

generate hash160 or p2sh output script, depending on the type of the given address. see #to_hash160_script and #to_p2sh_script.



641
642
643
644
645
646
647
# File 'lib/bitcoin/script.rb', line 641

def self.to_address_script(address)
  hash160 = Bitcoin.hash160_from_address(address)
  case Bitcoin.address_type(address)
  when :hash160; to_hash160_script(hash160)
  when :p2sh;    to_p2sh_script(hash160)
  end
end

.to_hash160_script(hash160) ⇒ Object

generate hash160 tx for given address. returns a raw binary script of the form:

OP_DUP OP_HASH160 <hash160> OP_EQUALVERIFY OP_CHECKSIG


625
626
627
628
629
# File 'lib/bitcoin/script.rb', line 625

def self.to_hash160_script(hash160)
  return nil  unless hash160
  #  DUP   HASH160  length  hash160    EQUALVERIFY  CHECKSIG
  [ ["76", "a9",    "14",   hash160,   "88",        "ac"].join ].pack("H*")
end

.to_multisig_script(m, *pubkeys) ⇒ Object

generate multisig output script for given pubkeys, expecting m signatures. returns a raw binary script of the form:

<m> <pubkey> [<pubkey> ...] <n_pubkeys> OP_CHECKMULTISIG


652
653
654
655
656
657
658
659
660
661
# File 'lib/bitcoin/script.rb', line 652

def self.to_multisig_script(m, *pubkeys)
  raise "invalid m-of-n number" unless [m, pubkeys.size].all?{|i| (0..20).include?(i) }
  raise "invalid m-of-n number" if pubkeys.size < m
  pubs = pubkeys.map{|pk| pack_pushdata([pk].pack("H*")) }

  m = m > 16 ?              pack_pushdata([m].pack("C"))              : [80 + m.to_i].pack("C")
  n = pubkeys.size > 16 ?   pack_pushdata([pubkeys.size].pack("C"))   : [80 + pubs.size].pack("C")

  [ m, *pubs, n, [OP_CHECKMULTISIG].pack("C")].join
end

.to_multisig_script_sig(*sigs) ⇒ Object

generate input script sig spending a multisig output script. returns a raw binary script sig of the form:

OP_0 <sig> [<sig> ...]


706
707
708
709
710
# File 'lib/bitcoin/script.rb', line 706

def self.to_multisig_script_sig(*sigs)
  partial_script = [OP_0].pack("C*")
  sigs.reverse_each{ |sig| partial_script = add_sig_to_multisig_script_sig(sig, partial_script) }
  partial_script
end

.to_op_return_script(data = nil) ⇒ Object

generate OP_RETURN output script with given data. returns a raw binary script of the form:

OP_RETURN <data>


665
666
667
668
669
# File 'lib/bitcoin/script.rb', line 665

def self.to_op_return_script(data = nil)
  buf = [ OP_RETURN ].pack("C")
  return buf unless data
  return buf + pack_pushdata( [data].pack("H*") )
end

.to_p2sh_multisig_script(*args) ⇒ Object

generate p2sh multisig output script for given args. returns the p2sh output script, and the redeem script needed to spend it. see #to_multisig_script for the redeem script, and #to_p2sh_script for the p2sh script.



692
693
694
695
696
# File 'lib/bitcoin/script.rb', line 692

def self.to_p2sh_multisig_script(*args)
  redeem_script = to_multisig_script(*args)
  p2sh_script = to_p2sh_script(Bitcoin.hash160(redeem_script.hth))
  return p2sh_script, redeem_script
end

.to_p2sh_multisig_script_sig(redeem_script, *sigs) ⇒ Object

generate input script sig spending a p2sh-multisig output script. returns a raw binary script sig of the form:

OP_0 <sig> [<sig> ...] <redeem_script>


725
726
727
# File 'lib/bitcoin/script.rb', line 725

def self.to_p2sh_multisig_script_sig(redeem_script, *sigs)
  to_multisig_script_sig(*sigs.flatten) + pack_pushdata(redeem_script)
end

.to_p2sh_script(p2sh) ⇒ Object

generate p2sh output script for given p2sh hash160. returns a raw binary script of the form:

OP_HASH160 <p2sh> OP_EQUAL


633
634
635
636
637
# File 'lib/bitcoin/script.rb', line 633

def self.to_p2sh_script(p2sh)
  return nil  unless p2sh
  # HASH160  length  hash  EQUAL
  [ ["a9",   "14",   p2sh, "87"].join ].pack("H*")
end

.to_pubkey_script(pubkey) ⇒ Object

generate pubkey tx script for given pubkey. returns a raw binary script of the form:

<pubkey> OP_CHECKSIG


619
620
621
# File 'lib/bitcoin/script.rb', line 619

def self.to_pubkey_script(pubkey)
  pack_pushdata([pubkey].pack("H*")) + [ OP_CHECKSIG ].pack("C")
end

.to_pubkey_script_sig(signature, pubkey) ⇒ Object

generate input script sig spending a pubkey output with given signature and pubkey. returns a raw binary script sig of the form:

<signature> [<pubkey>]


674
675
676
677
678
679
680
681
682
683
684
685
686
687
# File 'lib/bitcoin/script.rb', line 674

def self.to_pubkey_script_sig(signature, pubkey)
  hash_type = [ SIGHASH_TYPE[:all] ].pack("C")
  buf = pack_pushdata(signature + hash_type)
  return buf unless pubkey

  expected_size = case pubkey[0]
                  when "\x04"; 65
                  when "\x02", "\x03"; 33
                  end

  raise "pubkey is not in binary form" if !expected_size || pubkey.bytesize != expected_size

  return buf + pack_pushdata(pubkey)
end

.to_signature_pubkey_script(*a) ⇒ Object

alias for #to_pubkey_script_sig



699
700
701
# File 'lib/bitcoin/script.rb', line 699

def self.to_signature_pubkey_script(*a)
  to_pubkey_script_sig(*a)
end

Instance Method Details

#append_opcode(opcode) ⇒ Object

Adds opcode (OP_0, OP_1, … OP_CHECKSIG etc.) Returns self.



301
302
303
304
305
306
307
308
309
# File 'lib/bitcoin/script.rb', line 301

def append_opcode(opcode)
  raise "Opcode should be a Fixnum" if !opcode.is_a?(Fixnum)
  if opcode >= OP_0 && opcode <= 0xff
    @chunks << opcode
  else
    raise "Opcode should be within [0x00, 0xff]"
  end
  self
end

#append_pushdata(pushdata_string) ⇒ Object

Adds binary string as pushdata. Pushdata will be encoded in the most compact form (unless the string contains internal info about serialization that’s added by Script class) Returns self.



314
315
316
317
318
# File 'lib/bitcoin/script.rb', line 314

def append_pushdata(pushdata_string)
  raise "Pushdata should be a string" if !pushdata_string.is_a?(String)
  @chunks << pushdata_string
  self
end

#cast_to_bignum(buf) ⇒ Object



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
# File 'lib/bitcoin/script.rb', line 1182

def cast_to_bignum(buf)
  return (invalid; 0) unless buf
  case buf
  when Numeric
    invalid if OpenSSL::BN.new(buf.to_s).to_s(0).unpack("N")[0] > 4
    buf
  when String
    invalid if buf.bytesize > 4
    OpenSSL::BN.new([buf.bytesize].pack("N") + buf.reverse, 0).to_i
  else; raise TypeError, 'cast_to_bignum: failed to cast: %s (%s)' % [buf, buf.class]
  end
end

#cast_to_bool(buf) ⇒ Object



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
# File 'lib/bitcoin/script.rb', line 1204

def cast_to_bool(buf)
  buf = cast_to_string(buf).unpack("C*")
  size = buf.size
  buf.each.with_index{|byte,index|
    if byte != 0
      # Can be negative zero
      if (index == (size-1)) && byte == 0x80
        return false
      else
        return true
      end
    end
  }
  return false
end

#cast_to_string(buf) ⇒ Object



1195
1196
1197
1198
1199
1200
1201
1202
# File 'lib/bitcoin/script.rb', line 1195

def cast_to_string(buf)
  return (invalid; "") unless buf
  case buf
  when Numeric; OpenSSL::BN.new(buf.to_s).to_s(0)[4..-1].reverse
  when String; buf;
  else; raise TypeError, 'cast_to_string: failed to cast: %s (%s)' % [buf, buf.class]
  end
end

#codehash_script(opcode) ⇒ Object



1232
1233
1234
1235
1236
1237
# File 'lib/bitcoin/script.rb', line 1232

def codehash_script(opcode)
  # CScript scriptCode(pbegincodehash, pend);
  script    = to_string(@chunks[(@codehash_start||0)...@chunks.size-@chunks.reverse.index(opcode)])
  checkhash = Bitcoin.hash160(Bitcoin::Script.binary_from_string(script).unpack("H*")[0])
  [script, checkhash]
end

#get_addressObject

get single address, or first for multisig script



612
613
614
615
# File 'lib/bitcoin/script.rb', line 612

def get_address
  addrs = get_addresses
  addrs.is_a?(Array) ? addrs[0] : addrs
end

#get_addressesObject

get all addresses this script corresponds to (if possible)



603
604
605
606
607
608
609
# File 'lib/bitcoin/script.rb', line 603

def get_addresses
  return [get_pubkey_address]    if is_pubkey?
  return [get_hash160_address]   if is_hash160?
  return get_multisig_addresses  if is_multisig?
  return [get_p2sh_address]      if is_p2sh?
  []
end

#get_hash160Object

get the hash160 for this hash160 or pubkey script



566
567
568
569
570
# File 'lib/bitcoin/script.rb', line 566

def get_hash160
  return @chunks[2..-3][0].unpack("H*")[0]  if is_hash160?
  return @chunks[-2].unpack("H*")[0]        if is_p2sh?
  return Bitcoin.hash160(get_pubkey)        if is_pubkey?
end

#get_hash160_addressObject

get the hash160 address for this hash160 script



573
574
575
# File 'lib/bitcoin/script.rb', line 573

def get_hash160_address
  Bitcoin.hash160_to_address(get_hash160)
end

#get_multisig_addressesObject

get the pubkey addresses for this multisig script



583
584
585
586
587
588
589
590
# File 'lib/bitcoin/script.rb', line 583

def get_multisig_addresses
  get_multisig_pubkeys.map{|pub|
    begin
      Bitcoin::Key.new(nil, pub.unpack("H*")[0]).addr
    rescue OpenSSL::PKey::ECError, OpenSSL::PKey::EC::Point::Error
    end
  }.compact
end

#get_multisig_pubkeysObject

get the public keys for this multisig script



578
579
580
# File 'lib/bitcoin/script.rb', line 578

def get_multisig_pubkeys
  1.upto(@chunks[-2] - 80).map{|i| @chunks[i] }
end

#get_op_return_dataObject

get the data possibly included in an OP_RETURN script



597
598
599
600
# File 'lib/bitcoin/script.rb', line 597

def get_op_return_data
  return nil  unless is_op_return?
  cast_to_string(@chunks[1]).unpack("H*")[0]  if @chunks[1]
end

#get_p2sh_addressObject



592
593
594
# File 'lib/bitcoin/script.rb', line 592

def get_p2sh_address
  Bitcoin.hash160_to_p2sh_address(get_hash160)
end

#get_pubkeyObject

get the public key for this pubkey script



555
556
557
558
# File 'lib/bitcoin/script.rb', line 555

def get_pubkey
  return @chunks[0].unpack("H*")[0] if @chunks.size == 1
  is_pubkey? ? @chunks[0].unpack("H*")[0] : nil
end

#get_pubkey_addressObject

get the pubkey address for this pubkey script



561
562
563
# File 'lib/bitcoin/script.rb', line 561

def get_pubkey_address
  Bitcoin.pubkey_to_address(get_pubkey)
end

#get_signatures_requiredObject



729
730
731
732
# File 'lib/bitcoin/script.rb', line 729

def get_signatures_required
  return false unless is_multisig?
  @chunks[0] - 80
end

#inner_p2sh!(script = nil) ⇒ Object



490
# File 'lib/bitcoin/script.rb', line 490

def inner_p2sh!(script=nil); @inner_p2sh = true; @inner_script_code = script; self; end

#inner_p2sh?Boolean

Returns:



491
# File 'lib/bitcoin/script.rb', line 491

def inner_p2sh?; @inner_p2sh; end

#inner_p2sh_scriptObject

get the inner p2sh script



494
495
496
497
498
499
500
501
502
# File 'lib/bitcoin/script.rb', line 494

def inner_p2sh_script
  return nil if @chunks.size < 4
  *rest, script, _, script_hash, _ = @chunks
  script = rest.pop if script == OP_CODESEPARATOR
  script, script_hash = cast_to_string(script), cast_to_string(script_hash)

  return nil unless Bitcoin.hash160(script.unpack("H*")[0]) == script_hash.unpack("H*")[0]
  script
end

#invalidObject



464
465
466
# File 'lib/bitcoin/script.rb', line 464

def invalid
  @script_invalid = true; nil
end

#invalid?Boolean

Returns:



394
395
396
# File 'lib/bitcoin/script.rb', line 394

def invalid?
  @script_invalid ||= false
end

#is_hash160?Boolean

is this a hash160 (address) script

Returns:



525
526
527
528
529
530
# File 'lib/bitcoin/script.rb', line 525

def is_hash160?
  return false  if @chunks.size != 5
  (@chunks[0..1] + @chunks[-2..-1]) ==
    [OP_DUP, OP_HASH160, OP_EQUALVERIFY, OP_CHECKSIG] &&
    @chunks[2].is_a?(String) && @chunks[2].bytesize == 20
end

#is_multisig?Boolean

is this a multisig script

Returns:



533
534
535
536
# File 'lib/bitcoin/script.rb', line 533

def is_multisig?
  return false  if @chunks.size < 4 || !@chunks[-2].is_a?(Fixnum)
  @chunks[-1] == OP_CHECKMULTISIG and get_multisig_pubkeys.all?{|c| c.is_a?(String) }
end

#is_op_return?Boolean

is this an op_return script

Returns:



539
540
541
# File 'lib/bitcoin/script.rb', line 539

def is_op_return?
  @chunks[0] == OP_RETURN && @chunks.size <= 2
end

#is_pay_to_script_hash?Boolean Also known as: is_p2sh?

Returns:



504
505
506
507
508
509
# File 'lib/bitcoin/script.rb', line 504

def is_pay_to_script_hash?
  return false  if @inner_p2sh
  return false  unless @chunks[-2].is_a?(String)
  @chunks.size >= 3 && @chunks[-3] == OP_HASH160 &&
    @chunks[-2].bytesize == 20 && @chunks[-1] == OP_EQUAL
end

#is_pubkey?Boolean Also known as: is_send_to_ip?

is this a pubkey script

Returns:



518
519
520
521
# File 'lib/bitcoin/script.rb', line 518

def is_pubkey?
  return false if @chunks.size != 2
  (@chunks[1] == OP_CHECKSIG) && @chunks[0] && (@chunks[0].is_a?(String)) && @chunks[0] != OP_RETURN
end

#is_standard?Boolean

check if script is in one of the recognized standard formats

Returns:



513
514
515
# File 'lib/bitcoin/script.rb', line 513

def is_standard?
  is_pubkey? || is_hash160? || is_multisig? || is_p2sh?  || is_op_return?
end

#op_0Object

An empty array of bytes is pushed onto the stack.



993
994
995
# File 'lib/bitcoin/script.rb', line 993

def op_0
  @stack << "" # []
end

#op_0notequalObject



924
925
926
927
# File 'lib/bitcoin/script.rb', line 924

def op_0notequal
  a = pop_int
  @stack << (a != 0 ? 1 : 0)
end

#op_1Object

The number 1 is pushed onto the stack. Same as OP_TRUE



998
999
1000
# File 'lib/bitcoin/script.rb', line 998

def op_1
  @stack << 1
end

#op_1addObject

1 is added to the input.



948
949
950
951
# File 'lib/bitcoin/script.rb', line 948

def op_1add
  a = pop_int
  @stack << (a + 1)
end

#op_1negateObject

The number -1 is pushed onto the stack.



1033
1034
1035
# File 'lib/bitcoin/script.rb', line 1033

def op_1negate
  @stack << -1
end

#op_1subObject

1 is subtracted from the input.



954
955
956
957
# File 'lib/bitcoin/script.rb', line 954

def op_1sub
  a = pop_int
  @stack << (a - 1)
end

#op_2divObject

The input is divided by 2. Currently disabled.



936
937
938
939
# File 'lib/bitcoin/script.rb', line 936

def op_2div
  a = pop_int
  @stack << (a >> 1)
end

#op_2dropObject

Removes the top two stack items.



1138
1139
1140
# File 'lib/bitcoin/script.rb', line 1138

def op_2drop
  @stack.pop(2)
end

#op_2dupObject

Duplicates the top two stack items.



1143
1144
1145
# File 'lib/bitcoin/script.rb', line 1143

def op_2dup
  @stack.push(*@stack[-2..-1])
end

#op_2mulObject

The input is multiplied by 2. Currently disabled.



942
943
944
945
# File 'lib/bitcoin/script.rb', line 942

def op_2mul
  a = pop_int
  @stack << (a << 1)
end

#op_2overObject

Copies the pair of items two spaces back in the stack to the front.



1013
1014
1015
1016
# File 'lib/bitcoin/script.rb', line 1013

def op_2over
  @stack << @stack[-4]
  @stack << @stack[-4]
end

#op_2rotObject

The fifth and sixth items back are moved to the top of the stack.



1113
1114
1115
1116
# File 'lib/bitcoin/script.rb', line 1113

def op_2rot
  return invalid if @stack.size < 6
  @stack[-6..-1] = [ *@stack[-4..-1], *@stack[-6..-5] ]
end

#op_2swapObject

Swaps the top two pairs of items.



1019
1020
1021
1022
1023
# File 'lib/bitcoin/script.rb', line 1019

def op_2swap
  p1 = @stack.pop(2)
  p2 = @stack.pop(2)
  @stack += p1 += p2
end

#op_3dupObject

Duplicates the top three stack items.



1148
1149
1150
# File 'lib/bitcoin/script.rb', line 1148

def op_3dup
  @stack.push(*@stack[-3..-1])
end

#op_absObject

The input is made positive.



930
931
932
933
# File 'lib/bitcoin/script.rb', line 930

def op_abs
  a = pop_int
  @stack << a.abs
end

#op_addObject

a is added to b.



883
884
885
886
# File 'lib/bitcoin/script.rb', line 883

def op_add
  a, b = pop_int(2)
  @stack << a + b
end

#op_boolandObject

If both a and b are not 0, the output is 1. Otherwise 0.



871
872
873
874
# File 'lib/bitcoin/script.rb', line 871

def op_booland
  a, b = pop_int(2)
  @stack << (![a,b].any?{|n| n == 0 } ? 1 : 0)
end

#op_boolorObject

If a or b is not 0, the output is 1. Otherwise 0.



877
878
879
880
# File 'lib/bitcoin/script.rb', line 877

def op_boolor
  a, b = pop_int(2)
  @stack << ( (a != 0 || b != 0) ? 1 : 0 )
end

#op_checkmultisig(check_callback) ⇒ Object

do a CHECKMULTISIG operation on the current stack, asking check_callback to do the actual signature verification.

CHECKMULTISIG does a m-of-n signatures verification on scripts of the form:

0 <sig1> <sig2> | 2 <pub1> <pub2> 2 OP_CHECKMULTISIG
0 <sig1> <sig2> | 2 <pub1> <pub2> <pub3> 3 OP_CHECKMULTISIG
0 <sig1> <sig2> <sig3> | 3 <pub1> <pub2> <pub3> 3 OP_CHECKMULTISIG

see en.bitcoin.it/wiki/BIP_0011 for details. see github.com/bitcoin/bitcoin/blob/master/src/script.cpp#L931

TODO: validate signature order TODO: take global opcode count



1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
# File 'lib/bitcoin/script.rb', line 1292

def op_checkmultisig(check_callback)
  return invalid if @stack.size < 1
  n_pubkeys = pop_int
  return invalid  unless (0..20).include?(n_pubkeys)
  #return invalid  if (nOpCount += n_pubkeys) > 201
  return invalid if @stack.size < n_pubkeys
  pubkeys = pop_string(n_pubkeys)

  return invalid if @stack.size < 1
  n_sigs = pop_int
  return invalid if n_sigs < 0 || n_sigs > n_pubkeys
  return invalid if @stack.size < n_sigs
  sigs = pop_string(n_sigs)
  drop_sigs = sigs.dup

  # Bitcoin-core removes an extra item from the stack
  @stack.pop

  subscript = sighash_subscript(drop_sigs)

  success = true
  while success && n_sigs > 0
    sig, pub = sigs.pop, pubkeys.pop
    unless sig && sig.size > 0
      success = false
      break
    end
    signature, hash_type = parse_sig(sig)
    if pub.size > 0 && check_callback.call(pub, signature, hash_type, subscript)
      n_sigs -= 1
    else
      sigs << sig
    end
    n_pubkeys -= 1
    success = false if n_sigs > n_pubkeys
  end

  @stack << (success ? 1 : 0)
end

#op_checkmultisigverify(check_callback) ⇒ Object

Same as OP_CHECKMULTISIG, but OP_VERIFY is executed afterward.



1333
1334
1335
1336
# File 'lib/bitcoin/script.rb', line 1333

def op_checkmultisigverify(check_callback)
  op_checkmultisig(check_callback)
  op_verify
end

#op_checksig(check_callback) ⇒ Object

do a CHECKSIG operation on the current stack, asking check_callback to do the actual signature verification. This is used by Protocol::Tx#verify_input_signature



1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
# File 'lib/bitcoin/script.rb', line 1243

def op_checksig(check_callback)
  return invalid if @stack.size < 2
  pubkey = cast_to_string(@stack.pop)
  #return (@stack << 0) unless Bitcoin::Script.is_canonical_pubkey?(pubkey) # only for isStandard
  drop_sigs      = [ cast_to_string(@stack[-1]) ]

  signature = cast_to_string(@stack.pop)
  #return (@stack << 0) unless Bitcoin::Script.is_canonical_signature?(signature) # only for isStandard
  return (@stack << 0) if signature == ""

  sig, hash_type = parse_sig(signature)

  subscript = sighash_subscript(drop_sigs)

  if check_callback == nil # for tests
    @stack << 1
  else # real signature check callback
    @stack <<
      ((check_callback.call(pubkey, sig, hash_type, subscript) == true) ? 1 : 0)
  end
end

#op_checksigverify(check_callback) ⇒ Object

Same as OP_CHECKSIG, but OP_VERIFY is executed afterward.



1274
1275
1276
1277
# File 'lib/bitcoin/script.rb', line 1274

def op_checksigverify(check_callback)
  op_checksig(check_callback)
  op_verify
end

#op_codeseparatorObject

All of the signature checking words will only match signatures to the data after the most recently-executed OP_CODESEPARATOR.



1227
1228
1229
1230
# File 'lib/bitcoin/script.rb', line 1227

def op_codeseparator
  @codehash_start = @chunks.size - @chunks.reverse.index(OP_CODESEPARATOR)
  @last_codeseparator_index = @chunk_last_index
end

#op_depthObject

Puts the number of stack items onto the stack.



1038
1039
1040
# File 'lib/bitcoin/script.rb', line 1038

def op_depth
  @stack << @stack.size
end

#op_dropObject

Removes the top stack item.



966
967
968
# File 'lib/bitcoin/script.rb', line 966

def op_drop
  @stack.pop
end

#op_dupObject

Duplicates the top stack item.



816
817
818
# File 'lib/bitcoin/script.rb', line 816

def op_dup
  @stack << (@stack[-1].dup rescue @stack[-1])
end

#op_elseObject

If the preceding OP_IF or OP_NOTIF or OP_ELSE was not executed then these statements are and if the preceding OP_IF or OP_NOTIF or OP_ELSE was executed then these statements are not.



1092
1093
1094
1095
# File 'lib/bitcoin/script.rb', line 1092

def op_else
  return if @exec_stack.empty?
  @exec_stack[-1] = !@exec_stack[-1]
end

#op_endifObject

Ends an if/else block.



1098
1099
1100
1101
# File 'lib/bitcoin/script.rb', line 1098

def op_endif
  return if @exec_stack.empty?
  @exec_stack.pop
end

#op_equalObject

Returns 1 if the inputs are exactly equal, 0 otherwise.



971
972
973
974
# File 'lib/bitcoin/script.rb', line 971

def op_equal
  a, b = pop_string(2)
  @stack << (a == b ? 1 : 0)
end

#op_equalverifyObject

Same as OP_EQUAL, but runs OP_VERIFY afterward.



988
989
990
# File 'lib/bitcoin/script.rb', line 988

def op_equalverify
  op_equal; op_verify
end

#op_fromaltstackObject

Puts the input onto the top of the main stack. Removes it from the alt stack.



856
857
858
# File 'lib/bitcoin/script.rb', line 856

def op_fromaltstack
  @stack << @stack_alt.pop
end

#op_greaterthanObject

Returns 1 if a is greater than b, 0 otherwise.



907
908
909
910
# File 'lib/bitcoin/script.rb', line 907

def op_greaterthan
  a, b = pop_int(2)
  @stack << (a > b ? 1 : 0)
end

#op_greaterthanorequalObject

Returns 1 if a is greater than or equal to b, 0 otherwise.



913
914
915
916
# File 'lib/bitcoin/script.rb', line 913

def op_greaterthanorequal
  a, b = pop_int(2)
  @stack << (a >= b ? 1 : 0)
end

#op_hash160Object

The input is hashed twice: first with SHA-256 and then with RIPEMD-160.



833
834
835
836
# File 'lib/bitcoin/script.rb', line 833

def op_hash160
  buf = pop_string
  @stack << Digest::RMD160.digest(Digest::SHA256.digest(buf))
end

#op_hash256Object

The input is hashed two times with SHA-256.



845
846
847
848
# File 'lib/bitcoin/script.rb', line 845

def op_hash256
  buf = pop_string
  @stack << Digest::SHA256.digest(Digest::SHA256.digest(buf))
end

#op_ifObject

If the top stack value is not 0, the statements are executed. The top stack value is removed.



1072
1073
1074
1075
1076
1077
1078
1079
# File 'lib/bitcoin/script.rb', line 1072

def op_if
  value = false
  if @do_exec
    (invalid; return) if @stack.size < 1
    value = cast_to_bool(pop_string) == false ? false : true
  end
  @exec_stack << value
end

#op_ifdupObject

If the input is true, duplicate it.



1026
1027
1028
1029
1030
# File 'lib/bitcoin/script.rb', line 1026

def op_ifdup
  if cast_to_bool(@stack.last) == true
    @stack << @stack.last
  end
end

#op_lessthanObject

Returns 1 if a is less than b, 0 otherwise.



895
896
897
898
# File 'lib/bitcoin/script.rb', line 895

def op_lessthan
  a, b = pop_int(2)
  @stack << (a < b ? 1 : 0)
end

#op_lessthanorequalObject

Returns 1 if a is less than or equal to b, 0 otherwise.



901
902
903
904
# File 'lib/bitcoin/script.rb', line 901

def op_lessthanorequal
  a, b = pop_int(2)
  @stack << (a <= b ? 1 : 0)
end

#op_maxObject

Returns the larger of a and b.



1008
1009
1010
# File 'lib/bitcoin/script.rb', line 1008

def op_max
  @stack << pop_int(2).max
end

#op_minObject

Returns the smaller of a and b.



1003
1004
1005
# File 'lib/bitcoin/script.rb', line 1003

def op_min
  @stack << pop_int(2).min
end

#op_negateObject

The sign of the input is flipped.



960
961
962
963
# File 'lib/bitcoin/script.rb', line 960

def op_negate
  a = pop_int
  @stack << -a
end

#op_nipObject

Removes the second-to-top stack item.



1153
1154
1155
# File 'lib/bitcoin/script.rb', line 1153

def op_nip
  @stack.delete_at(-2)
end

#op_nopObject

Does nothing



803
# File 'lib/bitcoin/script.rb', line 803

def op_nop; end

#op_nop1Object

op_eval: en.bitcoin.it/wiki/BIP_0012

the BIP was never accepted and must be handled as old OP_NOP1


1340
# File 'lib/bitcoin/script.rb', line 1340

def op_nop1; end

#op_nop10Object



813
# File 'lib/bitcoin/script.rb', line 813

def op_nop10; end

#op_nop2Object



805
# File 'lib/bitcoin/script.rb', line 805

def op_nop2; end

#op_nop3Object



806
# File 'lib/bitcoin/script.rb', line 806

def op_nop3; end

#op_nop4Object



807
# File 'lib/bitcoin/script.rb', line 807

def op_nop4; end

#op_nop5Object



808
# File 'lib/bitcoin/script.rb', line 808

def op_nop5; end

#op_nop6Object



809
# File 'lib/bitcoin/script.rb', line 809

def op_nop6; end

#op_nop7Object



810
# File 'lib/bitcoin/script.rb', line 810

def op_nop7; end

#op_nop8Object



811
# File 'lib/bitcoin/script.rb', line 811

def op_nop8; end

#op_nop9Object



812
# File 'lib/bitcoin/script.rb', line 812

def op_nop9; end

#op_notObject

If the input is 0 or 1, it is flipped. Otherwise the output will be 0.



919
920
921
922
# File 'lib/bitcoin/script.rb', line 919

def op_not
  a = pop_int
  @stack << (a == 0 ? 1 : 0)
end

#op_notifObject

If the top stack value is 0, the statements are executed. The top stack value is removed.



1082
1083
1084
1085
1086
1087
1088
1089
# File 'lib/bitcoin/script.rb', line 1082

def op_notif
  value = false
  if @do_exec
    (invalid; return) if @stack.size < 1
    value = cast_to_bool(pop_string) == false ? true : false
  end
  @exec_stack << value
end

#op_numequalObject

Returns 1 if the numbers are equal, 0 otherwise.



1049
1050
1051
1052
# File 'lib/bitcoin/script.rb', line 1049

def op_numequal
  a, b = pop_int(2)
  @stack << (a == b ? 1 : 0)
end

#op_numequalverifyObject

Same as OP_NUMEQUAL, but runs OP_VERIFY afterward.



1221
1222
1223
# File 'lib/bitcoin/script.rb', line 1221

def op_numequalverify
  op_numequal; op_verify
end

#op_numnotequalObject

Returns 1 if the numbers are not equal, 0 otherwise.



1055
1056
1057
1058
# File 'lib/bitcoin/script.rb', line 1055

def op_numnotequal
  a, b = pop_int(2)
  @stack << (a != b ? 1 : 0)
end

#op_overObject

Copies the second-to-top stack item to the top.



1066
1067
1068
1069
# File 'lib/bitcoin/script.rb', line 1066

def op_over
  item = @stack[-2]
  @stack << item if item
end

#op_pickObject

The item n back in the stack is copied to the top.



1104
1105
1106
1107
1108
1109
1110
# File 'lib/bitcoin/script.rb', line 1104

def op_pick
  return invalid if @stack.size < 2
  pos = pop_int
  return invalid if (pos < 0) || (pos >= @stack.size)
  item = @stack[-(pos+1)]
  @stack << item if item
end

#op_returnObject

Marks transaction as invalid.



1061
1062
1063
# File 'lib/bitcoin/script.rb', line 1061

def op_return
  @script_invalid = true; nil
end

#op_ripemd160Object

The input is hashed using RIPEMD-160.



839
840
841
842
# File 'lib/bitcoin/script.rb', line 839

def op_ripemd160
  buf = pop_string
  @stack << Digest::RMD160.digest(buf)
end

#op_rollObject

The item n back in the stack is moved to the top.



1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'lib/bitcoin/script.rb', line 1119

def op_roll
  return invalid if @stack.size < 2
  pos = pop_int
  return invalid if (pos < 0) || (pos >= @stack.size)
  idx = -(pos+1)
  item = @stack[idx]
  if item
    @stack.delete_at(idx)
    @stack << item if item
  end
end

#op_rotObject

The top three items on the stack are rotated to the left.



1132
1133
1134
1135
# File 'lib/bitcoin/script.rb', line 1132

def op_rot
  return if @stack.size < 3
  @stack[-3..-1] = [ @stack[-2], @stack[-1], @stack[-3] ]
end

#op_sha1Object

The input is hashed using SHA-1.



827
828
829
830
# File 'lib/bitcoin/script.rb', line 827

def op_sha1
  buf = pop_string
  @stack << Digest::SHA1.digest(buf)
end

#op_sha256Object

The input is hashed using SHA-256.



821
822
823
824
# File 'lib/bitcoin/script.rb', line 821

def op_sha256
  buf = pop_string
  @stack << Digest::SHA256.digest(buf)
end

#op_sizeObject

Returns the length of the input string.



1158
1159
1160
1161
1162
1163
1164
1165
# File 'lib/bitcoin/script.rb', line 1158

def op_size
  item = @stack[-1]
  size = case item
         when String; item.bytesize
         when Numeric; OpenSSL::BN.new(item.to_s).to_mpi.size - 4
         end
  @stack << size
end

#op_subObject

b is subtracted from a.



889
890
891
892
# File 'lib/bitcoin/script.rb', line 889

def op_sub
  a, b = pop_int(2)
  @stack << a - b
end

#op_swapObject

The top two items on the stack are swapped.



866
867
868
# File 'lib/bitcoin/script.rb', line 866

def op_swap
  @stack[-2..-1] = @stack[-2..-1].reverse if @stack[-2]
end

#op_toaltstackObject

Puts the input onto the top of the alt stack. Removes it from the main stack.



851
852
853
# File 'lib/bitcoin/script.rb', line 851

def op_toaltstack
  @stack_alt << @stack.pop
end

#op_tuckObject

The item at the top of the stack is copied and inserted before the second-to-top item.



861
862
863
# File 'lib/bitcoin/script.rb', line 861

def op_tuck
  @stack[-2..-1] = [ @stack[-1], *@stack[-2..-1] ]
end

#op_verObject

Transaction is invalid unless occuring in an unexecuted OP_IF branch



1168
1169
1170
# File 'lib/bitcoin/script.rb', line 1168

def op_ver
  invalid if @do_exec
end

#op_verifyObject

Marks transaction as invalid if top stack value is not true. True is removed, but false is not.



977
978
979
980
981
982
983
984
985
# File 'lib/bitcoin/script.rb', line 977

def op_verify
  res = pop_int
  if cast_to_bool(res) == false
    @stack << res
    @script_invalid = true # raise 'transaction invalid' ?
  else
    @script_invalid = false
  end
end

#op_withinObject

Returns 1 if x is within the specified range (left-inclusive), 0 otherwise.



1043
1044
1045
1046
# File 'lib/bitcoin/script.rb', line 1043

def op_within
  bn1, bn2, bn3 = pop_int(3)
  @stack << ( (bn2 <= bn1 && bn1 < bn3) ? 1 : 0 )
end

#parse(bytes, offset = 0) ⇒ Object

parse raw script



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/bitcoin/script.rb', line 186

def parse(bytes, offset=0)
  program = bytes.unpack("C*")
  chunks = []
  until program.empty?
    opcode = program.shift

    if (opcode > 0) && (opcode < OP_PUSHDATA1)
      len, tmp = opcode, program[0]
      chunks << program.shift(len).pack("C*")

      # 0x16 = 22 due to OP_2_16 from_string parsing
      if len == 1 && tmp && tmp <= 22
        chunks.last.bitcoin_pushdata = OP_PUSHDATA0
        chunks.last.bitcoin_pushdata_length = len
      else
        raise "invalid OP_PUSHDATA0" if len != chunks.last.bytesize
      end
    elsif (opcode == OP_PUSHDATA1)
      len = program.shift(1)[0]
      chunks << program.shift(len).pack("C*")

      unless len > OP_PUSHDATA1 && len <= 0xff
        chunks.last.bitcoin_pushdata = OP_PUSHDATA1
        chunks.last.bitcoin_pushdata_length = len
      else
        raise "invalid OP_PUSHDATA1" if len != chunks.last.bytesize
      end
    elsif (opcode == OP_PUSHDATA2)
      len = program.shift(2).pack("C*").unpack("v")[0]
      chunks << program.shift(len).pack("C*")

      unless len > 0xff && len <= 0xffff
        chunks.last.bitcoin_pushdata = OP_PUSHDATA2
        chunks.last.bitcoin_pushdata_length = len
      else
        raise "invalid OP_PUSHDATA2" if len != chunks.last.bytesize
      end
    elsif (opcode == OP_PUSHDATA4)
      len = program.shift(4).pack("C*").unpack("V")[0]
      chunks << program.shift(len).pack("C*")

      unless len > 0xffff # && len <= 0xffffffff
        chunks.last.bitcoin_pushdata = OP_PUSHDATA4
        chunks.last.bitcoin_pushdata_length = len
      else
        raise "invalid OP_PUSHDATA4" if len != chunks.last.bytesize
      end
    else
      chunks << opcode
    end
  end
  chunks
rescue => ex
  # bail out! #run returns false but serialization roundtrips still create the right payload.
  chunks.pop if ex.message.include?("invalid OP_PUSHDATA")
  @parse_invalid = true
  c = bytes.unpack("C*").pack("C*")
  c.bitcoin_pushdata = OP_PUSHDATA_INVALID
  c.bitcoin_pushdata_length = c.bytesize
  chunks << c
end

#pay_to_script_hash(check_callback) ⇒ Object

pay_to_script_hash: en.bitcoin.it/wiki/BIP_0016

<sig> OP_CHECKSIG | OP_HASH160 <script_hash> OP_EQUAL



476
477
478
479
480
481
482
483
484
485
486
487
488
# File 'lib/bitcoin/script.rb', line 476

def pay_to_script_hash(check_callback)
  return false if @chunks.size < 4
  *rest, script, _, script_hash, _ = @chunks
  script = rest.pop if script == OP_CODESEPARATOR
  script, script_hash = cast_to_string(script), cast_to_string(script_hash)

  return false unless Bitcoin.hash160(script.unpack("H*")[0]) == script_hash.unpack("H*")[0]

  script = self.class.new(to_binary(rest) + script).inner_p2sh!(script)
  result = script.run(&check_callback)
  @debug = script.debug
  result
end

#pop_int(count = nil) ⇒ Object



1172
1173
1174
1175
# File 'lib/bitcoin/script.rb', line 1172

def pop_int(count=nil)
  return cast_to_bignum(@stack.pop) unless count
  @stack.pop(count).map{|i| cast_to_bignum(i) }
end

#pop_string(count = nil) ⇒ Object



1177
1178
1179
1180
# File 'lib/bitcoin/script.rb', line 1177

def pop_string(count=nil)
  return cast_to_string(@stack.pop) unless count
  @stack.pop(count).map{|i| cast_to_string(i) }
end

#run(block_timestamp = Time.now.to_i, &check_callback) ⇒ Object

run the script. check_callback is called for OP_CHECKSIG operations



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# File 'lib/bitcoin/script.rb', line 399

def run(block_timestamp=Time.now.to_i, &check_callback)
  return false if @parse_invalid

  #p [to_string, block_timestamp, is_p2sh?]
  @script_invalid = true if @raw_byte_sizes.any?{|size| size > 10_000 }
  @last_codeseparator_index = 0

  if block_timestamp >= 1333238400 # Pay to Script Hash (BIP 0016)
    return pay_to_script_hash(check_callback)  if is_p2sh?
  end

  @debug = []
  @chunks.each.with_index{|chunk,idx|
    break if invalid?
    @chunk_last_index = idx

    @debug << @stack.map{|i| i.unpack("H*") rescue i}
    @do_exec = @exec_stack.count(false) == 0 ? true : false
    #p [@stack, @do_exec]

    case chunk
    when Fixnum
      if DISABLED_OPCODES.include?(chunk)
        @script_invalid = true
        @debug << "DISABLED_#{OPCODES[chunk]}"
        break
      end

      next @debug.pop  unless (@do_exec || (OP_IF <= chunk && chunk <= OP_ENDIF))

      case chunk
      when *OPCODES_METHOD.keys
        m = method( n=OPCODES_METHOD[chunk] )
        @debug << n.to_s.upcase
        (m.arity == 1) ? m.call(check_callback) : m.call  # invoke opcode method
      when *OP_2_16
        @stack << OP_2_16.index(chunk) + 2
        @debug << "OP_#{chunk-80}"
      else
        name = OPCODES[chunk] || chunk
        puts "Bitcoin::Script: opcode #{name} unkown or not implemented\n#{to_string.inspect}"
        raise "opcode #{name} unkown or not implemented"
      end
    when String
      if @do_exec
        @debug << "PUSH DATA #{chunk.unpack("H*")[0]}"
        @stack << chunk
      else
        @debug.pop
      end
    end
  }
  @debug << @stack.map{|i| i.unpack("H*") rescue i } #if @do_exec

  if @script_invalid
    @stack << 0
    @debug << "INVALID TRANSACTION"
  end

  @debug << "RESULT"
  return false if @stack.empty?
  return false if cast_to_bool(@stack.pop) == false
  true
end

#sighash_subscript(drop_sigs) ⇒ Object



1265
1266
1267
1268
1269
1270
1271
# File 'lib/bitcoin/script.rb', line 1265

def sighash_subscript(drop_sigs)
  if inner_p2sh? && @inner_script_code
    ::Bitcoin::Script.new(@inner_script_code).to_binary_without_signatures(drop_sigs)
  else
    to_binary_without_signatures(drop_sigs)
  end
end

#sigops_count_accurate(is_accurate) ⇒ Object

This matches CScript::GetSigOpCount(bool fAccurate) Note: this does not cover P2SH script which is to be unserialized

and checked explicitly when validating blocks.


737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
# File 'lib/bitcoin/script.rb', line 737

def sigops_count_accurate(is_accurate)
  count = 0
  last_opcode = nil
  @chunks.each do |chunk| # pushdate or opcode
    if chunk == OP_CHECKSIG || chunk == OP_CHECKSIGVERIFY
      count += 1
    elsif chunk == OP_CHECKMULTISIG || chunk == OP_CHECKMULTISIGVERIFY
      # Accurate mode counts exact number of pubkeys required (not signatures, but pubkeys!). Only used in P2SH scripts.
      # Inaccurate mode counts every multisig as 20 signatures.
      if is_accurate && last_opcode && last_opcode.is_a?(Fixnum) && last_opcode >= OP_1 && last_opcode <= OP_16
        count += ::Bitcoin::Script.decode_OP_N(last_opcode)
      else
        count += 20
      end
    end
    last_opcode = chunk
  end
  count
end

#sigops_count_for_p2shObject

This method applies to script_sig that is an input for p2sh output. Bitcoind has somewhat special way to return count for invalid input scripts: it returns 0 when the opcode can’t be parsed or when it’s over OP_16. Also, if the OP_N is used anywhere it’s treated as 0-length data. See CScript::GetSigOpCount(const CScript& scriptSig) in bitcoind.



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
# File 'lib/bitcoin/script.rb', line 762

def sigops_count_for_p2sh
  # This is a pay-to-script-hash scriptPubKey;
  # get the last item that the scriptSig
  # pushes onto the stack:

  return 0 if @chunks.size == 0

  data = nil
  @chunks.each do |chunk|
    case chunk
    when Fixnum
      data = ""
      return 0 if chunk > OP_16
    when String
      data = chunk
    end
  end
  return 0 if data == ""

  ::Bitcoin::Script.new(data).sigops_count_accurate(true)
end

#to_binary(chunks = nil) ⇒ Object Also known as: to_payload



271
272
273
274
275
276
277
278
# File 'lib/bitcoin/script.rb', line 271

def to_binary(chunks=nil)
  (chunks || @chunks).map{|chunk|
    case chunk
    when Fixnum; [chunk].pack("C*")
    when String; self.class.pack_pushdata(chunk)
    end
  }.join
end

#to_binary_without_signatures(drop_signatures, chunks = nil) ⇒ Object



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# File 'lib/bitcoin/script.rb', line 281

def to_binary_without_signatures(drop_signatures, chunks=nil)
  buf = []
  (chunks || @chunks).each.with_index{|chunk,idx|
    if chunk == OP_CODESEPARATOR and idx <= @last_codeseparator_index
      buf.clear
    elsif chunk == OP_CODESEPARATOR
      if idx == @script_codeseparator_index
        break
      else
        # skip
      end
    elsif drop_signatures.none?{|e| e == chunk }
      buf << chunk
    end
  }
  to_binary(buf)
end

#to_string(chunks = nil) ⇒ Object

string representation of the script



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
# File 'lib/bitcoin/script.rb', line 249

def to_string(chunks=nil)
  string = ""
  (chunks || @chunks).each.with_index{|i,idx|
    string << " " unless idx == 0
    string << case i
    when Fixnum
      if opcode = OPCODES_PARSE_BINARY[i]
        opcode
      else
        "(opcode-#{i})"
      end
    when String
      if i.bitcoin_pushdata
        "#{i.bitcoin_pushdata}:#{i.bitcoin_pushdata_length}:".force_encoding('binary') + i.unpack("H*")[0]
      else
        i.unpack("H*")[0]
      end
    end
  }
  string
end

#typeObject

get type of this tx



544
545
546
547
548
549
550
551
552
# File 'lib/bitcoin/script.rb', line 544

def type
  if is_hash160?;     :hash160
  elsif is_pubkey?;   :pubkey
  elsif is_multisig?; :multisig
  elsif is_p2sh?;     :p2sh
  elsif is_op_return?;:op_return
  else;               :unknown
  end
end