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
  • Index
  • Enumeration members
  • Enumeration members
  • AdvancedTokenManagement
  • ClaimsManagement
  • ComplianceRequirementsManagement
  • CorporateActionsManagement
  • Distribution
  • Issuance
  • PortfolioManagement
  • StoManagement
  • TokenManagement
  • TrustedClaimIssuersManagement

Was this helpful?

  1. Enums

TxGroup

PreviousTransferStatusNextVenueType

Last updated 3 years ago

Was this helpful?

Transaction Groups (for permissions purposes)

Index

Enumeration members

Enumeration members

AdvancedTokenManagement

• AdvancedTokenManagement: = "AdvancedTokenManagement"

  • TxTags.asset.Freeze

  • TxTags.asset.Unfreeze

  • TxTags.identity.AddAuthorization

  • TxTags.identity.RemoveAuthorization

ClaimsManagement

• ClaimsManagement: = "ClaimsManagement"

  • TxTags.identity.AddClaim

  • TxTags.identity.RevokeClaim

ComplianceRequirementsManagement

• ComplianceRequirementsManagement: = "ComplianceRequirementsManagement"

  • TxTags.complianceManager.AddComplianceRequirement

  • TxTags.complianceManager.RemoveComplianceRequirement

  • TxTags.complianceManager.PauseAssetCompliance

  • TxTags.complianceManager.ResumeAssetCompliance

  • TxTags.complianceManager.ResetAssetCompliance

CorporateActionsManagement

• CorporateActionsManagement: = "CorporateActionsManagement"

  • TxTags.checkpoint.CreateSchedule,

  • TxTags.checkpoint.RemoveSchedule,

  • TxTags.checkpoint.CreateCheckpoint,

  • TxTags.corporateAction.InitiateCorporateAction,

  • TxTags.capitalDistribution.Distribute,

  • TxTags.capitalDistribution.Claim,

  • TxTags.identity.AddInvestorUniquenessClaim,

Distribution

• Distribution: = "Distribution"

  • TxTags.identity.AddInvestorUniquenessClaim

  • TxTags.settlement.CreateVenue

  • TxTags.settlement.AddInstruction

  • TxTags.settlement.AddAndAffirmInstruction

Issuance

• Issuance: = "Issuance"

  • TxTags.asset.Issue

PortfolioManagement

• PortfolioManagement: = "PortfolioManagement"

  • TxTags.identity.AddInvestorUniquenessClaim

  • TxTags.portfolio.MovePortfolioFunds

  • TxTags.settlement.AddInstruction

  • TxTags.settlement.AddAndAffirmInstruction

  • TxTags.settlement.AffirmInstruction

  • TxTags.settlement.RejectInstruction

  • TxTags.settlement.CreateVenue

StoManagement

• StoManagement: = "StoManagement"

  • TxTags.sto.CreateFundraiser,

  • TxTags.sto.FreezeFundraiser,

  • TxTags.sto.Invest,

  • TxTags.sto.ModifyFundraiserWindow,

  • TxTags.sto.Stop,

  • TxTags.sto.UnfreezeFundraiser,

  • TxTags.identity.AddInvestorUniquenessClaim,

  • TxTags.asset.Issue,

  • TxTags.settlement.CreateVenue

TokenManagement

• TokenManagement: = "TokenManagement"

  • TxTags.asset.MakeDivisible

  • TxTags.asset.RenameAsset

  • TxTags.asset.SetFundingRound

  • TxTags.asset.AddDocuments

  • TxTags.asset.RemoveDocuments

TrustedClaimIssuersManagement

• TrustedClaimIssuersManagement: = "TrustedClaimIssuersManagement"

  • TxTags.complianceManager.AddDefaultTrustedClaimIssuer

  • TxTags.complianceManager.RemoveDefaultTrustedClaimIssuer

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

Defined in

src/types/index.ts:652
src/types/index.ts:673
src/types/index.ts:681
src/types/index.ts:691
src/types/index.ts:659
src/types/index.ts:663
src/types/index.ts:637
src/types/index.ts:703
src/types/index.ts:645
src/types/index.ts:668
AdvancedTokenManagement
ClaimsManagement
ComplianceRequirementsManagement
CorporateActionsManagement
Distribution
Issuance
PortfolioManagement
StoManagement
TokenManagement
TrustedClaimIssuersManagement