PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

0.0.4

npm

@0xpay/sdk

SDK for 0xPay API

Published19 Dec 2022
Direct dependencies7
Transitive dependenciesNot calculated

README

Current package documentation

@0xpay/sdk

Node.js 0xPay integration package

npm

Overview

SDK for 0xPay Merchant API which allows merchants to accept and manage payments on various blockchain networks and fiat assets via integration options.

Getting started

Prerequisites

To start using 0xPay SDK you need to register your personal account and then create merchant at 0xPay to obtain your merchant id and private key and provide it to SDK.

Installation

// NPM
npm install @0xpay/sdk
// Yarn
yarn add @0xpay/sdk

Create instance

import { XPay } from '@0xpay/sdk'

const MERCHANT_ID = 'your-merchant-id'
const MERCHANT_PRIVATE_KEY = 'your-merchant-private-key'

// Create XPay instance
const xpay = new XPay(MERCHANT_ID, MERCHANT_PRIVATE_KEY)

Get available crypto assets

import { XPay } from '@0xpay/sdk'
import express from 'express'

// Create XPay instance
const xpay = new XPay(...)

express().post('/ipn', express.raw(), (req, res) => {
  const validationError = xpay.validateWebhookRequest({ ...req, ...req.headers })
  if (validationError) throw new Error(validationError.description)

  // processing your ipn...

  res.send('OK')
})

Extended Docs

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 7

Native requirements
7 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
node-fetch
Environment
{
  "local_name": "node-fetch",
  "alias": false,
  "peer_metadata": null
}
^2.6.7runtime
tslib
Environment
{
  "local_name": "tslib",
  "alias": false,
  "peer_metadata": null
}
^2.4.1development
rollup
Environment
{
  "local_name": "rollup",
  "alias": false,
  "peer_metadata": null
}
^3.3.0development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^4.9.3development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^18.11.9development
@types/node-fetch
Environment
{
  "local_name": "@types/node-fetch",
  "alias": false,
  "peer_metadata": null
}
^2.6.2development
@rollup/plugin-typescript
Environment
{
  "local_name": "@rollup/plugin-typescript",
  "alias": false,
  "peer_metadata": null
}
^9.0.2development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "850bf5322f87d9a9d687cab8893440931f4d106f",
  "tarball": "https://registry.npmjs.org/@0xpay/sdk/-/sdk-0.0.4.tgz",
  "fileCount": 87,
  "integrity": "sha512-gqCnx8CkCOJCBUI17QmH8cMFFEyz50MMictHr9lEruO8MQUvV2lyqfK2+QChzqAqwrBGAQRFu2BPhBzX02cwOw==",
  "signatures": [
    {
      "sig": "MEUCIHsDVMbJZDXNvEisoChrIhAstYiQCF8PoSd6BQtnehvbAiEAqiauQxNX5ybji4dLXKwzEQEAYnolUujqO+LPsxTT3xc=",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 60711,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjoG7SACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmri5RAAiwSElZSyoEx4EAWUckazvwHQ/OW8rwhnGthC/r35UqJHcoqF\r\n1l0m826dar/etoEyFf2WkiH0Td+C+eIVdPQX4eFsmnQteiOOmFXh1AlkY1je\r\nXNiWeHC2rp8Sg99wA3lUikRmPc7zMrTOz3vBRkKFtCl+CsFYApOceAgiT6/K\r\ncxnq8ya/+jmAfnQKdHyiiTosqCI6RhqTgKfad4uQyS+upU7r1BzqSB0RrUmI\r\nGEHQP1DP8nl8CXE7T//rppEf7kz8qOlH85dOan6bvYUh7efqyGXBoYramtxQ\r\njqOjNKFDbE04IEJjfqJ2HvWLFCsANXHX7i/JQxc9zZ8AxXVSm3v8VdcLLb1Y\r\ng0akZombzMDiGq6btrdnSjafTuZ2QbQGuEQihGVz5DpyCl0tJ/V6t49M3b/e\r\nu0vCkrqSb0/3Qz4g42HQ/H/DGwKiJOtXJjiA0dh56ifMSIFY2acZdIq1t+Z1\r\n/2+p9yY0yHZiLjgp9FM7HPgtlyO2KbhQ5b33YDyzE+e2gE7OQwTngDwHQ7HB\r\nrdq4OoG2X+cXGrw0r/hE8T5FWJb5MstRs/TP+aLdrku8xG9LTgL+mO+IqQ7F\r\n+dxd1IL/0Rh8MUEYPCpZ9IXhtr4btZHYBiLZZ6RcOND8MJEf8LquDOZa78PY\r\ncHD8p1W4MiKKNLntiwOubjlk4LUrTFBtiC8=\r\n=i4Pe\r\n-----END PGP SIGNATURE-----\r\n"
}

Repository

PENDING
poloplayingsolo/0xpay-js-sdk

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 09:28 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:f101fd8f0632e91243bf2b82f1bb174603dcfbfd21a78efe59cad37d19ceec2c

Other collected versions

0.0.1314 Jan0.0.1219 Jun0.0.1119 Jun0.0.1022 Feb0.0.826 Dec0.0.726 DecView all collected versions →