Daisy SDK

Install

You may also require some extra dependencies like web3, and eventemitter3

yarn add @daisypayments/daisy-sdk eventemitter3 [email protected]

MetaMask helper

To help you handle web3 instances and the current account we recommended daisypayments/react-metamask.

Usage: Subscriptions

1. Standard private and public plans with DaisySDK

This is the default flow with standardized plans. This requires the implementation of a front-end with integration of Daisy Widget or Daisy SDK (advanced).

1.1 Create a Subscription Product and Plans

After deploying a Subscription Product to the blockchain go to the API Integration tab and grab the DAISY_ID and DAISY_SECRET_KEY.

# Example values
DAISY_ID=margarita
DAISY_SECRET_KEY=key
DAISY_CALLBACK_PUBLIC_KEY=key

1.2 Integration in the server

Create an instance of ServerSubscriptions from the @daisypayments/daisy-sdk/private sub-module. It is extremely important to keep DAISY_SECRET_KEY private.

const { ServerSubscriptions } = require("@daisypayments/daisy-sdk/private");
const fetch = require("node-fetch");

ServerSubscriptions.fetch = fetch;
const subscriptions = new ServerSubscriptions({
  manager: {
    identifier: process.env.DAISY_ID,
    secretKey: process.env.DAISY_SECRET_KEY,
  },
  withGlobals: { fetch },
});

Server instances requires an instance of fetch. We recommend node-fetch.

Create and endpoint to retrieve information from your servers back to the frontend. Here is an example using Express.js:

const express = require("express");
const h = require("express-async-handler");

const app = express();

// GET /api/plans/ -> Fetch plans from the frontend
app.get("/api/plans/", h(async (req, res) => {
  const { plans } = await subscriptions.getData();
  res.json({ plans });
}));

// POST /api/plan/:pid/subscriptions/ -> Submit a subscription to Daisy
app.post("/api/plan/:pid/subscriptions/", h(async (req, res) => {
  const user = req.session;
  const { agreement, signature } = req.body;

  const { plans } = await subscriptions.getData();
  const plan = plans.find(p => p["id"] === req.params["pid"]);
  if (!plan) {
    throw new Error("Plan not found");
  }

  const { data: subscription } = await subscriptions.submit({
    agreement,
    authSignature,
    signature,
  });

  // Save and associate DaisyID from `subscription["daisyId"]` to an user.
  const daisyId = subscription["daisyId"];
  await user.patch({ daisyId });

  res.send("ok");
}));

1.2.1 Get plans from the frontend (not recommended)

This will only expose private: false plans.

import DaisySDK from "@daisypayments/daisy-sdk";

const daisy = await DaisySDK.initSubscriptions({
  manager: { identifier: "margarita" },
  withGlobals: { web3 },
});

const { plans } = await daisy.getData();

1.3 Approving tokens

It is required to approve tokens before signing the subscription agreement.

const daisy = await DaisySDK.initSubscriptions({
  manager: { identifier: "margarita" },
  withGlobals: { web3 },
});

const approvalAmount = "9000000000000000";
const account = "0x..." // from MetaMask.

const eventemitter = daisy
  .with(plan)
  .approve(approvalAmount, { from: account });

const eventemitter
  .on("transactionHash", handleApprove_transactionHash)
  .on("confirmation", handleApprove_confirmation)
  .on("receipt", handleApprove_receipt)
  .on("error", handleApprove_error);

function handleApprove_transactionHash(transactionHash) {
  // ...
};
function handleApprove_confirmation(confirmationNumber, receipt) {
  // ...
};
function handleApprove_receipt(receipt) {
  // Here you can assume this task is complete.
  // If you want to resume this transaction, save the `receipt` object.
};
function handleApprove_error(error) {
  // ...
};

1.4 Signing subscription agreement

const daisy = await DaisySDK.initSubscriptions({
  manager: { identifier: "margarita" },
  withGlobals: { web3 },
});

const { signature, agreement } = await daisy
  .with(plan)
  .sign({ account, plan });

