@craynetwork/react-pay NPM

@craynetwork/react-pay React Library Documentation

The CrayPayButton is a powerful and easy-to-use library for integrating cryptocurrency payments into your React application. It provides a seamless way to initiate, process, and handle cryptocurrency payments using the cray.network . This documentation will guide you through the installation, usage, and customization of the CrayPayButton.

Installation

npm install @craynetwork/react-pay

Then, import the CrayPayButton into your React component:

import CrayPayButton from "@craynetwork/react-pay";
/** For Nextjs
 const CrayPayButton = dynamic(() => import("@craynetwork/react-pay"), { ssr: false });
*/

Usage

Basic Usage

Here’s a simple example of how to use the CrayPayButton to initiate a payment:

import React from "react";
import CrayPayButton from "@craynetwork/react-pay";
/** For Nextjs
 const CrayPayButton = dynamic(() => import("@craynetwork/react-pay"), { ssr: false });
*/
const PaymentComponent = () => {
  return (
    <div>
      <CrayPayButton
        testnet={true}
        apiKey={API_KEY}
        onPaymentStarted={(e) => console.log("paymentStarted", e)}
        onPaymentCompleted={(e) => console.log("paymentCompeted", e)}
        onPaymentFailed={(e) => console.log("paymentFailed", e)}
        payload={{
          destinationToken: "0xTokenAddress",
          receiverAddress: "0xReceiverAddress",
          destinationChain: 1,
          amount: "100",
        }}
      />
    </div>
  );
};

export default PaymentComponent;

API Reference

`CrayPayButton`

It accepts These arguments:

testnet (boolean, optional): Whether to use the testnet. Default is false.
apiKey (string): Your API key for authentication.
payload
- destinationToken (string): Token address of the token to be used for payment.
- receiverAddress (string): The wallet address of the receiver.
- destinationChain (number): The chain ID of the destination blockchain.
- amount (string): The amount to be paid in USD.
- action (object, optional): An object containing payload and gasLimit for custom actions.

Types

`SubOrder`

An interface representing the SubOrder Schema:

enum SubOrder {
  type: "INPUT" | "OUTPUT";
  sourceChain: number;
  hash: string;
  status: "PENDING" | "FULFILLED" | "FAILED";
  gasUsed: number;
}

`OrderStatus`

An enum representing the possible payment statuses:

enum OrderStatus {
  INITIALIZED = "INITIALIZED",
  SIGNED = "SIGNED",
  DECLINED = "DECLINED",
  ASSIGNED = "ASSIGNED",
  CREATED = "CREATED",
  CREATED_FAILED = "CREATED_FAILED",
  FULFILLED = "FULFILLED",
  FULFILLED_FAILED = "FULFILLED_FAILED",
  SETTLED = "SETTLED",
  SETTLE_FAILED = "SETTLE_FAILED",
  FAILED = "FAILED",
}

`Order`

An interface representing the response object returned on onPaymentCompleted/onPaymentStarted callback:

interface IPaymentRes {
  _id: string;
  id: string; // alias of _id
  receiverAddress: string;
  senderAddress: string;
  destinationChain: number;
  destinationToken: string;
  amount: string;
  minAmountOut: string;
  orderHash: string;
  status: OrderStatus;
  readableStatus: string;
  destinationPayload: string;
  destinationGasLimit: number;
  apiId: string;
  solverApiId: string;
  assignedTo: string;
  assignedAt: string; // ISO timestamp
  signedAt: string; // ISO timestamp
  signedOrder: string;
  createdAt: string; // ISO timestamp
  updatedAt: string; // ISO timestamp
  orderData: string; // JSON string
  isSponsered: boolean;
  subOrders: SubOrder[];
  // Additional fields may be present depending on the payment details
}

Examples

Example 1: Basic Payment

const PaymentComponent = () => {
  return (
    <div>
      <CrayPayButton
        testnet={true}
        apiKey={API_KEY}
        onPaymentStarted={(e) => console.log("paymentStarted", e)}
        onPaymentCompleted={(e) => console.log("paymentCompeted", e)}
        onPaymentFailed={(e) => console.log("paymentFailed", e)}
        payload={{
          destinationToken: "0xTokenAddress",
          receiverAddress: "0xReceiverAddress",
          destinationChain: 1,
          amount: "100",
        }}
      >
        <button>Your custom Pay button/>
      </CrayPayButton>
    </div>
  );
};

Example 2: Contract

import abi from "./your_nft_abi.json";

const PaymentComponent = () => {
  return (
    <div>
      <CrayPayButton
        testnet={true}
        apiKey={API_KEY}
        onPaymentStarted={(e) => console.log("paymentStarted", e)}
        onPaymentCompleted={(e) => console.log("paymentCompeted", e)}
        onPaymentFailed={(e) => console.log("paymentFailed", e)}
        payload={{
          destinationToken: "0xTokenAddress",
          receiverAddress: "0xReceiverAddress",
          destinationChain: 1,
          amount: "100",
          action: {
            payload: {
              abi: abi,
              functionName: "buy",
              args: ["$$senderAddress", "120000"],
              /** you can access senderAddress by `$$senderAddress` variable */
            },
            gasLimit: 200000,
          },
        }}
      >
        <button>Your custom Pay button/>
      </CrayPayButton>
    </div>
  );
};