All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.bitcoinj.uri.BitcoinURI Maven / Gradle / Ivy

There is a newer version: 21.0.0
Show newest version
/*
 * Copyright 2012, 2014 the original author or authors.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.bitcoinj.uri;

import org.bitcoinj.core.*;
import org.bitcoinj.params.AbstractBitcoinNetParams;

import javax.annotation.Nullable;
import java.io.UnsupportedEncodingException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URLDecoder;
import java.util.*;

import static com.google.common.base.Preconditions.checkNotNull;

/**
 * 

Provides a standard implementation of a Bitcoin URI with support for the following:

* *
    *
  • URLEncoded URIs (as passed in by IE on the command line)
  • *
  • BIP21 names (including the "req-" prefix handling requirements)
  • *
* *

Accepted formats

* *

The following input forms are accepted:

* *
    *
  • {@code bitcoin:
    }
  • *
  • {@code bitcoin:
    ?=&=} with multiple * additional name/value pairs
  • *
* *

The name/value pairs are processed as follows.

*
    *
  1. URL encoding is stripped and treated as UTF-8
  2. *
  3. names prefixed with {@code req-} are treated as required and if unknown or conflicting cause a parse exception
  4. *
  5. Unknown names not prefixed with {@code req-} are added to a Map, accessible by parameter name
  6. *
  7. Known names not prefixed with {@code req-} are processed unless they are malformed
  8. *
* *

The following names are known and have the following formats:

*
    *
  • {@code amount} decimal value to 8 dp (e.g. 0.12345678) Note that the * exponent notation is not supported any more
  • *
  • {@code label} any URL encoded alphanumeric
  • *
  • {@code message} any URL encoded alphanumeric
  • *
* * @author Andreas Schildbach (initial code) * @author Jim Burton (enhancements for MultiBit) * @author Gary Rowe (BIP21 support) * @see BIP 0021 */ public class BitcoinURI { // Not worth turning into an enum public static final String FIELD_MESSAGE = "message"; public static final String FIELD_LABEL = "label"; public static final String FIELD_AMOUNT = "amount"; public static final String FIELD_ADDRESS = "address"; public static final String FIELD_PAYMENT_REQUEST_URL = "r"; public static final String FIELD_USER = "user"; /** * URI for Bitcoin network. Use {@link AbstractBitcoinNetParams#BITCOIN_SCHEME} if you specifically * need Bitcoin, or use {@link NetworkParameters#getUriScheme} to get the scheme * from network parameters. */ @Deprecated public static final String BITCOIN_SCHEME = "dash"; private static final String ENCODED_SPACE_CHARACTER = "%20"; private static final String AMPERSAND_SEPARATOR = "&"; private static final String QUESTION_MARK_SEPARATOR = "?"; /** * Contains all the parameters in the order in which they were processed */ private final Map parameterMap = new LinkedHashMap<>(); /** * Constructs a new BitcoinURI from the given string. Can be for any network. * * @param uri The raw URI data to be parsed (see class comments for accepted formats) * @throws BitcoinURIParseException if the URI is not syntactically or semantically valid. */ public BitcoinURI(String uri) throws BitcoinURIParseException { this(null, uri); } /** * Constructs a new object by trying to parse the input as a valid Bitcoin URI. * * @param params The network parameters that determine which network the URI is from, or null if you don't have * any expectation about what network the URI is for and wish to check yourself. * @param input The raw URI data to be parsed (see class comments for accepted formats) * * @throws BitcoinURIParseException If the input fails Bitcoin URI syntax and semantic checks. */ public BitcoinURI(@Nullable NetworkParameters params, String input) throws BitcoinURIParseException { checkNotNull(input); String scheme = null == params ? AbstractBitcoinNetParams.BITCOIN_SCHEME : params.getUriScheme(); // Attempt to form the URI (fail fast syntax checking to official standards). URI uri; try { uri = new URI(input); } catch (URISyntaxException e) { throw new BitcoinURIParseException("Bad URI syntax", e); } // URI is formed as bitcoin:
? // blockchain.info generates URIs of non-BIP compliant form bitcoin://address?.... // We support both until Ben fixes his code. // Remove the bitcoin scheme. // (Note: getSchemeSpecificPart() is not used as it unescapes the label and parse then fails. // For instance with : bitcoin:129mVqKUmJ9uwPxKJBnNdABbuaaNfho4Ha?amount=0.06&label=Tom%20%26%20Jerry // the & (%26) in Tom and Jerry gets interpreted as a separator and the label then gets parsed // as 'Tom ' instead of 'Tom & Jerry') String blockchainInfoScheme = scheme + "://"; String correctScheme = scheme + ":"; String schemeSpecificPart; final String inputLc = input.toLowerCase(Locale.US); if (inputLc.startsWith(blockchainInfoScheme)) { schemeSpecificPart = input.substring(blockchainInfoScheme.length()); } else if (inputLc.startsWith(correctScheme)) { schemeSpecificPart = input.substring(correctScheme.length()); } else { throw new BitcoinURIParseException("Unsupported URI scheme: " + uri.getScheme()); } // Split off the address from the rest of the query parameters. String[] addressSplitTokens = schemeSpecificPart.split("\\?", 2); if (addressSplitTokens.length == 0) throw new BitcoinURIParseException("No data found after the dash: prefix"); String addressToken = addressSplitTokens[0]; // may be empty! String[] nameValuePairTokens; if (addressSplitTokens.length == 1) { // Only an address is specified - use an empty '=' token array. nameValuePairTokens = new String[] {}; } else { // Split into '=' tokens. nameValuePairTokens = addressSplitTokens[1].split("&"); } // Attempt to parse the rest of the URI parameters. parseParameters(params, addressToken, nameValuePairTokens); if (!addressToken.isEmpty()) { // Attempt to parse the addressToken as a Bitcoin address for this network try { Address address = Address.fromBase58(params, addressToken); putWithValidation(FIELD_ADDRESS, address); } catch (final AddressFormatException e) { throw new BitcoinURIParseException("Bad address", e); } } if (addressToken.isEmpty() && getPaymentRequestUrl() == null) { throw new BitcoinURIParseException("No address and no r= parameter found"); } } /** * @param params The network parameters or null * @param nameValuePairTokens The tokens representing the name value pairs (assumed to be * separated by '=' e.g. 'amount=0.2') */ private void parseParameters(@Nullable NetworkParameters params, String addressToken, String[] nameValuePairTokens) throws BitcoinURIParseException { // Attempt to decode the rest of the tokens into a parameter map. for (String nameValuePairToken : nameValuePairTokens) { final int sepIndex = nameValuePairToken.indexOf('='); if (sepIndex == -1) throw new BitcoinURIParseException("Malformed Dash URI - no separator in '" + nameValuePairToken + "'"); if (sepIndex == 0) throw new BitcoinURIParseException("Malformed Dash URI - empty name '" + nameValuePairToken + "'"); final String nameToken = nameValuePairToken.substring(0, sepIndex).toLowerCase(Locale.ENGLISH); final String valueToken = nameValuePairToken.substring(sepIndex + 1); // Parse the amount. if (FIELD_AMOUNT.equals(nameToken)) { // Decode the amount (contains an optional decimal component to 8dp). try { Coin amount = Coin.parseCoin(valueToken); if (params != null && amount.isGreaterThan(params.getMaxMoney())) throw new BitcoinURIParseException("Max number of coins exceeded"); if (amount.signum() < 0) throw new ArithmeticException("Negative coins specified"); putWithValidation(FIELD_AMOUNT, amount); } catch (IllegalArgumentException e) { throw new OptionalFieldValidationException(String.format(Locale.US, "'%s' is not a valid amount", valueToken), e); } catch (ArithmeticException e) { throw new OptionalFieldValidationException(String.format(Locale.US, "'%s' has too many decimal places", valueToken), e); } } else { if (nameToken.startsWith("req-")) { // A required parameter that we do not know about. throw new RequiredFieldValidationException("'" + nameToken + "' is required but not known, this URI is not valid"); } else { // Known fields and unknown parameters that are optional. try { if (valueToken.length() > 0) putWithValidation(nameToken, URLDecoder.decode(valueToken, "UTF-8")); } catch (UnsupportedEncodingException e) { throw new RuntimeException(e); // can't happen } } } } // Note to the future: when you want to implement 'req-expires' have a look at commit 410a53791841 // which had it in. } /** * Put the value against the key in the map checking for duplication. This avoids address field overwrite etc. * * @param key The key for the map * @param value The value to store */ private void putWithValidation(String key, Object value) throws BitcoinURIParseException { if (parameterMap.containsKey(key)) { throw new BitcoinURIParseException(String.format(Locale.US, "'%s' is duplicated, URI is invalid", key)); } else { parameterMap.put(key, value); } } /** * The Bitcoin address from the URI, if one was present. It's possible to have Bitcoin URI's with no address if a * r= payment protocol parameter is specified, though this form is not recommended as older wallets can't understand * it. */ @Nullable public Address getAddress() { return (Address) parameterMap.get(FIELD_ADDRESS); } /** * @return The amount name encoded using a pure integer value based at * 10,000,000 units is 1 BTC. May be null if no amount is specified */ public Coin getAmount() { return (Coin) parameterMap.get(FIELD_AMOUNT); } /** * @return The label from the URI. */ public String getLabel() { return (String) parameterMap.get(FIELD_LABEL); } /** * @return The message from the URI. */ public String getMessage() { return (String) parameterMap.get(FIELD_MESSAGE); } /** * @return The user from the URI. */ public String getUser() { return (String)parameterMap.get(FIELD_USER); } /** * @return The URL where a payment request (as specified in BIP 70) may * be fetched. */ public final String getPaymentRequestUrl() { return (String) parameterMap.get(FIELD_PAYMENT_REQUEST_URL); } /** * Returns the URLs where a payment request (as specified in BIP 70) may be fetched. The first URL is the main URL, * all subsequent URLs are fallbacks. */ public List getPaymentRequestUrls() { ArrayList urls = new ArrayList<>(); while (true) { int i = urls.size(); String paramName = FIELD_PAYMENT_REQUEST_URL + (i > 0 ? Integer.toString(i) : ""); String url = (String) parameterMap.get(paramName); if (url == null) break; urls.add(url); } Collections.reverse(urls); return urls; } /** * @param name The name of the parameter * @return The parameter value, or null if not present */ public Object getParameterByName(String name) { return parameterMap.get(name); } @Override public String toString() { StringBuilder builder = new StringBuilder("DashURI["); boolean first = true; for (Map.Entry entry : parameterMap.entrySet()) { if (first) { first = false; } else { builder.append(","); } builder.append("'").append(entry.getKey()).append("'=").append("'").append(entry.getValue()).append("'"); } builder.append("]"); return builder.toString(); } /** * Simple Bitcoin URI builder using known good fields. * * @param address The Bitcoin address * @param amount The amount * @param label A label * @param message A message * @return A String containing the Bitcoin URI */ public static String convertToBitcoinURI(Address address, Coin amount, String label, String message) { return convertToBitcoinURI(address.getParameters(), address.toString(), amount, label, message); } /** * Simple Bitcoin URI builder using known good fields. * * @param params The network parameters that determine which network the URI * is for. * @param address The Bitcoin address * @param amount The amount * @param label A label * @param message A message * @return A String containing the Bitcoin URI */ public static String convertToBitcoinURI(NetworkParameters params, String address, @Nullable Coin amount, @Nullable String label, @Nullable String message) { return convertToBitcoinURI(params, address, amount, label, message, null); } /** * Simple Bitcoin URI builder using known good fields. * * @param params The network parameters that determine which network the URI * is for. * @param address The Bitcoin address * @param amount The amount * @param label A label * @param message A message * @param user A user * @return A String containing the Bitcoin URI */ public static String convertToBitcoinURI(NetworkParameters params, String address, @Nullable Coin amount, @Nullable String label, @Nullable String message, @Nullable String user) { checkNotNull(params); checkNotNull(address); if (amount != null && amount.signum() < 0) { throw new IllegalArgumentException("Coin must be positive"); } StringBuilder builder = new StringBuilder(); String scheme = params.getUriScheme(); builder.append(scheme).append(":").append(address); boolean questionMarkHasBeenOutput = false; if (amount != null) { builder.append(QUESTION_MARK_SEPARATOR).append(FIELD_AMOUNT).append("="); builder.append(amount.toPlainString()); questionMarkHasBeenOutput = true; } if (label != null && !"".equals(label)) { if (questionMarkHasBeenOutput) { builder.append(AMPERSAND_SEPARATOR); } else { builder.append(QUESTION_MARK_SEPARATOR); questionMarkHasBeenOutput = true; } builder.append(FIELD_LABEL).append("=").append(encodeURLString(label)); } if (message != null && !"".equals(message)) { if (questionMarkHasBeenOutput) { builder.append(AMPERSAND_SEPARATOR); } else { builder.append(QUESTION_MARK_SEPARATOR); } builder.append(FIELD_MESSAGE).append("=").append(encodeURLString(message)); } if (user != null && !"".equals(user)) { if (questionMarkHasBeenOutput) { builder.append(AMPERSAND_SEPARATOR); } else { builder.append(QUESTION_MARK_SEPARATOR); } builder.append(FIELD_USER).append("=").append(encodeURLString(user)); } return builder.toString(); } /** * Encode a string using URL encoding * * @param stringToEncode The string to URL encode */ static String encodeURLString(String stringToEncode) { try { return java.net.URLEncoder.encode(stringToEncode, "UTF-8").replace("+", ENCODED_SPACE_CHARACTER); } catch (UnsupportedEncodingException e) { throw new RuntimeException(e); // can't happen } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy