Class: RippleRest::Trustline
- Inherits:
-
RestObject
- Object
- RestObject
- RippleRest::Trustline
- Defined in:
- lib/ripple-rest/generated-schemas.rb,
lib/ripple-rest/generated-schemas.rb
Overview
A simplified Trustline object used by the ripple-rest API
Instance Attribute Summary collapse
-
#account ⇒ String<RippleAddress>
The account from whose perspective this trustline is being viewed.
-
#account_allows_rippling ⇒ Boolean
If true it indicates that the account allows pairwise rippling out through this trustline.
-
#authorized_by_account ⇒ Boolean
Set to true if the account has explicitly authorized the counterparty to hold currency it issues.
-
#authorized_by_counterparty ⇒ Boolean
Set to true if the counterparty has explicitly authorized the account to hold currency it issues.
-
#counterparty ⇒ String<RippleAddress>
The other party in this trustline.
-
#counterparty_allows_rippling ⇒ Boolean
If true it indicates that the counterparty allows pairwise rippling out through this trustline.
-
#currency ⇒ String<Currency>
The code of the currency in which this trustline denotes trust.
-
#hash ⇒ String<Hash256>
If this object was returned by a historical query this value will be the hash of the transaction that modified this Trustline.
-
#ledger ⇒ String
The string representation of the index number of the ledger containing this trustline or, in the case of historical queries, of the transaction that modified this Trustline.
-
#limit ⇒ BigDecimal
The maximum value of the currency that the account may hold issued by the counterparty.
-
#previous ⇒ Trustline
If the trustline was changed this will be a full Trustline object representing the previous values.
-
#reciprocated_limit ⇒ BigDecimal
The maximum value of the currency that the counterparty may hold issued by the account.
Method Summary
Methods inherited from RestObject
Constructor Details
This class inherits a constructor from RippleRest::RestObject
Instance Attribute Details
#account ⇒ String<RippleAddress>
The account from whose perspective this trustline is being viewed
395 |
# File 'lib/ripple-rest/generated-schemas.rb', line 395 property :account, :RippleAddress |
#account_allows_rippling ⇒ Boolean
If true it indicates that the account allows pairwise rippling out through this trustline
432 |
# File 'lib/ripple-rest/generated-schemas.rb', line 432 property :account_allows_rippling, :Boolean |
#authorized_by_account ⇒ Boolean
Set to true if the account has explicitly authorized the counterparty to hold currency it issues. This is only necessary if the account’s settings include require_authorization_for_incoming_trustlines
422 |
# File 'lib/ripple-rest/generated-schemas.rb', line 422 property :authorized_by_account, :Boolean |
#authorized_by_counterparty ⇒ Boolean
Set to true if the counterparty has explicitly authorized the account to hold currency it issues. This is only necessary if the counterparty’s settings include require_authorization_for_incoming_trustlines
427 |
# File 'lib/ripple-rest/generated-schemas.rb', line 427 property :authorized_by_counterparty, :Boolean |
#counterparty ⇒ String<RippleAddress>
The other party in this trustline
401 |
# File 'lib/ripple-rest/generated-schemas.rb', line 401 property :counterparty, :RippleAddress |
#counterparty_allows_rippling ⇒ Boolean
If true it indicates that the counterparty allows pairwise rippling out through this trustline
437 |
# File 'lib/ripple-rest/generated-schemas.rb', line 437 property :counterparty_allows_rippling, :Boolean |
#currency ⇒ String<Currency>
The code of the currency in which this trustline denotes trust
406 |
# File 'lib/ripple-rest/generated-schemas.rb', line 406 property :currency, :Currency |
#hash ⇒ String<Hash256>
If this object was returned by a historical query this value will be the hash of the transaction that modified this Trustline. The transaction hash is used throughout the Ripple Protocol to uniquely identify a particular transaction
447 |
# File 'lib/ripple-rest/generated-schemas.rb', line 447 property :hash, :Hash256 |
#ledger ⇒ String
The string representation of the index number of the ledger containing this trustline or, in the case of historical queries, of the transaction that modified this Trustline
442 |
# File 'lib/ripple-rest/generated-schemas.rb', line 442 property :ledger, [:String, "^[0-9]+$"] |
#limit ⇒ BigDecimal
The maximum value of the currency that the account may hold issued by the counterparty
411 |
# File 'lib/ripple-rest/generated-schemas.rb', line 411 property :limit, :FloatString |
#previous ⇒ Trustline
If the trustline was changed this will be a full Trustline object representing the previous values. If the previous object also had a previous object that will be removed to reduce data complexity. Trustline changes can be walked backwards by querying the API for previous.hash repeatedly
452 |
# File 'lib/ripple-rest/generated-schemas.rb', line 452 property :previous, :Trustline |
#reciprocated_limit ⇒ BigDecimal
The maximum value of the currency that the counterparty may hold issued by the account
417 |
# File 'lib/ripple-rest/generated-schemas.rb', line 417 property :reciprocated_limit, :FloatString |