Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Type parameters
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • Optional exemptedIds
  • Protected parent
  • Protected Abstract type
  • Methods
  • addRestriction
  • get
  • removeRestrictions
  • setRestrictions

Was this helpful?

  1. Classes

TransferRestrictionBase

PreviousTransactionQueueNextTransferRestrictions

Last updated 2 years ago

Was this helpful?

Base class for managing Transfer Restrictions

Type parameters

â–ª T:

Hierarchy

  • Namespace‹›

    ↳ TransferRestrictionBase

    ↳

    ↳

Index

Properties

Methods

Properties

Protected context

• context: Context

Inherited from void


Optional exemptedIds

• exemptedIds? : string[]

array of Scope/Identity IDs that are exempted from the Restriction


Protected parent

Inherited from void


Protected Abstract type

• type: T

Methods

addRestriction

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

Parameters:

Name
Type

args

opts?


get

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


removeRestrictions

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

Parameters:

Name
Type

opts?


setRestrictions

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

Parameters:

Name
Type

args

opts?

Defined in

Defined in

note if the Asset requires investor uniqueness, Scope IDs are used. Otherwise, we use Identity IDs. More on Scope IDs and investor uniqueness and

• parent:

Defined in

Defined in

▸ addRestriction(args: ‹T›, opts?: ): Promise‹‹BigNumber››

Defined in

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

‹T›

Returns: Promise‹‹BigNumber››

▸ get(): Promise‹‹T››

Defined in

Returns: Promise‹‹T››

▸ removeRestrictions(opts?: ): Promise‹‹BigNumber››

Defined in

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

Returns: Promise‹‹BigNumber››

▸ setRestrictions(args: ‹T›, opts?: ): Promise‹‹BigNumber››

Defined in

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

‹T›

Returns: Promise‹‹BigNumber››

src/api/entities/Namespace.ts:11
src/types/index.ts:1234
here
here
Asset
src/api/entities/Namespace.ts:9
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:59
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:126
ProcedureMethod
addRestriction.checkAuthorization
TransactionQueue
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:161
ProcedureOpts
TransactionQueue
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:150
NoArgsProcedureMethod
removeRestrictions.checkAuthorization
TransactionQueue
src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:138
ProcedureMethod
setRestrictions.checkAuthorization
TransactionQueue
TransferRestrictionType
Asset
CountTransferRestriction
PercentageTransferRestriction
context
exemptedIds
parent
type
addRestriction
get
removeRestrictions
setRestrictions
ProcedureOpts
ProcedureOpts
ProcedureOpts
ProcedureOpts
TransactionQueue
ProcedureOpts
TransactionQueue
AddRestrictionParams
GetReturnType
GetReturnType
SetRestrictionsParams
AddRestrictionParams
SetRestrictionsParams