Module: Entities Types
Enumerations
- AuthorizationType
- ClaimType
- ConditionTarget
- ConditionType
- PermissionGroupType
- PermissionType
- ScopeType
- SignerType
- StatType
Interfaces
- AccreditedClaim
- ActiveTransferRestrictions
- AddCountStatInput
- AffiliateClaim
- BlockedClaim
- BuyLockupClaim
- CddClaim
- CheckPermissionsResult
- CheckRolesResult
- CheckpointWithData
- ClaimCountTransferRestriction
- ClaimData
- ClaimPercentageTransferRestriction
- ClaimScope
- ClaimTarget
- Compliance
- ComplianceRequirements
- ConditionBase
- ConditionCompliance
- CountTransferRestriction
- CustomClaim
- DistributionPayment
- DistributionWithDetails
- ExemptedClaim
- ExternalAgentCondition
- FungiblePortfolioMovement
- IdentityCondition
- IdentityWithClaims
- JurisdictionClaim
- KycClaim
- MultiClaimCondition
- OfferingWithDetails
- PaginationOptions
- PercentageTransferRestriction
- PermissionGroups
- PermissionedAccount
- Permissions
- Requirement
- RequirementCompliance
- ResultSet
- ScheduleWithDetails
- Scope
- SectionPermissions
- SellLockupClaim
- SignerValue
- SimplePermissions
- SingleClaimCondition
- StatAccreditedClaimInput
- StatAffiliateClaimInput
- StatClaimIssuer
- StatJurisdictionClaimInput
- TransactionPermissions
- TrustedClaimIssuer
References
AccountBalance
Re-exports AccountBalance
AccountIdentityRelation
Re-exports AccountIdentityRelation
AccountKeyType
Re-exports AccountKeyType
AccountTypeInfo
Re-exports AccountTypeInfo
AffirmationStatus
Re-exports AffirmationStatus
AgentWithGroup
Re-exports AgentWithGroup
AnyJson
Re-exports AnyJson
Asset
Re-exports Asset
AssetDetails
Re-exports AssetDetails
AssetDocument
Re-exports AssetDocument
AssetWithGroup
Re-exports AssetWithGroup
Balance
Re-exports Balance
BaseHistoricAssetTransaction
Re-exports BaseHistoricAssetTransaction
CaCheckpointType
Re-exports CaCheckpointType
CheckpointScheduleParams
Re-exports CheckpointScheduleParams
CollectionKey
Re-exports CollectionKey
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
FungibleLeg
Re-exports FungibleLeg
GlobalMetadataKey
Re-exports GlobalMetadataKey
GroupedInstructions
Re-exports GroupedInstructions
GroupedInvolvedInstructions
Re-exports GroupedInvolvedInstructions
HeldNfts
Re-exports HeldNfts
HistoricAgentOperation
Re-exports HistoricAgentOperation
HistoricAssetTransaction
Re-exports HistoricAssetTransaction
HistoricInstruction
Re-exports HistoricInstruction
HistoricNftTransaction
Re-exports HistoricNftTransaction
HistoricPolyxTransaction
Re-exports HistoricPolyxTransaction
HistoricSettlement
Re-exports HistoricSettlement
IdentityBalance
Re-exports IdentityBalance
IdentityHeldNfts
Re-exports IdentityHeldNfts
InputCaCheckpoint
Re-exports InputCaCheckpoint
InputTargets
Re-exports InputTargets
InputTaxWithholding
Re-exports InputTaxWithholding
InstructionAffirmation
Re-exports InstructionAffirmation
InstructionDetails
Re-exports InstructionDetails
InstructionEndCondition
Re-exports InstructionEndCondition
InstructionStatus
Re-exports InstructionStatus
InstructionStatusResult
Re-exports InstructionStatusResult
InstructionType
Re-exports InstructionType
InstructionsByStatus
Re-exports InstructionsByStatus
Investment
Re-exports Investment
KnownAssetType
Re-exports KnownAssetType
KnownNftType
Re-exports KnownNftType
Leg
Re-exports Leg
MediatorAffirmation
Re-exports MediatorAffirmation
MetadataDetails
Re-exports MetadataDetails
MetadataKeyId
Re-exports MetadataKeyId
MetadataLockStatus
Re-exports MetadataLockStatus
MetadataSpec
Re-exports MetadataSpec
MetadataType
Re-exports MetadataType
MetadataValue
Re-exports MetadataValue
MetadataValueDetails
Re-exports MetadataValueDetails
MultiSigDetails
Re-exports MultiSigDetails
MultiSigProposalAction
Re-exports MultiSigProposalAction
MultiSigProposalDetails
Re-exports MultiSigProposalDetails
MultiSigProposalVote
Re-exports MultiSigProposalVote
NftLeg
Re-exports NftLeg
NftMetadata
Re-exports NftMetadata
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
PortfolioCollection
Re-exports PortfolioCollection
ProposalStatus
Re-exports ProposalStatus
ScheduleDetails
Re-exports ScheduleDetails
SecurityIdentifier
Re-exports SecurityIdentifier
SecurityIdentifierType
Re-exports SecurityIdentifierType
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
TransferError
Re-exports TransferError
TransferRestrictionResult
Re-exports TransferRestrictionResult
TransferStatus
Re-exports TransferStatus
UniqueIdentifiers
Re-exports UniqueIdentifiers
VenueDetails
Re-exports VenueDetails
VenueFilteringDetails
Re-exports VenueFilteringDetails
VenueType
Re-exports VenueType
Type Aliases
Account
Ƭ Account: Account
Defined in
AddRelayerPayingKeyAuthorizationData
Ƭ AddRelayerPayingKeyAuthorizationData: Object
Type declaration
| Name | Type |
|---|---|
type | AddRelayerPayingKey |
value | SubsidyData |
Defined in
AttestPrimaryKeyRotationAuthorizationData
Ƭ AttestPrimaryKeyRotationAuthorizationData: Object
Type declaration
| Name | Type |
|---|---|
type | AttestPrimaryKeyRotation |
value | Identity |
Defined in
Authorization
Ƭ Authorization: AttestPrimaryKeyRotationAuthorizationData | RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData
Authorization request data corresponding to type
Defined in
AuthorizationRequest
Ƭ AuthorizationRequest: AuthorizationRequest
Defined in
BecomeAgentAuthorizationData
Ƭ BecomeAgentAuthorizationData: Object
Type declaration
| Name | Type |
|---|---|
type | BecomeAgent |
value | KnownPermissionGroup | CustomPermissionGroup |
Defined in
Checkpoint
Ƭ Checkpoint: Checkpoint
Defined in
CheckpointSchedule
Ƭ CheckpointSchedule: CheckpointSchedule
Defined in
ChildIdentity
Ƭ ChildIdentity: ChildIdentity
Defined in
Claim
Ƭ Claim: ScopedClaim | UnscopedClaim
Defined in
ClaimCountStatInput
Ƭ ClaimCountStatInput: { claimType: Accredited ; issuer: Identity ; value: { accredited: BigNumber ; nonAccredited: BigNumber } } | { claimType: Affiliate ; issuer: Identity ; value: { affiliate: BigNumber ; nonAffiliate: BigNumber } } | { claimType: Jurisdiction ; issuer: Identity ; value: { count: BigNumber ; countryCode: CountryCode }[] }
Defined in
Condition
Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase
Defined in
CorporateAction
Ƭ CorporateAction: CorporateAction
Defined in
CustomPermissionGroup
Ƭ CustomPermissionGroup: CustomPermissionGroup
Defined in
DefaultPortfolio
Ƭ DefaultPortfolio: DefaultPortfolio
Defined in
DefaultTrustedClaimIssuer
Ƭ DefaultTrustedClaimIssuer: DefaultTrustedClaimIssuer
Defined in
DividendDistribution
Ƭ DividendDistribution: DividendDistribution
Defined in
FungibleAsset
Ƭ FungibleAsset: FungibleAsset
Defined in
GenericAuthorizationData
Ƭ GenericAuthorizationData: Object
Type declaration
| Name | Type |
|---|---|
type | Exclude<AuthorizationType, RotatePrimaryKey | JoinIdentity | PortfolioCustody | BecomeAgent | AddRelayerPayingKey | RotatePrimaryKeyToSecondary | AttestPrimaryKeyRotation> |
value | string |
Defined in
GroupPermissions
Ƭ GroupPermissions: Pick<Permissions, "transactions" | "transactionGroups">
Asset permissions shared by agents in a group
Defined in
Identity
Ƭ Identity: Identity
Defined in
InputCondition
Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify <IdentityCondition, { identity: string | Identity }> | ExternalAgentCondition & InputConditionBase
Defined in
InputConditionBase
Ƭ InputConditionBase: Modify <ConditionBase, { trustedClaimIssuers?: InputTrustedClaimIssuer[] }>
Defined in
InputRequirement
Ƭ InputRequirement: Modify <Requirement, { conditions: InputCondition[] }>
Defined in
InputStatClaim
Ƭ InputStatClaim: StatJurisdictionClaimInput | StatAccreditedClaimInput | StatAffiliateClaimInput
Defined in
InputStatType
Ƭ InputStatType: { type: Count | Balance } | { claimIssuer: StatClaimIssuer ; type: ScopedCount | ScopedBalance }
Defined in
InputTrustedClaimIssuer
Ƭ InputTrustedClaimIssuer: Modify <TrustedClaimIssuer, { identity: string | Identity }>
Defined in
Instruction
Ƭ Instruction: Instruction
Defined in
JoinIdentityAuthorizationData
Ƭ JoinIdentityAuthorizationData: Object
Type declaration
| Name | Type |
|---|---|
type | JoinIdentity |
value | Permissions |
Defined in
KnownPermissionGroup
Ƭ KnownPermissionGroup: KnownPermissionGroup
Defined in
MetadataEntry
Ƭ MetadataEntry: MetadataEntry
Defined in
MultiSig
Ƭ MultiSig: MultiSig
Defined in
NextKey
Ƭ NextKey: string | BigNumber | null
Defined in
Nft
Ƭ Nft: Nft
Defined in
NftCollection
Ƭ NftCollection: NftCollection
Defined in
NonFungiblePortfolioMovement
Ƭ NonFungiblePortfolioMovement: Object
Type declaration
| Name | Type | Description |
|---|---|---|
asset | NftCollection | string | - |
memo? | string | identifier string to help differentiate transfers |
nfts | (Nft | BigNumber)[] | - |
Defined in
NumberedPortfolio
Ƭ NumberedPortfolio: NumberedPortfolio
Defined in
Offering
Ƭ Offering: Offering
Defined in
PermissionsLike
Ƭ PermissionsLike: { assets?: SectionPermissions<string | FungibleAsset> | 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
| Name | Type |
|---|---|
type | PortfolioCustody |
value | NumberedPortfolio | DefaultPortfolio |
Defined in
PortfolioLike
Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | { id: BigNumber ; identity: string | Identity }
Defined in
PortfolioMovement
Ƭ PortfolioMovement: FungiblePortfolioMovement | NonFungiblePortfolioMovement
Defined in
RotatePrimaryKeyAuthorizationData
Ƭ RotatePrimaryKeyAuthorizationData: Object
Type declaration
| Name | Type |
|---|---|
type | RotatePrimaryKey |
Defined in
RotatePrimaryKeyToSecondaryData
Ƭ RotatePrimaryKeyToSecondaryData: Object
Type declaration
| Name | Type |
|---|---|
type | RotatePrimaryKeyToSecondary |
value | Permissions |
Defined in
ScopedClaim
Ƭ ScopedClaim: JurisdictionClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim | CustomClaim
Defined in
Signer
Defined in
StatClaimType
Ƭ StatClaimType: Accredited | Affiliate | Jurisdiction
Defined in
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
Subsidy
Ƭ Subsidy: Subsidy
Defined in
TickerReservation
Ƭ TickerReservation: TickerReservation
Defined in
UnscopedClaim
Ƭ UnscopedClaim: CddClaim
Defined in
UnsubCallback
Ƭ UnsubCallback: () => void
Type declaration
▸ (): void
Returns
void
Defined in
Venue
Ƭ Venue: Venue