types.txGroupConstants - PolymeshAssociation/polymesh-sdk GitHub Wiki

@polymeshassociation/polymesh-sdk / types/txGroupConstants

types/txGroupConstants

Variables

ADVANCED_ASSET_MANAGEMENT_TX_TAGS

const ADVANCED_ASSET_MANAGEMENT_TX_TAGS: [AcceptAssetOwnershipTransfer, ControllerTransfer, Freeze, Unfreeze, ControllerTransfer]

Defined in: types/txGroupConstants.ts:27

Transaction tags for Advanced Asset Management operations Contains asset freeze/unfreeze, controller transfer, and NFT management operations.

Values:

  • TxTags.asset.AcceptAssetOwnershipTransfer
  • TxTags.asset.ControllerTransfer
  • TxTags.asset.Freeze
  • TxTags.asset.Unfreeze
  • TxTags.nft.ControllerTransfer

Note

AcceptAssetOwnershipTransfer has unique permission checking - it verifies that the identity that created the authorization was an agent with AcceptAssetOwnershipTransfer permission so an agent with this permission can transfer the ownership of the asset.

AGENT_TX_GROUP_VALUES

const AGENT_TX_GROUP_VALUES: readonly [AdvancedAssetManagement, AssetDocumentManagement, AssetManagement, AssetMetadataManagement, CapitalDistribution, CheckpointManagement, ComplianceManagement, CorporateActionsManagement, CorporateBallotManagement, ExternalAgentManagement, Issuance, Redemption, StoManagement, TrustedClaimIssuersManagement]

Defined in: types/txGroupConstants.ts:591

Runtime list of TxGroup values that are permitted for External Agent permissions.

  • Pairs with api/procedures/types!AgentTxGroup for compile-time safety.
  • Use this constant when you need to iterate, validate, or render the allowed groups at runtime without duplicating definitions.
  • All transactions in these groups are available to both Agents and Secondary Keys.
  • Groups are ordered alphabetically for consistency.

Example

Iterate allowed agent groups and retrieve their transactions

AGENT_TX_GROUP_VALUES.forEach(group => {
  const tags = txGroupToTxTags(group);
  // render group with its tags, build UI options, etc.
});

ASSET_DOCUMENT_MANAGEMENT_TX_TAGS

const ASSET_DOCUMENT_MANAGEMENT_TX_TAGS: [AddDocuments, RemoveDocuments]

Defined in: types/txGroupConstants.ts:66

Transaction tags for Asset Document Management operations Contains operations for managing asset documents.

Values:

  • TxTags.asset.AddDocuments
  • TxTags.asset.RemoveDocuments

ASSET_MANAGEMENT_TX_TAGS

const ASSET_MANAGEMENT_TX_TAGS: [LinkTickerToAssetId, MakeDivisible, RenameAsset, SetFundingRound, UnlinkTickerFromAssetId, UpdateAssetType, UpdateIdentifiers]

Defined in: types/txGroupConstants.ts:48

Transaction tags for Asset Management operations Contains basic asset management operations like divisibility, linking, and metadata.

Values:

  • TxTags.asset.LinkTickerToAssetId
  • TxTags.asset.MakeDivisible
  • TxTags.asset.RenameAsset
  • TxTags.asset.SetFundingRound
  • TxTags.asset.UnlinkTickerFromAssetId
  • TxTags.asset.UpdateAssetType
  • TxTags.asset.UpdateIdentifiers

ASSET_METADATA_MANAGEMENT_TX_TAGS

const ASSET_METADATA_MANAGEMENT_TX_TAGS: [RegisterAndSetLocalAssetMetadata, RegisterAssetMetadataLocalType, RemoveLocalMetadataKey, RemoveMetadataValue, SetAssetMetadata, SetAssetMetadataDetails]

Defined in: types/txGroupConstants.ts:83

Transaction tags for Asset Metadata Management operations Contains operations for managing asset metadata.

Values:

  • TxTags.asset.RegisterAndSetLocalAssetMetadata
  • TxTags.asset.RegisterAssetMetadataLocalType
  • TxTags.asset.RemoveLocalMetadataKey
  • TxTags.asset.RemoveMetadataValue
  • TxTags.asset.SetAssetMetadata
  • TxTags.asset.SetAssetMetadataDetails

