PercentageRestrictions

Namespace that handles all Percentage Restriction related functionality

Hierarchy

• SubModule

  ↳ PercentageRestrictions

Index

Constructors

• constructor

Properties

• context

• securityToken

Methods

• getExemptions

• getMaxHolderPercentage

• modifyExemptions

• modifyMaxHolderPercentage

Constructors

constructor

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

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: PercentageRestrictions

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

getExemptions

▸ getExemptions(): Promise‹object›

Defined in src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:66

Retrieve all exemptions that currently apply to percentage restrictions. That includes the whitelist and whether primary issuance (minting) is allowed to bypass percentage ownership restrictions

Can be modified with modifyPercentageExemptions

Returns: Promise‹object›

getMaxHolderPercentage

▸ getMaxHolderPercentage(): Promise‹BigNumber›

Defined in src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:139

Retrieve the maximum percentage of the total supply that a single tokenholder can own Can be modified with modifyMaxHolderPercentage

Returns: Promise‹BigNumber›

modifyExemptions

▸ modifyExemptions(args: object): Promise‹TransactionQueue‹ModifyPercentageExemptionsProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:47

Modify the conditions for exemption from percentage ownership restrictions. There are two (independent) methods of exemption:

• Whitelisting: an address can be whitelisted and thus percentage ownership restrictions will not apply to it

• Primary issuance: if enabled, issuing tokens to an address will bypass percentage ownership restrictions (for example, if issuing tokens to a particular address would leave that address with a higher percentage than the limit, having this option set to true will allow that issuance operation)

Parameters:

▪ args: object

Name	Type
allowPrimaryIssuance?	undefined | false | true
whitelistEntries?	PercentageWhitelistEntry[]

Returns: Promise‹TransactionQueue‹ModifyPercentageExemptionsProcedureArgs, void››

modifyMaxHolderPercentage

▸ modifyMaxHolderPercentage(args: object): Promise‹TransactionQueue‹ModifyMaxHolderPercentageProcedureArgs, void››

Defined in src/entities/SecurityToken/Transfers/Restrictions/PercentageRestrictions.ts:124

Modify the maximum percentage of the total supply that a single tokenholder can own at a given time

Parameters:

▪ args: object

Name	Type
maxHolderPercentage	BigNumber

Returns: Promise‹TransactionQueue‹ModifyMaxHolderPercentageProcedureArgs, void››