Class: Counterparty::Burn

Inherits:
CounterResource show all
Defined in:
lib/counterparty/resources.rb

Overview

An object that describes an instance of a specific burn.

Instance Attribute Summary collapse

Attributes inherited from CounterResource

#allow_unconfirmed_inputs, #encoding, #fee, #fee_per_kb, #pubkey, #result_attributes

Method Summary

Methods inherited from CounterResource

#==, api_name, find, #initialize, #save!, to_create_request, to_do_request, to_get_request, #to_raw_tx, #to_signed_tx

Constructor Details

This class inherits a constructor from Counterparty::CounterResource

Instance Attribute Details

#block_index ⇒ Object

(integer): The block index (block number in the block chain)



217
218
219
 
# File 'lib/counterparty/resources.rb', line 217

def block_index
  @block_index
end

#burned ⇒ Object

(integer): The quantity of BTC burned



223
224
225
 
# File 'lib/counterparty/resources.rb', line 223

def burned
  @burned
end

#earned ⇒ Object

(integer): The quantity of XPC actually earned from the burn (takes into account any bonus quantitys, 1 BTC limitation, etc)



227
228
229
 
# File 'lib/counterparty/resources.rb', line 227

def earned
  @earned
end

#quantity ⇒ Object

(integer): The amount of BTC to burn (only used in the Create Burn)



238
239
240
 
# File 'lib/counterparty/resources.rb', line 238

def quantity
  @quantity
end

#source ⇒ Object

(string): The address the burn was performed from



220
221
222
 
# File 'lib/counterparty/resources.rb', line 220

def source
  @source
end

#status ⇒ Object

(string): Set to “valid” if a valid burn. Any other setting signifies an invalid/improper burn



235
236
237
 
# File 'lib/counterparty/resources.rb', line 235

def status
  @status
end

#tx_hash ⇒ Object

(string): The transaction hash



214
215
216
 
# File 'lib/counterparty/resources.rb', line 214

def tx_hash
  @tx_hash
end

#tx_index ⇒ Object

(integer): The transaction index



211
212
213
 
# File 'lib/counterparty/resources.rb', line 211

def tx_index
  @tx_index
end

#validity ⇒ Object

(string): Set to “valid” if a valid burn. Any other setting signifies an invalid/improper burn



231
232
233
 
# File 'lib/counterparty/resources.rb', line 231

def validity
  @validity
end