payment-kit 1.17.2 → 1.17.4

package/api/src/integrations/arcblock/nft.ts

@@ -57,7 +57,7 @@ export async function mintNftForCheckoutSession(id: string) {
       client.getAccountState({ address: wallet.address }),
     ]);
 
-    const preMint = preMintFromFactory({
+    const preMint = await preMintFromFactory({
       factory: formatFactoryState(factoryState as any),
       inputs: inputs || {},
       owner: nftOwner,

package/api/src/libs/env.ts

@@ -1,5 +1,4 @@
 import env from '@blocklet/sdk/lib/env';
-import { env as configEnv } from '@blocklet/sdk/lib/config';
 
 export const paymentStatCronTime: string = '0 1 0 * * *'; // 默认每天一次，计算前一天的
 export const subscriptionCronTime: string = process.env.SUBSCRIPTION_CRON_TIME || '0 */30 * * * *'; // 默认每 30 min 行一次
@@ -13,7 +12,6 @@ export const revokeStakeCronTime: string = process.env.REVOKE_STAKE_CRON_TIME ||
 export const daysUntilCancel: string | undefined = process.env.DAYS_UNTIL_CANCEL;
 export const meteringSubscriptionDetectionCronTime: string =
   process.env.METERING_SUBSCRIPTION_DETECTION_CRON_TIME || '0 0 10 * * *'; // 默认每天 10:00 执行
-export const overdraftProtectionMaxCount: number = Number(configEnv?.preferences?.overdraftProtectionMaxCount || 10); // 透支保护次数上限
 
 // sequelize 配置相关
 export const sequelizeOptionsPoolMin: number = process.env.SEQUELIZE_OPTIONS_POOL_MIN

package/api/src/libs/middleware.ts

@@ -12,7 +12,7 @@ export function ensureI18n() {
   };
 }
 
-export function contextMiddleware(req: Request, _res: Response, next: NextFunction) {
+export async function contextMiddleware(req: Request, _res: Response, next: NextFunction) {
   const requestId =
     (req.headers['x-request-id'] as string) || `req_${Date.now()}_${Math.random().toString(36).substring(2, 9)}`;
   let requestedBy = 'system';
@@ -22,7 +22,7 @@ export function contextMiddleware(req: Request, _res: Response, next: NextFuncti
   const componentDid = req.get('x-component-did');
   if (sig && componentDid) {
     const data = typeof req.body === 'undefined' ? {} : req.body;
-    const verified = verify(data, sig);
+    const verified = await verify(data, sig);
     if (verified) {
       requestedBy = componentDid;
     }

package/api/src/libs/overdraft-protection.ts

@@ -10,6 +10,9 @@ export async function ensureOverdraftProtectionPrice(livemode = true) {
     const exist = await Price.findOne({ where: { lookup_key: lookUpKey, livemode } });
     if (exist) {
       const product = await Product.findByPk(exist.product_id);
+      if (product?.name === 'Overdraft Protection') {
+        product.update({ name: 'SubGuard Service' });
+      }
       return {
         product,
         price: exist,
@@ -27,7 +30,7 @@ export async function ensureOverdraftProtectionPrice(livemode = true) {
 
     const result = await createProductAndPrices({
       type: 'service',
-      name: 'Overdraft Protection',
+      name: 'SubGuard Service',
       description:
         'If you purchase this service, the overdue subscription will be protected and not be ended due to overdue',
       images: [],

package/api/src/libs/security.ts

@@ -34,7 +34,7 @@ export function authenticate<T extends Model>({ component, roles, record, mine,
     const sig = req.get('x-component-sig');
     if (component && sig) {
       const { data } = getVerifyData(req as any, 'component');
-      const verified = verify(data, sig);
+      const verified = await verify(data, sig);
       if (!verified) {
         return res.status(401).json({ error: 'Invalid signature for component call' });
       }
@@ -56,7 +56,7 @@ export function authenticate<T extends Model>({ component, roles, record, mine,
     const id = req.params.id || req.query.subscription_id || '';
     if (embed && token && id) {
       try {
-        const verified = wallet.verify(id as string, token as string);
+        const verified = await wallet.verify(id as string, token as string);
         if (!verified) {
           return res.status(401).json({ error: `Invalid signature for embed: ${id}` });
         }

package/api/src/libs/subscription.ts

@@ -1296,7 +1296,7 @@ export async function returnOverdraftProtectionStake(
       const item = await Refund.create({
         type: 'stake_return',
         amount: unused,
-        description: 'overdraft protection_return_for_subscription',
+        description: 'stake_return_for_subscription_guard',
         status: 'pending',
         reason: refundReason || 'requested_by_admin',
         subscription_id: subscription.id,

package/api/src/locales/en.ts

@@ -194,8 +194,8 @@ export default flat({
     },
 
     overdraftProtectionExhausted: {
-      title: 'Insufficient Credit for Overdraft Protection',
-      body: 'Your subscription to {productName} has insufficient staked credit for overdraft protection. Please increase your stake to maintain the service or disable it if no longer needed.',
+      title: 'Insufficient Credit for SubGuard™',
+      body: 'Your subscription to {productName} has insufficient staked credit for SubGuard™. Please increase your stake to maintain the service or disable it if no longer needed.',
     },
   },
 });

package/api/src/locales/zh.ts

@@ -187,8 +187,8 @@ export default flat({
     },
 
     overdraftProtectionExhausted: {
-      title: '透支保护额度不足',
-      body: '您订阅的 {productName} 透支保护额度不足，为了避免影响您的透支保护服务，请及时充值。如不再需要透支保护服务，可关闭该功能。',
+      title: '订阅守护服务额度不足',
+      body: '您订阅的 {productName} 订阅守护服务额度不足，为了避免影响您的使用，请及时充值。如不再需要订阅守护服务，可关闭该功能。',
     },
   },
 });

package/api/src/queues/notification.ts

@@ -68,7 +68,7 @@ import {
 import {
   OverdraftProtectionExhaustedEmailTemplate,
   OverdraftProtectionExhaustedEmailTemplateOptions,
-} from '../libs/notification/template/subscription.overdraft-protection.exhausted';
+} from '../libs/notification/template/subscription-overdraft-protection-exhausted';
 
 export type NotificationQueueJobOptions = any;
 

package/api/src/queues/subscription.ts

@@ -1211,7 +1211,7 @@ events.on('customer.stake.revoked', async ({ subscriptionId, tx }: { subscriptio
       feedback: 'other',
       comment: `Revoked by ${tx.tx.from} with tx ${tx.hash}`,
     },
-    // 关闭透支保护
+    // 关闭订阅守护
     // @ts-ignore
     overdraft_protection: {
       ...(subscription.overdraft_protection || {}),

package/api/src/routes/connect/overdraft-protection.ts

@@ -1,6 +1,6 @@
 import type { CallbackArgs } from '../../libs/auth';
 import { isSubscriptionOverdraftProtectionEnabled } from '../../libs/subscription';
-import { Lock } from '../../store/models';
+import { Lock, TLineItemExpanded } from '../../store/models';
 import {
   ensureSubscriptionForOverdraftProtection,
   executeOcapTransactions,
@@ -35,6 +35,8 @@ export default {
       );
     }
 
+    // @ts-ignore
+    const items = subscription!.items as TLineItemExpanded[];
     const claims: { [type: string]: [string, object] } = {};
 
     if (paymentMethod.type === 'arcblock') {
@@ -48,6 +50,7 @@ export default {
           paymentMethod,
           stakeAmount,
           subscription,
+          items,
         }),
       ];
 

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

@@ -692,6 +692,7 @@ export async function getOverdraftProtectionStakeTxClaim({
   paymentCurrency,
   paymentMethod,
   stakeAmount,
+  items,
 }: {
   userDid: string;
   userPk: string;
@@ -699,6 +700,7 @@ export async function getOverdraftProtectionStakeTxClaim({
   paymentCurrency: PaymentCurrency;
   paymentMethod: PaymentMethod;
   stakeAmount: string;
+  items: TLineItemExpanded[];
 }) {
   // create staking amount
   logger.info('getStakeTxClaim', {
@@ -725,9 +727,11 @@ export async function getOverdraftProtectionStakeTxClaim({
       ),
     };
 
+    const setup = getSubscriptionCreateSetup(items, paymentCurrency.id, 0, 0);
+
     return {
       type: 'StakeTx',
-      description: `Stake to complete subscription ${subscription.id} overdraft protection`,
+      description: `Stake to complete subscription ${subscription.id} SubGuard`,
       partialTx: {
         from: userDid,
         pk: userPk,
@@ -735,8 +739,8 @@ export async function getOverdraftProtectionStakeTxClaim({
           address,
           receiver: wallet.address,
           slashers: [wallet.address],
-          revokeWaitingPeriod: 0,
-          message: `Stake for subscription ${subscription.id} overdraft protection`,
+          revokeWaitingPeriod: setup.cycle.duration / 1000, // wait for at least 1 billing cycle
+          message: `Stake for subscription ${subscription.id} SubGuard`,
           nonce,
           inputs: [],
           data,
@@ -946,12 +950,13 @@ export async function ensureSubscriptionForCollectBatch(subscriptionId: string,
 export async function ensureSubscriptionForOverdraftProtection(subscriptionId: string, amount: string) {
   const subscription = await Subscription.findByPk(subscriptionId);
   if (!subscription) {
-    throw new Error(`Subscription ${subscriptionId} not found when prepare overdraft protection`);
+    throw new Error(`Subscription ${subscriptionId} not found when prepare SubGuard`);
   }
-
+    // @ts-ignore
+  subscription.items = await expandSubscriptionItems(subscription.id);
   const paymentCurrency = await PaymentCurrency.findByPk(subscription.currency_id);
   if (!paymentCurrency) {
-    throw new Error(`PaymentCurrency ${subscription.currency_id} not found when prepare overdraft protection`);
+    throw new Error(`PaymentCurrency ${subscription.currency_id} not found when prepare SubGuard`);
   }
   
   const paymentMethod = await PaymentMethod.findByPk(paymentCurrency.payment_method_id);
@@ -960,7 +965,7 @@ export async function ensureSubscriptionForOverdraftProtection(subscriptionId: s
     throw new Error(`Payment method not found for subscription ${subscriptionId}`);
   }
   if (paymentMethod.type !== 'arcblock') {
-    throw new Error(`Payment method ${paymentMethod.type} not supported for overdraft protection`);
+    throw new Error(`Payment method ${paymentMethod.type} not supported for SubGuard`);
   }
 
   const customer = await Customer.findByPk(subscription.customer_id);

package/api/src/routes/invoices.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/naming-convention */
 import { isValid } from '@arcblock/did';
 import { Router } from 'express';
 import Joi from 'joi';
@@ -43,6 +44,7 @@ const schema = createListParamSchema<{
   ignore_zero?: boolean;
   include_staking?: boolean;
   include_return_staking?: boolean;
+  include_overdraft_protection?: boolean;
   include_recovered_from?: boolean;
 }>({
   status: Joi.string().empty(''),
@@ -53,15 +55,25 @@ const schema = createListParamSchema<{
   ignore_zero: Joi.boolean().empty(false),
   include_staking: Joi.boolean().empty(false),
   include_return_staking: Joi.boolean().empty(false),
+  include_overdraft_protection: Joi.boolean().default(true),
   include_recovered_from: Joi.boolean().empty(false),
 });
 router.get('/', authMine, async (req, res) => {
   // eslint-disable-next-line @typescript-eslint/naming-convention
-  const { page, pageSize, livemode, status, ignore_zero, include_staking, include_return_staking, ...query } =
-    await schema.validateAsync(req.query, {
-      stripUnknown: false,
-      allowUnknown: true,
-    });
+  const {
+    page,
+    pageSize,
+    livemode,
+    status,
+    ignore_zero,
+    include_staking,
+    include_return_staking,
+    include_overdraft_protection = true,
+    ...query
+  } = await schema.validateAsync(req.query, {
+    stripUnknown: false,
+    allowUnknown: true,
+  });
   const where = getWhereFromKvQuery(query.q);
 
   if (status) {
@@ -107,7 +119,11 @@ router.get('/', authMine, async (req, res) => {
       // @ts-ignore
       where[key] = query[key];
     });
+
   const excludeBillingReasons = ['recharge'];
+  if (!include_overdraft_protection) {
+    excludeBillingReasons.push('stake_overdraft_protection');
+  }
   if (!!(include_staking && query.subscription_id) || !include_staking) {
     excludeBillingReasons.push('stake');
   }

package/api/src/routes/subscriptions.ts

@@ -1760,7 +1760,7 @@ router.get('/:id/cycle-amount', authPortal, async (req, res) => {
   const pastMaxAmount = await getPastInvoicesAmount(subscription.id, 'max');
 
   // return max amount
-  const nextAmount = new BN(result.amount === '0' ? result.minExpectedAmount : result.amount);
+  const nextAmount = new BN(result.amount === '0' ? result.minExpectedAmount : result.amount).toString();
 
   const maxAmount = new BN(pastMaxAmount.amount).lte(new BN(nextAmount)) ? nextAmount : pastMaxAmount.amount;
 

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.17.2",
+  "version": "1.17.4",
   "scripts": {
     "dev": "blocklet dev --open",
     "eject": "vite eject",
@@ -43,30 +43,30 @@
     ]
   },
   "dependencies": {
-    "@abtnode/cron": "^1.16.36",
-    "@arcblock/did": "^1.18.165",
+    "@abtnode/cron": "^1.16.37",
+    "@arcblock/did": "^1.19.2",
     "@arcblock/did-auth-storage-nedb": "^1.7.1",
-    "@arcblock/did-connect": "^2.11.15",
-    "@arcblock/did-util": "^1.18.165",
-    "@arcblock/jwt": "^1.18.165",
-    "@arcblock/ux": "^2.11.15",
-    "@arcblock/validator": "^1.18.165",
-    "@blocklet/js-sdk": "^1.16.36",
-    "@blocklet/logger": "^1.16.36",
-    "@blocklet/payment-react": "1.17.2",
-    "@blocklet/sdk": "^1.16.36",
-    "@blocklet/ui-react": "^2.11.15",
-    "@blocklet/uploader": "^0.1.60",
-    "@blocklet/xss": "^0.1.17",
+    "@arcblock/did-connect": "^2.11.23",
+    "@arcblock/did-util": "^1.19.2",
+    "@arcblock/jwt": "^1.19.2",
+    "@arcblock/ux": "^2.11.23",
+    "@arcblock/validator": "^1.19.2",
+    "@blocklet/js-sdk": "^1.16.37",
+    "@blocklet/logger": "^1.16.37",
+    "@blocklet/payment-react": "1.17.4",
+    "@blocklet/sdk": "^1.16.37",
+    "@blocklet/ui-react": "^2.11.23",
+    "@blocklet/uploader": "^0.1.63",
+    "@blocklet/xss": "^0.1.20",
     "@mui/icons-material": "^5.16.6",
     "@mui/lab": "^5.0.0-alpha.173",
     "@mui/material": "^5.16.6",
     "@mui/system": "^5.16.6",
-    "@ocap/asset": "^1.18.165",
-    "@ocap/client": "^1.18.165",
-    "@ocap/mcrypto": "^1.18.165",
-    "@ocap/util": "^1.18.165",
-    "@ocap/wallet": "^1.18.165",
+    "@ocap/asset": "^1.19.2",
+    "@ocap/client": "^1.19.2",
+    "@ocap/mcrypto": "^1.19.2",
+    "@ocap/util": "^1.19.2",
+    "@ocap/wallet": "^1.19.2",
     "@stripe/react-stripe-js": "^2.7.3",
     "@stripe/stripe-js": "^2.4.0",
     "ahooks": "^3.8.0",
@@ -118,9 +118,9 @@
     "validator": "^13.12.0"
   },
   "devDependencies": {
-    "@abtnode/types": "^1.16.36",
+    "@abtnode/types": "^1.16.37",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.17.2",
+    "@blocklet/payment-types": "1.17.4",
     "@types/cookie-parser": "^1.4.7",
     "@types/cors": "^2.8.17",
     "@types/debug": "^4.1.12",
@@ -166,5 +166,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "c38e8a29d94254d503aa29084c2b629805a5a7ad"
+  "gitHead": "2d25cbcf146ba2195b1c3434ab3f64566f851893"
 }