Investment

Used to manage an Investment in a Security Token Offering

Hierarchy

• Entity‹Params›

  ↳ Investment

Index

Constructors

• constructor

Properties

• address

• index

• investedFunds

• securityTokenId

• securityTokenSymbol

• stoId

• tokenAmount

• uid

Methods

• _refresh
• toPojo
• generateId
• unserialize

Constructors

constructor

+ new Investment(params: Params & UniqueIdentifiers): Investment

Defined in src/entities/Investment.ts:103

Create an Investment instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers

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

Overrides Entity.uid

Defined in src/entities/Investment.ts:74

unique generated identifier for an Investment

Methods

_refresh

▸ _refresh(params: Partial‹Params›): void

Overrides Entity._refresh

Defined in src/entities/Investment.ts:165

Hydrate the entity

Parameters:

Name	Type
params	Partial‹Params›

Returns: void

toPojo

▸ toPojo(): object

Overrides Entity.toPojo

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

▸ 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
index	number
securityTokenId	string
stoId	string

Returns: string

Static unserialize

▸ unserialize(serialized: string): UniqueIdentifiers

Defined in src/entities/Investment.ts:58

Unserialize a serialized Investment entity

Parameters:

Name	Type	Description
serialized	string	string with Investment entity information

Returns: UniqueIdentifiers