Class SubscribeBase
base subscribe / unsubscribe request fields
Namespace: Xrpl.Models.Methods
Assembly: Xrpl.dll
Syntax
public class SubscribeBase : RippleRequest
Properties
| Improve this Doc View SourceAccounts
(Optional) Array with the unique addresses of accounts to monitor for validated transactions. The addresses must be in the XRP Ledger's base58 format. The server sends a notification for any transaction that affects at least one of these accounts
Declaration
public List<string> Accounts { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
AccountsProposed
(Optional) Like accounts, but include transactions that are not yet finalized.
Declaration
public List<string> AccountsProposed { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
Books
(Optional) Array of objects defining order books to monitor for updates.
Declaration
public List<SubscribeBook> Books { get; set; }
Property Value
Type | Description |
---|---|
List<SubscribeBook> |
Streams
(Optional) Array of string names of generic streams to subscribe to, as explained below
Declaration
public List<string> Streams { get; set; }
Property Value
Type | Description |
---|---|
List<System.String> |
Remarks
consensus | Sends a message whenever the server changes phase in the consensus cycle (open, establish, accepted, and so forth) |
ledger | Sends a message whenever the consensus process declares a new validated ledger |
manifests | Sends a message whenever the server receives an update to a validator's ephemeral signing key. |
peer_status | (Admin only) Information about connected peer rippled servers, especially with regards to the consensus process. |
transactions | Sends a message whenever a transaction is included in a closed ledger |
transactions_proposed | Sends a message whenever a transaction is included in a closed ledger, as well as some transactions that have not yet been included in a validated ledger and may never be. Not all proposed transactions appear before validation. Note: Even some transactions that don't succeed are included in validated ledgers, because they take the anti-spam transaction fee. |
server | Sends a message whenever the status of the rippled server (for example, network connectivity) changes |
validations | Sends a message whenever the server receives a validation message, regardless of if the server trusts the validator. (An individual rippled declares a ledger validated when the server receives validation messages from at least a quorum of trusted validators.) |