types

@polymeshassociation/polymesh-sdk / Modules / types

Module: types

Table of contents

References

• AffirmationStatus

• AgentWithGroup

• AssetDetails

• CaCheckpointType

• CheckpointScheduleParams

• CorporateActionDefaultConfig

• CorporateActionKind

• CorporateActionParams

• CorporateActionTargets

• DistributionParticipant

• DividendDistributionDetails

• DividendDistributionParams

• HistoricSettlement

• IdentityBalance

• InputCaCheckpoint

• InputTargets

• InputTaxWithholding

• InstructionAffirmation

• InstructionDetails

• InstructionStatus

• InstructionStatusResult

• InstructionType

• Investment

• Leg

• OfferingBalanceStatus

• OfferingDetails

• OfferingSaleStatus

• OfferingStatus

• OfferingTier

• OfferingTimingStatus

• PortfolioBalance

• ScheduleDetails

• SettlementLeg

• SubsidyData

• SubsidyWithAllowance

• TargetTreatment

• TaxWithholding

• TickerReservationDetails

• TickerReservationStatus

• Tier

• TransferBreakdown

• TransferRestrictionResult

• VenueDetails

• VenueType

Enumerations

• AuthorizationType

• CalendarUnit

• ClaimType

• ConditionTarget

• ConditionType

• ErrorCode

• KnownAssetType

• PayingAccountType

• PermissionGroupType

• PermissionType

• RoleType

• ScopeType

• SecurityIdentifierType

• SignerType

• TransactionArgumentType

• TransactionQueueStatus

• TransactionStatus

• TransferError

• TransferRestrictionType

• TransferStatus

• TxGroup

Interfaces

• AccreditedClaim

• ActiveTransferRestrictions

• AffiliateClaim

• ArrayTransactionArgument

• AssetDocument

• AssetWithGroup

• Balance

• BlockedClaim

• BuyLockupClaim

• CalendarPeriod

• CddClaim

• CddProviderRole

• CheckPermissionsResult

• CheckRolesResult

• CheckpointWithData

• ClaimData

• ClaimScope

• ClaimTarget

• ComplexTransactionArgument

• Compliance

• ComplianceRequirements

• ConditionBase

• ConditionCompliance

• CountTransferRestriction

• CountTransferRestrictionInput

• DistributionPayment

• DistributionWithDetails

• EventIdentifier

• ExemptKey

• ExemptedClaim

• ExternalAgentCondition

• ExtrinsicData

• ExtrinsicDataWithFees

• Fees

• FeesBreakdown

• GroupedInstructions

• HistoricAgentOperation

• IdentityCondition

• IdentityRole

• IdentityWithClaims

• InvestorUniquenessClaim

• InvestorUniquenessV2Claim

• JurisdictionClaim

• KycClaim

• MiddlewareConfig

• MultiClaimCondition

• NetworkProperties

• NoArgsProcedureMethod

• NoDataClaim

• NoTypeClaim

• OfferingWithDetails

• PaginationOptions

• PayingAccount

• PercentageTransferRestriction

• PercentageTransferRestrictionInput

• PermissionGroups

• PermissionedAccount

• Permissions

• PlainTransactionArgument

• PortfolioCustodianRole

• PortfolioMovement

• ProcedureAuthorizationStatus

• ProcedureMethod

• ProcedureOpts

• ProtocolFees

• Requirement

• RequirementCompliance

• ResultSet

• ScheduleWithDetails

• Scope

• SectionPermissions

• SecurityIdentifier

• SellLockupClaim

• SignerValue

• SimpleEnumTransactionArgument

• SimplePermissions

• SingleClaimCondition

• ThirdPartyFees

• TickerOwnerRole

• TransactionPermissions

• TransferRestriction

• TrustedClaimIssuer

• VenueOwnerRole

Type Aliases

• AccountBalance

• AddRelayerPayingKeyAuthorizationData

• Authorization

• BecomeAgentAuthorizationData

• Claim

• Condition

• GenericAuthorizationData

• GroupPermissions

• InputCondition

• InputConditionBase

• InputCorporateActionTargets

• InputCorporateActionTaxWithholdings

• InputRequirement

• InputTrustedClaimIssuer

• JoinIdentityAuthorizationData

• NextKey

• PermissionsLike

• PortfolioCustodyAuthorizationData

• PortfolioLike

