Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractKeyMetadata() - Constructor for class org.xrpl.xrpl4j.crypto.KeyMetadata.AbstractKeyMetadata
- AbstractSignatureService - Class in org.xrpl.xrpl4j.crypto.signing
-
An abstract implementation of
SignatureService
with common functionality that sub-classes can utilize. - AbstractSignatureService(KeyStoreType, SignatureUtils, KeyPairService) - Constructor for class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
-
Required-args Constructor.
- addSignatureToTransaction(Transaction, Signature) - Method in class org.xrpl.xrpl4j.crypto.signing.SignatureUtils
-
Add
Transaction.transactionSignature()
to the given unsignedTransaction.
B
- base16Encoded() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
- base16Encoded() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
- base16Encoded() - Method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
The key, as a Base16-encoded (i.e., HEX) string.
- base16Encoded() - Method in class org.xrpl.xrpl4j.crypto.PrivateKey.DefaultPrivateKey
- base16Encoded() - Method in interface org.xrpl.xrpl4j.crypto.PublicKey
-
The private-key value, as a Base16-encoded (i.e., HEX) string.
- base16Encoded() - Method in class org.xrpl.xrpl4j.crypto.PublicKey.DefaultPublicKey
- base16Value() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
Accessor for this signature as a base16-encoded (HEX) string.
- base16Value() - Method in interface org.xrpl.xrpl4j.crypto.signing.Signature
-
Accessor for this signature as a base16-encoded (HEX) string.
- base58Encoded() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
- base58Encoded() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
- base58Encoded() - Method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
The key, as a Base58-encoded string.
- base58Encoded() - Method in class org.xrpl.xrpl4j.crypto.PrivateKey.DefaultPrivateKey
- base58Encoded() - Method in interface org.xrpl.xrpl4j.crypto.PublicKey
-
The public-key, as a base-58 encoded
String
. - base58Encoded() - Method in class org.xrpl.xrpl4j.crypto.PublicKey.DefaultPublicKey
- build() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType.Builder
-
Builds a new
ImmutableDefaultKeyStoreType
. - build() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey.Builder
-
Builds a new
ImmutableDefaultPrivateKey
. - build() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey.Builder
-
Builds a new
ImmutableDefaultPublicKey
. - build() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed.Builder
-
Builds a new
ImmutableDefaultSeed
. - build() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Builds a new
ImmutableKeyMetadata
. - build() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction.Builder
-
Builds a new
ImmutableSignableTransaction
. - build() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature.Builder
-
Builds a new
ImmutableSignature
. - build() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction.Builder
-
Builds a new
ImmutableSignedTransaction
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
Creates a builder for
ImmutableDefaultKeyStoreType
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
-
Creates a builder for
ImmutableDefaultPrivateKey
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
-
Creates a builder for
ImmutableDefaultPublicKey
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
-
Creates a builder for
ImmutableDefaultSeed
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Creates a builder for
ImmutableKeyMetadata
. - builder() - Static method in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
A Builder for immutables.
- builder() - Static method in interface org.xrpl.xrpl4j.crypto.KeyStoreType
-
Builder for immutables.
- builder() - Static method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
Instantiates a new builder.
- builder() - Static method in interface org.xrpl.xrpl4j.crypto.PublicKey
-
Instantiates a new builder.
- builder() - Static method in interface org.xrpl.xrpl4j.crypto.Seed
-
Instantiates a new builder.
- builder() - Static method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
Creates a builder for
ImmutableSignableTransaction
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
Creates a builder for
ImmutableSignature
. - builder() - Static method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Creates a builder for
ImmutableSignedTransaction
. - builder() - Static method in interface org.xrpl.xrpl4j.crypto.signing.SignableTransaction
-
A builder.
- builder() - Static method in interface org.xrpl.xrpl4j.crypto.signing.Signature
-
Instantiates a new builder.
- builder() - Static method in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
A builder.
C
- copyOf(KeyMetadata.AbstractKeyMetadata) - Static method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Creates an immutable copy of a
KeyMetadata.AbstractKeyMetadata
value. - copyOf(KeyStoreType.DefaultKeyStoreType) - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
Creates an immutable copy of a
KeyStoreType.DefaultKeyStoreType
value. - copyOf(PrivateKey.DefaultPrivateKey) - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
-
Creates an immutable copy of a
PrivateKey.DefaultPrivateKey
value. - copyOf(PublicKey.DefaultPublicKey) - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
-
Creates an immutable copy of a
PublicKey.DefaultPublicKey
value. - copyOf(Seed.DefaultSeed) - Static method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
-
Creates an immutable copy of a
Seed.DefaultSeed
value. - copyOf(SignableTransaction) - Static method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
Creates an immutable copy of a
SignableTransaction
value. - copyOf(Signature) - Static method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
Creates an immutable copy of a
Signature
value. - copyOf(SignedTransaction<T>) - Static method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Creates an immutable copy of a
SignedTransaction
value.
D
- decodedSeed() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
-
The decoded details of this seed.
- decodedSeed() - Method in interface org.xrpl.xrpl4j.crypto.Seed
-
The decoded details of this seed.
- decodedSeed() - Method in class org.xrpl.xrpl4j.crypto.Seed.DefaultSeed
- DefaultKeyStoreType() - Constructor for class org.xrpl.xrpl4j.crypto.KeyStoreType.DefaultKeyStoreType
- DefaultPrivateKey() - Constructor for class org.xrpl.xrpl4j.crypto.PrivateKey.DefaultPrivateKey
- DefaultPublicKey() - Constructor for class org.xrpl.xrpl4j.crypto.PublicKey.DefaultPublicKey
- DefaultSeed() - Constructor for class org.xrpl.xrpl4j.crypto.Seed.DefaultSeed
- DERIVED_SERVER_SECRET - Static variable in interface org.xrpl.xrpl4j.crypto.KeyStoreType
-
Private keys are derived from a seed that is derived from a unique identifier and an in-memory server secret.
- doChecks() - Method in class org.xrpl.xrpl4j.crypto.KeyMetadata.AbstractKeyMetadata
-
For immutables.
E
- ecDsaSign(KeyMetadata, UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
-
Does the actual work of computing a signature using a secp256k1 private-key, as locatable using
privateKeyMetadata
. - ecDsaVerify(KeyMetadata, SignedTransaction, UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
-
Verify a signature.
- ed25519SeedFromPassphrase(byte[]) - Static method in interface org.xrpl.xrpl4j.crypto.Seed
-
Construct an Ed25519-compatible seed from the supplied
passphrase
. - edDsaSign(KeyMetadata, UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
-
Does the actual work of computing a signature using a ed25519 private-key, as locatable using
privateKeyMetadata
. - edDsaVerify(KeyMetadata, SignedTransaction, UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
-
Verify a signature.
- EMPTY - Static variable in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
Any empty instance that conformas to this interface but is otherwise empty.
- engineGenerateSeed(int) - Method in class org.xrpl.xrpl4j.crypto.LinuxSecureRandom
- engineNextBytes(byte[]) - Method in class org.xrpl.xrpl4j.crypto.LinuxSecureRandom
- engineSetSeed(byte[]) - Method in class org.xrpl.xrpl4j.crypto.LinuxSecureRandom
- equals(Object) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
This instance is equal to all instances of
ImmutableDefaultKeyStoreType
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
-
This instance is equal to all instances of
ImmutableDefaultPrivateKey
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
-
This instance is equal to all instances of
ImmutableDefaultPublicKey
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
-
This instance is equal to all instances of
ImmutableDefaultSeed
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
This instance is equal to all instances of
ImmutableKeyMetadata
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
This instance is equal to all instances of
ImmutableSignableTransaction
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
This instance is equal to all instances of
ImmutableSignature
that have equal attribute values. - equals(Object) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
This instance is equal to all instances of
ImmutableSignedTransaction
that have equal attribute values.
F
- from(KeyMetadata) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.KeyMetadata
instance. - from(KeyMetadata.AbstractKeyMetadata) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.KeyMetadata.AbstractKeyMetadata
instance. - from(KeyStoreType) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.KeyStoreType
instance. - from(KeyStoreType.DefaultKeyStoreType) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.KeyStoreType.DefaultKeyStoreType
instance. - from(PrivateKey) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.PrivateKey
instance. - from(PrivateKey.DefaultPrivateKey) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.PrivateKey.DefaultPrivateKey
instance. - from(PublicKey) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.PublicKey
instance. - from(PublicKey.DefaultPublicKey) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.PublicKey.DefaultPublicKey
instance. - from(Seed) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.Seed
instance. - from(Seed.DefaultSeed) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed.Builder
-
Fill a builder with attribute values from the provided
org.xrpl.xrpl4j.crypto.Seed.DefaultSeed
instance. - from(SignableTransaction) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction.Builder
-
Fill a builder with attribute values from the provided
SignableTransaction
instance. - from(Signature) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature.Builder
-
Fill a builder with attribute values from the provided
Signature
instance. - from(SignedTransaction<T>) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction.Builder
-
Fill a builder with attribute values from the provided
SignedTransaction
instance. - fromBase16EncodedPrivateKey(String) - Static method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
Construct a
PrivateKey
from a base16-encoded (HEX)String
. - fromBase16EncodedPublicKey(String) - Static method in interface org.xrpl.xrpl4j.crypto.PublicKey
-
Construct a
PrivateKey
from a base16-encoded (HEX)String
. - fromBase58EncodedPrivateKey(String) - Static method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
Construct a
PrivateKey
from a base58-encodedString
. - fromBase58EncodedPublicKey(String) - Static method in interface org.xrpl.xrpl4j.crypto.PublicKey
- fromKeystoreTypeId(String) - Static method in interface org.xrpl.xrpl4j.crypto.KeyStoreType
-
Helper method to construct a org.xrpl4j.crypto.keystore type from a
String
.
G
- GCP_KMS - Static variable in interface org.xrpl.xrpl4j.crypto.KeyStoreType
-
Private keys and symmetric secrets are stored in Google Cloud Platform KMS.
- getPublicKey(KeyMetadata) - Method in interface org.xrpl.xrpl4j.crypto.signing.SignatureService
-
Accessor for the public-key corresponding to the supplied key meta-data.
H
- hash() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
The hash of the
ImmutableSignedTransaction.signedTransactionBytes()
which can be used as a handle to the transaction even though the transaction hasn't yet been submitted to the XRP Ledger. - hash() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
The hash of the
SignedTransaction.signedTransactionBytes()
which can be used as a handle to the transaction even though the transaction hasn't yet been submitted to the XRP Ledger. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
Computes a hash code from attributes:
keystoreId
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
-
Computes a hash code from attributes:
value
,base58Encoded
,base16Encoded
,versionType
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
-
Computes a hash code from attributes:
value
,base58Encoded
,base16Encoded
,versionType
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
-
Computes a hash code from attributes:
value
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Computes a hash code from attributes:
platformIdentifier
,keyringIdentifier
,keyIdentifier
,keyVersion
,keyPassword
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
Computes a hash code from attributes:
originalTransaction
,signableTransactionBytes
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
Computes a hash code from attributes:
value
,base16Value
. - hashCode() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Computes a hash code from attributes:
unsignedTransaction
,signedTransaction
,signedTransactionBytes
,signature
,hash
.
I
- ImmutableDefaultKeyStoreType - Class in org.xrpl.xrpl4j.crypto
-
Immutable implementation of
KeyStoreType.DefaultKeyStoreType
. - ImmutableDefaultKeyStoreType.Builder - Class in org.xrpl.xrpl4j.crypto
-
Builds instances of type
ImmutableDefaultKeyStoreType
. - ImmutableDefaultPrivateKey - Class in org.xrpl.xrpl4j.crypto
-
Immutable implementation of
PrivateKey.DefaultPrivateKey
. - ImmutableDefaultPrivateKey.Builder - Class in org.xrpl.xrpl4j.crypto
-
Builds instances of type
ImmutableDefaultPrivateKey
. - ImmutableDefaultPublicKey - Class in org.xrpl.xrpl4j.crypto
-
Immutable implementation of
PublicKey.DefaultPublicKey
. - ImmutableDefaultPublicKey.Builder - Class in org.xrpl.xrpl4j.crypto
-
Builds instances of type
ImmutableDefaultPublicKey
. - ImmutableDefaultSeed - Class in org.xrpl.xrpl4j.crypto
-
Immutable implementation of
Seed.DefaultSeed
. - ImmutableDefaultSeed.Builder - Class in org.xrpl.xrpl4j.crypto
-
Builds instances of type
ImmutableDefaultSeed
. - ImmutableKeyMetadata - Class in org.xrpl.xrpl4j.crypto
-
Immutable implementation of
KeyMetadata.AbstractKeyMetadata
. - ImmutableKeyMetadata.Builder - Class in org.xrpl.xrpl4j.crypto
-
Builds instances of type
ImmutableKeyMetadata
. - ImmutableSignableTransaction - Class in org.xrpl.xrpl4j.crypto.signing
-
Immutable implementation of
SignableTransaction
. - ImmutableSignableTransaction.Builder - Class in org.xrpl.xrpl4j.crypto.signing
-
Builds instances of type
ImmutableSignableTransaction
. - ImmutableSignature - Class in org.xrpl.xrpl4j.crypto.signing
-
Immutable implementation of
Signature
. - ImmutableSignature.Builder - Class in org.xrpl.xrpl4j.crypto.signing
-
Builds instances of type
ImmutableSignature
. - ImmutableSignedTransaction<T extends Transaction> - Class in org.xrpl.xrpl4j.crypto.signing
-
Immutable implementation of
SignedTransaction
. - ImmutableSignedTransaction.Builder<T extends Transaction> - Class in org.xrpl.xrpl4j.crypto.signing
-
Builds instances of type
ImmutableSignedTransaction
.
J
- JavaKeystoreLoader - Class in org.xrpl.xrpl4j.crypto
-
A class that assists in loading
KeyStore
objects from the classpath.
K
- keyIdentifier() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
The unique identifier for the private-key used to encrypt this encoded secret.
- keyIdentifier() - Method in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
The unique identifier for the private-key used to encrypt this encoded secret.
- keyIdentifier(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Initializes the value for the
keyIdentifier
attribute. - KeyMetadata - Interface in org.xrpl.xrpl4j.crypto
-
Metadata about a particular key, public or private.
- KeyMetadata.AbstractKeyMetadata - Class in org.xrpl.xrpl4j.crypto
-
To satisfy immutables.
- keyPassword() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
An optional password that will unlock this particular key.
- keyPassword() - Method in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
An optional password that will unlock this particular key.
- keyPassword(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Initializes the optional value
keyPassword
to keyPassword. - keyPassword(Optional<String>) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Initializes the optional value
keyPassword
to keyPassword. - keyringIdentifier() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
The unique identifier of the keyring that holds the the private-key used to encrypt this encoded secret.
- keyringIdentifier() - Method in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
The unique identifier of the keyring that holds the the private-key used to encrypt this encoded secret.
- keyringIdentifier(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Initializes the value for the
keyringIdentifier
attribute. - keystoreId() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
The unique identifier of this KeyStore type.
- keystoreId() - Method in interface org.xrpl.xrpl4j.crypto.KeyStoreType
-
The unique identifier of this KeyStore type.
- keystoreId(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType.Builder
-
Initializes the value for the
keystoreId
attribute. - keyStoreType() - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
- keyStoreType() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignatureService
-
The type of org.xrpl4j.crypto.keystore this signer can be used with.
- KeyStoreType - Interface in org.xrpl.xrpl4j.crypto
-
An extensible interface that can be used to identify a type of underlying key-storage, which typically treats key-material as "secret information" whereas the data encrypted by these keys is generally not stored in these platforms.
- KeyStoreType.DefaultKeyStoreType - Class in org.xrpl.xrpl4j.crypto
-
For immutables.
- keyVersion() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
The version of the encryption key used to encrypt this secret.
- keyVersion() - Method in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
The version of the encryption key used to encrypt this secret.
- keyVersion(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Initializes the value for the
keyVersion
attribute.
L
- LinuxSecureRandom - Class in org.xrpl.xrpl4j.crypto
-
Implementation from web3j, which itself was taken from BitcoinJ.
- LinuxSecureRandom() - Constructor for class org.xrpl.xrpl4j.crypto.LinuxSecureRandom
-
No-args Constructor.
- loadFromClasspath(String, char[]) - Static method in class org.xrpl.xrpl4j.crypto.JavaKeystoreLoader
-
Helper method to load a
KeyStore
from the filesystem. - logger - Variable in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
-
A logger.
M
- MULTI - Enum constant in enum org.xrpl.xrpl4j.crypto.signing.SigningBehavior
O
- of(String) - Static method in interface org.xrpl.xrpl4j.crypto.KeyStoreType
-
Builder.
- org.xrpl.xrpl4j.crypto - package org.xrpl.xrpl4j.crypto
- org.xrpl.xrpl4j.crypto.signing - package org.xrpl.xrpl4j.crypto.signing
- originalTransaction() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
The original transaction that corresponds to this object.
- originalTransaction() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignableTransaction
-
The original transaction that corresponds to this object.
- originalTransaction(Transaction) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction.Builder
-
Initializes the value for the
originalTransaction
attribute.
P
- platformIdentifier() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
The unique identifier of the platform that can decode this secret.
- platformIdentifier() - Method in interface org.xrpl.xrpl4j.crypto.KeyMetadata
-
The unique identifier of the platform that can decode this secret.
- platformIdentifier(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata.Builder
-
Initializes the value for the
platformIdentifier
attribute. - PREFIX - Static variable in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
Keys generated from the secp256k1 curve have 33 bytes in XRP Ledger.
- PrivateKey - Interface in org.xrpl.xrpl4j.crypto
-
A typed instance of an XRPL private-key.
- PrivateKey.DefaultPrivateKey - Class in org.xrpl.xrpl4j.crypto
-
Abstract implementation for immutables.
- PublicKey - Interface in org.xrpl.xrpl4j.crypto
-
A typed instance of an XRPL Seed, which can be decoded into an instance of
Decoded
. - PublicKey.DefaultPublicKey - Class in org.xrpl.xrpl4j.crypto
-
Abstract implementation for immutables.
S
- secp256k1SeedFromPassphrase(byte[]) - Static method in interface org.xrpl.xrpl4j.crypto.Seed
-
Construct an secp256k1-compatible seed from the supplied
passphrase
. - secureRandom() - Static method in class org.xrpl.xrpl4j.crypto.SecureRandomUtils
-
Accessor for the shared
SecureRandom
. - SecureRandomUtils - Class in org.xrpl.xrpl4j.crypto
-
Utility class for working with SecureRandom implementation (Implementation from web3j).
- Seed - Interface in org.xrpl.xrpl4j.crypto
-
A typed instance of an XRPL Seed, which can be decoded into an instance of
Decoded
. - Seed.DefaultSeed - Class in org.xrpl.xrpl4j.crypto
-
Abstract implementation for immutables.
- ServerSecretSupplier - Interface in org.xrpl.xrpl4j.crypto
-
Supplies the Server secret in an implementation agnostic manner.
- sign(KeyMetadata, T) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
- sign(KeyMetadata, T) - Method in interface org.xrpl.xrpl4j.crypto.signing.TransactionSigner
-
Obtain a signature for the supplied transaction using the private-key that corresponds to
keyMetadata
. - SignableTransaction - Interface in org.xrpl.xrpl4j.crypto.signing
-
Holds both binary and typed manifestations of an XRPL transaction, for purposes of signing.
- signableTransactionBytes() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
The bytes of this message in canonical format such that signing them can be used by the XRP Ledger.
- signableTransactionBytes() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignableTransaction
-
The bytes of this message in canonical format such that signing them can be used by the XRP Ledger.
- signableTransactionBytes(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction.Builder
-
Initializes the value for the
signableTransactionBytes
attribute. - signature() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
The bytes of this message.
- signature() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
The bytes of this message.
- signature(Signature) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction.Builder
-
Initializes the value for the
signature
attribute. - Signature - Interface in org.xrpl.xrpl4j.crypto.signing
-
Represents a digital signature for a transaction that can be submitted to the XRP Ledger.
- SignatureService - Interface in org.xrpl.xrpl4j.crypto.signing
-
Defines how to sign and verify an XRPL transaction.
- SignatureUtils - Class in org.xrpl.xrpl4j.crypto.signing
-
Utility methods to help with generating, validating, and manipulating digital signatures.
- SignatureUtils(ObjectMapper, XrplBinaryCodec) - Constructor for class org.xrpl.xrpl4j.crypto.signing.SignatureUtils
-
Required-args constructor.
- SIGNED_TRANSACTION_HASH_PREFIX - Static variable in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
The hash prefix used by the XRPL to identify transaction hashes.
- signedTransaction() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
The transaction with a signature blob attached.
- signedTransaction() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
The transaction with a signature blob attached.
- signedTransaction(T) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction.Builder
-
Initializes the value for the
signedTransaction
attribute. - SignedTransaction<T extends Transaction> - Interface in org.xrpl.xrpl4j.crypto.signing
-
Holds the bytes for a signed XRPL transaction.
- signedTransactionBytes() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
The
ImmutableSignedTransaction.signedTransaction()
encoded into bytes that are suitable for submission to the XRP Ledger. - signedTransactionBytes() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
The
SignedTransaction.signedTransaction()
encoded into bytes that are suitable for submission to the XRP Ledger. - signedTransactionBytes(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction.Builder
-
Initializes the value for the
signedTransactionBytes
attribute. - SigningBehavior - Enum in org.xrpl.xrpl4j.crypto.signing
- signWithBehavior(KeyMetadata, Transaction, SigningBehavior) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
- signWithBehavior(KeyMetadata, Transaction, SigningBehavior) - Method in interface org.xrpl.xrpl4j.crypto.signing.TransactionSigner
-
Obtain a signature according to the
behavior
specified for the supplied transaction using the private-key that corresponds tokeyMetadata
. - SINGLE - Enum constant in enum org.xrpl.xrpl4j.crypto.signing.SigningBehavior
T
- toMultiSignableBytes(Transaction, String) - Method in class org.xrpl.xrpl4j.crypto.signing.SignatureUtils
-
Helper method to convert a
Transaction
into bytes that can be signed by multiple signers, as is the case when the source account has set a SignerList. - toSignableBytes(Transaction) - Method in class org.xrpl.xrpl4j.crypto.signing.SignatureUtils
-
Helper method to convert a
Transaction
into bytes that can be used directly for signing. - toString() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
Prints the immutable value
DefaultKeyStoreType
with attribute values. - toString() - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Prints the immutable value
KeyMetadata
with attribute values. - toString() - Method in class org.xrpl.xrpl4j.crypto.PrivateKey.DefaultPrivateKey
- toString() - Method in class org.xrpl.xrpl4j.crypto.PublicKey.DefaultPublicKey
- toString() - Method in class org.xrpl.xrpl4j.crypto.Seed.DefaultSeed
- toString() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
Prints the immutable value
SignableTransaction
with attribute values. - toString() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
Prints the immutable value
Signature
with attribute values. - toString() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Prints the immutable value
SignedTransaction
with attribute values. - TransactionSigner - Interface in org.xrpl.xrpl4j.crypto.signing
-
Defines how to sign an XRPL transaction.
- TransactionVerifier - Interface in org.xrpl.xrpl4j.crypto.signing
-
Defines how to verify an XRPL transaction.
U
- unsignedTransaction() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
The original transaction with no signature attached.
- unsignedTransaction() - Method in interface org.xrpl.xrpl4j.crypto.signing.SignedTransaction
-
The original transaction with no signature attached.
- unsignedTransaction(T) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction.Builder
-
Initializes the value for the
unsignedTransaction
attribute.
V
- value() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
-
The key, in binary (Note: will be 33 bytes).
- value() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
-
The key in binary (Note: will be 33 bytes).
- value() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
- value() - Method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
The key, in binary (Note: will be 33 bytes).
- value() - Method in interface org.xrpl.xrpl4j.crypto.PublicKey
-
The key in binary (Note: will be 33 bytes).
- value() - Method in class org.xrpl.xrpl4j.crypto.Seed.DefaultSeed
- value() - Method in interface org.xrpl.xrpl4j.crypto.Seed
-
The seed value, as a Base58-encoded string.
- value() - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
The bytes of this signature.
- value() - Method in interface org.xrpl.xrpl4j.crypto.signing.Signature
-
The bytes of this signature.
- value(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed.Builder
-
Initializes the value for the
value
attribute. - value(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey.Builder
-
Initializes the value for the
value
attribute. - value(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey.Builder
-
Initializes the value for the
value
attribute. - value(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature.Builder
-
Initializes the value for the
value
attribute. - valueOf(String) - Static method in enum org.xrpl.xrpl4j.crypto.signing.SigningBehavior
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.xrpl.xrpl4j.crypto.signing.SigningBehavior
-
Returns an array containing the constants of this enum type, in the order they are declared.
- verify(KeyMetadata, SignedTransaction) - Method in class org.xrpl.xrpl4j.crypto.signing.AbstractSignatureService
- verify(KeyMetadata, SignedTransaction<T>) - Method in interface org.xrpl.xrpl4j.crypto.signing.TransactionVerifier
-
TransactionVerifier the supplied digital-signature to ensure that it was constructed using the private-key corresponding to
publicKey
. - versionType() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
- versionType() - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
- versionType() - Method in class org.xrpl.xrpl4j.crypto.PrivateKey.DefaultPrivateKey
- versionType() - Method in interface org.xrpl.xrpl4j.crypto.PrivateKey
-
The type of this key (either
VersionType.ED25519
orVersionType.SECP256K1
). - versionType() - Method in class org.xrpl.xrpl4j.crypto.PublicKey.DefaultPublicKey
- versionType() - Method in interface org.xrpl.xrpl4j.crypto.PublicKey
-
The type of this key.
W
- withKeyIdentifier(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Copy the current immutable object by setting a value for the
keyIdentifier
attribute. - withKeyPassword(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Copy the current immutable object by setting a present value for the optional
keyPassword
attribute. - withKeyPassword(Optional<String>) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Copy the current immutable object by setting an optional value for the
keyPassword
attribute. - withKeyringIdentifier(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Copy the current immutable object by setting a value for the
keyringIdentifier
attribute. - withKeystoreId(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultKeyStoreType
-
Copy the current immutable object by setting a value for the
keystoreId
attribute. - withKeyVersion(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Copy the current immutable object by setting a value for the
keyVersion
attribute. - withOriginalTransaction(Transaction) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
Copy the current immutable object by setting a value for the
originalTransaction
attribute. - withPlatformIdentifier(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableKeyMetadata
-
Copy the current immutable object by setting a value for the
platformIdentifier
attribute. - withSignableTransactionBytes(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignableTransaction
-
Copy the current immutable object by setting a value for the
signableTransactionBytes
attribute. - withSignature(Signature) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Copy the current immutable object by setting a value for the
signature
attribute. - withSignedTransaction(T) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Copy the current immutable object by setting a value for the
signedTransaction
attribute. - withSignedTransactionBytes(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Copy the current immutable object by setting a value for the
signedTransactionBytes
attribute. - withUnsignedTransaction(T) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignedTransaction
-
Copy the current immutable object by setting a value for the
unsignedTransaction
attribute. - withValue(String) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultSeed
-
Copy the current immutable object by setting a value for the
value
attribute. - withValue(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPrivateKey
-
Copy the current immutable object by setting a value for the
value
attribute. - withValue(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.ImmutableDefaultPublicKey
-
Copy the current immutable object by setting a value for the
value
attribute. - withValue(UnsignedByteArray) - Method in class org.xrpl.xrpl4j.crypto.signing.ImmutableSignature
-
Copy the current immutable object by setting a value for the
value
attribute.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form