npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fupay

v1.1.5

Published

FuPay SDK is a TypeScript library for integrating Fuel blockchain payments into your applications. It provides easy-to-use functions for wallet integration and QR code generation for payment requests.

Downloads

114

Readme

FuPay SDK

FuPay SDK is a TypeScript library for integrating Fuel blockchain payments into your applications. It provides easy-to-use functions for wallet integration and QR code generation for payment requests.

Table of Contents

Installation

Install the FuPay SDK using npm:

npm install fupay

Or using yarn:

yarn add fupay

Wallet Integration

The FuPay SDK provides a FuPay class for interacting with the Fuel blockchain and performing transfers.

Basic Usage

import { FuPay } from "fupay";
import { Wallet, Provider } from "fuels";

async function main() {
  // Initialize provider and wallet
  const provider = await Provider.create(
    "https://testnet.fuel.network/v1/graphql"
  );
  const wallet = Wallet.fromPrivateKey("your_private_key_here", provider);

  // Create FuPay instance
  const fuPay = new FuPay(wallet);

  // Perform a transfer
  try {
    const recipientAddress = "fuel1your_recipient_address_here";
    const amount = 100; // Amount in the smallest unit of the token
    const reference = 49834;
    const result = await fuPay.transfer(recipientAddress, amount, reference);
    console.log("Transfer result:", result);
  } catch (error) {
    console.error("Transfer failed:", error);
  }
}

main();

Frontend Usage

The SDK includes a React component for generating QR codes for payment requests.

QR Code Generator

import React from "react";
import { Generator } from "fupay";

const PaymentPage: React.FC = () => {
  const paymentData = {
    merchantAddress: "fuel1your_merchant_address_here",
    amount: 100,
    reference: 578475847,
  };

  return (
    <div>
      <h1>Scan QR Code to Pay</h1>
      <Generator {...paymentData} />
    </div>
  );
};

export default PaymentPage;

API Reference

FuPay Class

  • constructor(wallet: Wallet): Creates a new FuPay instance.
  • transfer(recipientAddress: string, amount: number): Promise<TransferResult>: Performs a transfer.

Generator Component

React component for generating QR codes.

Props:

  • merchantAddress: string: The merchant's Fuel address.
  • amount: number: The payment amount.
  • reference: number: A reference for the payment (e.g., invoice number).