ASSET_REGISTRATION_TX_TAGS

const ASSET_REGISTRATION_TX_TAGS: [AcceptAssetOwnershipTransfer, AcceptTickerTransfer, CreateAsset, CreateAssetWithCustomType, RegisterCustomAssetType, RegisterUniqueTicker, CreateNftCollection]

Defined in: types/txGroupConstants.ts:109

Transaction tags for Asset Registration operations Contains operations for registering assets, custom types, and NFT collections.

Values:

  • TxTags.asset.AcceptAssetOwnershipTransfer
  • TxTags.asset.AcceptTickerTransfer
  • TxTags.asset.CreateAsset
  • TxTags.asset.CreateAssetWithCustomType
  • TxTags.asset.RegisterCustomAssetType
  • TxTags.asset.RegisterUniqueTicker
  • TxTags.nft.CreateNftCollection

Note

TxTags.nft.CreateNftCollection is Agent checked when the collection is created under an existing Asset. This group is not agent grantable, so that path is covered by ISSUANCE_TX_TAGS instead

AUTHORIZATION_MANAGEMENT_TX_TAGS

const AUTHORIZATION_MANAGEMENT_TX_TAGS: [AddAuthorization, RemoveAuthorization]

Defined in: types/txGroupConstants.ts:127

Transaction tags for Authorization Management operations Contains operations for managing identity authorizations.

Values:

  • TxTags.identity.AddAuthorization
  • TxTags.identity.RemoveAuthorization

CAPITAL_DISTRIBUTION_TX_TAGS

const CAPITAL_DISTRIBUTION_TX_TAGS: [Distribute, PushBenefit, Reclaim, RemoveDistribution]

Defined in: types/txGroupConstants.ts:142

Transaction tags for Capital Distribution operations Contains operations for managing capital distributions.

Values:

  • TxTags.capitalDistribution.Distribute
  • TxTags.capitalDistribution.PushBenefit
  • TxTags.capitalDistribution.Reclaim
  • TxTags.capitalDistribution.RemoveDistribution

CDD_REGISTRATION_TX_TAGS

const CDD_REGISTRATION_TX_TAGS: [CddRegisterDid, CddRegisterDidWithCdd]

Defined in: types/txGroupConstants.ts:160

Transaction tags for CDD Registration operations Contains the deprecated DID registration extrinsics.

Values:

  • TxTags.identity.CddRegisterDid
  • TxTags.identity.CddRegisterDidWithCdd

Deprecated

these extrinsics no longer attach a CustomerDueDiligence claim as of chain v8. Use DID_REGISTRATION_TX_TAGS instead

CHECKPOINT_MANAGEMENT_TX_TAGS

const CHECKPOINT_MANAGEMENT_TX_TAGS: [CreateCheckpoint, CreateSchedule, RemoveSchedule]

Defined in: types/txGroupConstants.ts:185

Transaction tags for Checkpoint Management operations Contains operations for creating and managing asset checkpoints.

Values:

  • TxTags.checkpoint.CreateCheckpoint
  • TxTags.checkpoint.CreateSchedule
  • TxTags.checkpoint.RemoveSchedule

CLAIMS_MANAGEMENT_TX_TAGS

const CLAIMS_MANAGEMENT_TX_TAGS: [AddClaim, RegisterCustomClaimType, RevokeClaim, RevokeClaimByIndex]

Defined in: types/txGroupConstants.ts:201

Transaction tags for Claims Management operations Contains operations for adding, revoking, and managing identity claims.

Values:

  • TxTags.identity.AddClaim
  • TxTags.identity.RegisterCustomClaimType
  • TxTags.identity.RevokeClaim
  • TxTags.identity.RevokeClaimByIndex

COMPLIANCE_MANAGEMENT_TX_TAGS

const COMPLIANCE_MANAGEMENT_TX_TAGS: [AddMandatoryMediators, RemoveMandatoryMediators, AddComplianceRequirement, ChangeComplianceRequirement, PauseAssetCompliance, RemoveComplianceRequirement, ReplaceAssetCompliance]

