Polymesh SDK API Reference
v5.0.0
v5.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyXParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Type parameters
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • addRestriction
  • Protected context
  • Optional exemptedScopeIds
  • Protected parent
  • removeRestrictions
  • setRestrictions
  • Protected Abstract type
  • Methods
  • get

Was this helpful?

  1. Classes

TransferRestrictionBase

PreviousTransactionQueueNextTransferRestrictions

Last updated 4 years ago

Was this helpful?

Base class for managing Transfer Restrictions

Type parameters

▪ T:

Hierarchy

  • Namespace‹›

    ↳ TransferRestrictionBase

    ↳

    ↳

Index

Properties

Methods

Properties

addRestriction

Add a Transfer Restriction of the corresponding type to this Security Token

param array of Scope IDs that are exempted from the Restriction

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

note required role:

  • Security Token Owner

Protected context

Inherited from void

Optional exemptedScopeIds

• exemptedScopeIds? : string[]

Protected parent

Inherited from void

removeRestrictions

• removeRestrictions: ProcedureMethod‹void, number›

Removes all Transfer Restrictions of the corresponding type from this Security Token

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

note required role:

  • Security Token Owner

setRestrictions

Sets all Transfer Restrictions of the corresponding type on this Security Token

param array of Transfer Restrictions with their corresponding exemptions (if applicable)

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

note required role:

  • Security Token Owner

Protected Abstract type

• type: T

Methods

get

Retrieve all active Transfer Restrictions of the corresponding type

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

• addRestriction: ProcedureMethod‹‹T›, number›

Defined in

• context:

Defined in

Defined in

• parent:

Defined in

Defined in

• setRestrictions: ProcedureMethod‹‹T›, number›

Defined in

Defined in

▸ get(): Promise‹‹T››

Defined in

Returns: Promise‹‹T››

TransferRestrictionType
SecurityToken
CountTransferRestriction
PercentageTransferRestriction
addRestriction
context
exemptedScopeIds
parent
removeRestrictions
setRestrictions
type
get
AddRestrictionParams
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:123
Context
src/api/entities/Namespace.ts:11
src/types/index.ts:858
SecurityToken
src/api/entities/Namespace.ts:9
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:145
SetRestrictionsParams
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:135
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:54
GetReturnType
src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:154
GetReturnType