Globals

Polymesh SDK API Reference
Search…
Polymesh SDK API Reference
v14.1.0
Globals
Classes
Enums
Interfaces
Globals
Index
Enumerations
​AffirmationStatus​
​AuthorizationType​
​CaCheckpointType​
​CalendarUnit​
​ClaimType​
​ConditionTarget​
​ConditionType​
​CorporateActionKind​
​CountryCode​
​ErrorCode​
​InstructionStatus​
​InstructionType​
​KnownAssetType​
​OfferingBalanceStatus​
​OfferingSaleStatus​
​OfferingTimingStatus​
​PayingAccountType​
​PermissionGroupType​
​PermissionType​
​RoleType​
​ScopeType​
​SecurityIdentifierType​
​SignerType​
​TargetTreatment​
​TickerReservationStatus​
​TransactionArgumentType​
​TransactionQueueStatus​
​TransactionStatus​
​TransferError​
​TransferRestrictionType​
​TransferStatus​
​TxGroup​
​VenueType​
Classes
​Account​
​AccountManagement​
​Asset​
​AssetHolders​
​AssetPermissions​
​Assets​
​AuthorizationRequest​
​Authorizations​
​Checkpoint​
​CheckpointSchedule​
​Checkpoints​
​Claims​
​Compliance​
​CorporateAction​
​CorporateActionBase​
​CorporateActions​
​Count​
​CustomPermissionGroup​
​DefaultPortfolio​
​DefaultTrustedClaimIssuer​
​Distributions​
​DividendDistribution​
​Documents​
​Entity​
​Identities​
​Identity​
​IdentityAuthorizations​
​Instruction​
​Issuance​
​KnownPermissionGroup​
​Network​
​NumberedPortfolio​
​Offering​
​Offerings​
​Percentage​
​PermissionGroup​
​Permissions​
​Polymesh​
​PolymeshError​
​PolymeshTransaction​
​PolymeshTransactionBase​
​PolymeshTransactionBatch​
​Portfolio​
​Portfolios​
​Requirements​
​Schedules​
​Settlements​
​Subsidy​
​TickerReservation​
​TransactionQueue​
​TransferRestrictionBase​
​TransferRestrictions​
​TrustedClaimIssuers​
​Venue​
Interfaces
​AccreditedClaim​
​ActiveTransferRestrictions​
​AddAssetRequirementParams​
​AddClaimsParams​
​AddInstructionParams​
​AddInstructionWithVenueIdParams​
​AddInstructionsParams​
​AddInvestorUniquenessClaimParams​
​AffiliateClaim​
​AffirmInstructionParams​
​AgentWithGroup​
​ArrayTransactionArgument​
​AssetBase​
​AssetDetails​
​AssetDocument​
​AssetWithGroup​
​Balance​
​BlockedClaim​
​BuyLockupClaim​
​CalendarPeriod​
​CalendarPeriodHumanReadable​
​CddClaim​
​CddProviderRole​
​CheckPermissionsResult​
​CheckRolesResult​
​CheckpointWithData​
​ClaimClassicTickerParams​
​ClaimData​
​ClaimScope​
​ClaimTarget​
​ComplexTransactionArgument​
​ComplianceRequirements​
​ConditionBase​
​ConditionCompliance​
​ConnectParams​
​ConstructorParams​
​ConsumeParams​
​ControllerTransferParams​
​CorporateActionDefaultConfig​
​CorporateActionTargets​
​CountTransferRestriction​
​CountTransferRestrictionInput​
​CreateAssetParams​
​CreateAssetWithTickerParams​
​CreateCheckpointScheduleParams​
​CreateGroupParams​
​CreateVenueParams​
​DecreaseAllowanceParams​
​DeletePortfolioParams​
​DistributionParticipant​
​DistributionPayment​
​DistributionWithDetails​
​DividendDistributionDetails​
​DividendDistributionParams​
​EditClaimsParams​
​EventIdentifier​
​ExemptedClaim​
​ExternalAgentCondition​
​ExtrinsicData​
​Fees​
​FeesBreakdown​
​GroupedInstructions​
​HistoricAgentOperation​
​HistoricSettlement​
​HumanReadable​
​IdentityBalance​
​IdentityCondition​
​IdentityRole​
​IdentityWithClaims​
​IncreaseAllowanceParams​
​InstructionAffirmation​
​InvestInOfferingParams​
​Investment​
​InvestorUniquenessClaim​
​InvestorUniquenessV2Claim​
​InviteAccountParams​
​InviteExternalAgentParams​
​IssueTokensParams​
​JurisdictionClaim​
​KycClaim​
​Leg​
​LinkCaDocsParams​
​MiddlewareConfig​
​ModifyAssetTrustedClaimIssuersAddSetParams​
​ModifyAssetTrustedClaimIssuersRemoveParams​
​ModifyCorporateActionsAgentParams​
​ModifyInstructionAffirmationParams​
​ModifyPrimaryIssuanceAgentParams​
​ModifySignerPermissionsParams​
​MoveFundsParams​
​MultiClaimCondition​
​NetworkProperties​
​NoArgsProcedureMethod​
​NoDataClaim​
​OfferingDetails​
​OfferingStatus​
​OfferingTier​
​OfferingWithDetails​
​PaginationOptions​
​PayDividendsParams​
​PayingAccount​
​PercentageTransferRestriction​
​PercentageTransferRestrictionInput​
​PermissionGroups​
​PermissionedAccount​
​PlainTransactionArgument​
​PortfolioBalance​
​PortfolioCustodianRole​
​PortfolioMovement​
​ProcedureAuthorizationStatus​
​ProcedureMethod​
​ProcedureOpts​
​QuitSubsidyParams​
​RedeemTokensParams​
​RegisterIdentityParams​
​RemoveAssetRequirementParams​
​RemoveCheckpointScheduleParams​
​RemoveCorporateActionParams​
​RemoveExternalAgentParams​
​RemoveSecondaryAccountsParams​
​RenamePortfolioParams​
​Requirement​
​RequirementCompliance​
​ReserveTickerParams​
​ResultSet​
​RevokeClaimsParams​
​ScheduleDetails​
​ScheduleWithDetails​
​Scope​
​SectionPermissions​
​SecurityIdentifier​
​SellLockupClaim​
​SetAllowanceParams​
​SetAssetDocumentsParams​
​SetAssetRequirementsParams​
​SetCountTransferRestrictionsParams​
​SetCustodianParams​
​SetGroupPermissionsParams​
​SetPercentageTransferRestrictionsParams​
​SetPermissionGroupParams​
​SettlementLeg​
​SignerValue​
​SimpleEnumTransactionArgument​
​SimplePermissions​
​SingleClaimCondition​
​SubsidizeAccountParams​
​SubsidyData​
​SubsidyWithAllowance​
​TaxWithholding​
​ThirdPartyFees​
​TickerOwnerRole​
​TickerReservationDetails​
​Tier​
​ToggleFreezeOfferingParams​
​ToggleFreezeSecondaryAccountsParams​
​ToggleFreezeTransfersParams​
​TogglePauseRequirementsParams​
​TransactionPermissions​
​TransactionsParams​
​TransferAssetOwnershipParams​
​TransferBreakdown​
​TransferPolyxParams​
​TransferRestriction​
​TransferRestrictionInputBase​
​TransferRestrictionResult​
​TransferTickerOwnershipParams​
​TrustedClaimIssuer​
​TxAndArgsArray​
​TxGroupParams​
​UniqueIdentifiers​
​VenueDetails​
​VenueOwnerRole​
​WaivePermissionsParams​
Type aliases
​AccountBalance​
​AddCountTransferRestrictionParams​
​AddPercentageTransferRestrictionParams​
​AddRelayerPayingKeyAuthorizationData​
​AddRestrictionParams​
​ArgsType​
​Authorization​
​BecomeAgentAuthorizationData​
​CheckpointScheduleParams​
​Claim​
​Condition​
​ConfigureDividendDistributionParams​
​Ensured​
​GenericAuthorizationData​
​GetReturnType​
​GroupPermissions​
​HumanReadableType​
​InputCaCheckpoint​
​InputCondition​
​InputConditionBase​
​InputRequirement​
​InputTargets​
​InputTaxWithholding​
​InputTrustedClaimIssuer​
​InstructionDetails​
​InstructionStatusResult​
​JoinIdentityAuthorizationData​
​MapTxAndArgsArray​
​Modify​
​ModifyAllowanceParams​
​ModifyAssetParams​
​ModifyCaDefaultConfigParams​
​ModifyClaimsParams​
​ModifyComplianceRequirementParams​
​ModifyOfferingTimesParams​
​ModifyVenueParams​
​Mutable​
​NextKey​
​PermissionsLike​
​PortfolioCustodyAuthorizationData​
​PortfolioLike​
​PrivateKey​
​ProcedureFunc​
​QueryReturnType​
​Role​
​RotatePrimaryKeyAuthorizationData​
​RotatePrimaryKeyToSecondaryData​
​ScopedClaim​
​SetRestrictionsParams​
​SetTransferRestrictionsParams​
​Signer​
​SubCallback​
​TransactionArgument​
​UnionOfProcedureFuncs​
​UnscopedClaim​
​UnsubCallback​
​WithRequired​
Variables
​caNotExistsMessage​
​executedMessage​
​notExistsMessage​
Functions
​areSameClaimIssuers​
​areSameClaims​
​areSameTargets​
​assembleBatchTransactions​
​convertArgsToRaw​
​createProcedureMethod​
​findClaimsByOtherIssuers​
​findPositiveBalanceIuClaims​
​isAccount​
​isAccreditedClaim​
​isAffiliateClaim​
​isAsset​
​isAuthorizationRequest​
​isBlockedClaim​
​isBuyLockupClaim​
​isCddClaim​
​isCddProviderRole​
​isCheckpoint​
​isCheckpointSchedule​
​isCorporateAction​
​isCustomPermissionGroup​
​isDefaultPortfolio​
​isDefaultTrustedClaimIssuer​
​isDividendDistribution​
​isEntity​
​isExemptedClaim​
​isIdentity​
​isIdentityCondition​
​isIdentityRole​
​isInstruction​
​isInvestorUniquenessClaim​
​isInvestorUniquenessV2Claim​
​isJurisdictionClaim​
​isKnownPermissionGroup​
​isKycClaim​
​isMultiClaimCondition​
​isNoDataClaim​
​isNumberedPortfolio​
​isOffering​
​isPolymeshError​
​isPolymeshTransaction​
​isPolymeshTransactionBatch​
​isPortfolioCustodianRole​
​isScopedClaim​
​isSellLockupClaim​
​isSingleClaimCondition​
​isTickerOwnerRole​
​isTickerReservation​
​isUnscopedClaim​
​isVenue​
​isVenueOwnerRole​
​tickerToDid​
​tuple​
​txGroupToTxTags​
Object literals
​defaultMessages​
Type aliases
AccountBalance
Ƭ AccountBalance: Balance​
Defined in src/types/index.ts:665​
​
AddCountTransferRestrictionParams
Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object
Defined in src/api/procedures/addTransferRestriction.ts:21​
​
AddPercentageTransferRestrictionParams
Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object
Defined in src/api/procedures/addTransferRestriction.ts:25​
​
AddRelayerPayingKeyAuthorizationData
Ƭ AddRelayerPayingKeyAuthorizationData: object
Defined in src/types/index.ts:1045​
Type declaration:
type: AddRelayerPayingKey​
value: SubsidyData​
​
AddRestrictionParams
Ƭ AddRestrictionParams: Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›
Defined in src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:35​
​
ArgsType
Ƭ ArgsType: T extends function ? A : never
Defined in src/types/utils/index.ts:20​
Less strict version of Parameters
​
Authorization
Ƭ Authorization: RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData​
Defined in src/types/index.ts:1065​
Authorization request data corresponding to type
​
BecomeAgentAuthorizationData
Ƭ BecomeAgentAuthorizationData: object
Defined in src/types/index.ts:1040​
Type declaration:
type: BecomeAgent​
value: KnownPermissionGroup | CustomPermissionGroup​
​
CheckpointScheduleParams
Ƭ CheckpointScheduleParams: Omit‹UniqueIdentifiers & Params, "ticker"›
Defined in src/api/entities/CheckpointSchedule/types.ts:10​
​
Claim
Ƭ Claim: ScopedClaim | UnscopedClaim​
Defined in src/types/index.ts:299​
​
Condition
Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase​
Defined in src/types