Defined in: types/txGroupConstants.ts:230

Transaction tags for Compliance Management operations Contains comprehensive compliance management operations.

Values:

  • TxTags.asset.AddMandatoryMediators
  • TxTags.asset.RemoveMandatoryMediators
  • TxTags.complianceManager.AddComplianceRequirement
  • TxTags.complianceManager.ChangeComplianceRequirement
  • TxTags.complianceManager.PauseAssetCompliance
  • TxTags.complianceManager.RemoveComplianceRequirement
  • TxTags.complianceManager.ReplaceAssetCompliance
  • TxTags.complianceManager.ResetAssetCompliance
  • TxTags.complianceManager.ResumeAssetCompliance
  • TxTags.settlement.AllowVenues
  • TxTags.settlement.DisallowVenues
  • TxTags.settlement.SetVenueFiltering
  • TxTags.statistics.BatchUpdateAssetStats
  • TxTags.statistics.SetActiveAssetStats
  • TxTags.statistics.SetAssetTransferCompliance
  • TxTags.statistics.SetEntitiesExempt

CORPORATE_ACTIONS_MANAGEMENT_TX_TAGS

const CORPORATE_ACTIONS_MANAGEMENT_TX_TAGS: [ChangeRecordDate, InitiateCorporateAction, InitiateCorporateActionAndBallot, InitiateCorporateActionAndDistribute, LinkCaDoc, RemoveCa, SetDefaultTargets, SetDefaultWithholdingTax, SetDidWithholdingTax]

Defined in: types/txGroupConstants.ts:264

Transaction tags for Corporate Actions Management operations Contains operations for managing corporate actions.

Values:

  • TxTags.corporateAction.ChangeRecordDate
  • TxTags.corporateAction.InitiateCorporateAction
  • TxTags.corporateAction.InitiateCorporateActionAndBallot
  • TxTags.corporateAction.InitiateCorporateActionAndDistribute
  • TxTags.corporateAction.LinkCaDoc
  • TxTags.corporateAction.RemoveCa
  • TxTags.corporateAction.SetDefaultTargets
  • TxTags.corporateAction.SetDefaultWithholdingTax
  • TxTags.corporateAction.SetDidWithholdingTax

CORPORATE_BALLOT_MANAGEMENT_TX_TAGS

const CORPORATE_BALLOT_MANAGEMENT_TX_TAGS: [AttachBallot, ChangeEnd, ChangeMeta, ChangeRcv, RemoveBallot]

Defined in: types/txGroupConstants.ts:287

Transaction tags for Corporate Ballot Management operations Contains operations for managing corporate ballots.

Values:

  • TxTags.corporateBallot.AttachBallot
  • TxTags.corporateBallot.ChangeEnd
  • TxTags.corporateBallot.ChangeMeta
  • TxTags.corporateBallot.ChangeRcv
  • TxTags.corporateBallot.RemoveBallot

CORPORATE_VOTING_TX_TAGS

const CORPORATE_VOTING_TX_TAGS: [Vote]

Defined in: types/txGroupConstants.ts:302

Transaction tags for Corporate Voting operations Contains operations for voting in corporate ballots.

Values:

  • TxTags.corporateBallot.Vote

DID_REGISTRATION_TX_TAGS

const DID_REGISTRATION_TX_TAGS: [RegisterDid]

Defined in: types/txGroupConstants.ts:172

Transaction tags for DID Registration operations Contains registrar-gated DID registration, superseding CDD registration.

Values:

  • TxTags.identity.RegisterDid

EXTERNAL_AGENT_MANAGEMENT_TX_TAGS

const EXTERNAL_AGENT_MANAGEMENT_TX_TAGS: [AcceptBecomeAgent, ChangeGroup, CreateAndChangeCustomGroup, CreateGroup, CreateGroupAndAddAuth, RemoveAgent, SetGroupPermissions]

Defined in: types/txGroupConstants.ts:325

Transaction tags for External Agent Management operations Contains operations for managing external agents and their permissions.

