Create Invoice Form

A form for creating invoices in Request Network

Screenshot of @requestnetwork/create-invoice-form 0.2.0

🕹️ Try it out

▶️ Demo Video

🏗️ Integration Video

📦 View on NPM

ℹ️ View Source

The Create Invoice Form allows end-users to create an invoice 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.

Features

Feature	Status
ERC20 Request	✅
rnf_invoice format 0.3.0	✅
Configure Logo and Colors	✅
Minimal Chains and Currencies	✅

Chains and Currencies

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

Installation

To install the component, use npm:

npm install @requestnetwork/create-invoice-form

Usage

Usage in React and Next.js

Follow the instructions below to add the Create Invoice Form to a React or Next.js app. For a video explaining how to integrate, see the Request Invoicing Integration Video

Disable swcMinify in next.config.mjs

To use the Create Invoice Form in NextJS 14.x, you must set swcMinify: false in your next.config.mjs file. Without it, the Create Invoice Form won't render.

https://github.com/RequestNetwork/invoicing-template/blob/main/next.config.mjs

/** @type {import('next').NextConfig} */
const nextConfig = {
	reactStrictMode: true,
	swcMinify: false,
};

export default nextConfig;

create-invoice.tsx

Configure the Create Invoice Form web component by creating a reference to it, setting its properties, and passing the reference as a prop.

To use the Create Invoice Form in a React or Next.js application, you must dynamically import @requestnetwork/create-invoice-form and use the component in your JSX file.

import("@requestnetwork/create-invoice-form");

This example uses Web3 Onboard to connect a wallet but you can use any wallet connection method you prefer.

Supporting files

• initializeRN.ts - Initialize the RequestNetwork object using an Ethers Signer or Viem WalletClient.

https://github.com/RequestNetwork/invoicing-template/blob/main/utils/initializeRN.ts

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

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,
      httpConfig: {
        getConfirmationMaxRetry: 120,
      },
      paymentOptions: {
        getSubgraphClient: (chain: string) => {
          // Ternary because cannot dynamically access environment variables in the browser
          const paymentsSubgraphUrl =
            chain === "arbitrum-one"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_ARBITRUM_ONE
              : chain === "avalanche"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_AVALANCHE
              : chain === "base"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_BASE
              : chain === "bsc"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_BSC
              : chain === "celo"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_CELO
              : chain === "core"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_CORE
              : chain === "fantom"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_FANTOM
              : chain === "fuse"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_FUSE
              : chain === "mainnet"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_MAINNET
              : chain === "matic"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_MATIC
              : chain === "moonbeam"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_MOONBEAM
              : chain === "near"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_NEAR
              : chain === "near-testnet"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_NEAR_TESTNET
              : chain === "optimism"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_OPTIMISM
              : chain === "ronin"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_RONIN
              : chain === "sepolia"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_SEPOLIA
              : chain === "tombchain"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_TOMBCHAIN
              : chain === "xdai"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_XDAI
              : chain === "zksyncera"
              ? process.env.NEXT_PUBLIC_PAYMENTS_SUBGRAPH_URL_ZKSYNCERA
              : undefined;
          if (!paymentsSubgraphUrl) {
            throw new Error(`Cannot get subgraph client for unknown chain: ${chain}`);
          }
          return getTheGraphClient(chain, paymentsSubgraphUrl);
        },
      },
    });

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

• 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.

https://github.com/RequestNetwork/invoicing-template/blob/main/utils/config.ts

import { IConfig } from "./types";

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

• 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.

Props

Prop	Type	Description
config	IConfig	Additional configuration parameters
config.builderId	string	Unique builder ID, arbitrarily chosen, used for metrics
config.dashboardLink	string	Path to dashboard page
config.logo	string	Path to logo file
config.colors.main	string	Hex color code for primary buttons and labels
config.colors.secondary	string	Hex color code for for borders and accents
requestNetwork	RequestNetwork	The RequestNetwork instance
signer	string	The address that signs to create the invoices