Class: Client

Client

The Sequence API Client object is the root object for all API interactions. To interact with Sequence, a Client object must always be instantiated first.


new Client(opts)

constructor - create a new Chain client object capable of interacting with the specified ledger.

Passing a configuration object is the preferred way of calling this constructor.

Parameters:
Name Type Description
opts Object

Plain JS object containing configuration options.

Properties
Name Type Argument Description
ledgerName String

Ledger name.

credential String

API credential secret.

agent https.Agent <optional>

optional, passed to Connection class.

Members


accounts :module:AccountsApi

API actions for accounts

Type:

actions :module:ActionsApi

API actions for actions

Type:

connection :Client

The client's connection to Sequence

Type:

devUtils :module:DevUtilsApi

Development-only API actions.

Type:

feeds :module:FeedsApi

API actions for feeds.

Type:

flavors :module:FlavorsApi

API actions for flavors.

Type:

keys :module:KeysAPI

API actions for keys.

Type:
  • module:KeysAPI

stats :module:StatsApi

API actions for stats.

Type:

tokens :module:TokensApi

API actions for tokens.

Type:

transactions :module:TransactionsApi

API actions for transactions.

Type:

Methods


request(path [, body])

Submit a request to the stored Sequence connection.

Parameters:
Name Type Argument Default Description
path String
body object <optional>
{}
Returns:
Type
Promise