Package org.xrpl.xrpl4j.model.ledger
Interface DidObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableDidObject
A
DID ledger entry holds references to, or data associated with a single DID.
This interface will be marked Beta until the featureDID amendment is enabled on mainnet. Its API
is subject to change.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()The account that controls the DID.static ImmutableDidObject.Builderbuilder()Construct aDidObjectbuilder.data()The public attestations of identity credentials associated with the DID.The W3C standard DID document associated with the DID.default Flagsflags()A bit-map of boolean flags.index()The unique ID of theDidObject.default LedgerObject.LedgerEntryTypeThe type of ledger object, which will always be "DID" in this case.A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.The identifying hash of the transaction that most recently modified this object.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.uri()The Universal Resource Identifier that points to the corresponding DID document or the data associated with the DID.
-
Method Details
-
builder
Construct aDidObjectbuilder.- Returns:
- An
ImmutableDidObject.Builder.
-
ledgerEntryType
The type of ledger object, which will always be "DID" in this case.- Returns:
- Always returns
LedgerObject.LedgerEntryType.DID.
-
flags
A bit-map of boolean flags. No flags are defined forDidObject, so this value is always 0.- Returns:
- Always
Flags.UNSET.
-
account
Address account()The account that controls the DID.- Returns:
- An
Address.
-
didDocument
Optional<DidDocument> didDocument()The W3C standard DID document associated with the DID. This field isn't checked for validity and is limited to a maximum length of 256 bytes.- Returns:
- An optionally-present
DidDocument.
-
data
The public attestations of identity credentials associated with the DID. This field isn't checked for validity and is limited to a maximum length of 256 bytes.- Returns:
- An optionally-present
DidData.
-
uri
The Universal Resource Identifier that points to the corresponding DID document or the data associated with the DID. This field can be an HTTP(S) URL or IPFS URI. This field isn't checked for validity and is limited to a maximum length of 256 bytes.- Returns:
- An optionally-present
DidUri.
-
ownerNode
String ownerNode()A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.
- Returns:
- A
Stringcontaining the owner node hint.
-
previousTransactionId
Hash256 previousTransactionId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing the previous transaction hash.
-
previousTransactionLedgerSequence
com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()The index of the ledger that contains the transaction that most recently modified this object.- Returns:
- An
UnsignedIntegerrepresenting the previous transaction ledger sequence.
-
index
Hash256 index()The unique ID of theDidObject.- Returns:
- A
Hash256containing the ID.
-