payment-kit 1.22.31 → 1.23.0

package/api/src/store/migrations/20251120-add-token-config-to-currencies.ts

@@ -0,0 +1,20 @@
+import { DataTypes } from 'sequelize';
+import { safeApplyColumnChanges, type Migration } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  await safeApplyColumnChanges(context, {
+    payment_currencies: [
+      {
+        name: 'token_config',
+        field: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
+      },
+    ],
+  });
+};
+
+export const down: Migration = async ({ context }) => {
+  await context.removeColumn('payment_currencies', 'token_config');
+};

package/api/src/store/migrations/20251204-add-chain-fields.ts

@@ -0,0 +1,74 @@
+import { DataTypes } from 'sequelize';
+import { createIndexIfNotExists, safeApplyColumnChanges, type Migration } from '../migrate';
+
+export const up: Migration = async ({ context }) => {
+  // Add new columns to credit_transactions table
+  await safeApplyColumnChanges(context, {
+    credit_transactions: [
+      {
+        name: 'transfer_status',
+        field: {
+          type: DataTypes.ENUM('pending', 'completed', 'failed'),
+          allowNull: true,
+        },
+      },
+      {
+        name: 'transfer_hash',
+        field: {
+          type: DataTypes.STRING(255),
+          allowNull: true,
+        },
+      },
+    ],
+  });
+
+  // Add new columns to credit_grants table for on-chain operations
+  await safeApplyColumnChanges(context, {
+    credit_grants: [
+      {
+        name: 'chain_status',
+        field: {
+          type: DataTypes.ENUM(
+            'mint_pending',
+            'mint_completed',
+            'mint_failed',
+            'burn_pending',
+            'burn_completed',
+            'burn_failed'
+          ),
+          allowNull: true,
+        },
+      },
+      {
+        name: 'chain_detail',
+        field: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
+      },
+    ],
+  });
+
+  // Add indexes for efficient querying
+  await createIndexIfNotExists(
+    context,
+    'credit_transactions',
+    ['transfer_status'],
+    'idx_credit_transactions_transfer_status'
+  );
+  await createIndexIfNotExists(context, 'credit_grants', ['chain_status'], 'idx_credit_grants_chain_status');
+};
+
+export const down: Migration = async ({ context }) => {
+  // Remove indexes
+  await context.removeIndex('credit_transactions', 'idx_credit_transactions_transfer_status');
+  await context.removeIndex('credit_grants', 'idx_credit_grants_chain_status');
+
+  // Remove columns from credit_transactions
+  await context.removeColumn('credit_transactions', 'transfer_hash');
+  await context.removeColumn('credit_transactions', 'transfer_status');
+
+  // Remove columns from credit_grants
+  await context.removeColumn('credit_grants', 'chain_detail');
+  await context.removeColumn('credit_grants', 'chain_status');
+};

package/api/src/store/models/credit-grant.ts

@@ -6,9 +6,10 @@ import type { LiteralUnion } from 'type-fest';
 import { createEvent } from '../../libs/audit';
 import { createIdGenerator } from '../../libs/util';
 import dayjs from '../../libs/dayjs';
-import { CreditGrantApplicabilityConfig } from './types';
+import { CreditGrantApplicabilityConfig, CreditGrantChainDetail, CreditGrantChainStatus } from './types';
 import logger from '../../libs/logger';
 import { PaymentCurrency, TPaymentCurrency } from './payment-currency';
