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)

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

TODO: Solve URI(this.serverURL as any).

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.

appName string <optional>

Allow set custom header X-App-Name, default: undefined.

appVersion string <optional>

Allow set custom header X-App-Version, default: undefined.

authToken string <optional>

Allow set custom header X-Auth-Token, default: undefined.

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

(async) checkMemoRequired(transaction) → {Promise.<void, Error>}

Check if any of the destination accounts requires a memo.

This function implements a memo required check as defined in SEP0029. It will load each account which is the destination and check if it has the data field config.memo_required set to "MQ==".

Each account is checked sequentially instead of loading multiple accounts at the same time from Horizon.

Source:
See:
Parameters:
Name Type Description
transaction Transaction

The transaction to check.

Returns:
Type:
Promise.<void, Error>

claimableBalances() → {ClaimableBalanceCallBuilder}

Source:
Returns:
Type:
ClaimableBalanceCallBuilder

New ClaimableBalanceCallBuilder object configured by a current Horizon server configuration.

effects() → {EffectCallBuilder}

Source:
Returns:
Type:
EffectCallBuilder

New EffectCallBuilder instance configured with the current Horizon server configuration

(async) feeStats() → {Promise.<Horizon.FeeStatsResponse>}

Fetch the fee stats endpoint.

Source:
See:
Returns:
Type:
Promise.<Horizon.FeeStatsResponse>

Promise that resolves to the fee stats returned by Horizon.

(async) fetchBaseFee() → {Promise.<number>}

Fetch the base fee. Since this hits the server, if the server call fails, you might get an error. You should be prepared to use a default value if that happens!

Source:
Returns:
Type:
Promise.<number>

Promise that resolves to the base fee.

(async) fetchTimebounds(seconds, _isRetryopt) → {Promise.<Timebounds>}

Get timebounds for N seconds from now, when you're creating a transaction with TransactionBuilder.

By default, TransactionBuilder uses the current local time, but your machine's local time could be different from Horizon's. This gives you more assurance that your timebounds will reflect what you want.

Note that this will generate your timebounds when you init the transaction, not when you build or submit the transaction! So give yourself enough time to get the transaction built and signed before submitting.

Example:

const transaction = new StellarSdk.TransactionBuilder(accountId, {
 fee: await StellarSdk.Server.fetchBaseFee(),
 timebounds: await StellarSdk.Server.fetchTimebounds(100)
})
 .addOperation(operation)
 // normally we would need to call setTimeout here, but setting timebounds
 // earlier does the trick!
 .build();
Source:
Parameters:
Name Type Attributes Default Description
seconds number

Number of seconds past the current time to wait.

_isRetry bool <optional>
false

True if this is a retry. Only set this internally! This is to avoid a scenario where Horizon is horking up the wrong date.

Returns:
Type:
Promise.<Timebounds>

Promise that resolves a timebounds object (with the shape { minTime: 0, maxTime: N }) that you can set the timebounds option to.

ledgers() → {LedgerCallBuilder}

Source:
Returns:
Type:
LedgerCallBuilder

New LedgerCallBuilder object configured by a current Horizon server configuration.

liquidityPools() → {LiquidityPoolCallBuilder}

Source:
Returns:
Type:
LiquidityPoolCallBuilder

New LiquidityPoolCallBuilder object configured to the current Horizon server settings.

(async) loadAccount(accountId) → {Promise}

Fetches an account's most current state in the ledger, then creates and returns an AccountResponse 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() → {OfferCallBuilder}

People on the Stellar network can make offers to buy or sell assets. This endpoint represents all the offers on the DEX.

You can query all offers for account using the function .accountId:

server.offers()
 .forAccount(accountId).call()
 .then(function(offers) {
   console.log(offers);
 });
Source:
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.

payments() → {PaymentCallBuilder}

Source:
Returns:
Type:
PaymentCallBuilder

New PaymentCallBuilder instance configured with the current Horizon server configuration.

