Tokenholders

Namespace that handles all Tokenholder related functionality

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Tokenholders(securityToken: SecurityToken, context: Context): Tokenholders

Inherited from SubModule.constructor

Defined in src/entities/SecurityToken/SubModule.ts:10

Create a new SubModule instance

Parameters:

Name

Type

securityToken

context

Returns: Tokenholders

Properties

Protected context

context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

Protected securityToken

securityToken: SecurityToken

Inherited from SubModule.securityToken

Defined in src/entities/SecurityToken/SubModule.ts:8

Methods

allTimeInvestorCount

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›

createCheckpoint

createCheckpoint(): Promise‹TransactionQueueCreateCheckpointProcedureArgs, Checkpoint››

Defined in src/entities/SecurityToken/Tokenholders.ts:59

Create a snapshot of the balances of every tokenholder at the current date

Returns: Promise‹TransactionQueueCreateCheckpointProcedureArgs, Checkpoint››

getCheckpoint

getCheckpoint(args: GetCheckpointParams | string): Promise‹Checkpoint

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

Returns: Promise‹Checkpoint

getCheckpoints

getCheckpoints(): Promise‹Checkpoint[]›

Defined in src/entities/SecurityToken/Tokenholders.ts:74

Retrieve list of checkpoints and their corresponding dividend distributions of every type

Returns: Promise‹Checkpoint[]›

getTokenholders

getTokenholders(): Promise‹Tokenholder[]›

Defined in src/entities/SecurityToken/Tokenholders.ts:155

Get data for all tokenholders associated to the Security Token

Returns: Promise‹Tokenholder[]›

holderCount

holderCount(): Promise‹number›

Defined in src/entities/SecurityToken/Tokenholders.ts:247

Retrieve the amount of wallets that currently hold tokens

Returns: Promise‹number›

modifyData

modifyData(args: object): Promise‹TransactionQueueModifyTokenholderDataProcedureArgs, Tokenholder[]››

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

Returns: Promise‹TransactionQueueModifyTokenholderDataProcedureArgs, Tokenholder[]››

revokeKyc

revokeKyc(args: object): Promise‹TransactionQueueRevokeKycProcedureArgs, Tokenholder[]››

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[]

Returns: Promise‹TransactionQueueRevokeKycProcedureArgs, Tokenholder[]››

Last updated