Swipechain Documentation

Pay

This is the reference implementation for Swipechain Pay, a simple open-source library that provides merchants with the ability to readily accept Swipechain as a means of payment in online stores.

Installation

yarn add @swipechain/pay

Usage With Browsers

WARNING

When using this module from a website that requires secure connections via HTTPS (SSL), you will need to specify peers that use HTTPS as browsers will not allow connections from HTTPS to HTTP (Peers). The default for Swipechain Core is to run the public API on HTTP connections without SSL.

Below you can find two of our secure HTTPS (SSL) nodes. If you wish to use them call the below snippets before gateway.start().

Mainnet

gateway.peers([
  {
    ip: "explorer.swipechain.org",
    port: 8443,
    protocol: "https"
  }
]);

Devnet

gateway.peers([
  {
    ip: "dexplorer.swipechain.org",
    port: 8443,
    protocol: "https"
  }
]);

Example

const SwipechainPay = require("@swipechain/pay");
const gateway = new SwipechainPay();

gateway
  .recipient("DNjuJEDQkhrJ7cA9FZ2iVXt5anYiM8Jtc9")
  .amount(1)
  .vendorField("Hello World")
  .currency("USD")
  .coin("SXP")
  .network("devnet");

// The "started" event is emitted when Swipechain Pay loaded all seeds, peers
// and exchange rates to make sure we are requesting the correct amount.
gateway.on("started", data => {
  // Send the session data to your backend, render it to the UI, etc.
});

// The "completed" event is emitted when Swipechain Pay received the exact amount
// with the correct vendor field within the specified time frame.
gateway.on("completed", data => {
  // Send a confirmation email, redirect the user, etc.
});

// The "aborted" event is emitted when Swipechain Pay is unable to find any seeds,
// peers or exchange rates for the active network within a reasonable time frame.
gateway.on("aborted", data => {
  // Restart the session, refresh the page or flush the shopping cart, etc.
});

// The "error" event is emitted when Swipechain Pay encounters any errors like an
// invalid or malformed response to an HTTP request.
gateway.on("error", data => {
  // React to the error, note that errors are not always critical, etc.
});

// The "start" method will initialize the transaction listener.
await gateway.start();

API

Set the Recipient of the Transfer.

.recipient('ARMy9u1XvrZ124JzQq3oeJpjmBEnYkyU7D')

Set the Total Amount of the Transfer.

.amount(1)

Set the Vendor Field of the Transfer.

.vendorField('Hello World')

Set the Fiat Currency of the Transfer.

.currency('USD')

Set the Cryptocurrency of the Transfer.

.coin('SXP')

Set the Network of the Transfer.

.network('devnet')

Set the Seeds of the Network.

.seeds('swipechain', [{
    ip: '127.0.0.1',
    port: '4003'
}, {
    ip: '127.0.0.1',
    port: '4003'
}, {
    ip: '127.0.0.1',
    port: '4003'
}])

Set the Peers of the Network.

.peers([{
    ip: '127.0.0.1',
    port: '4003'
}, {
    ip: '127.0.0.1',
    port: '4003'
}, {
    ip: '127.0.0.1',
    port: '4003'
}])

Stop the Listener and Reset the Configuration.

.reset()

← Contributor's Introduction →