@nearpay/nearpay-sdk NPM

NearPay Widget SDK

@nearpay/nearpay-sdk allows you to easily integrate the NearPay widget into your web app and communicate with it.

Using this SDK is not necessary, although it will simplify your experience and therefore is recommended.

It's written with TypeScript, with all the typings defined out of the box.

Installation

You can find the package here - https://www.npmjs.com/package/@nearpay/nearpay-sdk.

Install via Yarn:

yarn add @nearpay/nearpay-sdk

Install via npm:

npm install @nearpay/nearpay-sdk

Quick Start

import {
  NearPay,
  SignedWidgetParams,
  EventType,
  ResizePayload,
} from '@nearpay/nearpay-sdk';

// more info about params available at SignedWidgetParams definition
const params: SignedWidgetParams = {
  fromCurrency: '',
  fromAmount: '',
  toAmount: '',
  toCurrency: '',
  toWallet: '',
  signature: '',
  apiKey: 'your-public-api-key',
  contractCall: {
    method: '',
    args: {},
  },
};

const body = document.querySelector('body');

const widget = new NearPay({
  mountElement: body,
  environment: 'stage', // or production
  params,
});

// Subscribing to events
widget.addListener(EventType.Onload, (data: OnLoadedEvent) => {
  // react to changes!
});
// You can also subscribe to all events using wildcard
widget.addListener(EventType.Any, (data: WidgetEvent) => {
  // react to changes!
});

// render iframe
widget.init();

NearPay Events

NearPay widget notifies parent window (your website), via window.postMessage interface. In listener you get event object with browser type of MessageEvent. It has property data, which contains our event object with type WidgetMessageEventData and properties source and data, where data is object with type WidgetEvent.

Type of NearPay event :

interface WidgetMessageEventData {
  source: 'nearpay_widget';
  data: WidgetEvent;
}

Example of NearPay event:

{
    source: 'nearpay_widget',
    data: {
        type: 'onload',
        payload: {
            width: 480,
            height: 612
        }
    }
}

Available Events

All the typings for events and their payload are defined and exported from @nearpay/nearpay-sdk

// EventType is a union type that consist of every event type available
import {
  EventType,
  WidgetEvent,
  WidgetMessageEventData,
  OnLoadedEvent,
  OnErrorEvent,
  OnResizeEvent,
  OnExitEvent,
  OnStartedEvent,
  OnOperationCreated,
  OnPaymentSent,
  OnOperationPending,
  OnOperationSuccess,
  OnOperationFail,
  OnUnsupported,
  OnForceContinue,
  OnMerchantOrderIdExists,
  OnPaymentPending
} from '@nearpay/nearpay-sdk';

off-ramp events: | Event | Description | |----------|----------| | onoperationcreated | The user had been authenticated and order had been created | | onpaymentpending | The user entered the card and clicked "Confirm & Proceed" and received the deposit address | | onmerchantorderidexists | When an error is triggered that the merchantOrderId has already been used |

on-ramp events: | Event | Description | |---------------------------|-----------------------------------------------------------------------------| | onoperationcreated | The user had been authenticated and order had been created | | onpaymentsent | Sending payment data - the user clicked on Pay, does not contain data | | onoperationsuccess | The order completed, payment has been received | | onoperationfail | The order declined, due to service failure, fraud control, or other | | onoperationpending | The payment is pending to be confirmed | | onunsupported | Detected user country is unsupported | | onforcecontinue | The user clicks "Force continue" button and default country (US) is applied | | onmerchantorderidexists | When an error is triggered that the merchantOrderId has already been used |