BitcoinExpress

Bitcoin-express payment library

• Licence: MIT Licence
• Authors: Jose E. Martinez, Ricky Rand
• Contributers: Paul Clark, Jon Barber, Clive Rand
• Language: Javascript
• Homepage: https://bitcoin-e.org/

Getting started

Bitcoin-express payment library provides developer with the tools that let users from any website open a Bitcoin-express wallet. The libray container will first ask the user to select their wallet and then launch it.

In addition, the library allows requests to a wallet to authorise payments. If the user confirms the payment, coins coming from the user payment will be sent for verification.

Wallets are instantly available directly from a Wallet supplier's site or more likely while visiting a merchant's site. Other than including this Javascript library on the page, merchants have no involvement in the establishment or operation of a Wallet.

There is no sign-up, download, installation or Browser configuration required for a user to obtain a Wallet. Wallets come preconfigured for use with a default Issuer (which they may change at any time), and will instantly be able to receive Bitcoin funds from any existing Bitcoin Wallet (with the usual fees and confirmations).

Once funds have been confirmed, the user may immediately spend their coins as they wish.

BitcoinExpress is a vanilla javascript library. You need to make use of Gulp task manager in order to build your own modified library.

Check out the code from Github:

    git clone [email protected]:bitcoin-express/BitcoinExpress.git
    cd BitcoinExpress

Install all the development dependencies of the project:

    npm install

Build library (developer mode). By default the lib will be placed in the dist/ folder, use the flag --dest to modify the destination folder and flag --watch for file watcher.

    gulp build:dev

Build production library (removes logs in console and minifies the file, renaming it to BitcoinExpress.min.js).

    gulp

Set your own list of well known wallets

From gulpfile.js modify the list of probes (list of wallets that will show initially) with the wallets you desire to use for your own built library.

How to use the library?

Include the library in your website:

  <script type="text/javascript" src="BitcoinExpress.min.js"></script>

Open a wallet?

  // if fullScreen set to false, wallet will
  // open with the minimized version
  BitcoinExpress.Wallet.Open({
    fullScreen: true
  });

Request a payment?

  var payment_details_object = {
    "PaymentRequest": {
      "payment_details_version": "1",
      "PaymentDetails": {
        "payment_url": "https://merchant.com/",
        "amount": "0.00123",
        "merchant_data": "",
        "issuers": ["(bitcoin-e.org)"],
        "memo": "Human-readable description of request to the customer",
        //optional
        "email": {
          "contact":"[email protected]",
          "receipt":true,
          "refund":false
        },
        "currency": "XBT",
        "time": "2017-05-15T10:50:23.167Z",
        "expires": "2017-05-15T11:50:23.167Z",
      }
    }
  };

  BitcoinExpress.PaymentRequest(payment_details_object).then(function(paymentAck_container) {
    window.location.replace(paymentAck_container.PaymentAck.return_url);
  }).catch(function(err) {
    alert("Payment failed because "+err);
  });