AccountFlag
in package
Account flags control authorization and trust settings for Stellar accounts.
These flags are used with SetOptions operations to configure account behavior regarding trustlines and asset authorization. Issuers can use these flags to control how their custom assets can be held and transferred.
Tags
Table of Contents
Constants
- AUTH_CLAWBACK_ENABLED_FLAG = 8
- Clawback enabled flag (0x8).
- AUTH_IMMUTABLE_FLAG = 4
- Authorization immutable flag (0x4).
- AUTH_REQUIRED_FLAG = 1
- Authorization required flag (0x1).
- AUTH_REVOCABLE_FLAG = 2
- Authorization revocable flag (0x2).
Constants
AUTH_CLAWBACK_ENABLED_FLAG
Clawback enabled flag (0x8).
public
int
AUTH_CLAWBACK_ENABLED_FLAG
= 8
Allows the issuing account to claw back (burn) its custom assets from any account holding them. This enables the issuer to revoke assets after they have been distributed, which may be required for regulated assets.
Tags
AUTH_IMMUTABLE_FLAG
Authorization immutable flag (0x4).
public
int
AUTH_IMMUTABLE_FLAG
= 4
Permanently prevents the account from changing any authorization flags. Once set, AUTH_REQUIRED_FLAG and AUTH_REVOCABLE_FLAG cannot be changed. This flag itself cannot be unset once applied, ensuring the account's authorization behavior is fixed forever.
AUTH_REQUIRED_FLAG
Authorization required flag (0x1).
public
int
AUTH_REQUIRED_FLAG
= 1
Requires the issuing account to give explicit authorization for accounts to hold its custom assets. When set, trustlines default to unauthorized and require approval before they can hold or receive the asset.
AUTH_REVOCABLE_FLAG
Authorization revocable flag (0x2).
public
int
AUTH_REVOCABLE_FLAG
= 2
Allows the issuing account to revoke authorization for its custom assets at any time. Once revoked, the trustline cannot be used to send, receive, or maintain offers for the asset. The asset balance becomes frozen.