Class: OpenAssets::Protocol::MarkerOutput

Inherits:
Object
  • Object
show all
Extended by:
Util
Includes:
Util
Defined in:
lib/openassets/protocol/marker_output.rb

Constant Summary collapse

MAX_ASSET_QUANTITY = 
2 ** 63 -1
OAP_MARKER =

A tag indicating thath this transaction is an Open Assets transaction.

"4f41"
VERSION =

The major revision number of the Open Assets Protocol.(1=0x0100)

"0100"

Constants included from Util

Util::OA_NAMESPACE, Util::OA_VERSION_BYTE, Util::OA_VERSION_BYTE_TESTNET

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util

address_to_oa_address, coin_to_satoshi, decode_leb128, encode_leb128, generate_asset_id, hash_to_asset_id, oa_address_to_address, pubkey_hash_to_asset_id, read_leb128, read_var_integer, satoshi_to_coin, script_to_asset_id, to_bytes, valid_asset_id?, validate_address

Constructor Details

#initialize(asset_quantities, metadata = '') ⇒ MarkerOutput

Returns a new instance of MarkerOutput.

Parameters:

  • asset_quantities (Array[Integer]) —

    The asset quantity array

  • metadata (String) (defaults to: '') —

    The metadata in the marker output.



21
22
23
24
 
# File 'lib/openassets/protocol/marker_output.rb', line 21

def initialize(asset_quantities, metadata = '')
  @asset_quantities = asset_quantities
  @metadata = metadata
end

Instance Attribute Details

#asset_quantities ⇒ Object

Returns the value of attribute asset_quantities.



16
17
18
 
# File 'lib/openassets/protocol/marker_output.rb', line 16

def asset_quantities
  @asset_quantities
end

#metadata ⇒ Object

Returns the value of attribute metadata.



17
18
19
 
# File 'lib/openassets/protocol/marker_output.rb', line 17

def metadata
  @metadata
end

Class Method Details

.parse_from_payload(payload) ⇒ OpenAssets::Protocol::MarkerOutput

Deserialize the marker output payload.

Parameters:

  • payload (String) —

    The Open Assets Payload with binary format.

Returns:



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/openassets/protocol/marker_output.rb', line 49

def self.parse_from_payload(payload)
  p = payload.bth
  return nil unless valid?(p)
  p = p[8..-1] # exclude OAP_MARKER,VERSION
  asset_quantity, p = parse_asset_qty(p)
  list = to_bytes(p).map{|x|(x.to_i(16)>=128 ? x : x+"|")}.join.split('|')[0..(asset_quantity - 1)].join
  asset_quantities = decode_leb128(list)
  meta = to_bytes(p[list.size..-1])
  metadata =  meta.empty? ? '' : meta[1..-1].map{|x|x.to_i(16).chr}.join
  new(asset_quantities, metadata)
end

.parse_script(output_script) ⇒ String

Parses an output and returns the payload if the output matches the right pattern for a marker output,

Parameters:

  • output_script: (Bitcoin::Script) —

    The output script to be parsed.

Returns:

  • (String) —

    The marker output payload with hex format if the output fits the pattern, nil otherwise.



64
65
66
67
 
# File 'lib/openassets/protocol/marker_output.rb', line 64

def self.parse_script(output_script)
  data = output_script.op_return_data
  return data.bth if data && valid?(data.bth)
end

Instance Method Details

#build_script ⇒ Bitcoin::Script Also known as: to_script

Creates an output script containing an OP_RETURN and a PUSHDATA from payload.

Returns:

  • (Bitcoin::Script) —

    the output script.



71
72
73
 
# File 'lib/openassets/protocol/marker_output.rb', line 71

def build_script
  Bitcoin::Script.from_string("OP_RETURN #{to_hex}")
end

#to_hex ⇒ String

Serialize the marker output into a Open Assets Payload buffer.

Returns:

  • (String) —

    The serialized payload with hex format



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/openassets/protocol/marker_output.rb', line 28

def to_hex
  payload = [OAP_MARKER, VERSION]
  asset_quantity_count = Bitcoin.pack_var_int(@asset_quantities.length).unpack("H*")
  payload << sort_count(asset_quantity_count[0])
  @asset_quantities.map{|q|payload << encode_leb128(q)}
  @metadata ||= ''
  metadata_length = Bitcoin.pack_var_int(@metadata.length).unpack("H*")
  payload << sort_count(metadata_length[0])
  payload << @metadata.bytes.map{|b| sprintf("%02x", b)}.join
  payload.join
end

#to_payload ⇒ String

Serialize the marker output into a Open Assets Payload buffer.

Returns:

  • (String) —

    The serialized payload with binary format.



42
43
44
 
# File 'lib/openassets/protocol/marker_output.rb', line 42

def to_payload
  to_hex.htb
end