Class NftClient

You may use the builders() client to access the underlying Transaction Builders of this module.

const buildersClient = metaplex.nfts().builders();

You may use the pdas() client to build PDAs related to this module.

const pdasClient = metaplex.nfts().pdas();

Finds an NFT or an SFT by its mint address.

const nft = await metaplex
  .nfts()
  .findByMint({ mintAddress };

Finds an NFT or an SFT by its metadata address.

const nft = await metaplex
  .nfts()
  .findByMetadata({ metadata };

Finds an NFT or an SFT by its token address.

const nft = await metaplex
  .nfts()
  .findByToken({ token };

Finds multiple NFTs and SFTs by their creator at a given position.

// Find all by first creator.
const nfts = await metaplex
  .nfts()
  .findAllByCreator({ creator };

// Find all by second creator.
const nfts = await metaplex
  .nfts()
  .findAllByCreator({ creator, position: 2 };

Finds multiple NFTs and SFTs by a given list of mint addresses.

const nfts = await metaplex
  .nfts()
  .findAllByMintList({ mints: [...] };

Finds multiple NFTs and SFTs by a given owner.

const nfts = await metaplex
  .nfts()
  .findAllByOwner({ owner };

Finds multiple NFTs and SFTs by a given update authority.

const nfts = await metaplex
  .nfts()
  .findAllByUpdateAuthority({ updateAuthority };

Finds an NFT or an SFT by its mint address.

const nft = await metaplex
  .nfts()
  .findByAssetId({ assetId };

Transforms a Metadata model into a Nft or Sft model.

const nfts = await metaplex
  .nfts()
  .load({ metadata };

Helper method that refetches a given model and returns an instance of the same type.

nft = await metaplex.nfts().refresh(nft);
sft = await metaplex.nfts().refresh(sft);
nftWithToken = await metaplex.nfts().refresh(nftWithToken);

Creates a new NFT.

const { nft } = await metaplex
  .nfts()
  .create({
    name: 'My NFT',
    uri: 'https://example.com/my-nft',
    sellerFeeBasisPoints: 250, // 2.5%
  };

Creates a new SFT.

const { sft } = await metaplex
  .nfts()
  .createSft({
    name: 'My SFT',
    uri: 'https://example.com/my-sft',
    sellerFeeBasisPoints: 250, // 2.5%
  };

Prints a new edition from an original NFT.

const { nft } = await metaplex
  .nfts()
  .printNewEdition({ originalMint };

Uploads a JSON Metadata object to the current storage provider.

const { uri } = await metaplex
  .nfts()
  .uploadMetadata({
    name: "My NFT",
    description: "My description",
    image: "https://arweave.net/123",
  };

Updates an existing NFT or SFT.

await metaplex
  .nfts()
  .update({ nftOrSft, name: "My new NFT name" });

Deletes an existing NFT.

await metaplex
  .nfts()
  .delete({ mintAddress };

Approve a new delegate authority for an NFT or SFT.

await metaplex.nfts().delegate({
  nftOrSft,
  delegate,
  delegateArgs
});

Revoke an existing delegate authority for an NFT or SFT.

await metaplex.nfts().revoke({ sftOrNft, delegate });

Utilizes a usable NFT.

await metaplex.nfts().use({ mintAddress });
await metaplex.nfts().use({ mintAddress, numberOfUses: 3 });

Approves a new use authority.

await metaplex
  .nfts()
  .approveUseAuthority({ mintAddress, user };

Revokes an existing use authority.

await metaplex
  .nfts()
  .revokeUseAuthority({ mintAddress, user };

Verifies the creator of an NFT or SFT.

await metaplex
  .nfts()
  .verifyCreator({ mintAddress, creator };

Unverifies the creator of an NFT or SFT.

await metaplex
  .nfts()
  .unverifyCreator({ mintAddress, creator };

Verifies the collection of an NFT or SFT.

await metaplex
  .nfts()
  .verifyCollection({ mintAddress, collectionMintAddress };

Unverifies the collection of an NFT or SFT.

await metaplex
  .nfts()
  .unverifyCollection({ mintAddress, collectionMintAddress };

Approves a new collection authority.

await metaplex
  .nfts()
  .approveCollectionAuthority({
    mintAddress,
    collectionAuthority,
  };

Revokes an existing collection authority.

await metaplex
  .nfts()
  .revokeCollectionAuthority({ mintAddress, collectionAuthority };

Migrates a legacy Collection NFT to a sized Collection NFT. Both can act as a Collection for NFTs but only the latter keeps track of the size of the collection on chain.

await metaplex
  .nfts()
  .migrateToSizedCollection({ mintAddress, size: toBigNumber(10000) };

Lock a programmable NFT.

await metaplex.nfts().lock({ nftOrSft, authority });

Unlock a programmable NFT.

await metaplex.nfts().unlock({ nftOrSft, authority });

Mint token(s) for an NFT or SFT.

await metaplex.nfts().mint({
  nftOrSft,
  toOwner,
  amount: token(5),
});

Transfers an NFT or SFT from one account to another.

await metaplex.nfts().transfer({
  nftOrSft,
  toOwner,
  amount: token(5),
});

Freezes a NFT via its delegate authority.

await metaplex
  .nfts()
  .freezeDelegatedNft({ mintAddress, delegateAuthority };

Thaws a NFT via its delegate authority.

await metaplex
  .nfts()
  .thawDelegatedNft({ mintAddress, delegateAuthority };