Class: Counterparty::Dividend

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

Overview

An object that describes an issuance of dividends on a specific user defined asset.

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

#assetObject

(string): The asset that the dividends are being rewarded on



363
364
365
# File 'lib/counterparty/resources.rb', line 363

def asset
  @asset
end

#block_indexObject

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



357
358
359
# File 'lib/counterparty/resources.rb', line 357

def block_index
  @block_index
end

#dividend_assetObject

(string, required): The asset that the dividends are paid in.



373
374
375
# File 'lib/counterparty/resources.rb', line 373

def dividend_asset
  @dividend_asset
end

#quantity_per_unitObject

(integer): The quantity of XCP rewarded per whole unit of the asset



366
367
368
# File 'lib/counterparty/resources.rb', line 366

def quantity_per_unit
  @quantity_per_unit
end

#sourceObject

(string): The address that issued the dividend



360
361
362
# File 'lib/counterparty/resources.rb', line 360

def source
  @source
end

#tx_hashObject

(string): The transaction hash



354
355
356
# File 'lib/counterparty/resources.rb', line 354

def tx_hash
  @tx_hash
end

#tx_indexObject

(integer): The transaction index



351
352
353
# File 'lib/counterparty/resources.rb', line 351

def tx_index
  @tx_index
end

#validityObject

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



370
371
372
# File 'lib/counterparty/resources.rb', line 370

def validity
  @validity
end