Values:

  • TxTags.externalAgents.AcceptBecomeAgent
  • TxTags.externalAgents.ChangeGroup
  • TxTags.externalAgents.CreateAndChangeCustomGroup
  • TxTags.externalAgents.CreateGroup
  • TxTags.externalAgents.CreateGroupAndAddAuth
  • TxTags.externalAgents.RemoveAgent
  • TxTags.externalAgents.SetGroupPermissions

Note

AcceptBecomeAgent has unique permission checking - when an invitation is accepted, the chain verifies that the identity that created the authorization was an agent with AcceptBecomeAgent permission, so an agent with this permission can invite other agents to the Asset. It is also a member of EXTERNAL_AGENT_PARTICIPATION_TX_TAGS, which grants a Secondary Key the ability to accept an invitation on its own Identity's behalf.

EXTERNAL_AGENT_PARTICIPATION_TX_TAGS

const EXTERNAL_AGENT_PARTICIPATION_TX_TAGS: [Abdicate, AcceptBecomeAgent]

Defined in: types/txGroupConstants.ts:343

Transaction tags for External Agent Participation operations Contains operations for joining and leaving external agent roles.

Values:

  • TxTags.externalAgents.Abdicate
  • TxTags.externalAgents.AcceptBecomeAgent

INSTRUCTION_MEDIATION_TX_TAGS

const INSTRUCTION_MEDIATION_TX_TAGS: [AffirmInstructionAsMediator, LockInstruction, RejectInstructionAsMediator, UnlockInstruction]

Defined in: types/txGroupConstants.ts:424

Transaction tags for Instruction Mediation operations Contains the operations available to an Instruction's mediators — affirming or rejecting as a mediator, and locking/unlocking an Instruction for execution.

Values:

  • TxTags.settlement.AffirmInstructionAsMediator
  • TxTags.settlement.LockInstruction
  • TxTags.settlement.RejectInstructionAsMediator
  • TxTags.settlement.UnlockInstruction

ISSUANCE_TX_TAGS

const ISSUANCE_TX_TAGS: [Issue, CreateNftCollection, IssueNft]

Defined in: types/txGroupConstants.ts:446

Transaction tags for Issuance operations Contains fungible asset and NFT issuance operations.

Values:

  • TxTags.asset.Issue
  • TxTags.nft.CreateNftCollection
  • TxTags.nft.IssueNft

Note

TxTags.nft.CreateNftCollection is also a member of ASSET_REGISTRATION_TX_TAGS. The extrinsic takes two paths on chain: creating a collection for a new Asset is a Secondary Key operation (ensure_origin_call_permissions), while creating one under an existing Asset is Agent checked (ExternalAgents::ensure_agent_asset_perms). TxGroup.AssetRegistration is not agent grantable, so it covers only the first path - this group covers the second

MULTISIG_MANAGEMENT_TX_TAGS

const MULTISIG_MANAGEMENT_TX_TAGS: [CreateMultisig]

Defined in: types/txGroupConstants.ts:463

Transaction tags for MultiSig Management operations Contains operations for managing multi-signature accounts.

Values:

  • TxTags.multiSig.CreateMultisig

Note

a MultiSig executes proposals under its own origin, so what it may do via proposal is constrained by the permissions held by the MultiSig Account itself, not by those of its signers. Those permissions are drawn from these same groups

PORTFOLIO_MANAGEMENT_TX_TAGS

const PORTFOLIO_MANAGEMENT_TX_TAGS: [AcceptPortfolioCustody, AllowIdentityToCreatePortfolios, CreateCustodyPortfolio, CreatePortfolio, DeletePortfolio, MovePortfolioFunds, QuitPortfolioCustody, RenamePortfolio, RevokeCreatePortfoliosPermission]

Defined in: types/txGroupConstants.ts:482

Transaction tags for Portfolio Management operations Contains comprehensive portfolio management including creation, custody, movement, and operations.

Values:

  • TxTags.portfolio.AcceptPortfolioCustody
  • TxTags.portfolio.AllowIdentityToCreatePortfolios
  • TxTags.portfolio.CreateCustodyPortfolio
  • TxTags.portfolio.CreatePortfolio
  • TxTags.portfolio.DeletePortfolio
  • TxTags.portfolio.MovePortfolioFunds
  • TxTags.portfolio.QuitPortfolioCustody
  • TxTags.portfolio.RenamePortfolio
  • TxTags.portfolio.RevokeCreatePortfoliosPermission

