Class: Counterparty::Order

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

Overview

An object that describes a specific order.

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)



431
432
433
 
# File 'lib/counterparty/resources.rb', line 431

def block_index
  @block_index
end

#expiration ⇒ Object

(integer): The number of blocks over which the order should be valid



459
460
461
 
# File 'lib/counterparty/resources.rb', line 459

def expiration
  @expiration
end

#fee_provided ⇒ Object

(integer): The miners’ fee provided; in BTC; required only if selling BTC (should not be lower than is required for acceptance in a block)



463
464
465
 
# File 'lib/counterparty/resources.rb', line 463

def fee_provided
  @fee_provided
end

#fee_required ⇒ Object

(integer): The miners’ fee required to be paid by orders for them to match this one; in BTC; required only if buying BTC (may be zero, though)



467
468
469
 
# File 'lib/counterparty/resources.rb', line 467

def fee_required
  @fee_required
end

#get_asset ⇒ Object

(string): The asset desired in exchange



446
447
448
 
# File 'lib/counterparty/resources.rb', line 446

def get_asset
  @get_asset
end

#get_quantity ⇒ Object

(integer): The quantity of the specified asset desired in exchange



449
450
451
 
# File 'lib/counterparty/resources.rb', line 449

def get_quantity
  @get_quantity
end

#get_remaining ⇒ Object

(integer): The quantity of the specified get asset remaining for the order



452
453
454
 
# File 'lib/counterparty/resources.rb', line 452

def get_remaining
  @get_remaining
end

#give_asset ⇒ Object

(string): The asset being offered



437
438
439
 
# File 'lib/counterparty/resources.rb', line 437

def give_asset
  @give_asset
end

#give_quantity ⇒ Object

(integer): The quantity of the specified asset being offered



440
441
442
 
# File 'lib/counterparty/resources.rb', line 440

def give_quantity
  @give_quantity
end

#give_remaining ⇒ Object

(integer): The quantity of the specified give asset remaining for the order



443
444
445
 
# File 'lib/counterparty/resources.rb', line 443

def give_remaining
  @give_remaining
end

#price ⇒ Object

(float): The given exchange rate (as an exchange ratio desired from the asset offered to the asset desired)



456
457
458
 
# File 'lib/counterparty/resources.rb', line 456

def price
  @price
end

#source ⇒ Object

(string): The address that made the order



434
435
436
 
# File 'lib/counterparty/resources.rb', line 434

def source
  @source
end

#tx_hash ⇒ Object

(string): The transaction hash



428
429
430
 
# File 'lib/counterparty/resources.rb', line 428

def tx_hash
  @tx_hash
end

#tx_index ⇒ Object

(integer): The transaction index



425
426
427
 
# File 'lib/counterparty/resources.rb', line 425

def tx_index
  @tx_index
end