api.entities.Asset.TransferRestrictions.ClaimPercentage.ClaimPercentage

Class: ClaimPercentage

api/entities/Asset/TransferRestrictions/ClaimPercentage.ClaimPercentage

Handles all Claim Percentage Transfer Restriction related functionality

Hierarchy

• TransferRestrictionBase<ClaimPercentage>

  ↳ ClaimPercentage

Table of contents

Properties

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

Properties

addRestriction

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

Add a Percentage Transfer Restriction to this Asset. This can be used to limit the total amount of supply investors who share a ClaimType may hold. For example a restriction can be made so Canadian investors must hold at least 50% of the supply.

Throws

if the appropriately scoped Balance statistic (by ClaimType and issuer) is not enabled for this Asset. enableStat with appropriate arguments should be called before this method

Overrides

TransferRestrictionBase.addRestriction

Defined in

api/entities/Asset/TransferRestrictions/ClaimPercentage.ts:31

---

disableStat

• disableStat: ProcedureMethod<Omit<RemoveScopedBalanceParams, "type">, void, void>

Disables an 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

Throws

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

Overrides

TransferRestrictionBase.disableStat

Defined in

api/entities/Asset/TransferRestrictions/ClaimPercentage.ts:68

---

enableStat

• enableStat: ProcedureMethod<Omit<AddClaimPercentageStatParams, "type">, void, void>

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

Overrides

TransferRestrictionBase.enableStat

Defined in

api/entities/Asset/TransferRestrictions/ClaimPercentage.ts:60

---

get

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

Type declaration

▸ (): Promise<ActiveTransferRestrictions<ClaimPercentageTransferRestriction>>

Retrieve all active Claim 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<ClaimPercentageTransferRestriction>>

Overrides

TransferRestrictionBase.get

Defined in

api/entities/Asset/TransferRestrictions/ClaimPercentage.ts:77

---

removeRestrictions

• removeRestrictions: NoArgsProcedureMethod<BigNumber, BigNumber>

Removes all Claim 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/ClaimPercentage.ts:54

---

setRestrictions

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

Sets all Claim Percentage Transfer Restrictions on this Asset

Note

this method sets exempted Identities for restrictions as well. If an Identity is currently exempted from a Claim 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/ClaimPercentage.ts:44