Type alias Nft

Type declaration

• Readonly symbol: string

  The on-chain symbol of the asset, stored in the Metadata account. E.g. "MYNFT"

• Readonly json: Option<JsonMetadata<string>>

  The JSON metadata associated with the metadata account.

• Readonly collection: Option<{
      address: PublicKey;
      verified: boolean;
  }>

  The parent collection the asset belongs to.

• Readonly creators: Creator[]

  The creators of the asset. Each object within the array contains the address, the shares in percent (i.e. 5 is 5%) and whether or not the creator is verified (i.e. they signed the asset).

• Readonly name: string

  The on-chain name of the asset, stored in the Metadata account. E.g. "My NFT #123"

• Readonly sellerFeeBasisPoints: number

  The royalties in percent basis point (i.e. 250 is 2.5%) that should be paid to the creators on each secondary sale.

• Readonly uri: string

  The URI that points to the JSON metadata of the asset. This URI is used to load the json property of this object.

• Readonly updateAuthorityAddress: PublicKey

  The address of the authority that is allowed to make changes to the Metadata account.

• Readonly jsonLoaded: boolean

  Whether or not the JSON metadata was loaded in the first place. When this is false, the json property is should be ignored.

• Readonly isMutable: boolean

  Whether or not the asset is mutable. When set to false no one can update the Metadata account, not even the update authority.

• Readonly primarySaleHappened: boolean

  Whether or not the asset has already been sold to its first buyer. When set to false, all royalties should be paid to the creators. When set to true, royalties should be calculate as usual.

• Readonly editionNonce: Option<number>

  Stores the bump of the edition PDA.

• Readonly tokenStandard: Option<TokenStandard>

  This enum indicates which type of asset we are dealing with. It can be an NFT, a limited edition of an original NFT, a fungible asset (i.e. it has zero decimals) or a fungible token (i.e. it has more than zero decimals).

• Readonly collectionDetails: Option<{
      version: "V1";
      size: BigNumber;
  }>

  When this field is not null, it indicates that the asset is a collection. Every time an asset is verified/unverified as part of this collection, the size field inside this object will be updated accordingly.

• Readonly uses: Option<{
      useMethod: UseMethod;
      remaining: BigNumber;
      total: BigNumber;
  }>

  When this field is not null, it indicates that the asset can be "used" by its owner or any approved "use authorities".

• Readonly programmableConfig: Option<{
      __kind: "V1";
  } & Omit<{
      ruleSet: COption<PublicKey>;
  }, "void">>

  Programmable configuration for the asset.

• Readonly model: "nft"

  A model identifier to distinguish models in the SDK.

• Readonly address: PublicKey

  The mint address of the NFT.

• Readonly metadataAddress: Pda

  The metadata address of the NFT.

• Readonly mint: Mint

  The mint account of the NFT.

• Readonly edition: NftEdition

  Defines whether the NFT is an original edition or a printed edition and provides additional information accordingly.

• Optional Readonly compression?: undefined | ReadApiCompressionMetadata