@solana/kit/src/get-minimum-balance-for-rent-exemption.ts

Solana Javascript API

import type { Lamports } from '@solana/rpc-types';

/**
 * Calculates the minimum {@link Lamports | lamports} required to make an account rent exempt for a
 * given data size, without performing an RPC call.
 *
 * Values are sourced from the on-chain rent parameters in the Solana runtime:
 * https://github.com/anza-xyz/solana-sdk/blob/c07f692e41d757057c8700211a9300cdcd6d33b1/rent/src/lib.rs#L93-L97
 *
 * Note that this logic may change, or be incorrect depending on the cluster you are connected to.
 * You can always use the RPC method `getMinimumBalanceForRentExemption` to get the current value.
 *
 * @deprecated The minimum balance for an account is being actively reduced
 * (see {@link https://github.com/solana-foundation/solana-improvement-documents/pull/437 | SIMD-0437})
 * and is expected to become dynamic in future Solana upgrades
 * (see {@link https://github.com/solana-foundation/solana-improvement-documents/pull/194 | SIMD-0194}
 * and {@link https://github.com/solana-foundation/solana-improvement-documents/pull/389 | SIMD-0389}),
 * meaning a hardcoded local computation will no longer return accurate results. Use the
 * {@link GetMinimumBalanceForRentExemptionApi.getMinimumBalanceForRentExemption | getMinimumBalanceForRentExemption}
 * RPC method or a `ClientWithGetMinimumBalance` plugin instead. This function will be removed in v7.
 *
 * @param space The number of bytes of account data.
 */
export function getMinimumBalanceForRentExemption(space: bigint): Lamports {
    const RENT = {
        ACCOUNT_STORAGE_OVERHEAD: 128n,
        DEFAULT_EXEMPTION_THRESHOLD: 2n,
        DEFAULT_LAMPORTS_PER_BYTE_YEAR: 3_480n,
    } as const;
    const requiredLamports =
        (RENT.ACCOUNT_STORAGE_OVERHEAD + space) *
        RENT.DEFAULT_LAMPORTS_PER_BYTE_YEAR *
        RENT.DEFAULT_EXEMPTION_THRESHOLD;
    return requiredLamports as Lamports;
}