Tokenholders
Last updated
Was this helpful?
Last updated
Was this helpful?
Namespace that handles all Tokenholder related functionality
↳ Tokenholders
Create a new SubModule instance
Parameters:
Name
Type
securityToken
context
Protected contextProtected securityToken▸ allTimeInvestorCount(): Promise‹number›
Retrieve the amount of wallets that ever held tokens or have any KYC data
Returns: Promise‹number›
Create a snapshot of the balances of every tokenholder at the current date
Retrieve a checkpoint from the security token by index or UUID
Parameters:
Name
Type
Description
args
checkpoint uuid or object containing its index
Retrieve list of checkpoints and their corresponding dividend distributions of every type
Get data for all tokenholders associated to the Security Token
▸ holderCount(): Promise‹number›
Retrieve the amount of wallets that currently hold tokens
Returns: Promise‹number›
Add/modify investor data. For an investor to be able to hold, sell or purchase tokens, his address (and other KYC data) must be added/modified via this method
Parameters:
â–ª args: object
Name
Type
tokenholderData
Revoke KYC for a group of tokenholder addresses. Supplied addresses must have valid KYC
Parameters:
â–ª args: object
Name
Type
tokenholderAddresses
string[]
+ new Tokenholders(securityToken: , context: ):
Inherited from .
Defined in
Returns:
• context:
Inherited from .
Defined in
• securityToken:
Inherited from .
Defined in
Defined in
▸ createCheckpoint(): Promise‹‹, ››
Defined in
Returns: Promise‹‹, ››
▸ getCheckpoint(args: | string): Promise‹›
Defined in
| string
Returns: Promise‹›
▸ getCheckpoints(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getTokenholders(): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ modifyData(args: object): Promise‹‹, []››
Defined in
[]
Returns: Promise‹‹, []››
▸ revokeKyc(args: object): Promise‹‹, []››
Defined in
Returns: Promise‹‹, []››