Polymesh SDK API Reference
v6.0.0
v6.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
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • 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
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • get
  • Protected parent
  • Protected type
  • Methods
  • addRestriction
  • removeRestrictions
  • setRestrictions

Was this helpful?

  1. Classes

Percentage

PreviousOfferingsNextPolymesh

Last updated 3 years ago

Was this helpful?

Handles all Percentage Transfer Restriction related functionality

Hierarchy

  • TransferRestrictionBase‹›

    ↳ Percentage

Index

Properties

Methods

Properties

Protected context

Inherited from void

get

• get: function

Retrieve all active Percentage Transfer Restrictions

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

Type declaration:

Protected parent

Inherited from void

Protected type

Methods

addRestriction

Add a Percentage Transfer Restriction to this Security Token

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

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

removeRestrictions

Removes all Percentage Transfer Restrictions from this Security Token

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

Parameters:

Name

Type

args

void

setRestrictions

Sets all Percentage Transfer Restrictions on this Security Token

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

note required role:

  • Security Token Owner

Parameters:

Name

Type

args

• context:

Defined in

Overrides .

Defined in

▸ (): Promise‹‹››

• parent:

Defined in

• type: = TransferRestrictionType.Percentage as const

Overrides .

Defined in

▸ addRestriction(args: Omit‹, "type"›): Promise‹‹number››

Overrides .

Defined in

note this method is of type , which means you can call addRestriction.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Omit‹, "type"›

Returns: Promise‹‹number››

▸ removeRestrictions(args: void): Promise‹‹number››

Overrides .

Defined in

note this method is of type , which means you can call removeRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹number››

▸ setRestrictions(args: Omit‹, "type"›): Promise‹‹number››

Overrides .

Defined in

note this method is of type , which means you can call setRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Omit‹, "type"›

Returns: Promise‹‹number››

Context
src/api/entities/Namespace.ts:11
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:69
ActiveTransferRestrictions
PercentageTransferRestriction
SecurityToken
src/api/entities/Namespace.ts:9
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:18
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:31
ProcedureMethod
TransactionQueue
TransactionQueue
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:58
ProcedureMethod
TransactionQueue
SetPercentageTransferRestrictionsParams
TransactionQueue
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:46
ProcedureMethod
TransactionQueue
SetPercentageTransferRestrictionsParams
TransferRestrictionBase
TransferRestrictionBase
TransactionQueue
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
context
get
parent
type
addRestriction
removeRestrictions
setRestrictions
Percentage
Percentage
get
type
addRestriction
removeRestrictions
setRestrictions
AddPercentageTransferRestrictionParams
AddPercentageTransferRestrictionParams