Type alias UseNftBuilderParams

UseNftBuilderParams: {
    mintAddress: PublicKey;
    owner?: undefined | PublicKey | Signer;
    numberOfUses?: undefined | number;
    ownerTokenAccount?: undefined | PublicKey;
    useAuthority?: undefined | Signer;
    instructionKey?: undefined | string;
}

Type declaration

  • mintAddress: PublicKey

    The address of the mint account.

  • Optional owner?: undefined | PublicKey | Signer

    The owner of the NFT or SFT.

    This must be a Signer unless a useAuthority is provided.

    Default Value

    metaplex.identity()

  • Optional numberOfUses?: undefined | number

    The number of uses to utilize.

    Default Value

    1

  • Optional ownerTokenAccount?: undefined | PublicKey

    The address of the token account linking the mint account with the owner account.

    Default Value

    Defaults to using the associated token account from the mintAddress and owner parameters.

  • Optional useAuthority?: undefined | Signer

    The delegated use authority that should authorize this operation.

    Default Value

    Defaults to not using a delegated use authority and using the owner parameter as a Signer instead.

  • Optional instructionKey?: undefined | string

    A key to distinguish the instruction that uses the NFT.

Generated using TypeDoc