@dawnpay/kit

Dawn Kit

Dawn Kit is a React library that makes it easy to accept payments across Internet.

How to get started

npm

npm i @dawnpay/kit

yarn

yarn add @dawnpay/kit

Getting Started

Wrap your application in DawnProvider

Wrap your application in the DawnProvider component to start using the SDK.

import { DawnProvider } from "@dawnpay/kit";

const App = () => {
  return (
    <DawnProvider>
      <YourApp />
    </DawnProvider>
  );
};

API Reference

Components and Hooks

PayButton

PayButton renders a button which when clicked opens a modal to make a payment to a specific address using their wallet.

<PayButton address="0x7851b240aCE79FA6961AE36c865802D1416611e7" />

pay

Call the pay function to prompt the user to make a payment to a specific address using their wallet.

const { success, receipt, error } = await pay(recipient);

Example

When using the pay hook, you must provide the recipient's address as a parameter. It will then return a Promise that resolves to a PayResult object, which contains details about the transaction.

const handlePayClick = async () => {
    const { success, receipt, error } = await pay(recipient);

    if (success) {
        console.log("Transaction Success: ", receipt)
    }

    if (!success) {
        console.log("Transaction Error: ", error)
    }
};

<button onClick={handlePayClick}>
    Pay using Dawn Kit
</button>