1.0.7 • Published 3 years ago

vitepay.js v1.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

How to Use? (Example)

Install the VitePay package,

npm i vitepay.js

or

yarn add vitepay.js

import React from 'react'

import { VitePay, TransactionCheck } from 'vitepay.js'
import 'vitepay.js/dist/index.css'


const onTransactionSuccess = (transaction) => {
  console.log("Pay successful", transaction);
};

const onTransactionFailure = (error) => {
  console.log("Payment Failed", error);
};

const paymentLogs = (logs) => {
  console.log("Payment Logs", logs);
};

const App = () => {
  return (<div>

    <VitePay
      amountDefault="250"
      tokenDefault="tti_5649544520544f4b454e6e40"
      defaultMemo="123abcd"
      displayToken={false}
      displayMemo={false}
      displayAmount={false}
      addressDefault="vite_10a86218cf37c795ebbdf8a7da643d92e22d860d2b747e049e"
      nodeURL="wss://buidl.vite.net/gvite/ws"
      paymentTimeout="900"
      buttonStyle={{
        "color": "#FFF",
        "backgroundColor": "#02298A",
        "fontSize": "18px",
        "textAlign": "center",
        "fontStyle": "normal",
        "borderRadius": "5px",
        "width": "200px",
        "borderWidth": "1px 1px 3px",
        "boxShadow": "0 -1px 0 rgba(255, 255, 255, 0.1) inset",
        "marginBottom": "10px",
        "height": "3em"
      }}
      onPaymentSuccess={onTransactionSuccess}
      onPaymentFailure={onTransactionFailure}
      onPaymentLogs={paymentLogs}
      httpURL="https://buidl.vite.net/gvite/http"
      checkPreviousTransactionsCount={500}
    />

    <TransactionCheck
      nodeURL="https://buidl.vite.net/gvite/http"
      recipientAddress="vite_10a86218cf37c795ebbdf8a7da643d92e22d860d2b747e049e"
      amount="250"
      tokenId="tti_5649544520544f4b454e6e40"
      memo="123abcd"
      checkPreviousTransactionsCount={500}
    ></TransactionCheck>
  </div>)
}

export default App

How it Looks? (Video)

IMAGE ALT TEXT HERE

Parameters

ParameterDescriptionDefault Value
recipientAddressThe payment will be made to this addressvite_10a86218cf37c795ebbdf8a7da643d92e22d860d2b747e049e
defaultTokenThis is token id for default token, you can find the token id listed on VITE from https://vitescan.io/. It can later be changed from the dropdown by person making the paymenttti_5649544520544f4b454e6e40
defaultAmountThis is the default amount present in VITEPAY popup1
nodeURLThis is the default websockets node url, the default one being, it is used to connect VITE Node.wss://buidl.vite.net/gvite/ws
httpURLThis is default fallback of HTTP URL which is used in case websockets failhttps://buidl.vite.net/gvite/http
paymentTimeoutThis is timer by which payment will get timed out. It is present in seconds900
buttonStyleButton style Object for "Pay with VITE" buttonExample has the default button Class
defaultMemoDefault Memo Present in Payment Popup123abcd
displayTokenShow Token Dropdown in form popup. In case of false, default values will be used.true
displayAmountShow Amount Input in form popup. In case of false, default values will be used.true
displayMemoShow Memo Input in form popup. In case of false, default values will be used.true
checkPreviousTransactionsCountThe number of transasctions it checks for your account to match the one recieving. Increase if high number of transactions on your website.500

Callback Hooks

FunctionDescription
onPaymentSuccessEvent to be called when payment has been successful
onPaymentFailureEvent to be called when payment has failed
onPaymentLogsLog Payments (In case the person closed the window and yet the transaction did happen. )

License

MIT © vaibhavgeek