soneso / stellar-java-mnemonic Goto Github PK

View Code? Open in Web Editor NEW

11.0 7.0 6.0 9.68 MB

A Java library that can be used to create mnemonics for the Stellar Network (e.g. for your Android app)

License: Apache License 2.0

Java 100.00%

stellar stellar-network mnemonic mnemonics java android blockchain cryptocurrency key-derivation

stellar-java-mnemonic's Introduction

stellar-java-mnemonic

The Soneso open source Java library to create mnemonics for the Stellar Network.

See Key Derivation Methods for Stellar Accounts

Installation

Jar file

Add the current jar file from the distribution folder to your Java/Android Project.

Source code

Copy and attach source code to your project.

Dependencies

The library needs the Stellar Java SDK

If you add the library to a project running Java 1.7 or lower, then you need Bouncy Castle as well, because some of the security algorithms used within the library are supported starting with Java 1.8 only. After adding that dependency, add the following lines of code at your project entry point.

Security.removeProvider("BC");
Security.insertProviderAt(new BouncyCastleProvider(), 1);

In that way you are adding Bouncy Castle as the main provider for security algorthms.

Quick Start

Deterministic generation

Generate mnemonic

char[] mnemonic = Wallet.generate24WordMnemonic();
String[] words = String.valueOf(mnemonic).split(" ");
// bench hurt jump file august wise shallow faculty impulse spring exact slush thunder author capable act festival slice deposit sauce coconut afford frown better

Generate key pairs

char[] mnemonic = "bench hurt jump file august wise shallow faculty impulse spring exact slush thunder author capable act festival slice deposit sauce coconut afford frown better".toCharArray();
KeyPair keyPair0 = Wallet.createKeyPair(mnemonic, null, 0);
KeyPair keyPair1 = Wallet.createKeyPair(mnemonic, null, 1);

Generate key pairs with passphrase

char[] mnemonic = "cable spray genius state float twenty onion head street palace net private method loan turn phrase state blanket interest dry amazing dress blast tube".toCharArray();
char[] passphrase = "p4ssphr4se".toCharArray();
KeyPair keyPair0 = Wallet.createKeyPair(mnemonic, passphrase, 0);

BIP and master key generation

char[] mnemonic = "bench hurt jump file august wise shallow faculty impulse spring exact slush thunder author capable act festival slice deposit sauce coconut afford frown better".toCharArray();
byte[] bip39Seed = Mnemonic.createSeed(mnemonic, null);

Ed25519Derivation masterPrivateKey = Ed25519Derivation.fromSecretSeed(bip39Seed);
Ed25519Derivation purpose = masterPrivateKey.derived(44);
Ed25519Derivation coinType = purpose.derived(148);

Ed25519Derivation account0 = coinType.derived(0);
KeyPair keyPair0 = KeyPair.fromSecretSeed(account0.getPrivateKey());

Ed25519Derivation account4 = coinType.derived(4);
KeyPair keyPair4 = KeyPair.fromSecretSeed(account4.getPrivateKey());

Please also see test classes for more examples.

License

java-stellar-mnemonic is licensed under an Apache-2.0 license. See the LICENSE file for details.

Donations

Send lumens to: GANSYJ64BTHYFM6BAJEWXYLVSZVSHYZFPW4DIQDWJL5BOT6O6GUE7JM5

stellar-java-mnemonic's People

Contributors

Stargazers

Watchers

Forkers

daniel-wang linhtoji vlmold isanwenyu pipicoming uriencedric

stellar-java-mnemonic's Issues

Firebase SDK https requests on Android Pie stop working at some point

Hi everyone. We use your library in our product which is Wallet based on Stellar network and I faced an issue working with Firebase SDK.

These lines cause problems on Android P in our case:

Security.removeProvider("BC");
Security.insertProviderAt(new BouncyCastleProvider(), 1);

Https requests get stuck when Firebase API updates certificates or something.
I cannot have control over requests inside of Firebase SDK. And this bug happens at some point after use of app & all Firebase requests not working after this point.

This is the exception I get from Firebase when this issue appears:

error sending network request POST https://firebasestorage.googleapis.com
java.net.SocketException: java.security.NoSuchAlgorithmException: Error constructing implementation (algorithm: Default, provider: AndroidOpenSSL, class: com.android.org.conscrypt.DefaultSSLContextImpl)
at javax.net.ssl.DefaultSSLSocketFactory.throwException(SSLSocketFactory.java:284)
at javax.net.ssl.DefaultSSLSocketFactory.createSocket(SSLSocketFactory.java:306)
at com.android.okhttp.internal.io.RealConnection.connectTls(RealConnection.java:181)
at com.android.okhttp.internal.io.RealConnection.connectSocket(RealConnection.java:149)
at com.android.okhttp.internal.io.RealConnection.connect(RealConnection.java:112)
at com.android.okhttp.internal.http.StreamAllocation.findConnection(StreamAllocation.java:184)
at com.android.okhttp.internal.http.StreamAllocation.findHealthyConnection(StreamAllocation.java:126)
at com.android.okhttp.internal.http.StreamAllocation.newStream(StreamAllocation.java:95)
at com.android.okhttp.internal.http.HttpEngine.connect(HttpEngine.java:281)
at com.android.okhttp.internal.http.HttpEngine.sendRequest(HttpEngine.java:224)
at com.android.okhttp.internal.huc.HttpURLConnectionImpl.execute(HttpURLConnectionImpl.java:461)
at com.android.okhttp.internal.huc.HttpURLConnectionImpl.getResponse(HttpURLConnectionImpl.java:407)
at com.android.okhttp.internal.huc.HttpURLConnectionImpl.getResponseCode(HttpURLConnectionImpl.java:538)
at com.android.okhttp.internal.huc.DelegatingHttpsURLConnection.getResponseCode(DelegatingHttpsURLConnection.java:105)

createSeed uses "PBKDF2WithHmacSHA512" which is only supported Android API 26+

From the SecretKeyFactory docs createSeed only supports API 26+ with the current algorithm.

Could we overload this method so it uses a different algorithm based on the API level of the device?

support other strenghts than high(24 words) and low(12 words)

For example Stellarx uses 15 words.
One possible solution is to make the constructor of Strength public

private Strength(int rawValue) {
        this.rawValue = rawValue;
    }