strictReceivePaths(source, destinationAsset, destinationAmount) → {StrictReceivePathCallBuilder}

The Stellar Network allows payments to be made between assets through path payments. A strict receive 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 strict receive path search is specified using:

  • The destination address.
  • The source address or source assets.
  • 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.

If a list of assets is passed as the source, horizon will find any payment paths from those source assets to the desired destination asset.

Source:
Parameters:
Name Type Description
source string | Array.<Asset>

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

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:
StrictReceivePathCallBuilder

New StrictReceivePathCallBuilder object configured with the current Horizon server configuration.

strictSendPaths(sourceAsset, sourceAmount, destination) → {StrictSendPathCallBuilder}

The Stellar Network allows payments to be made between assets through path payments. A strict send 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 strict send path search is specified using:

The asset and amount that is being sent. The destination account or the destination assets.

Source:
Parameters:
Name Type Description
sourceAsset Asset

The asset to be sent.

sourceAmount string

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

destination string | Array.<Asset>

The destination account or the destination assets.

Returns:
Type:
StrictSendPathCallBuilder

New StrictSendPathCallBuilder object configured with the current Horizon server configuration.

(async) submitTransaction(transaction, optsopt) → {Promise}

Submits a transaction to the network.

By default this function calls Server#checkMemoRequired, you can skip this check by setting the option skipMemoRequiredCheck to true.

If you submit any number of manageOffer operations, this will add an attribute to the response that will help you analyze what happened with your offers.

Ex:

const res = {
  ...response,
  offerResults: [
    {
      // Exact ordered list of offers that executed, with the exception
      // that the last one may not have executed entirely.
      offersClaimed: [
        sellerId: String,
        offerId: String,
        assetSold: {
          type: 'native|credit_alphanum4|credit_alphanum12',

          // these are only present if the asset is not native
          assetCode: String,
          issuer: String,
        },

        // same shape as assetSold
        assetBought: {}
      ],

      // What effect your manageOffer op had
      effect: "manageOfferCreated|manageOfferUpdated|manageOfferDeleted",

      // Whether your offer immediately got matched and filled
      wasImmediatelyFilled: Boolean,

      // Whether your offer immediately got deleted, if for example the order was too small
      wasImmediatelyDeleted: Boolean,

      // Whether the offer was partially, but not completely, filled
      wasPartiallyFilled: Boolean,

      // The full requested amount of the offer is open for matching
      isFullyOpen: Boolean,

      // The total amount of tokens bought / sold during transaction execution
      amountBought: Number,
      amountSold: Number,

      // if the offer was created, updated, or partially filled, this is
      // the outstanding offer
      currentOffer: {
        offerId: String,
        amount: String,
        price: {
          n: String,
          d: String,
        },

        selling: {
          type: 'native|credit_alphanum4|credit_alphanum12',

          // these are only present if the asset is not native
          assetCode: String,
          issuer: String,
        },

        // same as `selling`
        buying: {},
      },

      // the index of this particular operation in the op stack
      operationIndex: Number
    }
  ]
}

For example, you'll want to examine offerResults to add affordances like these to your app:

  • If wasImmediatelyFilled is true, then no offer was created. So if you normally watch the Server.offers endpoint for offer updates, you instead need to check Server.trades to find the result of this filled offer.
  • If wasImmediatelyDeleted is true, then the offer you submitted was deleted without reaching the orderbook or being matched (possibly because your amounts were rounded down to zero). So treat the just-submitted offer request as if it never happened.
  • If wasPartiallyFilled is true, you can tell the user that amountBought or amountSold have already been transferred.
Source:
See:
Parameters:
Name Type Attributes Description
transaction Transaction | FeeBumpTransaction

The transaction to submit.

opts object <optional>

Options object

Name Type Attributes Description
skipMemoRequiredCheck boolean <optional>

Allow skipping memo required check, default: false. See SEP0029.

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 asset

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.