api.entities.Asset.TransferRestrictions.Percentage.Percentage

Class: Percentage

api/entities/Asset/TransferRestrictions/Percentage.Percentage

Handles all Percentage Transfer Restriction related functionality

Hierarchy

• TransferRestrictionBase<Percentage>

  ↳ Percentage

Table of contents

Properties

• addRestriction
• disableStat
• enableStat
• get
• removeRestrictions
• setRestrictions

Properties

addRestriction

• addRestriction: ProcedureMethod<Omit<AddPercentageTransferRestrictionParams, "type">, BigNumber, BigNumber>

Add a Percentage Transfer Restriction to this Asset. This limits the total percentage of the supply a single investor can acquire without an exemption

Throws

if the Balance statistic is not enabled for this Asset. enableStat should be called before this method

Overrides

TransferRestrictionBase.addRestriction

Defined in

api/entities/Asset/TransferRestrictions/Percentage.ts:28

---

disableStat

• disableStat: NoArgsProcedureMethod<void, void>

Disables the investor balance statistic for the Asset. Since statistics introduce slight overhead to each transaction involving the Asset, disabling unused stats will reduce gas fees for investors when they transact with the Asset

Throws

if the stat is being used by a restriction or is not set

Overrides

TransferRestrictionBase.disableStat

Defined in

api/entities/Asset/TransferRestrictions/Percentage.ts:65

---

enableStat

• enableStat: NoArgsProcedureMethod<void, void>

Enables investor balance statistic for the Asset, which is required before creating restrictions that limit the total ownership of the Assets' supply

Overrides

TransferRestrictionBase.enableStat

Defined in

api/entities/Asset/TransferRestrictions/Percentage.ts:57

---

get

• get: () => Promise<ActiveTransferRestrictions<PercentageTransferRestriction>>

Type declaration

▸ (): Promise<ActiveTransferRestrictions<PercentageTransferRestriction>>

Retrieve all active Percentage Transfer Restrictions

Note

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

Returns

Promise<ActiveTransferRestrictions<PercentageTransferRestriction>>

Overrides

TransferRestrictionBase.get

Defined in

api/entities/Asset/TransferRestrictions/Percentage.ts:74

---

removeRestrictions

• removeRestrictions: NoArgsProcedureMethod<BigNumber, BigNumber>

Removes all Percentage Transfer Restrictions from this Asset

Note

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

Overrides

TransferRestrictionBase.removeRestrictions

Defined in

api/entities/Asset/TransferRestrictions/Percentage.ts:51

---

setRestrictions

• setRestrictions: ProcedureMethod<Omit<SetPercentageTransferRestrictionsParams, "type">, BigNumber, BigNumber>

Sets all Percentage Transfer Restrictions on this Asset

Note

this method sets exempted Identities for restrictions as well. If an Identity is currently exempted from a Percentage Transfer Restriction but not passed into this call then it will be removed

Note

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

Overrides

TransferRestrictionBase.setRestrictions

Defined in

api/entities/Asset/TransferRestrictions/Percentage.ts:41