lib-base.usertrove

Home > @mosaic/lib-base > UserTrove

UserTrove class

A Trove that is associated with a single owner.

Signature:

export declare class UserTrove extends Trove 

Extends: Trove

Remarks

The SDK uses the base Trove class as a generic container of collateral and debt, for example to represent the total collateral and debt locked up in the protocol.

The UserTrove class extends Trove with extra information that's only available for Troves that are associated with a single owner (such as the owner's address, or the Trove's status).

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the UserTrove class.

Properties

Property	Modifiers	Type	Description
ownerAddress		string	Address that owns this Trove.
status		UserTroveStatus	Provides more information when the UserTrove is empty.

Methods

Method	Modifiers	Description
equals(that)