Class: RippleRest::Trustline

Inherits:
RestObject show all
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

Method Summary

Methods inherited from RestObject

#initialize, #to_hash

Constructor Details

This class inherits a constructor from RippleRest::RestObject

Instance Attribute Details

#accountString<RippleAddress>

The account from whose perspective this trustline is being viewed

Returns:

  • (String<RippleAddress>)

395
# File 'lib/ripple-rest/generated-schemas.rb', line 395

property :account, :RippleAddress

#account_allows_ripplingBoolean

If true it indicates that the account allows pairwise rippling out through this trustline

Returns:

  • (Boolean)

432
# File 'lib/ripple-rest/generated-schemas.rb', line 432

property :account_allows_rippling, :Boolean

#authorized_by_accountBoolean

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

Returns:

  • (Boolean)

422
# File 'lib/ripple-rest/generated-schemas.rb', line 422

property :authorized_by_account, :Boolean

#authorized_by_counterpartyBoolean

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

Returns:

  • (Boolean)

427
# File 'lib/ripple-rest/generated-schemas.rb', line 427

property :authorized_by_counterparty, :Boolean

#counterpartyString<RippleAddress>

The other party in this trustline

Returns:

  • (String<RippleAddress>)

401
# File 'lib/ripple-rest/generated-schemas.rb', line 401

property :counterparty, :RippleAddress

#counterparty_allows_ripplingBoolean

If true it indicates that the counterparty allows pairwise rippling out through this trustline

Returns:

  • (Boolean)

437
# File 'lib/ripple-rest/generated-schemas.rb', line 437

property :counterparty_allows_rippling, :Boolean

#currencyString<Currency>

The code of the currency in which this trustline denotes trust

Returns:

  • (String<Currency>)

406
# File 'lib/ripple-rest/generated-schemas.rb', line 406

property :currency, :Currency

#hashString<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

Returns:

  • (String<Hash256>)

447
# File 'lib/ripple-rest/generated-schemas.rb', line 447

property :hash, :Hash256

#ledgerString

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

Returns:

  • (String)

    “^[0-9]$”+


442
# File 'lib/ripple-rest/generated-schemas.rb', line 442

property :ledger, [:String, "^[0-9]+$"]

#limitBigDecimal

The maximum value of the currency that the account may hold issued by the counterparty

Returns:

  • (BigDecimal)

411
# File 'lib/ripple-rest/generated-schemas.rb', line 411

property :limit, :FloatString

#previousTrustline

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

Returns:


452
# File 'lib/ripple-rest/generated-schemas.rb', line 452

property :previous, :Trustline

#reciprocated_limitBigDecimal

The maximum value of the currency that the counterparty may hold issued by the account

Returns:

  • (BigDecimal)

417
# File 'lib/ripple-rest/generated-schemas.rb', line 417

property :reciprocated_limit, :FloatString