gill/dist/programs/token/instructions/transfer-tokens.d.ts

a modern javascript/typescript client library for interacting with the Solana blockchain

import type { Address, IInstruction, TransactionSigner } from "@solana/kit";
import type { TokenInstructionBase } from "./types";
export type GetTransferTokensInstructionsArgs = TokenInstructionBase & {
    /**
     * The source account's owner/delegate or its multi-signature account:
     * - this should normally by a `TransactionSigner`
     * - only for multi-sig authorities (like Squads Protocol), should you supply an `Address`
     * */
    authority: TransactionSigner | Address;
    /**
     * Associated token account (ata) address for `authority` and this `mint`
     *
     * See {@link getAssociatedTokenAccountAddress}
     *
     * @example
     * ```
     * getAssociatedTokenAccountAddress(mint, authority, tokenProgram);
     * ```
     * */
    sourceAta: Address;
    /** Wallet address to receive the tokens, via their associated token account: `destinationAta` */
    destination: TransactionSigner | Address;
    /**
     * Associated token account (ata) address for `destination` and this `mint`
     *
     * See {@link getAssociatedTokenAccountAddress}
     *
     * @example
     * ```
     * getAssociatedTokenAccountAddress(mint, destination, tokenProgram);
     * ```
     * */
    destinationAta: Address;
    /** Amount of tokens to be transferred to the `destination` via their `destinationAta` */
    amount: bigint | number;
};
/**
 * Create the instructions required to transfer tokens from one wallet to another,
 * including creating the destination ATA if it does not exist
 *
 * @example
 *
 * ```
 * const sourceAta = await getAssociatedTokenAccountAddress(mint, authority, tokenProgram);
 *
 * const destination = address(...);
 * const destinationAta = await getAssociatedTokenAccountAddress(mint, destination, tokenProgram);
 *
 * const instructions = getTransferTokensInstructions({
 *    feePayer: signer,
 *    mint,
 *    amount: 10,
 *    authority: signer, // the source wallet for the tokens to be transferred
 *    sourceAta, // normally derived from the `authority`
 *    destination,
 *    destinationAta, // derived from the `destination`
 *    tokenProgram,
 * });
 * ```
 */
export declare function getTransferTokensInstructions(args: GetTransferTokensInstructionsArgs): IInstruction[];
//# sourceMappingURL=transfer-tokens.d.ts.map