Percentage
Handles all Percentage Transfer Restriction related functionality

Hierarchy

Percentage

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from void

get

get: function
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:

Protected parent

parent: SecurityToken
Inherited from void

Protected type

type: Percentage = TransferRestrictionType.Percentage as const

Methods

addRestriction

addRestriction(args: Omit‹AddPercentageTransferRestrictionParams, "type"›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››
Add a Percentage Transfer Restriction to this Security Token
note the result is the total amount of restrictions after the procedure has run
note this method is of type ProcedureMethod, which means you can call addRestriction.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹number››

removeRestrictions

removeRestrictions(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››
Removes all Percentage Transfer Restrictions from this Security Token
note the result is the total amount of restrictions after the procedure has run
note this method is of type ProcedureMethod, which means you can call removeRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹number››

setRestrictions

setRestrictions(args: Omit‹SetPercentageTransferRestrictionsParams, "type"›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››
Sets all Percentage Transfer Restrictions on this Security Token
note the result is the total amount of restrictions after the procedure has run
note this method is of type ProcedureMethod, which means you can call setRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
opts?
Returns: Promise‹TransactionQueue‹number››
Last modified 26d ago