Server

Server

Server handles the network connection to a Horizon instance and exposes an interface for requests to that instance.

Constructor

new Server(serverURL, optsopt)

Source:
Parameters:
Name Type Attributes Description
serverURL string

Horizon Server URL (ex. https://horizon-testnet.stellar.org).

opts object <optional>

Options object

Name Type Attributes Description
allowHttp boolean <optional>

Allow connecting to http servers, default: false. This must be set to false in production deployments! You can also use Config class to set this globally.

Methods

accounts() → {AccountCallBuilder}

Source:
Returns:
Type:
AccountCallBuilder

New AccountCallBuilder object configured by a current Horizon server configuration.

assets() → {AssetsCallBuilder}

Get a new AssetsCallBuilder instance configured with the current Horizon server configuration.

Source:
Returns:
Type:
AssetsCallBuilder

New AssetsCallBuilder instance

effects() → {EffectCallBuilder}

Source:
Returns:
Type:
EffectCallBuilder

New EffectCallBuilder instance configured with the current Horizon server configuration

ledgers() → {LedgerCallBuilder}

Source:
Returns:
Type:
LedgerCallBuilder

New LedgerCallBuilder object configured by a current Horizon server configuration.

loadAccount(accountId) → {Promise}

Fetches an account's most current state in the ledger and then creates and returns an Account object.

Source:
Parameters:
Name Type Description
accountId string

The account to load.

Returns:
Type:
Promise

Returns a promise to the AccountResponse object with populated sequence number.

offers(resource, …resourceParams) → {OfferCallBuilder}

People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the offers a particular account makes. Currently this method only supports querying offers for account and should be used like this:

server.offers('accounts', accountId).call()
 .then(function(offers) {
   console.log(offers);
 });
Source:
Parameters:
Name Type Attributes Description
resource string

Resource to query offers

resourceParams string <repeatable>

Parameters for selected resource

Returns:
Type:
OfferCallBuilder

New OfferCallBuilder object

operations() → {OperationCallBuilder}

Source:
Returns:
Type:
OperationCallBuilder

New OperationCallBuilder object configured by a current Horizon server configuration.

orderbook(selling, buying) → {OrderbookCallBuilder}

Source:
Parameters:
Name Type Description
selling Asset

Asset being sold

buying Asset

Asset being bought

Returns:
Type:
OrderbookCallBuilder

New OrderbookCallBuilder object configured by a current Horizon server configuration.

paths(source, destination, destinationAsset, destinationAmount) → {PathCallBuilder}

The Stellar Network allows payments to be made between assets through path payments. A path payment specifies a series of assets to route a payment through, from source asset (the asset debited from the payer) to destination asset (the asset credited to the payee).

A path search is specified using:

  • The destination address
  • The source address
  • The asset and amount that the destination account should receive

As part of the search, horizon will load a list of assets available to the source address and will find any payment paths from those source assets to the desired destination asset. The search's amount parameter will be used to determine if there a given path can satisfy a payment of the desired amount.

Source:
Parameters:
Name Type Description
source string

The sender's account ID. Any returned path will use a source that the sender can hold.

destination string

The destination account ID that any returned path should use.

destinationAsset Asset

The destination asset.

destinationAmount string

The amount, denominated in the destination asset, that any returned path should be able to satisfy.

Returns:
Type:
PathCallBuilder

New PathCallBuilder object configured with the current Horizon server configuration.

payments() → {PaymentCallBuilder}

Source:
Returns:
Type:
PaymentCallBuilder

New PaymentCallBuilder instance configured with the current Horizon server configuration.

submitTransaction(transaction) → {Promise}

Submits a transaction to the network.

Source:
See:
Parameters:
Name Type Description
transaction Transaction

The transaction to submit.

Returns:
Type:
Promise

Promise that resolves or rejects with response from horizon.

tradeAggregation(base, counter, start_time, end_time, resolution, offset) → {TradeAggregationCallBuilder}

Source:
Parameters:
Name Type Description
base Asset

base aseet

counter Asset

counter asset

start_time long

lower time boundary represented as millis since epoch

end_time long

upper time boundary represented as millis since epoch

resolution long

segment duration as millis since epoch. *Supported values are 5 minutes (300000), 15 minutes (900000), 1 hour (3600000), 1 day (86400000) and 1 week (604800000).

offset long

segments can be offset using this parameter. Expressed in milliseconds. *Can only be used if the resolution is greater than 1 hour. Value must be in whole hours, less than the provided resolution, and less than 24 hours. Returns new TradeAggregationCallBuilder object configured with the current Horizon server configuration.

Returns:
Type:
TradeAggregationCallBuilder

New TradeAggregationCallBuilder instance

trades() → {TradesCallBuilder}

Returns

Source:
Returns:
Type:
TradesCallBuilder

New TradesCallBuilder object configured by a current Horizon server configuration.

transactions() → {TransactionCallBuilder}

Source:
Returns:
Type:
TransactionCallBuilder

New TransactionCallBuilder object configured by a current Horizon server configuration.