payment-kit 1.14.3 → 1.14.5

package/README.md

@@ -11,15 +11,19 @@ The decentralized stripe for blocklet platform.
 3. run `cd blocklets/core && blocklet dev`
 
 ##### when error
+
 1. pre-start error component xxx is not running or unreachable
-  - create .env.local file in this root
-    - add BLOCKLET_DEV_APP_DID="did:abt:your payment kit server did"
-    - add BLOCKLET_DEV_MOUNT_POINT="/example"
-  - copy .env.local to be under the /core
-    - edit BLOCKLET_DEV_MOUNT_POINT="/"
+
+- create .env.local file in this root
+  - add BLOCKLET_DEV_APP_DID="did:abt:your payment kit server did"
+  - add BLOCKLET_DEV_MOUNT_POINT="/example"
+- copy .env.local to be under the /core
+  - edit BLOCKLET_DEV_MOUNT_POINT="/"
+
 2. Insufficient fund to pay for tx cost from xxx, expected 1.0020909, got 0
    - copy BLOCKLET_DEV_APP_DID
    - transfer 2 TBA in your DID Wallet to your copied address
+
 ### Debug Stripe
 
 1. Install and login with instructions from: https://stripe.com/docs/stripe-cli
@@ -37,5 +41,6 @@ None public environment variables used in the code, can change the behavior of t
 - PAYMENT_CHANGE_LOCKED_PRICE: allow change locked price, must be set to "1" to work
 - PAYMENT_RELOAD_SUBSCRIPTION_JOBS: reload subscription jobs on start, must be set to "1" to work
 - PAYMENT_BILLING_THRESHOLD: global default billing threshold, must be a number
+- PAYMENT_MIN_STAKE_AMOUNT: global min stake amount limit, must be a number
 - PAYMENT_DAYS_UNTIL_DUE: global default days until due, must be a number
 - PAYMENT_DAYS_UNTIL_CANCEL: global default days until cancel, must be a number

package/api/src/libs/session.ts

@@ -299,6 +299,22 @@ export function getBillingThreshold(config: Record<string, any> = {}) {
   return 0;
 }
 
+export function getMinStakeAmount(config: Record<string, any> = {}) {
+  if (config?.min_stake_amount) {
+    const threshold = +(config.min_stake_amount as string);
+    if (threshold > 0) {
+      return threshold;
+    }
+  }
+
+  const threshold = +(process.env.PAYMENT_MIN_STAKE_AMOUNT as string);
+  if (threshold > 0) {
+    return threshold;
+  }
+
+  return 0;
+}
+
 export function canPayWithDelegation(beneficiaries: PaymentBeneficiary[]) {
   return beneficiaries.length === 0 || beneficiaries.every((x) => x.address === wallet.address);
 }

package/api/src/routes/checkout-sessions.ts