• PrivateKey

• Role

• RotatePrimaryKeyAuthorizationData

• RotatePrimaryKeyToSecondaryData

• ScopedClaim

• Signer

• SubCallback

• TransactionArgument

• UnscopedClaim

• UnsubCallback

References

AffirmationStatus

Re-exports AffirmationStatus

---

AgentWithGroup

Re-exports AgentWithGroup

---

AssetDetails

Re-exports AssetDetails

---

CaCheckpointType

Re-exports CaCheckpointType

---

CheckpointScheduleParams

Re-exports CheckpointScheduleParams

---

CorporateActionDefaultConfig

Re-exports CorporateActionDefaultConfig

---

CorporateActionKind

Re-exports CorporateActionKind

---

CorporateActionParams

Renames and re-exports Params

---

CorporateActionTargets

Re-exports CorporateActionTargets

---

DistributionParticipant

Re-exports DistributionParticipant

---

DividendDistributionDetails

Re-exports DividendDistributionDetails

---

DividendDistributionParams

Re-exports DividendDistributionParams

---

HistoricSettlement

Re-exports HistoricSettlement

---

IdentityBalance

Re-exports IdentityBalance

---

InputCaCheckpoint

Re-exports InputCaCheckpoint

---

InputTargets

Re-exports InputTargets

---

InputTaxWithholding

Re-exports InputTaxWithholding

---

InstructionAffirmation

Re-exports InstructionAffirmation

---

InstructionDetails

Re-exports InstructionDetails

---

InstructionStatus

Re-exports InstructionStatus

---

InstructionStatusResult

Re-exports InstructionStatusResult

---

InstructionType

Re-exports InstructionType

---

Investment

Re-exports Investment

---

Leg

Re-exports Leg

---

OfferingBalanceStatus

Re-exports OfferingBalanceStatus

---

OfferingDetails

Re-exports OfferingDetails

---

OfferingSaleStatus

Re-exports OfferingSaleStatus

---

OfferingStatus

Re-exports OfferingStatus

---

OfferingTier

Re-exports OfferingTier

---

OfferingTimingStatus

Re-exports OfferingTimingStatus

---

PortfolioBalance

Re-exports PortfolioBalance

---

ScheduleDetails

Re-exports ScheduleDetails

---

SettlementLeg

Re-exports SettlementLeg

---

SubsidyData

Re-exports SubsidyData

---

SubsidyWithAllowance

Re-exports SubsidyWithAllowance

---

TargetTreatment

Re-exports TargetTreatment

---

TaxWithholding

Re-exports TaxWithholding

---

TickerReservationDetails

Re-exports TickerReservationDetails

---

TickerReservationStatus

Re-exports TickerReservationStatus

---

Tier

Re-exports Tier

---

TransferBreakdown

Re-exports TransferBreakdown

---

TransferRestrictionResult

Re-exports TransferRestrictionResult

---

VenueDetails

Re-exports VenueDetails

---

VenueType

Re-exports VenueType

Type Aliases

AccountBalance

Ƭ AccountBalance: Balance

Defined in

types/index.ts:682

---

AddRelayerPayingKeyAuthorizationData

Ƭ AddRelayerPayingKeyAuthorizationData: Object

Type declaration

Name	Type
type	AddRelayerPayingKey
value	SubsidyData

Defined in

types/index.ts:1062

---

Authorization

Ƭ Authorization: RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData

Authorization request data corresponding to type

Defined in

types/index.ts:1082

---

BecomeAgentAuthorizationData

Ƭ BecomeAgentAuthorizationData: Object

Type declaration

Name	Type
type	BecomeAgent
value	KnownPermissionGroup | CustomPermissionGroup

Defined in

types/index.ts:1057

---

Claim

Ƭ Claim: ScopedClaim | UnscopedClaim

Defined in

types/index.ts:307

---

Condition

Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase

Defined in

types/index.ts:420

---

GenericAuthorizationData

Ƭ GenericAuthorizationData: Object

Type declaration

Name	Type
type	Exclude<AuthorizationType, RotatePrimaryKey | JoinIdentity | PortfolioCustody | BecomeAgent | AddRelayerPayingKey | RotatePrimaryKeyToSecondary>
value	string

Defined in

types/index.ts:1067

---

GroupPermissions

Ƭ GroupPermissions: Pick<Permissions, "transactions" | "transactionGroups">

