@stellar/stellar-sdk/lib/esm/base/operations/extend_footprint_ttl.d.ts

A library for working with the Stellar network, including communication with the Horizon and Soroban RPC servers.

import xdr from "../xdr.js";
import { ExtendFootprintTTLResult, ExtendFootprintTtlOpts } from "./types.js";
/**
 * Builds an operation to bump the time-to-live (TTL) of the ledger keys. The
 * keys for extension have to be provided in the read-only footprint of
 * the transaction.
 *
 * The only parameter of the operation itself is the new minimum TTL for
 * all the provided entries. If an entry already has a higher TTL, then it
 * will just be skipped.
 *
 * TTL is the number of ledgers from the current ledger (exclusive) until
 * the last ledger the entry is still considered alive (inclusive). Thus
 * the exact ledger until the entries will live will only be determined
 * when transaction has been applied.
 *
 * The footprint has to be specified in the transaction. See
 * {@link TransactionBuilder}'s `opts.sorobanData` parameter, which is a
 * {@link xdr.SorobanTransactionData} instance that contains fee data & resource
 * usage as part of {@link xdr.SorobanResources}.
 *
 *
 * @param opts - object holding operation parameters
 *   - `extendTo`: the minimum TTL that all the entries in
 *    the read-only footprint will have
 *   - `source`: an optional source account
 */
export declare function extendFootprintTtl(opts: ExtendFootprintTtlOpts): xdr.Operation<ExtendFootprintTTLResult>;