+import { Meter, TMeter } from './meter';
 
 const CREDIT_GRANT_STATUS_EVENTS = {
   depleted: 'depleted',
@@ -18,6 +19,7 @@ const CREDIT_GRANT_STATUS_EVENTS = {
 
 type CreditGrantSummary = {
   paymentCurrency: TPaymentCurrency;
+  meter?: TMeter;
   totalAmount: string;
   remainingAmount: string;
   grantCount: number;
@@ -62,6 +64,10 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
   declare status: LiteralUnion<'pending' | 'granted' | 'depleted' | 'expired' | 'voided', string>;
   declare remaining_amount: string; // 剩余金额
 
+  // On-chain credit token operation fields
+  declare chain_status?: CreditGrantChainStatus;
+  declare chain_detail?: CreditGrantChainDetail;
+
   // 审计字段
   declare created_by?: string;
   declare updated_by?: string;
@@ -148,6 +154,21 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
       type: DataTypes.STRING(32),
       allowNull: false,
     },
+    chain_status: {
+      type: DataTypes.ENUM(
+        'mint_pending',
+        'mint_completed',
+        'mint_failed',
+        'burn_pending',
+        'burn_completed',
+        'burn_failed'
+      ),
+      allowNull: true,
+    },
+    chain_detail: {
+      type: DataTypes.JSON,
+      allowNull: true,
+    },
     created_by: {
       type: DataTypes.STRING(40),
       allowNull: true,
@@ -267,6 +288,16 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
     return true;
   }
 
+  // check if Credit Grant has on-chain token (mint completed)
+  public hasOnchainToken(): boolean {
+    return CreditGrant.hasOnchainToken(this);
+  }
+
+  // Static version that works with plain objects
+  public static hasOnchainToken(grant: { chain_status?: string | null }): boolean {
+    return grant.chain_status === 'mint_completed';
+  }
+
   public static initialize(sequelize: any) {
     this.init(this.GENESIS_ATTRIBUTES, {
       sequelize,
@@ -282,9 +313,6 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
       hooks: {
         afterCreate: (model: CreditGrant, options) => {
           createEvent('CreditGrant', 'customer.credit_grant.created', model, options).catch(console.error);
-          if (!model.effective_at || model.effective_at <= Math.floor(Date.now() / 1000)) {
-            createEvent('CreditGrant', 'customer.credit_grant.granted', model, options).catch(console.error);
-          }
         },
         afterUpdate: (model: CreditGrant, options) => {
           createEvent('CreditGrant', 'customer.credit_grant.updated', model, options).catch(console.error);
@@ -404,10 +432,7 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
     currencyId?: string[] | string;
     priceIds?: string[];
   }): Promise<Record<string, CreditGrantSummary>> {
-    const summary: Record<
-      string,
-      { paymentCurrency: TPaymentCurrency; totalAmount: string; remainingAmount: string; grantCount: number }
-    > = {};
+    const summary: Record<string, CreditGrantSummary> = {};
 
     let targetCurrencyIds: string[] = [];
     if (searchCurrencyId) {
@@ -427,9 +452,28 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
       targetCurrencyIds = grantsWithCurrency.map((grant: any) => grant.currency_id);
     }
 
+    const currencies = await PaymentCurrency.scope('withRechargeConfig').findAll({
+      where: {
+        id: {
+          [Op.in]: Array.from(new Set(targetCurrencyIds)),
+        },
+      },
+    });
+    const currencyMap = new Map(currencies.map((c) => [c.id, c]));
+
+    // Query meters for credit currencies
+    const meters = await Meter.findAll({
+      where: {
+        currency_id: {
+          [Op.in]: Array.from(new Set(targetCurrencyIds)),
+        },
+      },
+    });
+    const meterMap = new Map(meters.map((m) => [m.currency_id, m]));
+
     await Promise.all(
       targetCurrencyIds.map(async (currencyId: string) => {
-        const paymentCurrency = await PaymentCurrency.scope('withRechargeConfig').findByPk(currencyId);
+        const paymentCurrency = currencyMap.get(currencyId);
         if (!paymentCurrency) {
           return null;
         }
@@ -437,6 +481,7 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
           return null;
         }
 
+        const meter = meterMap.get(currencyId);
         const availableGrants = await this.getAvailableCreditsForCustomer(customerId, currencyId, priceIds);
 
         if (availableGrants.length > 0) {
@@ -450,8 +495,9 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
             grantCount += 1;
           });
 
-          const result = {
+          const result: CreditGrantSummary = {
             paymentCurrency,
+            meter,
             totalAmount,
             remainingAmount,
             grantCount,
@@ -462,6 +508,7 @@ export class CreditGrant extends Model<InferAttributes<CreditGrant>, InferCreati
         }
         summary[currencyId] = {
           paymentCurrency,
+          meter,
           totalAmount: '0',
           remainingAmount: '0',
           grantCount: 0,

package/api/src/store/models/credit-transaction.ts

@@ -29,6 +29,10 @@ export class CreditTransaction extends Model<
   declare description?: string;
   declare metadata?: Record<string, any>;
 
+  // Token transfer fields
+  declare transfer_status?: 'pending' | 'completed' | 'failed' | null;
+  declare transfer_hash?: string;
+
   declare created_at: CreationOptional<Date>;
   declare updated_at: CreationOptional<Date>;
 
@@ -88,6 +92,14 @@ export class CreditTransaction extends Model<
       type: DataTypes.JSON,
       allowNull: true,
     },
+    transfer_status: {
+      type: DataTypes.ENUM('pending', 'completed', 'failed'),
+      allowNull: true,
+    },
+    transfer_hash: {
+      type: DataTypes.STRING(255),
+      allowNull: true,
+    },
     created_at: {
       type: DataTypes.DATE,
       defaultValue: DataTypes.NOW,
@@ -107,7 +119,12 @@ export class CreditTransaction extends Model<
       tableName: 'credit_transactions',
       createdAt: 'created_at',
       updatedAt: 'updated_at',
-      indexes: [{ fields: ['customer_id'] }, { fields: ['credit_grant_id'] }, { fields: ['source'] }],
+      indexes: [
+        { fields: ['customer_id'] },
+        { fields: ['credit_grant_id'] },
+        { fields: ['source'] },
+        { fields: ['transfer_status'] },
+      ],
       hooks: {
         afterCreate: (model: CreditTransaction, options) =>
           createEvent('CreditTransaction', 'customer.credit_transaction.created', model, options).catch(console.error),

package/api/src/store/models/meter-event.ts

@@ -373,27 +373,52 @@ export class MeterEvent extends Model<InferAttributes<MeterEvent>, InferCreation
     const summary: GroupedBN = {};
     const detail: GroupedStrList = {};
 
-    await Promise.all(
-      events.map(async (event) => {
-        const meter = await Meter.getMeterByEventName(event.event_name);
-        if (!meter) {
-          return;
-        }
-        const paymentCurrency = await PaymentCurrency.findByPk(meter.currency_id);
-        if (!paymentCurrency) {
-          return;
-        }
-        const currencyId = meter.currency_id as string;
-        if (searchCurrencyId && searchCurrencyId !== currencyId) {
-          return;
-        }
-        if (!detail[currencyId]) {
-          detail[currencyId] = [];
-        }
-        summary[currencyId] = new BN(summary[currencyId] || '0').add(new BN(event.credit_pending)).toString();
-        detail[currencyId]!.push(event.id);
-      })
-    );
+    if (events.length === 0) {
+      return [summary, detail, events];
+    }
+
+    const eventNames = [...new Set(events.map((e) => e.event_name))];
+    const meters = await Meter.findAll({
+      where: {
+        event_name: {
+          [Op.in]: eventNames,
+        },
+      },
+    });
+    const meterMap = new Map(meters.map((m) => [m.event_name, m]));
+
+    const currencyIds = [...new Set(meters.map((m) => m.currency_id).filter((id): id is string => Boolean(id)))];
+    const currencies =
+      currencyIds.length > 0
+        ? await PaymentCurrency.findAll({
+            where: {
+              id: {
+                [Op.in]: currencyIds,
+              },
+            },
+          })
+        : [];
+    const currencyMap = new Map(currencies.map((c) => [c.id, c]));
+
+    events.forEach((event) => {
+      const meter = meterMap.get(event.event_name);
+      if (!meter || !meter.currency_id) {
+        return;
+      }
+      const paymentCurrency = currencyMap.get(meter.currency_id);
+      if (!paymentCurrency) {
+        return;
+      }
+      const currencyId = meter.currency_id as string;
+      if (searchCurrencyId && searchCurrencyId !== currencyId) {
+        return;
+      }
+      if (!detail[currencyId]) {
+        detail[currencyId] = [];
+      }
+      summary[currencyId] = new BN(summary[currencyId] || '0').add(new BN(event.credit_pending)).toString();
+      detail[currencyId]!.push(event.id);
+    });
 
     return [summary, detail, events];
   }
@@ -424,14 +449,12 @@ export class MeterEvent extends Model<InferAttributes<MeterEvent>, InferCreation
     if (subscriptionId) {
       where[Op.and] = where[Op.and] || [];
       where[Op.and].push(
-        Sequelize.where(Sequelize.fn('json_extract', Sequelize.col('payload'), '$.subscription_id'), subscriptionId)
+        Sequelize.where(Sequelize.literal("json_extract(payload, '$.subscription_id')"), subscriptionId)
       );
     }
     if (customerId) {
       where[Op.and] = where[Op.and] || [];
-      where[Op.and].push(
-        Sequelize.where(Sequelize.fn('json_extract', Sequelize.col('payload'), '$.customer_id'), customerId)
-      );
+      where[Op.and].push(Sequelize.where(Sequelize.literal("json_extract(payload, '$.customer_id')"), customerId));
     }
 
     return this._getPendingAmounts(where, currencyId);

package/api/src/store/models/payment-currency.ts

@@ -46,6 +46,7 @@ export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, Inf
   declare vault_config?: VaultConfig;
   declare type: LiteralUnion<'standard' | 'credit', string>;
   declare recharge_config?: RechargeConfig;
+  declare token_config?: Record<string, any> | null;
 
   public static readonly GENESIS_ATTRIBUTES = {
     id: {
@@ -144,6 +145,10 @@ export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, Inf
           type: DataTypes.JSON,
           allowNull: true,
         },
+        token_config: {
+          type: DataTypes.JSON,
+          allowNull: true,
+        },
       },
       {
         sequelize,
@@ -210,7 +215,12 @@ export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, Inf
     );
     return count > 0;
   }
-  public static async createForMeter(meter: any, paymentMethodId: string) {
+  public static async createForMeter(
+    meter: any,
+    paymentMethodId: string,
+    tokenConfig?: Record<string, any>,
+    options?: { decimal?: number }
+  ) {
     const existingCurrency = await this.findOne({
       where: {
         type: 'credit',
@@ -222,6 +232,8 @@ export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, Inf
     if (existingCurrency) {
       return existingCurrency;
     }
+
+    const decimal = options?.decimal ?? 10;
     const currency = await this.create({
       type: 'credit',
       payment_method_id: paymentMethodId,
@@ -229,8 +241,8 @@ export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, Inf
       description: `Credit for ${meter.unit}`,
       symbol: meter.unit,
       logo: getUrl('/methods/arcblock.png'), // 默认credit图标
-      decimal: 2,
-      maximum_precision: 2,
+      decimal,
+      maximum_precision: decimal,
       minimum_payment_amount: '1',
       maximum_payment_amount: '100000000000',
       active: true,
@@ -242,13 +254,28 @@ export class PaymentCurrency extends Model<InferAttributes<PaymentCurrency>, Inf
         meter_event_name: meter.event_name,
         created_by_meter: true,
       },
+      token_config: tokenConfig,
     });
 
     return currency;
   }
 
   public isCredit(): boolean {
-    return this.type === 'credit';
+    return PaymentCurrency.isCredit(this);
+  }
+
+  public isOnChainCredit(): boolean {
+    return PaymentCurrency.isOnChainCredit(this);
+  }
+
+  // Static version that works with plain objects
+  public static isCredit(currency: { type?: string | null }): boolean {
+    return currency.type === 'credit';
+  }
+
+  // Static version that works with plain objects
+  public static isOnChainCredit(currency: { type?: string | null; token_config?: any }): boolean {
+    return PaymentCurrency.isCredit(currency) && !!currency.token_config;
   }
 }
 

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

@@ -32,7 +32,11 @@ export class Refund extends Model<InferAttributes<Refund>, InferCreationAttribut
 
   declare metadata?: Record<string, any>;
 
-  declare status: LiteralUnion<'pending' | 'requires_action' | 'failed' | 'canceled' | 'succeeded', string>;
+  // processing: refund transfer succeeded, waiting for credit burn (for onchain credit only)
+  declare status: LiteralUnion<
+    'pending' | 'requires_action' | 'processing' | 'failed' | 'canceled' | 'succeeded',
+    string
+  >;
   declare reason?: LiteralUnion<
     'duplicate' | 'requested_by_customer' | 'requested_by_admin' | 'fraudulent' | 'expired_uncaptured_charge',
     string
@@ -199,7 +203,13 @@ export class Refund extends Model<InferAttributes<Refund>, InferCreationAttribut
           afterCreate: (model: Refund, options) =>
             createEvent('Refund', 'refund.created', model, options).catch(console.error),
           afterUpdate: (model: Refund, options) =>
-            createStatusEvent('Refund', 'refund', { canceled: 'canceled', succeeded: 'succeeded' }, model, options),
+            createStatusEvent(
+              'Refund',
+              'refund',
+              { canceled: 'canceled', processing: 'processing', succeeded: 'succeeded' },
+              model,
+              options
+            ),
           afterDestroy: (model: Refund, options) =>
             createEvent('Refund', 'refund.deleted', model, options).catch(console.error),
         },

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

@@ -835,3 +835,51 @@ export type StructuredSourceDataField = {
 };
 
 export type SourceData = SimpleSourceData | StructuredSourceDataField[];
+
+// Credit Grant on-chain operation status (combined mint, burn and transfer status)
+export type CreditGrantChainStatus =
+  | 'mint_pending'
+  | 'mint_completed'
+  | 'mint_failed'
+  | 'burn_pending'
+  | 'burn_completed'
+  | 'burn_failed'
+  | 'transfer_completed' // for expired credits transferred to system wallet
+  | 'transfer_failed';
+
+// Credit Grant chain operation details
+export type CreditGrantChainDetail = {
+  // Mint operation details
+  mint?: {
+    hash?: string;
+    at?: number; // timestamp
+    error?: string;
+    failed_at?: number;
+  };
+  // Burn operation details (for expiration)
+  burn?: {
+    hash?: string;
+    at?: number; // timestamp
+    amount?: string;
+    error?: string;
+    failed_at?: number;
+  };
+  // Expired transfer operation details (for expiration - transfer to system wallet)
+  expired_transfer?: {
+    hash?: string;
+    at?: number; // timestamp
+    amount?: string;
+    error?: string;
+    failed_at?: number;
+  };
+  // Refund burn operation details
+  refund?: {
+    id?: string; // refund id
+    burn_hash?: string;
+    burned_amount?: string;
+    system_retained?: string; // amount retained by system (consumed portion)
+    burn_error?: string;
+  };
+  // Voided reason
+  voided_reason?: 'refund' | 'expired' | 'manual';
+};

package/api/third.d.ts

@@ -2,6 +2,8 @@ declare module 'vite-plugin-blocklet';
 
 declare module '@blocklet/sdk/service/notification';
 
+declare module '@blocklet/sdk/service/blocklet';
+
 declare module 'express-history-api-fallback';
 
 declare module 'express-async-errors';

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.22.31",
+  "version": "1.23.0",
   "scripts": {
     "dev": "blocklet dev --open",
     "lint": "tsc --noEmit && eslint src api/src --ext .mjs,.js,.jsx,.ts,.tsx",
@@ -53,13 +53,14 @@
     "@arcblock/react-hooks": "^3.2.11",
     "@arcblock/ux": "^3.2.11",
     "@arcblock/validator": "^1.27.14",
+    "@arcblock/vc": "^1.27.14",
     "@blocklet/did-space-js": "^1.2.9",
     "@blocklet/error": "^0.3.4",
     "@blocklet/js-sdk": "^1.17.4",
     "@blocklet/logger": "^1.17.4",
-    "@blocklet/payment-broker-client": "1.22.31",
-    "@blocklet/payment-react": "1.22.31",
-    "@blocklet/payment-vendor": "1.22.31",
+    "@blocklet/payment-broker-client": "1.23.0",
+    "@blocklet/payment-react": "1.23.0",
+    "@blocklet/payment-vendor": "1.23.0",
     "@blocklet/sdk": "^1.17.4",
     "@blocklet/ui-react": "^3.2.11",
     "@blocklet/uploader": "^0.3.14",
@@ -129,7 +130,7 @@
   "devDependencies": {
     "@abtnode/types": "^1.17.4",
     "@arcblock/eslint-config-ts": "^0.3.3",
-    "@blocklet/payment-types": "1.22.31",
+    "@blocklet/payment-types": "1.23.0",
     "@types/cookie-parser": "^1.4.9",
     "@types/cors": "^2.8.19",
     "@types/debug": "^4.1.12",
@@ -176,5 +177,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "fc03087134d309474256b122eba125e4a01dd6c0"
+  "gitHead": "d791ace5b095ff78f4b7328dac8a9575e6b2e265"
 }

package/src/components/customer/credit-overview.tsx

@@ -173,7 +173,7 @@ export default function CreditOverview({ customerId, settings, mode = 'portal' }
                 pb: 2,
               }}>
               <Typography variant="h6" component="div">
-                {currency.name}
+                {grantData.meter?.name || currency.name} ({currency.symbol})
               </Typography>
               {showRecharge && (
                 <SplitButton