Tokenholder
Used to manage a Tokenholder
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
+ new Tokenholder(params: Params & UniqueIdentifiers): Tokenholder
Defined in src/entities/Tokenholder.ts:112
Create a new Tokenholder instance
Parameters:
Name
Type
params
Returns: Tokenholder
Properties
address
• address: string
Defined in src/entities/Tokenholder.ts:112
wallet address
balance
• balance: BigNumber
Defined in src/entities/Tokenholder.ts:107
total Security Token balance of the Tokenholder
canBuyFromSto
• canBuyFromSto: boolean
Defined in src/entities/Tokenholder.ts:102
whether the Tokenholder can purchase from an STO or not
canReceiveAfter
• canReceiveAfter: Date
Defined in src/entities/Tokenholder.ts:87
date after which a Tokenholder can transfer tokens to their address
canSendAfter
• canSendAfter: Date
Defined in src/entities/Tokenholder.ts:82
date after which a Tokenholder can transfer tokens from their address
isAccredited
• isAccredited: boolean
Defined in src/entities/Tokenholder.ts:97
whether the Tokenholder is accredited or not
kycExpiry
• kycExpiry: Date
Defined in src/entities/Tokenholder.ts:92
date when the Tokenholder's KYC will expire
securityTokenId
• securityTokenId: string
Defined in src/entities/Tokenholder.ts:77
securityTokenSymbol
• securityTokenSymbol: string
Defined in src/entities/Tokenholder.ts:75
uid
• uid: string
Defined in src/entities/Tokenholder.ts:73
unique generated id for a Tokenholder
Methods
_refresh
▸ _refresh(params: Partial‹Params›): void
Defined in src/entities/Tokenholder.ts:195
Hydrate the entity
Parameters:
Name
Type
params
Partial‹Params›
Returns: void
isRevoked
▸ isRevoked(): boolean
Defined in src/entities/Tokenholder.ts:150
Checks if this Tokenholder's KYC has been manually revoked
Returns: boolean
toPojo
▸ toPojo(): object
Defined in src/entities/Tokenholder.ts:164
Convert entity to a POJO (Plain Old Javascript Object)
Returns: object
address: string
balance: BigNumber
canBuyFromSto: boolean
canReceiveAfter: Date
canSendAfter: Date
isAccredited: boolean
kycExpiry: Date
securityTokenId: string
securityTokenSymbol: string
uid: string
Static generateId
Static generateId▸ generateId(__namedParameters: object): string
Defined in src/entities/Tokenholder.ts:45
Generate the Tokenholder's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Name
Type
address
string
securityTokenId
string
Returns: string
Static unserialize
Static unserialize▸ unserialize(serialized: string): UniqueIdentifiers
Defined in src/entities/Tokenholder.ts:57
Unserialize a serialized Tokenholder entity
Parameters:
Name
Type
Description
serialized
string
string with Tokenholder entity information
Returns: UniqueIdentifiers
Last updated
Was this helpful?