Tokenholder
Last updated
Was this helpful?
Last updated
Was this helpful?
Used to manage a Tokenholder
‹›
↳ Tokenholder
Create a new Tokenholder instance
Parameters:
Name
Type
params
• address: string
wallet address
• balance: BigNumber
total Security Token balance of the Tokenholder
• canBuyFromSto: boolean
whether the Tokenholder can purchase from an STO or not
• canReceiveAfter: Date
date after which a Tokenholder can transfer tokens to their address
• canSendAfter: Date
date after which a Tokenholder can transfer tokens from their address
• isAccredited: boolean
whether the Tokenholder is accredited or not
• kycExpiry: Date
date when the Tokenholder's KYC will expire
• securityTokenId: string
• securityTokenSymbol: string
• uid: string
unique generated id for a Tokenholder
Hydrate the entity
Parameters:
Name
Type
params
Returns: void
▸ isRevoked(): boolean
Checks if this Tokenholder's KYC has been manually revoked
Returns: boolean
▸ toPojo(): object
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▸ generateId(__namedParameters: object): string
Generate the Tokenholder's UUID from its identifying properties
Parameters:
▪ __namedParameters: object
Name
Type
address
string
securityTokenId
string
Returns: string
Static unserializeUnserialize a serialized Tokenholder entity
Parameters:
Name
Type
Description
serialized
string
string with Tokenholder entity information
+ new Tokenholder(params: & ):
Defined in
&
Returns:
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Defined in
Overrides .
Defined in
▸ _refresh(params: Partial‹›): void
Overrides .
Defined in
Partial‹›
Defined in
Overrides .
Defined in
Defined in
▸ unserialize(serialized: string):
Defined in
Returns: