payment-kit 1.16.10 → 1.16.12

package/api/src/index.ts

@@ -37,6 +37,7 @@ import rechargeHandlers from './routes/connect/recharge';
 import payHandlers from './routes/connect/pay';
 import setupHandlers from './routes/connect/setup';
 import subscribeHandlers from './routes/connect/subscribe';
+import delegationHandlers from './routes/connect/delegation';
 import { initialize } from './store/models';
 import { sequelize } from './store/sequelize';
 import { initUserHandler } from './integrations/blocklet/user';
@@ -71,7 +72,7 @@ handlers.attach(Object.assign({ app: router }, subscribeHandlers));
 handlers.attach(Object.assign({ app: router }, changePaymentHandlers));
 handlers.attach(Object.assign({ app: router }, changePlanHandlers));
 handlers.attach(Object.assign({ app: router }, rechargeHandlers));
-
+handlers.attach(Object.assign({ app: router }, delegationHandlers));
 router.use('/api', routes);
 
 const isProduction = process.env.BLOCKLET_MODE === 'production';

package/api/src/integrations/stripe/handlers/invoice.ts

@@ -263,7 +263,7 @@ export async function handleStripeInvoiceCreated(event: TEventExpanded, client:
     const usageReportStart = stripeInvoice.period_start;
     const usageReportEnd = stripeInvoice.period_end;
     const usageReportEmpty = await checkUsageReportEmpty(subscription, usageReportStart, usageReportEnd);
-    if (usageReportEmpty) {
+    if (usageReportEmpty && subscription.status !== 'trialing') {
       createEvent('Subscription', 'usage.report.empty', subscription, {
         usageReportStart,
         usageReportEnd,

package/api/src/libs/payment.ts

@@ -73,6 +73,10 @@ export async function isDelegationSufficientForPayment(args: {
       return { sufficient: false, reason: 'NO_DELEGATION' };
     }
 
+    if (!state.ops || state.ops?.length === 0) {
+      return { sufficient: false, reason: 'NO_DELEGATION' };
+    }
+
     // have transfer permissions?
     const grant = (state as DelegateState).ops.find((x: any) => x.key === OCAP_PAYMENT_TX_TYPE)?.value;
     if (!grant) {
@@ -276,12 +280,11 @@ export async function getTokenLimitsForDelegation(
       return [entry];
     }
 
-    // If we have metered items, we should not limit tx allowance(set to 0)
-    if (hasMetered) {
+    if (!state.ops || state.ops?.length === 0) {
       return [entry];
     }
 
-    const op = (state as DelegateState).ops.find((x) => x.key === OCAP_PAYMENT_TX_TYPE);
+    const op = state.ops.find((x) => x.key === OCAP_PAYMENT_TX_TYPE);
     if (op && Array.isArray(op.value.limit?.tokens) && op.value.limit.tokens.length > 0) {
       const tokenLimits = cloneDeep(op.value.limit.tokens);
       const index = op.value.limit.tokens.findIndex((x) => x.address === paymentCurrency.contract);

package/api/src/queues/subscription.ts

@@ -119,18 +119,20 @@ const doHandleSubscriptionInvoice = async ({
   const usageReportStart = usageStart || start - offset;
   const usageReportEnd = usageEnd || end - offset;
 
-  // check if usage report is empty
-  const usageReportEmpty = await checkUsageReportEmpty(subscription, usageReportStart, usageReportEnd);
-  if (usageReportEmpty) {
-    createEvent('Subscription', 'usage.report.empty', subscription, {
-      usageReportStart,
-      usageReportEnd,
-    }).catch(console.error);
-    logger.info('create usage report empty event', {
-      subscriptionId: subscription.id,
-      usageReportStart,
-      usageReportEnd,
-    });
+  if (subscription.status !== 'trialing') {
+    // check if usage report is empty
+    const usageReportEmpty = await checkUsageReportEmpty(subscription, usageReportStart, usageReportEnd);
+    if (usageReportEmpty) {
+      createEvent('Subscription', 'usage.report.empty', subscription, {
+        usageReportStart,
+        usageReportEnd,
+      }).catch(console.error);
+      logger.info('create usage report empty event', {
+        subscriptionId: subscription.id,
+        usageReportStart,
+        usageReportEnd,
+      });
+    }
   }
 
   // get usage summaries for this billing cycle

package/api/src/routes/connect/collect-batch.ts

@@ -3,8 +3,8 @@ import type { Transaction } from '@ocap/client';
 import { fromAddress } from '@ocap/wallet';
 
 import { toBase58 } from '@ocap/util';
-import { encodeTransferItx } from 'api/src/integrations/ethereum/token';
-import { waitForEvmTxConfirm, waitForEvmTxReceipt } from 'api/src/integrations/ethereum/tx';
+import { encodeTransferItx } from '../../integrations/ethereum/token';
+import { waitForEvmTxConfirm, waitForEvmTxReceipt } from '../../integrations/ethereum/tx';
 import type { CallbackArgs } from '../../libs/auth';
 import { ethWallet, wallet } from '../../libs/auth';
 import { getGasPayerExtra } from '../../libs/payment';

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

@@ -0,0 +1,70 @@
+import type { TLineItemExpanded } from '../../store/models';
+import type { CallbackArgs } from '../../libs/auth';
+import { getTxMetadata } from '../../libs/util';
+import {
+  ensureSubscriptionDelegation,
+  executeOcapTransactions,
+  getAuthPrincipalClaim,
+  getDelegationTxClaim,
+} from './shared';
+
+export default {
+  action: 'delegation',
+  authPrincipal: false,
+  claims: {
+    authPrincipal: async ({ extraParams }: CallbackArgs) => {
+      const { paymentMethod } = await ensureSubscriptionDelegation(extraParams.subscriptionId);
+      return getAuthPrincipalClaim(paymentMethod, 'continue');
+    },
+  },
+  onConnect: async (args: CallbackArgs) => {
+    const { userDid, userPk, extraParams } = args;
+    const { paymentMethod, paymentCurrency, subscription, payerAddress } = await ensureSubscriptionDelegation(
+      extraParams.subscriptionId
+    );
+    const billingThreshold = Number(subscription.billing_thresholds?.amount_gte || 0);
+    if (userDid !== payerAddress) {
+      throw new Error(
+        `You are not the payer for this subscription. Expected payer: ${payerAddress}, but found: ${userDid}.`
+      );
+    }
+    const claims: { [type: string]: [string, object] } = {
+      delegation: [
+        'signature',
+        await getDelegationTxClaim({
+          mode: 'delegation',
+          userDid,
+          userPk,
+          nonce: subscription.id,
+          data: getTxMetadata({ subscriptionId: subscription.id }),
+          paymentCurrency,
+          paymentMethod,
+          trialing: true,
+          billingThreshold,
+          items: subscription!.items as TLineItemExpanded[],
+        }),
+      ],
+    };
+    return claims;
+  },
+  onAuth: async (args: CallbackArgs) => {
+    const { request, userDid, userPk, claims, extraParams } = args;
+    const { subscriptionId } = extraParams;
+    const { paymentMethod, paymentCurrency } = await ensureSubscriptionDelegation(subscriptionId);
+
+    if (paymentMethod.type === 'arcblock') {
+      const { stakingAmount, ...paymentDetails } = await executeOcapTransactions(
+        userDid,
+        userPk,
+        claims,
+        paymentMethod,
+        request,
+        subscriptionId,
+        paymentCurrency?.contract
+      );
+      return { hash: paymentDetails.tx_hash };
+    }
+
+    throw new Error(`Payment method ${paymentMethod.type} not supported`);
+  },
+};

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

@@ -1,8 +1,8 @@
 import type { Transaction } from '@ocap/client';
 import { fromAddress } from '@ocap/wallet';
 import { fromTokenToUnit, toBase58 } from '@ocap/util';
-import { encodeTransferItx } from 'api/src/integrations/ethereum/token';
-import { executeEvmTransaction, waitForEvmTxConfirm } from 'api/src/integrations/ethereum/tx';
+import { encodeTransferItx } from '../../integrations/ethereum/token';
+import { executeEvmTransaction, waitForEvmTxConfirm } from '../../integrations/ethereum/tx';
 import type { CallbackArgs } from '../../libs/auth';
 import { getGasPayerExtra } from '../../libs/payment';
 import { getTxMetadata } from '../../libs/util';

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

@@ -259,6 +259,26 @@ export async function ensureSetupIntent(checkoutSessionId: string, userDid?: str
   };
 }
 
+export async function ensureSubscriptionDelegation(subscriptionId: string) {
+  const subscription = (await Subscription.findOne({
+    where: { id: subscriptionId },
+    include: [{ model: PaymentCurrency, as: 'paymentCurrency' }, { model: PaymentMethod, as: 'paymentMethod' }],
+  })) as (Subscription & { paymentCurrency: PaymentCurrency; paymentMethod: PaymentMethod; items?: TLineItemExpanded[] }) | null;
+  if (!subscription) {
+    throw new Error('Subscription not found');
+  }
+  if (!['arcblock', 'ethereum'].includes(subscription.paymentMethod?.type)) {
+    throw new Error(`Payment method ${subscription.paymentMethod?.type} not supported for delegation`);
+  }
+  subscription.items = await expandSubscriptionItems(subscription.id);
+  return {
+    paymentCurrency: subscription.paymentCurrency!,
+    paymentMethod: subscription.paymentMethod!,
+    subscription,
+    payerAddress: getSubscriptionPaymentAddress(subscription, subscription.paymentMethod?.type),
+  };
+}
+
 type Args = {
   checkoutSession: CheckoutSession;
   customer: Customer;
@@ -689,7 +709,7 @@ export async function getDelegationTxClaim({
   const amount = getFastCheckoutAmount(items, mode, paymentCurrency.id);
   const address = toDelegateAddress(userDid, wallet.address);
   const tokenLimits = await getTokenLimitsForDelegation(items, paymentMethod, paymentCurrency, address, amount);
-  const tokenRequirements = await getTokenRequirements({
+  let tokenRequirements = await getTokenRequirements({
     items,
     mode,
     trialing,
@@ -697,7 +717,9 @@ export async function getDelegationTxClaim({
     paymentMethod,
     paymentCurrency,
   });
-
+  if (mode === 'delegation') {
+    tokenRequirements = [];
+  }
   if (paymentMethod.type === 'arcblock') {
     return {
       type: 'DelegateTx',
@@ -884,7 +906,7 @@ export async function getTokenRequirements({
   }
 
   // Add stake requirement to token requirement
-  if (paymentMethod.type === 'arcblock' || mode === 'setup') {
+  if ((paymentMethod.type === 'arcblock' && mode !== 'delegation') || mode === 'setup') {
     const staking = getSubscriptionStakeSetup(
       items,
       paymentCurrency.id,

package/api/src/routes/donations.ts

@@ -48,7 +48,9 @@ const donationSchema = Joi.object<DonationSettings>({
 router.post('/', async (req, res) => {
   try {
     const payload = await donationSchema.validateAsync(req.body, { stripUnknown: true, convert: true });
-    const link = await PaymentLink.findOne({ where: { 'donation_settings.target': payload.target } });
+    const link = await PaymentLink.findOne({
+      where: { 'donation_settings.target': payload.target, livemode: !!req.livemode },
+    });
     if (link) {
       await link.update({
         name: payload.title,
@@ -67,12 +69,13 @@ router.post('/', async (req, res) => {
     }
 
     logger.info('No existing payment link found, creating new one');
-    let price = await Price.findByPkOrLookupKey(payload.target);
+    const lookupKey = `${payload.target}-${req.livemode ? 'live' : 'test'}`;
+    let price = await Price.findByPkOrLookupKey(lookupKey);
     if (!price) {
       logger.info('No existing price found, creating new product and price');
       const result = await createProductAndPrices({
         type: 'service',
-        livemode: req.livemode,
+        livemode: !!req.livemode,
         name: payload.title,
         description: payload.description,
         currency_id: req.currency.id,
@@ -82,7 +85,7 @@ router.post('/', async (req, res) => {
             type: 'one_time',
             unit_amount: '0',
             billing_schema: 'per_unit',
-            lookup_key: payload.target,
+            lookup_key: lookupKey,
             custom_unit_amount: {
               presets: payload.amount.presets || [],
               preset: payload.amount.preset || null,

package/api/src/routes/subscriptions.ts

@@ -1918,4 +1918,45 @@ router.get('/:id/overdue/invoices', authPortal, async (req, res) => {
     return res.status(400).json({ error: err.message });
   }
 });
+
+router.get('/:id/delegation', authPortal, async (req, res) => {
+  if (!req.user) {
+    return res.status(403).json({ error: 'Unauthorized' });
+  }
+  try {
+    const subscription = (await Subscription.findByPk(req.params.id, {
+      include: [
+        { model: PaymentCurrency, as: 'paymentCurrency' },
+        { model: PaymentMethod, as: 'paymentMethod' },
+      ],
+    })) as (Subscription & { paymentMethod: PaymentMethod; paymentCurrency: PaymentCurrency }) | null;
+    if (!subscription) {
+      return res.status(404).json({ error: 'Subscription not found' });
+    }
+    const payer = getSubscriptionPaymentAddress(subscription, subscription.paymentMethod?.type);
+    const delegator = await isDelegationSufficientForPayment({
+      paymentMethod: subscription.paymentMethod,
+      paymentCurrency: subscription.paymentCurrency,
+      userDid: payer as string,
+      amount: '0',
+    });
+    if (
+      !delegator.sufficient &&
+      [
+        'NO_DELEGATION',
+        'NO_TOKEN_PERMISSION',
+        'NO_TRANSFER_PERMISSION',
+        'NO_TRANSFER_TO',
+        'NO_ENOUGH_ALLOWANCE',
+        'NO_ENOUGH_TOKEN',
+      ].includes(delegator?.reason || '')
+    ) {
+      return res.json(delegator);
+    }
+    return res.json(null);
+  } catch (err) {
+    console.error(err);
+    return res.json(null);
+  }
+});
 export default router;

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.16.10
+version: 1.16.12
 logo: logo.png
 files:
   - dist

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.16.10",
+  "version": "1.16.12",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -53,7 +53,7 @@
     "@arcblock/validator": "^1.18.150",
     "@blocklet/js-sdk": "^1.16.33",
     "@blocklet/logger": "^1.16.33",
-    "@blocklet/payment-react": "1.16.10",
+    "@blocklet/payment-react": "1.16.12",
     "@blocklet/sdk": "^1.16.33",
     "@blocklet/ui-react": "^2.10.74",
     "@blocklet/uploader": "^0.1.53",
@@ -120,7 +120,7 @@
   "devDependencies": {
     "@abtnode/types": "^1.16.33",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.16.10",
+    "@blocklet/payment-types": "1.16.12",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -166,5 +166,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "ee0052f6d37257507d69b979ea11ae22ffd622b7"
+  "gitHead": "1af1e91e65dfb78b39d65a1d8d3396be83a9c04f"
 }

package/src/locales/en.tsx

@@ -638,5 +638,12 @@ export default flat({
       intervals: 'intervals',
       history: 'Fund History',
     },
+    delegation: {
+      title:
+        'Seems your delegation to this blocklet is revoked or insufficient, which will cause automatic payment failures for your subscription.',
+      btn: 'Delegate Now',
+      success: 'Delegate successful',
+      error: 'Delegate failed',
+    },
   },
 });

package/src/locales/zh.tsx

@@ -625,5 +625,11 @@ export default flat({
       intervals: '个周期',
       history: '充值记录',
     },
+    delegation: {
+      title: '检测到你未完成账户的授权,为了不影响订阅的扣费，请尽快完成授权',
+      btn: '支付授权',
+      success: '授权成功',
+      error: '授权失败',
+    },
   },
 });

package/src/pages/admin/settings/payment-methods/index.tsx

@@ -199,7 +199,7 @@ export default function PaymentMethods() {
                                 </IconButton>
                               }>
                               <ListItemAvatar>
-                                <Avatar src={currency.logo} />
+                                <Avatar src={currency.logo} alt={currency.name} />
                               </ListItemAvatar>
                               <ListItemText primary={currency.name} secondary={currency.description} />
                             </ListItem>

package/src/pages/customer/index.tsx

@@ -104,6 +104,7 @@ export default function CustomerHome() {
   const { data, error, loading, runAsync } = useRequest(fetchData, {
     manual: true,
   });
+
   const countryDetail = useMemo(() => {
     const item = defaultCountries.find((v) => v[1] === data?.address?.country);
     return item ? parseCountry(item) : { name: '' };
@@ -465,24 +466,6 @@ export default function CustomerHome() {
       )}
     </Content>
   );
-
-  // return (
-  //   <>
-  //     <ProgressBar pending={isPending} />
-  //     <Grid container spacing={5}>
-  //       <Grid item xs={12} md={8}>
-  //         <Root direction="column" spacing={3} sx={{ my: 2 }}>
-
-  //         </Root>
-  //       </Grid>
-  //       <Grid item xs={12} md={4}>
-  //         <Root direction="column" spacing={4} sx={{ my: 2 }}>
-
-  //         </Root>
-  //       </Grid>
-  //     </Grid>
-  //   </>
-  // );
 }
 
 const Content = styled(Stack)`

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

@@ -1,13 +1,23 @@
 /* eslint-disable react/no-unstable-nested-components */
 import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
-import { CustomerInvoiceList, TxLink, api, formatTime, hasDelegateTxHash } from '@blocklet/payment-react';
+import {
+  CustomerInvoiceList,
+  TxLink,
+  api,
+  formatError,
+  formatTime,
+  getPrefix,
+  hasDelegateTxHash,
+  usePaymentContext,
+} from '@blocklet/payment-react';
 import type { TSubscriptionExpanded } from '@blocklet/payment-types';
 import { ArrowBackOutlined } from '@mui/icons-material';
-import { Alert, Box, Button, CircularProgress, Divider, Stack, Typography } from '@mui/material';
+import { Alert, Box, Button, CircularProgress, Divider, Stack, Tooltip, Typography } from '@mui/material';
 import { useRequest } from 'ahooks';
 import { Link, useNavigate, useParams } from 'react-router-dom';
-
+import Toast from '@arcblock/ux/lib/Toast';
 import { styled } from '@mui/system';
+import { joinURL } from 'ufo';
 import Currency from '../../../components/currency';
 import CustomerLink from '../../../components/customer/link';
 import InfoRow from '../../../components/info-row';
@@ -22,6 +32,10 @@ const fetchData = (id: string | undefined): Promise<TSubscriptionExpanded> => {
   return api.get(`/api/subscriptions/${id}`).then((res) => res.data);
 };
 
+const fetchSubscriptionDelegation = (id: string): Promise<{ sufficient: boolean }> => {
+  return api.get(`/api/subscriptions/${id}/delegation`).then((res) => res.data);
+};
+
 const InfoDirection = 'column';
 const InfoAlignItems = 'flex-start';
 
@@ -31,6 +45,33 @@ export default function CustomerSubscriptionDetail() {
   const { t } = useLocaleContext();
   const { session } = useSessionContext();
   const { loading, error, data, refresh } = useRequest(() => fetchData(id));
+  const { connect } = usePaymentContext();
+
+  const { data: delegation = { sufficient: true }, runAsync: runDelegation } = useRequest(() =>
+    fetchSubscriptionDelegation(id)
+  );
+  const noDelegation = delegation && typeof delegation === 'object' && !delegation.sufficient;
+
+  const handleDelegate = () => {
+    connect.open({
+      containerEl: undefined as unknown as Element,
+      saveConnect: false,
+      action: 'delegation',
+      prefix: joinURL(getPrefix(), '/api/did'),
+      extraParams: { subscriptionId: id },
+      onSuccess: () => {
+        connect.close();
+        Toast.success(t('customer.delegation.success'));
+        runDelegation();
+      },
+      onClose: () => {
+        connect.close();
+      },
+      onError: (err: any) => {
+        Toast.error(formatError(err));
+      },
+    });
+  };
   if (data?.customer?.did && session?.user?.did && data.customer.did !== session.user.did) {
     return <Alert severity="error">You do not have permission to access other customer data</Alert>;
   }
@@ -62,6 +103,13 @@ export default function CustomerSubscriptionDetail() {
             </Typography>
           </Stack>
           <Stack direction="row" gap={1}>
+            {noDelegation && ['active', 'trialing', 'past_due'].includes(data?.status) && (
+              <Tooltip title={t('customer.delegation.title')}>
+                <Button variant="outlined" color="primary" onClick={() => handleDelegate()}>
+                  {t('customer.delegation.btn')}
+                </Button>
+              </Tooltip>
+            )}
             <SubscriptionActions
               subscription={data}
               onChange={() => refresh()}