// Send `signature` and `agreement` back to the server
// TODO: replace `:pid` with Plan ID.
const response = await fetch("/api/plan/:pid/subscriptions/", {
  method: "post",
  credentials: "same-origin",
  body: JSON.stringify({ signature, agreement }),
});

const data = await response.json();

1.4.1 Submit subscription from the frontend (only for public plans) (not recommended)

const { data: subscription } = await daisy.submit({
  agreement,
  signature,
});

1.5 Verify Daisy subscription state

Verify subscription state with:

const sub = await subscriptions.getSubscription({
  id: daisyID,
});
console.log(sub["state"]);

const subs = await subscriptions.getSubscriptions({
  account: "0x...",
});

2. Invitations

This feature has been reworked and the documentation still in progress.

Usage: Payments invoices

1. Creating invoices with Daisy SDK

1.1 Create an Invitation

The first step is going to the Daisy Dashboard and setup an Invitation product. After setting this go to the API Integration and grab the DAISY_ID and DAISY_SECRET_KEY.

# Example values
DAISY_OTP_ID=plantae
DAISY_OTP_SECRET_KEY=key

1.2 Server integration

Create an instance of ServerPayments from the @daisypayments/daisy-sdk/private sub-module. It is extremely important to keep DAISY_OTP_SECRET_KEY private.

const DaisySDK = require("@daisypayments/daisy-sdk/private");
const fetch = require("node-fetch");

const payments = new DaisySDK.ServerPayments({
  manager: {
    identifier: process.env.DAISY_OTP_ID,
    secretKey: process.env.DAISY_OTP_SECRET_KEY,
  },
  withGlobals: { fetch },
});

Server instances requires an instance of fetch. We recommend node-fetch.

Let's say we want to sell an access pass for 20 USD or equivalent in DAI.

const express = require("express");
const h = require("express-async-handler");

const app = express();

app.get("/api/checkout/invoice/", h(async (req, res) => {
  const user = req.session;

  // Create an invoice using Daisy SDK
  const invoice = await payments.createInvoice({
    invoicedPrice: 20, // required
    invoicedEmail: user.email, // optional
    invoicedName: user.name, // optional
    invoicedDetail: "Paid Access", // optional
  });

  // Save and associate invoice to user
  await user.update({ invoiceId: invoice["id"]} );

  // Use this object in the frontend to start the transaction.
  res.json({ invoice });
});

The invoice object looks like this using TypeScript notation:

interface PaymentInvoice {
  id: string;
  identifier: string;
  state: PaymentInvoiceState;
  amountPaid: string | BigNumber;
  paidAt?: string;
  address: string;
  tokenAddress: string;
  walletAddress: string;
  invoicedPrice: string;
  invoicedEmail?: string;
  invoicedName?: string;
  invoicedDetail?: string;
  createdAt: string | Date;
  updatedAt: string | Date;
}

export enum PaymentInvoiceState {
  Pending = "PENDING",
  UnderPaid = "UNDER_PAID",
  Paid = "PAID",
  OverPaid = "OVER_PAID",
}

Since any transaction sending money to the invoice address can fulfill the requested amount, one way to know the state of the payment is to ask Daisy via polling.

app.get("/api/checkout/state/", h(async (req, res) => {
  const user = req.session;

  try {
    const invoice = await payments.getInvoice({
      identifier: user.invoiceId,
    });
    const success = ["PAID", "OVER_PAID"].includes(invoice["state"]);

    res.json({ invoice });
  } catch (error) {
    //
  }
});

To get the receipts from any Invoice:

const receipts = await payments.getReceipts({
  identifier: user.invoiceId,
});

Receipt object shape:

interface PaymentReceipt {
  id: string;
  txHash: string;
  account: string;
  amount: string | BigNumber;
  onChainCreatedAt: string | Date;
  createdAt: string | Date;
  updatedAt: string | Date;
}

isabella232 / daisy-sdk Goto Github PK

daisy-sdk's Introduction