ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-12-05 08:48:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify tf flag usage

Browse Source 
Feedback on the "Issue a Fungible Token" tutorial mentioned that the example there sets multiple flags using a combination of asf and tf flags, but the wording here says tf flags are discouraged. That's confusing, and not really accurate: there's nothing wrong with using tf flags where applicable; it's just that the AccountSet transaction type started running out of unique bits for tf flags, so newer settings only have asf flags.
This commit is contained in:
Rome Reginelli
2022-03-08 14:04:02 -08:00
committed by GitHub
parent 688d131ab1
commit 08c1594455
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/references/protocol-reference/transactions/transaction-types/accountset.md
View File

@@ -58,8 +58,8 @@ You can put any domain in your account's `Domain` field. To prove that an accoun
There are several options which can be either enabled or disabled for an account. Account options are represented by different types of flags depending on the situation:
* The `AccountSet` transaction type has several "AccountSet Flags" (prefixed **`asf`**) that can enable an option when passed as the `SetFlag` parameter, or disable an option when passed as the `ClearFlag` parameter.
* The `AccountSet` transaction type has several transaction flags (prefixed **`tf`**) that can be used to enable or disable specific account options when passed in the `Flags` parameter. This style is discouraged. New account options do not have corresponding transaction (`tf`) flags.
* The `AccountSet` transaction type has several "AccountSet Flags" (prefixed **`asf`**) that can enable an option when passed as the `SetFlag` parameter, or disable an option when passed as the `ClearFlag` parameter. Some options have only this style of flag. You can only enable up to one `asf` flag per transaction.
* The `AccountSet` transaction type has several transaction flags (prefixed **`tf`**) that can be used to enable or disable specific account options when passed in the `Flags` parameter. You can enable and disable a combination of settings in one transaction using multiple `tf` flags, but not all settings have `tf` flags.
* The `AccountRoot` ledger object type has several ledger-state-flags (prefixed **`lsf`**) which represent the state of particular account options within a particular ledger. These settings apply until a transaction changes them.
The preferred way to enable and disable Account Flags is using the `SetFlag` and `ClearFlag` parameters of an AccountSet transaction. AccountSet flags have names that begin with **`asf`**.