diff --git a/docs/references/protocol/transactions/types/mptokenissuancecreate.md b/docs/references/protocol/transactions/types/mptokenissuancecreate.md index 4e492484523..80c865c8cc4 100644 --- a/docs/references/protocol/transactions/types/mptokenissuancecreate.md +++ b/docs/references/protocol/transactions/types/mptokenissuancecreate.md @@ -39,6 +39,7 @@ This example assumes that the issuer of the token is the signer of the transacti | Field | JSON Type | [Internal Type][] | Required? | Description | |:------------------|:---------------------|:------------------|:----------|:------------| | `AssetScale` | Number | UInt8 | No | Where to put the decimal place when displaying amounts of this MPT. More formally, the asset scale is a non-negative integer (0, 1, 2, …) such that one standard unit equals 10^(-scale) of a corresponding fractional unit. For example, if a US Dollar Stablecoin has an asset scale of _2_, then 1 unit of that MPT would equal 0.01 US Dollars. This indicates to how many decimal places the MPT can be subdivided. If omitted, the default is 0, meaning that the MPT cannot be divided into smaller than 1 unit. | +| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain that grants access to the MPT. You must set the `tfMPTRequireAuth` flag to use permissioned domains.
{% amendment-disclaimer name="PermissionedDomains" /%}
{% amendment-disclaimer name="SingleAssetVault" /%} | | `TransferFee` | Number | UInt16 | No | The value specifies the fee to charged by the issuer for secondary sales of the Token, if such sales are allowed. Valid values for this field are between 0 and 50,000 inclusive, allowing transfer rates of between 0.000% and 50.000% in increments of 0.001. The field _must not_ be present if the tfMPTCanTransfer flag is not set. If it is, the transaction should fail and a fee should be claimed. | | `MaximumAmount` | String - Number | UInt64 | No | The maximum asset amount of this token that can ever be issued, as a base-10 number encoded as a string. The current default maximum limit is 9,223,372,036,854,775,807 (2^63-1). _This limit may increase in the future. If an upper limit is required, you must specify this field._ | | `MPTokenMetadata` | String - Hexadecimal | Blob | No | Arbitrary metadata about this issuance. The limit for this field is 1024 bytes. By convention, the metadata should decode to JSON data describing what the MPT represents. The [XLS-89 specification](https://github.com/XRPLF/XRPL-Standards/tree/master/XLS-0089-multi-purpose-token-metadata-schema) defines a recommended format for metadata. | @@ -60,6 +61,20 @@ Transactions of the MPTokenIssuanceCreate type support additional values in the | `tfMPTCanTransfer` | `0x00000020` | `32` | If set, indicates that tokens can be transferred to other accounts that are not the issuer. | | `tfMPTCanClawback` | `0x00000040` | `64` | If set, indicates that the issuer can use the `Clawback` transaction to claw back value from individual holders. | + +## Error Cases + +Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} transactions can result in the following [transaction result codes](../transaction-results/index.md): + +| Error Code | Description | +|:--------------------------|:------------| +| `tecDIR_FULL` | The owner directory of the account creating the `MPTokenIssuance` ledger entry is full. | +| `temBAD_TRANSFER_FEE` | The transfer fee specified is greater than the maximum allowed value of 50,000. | +| `temDISABLED` | The `MPTokensV1` amendment is disabled. You will also receive this error if you include a `DomainID` field in the transaction, but the `PermissionedDomains` and `SingleAssetVault` amendments are both disabled. | +| `tecINSUFFICIENT_RESERVE` | The account creating the `MPTokenIssuance` ledger entry doesn't have enough XRP to meet the owner reserve. | +| `temMALFORMED` | - A non-zero transfer fee is set, but the `tfMPTCanTransfer` flag is _not_ set.
- The `DomainID` points to an invalid permissioned domain; you can also receive this error if you include a `DomainID` without setting the `tfMPTRequireAuth` flag.
- The `MPTokenMetadata` field is an invalid length (0 or exceeds 1024 bytes).
- The `MaximumAmount` field is 0 or exceeds 9,223,372,036,854,775,807 (2^63-1). | + + ## See Also - [MPTokenIssuance entry][] diff --git a/docs/references/protocol/transactions/types/mptokenissuanceset.md b/docs/references/protocol/transactions/types/mptokenissuanceset.md index b7cb469ba71..d727a14bbd0 100644 --- a/docs/references/protocol/transactions/types/mptokenissuanceset.md +++ b/docs/references/protocol/transactions/types/mptokenissuanceset.md @@ -32,6 +32,7 @@ This example locks the balances of all holders of the specified MPT issuance. | Field | JSON Type | [Internal Type][] | Required? | Description | |:--------------------|:---------------------|:------------------|:----------|-------------| +| `DomainID` | String - [Hash][] | UInt256 | No | The ledger entry ID of a permissioned domain that grants access to the MPT. An empy value or `0` will remove permissioned domain access management. Any accounts that lose access to the MPT because of `DomainID` updates--unless explicitly authorized by the MPT issuer--lose the ability to send or receive MPTs they already hold. The `tfMPTRequireAuth` flag must have been set in the `MPTokenIssuanceCreate` transaction to use permissioned domains.
{% amendment-disclaimer name="PermissionedDomains" /%}
{% amendment-disclaimer name="SingleAssetVault" /%} | | `MPTokenIssuanceID` | String - Hexadecimal | UInt192 | Yes | The identifier of the `MPTokenIssuance` to update. | | `Holder` | String - [Address][] | AccountID | No | An individual token holder. If provided, apply changes to the given holder's balance of the given MPT issuance. If omitted, apply to all accounts holding the given MPT issuance. | @@ -44,6 +45,20 @@ Transactions of the `MPTokenIssuanceSet` type support additional values in the ` | `tfMPTLock` | `0x00000001` | 1 | Enable to lock balances of this MPT issuance. | | `tfMPTUnlock` | `0x00000002` | 2 | Enable to unlock balances of this MPT issuance. | + +## Error Cases + +Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} transactions can result in the following [transaction result codes](../transaction-results/index.md): + +| Error Code | Description | +|:--------------------------|:------------| +| `temDISABLED` | The `MPTokensV1` amendment is disabled. You will also receive this error if you include a `DomainID` field in the transaction, but the `PermissionedDomains` and `SingleAssetVault` amendments are both disabled. | +| `tecNO_DST` | The account specified in the `Holder` field doesn't exist. | +| `tecNO_PERMISSION` | - The `lsfMPTCanLock` flag isn't enabled, but you are attempting to lock or unlock an MPT.
- The `SingleAssetVault` amendment is disabled and you're trying to modify a `DomainID` field. | +| `temMALFORMED` | - You specified a `DomainID` and `Holder` value--only one can be set in a single transaction.
- You specified the same account for both `Acount` and `Holder`.
- The transaction isn't changing anything; it must either update a flag or modify the `DomainID`. | +| `tecOBJECT_NOT_FOUND` | The specified `MPToken`, `MPTokenIssuance`, or `PermissionedDomain` ledger entry doesn't exist. | + + ## See Also - [MPTokenIssuance entry][]