Module: Asset Types
Enumerations
Interfaces
- ActiveTransferRestrictions
- AgentWithGroup
- AssetDetails
- AssetDocument
- AssetStat
- AssetWithGroup
- BaseHistoricAssetTransaction
- HeldNfts
- HistoricAgentOperation
- HistoricAssetTransaction
- HistoricNftTransaction
- IdentityBalance
- IdentityHeldNfts
- NftMetadata
- SecurityIdentifier
- TransferBreakdown
- TransferExemptKey
- TransferRestrictionExemption
- TransferRestrictionResult
- TransferRestrictionStatValues
- UniqueIdentifiers
- VenueFilteringDetails
References
CaCheckpointType
Re-exports CaCheckpointType
CorporateActionDefaultConfig
Re-exports CorporateActionDefaultConfig
InputCaCheckpoint
Re-exports InputCaCheckpoint
Type Aliases
Asset
Ƭ Asset: FungibleAsset | NftCollection
Represents a generic asset on chain. Common functionality (e.g. documents) can be interacted with directly. For type specific functionality (e.g. issue) the type can
be narrowed via instanceof operator, or by using a more specific getter
Defined in
api/entities/Asset/types.ts:32
ClaimStatValue
Ƭ ClaimStatValue<T>: T extends Jurisdiction ? JurisdictionValue[] : ClaimValue
Maps claim types to their corresponding statistical value types
Type parameters
| Name | Type |
|---|---|
T | extends TrustedFor |
Defined in
api/entities/Asset/types.ts:435
ClaimValue
Ƭ ClaimValue: Object
For all claim types except Jurisdiction - tracks holders with and without the claim
Type declaration
| Name | Type | Description |
|---|---|---|
withClaim | BigNumber | The number of individual Asset holders that have the claim, or the total balance of tokens held by all holders with the claim |
withoutClaim | BigNumber | The number of individual Asset holders that do not have the claim, or the total balance of tokens held by all holders without the claim |
Defined in
api/entities/Asset/types.ts:404
CollectionKey
Ƭ CollectionKey: MetadataKeyId & MetadataDetails
A metadata entry for which each NFT in the collection must have an entry for
Note
each NFT must have an entry for each metadata value, the entry should comply with the relevant spec
Defined in
api/entities/Asset/types.ts:248
JurisdictionValue
Ƭ JurisdictionValue: Object
For Jurisdiction claims - tracks holders by country code and those without jurisdiction
Type declaration
| Name | Type | Description |
|---|---|---|
countryCode | CountryCode | null | The country code of the jurisdiction Note null if the jurisdiction is not specified (no jurisdiction claim) |
value | BigNumber | The number of individual Asset holders with this jurisdiction (or without any jurisdiction if countryCode is null), or the total balance of tokens held by all such holders |
Defined in
api/entities/Asset/types.ts:419
MetadataKeyId
Ƭ MetadataKeyId: { id: BigNumber ; type: Global } | { assetId: string ; id: BigNumber ; type: Local }
The data needed to uniquely identify a metadata specification