api.entities.Asset.TransferRestrictions.TransferRestrictionBase.TransferRestrictionBase

Class: TransferRestrictionBase<T>

api/entities/Asset/TransferRestrictions/TransferRestrictionBase.TransferRestrictionBase

Base class for managing Transfer Restrictions

Type parameters

Name	Type
T	extends TransferRestrictionType

Hierarchy

• Namespace<Asset>

  ↳ TransferRestrictionBase

  ↳↳ Count

  ↳↳ Percentage

Table of contents

Methods

• addRestriction
• get
• removeRestrictions
• setRestrictions

Methods

addRestriction

▸ addRestriction(args, opts?): Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>

Add a Transfer Restriction of the corresponding type to this Asset

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 signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
args	AddRestrictionParams<T>
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>

Defined in

api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:128

---

get

▸ get(): Promise<GetReturnType<T>>

Retrieve all active Transfer Restrictions of the corresponding type

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<GetReturnType<T>>

Defined in

api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:163

---

removeRestrictions

▸ removeRestrictions(opts?): Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>

Removes all Transfer Restrictions of the corresponding type from this Asset

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

note this method is of type NoArgsProcedureMethod, which means you can call removeRestrictions.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>

Defined in

api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:152

---

setRestrictions

▸ setRestrictions(args, opts?): Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>

Sets all Transfer Restrictions of the corresponding type on this Asset

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 signing Account and Identity have the required roles and permissions to run it

Parameters

Name	Type
args	SetRestrictionsParams<T>
opts?	ProcedureOpts

Returns

Promise<TransactionQueue<BigNumber, BigNumber, unknown[][]>>

Defined in

api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:140