Investment
Used to manage an Investment in a Security Token Offering
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Investment(params
: Params & UniqueIdentifiers): Investment
Defined in src/entities/Investment.ts:103
Create an Investment instance
Parameters:
Name | Type |
|
Returns: Investment
Properties
address
• address: string
Defined in src/entities/Investment.ts:88
wallet address of token holder
index
• index: number
Defined in src/entities/Investment.ts:93
index of the Investment
investedFunds
• investedFunds: BigNumber
Defined in src/entities/Investment.ts:103
amount of funds used to make Investment
securityTokenId
• securityTokenId: string
Defined in src/entities/Investment.ts:76
securityTokenSymbol
• securityTokenSymbol: string
Defined in src/entities/Investment.ts:83
stoId
• stoId: string
Defined in src/entities/Investment.ts:81
unique ID for the Investment
tokenAmount
• tokenAmount: BigNumber
Defined in src/entities/Investment.ts:98
total amount of tokens involved in the Investment
uid
• uid: string
Defined in src/entities/Investment.ts:74
unique generated identifier for an Investment
Methods
_refresh
▸ _refresh(params
: Partial‹Params›): void
Defined in src/entities/Investment.ts:165
Hydrate the entity
Parameters:
Name | Type |
| Partial‹Params› |
Returns: void
toPojo
▸ toPojo(): object
Defined in src/entities/Investment.ts:138
Convert entity to a POJO (Plain Old Javascript Object)
Returns: object
address: string
index: number
investedFunds: BigNumber
securityTokenId: string
securityTokenSymbol: string
stoId: string
tokenAmount: BigNumber
uid: string
Static
generateId
Static
generateId▸ generateId(__namedParameters
: object): string
Defined in src/entities/Investment.ts:45
Generate the Investment's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Name | Type |
| number |
| string |
| string |
Returns: string
Static
unserialize
Static
unserialize▸ unserialize(serialized
: string): UniqueIdentifiers
Defined in src/entities/Investment.ts:58
Unserialize a serialized Investment entity
Parameters:
Name | Type | Description |
| string | string with Investment entity information |
Returns: UniqueIdentifiers
Last updated