REDEMPTION_TX_TAGS

const REDEMPTION_TX_TAGS: [Redeem, RedeemNft]

Defined in: types/txGroupConstants.ts:502

Transaction tags for Redemption operations Contains fungible asset and NFT redemption operations.

Values:

  • TxTags.asset.Redeem
  • TxTags.nft.RedeemNft

SETTLEMENT_MANAGEMENT_TX_TAGS

const SETTLEMENT_MANAGEMENT_TX_TAGS: [Approve, PreApproveAsset, ReceiverAffirmAssetTransfer, RejectAssetTransfer, RemoveAssetPreApproval, TransferAsset, Claim, TransferNft, PreApprovePortfolio, RemovePortfolioPreApproval]

Defined in: types/txGroupConstants.ts:382

Transaction tags for Settlement Management operations Contains comprehensive settlement instruction, venue management, asset pre-approval, and investment operations.

Values:

  • TxTags.asset.Approve
  • TxTags.asset.PreApproveAsset
  • TxTags.asset.ReceiverAffirmAssetTransfer
  • TxTags.asset.RejectAssetTransfer
  • TxTags.asset.RemoveAssetPreApproval
  • TxTags.asset.TransferAsset
  • TxTags.capitalDistribution.Claim
  • TxTags.nft.TransferNft
  • TxTags.portfolio.PreApprovePortfolio
  • TxTags.portfolio.RemovePortfolioPreApproval
  • TxTags.settlement.AddAndAffirmInstruction
  • TxTags.settlement.AddAndAffirmWithMediators
  • TxTags.settlement.AddInstruction
  • TxTags.settlement.AddInstructionWithMediators
  • TxTags.settlement.AffirmInstruction
  • TxTags.settlement.AffirmInstructionWithCount
  • TxTags.settlement.AffirmWithReceipts
  • TxTags.settlement.AffirmWithReceiptsWithCount
  • TxTags.settlement.CreateVenue
  • TxTags.settlement.ExecuteManualInstruction
  • TxTags.settlement.RejectInstruction
  • TxTags.settlement.RejectInstructionWithCount
  • TxTags.settlement.SetMandatoryReceiverAffirmation
  • TxTags.settlement.TransferFunds
  • TxTags.settlement.UpdateVenueDetails
  • TxTags.settlement.UpdateVenueSigners
  • TxTags.settlement.UpdateVenueType
  • TxTags.sto.Invest

STO_MANAGEMENT_TX_TAGS

const STO_MANAGEMENT_TX_TAGS: [CreateFundraiser, EnableOffchainFunding, FreezeFundraiser, ModifyFundraiserWindow, Stop, UnfreezeFundraiser]

Defined in: types/txGroupConstants.ts:519

Transaction tags for STO Management operations Contains operations for Security Token Offerings management.

Values:

  • TxTags.sto.CreateFundraiser
  • TxTags.sto.EnableOffchainFunding
  • TxTags.sto.FreezeFundraiser
  • TxTags.sto.ModifyFundraiserWindow
  • TxTags.sto.Stop
  • TxTags.sto.UnfreezeFundraiser

TRUSTED_CLAIM_ISSUERS_MANAGEMENT_TX_TAGS

const TRUSTED_CLAIM_ISSUERS_MANAGEMENT_TX_TAGS: [AddDefaultTrustedClaimIssuer, RemoveDefaultTrustedClaimIssuer]

Defined in: types/txGroupConstants.ts:536

Transaction tags for Trusted Claim Issuers Management operations Contains operations for managing trusted claim issuers.

Values:

  • TxTags.complianceManager.AddDefaultTrustedClaimIssuer
  • TxTags.complianceManager.RemoveDefaultTrustedClaimIssuer

TX_GROUP_TO_TAGS_MAP

const TX_GROUP_TO_TAGS_MAP: Record<TxGroup, TxTag[]>

Defined in: types/txGroupConstants.ts:546

Mapping of transaction groups to their corresponding transaction tags Used by txGroupToTxTags function for efficient lookups Groups are ordered alphabetically for maintainability