Polymesh SDK API Reference
v4.0.0
v4.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Claims
    • Compliance
    • Context
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoStatus
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountBalance
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • CddProviderRole
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • Leg
    • MiddlewareConfig
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoTier
    • StoWithDetails
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenDocument
    • TokenHolderOptions
    • TokenHolderProperties
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferPolyXParams
    • TransferRestrictionInputBase
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Properties
  • addRestriction
  • Protected context
  • get
  • Protected parent
  • removeRestrictions
  • setRestrictions
  • Protected type

Was this helpful?

  1. Classes

Percentage

PreviousOfferingsNextPolymesh

Last updated 4 years ago

Was this helpful?

Handles all Percentage Transfer Restriction related functionality

Hierarchy

  • TransferRestrictionBase‹Percentage›

    ↳ Percentage

Index

Properties

Properties

addRestriction

Add a Percentage Transfer Restriction to this Security Token

param limit on the proportion of the total supply of this Security Token that can be held by a single investor at once

param array of Scope IDs that are exempted from the Restriction

param array of Identities (or DIDs) 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

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

removeRestrictions

• removeRestrictions: ProcedureMethod‹void, number›

Removes all Percentage Transfer Restrictions from this Security Token

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

setRestrictions

Sets all Percentage Transfer Restrictions on this Security Token

param array of Percentage 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 type

• type: Percentage = TransferRestrictionType.Percentage as const

• addRestriction: ProcedureMethod‹Omit‹, "type"›, number›

Overrides .

Defined in

• context:

Defined in

Overrides .

Defined in

▸ (): Promise‹‹››

• parent:

Defined in

Overrides .

Defined in

• setRestrictions: ProcedureMethod‹Omit‹, "type"›, number›

Overrides .

Defined in

Overrides .

Defined in

src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:27
Context
src/api/entities/Namespace.ts:11
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:61
ActiveTransferRestrictions
PercentageTransferRestriction
SecurityToken
src/api/entities/Namespace.ts:9
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:52
SetPercentageTransferRestrictionsParams
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:42
src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:13
addRestriction
context
get
parent
removeRestrictions
setRestrictions
type
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
addRestriction
get
removeRestrictions
setRestrictions
type
AddPercentageTransferRestrictionParams