-
Notifications
You must be signed in to change notification settings - Fork 1.1k
update mpt docs for permissioneddomains #3251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: rippled-3.0.0
Are you sure you want to change the base?
Changes from all commits
f20f8c5
015f3ab
45e0809
b9a0772
1143443
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||
|---|---|---|---|---|
|
|
@@ -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.<br>{% amendment-disclaimer name="PermissionedDomains" /%}<br>{% 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.<br>- The `SingleAssetVault` amendment is disabled and you're trying to modify a `DomainID` field. | | ||||
oeggert marked this conversation as resolved.
Show resolved
Hide resolved
|
||||
| | `temMALFORMED` | - You specified a `DomainID` and `Holder` value--only one can be set in a single transaction.<br>- You specified the same account for both `Acount` and `Holder`.<br>- The transaction isn't changing anything; it must either update a flag or modify the `DomainID`. | | ||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same comment in issuancecreate. I think it's helpful to explain how you'd malform this specific transaction. |
||||
| | `tecOBJECT_NOT_FOUND` | The specified `MPToken`, `MPTokenIssuance`, or `PermissionedDomain` ledger entry doesn't exist. | | ||||
|
|
||||
|
|
||||
| ## See Also | ||||
|
|
||||
| - [MPTokenIssuance entry][] | ||||
|
|
||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
temMALFORMEDis one of the errors that can occur for any transaction type.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True, but I think it's helpful to explain what specifically you could be malforming to make it easier for someone to troubleshoot.
Maybe I could preface it with something like: "Besides generally malformed transactions, you can receive this error if ..."