payment-kit 1.13.205 → 1.13.207

package/api/src/integrations/blockchain/stake.ts

@@ -173,9 +173,9 @@ export async function checkStakeRevokeTx() {
   }
 }
 
-export async function getStakeSummaryByDid(did: string): Promise<GroupedBN> {
+export async function getStakeSummaryByDid(did: string, livemode: boolean): Promise<GroupedBN> {
   const methods = await PaymentMethod.findAll({
-    where: { type: 'arcblock' },
+    where: { type: 'arcblock', livemode },
     include: [{ model: PaymentCurrency, as: 'payment_currencies' }],
   });
   if (methods.length === 0) {
@@ -199,3 +199,29 @@ export async function getStakeSummaryByDid(did: string): Promise<GroupedBN> {
 
   return results;
 }
+
+export async function getTokenSummaryByDid(did: string, livemode: boolean): Promise<GroupedBN> {
+  const methods = await PaymentMethod.findAll({
+    where: { type: 'arcblock', livemode },
+    include: [{ model: PaymentCurrency, as: 'payment_currencies' }],
+  });
+  if (methods.length === 0) {
+    return {};
+  }
+
+  const results: GroupedBN = {};
+  await Promise.all(
+    methods.map(async (method: any) => {
+      const client = method.getOcapClient();
+      const { tokens } = await client.getAccountTokens({ address: did });
+      (tokens || []).forEach((t: any) => {
+        const currency = method.payment_currencies.find((c: any) => t.address === c.contract);
+        if (currency) {
+          results[currency.id] = t.balance;
+        }
+      });
+    })
+  );
+
+  return results;
+}

package/api/src/routes/customers.ts

@@ -3,7 +3,7 @@ import { Router } from 'express';
 import Joi from 'joi';
 import pick from 'lodash/pick';
 
-import { getStakeSummaryByDid } from '../integrations/blockchain/stake';
+import { getStakeSummaryByDid, getTokenSummaryByDid } from '../integrations/blockchain/stake';
 import { getWhereFromKvQuery, getWhereFromQuery } from '../libs/api';
 import { authenticate } from '../libs/security';
 import { formatMetadata } from '../libs/util';
@@ -111,8 +111,12 @@ router.get('/me', user(), async (req, res) => {
     if (!doc) {
       res.json(null);
     } else {
-      const [summary, stake] = await Promise.all([doc.getSummary(), getStakeSummaryByDid(doc.did)]);
-      res.json({ ...doc.toJSON(), summary: { ...summary, stake } });
+      const [summary, stake, token] = await Promise.all([
+        doc.getSummary(),
+        getStakeSummaryByDid(doc.did, doc.livemode),
+        getTokenSummaryByDid(doc.did, doc.livemode),
+      ]);
+      res.json({ ...doc.toJSON(), summary: { ...summary, stake, token } });
     }
   } catch (err) {
     console.error(err);
@@ -142,8 +146,12 @@ router.get('/:id/summary', auth, async (req, res) => {
       return;
     }
 
-    const [summary, stake] = await Promise.all([doc.getSummary(), getStakeSummaryByDid(doc.did)]);
-    res.json({ ...summary, stake });
+    const [summary, stake, token] = await Promise.all([
+      doc.getSummary(),
+      getStakeSummaryByDid(doc.did, doc.livemode),
+      getTokenSummaryByDid(doc.did, doc.livemode),
+    ]);
+    res.json({ ...summary, stake, token });
   } catch (err) {
     console.error(err);
     res.json(null);

package/api/src/routes/subscriptions.ts

@@ -20,6 +20,7 @@ import type { TLineItemExpanded } from '../store/models';
 import { Customer } from '../store/models/customer';
 import { Invoice } from '../store/models/invoice';
 import { InvoiceItem } from '../store/models/invoice-item';
+import { Lock } from '../store/models/lock';
 import { PaymentCurrency } from '../store/models/payment-currency';
 import { PaymentIntent } from '../store/models/payment-intent';
 import { PaymentMethod } from '../store/models/payment-method';
@@ -694,6 +695,11 @@ router.put('/:id', authPortal, async (req, res) => {
         throw new Error('Updating subscription item not allowed for subscriptions paid with stripe');
       }
 
+      const locked = await Lock.isLocked(`${subscription.id}-change-plan`);
+      if (locked) {
+        throw new Error('Updating subscription item not allowed now until next billing cycle');
+      }
+
       // validate the request
       const { existingItems, addedItems, updatedItems, deletedItems, newItems } =
         await validateSubscriptionUpdateRequest(subscription, value.items);
@@ -867,6 +873,11 @@ router.put('/:id', authPortal, async (req, res) => {
           }
         }
       }
+
+      // rate limit for plan change
+      const releaseAt = updates.current_period_end || subscription.current_period_end;
+      await Lock.acquire(`${subscription.id}-change-plan`, releaseAt);
+      logger.info('subscription plan change lock acquired', { subscription: req.params.id, releaseAt });
     } else if (req.body.billing_cycle_anchor === 'now') {
       if (subscription.isActive() === false) {
         throw new Error('Updating billing_cycle_anchor not allowed for inactive subscriptions');
@@ -1010,6 +1021,10 @@ router.get('/:id/change-plan', authPortal, async (req, res) => {
     if (subscription.isScheduledToCancel()) {
       return res.status(400).json({ error: 'Subscription is scheduled to cancel' });
     }
+    const locked = await Lock.isLocked(`${subscription.id}-change-plan`);
+    if (locked) {
+      return res.status(400).json({ error: 'Subscription plan change is not allowed until next billing cycle' });
+    }
 
     const paymentMethod = await PaymentMethod.findByPk(subscription.default_payment_method_id);
     if (paymentMethod?.type === 'stripe') {
@@ -1037,6 +1052,10 @@ router.post('/:id/change-plan', authPortal, async (req, res) => {
     if (subscription.isScheduledToCancel()) {
       return res.status(400).json({ error: 'Subscription is scheduled to cancel' });
     }
+    const locked = await Lock.isLocked(`${subscription.id}-change-plan`);
+    if (locked) {
+      return res.status(400).json({ error: 'Subscription plan change is not allowed until next billing cycle' });
+    }
 
     const paymentMethod = await PaymentMethod.findByPk(subscription.default_payment_method_id);
     if (paymentMethod?.type === 'stripe') {

package/api/src/store/migrations/20240328-lock.ts

@@ -0,0 +1,10 @@
+import type { Migration } from '../migrate';
+import models from '../models';
+
+export const up: Migration = async ({ context }) => {
+  await context.createTable('locks', models.Lock.GENESIS_ATTRIBUTES);
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.dropTable('locks');
+};

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

@@ -6,6 +6,7 @@ import { Event, TEvent } from './event';
 import { Invoice, TInvoice } from './invoice';
 import { InvoiceItem, TInvoiceItem } from './invoice-item';
 import { Job } from './job';
+import { Lock } from './lock';
 import { PaymentCurrency, TPaymentCurrency } from './payment-currency';
 import { PaymentIntent, TPaymentIntent } from './payment-intent';
 import { PaymentLink, TPaymentLink } from './payment-link';
@@ -49,6 +50,7 @@ const models = {
   WebhookEndpoint,
   WebhookAttempt,
   Job,
+  Lock,
 };
 
 export function initialize(sequelize: any) {
@@ -70,6 +72,7 @@ export * from './event';
 export * from './invoice';
 export * from './invoice-item';
 export * from './job';
+export * from './lock';
 export * from './payment-currency';
 export * from './payment-intent';
 export * from './payment-link';

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

@@ -0,0 +1,82 @@
+/* eslint-disable @typescript-eslint/lines-between-class-members */
+import { CreationOptional, DataTypes, InferAttributes, InferCreationAttributes, Model } from 'sequelize';
+
+import dayjs from '../../libs/dayjs';
+
+// eslint-disable-next-line prettier/prettier
+export class Lock extends Model<InferAttributes<Lock>, InferCreationAttributes<Lock>> {
+  declare id: CreationOptional<string>;
+  declare lock_at: number;
+  declare release_at: number;
+
+  declare reason?: string;
+
+  declare created_at: CreationOptional<Date>;
+  declare updated_at: CreationOptional<Date>;
+
+  public static readonly GENESIS_ATTRIBUTES = {
+    id: {
+      type: DataTypes.STRING(30),
+      primaryKey: true,
+      allowNull: false,
+    },
+    lock_at: {
+      type: DataTypes.INTEGER,
+      defaultValue: 0,
+    },
+    release_at: {
+      type: DataTypes.INTEGER,
+      defaultValue: -1,
+    },
+    reason: {
+      type: DataTypes.STRING(255),
+      allowNull: true,
+    },
+    created_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+    updated_at: {
+      type: DataTypes.DATE,
+      defaultValue: DataTypes.NOW,
+      allowNull: false,
+    },
+  };
+
+  public static initialize(sequelize: any) {
+    this.init(Lock.GENESIS_ATTRIBUTES, {
+      sequelize,
+      modelName: 'Lock',
+      tableName: 'locks',
+      createdAt: 'created_at',
+      updatedAt: 'updated_at',
+    });
+  }
+
+  public static async acquire(id: string, releaseAt: number, reason?: string): Promise<boolean> {
+    const now = dayjs().unix();
+    const exist = await this.findByPk(id);
+    if (exist) {
+      if (exist.release_at <= now) {
+        await exist.update({ lock_at: now, release_at: releaseAt, reason });
+        return true;
+      }
+
+      return false;
+    }
+
+    await this.create({ id, lock_at: now, release_at: releaseAt, reason });
+    return true;
+  }
+
+  public static async isLocked(id: string): Promise<boolean> {
+    const now = dayjs().unix();
+    const exist = await this.findByPk(id);
+    return !!exist && exist.release_at > now;
+  }
+
+  public static associate() {}
+}
+
+export type TLock = InferAttributes<Lock>;

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.205",
+  "version": "1.13.207",
   "scripts": {
     "dev": "cross-env COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev --open",
     "eject": "vite eject",
@@ -50,7 +50,7 @@
     "@arcblock/jwt": "^1.18.113",
     "@arcblock/ux": "^2.9.63",
     "@blocklet/logger": "1.16.24",
-    "@blocklet/payment-react": "1.13.205",
+    "@blocklet/payment-react": "1.13.207",
     "@blocklet/sdk": "1.16.24",
     "@blocklet/ui-react": "^2.9.63",
     "@blocklet/uploader": "^0.0.75",
@@ -110,7 +110,7 @@
   "devDependencies": {
     "@abtnode/types": "1.16.24",
     "@arcblock/eslint-config-ts": "^0.3.0",
-    "@blocklet/payment-types": "1.13.205",
+    "@blocklet/payment-types": "1.13.207",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -149,5 +149,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "8c16c5d362df5c497c7a95a0ae20e2ef61f747b3"
+  "gitHead": "7b4918ac7bb09317df0b2a78e337312cc4b50b67"
 }

package/src/components/balance-list.tsx

@@ -1,5 +1,5 @@
 import { useLocaleContext } from '@arcblock/ux/lib/Locale/context';
-import { formatAmount, usePaymentContext } from '@blocklet/payment-react';
+import { formatBNStr, usePaymentContext } from '@blocklet/payment-react';
 import type { GroupedBN } from '@blocklet/payment-types';
 import { Stack, Typography } from '@mui/material';
 import flatten from 'lodash/flatten';
@@ -26,13 +26,13 @@ export default function BalanceList(props: Props) {
           return null;
         }
         return (
-          <Stack key={currencyId} sx={{ width: '100%' }} direction="row" spacing={1}>
-            <Typography sx={{ flex: 1 }} color="text.primary">
-              {formatAmount(amount, currency.decimal)}
-            </Typography>
+          <Stack key={currencyId} sx={{ width: '100%', maxWidth: '200px' }} direction="row" spacing={1}>
             <Typography sx={{ width: '32px' }} color="text.secondary">
               {currency.symbol}
             </Typography>
+            <Typography sx={{ flex: 1, textAlign: 'right' }} color="text.primary">
+              {formatBNStr(amount, currency.decimal, 6, false)}
+            </Typography>
           </Stack>
         );
       })}

package/src/locales/en.tsx

@@ -399,6 +399,7 @@ export default flat({
       dispute: 'Dispute Amount',
       due: 'Due Amount',
       stake: 'Stake Amount',
+      token: 'Token Balance',
       name: 'Name',
       email: 'Email',
       phone: 'Phone',

package/src/locales/zh.tsx

@@ -389,6 +389,7 @@ export default flat({
       refund: '退款金额',
       stake: '质押金额',
       dispute: '争议金额',
+      token: '链上余额',
       due: '欠款金额',
       name: '名称',
       email: '电子邮件',

package/src/pages/admin/customers/customers/detail.tsx

@@ -167,6 +167,7 @@ export default function CustomerDetail(props: { id: string }) {
             <InfoMetric label={t('common.updatedAt')} value={formatTime(data.customer.updated_at)} divider />
             <InfoMetric label={t('admin.customer.spent')} value={<BalanceList data={data.summary.paid} />} divider />
             <InfoMetric label={t('admin.customer.stake')} value={<BalanceList data={data.summary.stake} />} divider />
+            <InfoMetric label={t('admin.customer.token')} value={<BalanceList data={data.summary.token} />} divider />
             <InfoMetric label={t('admin.customer.due')} value={<BalanceList data={data.summary.due} />} divider />
             <InfoMetric
               label={t('admin.customer.refund')}

package/src/pages/customer/index.tsx

@@ -179,6 +179,7 @@ export default function CustomerHome() {
                   sx={{ width: '100%' }}>
                   <InfoMetric label={t('admin.customer.spent')} value={<BalanceList data={data.summary.paid} />} />
                   <InfoMetric label={t('admin.customer.stake')} value={<BalanceList data={data.summary.stake} />} />
+                  <InfoMetric label={t('admin.customer.token')} value={<BalanceList data={data.summary.token} />} />
                   <InfoMetric label={t('admin.customer.due')} value={<BalanceList data={data.summary.due} />} />
                   <InfoMetric label={t('admin.customer.refund')} value={<BalanceList data={data.summary.refunded} />} />
                 </Stack>