@solana/spl-token
Version:
SPL Token Program JS API
234 lines • 11.2 kB
JavaScript
import { sendAndConfirmTransaction, SystemProgram, Transaction } from '@solana/web3.js';
import { createInitializeInstruction, createRemoveKeyInstruction, createUpdateAuthorityInstruction, createUpdateFieldInstruction, pack, unpack, } from '@solana/spl-token-metadata';
import { TOKEN_2022_PROGRAM_ID } from '../../constants.js';
import { getSigners } from '../../actions/internal.js';
import { ExtensionType, getExtensionData, getNewAccountLenForExtensionLen } from '../extensionType.js';
import { updateTokenMetadata } from './state.js';
import { TokenAccountNotFoundError } from '../../errors.js';
import { unpackMint } from '../../state/index.js';
async function getAdditionalRentForNewMetadata(connection, address, tokenMetadata, programId = TOKEN_2022_PROGRAM_ID) {
const info = await connection.getAccountInfo(address);
if (!info) {
throw new TokenAccountNotFoundError();
}
const extensionLen = pack(tokenMetadata).length;
const newAccountLen = getNewAccountLenForExtensionLen(info, address, ExtensionType.TokenMetadata, extensionLen, programId);
if (newAccountLen <= info.data.length) {
return 0;
}
const newRentExemptMinimum = await connection.getMinimumBalanceForRentExemption(newAccountLen);
return newRentExemptMinimum - info.lamports;
}
async function getAdditionalRentForUpdatedMetadata(connection, address, field, value, programId = TOKEN_2022_PROGRAM_ID) {
const info = await connection.getAccountInfo(address);
if (!info) {
throw new TokenAccountNotFoundError();
}
const mint = unpackMint(address, info, programId);
const extensionData = getExtensionData(ExtensionType.TokenMetadata, mint.tlvData);
if (extensionData === null) {
throw new Error('TokenMetadata extension not initialized');
}
const updatedTokenMetadata = updateTokenMetadata(unpack(extensionData), field, value);
const extensionLen = pack(updatedTokenMetadata).length;
const newAccountLen = getNewAccountLenForExtensionLen(info, address, ExtensionType.TokenMetadata, extensionLen, programId);
if (newAccountLen <= info.data.length) {
return 0;
}
const newRentExemptMinimum = await connection.getMinimumBalanceForRentExemption(newAccountLen);
return newRentExemptMinimum - info.lamports;
}
/**
* Initializes a TLV entry with the basic token-metadata fields.
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param mintAuthority Mint Authority
* @param name Longer name of token
* @param symbol Shortened symbol of token
* @param uri URI pointing to more metadata (image, video, etc)
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataInitialize(connection, payer, mint, updateAuthority, mintAuthority, name, symbol, uri, multiSigners = [], confirmOptions, programId = TOKEN_2022_PROGRAM_ID) {
const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners);
const transaction = new Transaction().add(createInitializeInstruction({
programId,
metadata: mint,
updateAuthority,
mint,
mintAuthority: mintAuthorityPublicKey,
name,
symbol,
uri,
}));
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Initializes a TLV entry with the basic token-metadata fields,
* Includes a transfer for any additional rent-exempt SOL if required.
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param mintAuthority Mint Authority
* @param name Longer name of token
* @param symbol Shortened symbol of token
* @param uri URI pointing to more metadata (image, video, etc)
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataInitializeWithRentTransfer(connection, payer, mint, updateAuthority, mintAuthority, name, symbol, uri, multiSigners = [], confirmOptions, programId = TOKEN_2022_PROGRAM_ID) {
const [mintAuthorityPublicKey, signers] = getSigners(mintAuthority, multiSigners);
const transaction = new Transaction();
const lamports = await getAdditionalRentForNewMetadata(connection, mint, {
updateAuthority,
mint,
name,
symbol,
uri,
additionalMetadata: [],
}, programId);
if (lamports > 0) {
transaction.add(SystemProgram.transfer({ fromPubkey: payer.publicKey, toPubkey: mint, lamports: lamports }));
}
transaction.add(createInitializeInstruction({
programId,
metadata: mint,
updateAuthority,
mint,
mintAuthority: mintAuthorityPublicKey,
name,
symbol,
uri,
}));
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* 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.
*
* The field can be one of the required fields (name, symbol, URI), or a
* totally new field denoted by a "key" string.
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param field Field to update in the metadata
* @param value Value to write for the field
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataUpdateField(connection, payer, mint, updateAuthority, field, value, multiSigners = [], confirmOptions, programId = TOKEN_2022_PROGRAM_ID) {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction().add(createUpdateFieldInstruction({
programId,
metadata: mint,
updateAuthority: updateAuthorityPublicKey,
field,
value,
}));
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* 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.
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param field Field to update in the metadata
* @param value Value to write for the field
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataUpdateFieldWithRentTransfer(connection, payer, mint, updateAuthority, field, value, multiSigners = [], confirmOptions, programId = TOKEN_2022_PROGRAM_ID) {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction();
const lamports = await getAdditionalRentForUpdatedMetadata(connection, mint, field, value, programId);
if (lamports > 0) {
transaction.add(SystemProgram.transfer({ fromPubkey: payer.publicKey, toPubkey: mint, lamports: lamports }));
}
transaction.add(createUpdateFieldInstruction({
programId,
metadata: mint,
updateAuthority: updateAuthorityPublicKey,
field,
value,
}));
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Remove a field in a token-metadata account.
*
* The field can be one of the required fields (name, symbol, URI), or a
* totally new field denoted by a "key" string.
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param key Key to remove in the additional metadata portion
* @param idempotent When true, instruction will not error if the key does not exist
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataRemoveKey(connection, payer, mint, updateAuthority, key, idempotent, multiSigners = [], confirmOptions, programId = TOKEN_2022_PROGRAM_ID) {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction().add(createRemoveKeyInstruction({
programId,
metadata: mint,
updateAuthority: updateAuthorityPublicKey,
key,
idempotent,
}));
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
/**
* Update authority
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param mint Mint Account
* @param updateAuthority Update Authority
* @param newAuthority New authority for the token metadata, or unset
* @param multiSigners Signing accounts if `authority` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function tokenMetadataUpdateAuthority(connection, payer, mint, updateAuthority, newAuthority, multiSigners = [], confirmOptions, programId = TOKEN_2022_PROGRAM_ID) {
const [updateAuthorityPublicKey, signers] = getSigners(updateAuthority, multiSigners);
const transaction = new Transaction().add(createUpdateAuthorityInstruction({
programId,
metadata: mint,
oldAuthority: updateAuthorityPublicKey,
newAuthority,
}));
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
//# sourceMappingURL=actions.js.map