Package org.xrpl.xrpl4j.wallet

Class DefaultWalletFactory

java.lang.Object

org.xrpl.xrpl4j.wallet.DefaultWalletFactory

All Implemented Interfaces:

WalletFactory

public class DefaultWalletFactory
extends Object
implements WalletFactory

Default implementation of WalletFactory.

Constructor Summary

Constructors

Constructor	Description
DefaultWalletFactory(KeyPairService keyPairService, AddressCodec addressCodec)	Construct a DefaultWalletFactory from a KeyPairService and an AddressCodec.

Method Summary

Modifier and Type	Method	Description
Wallet	fromKeyPair(KeyPair keyPair, boolean isTest)	Generate a Wallet from a KeyPair.
Wallet	fromSeed(String seed, boolean isTest)	Generate a Wallet from a Base58Check encoded seed value.
static WalletFactory	getInstance()	Get a JVM wide WalletFactory instance.
SeedWalletGenerationResult	randomWallet(boolean isTest)	Generate a Wallet by generating a random seed and deriving the public/private keys and XRPL address from it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWalletFactory

public DefaultWalletFactory(KeyPairService keyPairService,
                            AddressCodec addressCodec)

Construct a DefaultWalletFactory from a KeyPairService and an AddressCodec.

Parameters:

keyPairService - A KeyPairService.

addressCodec - An AddressCodec.

Method Detail

getInstance

public static WalletFactory getInstance()

Get a JVM wide WalletFactory instance.

Returns:

A static DefaultWalletFactory instance.

randomWallet

public SeedWalletGenerationResult randomWallet(boolean isTest)

Description copied from interface: WalletFactory

Generate a Wallet by generating a random seed and deriving the public/private keys and XRPL address from it.

Specified by:

randomWallet in interface WalletFactory

Parameters:

isTest - A boolean requesting either a testnet wallet (if true) or a mainnet wallet (if false).

Returns:

A SeedWalletGenerationResult, which contains the seed that was generated, as well as the Wallet.

fromSeed

public Wallet fromSeed(String seed,
                       boolean isTest)

Description copied from interface: WalletFactory

Generate a Wallet from a Base58Check encoded seed value.

Specified by:

fromSeed in interface WalletFactory

Parameters:

seed - A Base58Check encoded 16 byte seed value.

isTest - A boolean indicating either a testnet wallet (if true) or a mainnet wallet (if false).

Returns:

The Wallet derived from the seed.

fromKeyPair

public Wallet fromKeyPair(KeyPair keyPair,
                          boolean isTest)

Description copied from interface: WalletFactory

Generate a Wallet from a KeyPair.

Specified by:

fromKeyPair in interface WalletFactory

Parameters:

keyPair - The KeyPair containing the private and public keys used to generate the Wallet.

isTest - A boolean indicating either a testnet wallet (if true) or a mainnet wallet (if false).

Returns:

The Wallet derived from the keyPair.