HorizonServer

HorizonServer

Facilitates interaction with a Horizon server instance.

Constructor

new HorizonServer(sdk, serverUrl, opts)

Create a new Horizon instance.

Source:
Parameters:
Name Type Description
sdk ShelfNetwork

Parent SDK instance.
serverUrl string

Horizon server instance URL.
opts Object
Name Type Attributes Description
allowHttp boolean <optional>

Allow connecting to http servers, default: false. This must be set to false in production deployments!
proxy Object <optional>

Proxy configuration. Look axios docs for more info
httpBasicAuth Object <optional>

HTTP basic auth credentials. Look axios docs for more info.
customHeaders Object <optional>

Custom headers for request.
withCredentials boolean <optional>

Indicates whether or not cross-site Access-Control requests should be made using credentials.

Members

account

Account details.

Source:

deposits

Deposits management.

Source:

enums

Enums.

Source:

lots

Lots.

Source:

messages

Messages.

Source:

participants

Participants.

Source:

reviewableRequests

ReviewableRequests.

Source:

transactions

Transactions.

Source:

Methods

convertCurrency(query) → {JsonApiResponse}

Convert currency.

Source:
Parameters:
Name Type Description
query object

Request options.

Name Type Description
from string

From currency.
to string

To currency.
amount Number

Ampount.
Returns:
Type:
JsonApiResponse

Network details.

convertCurrencyBulk(paris) → {JsonApiResponse}

Convert multiple amounts.

Source:
Parameters:
Name Type Description
paris Array.<object>

Array of currency paris for convertation.

Name Type Description
from string

From currency.
to string

To currency.
amount Number

Amount.
Returns:
Type:
JsonApiResponse

Network details.

getNetworkDetails() → {JsonApiResponse}

Get network details.

Source:
Returns:
Type:
JsonApiResponse

Network details.

migrateLegacyAccount(email, password, platformIdopt) → {JsonApiResponse}

Migrate a legacy cardeal account.

Source:
Parameters:
Name Type Attributes Default Description
email string

Email.
password string

Password.
platformId string <optional>
 null

User's platform ID.
Returns:
Type:
JsonApiResponse