payment-kit 1.13.67 → 1.13.69

package/api/src/jobs/invoice.ts

@@ -79,6 +79,9 @@ export const handleInvoice = async (job: InvoiceJob) => {
   if (invoice.payment_intent_id) {
     logger.warn(`PaymentIntent exist: ${invoice.payment_intent_id} for invoice ${job.invoiceId}`);
     paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
+    if (paymentIntent && ['succeeded', 'canceled'].includes(paymentIntent.status) === false) {
+      await paymentIntent.update({ status: 'requires_capture' });
+    }
   } else {
     const descriptionMap: any = {
       subscription_create: 'Subscription creation',

package/api/src/libs/notification/template/subscription-renew-failed.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/brace-style */
 /* eslint-disable @typescript-eslint/indent */
 import { fromUnitToToken, toDid } from '@ocap/util';
+import camelCase from 'lodash/camelCase';
 import prettyMsI18n from 'pretty-ms-i18n';
 
 import { getUserLocale } from '../../../integrations/blocklet/notification';
@@ -60,14 +61,7 @@ export class SubscriptionRenewFailedEmailTemplate
       throw new Error(`SufficientForPaymentResult.sufficient should be false: ${JSON.stringify(this.options.result)}`);
     }
 
-    // 类似 NO_DID_WALLET 字符串将转成 noDidWallet
-    const toCamelCase = (input: string): string => {
-      return input.toLowerCase().replace(/_([a-z])/g, (_match, group1) => {
-        return group1.toUpperCase();
-      });
-    };
-
-    const i18nText = `notification.subscriptionRenewFailed.reason.${toCamelCase(this.options.result.reason as string)}`;
+    const i18nText = `notification.subscriptionRenewFailed.reason.${camelCase(this.options.result.reason as string)}`;
 
     const paymentDetail = await getPaymentDetail(userDid, invoice);
     const reason = translate(i18nText, locale, {

package/api/src/libs/payment.ts

@@ -2,26 +2,35 @@
 import { toDelegateAddress } from '@arcblock/did-util';
 import { sign } from '@arcblock/jwt';
 import { getWalletDid } from '@blocklet/sdk/lib/did';
-import type { DelegateState } from '@ocap/client';
+import type { DelegateState, TokenLimit } from '@ocap/client';
 import { toTxHash } from '@ocap/mcrypto';
 import { BN, fromUnitToToken } from '@ocap/util';
+import cloneDeep from 'lodash/cloneDeep';
+import type { LiteralUnion } from 'type-fest';
 
 import { Invoice, PaymentCurrency, PaymentIntent, PaymentMethod } from '../store/models';
 import type { TPaymentCurrency } from '../store/models/payment-currency';
 import { blocklet, wallet } from './auth';
 import logger from './logger';
+import { OCAP_PAYMENT_TX_TYPE } from './util';
 
 export interface SufficientForPaymentResult {
   sufficient: boolean;
-  reason?:
+  reason?: LiteralUnion<
     | 'NO_DID_WALLET'
     | 'NO_DELEGATION'
     | 'NO_TRANSFER_PERMISSION'
+    | 'NO_TRANSFER_TO'
+    | 'NO_TOKEN_PERMISSION'
     | 'NO_TOKEN'
+    | 'NO_ENOUGH_ALLOWANCE'
     | 'NO_ENOUGH_TOKEN'
-    | 'NOT_SUPPORTED';
+    | 'NOT_SUPPORTED',
+    string
+  >;
   delegator?: string;
   state?: DelegateState;
+  token?: { address: string; balance: string };
 }
 
 export async function isDelegationSufficientForPayment(args: {
@@ -31,6 +40,8 @@ export async function isDelegationSufficientForPayment(args: {
   amount: string;
 }): Promise<SufficientForPaymentResult> {
   const { paymentCurrency, paymentMethod, userDid, amount } = args;
+  const tokenAddress = paymentCurrency.contract as string;
+
   if (paymentMethod.type === 'arcblock') {
     // user have bond wallet did?
     const { user } = await blocklet.getUser(userDid, { enableConnectedAccount: true });
@@ -48,22 +59,43 @@ export async function isDelegationSufficientForPayment(args: {
       return { sufficient: false, reason: 'NO_DELEGATION' };
     }
 
-    // have enough permissions
-    if (state.ops.some((x: any) => x.key === 'fg:t:transfer_v2') === false) {
+    // have transfer permissions?
+    const grant = (state as DelegateState).ops.find((x: any) => x.key === OCAP_PAYMENT_TX_TYPE)?.value;
+    if (!grant) {
       return { sufficient: false, reason: 'NO_TRANSFER_PERMISSION' };
     }
 
+    // check token limits
+    if (grant.limit) {
+      const tokenLimit = grant.limit.tokens.find((x: any) => x.address === tokenAddress);
+      if (!tokenLimit) {
+        return { sufficient: false, reason: 'NO_TOKEN_PERMISSION' };
+      }
+
+      // FIXME: @wangshijun check other conditions in the token limit: txCount, totalAllowance, validUntil, rateLimit
+
+      if (Array.isArray(tokenLimit.to) && tokenLimit.to.length && tokenLimit.to.includes(wallet.address) === false) {
+        return { sufficient: false, reason: 'NO_TRANSFER_TO' };
+      }
+
+      const requested = new BN(amount);
+      const allowance = new BN(tokenLimit.txAllowance);
+      if (requested.gt(allowance)) {
+        return { sufficient: false, reason: 'NO_ENOUGH_ALLOWANCE' };
+      }
+    }
+
     // balance enough token for payment?
-    const { tokens } = await client.getAccountTokens({ address: delegator, token: paymentCurrency.contract as string });
+    const { tokens } = await client.getAccountTokens({ address: delegator, token: tokenAddress });
     const [token] = tokens;
     if (!token) {
       return { sufficient: false, reason: 'NO_TOKEN' };
     }
     if (new BN(token.balance).lt(new BN(amount))) {
-      return { sufficient: false, reason: 'NO_ENOUGH_TOKEN' };
+      return { sufficient: false, reason: 'NO_ENOUGH_TOKEN', token };
     }
 
-    return { sufficient: true, delegator, state };
+    return { sufficient: true, delegator, state, token };
   }
 
   if (paymentMethod.type === 'stripe') {
@@ -114,53 +146,82 @@ export async function getPaymentDetail(userDid: string, invoice: Invoice): Promi
   }
 
   if (paymentMethod.type === 'arcblock') {
-    // user have bond wallet did?
-    const { user } = await blocklet.getUser(userDid, { enableConnectedAccount: true });
-    const delegator = getWalletDid(user);
-    if (!delegator) {
-      logger.error('getPayment.error', { reason: 'NO_DID_WALLET' });
-      return defaultResult;
-    }
-
-    const client = paymentMethod.getOcapClient();
-
-    // have delegated before?
-    const address = toDelegateAddress(delegator, wallet.address);
-    const { state } = await client.getDelegateState({ address });
-    if (!state) {
-      logger.error('getPayment.error', { reason: 'NO_DELEGATION' });
-      return defaultResult;
-    }
+    // balance enough token for payment?
+    const result = await isDelegationSufficientForPayment({
+      paymentMethod,
+      paymentCurrency,
+      userDid,
+      amount: paymentIntent.amount,
+    });
 
-    // have enough permissions
-    if (state.ops.some((x: any) => x.key === 'fg:t:transfer_v2') === false) {
-      logger.error('getPayment.error', { reason: 'NO_TRANSFER_PERMISSION' });
+    // Do not have enough permission
+    if (!result.token) {
+      logger.error('getPayment.error', { reason: result.reason });
       return defaultResult;
     }
 
-    // balance enough token for payment?
+    // Do not have enough token
     const amount: number = +fromUnitToToken(paymentIntent.amount, paymentCurrency.decimal);
-    const { symbol } = paymentCurrency;
-
-    const { tokens } = await client.getAccountTokens({
-      address: delegator,
-      token: paymentCurrency.contract as string,
-    });
-    const [token] = tokens;
-    if (!token) {
+    if (!result.delegator) {
       return {
         balance: 0,
         price: amount,
-        symbol,
+        symbol: paymentCurrency.symbol,
       };
     }
 
     return {
-      balance: +fromUnitToToken(token.balance, paymentCurrency.decimal),
+      balance: +fromUnitToToken(result.token.balance, paymentCurrency.decimal),
       price: amount,
-      symbol,
+      symbol: paymentCurrency.symbol,
     };
   }
 
   return defaultResult;
 }
+
+export async function getTokenLimitsForDelegation(
+  paymentMethod: PaymentMethod,
+  paymentCurrency: PaymentCurrency,
+  address: string,
+  amount: string
+): Promise<TokenLimit[]> {
+  const client = paymentMethod.getOcapClient();
+  const { state } = await client.getDelegateState({ address });
+
+  // @ts-ignore
+  const entry: TokenLimit = {
+    address: paymentCurrency.contract as string,
+    to: [wallet.address], // FIXME: may broken if we have vault, migrated
+    txAllowance: amount,
+    totalAllowance: '0',
+    txCount: 0,
+    validUntil: 0,
+  };
+
+  // If we never delegated before
+  if (!state) {
+    return [entry];
+  }
+
+  const op = (state as DelegateState).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);
+    // we are updating an existing token limit
+    if (index > -1) {
+      const limit = op.value.limit.tokens[index] as TokenLimit;
+      // If we have a previous delegation and the txAllowance is smaller than requested amount
+      if (new BN(limit.txAllowance).lt(new BN(amount))) {
+        tokenLimits[index] = entry;
+      }
+    } else {
+      // we are adding a new token limit
+      tokenLimits.push(entry);
+    }
+
+    return tokenLimits;
+  }
+
+  return [entry];
+}

package/api/src/libs/util.ts

@@ -7,6 +7,8 @@ import type { LiteralUnion } from 'type-fest';
 
 import dayjs from './dayjs';
 
+export const OCAP_PAYMENT_TX_TYPE = 'fg:t:transfer_v2';
+
 export const MAX_RETRY_COUNT = 18; // 2^18 seconds ~~ 3 days, total retry time: 6 days
 export const STRIPE_API_VERSION = '2023-08-16';
 export const STRIPE_ENDPOINT: string = getUrl('/api/integrations/stripe/webhook');

package/api/src/locales/en.ts

@@ -47,9 +47,9 @@ export default flat({
 
     subscriptionWillRenew: {
       title: '{productName} will be auto-renewed soon',
-      body: 'Your subscription to {productName} and {willRenewDuration} is expiring. Please make sure you have enough balance in your account to auto-renew your subscription when it expires ({at}). We wish you all the best!',
+      body: 'Your subscription to {productName} expires in {willRenewDuration}. Please make sure you have enough balance in your account to auto-renew your subscription when it expires ({at}). We wish you all the best!',
       unableToPayBody:
-        'Your subscription to {productName} and {willRenewDuration} expires. <span style="color: red;">Your current balance is {balance}, which is less than {price}</span>, so please make sure you have enough balance in your account to automatically renew your subscription when it expires ({at}). We wish you all the best!',
+        'Your subscription to {productName} expires in {willRenewDuration}. <span style="color: red;">Your current balance is {balance}, which is less than {price}</span>, so please make sure you have enough balance in your account to automatically renew your subscription when it expires ({at}). We wish you all the best!',
       renewAmount: 'Amount',
     },
 
@@ -65,9 +65,14 @@ export default flat({
       reason: {
         noDidWallet:
           'You have not yet bound the DID Wallet, please bind the DID Wallet, make sure the balance is sufficient and then renew it',
-        noDelegation: 'Your DID Wallet is not yet authorized, please renew it after completing the authorization',
+        noDelegation: 'No delegation found from your DID Wallet, please renew it after completing the authorization',
         noTransferPermission:
-          'Your DID Wallet transfer privileges are insufficient, please complete the authorization and renew it again',
+          'Transfer permission not granted to app, please update the authorization and renew it again',
+        noTokenPermission:
+          'Token transfer permission not granted to app, please update the authorization and renew it again',
+        noTransferTo:
+          'App not in whitelist of the transfer permission, please update the authorization and renew it again',
+        noEnoughAllowance: 'Transfer amount exceeds tx allowance, please update the authorization and renew it again',
         noToken: "You don't have any tokens in your account, please replenish your tokens and renew your account",
         noEnoughToken:
           'Your account token balance is {balance}, not enough for {price}, please replenish your tokens and renew your account',

package/api/src/locales/zh.ts

@@ -65,7 +65,10 @@ export default flat({
       reason: {
         noDidWallet: '您尚未绑定 DID Wallet，请绑定 DID Wallet，确保余额充足后重新续费',
         noDelegation: '您的 DID Wallet 尚未授权，请完成授权后重新续费',
-        noTransferPermission: '您的 DID Wallet 转账权限不足，请完成授权后重新续费',
+        noTransferPermission: '您的 DID Wallet 未授予应用转账权限，请更新授权后重新续费',
+        noTokenPermission: '您的 DID Wallet 未授予应用对应通证的转账权限，请更新授权后重新续费',
+        noTransferTo: '您的 DID Wallet 未授予应用扣款权限，请更新授权后重新续费',
+        noEnoughAllowance: '扣款金额超出单笔转账限额，请更新授权后重新续费',
         noToken: '您的账户没有任何代币，请充值代币后重新续费',
         noEnoughToken: '您的账户代币余额为 {balance}，不足 {price}，请充值代币后重新续费',
         noSupported: '不支持使用代币续费，请检查您的套餐',

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

@@ -657,6 +657,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           subscription: subscription.id,
         });
 
+        // FIXME: @wangshijun what if we have have changed subscription items when resubmit
         // create subscription items
         const items = await Promise.all(
           lineItems
@@ -753,6 +754,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           id: stripeIntent.id,
           client_secret: stripeIntent.client_secret,
           status: stripeIntent.status,
+          intent_type: 'payment_intent',
         };
       }
 

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

@@ -6,8 +6,10 @@ import { fromPublicKey } from '@ocap/wallet';
 import { subscriptionQueue } from '../../jobs/subscription';
 import type { CallbackArgs } from '../../libs/auth';
 import { wallet } from '../../libs/auth';
-import { getGasPayerExtra } from '../../libs/payment';
-import { getTxMetadata } from '../../libs/util';
+import { getGasPayerExtra, getTokenLimitsForDelegation } from '../../libs/payment';
+import { getFastCheckoutAmount } from '../../libs/session';
+import { OCAP_PAYMENT_TX_TYPE, getTxMetadata } from '../../libs/util';
+import type { TLineItemExpanded } from '../../store/models';
 import { ensureSetupIntent, getAuthPrincipalClaim, getTokenRequirements } from './shared';
 
 export default {
@@ -30,6 +32,13 @@ export default {
     }
 
     if (paymentMethod.type === 'arcblock') {
+      const address = toDelegateAddress(userDid, wallet.address);
+      const amount = getFastCheckoutAmount(
+        checkoutSession.line_items as TLineItemExpanded[],
+        checkoutSession.mode,
+        paymentCurrency
+      );
+      const tokenLimits = await getTokenLimitsForDelegation(paymentMethod, paymentCurrency, address, amount);
       const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
 
       return {
@@ -39,9 +48,9 @@ export default {
           wallet: fromPublicKey(userPk, toTypeInfo(userDid)),
           data: {
             itx: {
-              address: toDelegateAddress(userDid, wallet.address),
+              address,
               to: wallet.address,
-              ops: [{ typeUrl: 'fg:t:transfer_v2', rules: [] }],
+              ops: [{ typeUrl: OCAP_PAYMENT_TX_TYPE, limit: { tokens: tokenLimits, assets: [] } }],
               data: getTxMetadata({
                 subscriptionId: subscription.id,
                 checkoutSessionId,

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

@@ -8,8 +8,10 @@ import { invoiceQueue } from '../../jobs/invoice';
 import { subscriptionQueue } from '../../jobs/subscription';
 import type { CallbackArgs } from '../../libs/auth';
 import { wallet } from '../../libs/auth';
-import { getGasPayerExtra } from '../../libs/payment';
-import { getTxMetadata } from '../../libs/util';
+import { getGasPayerExtra, getTokenLimitsForDelegation } from '../../libs/payment';
+import { getFastCheckoutAmount } from '../../libs/session';
+import { OCAP_PAYMENT_TX_TYPE, getTxMetadata } from '../../libs/util';
+import type { TLineItemExpanded } from '../../store/models';
 import { ensureInvoiceForCheckout, ensurePaymentIntent, getAuthPrincipalClaim, getTokenRequirements } from './shared';
 
 export default {
@@ -32,6 +34,13 @@ export default {
     }
 
     if (paymentMethod.type === 'arcblock') {
+      const address = toDelegateAddress(userDid, wallet.address);
+      const amount = getFastCheckoutAmount(
+        checkoutSession.line_items as TLineItemExpanded[],
+        checkoutSession.mode,
+        paymentCurrency
+      );
+      const tokenLimits = await getTokenLimitsForDelegation(paymentMethod, paymentCurrency, address, amount);
       const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
 
       return {
@@ -41,9 +50,9 @@ export default {
           wallet: fromPublicKey(userPk, toTypeInfo(userDid)),
           data: {
             itx: {
-              address: toDelegateAddress(userDid, wallet.address),
+              address,
               to: wallet.address,
-              ops: [{ typeUrl: 'fg:t:transfer_v2', rules: [] }],
+              ops: [{ typeUrl: OCAP_PAYMENT_TX_TYPE, limit: { tokens: tokenLimits, assets: [] } }],
               data: getTxMetadata({
                 subscriptionId: subscription.id,
                 checkoutSessionId,

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.67",
+  "version": "1.13.69",
   "scripts": {
     "dev": "COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev",
     "eject": "vite eject",
@@ -106,7 +106,7 @@
     "@abtnode/types": "^1.16.19",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.67",
+    "@did-pay/types": "1.13.69",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -143,5 +143,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "37b1d2ce195a256f8743a6cc53fd24d3d01579b0"
+  "gitHead": "fd169e0529e664ecf8257e684029f21629d39113"
 }

package/src/components/checkout/form/index.tsx

@@ -82,7 +82,11 @@ export default function PaymentForm({
     paying: boolean;
     paid: boolean;
     paymentIntent?: TPaymentIntent;
-    stripeContext?: any;
+    stripeContext?: {
+      client_secret: string;
+      intent_type: string;
+      status: string;
+    };
     customer?: TCustomer;
     stripePaying: boolean;
   }>({
@@ -90,7 +94,7 @@ export default function PaymentForm({
     paying: false,
     paid: false,
     paymentIntent,
-    stripeContext: null,
+    stripeContext: undefined,
     customer,
     stripePaying: false,
   });

package/src/pages/customer/invoice.tsx

@@ -3,9 +3,9 @@ import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
 import Toast from '@arcblock/ux/lib/Toast';
 import type { TInvoiceExpanded } from '@did-pay/types';
 import { ArrowBackOutlined } from '@mui/icons-material';
-import { Alert, Box, Button, CircularProgress, Grid, Link, Stack, Typography } from '@mui/material';
+import { Alert, Box, Button, CircularProgress, Grid, Stack, Typography } from '@mui/material';
 import { useRequest, useSetState } from 'ahooks';
-import { useParams } from 'react-router-dom';
+import { Link, useParams } from 'react-router-dom';
 
 import TxLink from '../../components/blockchain/tx';
 import Currency from '../../components/currency';
@@ -73,7 +73,7 @@ export default function CustomerHome() {
     <Layout>
       <Grid container spacing={3} sx={{ mt: 1 }}>
         <Grid item xs={12} md={12}>
-          <Link onClick={() => window.history.back()}>
+          <Link to="/customer">
             <Stack direction="row" alignItems="center" sx={{ fontWeight: 'normal' }}>
               <ArrowBackOutlined fontSize="small" sx={{ mr: 0.5, color: 'text.secondary' }} />
               <Typography variant="h6" sx={{ color: 'text.secondary', fontWeight: 'normal' }}>