@ledgerhq/types-live/src/nft.ts

Ledger Live main types.

import type BigNumber from "bignumber.js";

// TODO: cryptocurrencyIds should be the one from cryptoassets package
export type CryptoCurrencyIds = string;

/**
 *
 */
export type NFTStandard = "ERC721" | "ERC1155" | "SPL";

/**
 *
 */
export type NFTMediaSize = "preview" | "big" | "original";

/**
 *
 */
export type NFTMedias = Record<
  NFTMediaSize,
  {
    uri: string;
    mediaType: string; // mime-type
  }
>;

/**
 *
 */
export type NFTMetadata = {
  tokenName: string | null;
  nftName: string | null;
  medias: NFTMedias;
  description: string | null;
  properties: Array<Record<"key" | "value", string>>;
  links: Record<NFTMetadataLinksProviders, string | null>;
  staxImage?: string;
};

/**
 *
 */
export type NFTCollectionMetadata = {
  tokenName: string | null;
};

/**
 *
 */
export type ProtoNFT = {
  // id crafted by live
  id: string;
  // id on chain
  tokenId: string;
  amount: BigNumber;
  contract: string;
  standard: NFTStandard;
  currencyId: CryptoCurrencyIds;
  metadata?: NFTMetadata | undefined;
};

/**
 *
 */
export type ProtoNFTRaw = Omit<ProtoNFT, "amount"> & {
  amount: string;
};

/**
 *
 */
export type NFT = Omit<ProtoNFT, "metadata"> & {
  metadata: NFTMetadata;
};

/**
 *
 */
export type NFTMetadataLinksProviders = "opensea" | "rarible" | "etherscan" | "explorer";

/**
 *
 */
export type NFTMetadataResponse = {
  status: 200 | 404 | 500;
  result?: {
    contract: string;
    tokenId: string;
    tokenName: string | null;
    nftName: string | null;
    medias: NFTMedias;
    description: string | null;
    properties: Array<Record<"key" | "value", string>>;
    links: Record<NFTMetadataLinksProviders, string>;
    staxImage?: string;
    spamScore?: number;
  } | null;
};

/**
 *
 */
export type NFTCollectionMetadataResponse = {
  status: 200 | 404 | 500;
  result?: {
    contract: string;
    tokenName: string | null;
    spamScore?: number;
  } | null;
};

/**
 *
 */
export type FloorPrice = {
  ticker: string;
  value: number;
};