@stellar/stellar-sdk/lib/esm/base/operations/set_options.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 { SetOptionsOpts, SetOptionsResult, SignerOpts } from "./types.js";
/**
 * Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
 * set the account's inflation destination, and/or add new signers to the account.
 * The flags used in `opts.clearFlags` and `opts.setFlags` can be the following:
 *   - `{@link AuthRequiredFlag}`
 *   - `{@link AuthRevocableFlag}`
 *   - `{@link AuthImmutableFlag}`
 *   - `{@link AuthClawbackEnabledFlag}`
 *
 * It's possible to set/clear multiple flags at once using logical or.
 *
 *
 * @param opts - Options object
 *   - `inflationDest`: Set this account ID as the account's inflation destination.
 *   - `clearFlags`: Bitmap integer for which account flags to clear.
 *   - `setFlags`: Bitmap integer for which account flags to set.
 *   - `masterWeight`: The master key weight.
 *   - `lowThreshold`: The sum weight for the low threshold.
 *   - `medThreshold`: The sum weight for the medium threshold.
 *   - `highThreshold`: The sum weight for the high threshold.
 *   - `signer`: Add or remove a signer from the account. The signer is
 *                                 deleted if the weight is 0. Only one of `ed25519PublicKey`, `sha256Hash`, `preAuthTx` should be defined.
 *   - `signer.ed25519PublicKey`: The ed25519 public key of the signer.
 *   - `signer.sha256Hash`: sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction.
 *   - `signer.preAuthTx`: Hash (Buffer or hex string) of transaction that will unlock funds.
 *   - `signer.ed25519SignedPayload`: Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure.
 *   - `signer.weight`: The weight of the new signer (0 to delete or 1-255)
 *   - `homeDomain`: sets the home domain used for reverse federation lookup.
 *   - `source`: The source account (defaults to transaction source).
 * @see [Account flags](https://developers.stellar.org/docs/glossary/accounts/#flags)
 */
export declare function setOptions<T extends SignerOpts = never>(opts: SetOptionsOpts<T>): xdr.Operation<SetOptionsResult<T>>;