Class TokenClient

You may use the builders() client to access the underlying Transaction Builders of this module.

const buildersClient = metaplex.tokens().builders();

You may use the pdas() client to build PDAs related to this module.

const pdasClient = metaplex.tokens().pdas();

Finds a mint account by its address.

const mint = await metaplex.tokens().findMintByAddress({ address });

Finds a token account by its address.

const token = await metaplex.tokens().findTokenByAddress({ address });

Finds a token account and its associated mint account by providing the token address.

const tokenWithMint = await metaplex.tokens().findTokenWithMintByAddress({ address });

Finds a token account and its associated mint account by providing the mint address and either:

• the token address or
• the address of the token's owner.

const tokenWithMint = await metaplex
  .tokens()
  .findTokenWithMintByMint({ mint, address: tokenAddress, type: "token" };

const tokenWithMint = await metaplex
  .tokens()
  .findTokenWithMintByMint({ mint, address: ownerAddress, type: "owner" };

Creates a new mint account.

const { mint } = await metaplex.tokens().createMint();

Creates a new token account.

const { token } = await metaplex.tokens().createToken({ mint });

Creates both mint and token accounts in the same transaction.

const { token } = await metaplex.tokens().createTokenWithMint();
const mint = token.mint;

Mint tokens to an account.

await metaplex
  .tokens()
  .mint({
    mintAddress,
    toOwner,
    amount: token(100),
  };

Send tokens from one account to another.

await metaplex
  .tokens()
  .send({
    mintAddress,
    toOwner,
    amount: token(100),
  };

Freezes a token account.

await metaplex.tokens().freeze({ mintAddress, freezeAuthority });

Thaws a token account.

await metaplex.tokens().thaw({ mintAddress, freezeAuthority });

Approves a delegate authority for a token account.

await metaplex
  .tokens()
  .approveDelegateAuthority({
    delegateAuthority,
    mintAddress,
  };

Revokes the current delegate authority for a token account.

await metaplex
  .tokens()
  .revokeDelegateAuthority({ mintAddress };