api.entities.Asset.types

Module: api/entities/Asset/types

Table of contents

References

• CaCheckpointType
• CorporateActionDefaultConfig
• InputCaCheckpoint

Enumerations

• KnownAssetType
• KnownNftType
• SecurityIdentifierType
• TransferError
• TransferStatus

Interfaces

• AgentWithGroup
• AssetDetails
• AssetDocument
• AssetWithGroup
• BaseHistoricAssetTransaction
• HeldNfts
• HistoricAgentOperation
• HistoricAssetTransaction
• HistoricNftTransaction
• IdentityBalance
• IdentityHeldNfts
• NftMetadata
• SecurityIdentifier
• TransferBreakdown
• TransferRestrictionResult
• UniqueIdentifiers
• VenueFilteringDetails

Type Aliases

• Asset
• CollectionKey
• MetadataKeyId

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:27

---

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:243

---

MetadataKeyId

Ƭ MetadataKeyId: { id: BigNumber ; type: Global } | { assetId: string ; id: BigNumber ; type: Local }

The data needed to uniquely identify a metadata specification

Defined in

api/entities/Asset/types.ts:205