Type alias UpdateNftBuilderParams

UpdateNftBuilderParams: {
    nftOrSft: Pick<Sft, "symbol" | "collection" | "creators" | "name" | "address" | "sellerFeeBasisPoints" | "uri" | "tokenStandard" | "uses" | "programmableConfig">;
    symbol?: undefined | string;
    collection?: undefined | Option<PublicKey>;
    creators?: undefined | CreatorInput[];
    name?: undefined | string;
    sellerFeeBasisPoints?: undefined | number;
    ruleSet?: undefined | Option<PublicKey>;
    updateAuthority?: undefined | Signer;
    uri?: undefined | string;
    isMutable?: undefined | boolean;
    primarySaleHappened?: undefined | boolean;
    collectionDetails?: undefined | {
        __kind: "V1";
    } & Omit<{
        size: bignum;
    }, "void">;
    uses?: undefined | Option<Uses>;
    collectionAuthority?: undefined | Option<Signer>;
    authority?: undefined | Signer | TokenMetadataAuthority;
    authorizationDetails?: undefined | TokenMetadataAuthorizationDetails;
    collectionAuthorityIsDelegated?: undefined | boolean;
    collectionIsSized?: undefined | boolean;
    newUpdateAuthority?: undefined | PublicKey;
    oldCollectionAuthority?: undefined | Signer;
    oldCollectionIsSized?: undefined | boolean;
    updateMetadataInstructionKey?: undefined | string;
}

Type declaration

  • nftOrSft: Pick<Sft, "symbol" | "collection" | "creators" | "name" | "address" | "sellerFeeBasisPoints" | "uri" | "tokenStandard" | "uses" | "programmableConfig">

    The NFT or SFT to update. We only need a subset of the Sft (or Nft) model to figure out the current values for the data of the metadata account and only update the parts that are different.

  • Optional symbol?: undefined | string

    The new on-chain symbol of the asset.

    Default Value

    Defaults to not being updated.

  • Optional collection?: undefined | Option<PublicKey>

    The new Collection NFT that this asset belongs to. When null, this will remove the asset from its current collection.

    Default Value

    Defaults to not being updated.

  • Optional creators?: undefined | CreatorInput[]

    The new creators for the asset. For each creator, if an authority Signer is provided, the creator will be marked as verified.

    Default Value

    Defaults to not being updated.

  • Optional name?: undefined | string

    The new on-chain name of the asset.

    Default Value

    Defaults to not being updated.

  • Optional sellerFeeBasisPoints?: undefined | number

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

    Default Value

    Defaults to not being updated.

  • Optional ruleSet?: undefined | Option<PublicKey>

    The ruleset account that should be used to configure the programmable NFT.

    This is only relevant for programmable NFTs, i.e. if the tokenStandard is set to TokenStandard.ProgrammableNonFungible.

    Default Value

    Defaults to not being updated.

  • Optional updateAuthority?: undefined | Signer

    The current update authority of the asset as a Signer.

    Default Value

    metaplex.identity()

    Deprecated

    Use authority instead.

  • Optional uri?: undefined | string

    The new on-chain uri of the asset.

    Default Value

    Defaults to not being updated.

  • Optional isMutable?: undefined | boolean

    Whether or not the asset is mutable. When set to false no one can update the Metadata account, not even the update authority. This can only be flipped from true to false.

    Default Value

    Defaults to not being updated.

  • Optional primarySaleHappened?: undefined | boolean

    Whether or not the asset has already been sold to its first buyer. This can only be flipped from false to true.

    Default Value

    Defaults to not being updated.

  • Optional collectionDetails?: undefined | {
        __kind: "V1";
    } & Omit<{
        size: bignum;
    }, "void">

    Transforms a regular NFT into a Collection NFT of the provided size.

    The provided size should include all verified NFTs and/or SFTs within the Collection. Unverified NFTs and/or SFTs should not be included in the size.

    Warning, once set, this size can no longer be updated manually.

    Default Value

    Defaults to not being updated.

  • Optional uses?: undefined | Option<Uses>

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

    Default Value

    Defaults to not being updated.

  • Optional collectionAuthority?: undefined | Option<Signer>

    The collection authority that should sign the asset to prove that it is part of the newly provided collection. When null, the provided collection will not be verified.

    Default Value

    null

  • Optional authority?: undefined | Signer | TokenMetadataAuthority

    An authority allowed to update the asset.

    If a Signer is provided directly, it will be used as the update authority.

    See

    TokenMetadataAuthority

    Default Value

    metaplex.identity()

  • Optional authorizationDetails?: undefined | TokenMetadataAuthorizationDetails

    The authorization rules and data to use for the update.

    See

    TokenMetadataAuthorizationDetails

    Default Value

    Defaults to not using auth rules.

  • Optional collectionAuthorityIsDelegated?: undefined | boolean

    Whether or not the provided collectionAuthority is a delegated collection authority, i.e. it was approved by the update authority using metaplex.nfts().approveCollectionAuthority().

    Default Value

    false

  • Optional collectionIsSized?: undefined | boolean

    Whether or not the newly provided collection is a sized collection and not a legacy collection.

    Default Value

    true

  • Optional newUpdateAuthority?: undefined | PublicKey

    The address of the new update authority to set for the asset

    Default Value

    Defaults to not being updated.

  • Optional oldCollectionAuthority?: undefined | Signer

    The authority of the asset's current collection. This may be required if the current collection is being removed or updated and needs to be unverified before doing so.

    Default Value

    payer

  • Optional oldCollectionIsSized?: undefined | boolean

    Whether or not the asset's current collection is a sized collection and not a legacy collection.

    Default Value

    true

  • Optional updateMetadataInstructionKey?: undefined | string

    A key to distinguish the instruction that updates the metadata account.

Settings

Member Visibility

Theme

Generated using TypeDoc