types
@polymeshassociation/polymesh-sdk / Modules / types
Module: types
Table of contents
References
Enumerations
Interfaces
Type Aliases
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
AddRelayerPayingKeyAuthorizationData
Ƭ AddRelayerPayingKeyAuthorizationData: Object
Type declaration
value
Defined in
Authorization
Ƭ Authorization: RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData
Authorization request data corresponding to type
Defined in
BecomeAgentAuthorizationData
Ƭ BecomeAgentAuthorizationData: Object
Type declaration
Defined in
Claim
Ƭ Claim: ScopedClaim | UnscopedClaim
Defined in
Condition
Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase
Defined in
GenericAuthorizationData
Ƭ GenericAuthorizationData: Object
Type declaration
type
value
string
Defined in
GroupPermissions
Ƭ GroupPermissions: Pick<Permissions, "transactions" | "transactionGroups">
Asset permissions shared by agents in a group
Defined in
InputCondition
Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify<IdentityCondition, { identity: string | Identity }> | ExternalAgentCondition & InputConditionBase
Defined in
InputConditionBase
Ƭ InputConditionBase: Modify<ConditionBase, { trustedClaimIssuers?: InputTrustedClaimIssuer[] }>
Defined in
InputCorporateActionTargets
Ƭ InputCorporateActionTargets: Modify<CorporateActionTargets, { identities: (string | Identity)[] }>
Targets of a corporate action in a flexible structure for input purposes
Defined in
InputCorporateActionTaxWithholdings
Ƭ InputCorporateActionTaxWithholdings: Modify<TaxWithholding, { identity: string | Identity }>[]
Per-Identity tax withholdings of a corporate action in a flexible structure for input purposes
Defined in
InputRequirement
Ƭ InputRequirement: Modify<Requirement, { conditions: InputCondition[] }>
Defined in
InputTrustedClaimIssuer
Ƭ InputTrustedClaimIssuer: Modify<TrustedClaimIssuer, { identity: string | Identity }>
Defined in
JoinIdentityAuthorizationData
Ƭ JoinIdentityAuthorizationData: Object
Type declaration
type
value
Defined in
NextKey
Ƭ NextKey: string | BigNumber | null
Defined in
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
note TxGroups in the transactionGroups array will be transformed into their corresponding TxTags
Defined in
PortfolioCustodyAuthorizationData
Ƭ PortfolioCustodyAuthorizationData: Object
Type declaration
Defined in
PortfolioLike
Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | { id: BigNumber ; identity: string | Identity }
Defined in
PrivateKey
Ƭ PrivateKey: { uri: string } | { mnemonic: string } | { seed: string }
URI|mnemonic|hex representation of a private key
Defined in
Role
Ƭ Role: TickerOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole | IdentityRole
Defined in
RotatePrimaryKeyAuthorizationData
Ƭ RotatePrimaryKeyAuthorizationData: Object
Type declaration
type
Defined in
RotatePrimaryKeyToSecondaryData
Ƭ RotatePrimaryKeyToSecondaryData: Object
Type declaration
Defined in
ScopedClaim
Ƭ ScopedClaim: JurisdictionClaim | InvestorUniquenessClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim
Defined in
Signer
Defined in
SubCallback
Ƭ SubCallback<T>: (result: T) => void | Promise<void>
Type parameters
T
Type declaration
▸ (result): void | Promise<void>
Parameters
result
T
Returns
void | Promise<void>
Defined in
TransactionArgument
Ƭ TransactionArgument: { _rawType: TypeDef ; name: string ; optional: boolean } & PlainTransactionArgument | ArrayTransactionArgument | SimpleEnumTransactionArgument | ComplexTransactionArgument
Defined in
UnscopedClaim
Ƭ UnscopedClaim: NoDataClaim | NoTypeClaim | CddClaim | InvestorUniquenessV2Claim
Defined in
UnsubCallback
Ƭ UnsubCallback: () => void
Type declaration
▸ (): void
Returns
void
Defined in
Last updated