Protected
Readonly
metaplexCreates a new NFT.
const transactionBuilder = await metaplex
.nfts()
.builders()
.create({
name: 'My NFT',
uri: 'https://example.com/my-nft',
sellerFeeBasisPoints: 250, // 2.5%
});
Optional
options: TransactionBuilderOptionsCreates a new SFT.
const transactionBuilder = await metaplex
.nfts()
.builders()
.createSft({
name: 'My SFT',
uri: 'https://example.com/my-sft',
sellerFeeBasisPoints: 250, // 2.5%
});
Optional
options: TransactionBuilderOptionsPrints a new edition from an original NFT.
const transactionBuilder = await metaplex
.nfts()
.builders()
.printNewEdition({ originalMint });
Optional
options: TransactionBuilderOptionsUpdates an existing NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.update({ nftOrSft, name: "My new NFT name" });
Optional
options: TransactionBuilderOptionsDeletes an existing NFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.delete({ mintAddress });
Optional
options: TransactionBuilderOptionsApprove a new delegate authority for an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.delegate({
nftOrSft,
delegate,
delegateArgs
});
Optional
options: TransactionBuilderOptionsRevoke an existing delegate authority for an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.revoke({ sftOrNft, delegate });
Optional
options: TransactionBuilderOptionsUtilizes a usable NFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.use({ mintAddress });
Optional
options: TransactionBuilderOptionsApproves a new use authority.
const transactionBuilder = metaplex
.nfts()
.builders()
.approveUseAuthority({ mintAddress, user });
Optional
options: TransactionBuilderOptionsRevokes an existing use authority.
const transactionBuilder = metaplex
.nfts()
.builders()
.revokeUseAuthority({ mintAddress, user });
Optional
options: TransactionBuilderOptionsVerifies the creator of an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.verifyCreator({ mintAddress, creator });
Optional
options: TransactionBuilderOptionsUnverifies the creator of an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.unverifyCreator({ mintAddress, creator });
Optional
options: TransactionBuilderOptionsVerifies the collection of an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.verifyCollection({ mintAddress, collectionMintAddress });
Optional
options: TransactionBuilderOptionsUnverifies the collection of an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.unverifyCollection({ mintAddress, collectionMintAddress });
Optional
options: TransactionBuilderOptionsApproves a new collection authority.
const transactionBuilder = metaplex
.nfts()
.builders()
.approveCollectionAuthority({
mintAddress,
collectionAuthority,
});
Optional
options: TransactionBuilderOptionsRevokes an existing collection authority.
const transactionBuilder = metaplex
.nfts()
.builders()
.revokeCollectionAuthority({ mintAddress, collectionAuthority });
Optional
options: TransactionBuilderOptionsMigrates 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.
const transactionBuilder = metaplex
.nfts()
.builders()
.migrateToSizedCollection({ mintAddress, size: toBigNumber(10000) });
Optional
options: TransactionBuilderOptionsLock a programmable NFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.lock({ nftOrSft, authority });
Optional
options: TransactionBuilderOptionsUnlock a programmable NFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.unlock({ nftOrSft, authority });
Optional
options: TransactionBuilderOptionsMint token(s) for an NFT or SFT.
const transactionBuilder = metaplex
.nfts()
.builders()
.mint({
nftOrSft,
toOwner,
amount: token(5),
});
Optional
options: TransactionBuilderOptionsTransfers an NFT or SFT from one account to another.
const transactionBuilder = metaplex
.nfts()
.builders()
.transfer({
nftOrSft,
toOwner,
amount: token(5),
});
Optional
options: TransactionBuilderOptionsFreezes a NFT via its delegate authority.
const transactionBuilder = metaplex
.nfts()
.builders()
.freezeDelegatedNft({ mintAddress, delegateAuthority });
Optional
options: TransactionBuilderOptionsThaws a NFT via its delegate authority.
const transactionBuilder = metaplex
.nfts()
.builders()
.thawDelegatedNft({ mintAddress, delegateAuthority });
Optional
options: TransactionBuilderOptionsGenerated using TypeDoc
This client allows you to access the underlying Transaction Builders for the write operations of the NFT module.
See
NftClient