CountRestrictions

Namespace that handles all Count Restriction related functionality

Hierarchy

• SubModule

  ↳ CountRestrictions

Index

Constructors

• constructor

Properties

• context

• securityToken

Methods

• getMaxHolderCount

• modifyMaxHolderCount

Constructors

constructor

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

Inherited from SubModule.constructor

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

Create a new SubModule instance

Parameters:

Name	Type
securityToken	SecurityToken
context	Context

Returns: CountRestrictions

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

getMaxHolderCount

▸ getMaxHolderCount(): Promise‹number›

Defined in src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:31

Retrieve the maximum amonut of tokenholders allowed to hold the token at once Can be modified with modifyMaxHolderCount

Returns: Promise‹number›

modifyMaxHolderCount

▸ modifyMaxHolderCount(args: object): Promise‹TransactionQueue‹ModifyMaxHolderCountProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Restrictions/CountRestrictions.ts:16

Modify the maximum amount of tokenholders allowed to hold the token at once

Parameters:

▪ args: object

Name	Type
maxHolderCount	number

Returns: Promise‹TransactionQueue‹ModifyMaxHolderCountProcedureArgs, void››