Skip to content
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.

Sign up for GitHub

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

Update README.md #491

Closed
wants to merge 4 commits into from
Closed

Update README.md #491

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
167aa36
Update README.md
Try-Parser Oct 22, 2023
ac50b25
Update README.md
Try-Parser Oct 23, 2023
5a44330
Update README.md
Try-Parser Oct 23, 2023
22b1f75
Update README.md
Try-Parser Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,17 +141,24 @@ For use-cases that require private keys to exist inside the running JVM, the fol
generate a keypair, and also how to derive an XRPL address from there:

```java
import org.xrpl.xrpl4j.crypto.core.keys.Seed;
import org.xrpl.xrpl4j.crypto.core.keys.PrivateKey;
import org.xrpl.xrpl4j.crypto.core.keys.PublicKey;
import org.xrpl.xrpl4j.crypto.keys.Seed;
import org.xrpl.xrpl4j.crypto.keys.KeyPair;
import org.xrpl.xrpl4j.crypto.keys.PrivateKey;
import org.xrpl.xrpl4j.crypto.keys.PublicKey;
import org.xrpl.xrpl4j.model.transactions.Address;

import org.xrpl.xrpl4j.model.transactions.XAddress;
import org.xrpl.xrpl4j.codec.addresses.AddressCodec;
...
Seed seed = Seed.ed25519Seed(); // <-- Generates a random seed.

Seed seed = Seed.ed255519Seed(); // <-- Generates a random seed.
PrivateKey privateKey = seed.derivePrivateKey(); // <-- Derive a private key from the seed.
PublicKey publicKey = privateKey.derivePublicKey(); // <-- Derive a public key from the private key.
Address address = publicKey.deriveAddress(); // <-- Derive an address from the public key.
KeyPair pair = seed.deriveKeyPair(); // <-- Derive a key pair from seed;
PublicKey pubKey = pair.publicKey(); // <-- Public key from KeyPair
PrivateKey privKey = pair.privateKey() // <-- Private key from KeyPair
Try-Parser marked this conversation as resolved.
Show resolved Hide resolved

// Classic Addresss
Try-Parser marked this conversation as resolved.
Show resolved Hide resolved
Address classicAddress = pubKey.deriveAddress();
Try-Parser marked this conversation as resolved.
Show resolved Hide resolved
// Derive the Classic and X-Addresses from testWallet
XAddress xAddress = AddressCodec.getInstance().classicAddressToXAddress(classicAddress, true)
```

#### Private Key References (`PrivateKeyReference`)
Expand Down Expand Up @@ -183,12 +190,13 @@ The following example illustrates how to construct a payment transaction, sign i
then submit that transaction to the XRP Ledger for processing and validation:

```java
import org.xrpl.xrpl4j.crypto.core.keys.Seed;
import org.xrpl.xrpl4j.crypto.core.keys.KeyPair;
import org.xrpl.xrpl4j.crypto.core.keys.PrivateKey;
import org.xrpl.xrpl4j.crypto.core.keys.PublicKey;
import org.xrpl.xrpl4j.crypto.keys.Seed;
import org.xrpl.xrpl4j.crypto.keys.KeyPair;
import org.xrpl.xrpl4j.crypto.keys.PrivateKey;
import org.xrpl.xrpl4j.crypto.keys.PublicKey;
import org.xrpl.xrpl4j.model.transactions.Address;
import org.xrpl.xrpl4j.crypto.core.signing.SignatureService;

import org.xrpl.xrpl4j.crypto.signing.SignatureService;
import org.xrpl.xrpl4j.crypto.signing.bc.BcSignatureService;

// Construct a SignatureService that uses in-memory Keys (see SignatureService.java for alternatives).
Expand All @@ -200,6 +208,11 @@ PrivateKey senderPrivateKey = senderSeed.derivePrivateKey();
PublicKey senderPublicKey = senderPrivateKey.derivePublicKey();
Address senderAddress = senderPublicKey.deriveAddress();

KeyPair pair = Seed.ed25519Seed().deriveKeyPair(); // <-- Generate Key Pair from random seed;
PublicKey pubKey = pair.publicKey(); // <-- Public key from KeyPair
PrivateKey privKey = pair.privateKey() // <-- Private key from KeyPair
Address classicAddress = pubKey.deriveAddress();
Try-Parser marked this conversation as resolved.
Show resolved Hide resolved

// Receiver (using secp256k1 key)
Address receiverAddress = Address.of("r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59");

Expand Down