Change UInt64-Base10 #99
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update docs to reflect change from UInt64 values to Base10
OwnerNode should remain UInt64. I was overzealous.
mDuo13
requested changes
Sep 18, 2024
There was a problem hiding this comment.
Based on my understanding of the change on the rippled side, I think these edits miss the mark slightly. The internal representation (the canonical binary format) is the same, but for some reason rippled's APIs would return these values as hexadecimal strings instead of base-10 number strings, e.g. the number ten was previous returned as "a" and it'll now be returned as "10".
So in both cases the internal format is UInt64 and the JSON format is string, but the format of the string is now a base-10 instead of base-16 representation.
kennyzlei
reviewed
Sep 18, 2024
shawnxie999
reviewed
Oct 2, 2024
shawnxie999
reviewed
Oct 2, 2024
shawnxie999
reviewed
Oct 2, 2024
shawnxie999
reviewed
Oct 2, 2024
| | `LockedAmount` | string | UInt64 | A positive amount of tokens that are currently held in a token holder's account, but are unavailable to be used by the token holder. Locked tokens might, for example, represent value currently being held in escrow, or value that is otherwise inaccessible to the token holder. This value is stored as a default value such that its initial value is 0, in order to save space on the ledger for an empty MPT holding. | | ||
| | `MaximumAmount` | string | Base10 | This value is an unsigned number that specifies the maximum number of MPTs that can be distributed to non-issuing accounts (i.e., minted). For issuances that do not have a maximum limit, this value should be set to 18,446,744,073,709,551,615. | | ||
| | `OutstandingAmount` | string | Base10 | Specifies the sum of all token amounts that have been minted to all token holders. This value can be stored on ledger as a default type so that when its value is 0 it takes up less space on ledger. This value is increased whenever an issuer pays MPTs to a non-issuer account, and decreased whenever a non-issuer pays MPTs into the issuing account. | | ||
| | `LockedAmount` | string | Base10 | A positive amount of tokens that are currently held in a token holder's account, but are unavailable to be used by the token holder. Locked tokens might, for example, represent value currently being held in escrow, or value that is otherwise inaccessible to the token holder. This value is stored as a default value such that its initial value is 0, in order to save space on the ledger for an empty MPT holding. | |
There was a problem hiding this comment.
Suggested change
| | `LockedAmount` | string | Base10 | A positive amount of tokens that are currently held in a token holder's account, but are unavailable to be used by the token holder. Locked tokens might, for example, represent value currently being held in escrow, or value that is otherwise inaccessible to the token holder. This value is stored as a default value such that its initial value is 0, in order to save space on the ledger for an empty MPT holding. | | |
| | `LockedAmount` | string | UInt64 | A positive amount of tokens that are currently held in a token holder's account, but are unavailable to be used by the token holder. Locked tokens might, for example, represent value currently being held in escrow, or value that is otherwise inaccessible to the token holder. This value is stored as a default value such that its initial value is 0, in order to save space on the ledger for an empty MPT holding. | |
should also say that its base 10 in the description
shawnxie999
reviewed
Oct 2, 2024
docs/xls-33d-multi-purpose-tokens/reference/mptokenissuancecreate.md
Outdated
Show resolved
Hide resolved
shawnxie999
reviewed
Oct 7, 2024
| | `LockedAmount` | string | Base10 | A positive amount of tokens that are currently held in a token holder's account, but are unavailable to be used by the token holder. Locked tokens might, for example, represent value currently being held in escrow, or value that is otherwise inaccessible to the token holder. This value is stored as a default value such that its initial value is 0, in order to save space on the ledger for an empty MPT holding. | | ||
| | `MaximumAmount` | string | UInt64 | This value is an unsigned base 10 number that specifies the maximum number of MPTs that can be distributed to non-issuing accounts (that is, minted). For issuances that do not have a maximum limit, set this value to 9,223,372,036,854,775,807. | | ||
| | `OutstandingAmount` | string | UInt64 | Specifies the base 10 sum of all token amounts that have been minted to all token holders. This value can be stored on ledger as a default type so that when its value is 0 it takes up less space on ledger. This value is increased whenever an issuer pays MPTs to a non-issuer account, and decreased whenever a non-issuer pays MPTs into the issuing account. | | ||
| | `LockedAmount` | string | UInt64 | A positive amount of tokens that are currently held in a token holder's account, but are unavailable to be used by the token holder. Locked tokens might, for example, represent value currently being held in escrow, or value that is otherwise inaccessible to the token holder. This value is stored as a default base 10 value such that its initial value is 0, in order to save space on the ledger for an empty MPT holding. | |
There was a problem hiding this comment.
LockedAmount has been removed everywhere. Haven't updated the spec yet, but might be convenient to remove this field in the PR while we are at it.
shawnxie999
approved these changes
Oct 7, 2024
oeggert
approved these changes
Oct 8, 2024
| @@ -92,8 +92,8 @@ An `mptoken` object has the following parameters: | |||
| |:-----------------------|:--------|:------------------------------------------| | |||
| | `account` | string | The account address of the holder who owns the `MPToken`. | | |||
| | `flags` | number | The flags assigned to the`MPToken` object. | | |||
| | `mpt_amount` | string | Hex-encoded amount of the holder's balance. | | |||
| | `locked_amount` | string | Hex-encoded amount of the locked balance. (Can be omitted if the value is 0.) | | |||
| | `mpt_amount` | string | Base 10-encoded amount of the holder's balance. | | |||
There was a problem hiding this comment.
Not a blocker, but should we be saying base 10-encoded or decimal/hexadecimal? I don't have strong opinion either way, but I want to standardize the language we use in this instance.
There was a problem hiding this comment.
If we're going to say "hex" elsewhere, then I think it makes more sense to say "decimal" here.
Per Shawn Xie.
mDuo13
approved these changes
Oct 15, 2024
mDuo13
approved these changes
Oct 15, 2024
There was a problem hiding this comment.
This file should be removed.
There was a problem hiding this comment.
Don't add .DS_Store files to the repo (they're some sort of Mac OS caching thing)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update docs to reflect change from UInt64 values to Base10, per https://ripplelabs.atlassian.net/jira/software/projects/DEFI/issues/DEFI-247