Version: 0.13.7

Class: TLNetwork

"TLNetwork".TLNetwork

The TLNetwork class is the single entry-point into the trustlines-clientlib. It contains all of the library's functionality and all calls to the library should be made through a TLNetwork instance.

Hierarchy#

  • TLNetwork

Constructors#

constructor#

+ new TLNetwork(config?: TLNetworkConfig): TLNetwork

Defined in src/TLNetwork.ts:130

Initiates a new TLNetwork instance that provides the public interface to trustlines-clientlib.

Parameters:#

NameTypeDefault valueDescription
configTLNetworkConfig{}Configuration object. See TLNetworkConfig for more information.

Returns: TLNetwork

Properties#

currencyNetwork#

currencyNetwork: CurrencyNetwork

Defined in src/TLNetwork.ts:83

CurrencyNetwork instance containing all methods for retrieving currency network related information.


event#

event: Event

Defined in src/TLNetwork.ts:87

Event instance for retrieving and formatting event logs.


payment#

payment: Payment

Defined in src/TLNetwork.ts:74

Payment instance containing all methods for creating trustline transfers and TLC transfers.


trustline#

trustline: Trustline

Defined in src/TLNetwork.ts:78

Trustline instance containing all methods for managing trustlines.


user#

user: User

Defined in src/TLNetwork.ts:69

User instance containing all user/keystore related methods.