Asset permissions shared by agents in a group

Defined in

types/index.ts:945

---

InputCondition

Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify<IdentityCondition, { identity: string | Identity }> | ExternalAgentCondition & InputConditionBase

Defined in

types/index.ts:428

---

InputConditionBase

Ƭ InputConditionBase: Modify<ConditionBase, { trustedClaimIssuers?: InputTrustedClaimIssuer[] }>

Defined in

types/index.ts:391

---

InputCorporateActionTargets

Ƭ InputCorporateActionTargets: Modify<CorporateActionTargets, { identities: (string | Identity)[] }>

Targets of a corporate action in a flexible structure for input purposes

Defined in

types/index.ts:1419

---

InputCorporateActionTaxWithholdings

Ƭ InputCorporateActionTaxWithholdings: Modify<TaxWithholding, { identity: string | Identity }>[]

Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes

Defined in

types/index.ts:1429

---

InputRequirement

Ƭ InputRequirement: Modify<Requirement, { conditions: InputCondition[] }>

Defined in

types/index.ts:454

---

InputTrustedClaimIssuer

Ƭ InputTrustedClaimIssuer: Modify<TrustedClaimIssuer, { identity: string | Identity }>

Defined in

types/index.ts:367

---

JoinIdentityAuthorizationData

Ƭ JoinIdentityAuthorizationData: Object

Type declaration

Name	Type
type	JoinIdentity
value	Permissions

Defined in

types/index.ts:1047

---

NextKey

Ƭ NextKey: string | BigNumber | null

Defined in

types/index.ts:689

---

PermissionsLike

Ƭ PermissionsLike: { assets?: SectionPermissions<string | Asset> | null ; portfolios?: SectionPermissions<PortfolioLike> | null } & { transactions?: TransactionPermissions | null } | { transactionGroups?: TxGroup[] }

Permissions to grant to a Signer over an Identity

Permissions

note TxGroups in the transactionGroups array will be transformed into their corresponding TxTags

Defined in

types/index.ts:1180

---

PortfolioCustodyAuthorizationData

Ƭ PortfolioCustodyAuthorizationData: Object

Type declaration

Name	Type
type	PortfolioCustody
value	NumberedPortfolio | DefaultPortfolio

Defined in

types/index.ts:1052

---

PortfolioLike

Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | { id: BigNumber ; identity: string | Identity }

Defined in

types/index.ts:1166

---

PrivateKey

Ƭ PrivateKey: { uri: string } | { mnemonic: string } | { seed: string }

URI|mnemonic|hex representation of a private key

Defined in

types/index.ts:1405

---

Role

Ƭ Role: TickerOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole | IdentityRole

Defined in

types/index.ts:125

---

RotatePrimaryKeyAuthorizationData

Ƭ RotatePrimaryKeyAuthorizationData: Object

Type declaration

Name	Type
type	RotatePrimaryKey

Defined in

types/index.ts:1038

---

RotatePrimaryKeyToSecondaryData

Ƭ RotatePrimaryKeyToSecondaryData: Object

Type declaration

Name	Type
type	RotatePrimaryKeyToSecondary
value	Permissions

Defined in

types/index.ts:1042

---

ScopedClaim

Ƭ ScopedClaim: JurisdictionClaim | InvestorUniquenessClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim

Defined in

types/index.ts:294

---

Signer

Ƭ Signer: Identity | Account

Defined in

types/index.ts:1148

---

SubCallback

Ƭ SubCallback<T>: (result: T) => void | Promise<void>

Type parameters

Name
T

Type declaration

▸ (result): void | Promise<void>

Parameters

Name	Type
result	T

Returns

void | Promise<void>

Defined in

types/index.ts:651

---

TransactionArgument

Ƭ TransactionArgument: { _rawType: TypeDef ; name: string ; optional: boolean } & PlainTransactionArgument | ArrayTransactionArgument | SimpleEnumTransactionArgument | ComplexTransactionArgument

Defined in

types/index.ts:1137

---

UnscopedClaim

Ƭ UnscopedClaim: NoDataClaim | NoTypeClaim | CddClaim | InvestorUniquenessV2Claim

Defined in

types/index.ts:305

---

UnsubCallback

Ƭ UnsubCallback: () => void

Type declaration

▸ (): void

Returns

void

Defined in

types/index.ts:653