Skip to content

Commit ff5faf4

Browse files
authored
Merge branch 'main' into mpt-amounts
2 parents e7e6b69 + c0fb168 commit ff5faf4

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,9 @@ Which produces the following output:
128128
Most operations using this library require some sort of private key material. Broadly speaking, the library supports
129129
two mechanisms: (1) in-memory private keys, and (2) in-memory _references_ to private keys where the actual private key
130130
material lives in an external system (e.g., keys in a Hardware Security Module, or HSM). In Java, this is modeled
131-
using the `PrivateKeyable` interface, which has two subclasses: `PrivateKey` and `PrivateKeyReference`.
131+
using the [`PrivateKeyable`](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/keys/PrivateKeyable.java) interface,
132+
which has two subclasses: [`PrivateKey`](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/keys/PrivateKey.java)
133+
and [`PrivateKeyReference`](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/keys/PrivateKeyReference.java).
132134

133135
#### In-Memory Private Keys (`PrivateKey`)
134136

@@ -163,7 +165,7 @@ without exposing key material to the outside world (e.g., an HSM or cloud servic
163165

164166
This library does not provide an implementation that interacts with any particular external signing service or HSM.
165167
However, developers wishing to support such interactions should extend `PrivateKeyReference` for the particular external service, and implement
166-
[SignatureService](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/crypto/signing/SignatureService.java) for their `PrivateKeyReference` type.
168+
[SignatureService](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/signing/SignatureService.java) for their `PrivateKeyReference` type.
167169
interface. In
168170
addition, [FauxGcpKmsSignatureServiceTest](./xrpl4j-core/src/test/java/org/xrpl/xrpl4j/crypto/signing/faux/FauxGcpKmsSignatureServiceTest.java)
169171
and [FauxAwsKmsSignatureServiceTest](./xrpl4j-core/src/test/java/org/xrpl/xrpl4j/crypto/signing/faux/FauxAwsKmsSignatureServiceTest.java)
@@ -172,9 +174,10 @@ illustrate faux variants of a simulated external key provider that can also be u
172174
### Signing and Verifying Transactions
173175

174176
The main interface used to sign and verify transactions
175-
is [SignatureService](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/model/crypto/signing/SignatureService.java),
176-
which has two concrete implementations: `BcSignatureService` and `BcDerivedKeySignatureService`. The first uses
177-
in-memory private key material to perform signing and validation operations, while the latter can be used to derive
177+
is [SignatureService](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/signing/SignatureService.java), which has two concrete
178+
implementations: [`BcSignatureService`](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/signing/bc/BcSignatureService.java) and
179+
[`BcDerivedKeySignatureService`](./xrpl4j-core/src/main/java/org/xrpl/xrpl4j/crypto/signing/bc/BcDerivedKeySignatureService.java).
180+
The first uses in-memory private key material to perform signing and validation operations, while the latter can be used to derive
178181
multiple private keys using a single entropy source combined with differing unique key identifiers (e.g., User Ids).
179182

180183
#### Construct and Sign an XRP Payment:

0 commit comments

Comments
 (0)