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›
Defined in src/entities/SecurityToken/Tokenholders.ts:221
Retrieve the amount of wallets that ever held tokens or have any KYC data
Returns: Promise‹number›
Defined in src/entities/SecurityToken/Tokenholders.ts:59
Create a snapshot of the balances of every tokenholder at the current date
Defined in src/entities/SecurityToken/Tokenholders.ts:133
Retrieve a checkpoint from the security token by index or UUID
Parameters:
Name
Type
Description
args
checkpoint uuid or object containing its index
Defined in src/entities/SecurityToken/Tokenholders.ts:74
Retrieve list of checkpoints and their corresponding dividend distributions of every type
Defined in src/entities/SecurityToken/Tokenholders.ts:155
Get data for all tokenholders associated to the Security Token
▸ holderCount(): Promise‹number›
Defined in src/entities/SecurityToken/Tokenholders.ts:247
Retrieve the amount of wallets that currently hold tokens
Returns: Promise‹number›
Defined in src/entities/SecurityToken/Tokenholders.ts:31
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
Defined in src/entities/SecurityToken/Tokenholders.ts:45
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
▸ createCheckpoint(): Promise‹‹, ››
Returns: Promise‹‹, ››
▸ getCheckpoint(args: | string): Promise‹›
| string
Returns: Promise‹›
▸ getCheckpoints(): Promise‹[]›
Returns: Promise‹[]›
▸ getTokenholders(): Promise‹[]›
Returns: Promise‹[]›
▸ modifyData(args: object): Promise‹‹, []››
[]
Returns: Promise‹‹, []››
▸ revokeKyc(args: object): Promise‹‹, []››
Returns: Promise‹‹, []››