@requestnetwork/create-invoice-form

v0.11.1

Published

5 hours ago

[![npm version](https://badge.fury.io/js/%40requestnetwork%2Fcreate-invoice-form.svg)](https://badge.fury.io/js/%40requestnetwork%2Fcreate-invoice-form)

Downloads

647

0High
0Medium
0Low

rodrigopavezi-request

mantisclone-requestnetwork

Request Network Create Invoice Form Web Component

A web component for integrating the Request Network's Create Invoice Form into a web application.

Introduction

The Create Invoice Form component allows users to create a request using the Request Network. It is built using Svelte but compiled to a Web Component, making it usable in any web environment, regardless of the framework.

Installation

To install the component, use npm:

npm install @requestnetwork/create-invoice-form

Usage

Usage in React

create-invoice.tsx

You can directly pass props into the create-invoice-form web component without needing to create references or use workarounds.

import Head from "next/head";
import { config } from "@/utils/config";
import { useAppContext } from "@/utils/context";
import { currencies } from "@/utils/currencies";
import { rainbowKitConfig as wagmiConfig } from "@/utils/wagmiConfig";
import CreateInvoiceForm from "@requestnetwork/create-invoice-form/react";

export default function CreateInvoice() {
  const { requestNetwork } = useAppContext();

  return (
    <>
      <Head>
        <title>Request Invoicing - Create an Invoice</title>
      </Head>
      <div className="container m-auto  w-[100%]">
        <CreateInvoiceForm
          config={config}
          currencies={currencies}
          wagmiConfig={wagmiConfig}
          requestNetwork={requestNetwork}
        />
      </div>
    </>
  );
}

initializeRN.ts

Initialize the RequestNetwork object using an Ethers Signer or Viem WalletClient.

import { RequestNetwork } from "@requestnetwork/request-client.js";
import { Web3SignatureProvider } from "@requestnetwork/web3-signature";

export const initializeRequestNetwork = (setter: any, walletClient: any) => {
  try {
    const web3SignatureProvider = new Web3SignatureProvider(walletClient);

    const requestNetwork = new RequestNetwork({
      nodeConnectionConfig: {
        baseURL: "https://gnosis.gateway.request.network/",
      },
      signatureProvider: web3SignatureProvider,
    });

    setter(requestNetwork);
  } catch (error) {
    console.error("Failed to initialize the Request Network:", error);
    setter(null);
  }
};

wagmiConfig.ts

The wagmiConfig file configures wallet connections for the InvoiceDashboard component, using RainbowKit and supporting various wallets and blockchains.

For more details see Wagmi Docs

config.ts

Use the config object to pass additional configuration options to the create invoice form component.

Please replace the builderId with your own, arbitrarily chosen ID. This is used to track how many invoices are created by your application.

import { IConfig } from "@requestnetwork/shared";

export const config: IConfig = {
  builderId: "request-network", // Replace with your builder ID, arbitrarily chosen, used for metrics
  dashboardLink: "/",
  logo: "/assets/logo-sm.svg",
  colors: {
    main: "#0BB489",
    secondary: "#58E1A5",
  },
};

Supporting files

context.tsx - Use a context provider to reinitialize the Request Network instance when the wallet changes.
types.d.ts - Specify types to avoid TypeScript errors.

Features

| Feature | Status | | ------------------------------------ | ------ | | ERC20 Request | ✅ | | rnf_invoice format 0.3.0 | ✅ | | Configure Logo and Colors | ✅ | | Minimal Chains and Currencies | ✅ | | Compatible with all Wagmi connectors | ✅ | | Native Request | ❌ | | Conversion Request | ❌ | | Swap-to-Pay Request | ❌ | | Swap-to-Conversion Request | ❌ | | Escrow Request | ❌ | | Improved UI and UX | ❌ | | Auto-increment Invoice Number | ❌ | | Client Address List | ❌ | | Payment Recipient Address List | ❌ | | More Chains and Currencies | ❌ | | More Configuration Options | ❌ | | Attachments | ❌ |

Chains and Currencies

| Chain | Currencies | | -------- | ---------------------- | | Ethereum | USDC, USDT, DAI | | Polygon | USDC, USDT, DAI, USDCe | | Sepolia | USDC, FAU |

Additional Information

For more information, see the Request Network documentation.