Type alias MintTokensBuilderParams

MintTokensBuilderParams: {
    mintAddress: PublicKey;
    amount: SplTokenAmount;
    multiSigners?: undefined | KeypairSigner[];
    mintAuthority?: undefined | PublicKey | Signer;
    toOwner?: undefined | PublicKey;
    toToken?: undefined | PublicKey | Signer;
    toTokenExists?: undefined | boolean;
    createAssociatedTokenAccountInstructionKey?: undefined | string;
    createAccountInstructionKey?: undefined | string;
    initializeTokenInstructionKey?: undefined | string;
    mintTokensInstructionKey?: undefined | string;
}

Type declaration

  • mintAddress: PublicKey

    The address of the mint account.

  • amount: SplTokenAmount

    The amount of tokens to mint.

  • Optional multiSigners?: undefined | KeypairSigner[]

    The signing accounts to use if the mint authority is a multisig.

    Default Value

    []

  • Optional mintAuthority?: undefined | PublicKey | Signer

    The authority that is allowed to mint new tokens as a Signer.

    This may be provided as a PublicKey if and only if the multiSigners parameter is provided.

    Default Value

    metaplex.identity()

  • Optional toOwner?: undefined | PublicKey

    The owner of the token account to mint to.

    Default Value

    metaplex.identity().publicKey

  • Optional toToken?: undefined | PublicKey | Signer

    The address of the token account to mint to.

    Note that this may be required as a Signer if the destination token account does not exist and we need to create it before minting the tokens.

    Default Value

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

  • Optional toTokenExists?: undefined | boolean

    Whether or not the provided token account already exists. If false, we'll add another instruction to create it.

    Default Value

    true

  • Optional createAssociatedTokenAccountInstructionKey?: undefined | string

    A key to distinguish the instruction that creates the associated token account.

  • Optional createAccountInstructionKey?: undefined | string

    A key to distinguish the instruction that creates the token account.

  • Optional initializeTokenInstructionKey?: undefined | string

    A key to distinguish the instruction that initializes the token account.

  • Optional mintTokensInstructionKey?: undefined | string

    A key to distinguish the instruction that mints tokens.

Generated using TypeDoc