Class: UserInformation

"UserInformation".UserInformation

The UserInformation class contains methods related to getting trustlines related information of a user.

Hierarchy

• UserInformation

Constructors

constructor

+ new UserInformation(params: { currencyNetwork: CurrencyNetwork ; provider: TLProvider ; user: User }): UserInformation

Defined in src/UserInformation.ts:28

Parameters:

Name	Type
params	{ currencyNetwork: CurrencyNetwork ; provider: TLProvider ; user: User }

Returns: UserInformation

Methods

getAccruedInterests

▸ getAccruedInterests(networkAddress: string, options?: { decimalsOptions?: DecimalsOptions ; timeWindowOption?: { endTime: number ; startTime: number } }): Promise<UserAccruedInterestsObject>

Defined in src/UserInformation.ts:74

Parameters:

Name	Type	Default value
networkAddress	string	-
options	{ decimalsOptions?: DecimalsOptions ; timeWindowOption?: { endTime: number ; startTime: number } }	{}

Returns: Promise<UserAccruedInterestsObject>

---

getAccruedInterestsOnTrustline

▸ getAccruedInterestsOnTrustline(networkAddress: string, counterpartyAddress: string, options?: { decimalsOptions?: DecimalsOptions ; timeWindowOption?: { endTime: number ; startTime: number } }): Promise<TrustlineAccruedInterestsObject>

Defined in src/UserInformation.ts:108

Parameters:

Name	Type	Default value
networkAddress	string	-
counterpartyAddress	string	-
options	{ decimalsOptions?: DecimalsOptions ; timeWindowOption?: { endTime: number ; startTime: number } }	{}

Returns: Promise<TrustlineAccruedInterestsObject>

---

getEarnedMediationFees

▸ getEarnedMediationFees(networkAddress: string, options?: { decimalsOptions?: DecimalsOptions ; timeWindowOption?: { endTime: number ; startTime: number } }): Promise<EarnedMediationFeesListObject>

Defined in src/UserInformation.ts:40

Parameters:

Name	Type	Default value
networkAddress	string	-
options	{ decimalsOptions?: DecimalsOptions ; timeWindowOption?: { endTime: number ; startTime: number } }	{}

Returns: Promise<EarnedMediationFeesListObject>