@@ -30,6 +30,7 @@ import {
   getCheckoutAmount,
   getCheckoutMode,
   getFastCheckoutAmount,
+  getMinStakeAmount,
   getStatementDescriptor,
   getSupportedPaymentCurrencies,
   getSupportedPaymentMethods,
@@ -146,6 +147,7 @@ export const formatCheckoutSession = async (payload: any, throwOnEmptyItems = tr
         description: '',
         trial_period_days: 0,
         billing_threshold_amount: 0,
+        min_stake_amount: 0,
         trial_end: 0,
       },
       payment_intent_data: {},
@@ -373,6 +375,7 @@ export async function startCheckoutSessionFromPaymentLink(id: string, req: Reque
     raw.payment_link_id = link.id;
     raw.subscription_data = merge(link.subscription_data, getDataObjectFromQuery(req.query, 'subscription_data'), {
       billing_threshold_amount: getBillingThreshold(link.subscription_data),
+      min_stake_amount: getMinStakeAmount(link.subscription_data),
     });
 
     if (link.after_completion?.hosted_confirmation?.custom_message) {
@@ -559,6 +562,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
     const trialInDays = Number(checkoutSession.subscription_data?.trial_period_days || 0);
     const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
     const billingThreshold = Number(checkoutSession.subscription_data?.billing_threshold_amount || 0);
+    const minStakeAmount = Number(checkoutSession.subscription_data?.min_stake_amount || 0);
     const amount = getCheckoutAmount(lineItems, paymentCurrency.id, trialInDays > 0 || trialEnds > now);
     await checkoutSession.update({
       amount_subtotal: amount.subtotal,
@@ -809,10 +813,11 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
               missing_payment_method: 'create_invoice',
             },
           },
-          // @ts-ignore
-          billing_thresholds: billingThreshold
-            ? { amount_gte: billingThreshold, reset_billing_cycle_anchor: false } // prettier-ignore
-            : null,
+          billing_thresholds: {
+            amount_gte: billingThreshold,
+            stake_gte: minStakeAmount,
+            reset_billing_cycle_anchor: false,
+          },
           pending_invoice_item_interval: setup.recurring,
           pending_setup_intent: setupIntent?.id,
           default_payment_method_id: paymentMethod.id,

package/api/src/routes/connect/setup.ts

@@ -43,6 +43,7 @@ export default {
     const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
     const trialing = trialInDays > 0 || trialEnds > now;
     const billingThreshold = Number(checkoutSession.subscription_data?.billing_threshold_amount || 0);
+    const minStakeAmount = Number(checkoutSession.subscription_data?.min_stake_amount || 0);
     const fastCheckoutAmount = getFastCheckoutAmount(items, checkoutSession.mode, paymentCurrency.id, trialing);
 
     if (paymentMethod.type === 'arcblock') {
@@ -65,7 +66,7 @@ export default {
             paymentCurrency,
             paymentMethod,
             trialing,
-            billingThreshold,
+            billingThreshold: Math.max(minStakeAmount, billingThreshold),
             items,
           }),
         ];

package/api/src/routes/connect/shared.ts

@@ -732,8 +732,10 @@ export async function getStakeTxClaim({
   paymentMethod: PaymentMethod;
 }) {
   // create staking amount
-  const billingThreshold = fromTokenToUnit(subscription.billing_thresholds?.amount_gte || 0, paymentCurrency.decimal);
-  const staking = getSubscriptionStakeSetup(items, paymentCurrency.id, billingThreshold.toString());
+  const billingThreshold = Number(subscription.billing_thresholds?.amount_gte || 0);
+  const minStakeAmount = Number(subscription.billing_thresholds?.stake_gte || 0);
+  const threshold = fromTokenToUnit(Math.max(billingThreshold, minStakeAmount), paymentCurrency.decimal);
+  const staking = getSubscriptionStakeSetup(items, paymentCurrency.id, threshold.toString());
   const amount = staking.licensed.add(staking.metered).toString();
 
   if (paymentMethod.type === 'arcblock') {

package/api/src/routes/connect/subscribe.ts

@@ -44,6 +44,7 @@ export default {
     const trialEnds = Number(checkoutSession.subscription_data?.trial_end || 0);
     const trialing = trialInDays > 0 || trialEnds > now;
     const billingThreshold = Number(checkoutSession.subscription_data?.billing_threshold_amount || 0);
+    const minStakeAmount = Number(checkoutSession.subscription_data?.min_stake_amount || 0);
     const fastCheckoutAmount = getFastCheckoutAmount(items, checkoutSession.mode, paymentCurrency.id, trialing);
 
     if (paymentMethod.type === 'arcblock') {
@@ -67,7 +68,7 @@ export default {
             paymentCurrency,
             paymentMethod,
             trialing,
-            billingThreshold,
+            billingThreshold: Math.max(minStakeAmount, billingThreshold),
             items,
           }),
         ];

package/api/src/routes/pricing-table.ts

@@ -11,7 +11,7 @@ import { checkPassportForPricingTable } from '../integrations/blocklet/passport'
 import { createListParamSchema } from '../libs/api';
 import logger from '../libs/logger';
 import { authenticate } from '../libs/security';
-import { getBillingThreshold, isLineItemCurrencyAligned } from '../libs/session';
+import { getBillingThreshold, getMinStakeAmount, isLineItemCurrencyAligned } from '../libs/session';
 import { getDaysUntilCancel, getDaysUntilDue } from '../libs/subscription';
 import { getDataObjectFromQuery } from '../libs/util';
 import { CheckoutSession } from '../store/models/checkout-session';
@@ -224,6 +224,7 @@ router.post('/:id/checkout/:priceId', async (req, res) => {
     ]),
     subscription_data: merge(price.subscription_data || {}, getDataObjectFromQuery(req.query, 'subscription_data'), {
       billing_threshold_amount: getBillingThreshold(price.subscription_data),
+      min_stake_amount: getMinStakeAmount(price.subscription_data),
     }),
     metadata: {
       ...doc.metadata,

package/api/src/store/models/subscription.ts

@@ -66,6 +66,7 @@ export class Subscription extends Model<InferAttributes<Subscription>, InferCrea
   declare billing_cycle_anchor: number;
   declare billing_thresholds?: {
     amount_gte: number;
+    stake_gte: number;
     reset_billing_cycle_anchor: boolean;
   };
 

package/api/src/store/models/types.ts

@@ -363,6 +363,7 @@ export type SubscriptionData = {
   description: string;
   trial_period_days: number;
   billing_threshold_amount?: number;
+  min_stake_amount?: number;
   metadata?: Record<string, any>;
 };
 

package/blocklet.yml

@@ -14,7 +14,7 @@ repository:
   type: git
   url: git+https://github.com/blocklet/payment-kit.git
 specVersion: 1.2.8
-version: 1.14.3
+version: 1.14.5
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.14.3",
+  "version": "1.14.5",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -52,7 +52,7 @@
     "@arcblock/validator": "^1.18.124",
     "@blocklet/js-sdk": "1.16.28",
     "@blocklet/logger": "1.16.28",
-    "@blocklet/payment-react": "1.14.3",
+    "@blocklet/payment-react": "1.14.5",
     "@blocklet/sdk": "1.16.28",
     "@blocklet/ui-react": "^2.10.3",
     "@blocklet/uploader": "^0.1.20",
@@ -118,7 +118,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.28",
     "@arcblock/eslint-config-ts": "^0.3.2",
-    "@blocklet/payment-types": "1.14.3",
+    "@blocklet/payment-types": "1.14.5",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -160,5 +160,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "23e4827487dc9e180191948a58074abfb47dee1d"
+  "gitHead": "e4715805a87b2e4e3622564f4bc26578f19211e4"
 }

package/src/pages/customer/subscription/embed.tsx

@@ -5,9 +5,11 @@ import {
   api,
   formatBNStr,
   formatError,
+  formatPrettyMsLocale,
   formatSubscriptionProduct,
   formatTime,
   formatToDate,
+  formatToDatetime,
   getDidConnectQueryParams,
   getInvoiceStatusColor,
   getPrefix,
@@ -25,11 +27,13 @@ import {
   ListItem,
   ListSubheader,
   Stack,
+  Tooltip,
   Typography,
 } from '@mui/material';
 import { useRequest } from 'ahooks';
 import { useMemo } from 'react';
 import { joinURL, withQuery } from 'ufo';
+import prettyMs from 'pretty-ms-i18n';
 
 const fetchInvoiceData = (params: Record<string, any> = {}): Promise<Paginated<TInvoiceExpanded>> => {
   const search = new URLSearchParams();
@@ -112,7 +116,33 @@ export default function SubscriptionEmbed() {
     },
   ];
 
-  if (subscription.status === 'active' || subscription.status === 'trialing') {
+  if (subscription.status === 'trialing') {
+    const endTimestamp = subscription.current_period_end * 1000;
+    const remainingTime = endTimestamp - Date.now();
+
+    infoList.push({
+      name: t('payment.customer.subscriptions.trialLeft'),
+      value: (
+        <Typography
+          sx={{
+            color: 'success.main',
+            fontWeight: 'bold',
+            marginRight: '10px',
+          }}>
+          <Tooltip title={formatToDatetime(endTimestamp, locale)} placement="top-end" enterTouchDelay={0}>
+            <Typography component="span" sx={{ cursor: 'pointer' }}>
+              {prettyMs(remainingTime, {
+                locale: formatPrettyMsLocale(locale),
+                compact: true,
+              })}
+            </Typography>
+          </Tooltip>
+        </Typography>
+      ),
+    });
+  }
+
+  if (subscription.status === 'active') {
     infoList.push({
       name: t('payment.customer.subscriptions.nextInvoice'),
       value: (