Percentage

Handles all Percentage Transfer Restriction related functionality

Hierarchy

• TransferRestrictionBase‹Percentage›

  ↳ Percentage

Index

Properties

• addRestriction

• context

• get

• parent

• removeRestrictions

• setRestrictions

• type

Properties

addRestriction

• addRestriction: ProcedureMethod‹Omit‹AddPercentageTransferRestrictionParams, "type"›, number›

Overrides TransferRestrictionBase.addRestriction

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:31

Add a Percentage Transfer Restriction to this Security Token

param limit on the proportion of the total supply of this Security Token that can be held by a single investor at once

param array of Scope IDs that are exempted from the Restriction

param array of Identities (or DIDs) that are exempted from the Restriction

note the result is the total amount of restrictions after the procedure has run

note required role:

• Security Token Owner

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

get

• get: function

Overrides TransferRestrictionBase.get

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:65

Retrieve all active Percentage Transfer Restrictions

note there is a maximum number of restrictions allowed accross all types. The availableSlots property of the result represents how many more restrictions can be added before reaching that limit

Type declaration:

▸ (): Promise‹ActiveTransferRestrictions‹PercentageTransferRestriction››

Protected parent

• parent: SecurityToken

Inherited from void

Defined in src/api/entities/Namespace.ts:9

removeRestrictions

• removeRestrictions: ProcedureMethod‹void, number›

Overrides TransferRestrictionBase.removeRestrictions

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:56

Removes all Percentage Transfer Restrictions from this Security Token

note the result is the total amount of restrictions after the procedure has run

setRestrictions

• setRestrictions: ProcedureMethod‹Omit‹SetPercentageTransferRestrictionsParams, "type"›, number›

Overrides TransferRestrictionBase.setRestrictions

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:46

Sets all Percentage Transfer Restrictions on this Security Token

param array of Percentage Transfer Restrictions with their corresponding exemptions (if applicable)

note the result is the total amount of restrictions after the procedure has run

note required role:

• Security Token Owner

Protected type

• type: Percentage = TransferRestrictionType.Percentage as const

Overrides TransferRestrictionBase.type

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:17