Function tokenMetadataUpdateFieldWithRentTransfer

  • tokenMetadataUpdateFieldWithRentTransfer(connection, payer, mint, updateAuthority, field, value, multiSigners?, confirmOptions?, programId?): Promise<TransactionSignature>

  • Updates a field in a token-metadata account. If the field does not exist on the account, it will be created. If the field does exist, it will be overwritten. Includes a transfer for any additional rent-exempt SOL if required.

    The field can be one of the required fields (name, symbol, URI), or a totally new field denoted by a "key" string.

    Parameters

    • connection: Connection

      Connection to use

    • payer: Signer

      Payer of the transaction fees

    • mint: PublicKey

      Mint Account

    • updateAuthority: PublicKey | Signer

      Update Authority

    • field: string | Field

      Field to update in the metadata

    • value: string

      Value to write for the field

    • multiSigners: Signer[] = []

      Signing accounts if authority is a multisig

    • Optional confirmOptions: ConfirmOptions

      Options for confirming the transaction

    • programId: PublicKey = TOKEN_2022_PROGRAM_ID

      SPL Token program account

    Returns Promise<TransactionSignature>

    Signature of the confirmed transaction

Settings

Member Visibility

Theme

Generated using TypeDoc