payment-kit 1.13.92 → 1.13.93

package/api/src/index.ts

@@ -26,6 +26,7 @@ import collectHandlers from './routes/connect/collect';
 import payHandlers from './routes/connect/pay';
 import setupHandlers from './routes/connect/setup';
 import subscribeHandlers from './routes/connect/subscribe';
+import updateHandlers from './routes/connect/update';
 import { initialize } from './store/models';
 import { sequelize } from './store/sequelize';
 
@@ -53,6 +54,7 @@ handlers.attach(Object.assign({ app: router }, collectHandlers));
 handlers.attach(Object.assign({ app: router }, payHandlers));
 handlers.attach(Object.assign({ app: router }, setupHandlers));
 handlers.attach(Object.assign({ app: router }, subscribeHandlers));
+handlers.attach(Object.assign({ app: router }, updateHandlers));
 
 router.use('/api', routes);
 

package/api/src/libs/audit.ts

@@ -16,24 +16,21 @@ export async function createEvent(scope: string, type: LiteralUnion<EventType, s
     data.previous_attributes = pick(model._previousDataValues, options.fields);
   }
 
-  const event = await Event.create(
-    {
-      type,
-      api_version: API_VERSION,
-      livemode: !!model.livemode,
-      object_id: model.id,
-      object_type: scope,
-      data,
-      request: {
-        // FIXME:
-        id: '',
-        idempotency_key: '',
-      },
-      metadata: {},
-      pending_webhooks: 99, // force all events goto the event queue
+  const event = await Event.create({
+    type,
+    api_version: API_VERSION,
+    livemode: !!model.livemode,
+    object_id: model.id,
+    object_type: scope,
+    data,
+    request: {
+      // FIXME:
+      id: '',
+      idempotency_key: '',
     },
-    { transaction: null }
-  );
+    metadata: {},
+    pending_webhooks: 99, // force all events goto the event queue
+  });
 
   events.emit('event.created', { id: event.id });
   events.emit(event.type, data.object);
@@ -61,24 +58,21 @@ export async function createStatusEvent(
   }
 
   const suffix = config[data.object.status];
-  const event = await Event.create(
-    {
-      type: [prefix, suffix].join('.'),
-      api_version: API_VERSION,
-      livemode: !!model.livemode,
-      object_id: model.id,
-      object_type: scope,
-      data,
-      request: {
-        // FIXME:
-        id: '',
-        idempotency_key: '',
-      },
-      metadata: {},
-      pending_webhooks: 99, // force all events goto the event queue
+  const event = await Event.create({
+    type: [prefix, suffix].join('.'),
+    api_version: API_VERSION,
+    livemode: !!model.livemode,
+    object_id: model.id,
+    object_type: scope,
+    data,
+    request: {
+      // FIXME:
+      id: '',
+      idempotency_key: '',
     },
-    { transaction: null }
-  );
+    metadata: {},
+    pending_webhooks: 99, // force all events goto the event queue
+  });
 
   events.emit('event.created', { id: event.id });
   events.emit(event.type, data.object);

package/api/src/libs/payment.ts

@@ -8,15 +8,7 @@ import { BN, fromUnitToToken } from '@ocap/util';
 import cloneDeep from 'lodash/cloneDeep';
 import type { LiteralUnion } from 'type-fest';
 
-import {
-  CheckoutSession,
-  Invoice,
-  PaymentCurrency,
-  PaymentIntent,
-  PaymentMethod,
-  TCustomer,
-  TLineItemExpanded,
-} from '../store/models';
+import { Invoice, PaymentCurrency, PaymentIntent, PaymentMethod, TCustomer, TLineItemExpanded } from '../store/models';
 import type { TPaymentCurrency } from '../store/models/payment-currency';
 import { blocklet, wallet } from './auth';
 import { OCAP_PAYMENT_TX_TYPE } from './util';
@@ -209,7 +201,7 @@ export async function getPaymentDetail(userDid: string, invoice: Invoice): Promi
 }
 
 export async function getTokenLimitsForDelegation(
-  checkoutSession: CheckoutSession,
+  items: TLineItemExpanded[],
   paymentMethod: PaymentMethod,
   paymentCurrency: PaymentCurrency,
   address: string,
@@ -218,7 +210,6 @@ export async function getTokenLimitsForDelegation(
   const client = paymentMethod.getOcapClient();
   const { state } = await client.getDelegateState({ address });
 
-  const items = checkoutSession.line_items as TLineItemExpanded[];
   const hasMetered = items.some((x) => x.price.recurring?.usage_type === 'metered');
   const allowance = hasMetered ? '0' : amount;
 

package/api/src/libs/session.ts

@@ -109,7 +109,7 @@ export function getSubscriptionCreateSetup(items: TLineItemExpanded[], currencyI
     setup = setup.add(new BN(unit).mul(new BN(x.quantity)));
     if (price.type === 'recurring') {
       if (trialInDays === 0) {
-        subscription = setup.add(new BN(unit).mul(new BN(x.quantity)));
+        subscription = subscription.add(new BN(unit).mul(new BN(x.quantity)));
       }
     }
   });

package/api/src/libs/util.ts

@@ -152,15 +152,18 @@ export function getTxMetadata(extra: Record<string, any> = {}): any {
   };
 }
 
-export function getMetadataFromQuery(query: Record<string, any> = {}): Record<string, any> {
-  const metadata: Record<string, any> = {};
+export function getDataObjectFromQuery(
+  query: Record<string, any> = {},
+  prefix: string = 'metadata'
+): Record<string, any> {
+  const result: Record<string, any> = {};
   Object.keys(query).forEach((key) => {
-    if (key.startsWith('metadata.') && query[key]) {
-      metadata[key.replace('metadata.', '')] = query[key];
+    if (key.startsWith(`${prefix}.`) && query[key]) {
+      result[key.replace(`${prefix}.`, '')] = query[key];
     }
   });
 
-  return metadata;
+  return result;
 }
 
 // @FIXME: 这个应该封装在某个通用类库里面 @jianchao @wangshijun

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

@@ -33,7 +33,7 @@ import {
   isLineItemAligned,
 } from '../libs/session';
 import { getDaysUntilDue } from '../libs/subscription';
-import { createCodeGenerator, formatMetadata, getMetadataFromQuery } from '../libs/util';
+import { createCodeGenerator, formatMetadata, getDataObjectFromQuery } from '../libs/util';
 import { invoiceQueue } from '../queues/invoice';
 import { paymentQueue } from '../queues/payment';
 import { subscriptionQueue } from '../queues/subscription';
@@ -304,6 +304,13 @@ export async function startCheckoutSessionFromPaymentLink(id: string, req: Reque
     raw.created_via = 'portal';
     raw.currency_id = link.currency_id || req.currency.id;
     raw.payment_link_id = link.id;
+    raw.subscription_data = merge(
+      {
+        description: '',
+        trial_period_days: 0,
+      },
+      getDataObjectFromQuery(req.query, 'subscription_data')
+    );
 
     if (link.after_completion?.hosted_confirmation?.custom_message) {
       raw.payment_intent_data = {
@@ -332,7 +339,7 @@ export async function startCheckoutSessionFromPaymentLink(id: string, req: Reque
       } else {
         raw.metadata = {
           ...link.metadata,
-          ...getMetadataFromQuery(req.query),
+          ...getDataObjectFromQuery(req.query),
           days_until_due: getDaysUntilDue(req.query),
           passport: await checkPassportForPaymentLink(link),
           preview: '1',
@@ -341,7 +348,7 @@ export async function startCheckoutSessionFromPaymentLink(id: string, req: Reque
     } else {
       raw.metadata = {
         ...link.metadata,
-        ...getMetadataFromQuery(req.query),
+        ...getDataObjectFromQuery(req.query),
         days_until_due: getDaysUntilDue(req.query),
         passport: await checkPassportForPaymentLink(link),
       };
@@ -629,6 +636,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           pending_setup_intent: setupIntent?.id,
         });
       } else {
+        // FIXME: @wangshijun respect all checkoutSession.subscription_data fields
         const setup = getSubscriptionCreateSetup(lineItems, paymentCurrency.id, trialInDays);
         subscription = await Subscription.create({
           livemode: !!checkoutSession.livemode,
@@ -637,7 +645,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           status: 'incomplete',
           current_period_start: setup.period.start,
           current_period_end: setup.period.end,
-          billing_cycle_anchor: setup.cycle.anchor,
+          billing_cycle_anchor: checkoutSession.subscription_data?.billing_cycle_anchor || setup.cycle.anchor,
           start_date: dayjs().unix(),
           trail_end: setup.trail.end,
           trail_start: setup.trail.start,
@@ -651,7 +659,8 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           default_payment_method_id: paymentMethod.id,
           cancel_at_period_end: false,
           collection_method: 'charge_automatically',
-          proration_behavior: 'none',
+          description: checkoutSession.subscription_data?.description || '',
+          proration_behavior: checkoutSession.subscription_data?.proration_behavior || 'none',
           payment_behavior: 'default_incomplete',
           days_until_due: checkoutSession.metadata?.days_until_due,
           metadata: checkoutSession.metadata as any,
@@ -688,7 +697,6 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
       }
     }
 
-    let isPaymentFromBalance = false;
     const fastCheckoutAmount = getFastCheckoutAmount(
       lineItems,
       checkoutSession.mode,
@@ -709,11 +717,23 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
       customer,
       amount: fastCheckoutAmount,
     });
-    if (balance.sufficient) {
-      if (checkoutSession.mode === 'payment' && paymentIntent) {
-        await paymentIntent.update({ status: 'requires_capture' });
-        logger.info(`CheckoutSession ${checkoutSession.id} will pay from balance ${paymentIntent?.id}`);
+    // if we can complete purchase without any wallet interaction
+    const delegation = await isDelegationSufficientForPayment({
+      paymentMethod,
+      paymentCurrency,
+      userDid: customer.did,
+      amount: fastCheckoutAmount,
+    });
 
+    if (checkoutSession.mode === 'payment' && paymentIntent) {
+      if (balance.sufficient) {
+        logger.info(`CheckoutSession ${checkoutSession.id} will pay from balance ${paymentIntent?.id}`);
+      }
+      if (delegation.sufficient) {
+        logger.info(`CheckoutSession ${checkoutSession.id} will pay from delegation ${paymentIntent?.id}`);
+      }
+      if (balance.sufficient || delegation.sufficient) {
+        await paymentIntent.update({ status: 'requires_capture' });
         const { invoice } = await ensureInvoiceForCheckout({ checkoutSession, customer, paymentIntent });
         if (invoice) {
           await invoice.update({ auto_advance: true, payment_settings: paymentSettings });
@@ -724,22 +744,15 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
             job: { paymentIntentId: paymentIntent.id, paymentSettings, retryOnError: false },
           });
         }
-
-        isPaymentFromBalance = true;
       }
     }
 
-    // if we can complete purchase without any wallet interaction
-    const delegation = await isDelegationSufficientForPayment({
-      paymentMethod,
-      paymentCurrency,
-      userDid: customer.did,
-      amount: fastCheckoutAmount,
-    });
-
-    if (delegation.sufficient) {
-      // all subscription payments are done after delegation
-      if (checkoutSession.mode === 'subscription' && subscription) {
+    // all subscription payments are done after delegation
+    if (checkoutSession.mode === 'subscription' && subscription) {
+      if (
+        delegation.sufficient || // we can pay from delegation
+        (balance.sufficient && ['NO_TOKEN', 'NO_ENOUGH_TOKEN'].includes(delegation.reason as string)) // we can pay from balance
+      ) {
         await subscription.update({ payment_settings: paymentSettings });
 
         const { invoice } = await ensureInvoiceForCheckout({ checkoutSession, customer, subscription });
@@ -752,28 +765,17 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           runAt: subscription.trail_end || subscription.current_period_end,
         });
       }
-      if (checkoutSession.mode === 'payment' && paymentIntent && !isPaymentFromBalance) {
-        logger.info(`CheckoutSession ${checkoutSession.id} will pay from delegation ${paymentIntent?.id}`);
-        const { invoice } = await ensureInvoiceForCheckout({ checkoutSession, customer, paymentIntent });
-        if (invoice) {
-          await invoice.update({ auto_advance: true, payment_settings: paymentSettings });
-          invoiceQueue.push({ id: invoice.id, job: { invoiceId: invoice.id, retryOnError: false } });
-        } else {
-          await paymentIntent.update({ status: 'requires_capture' });
-          paymentQueue.push({
-            id: paymentIntent.id,
-            job: { paymentIntentId: paymentIntent.id, paymentSettings, retryOnError: false },
-          });
-        }
-      }
-      if (checkoutSession.mode === 'setup' && setupIntent && subscription) {
+    }
+
+    if (checkoutSession.mode === 'setup' && setupIntent && subscription) {
+      if (delegation.sufficient) {
         await setupIntent.update({ status: 'succeeded', ...paymentSettings });
         await subscription.update({
           status: subscription.trail_end ? 'trialing' : 'active',
           payment_settings: paymentSettings,
         });
         await checkoutSession.update({ status: 'complete', payment_status: 'no_payment_required' });
-        logger.info(`CheckoutSession ${checkoutSession.id} updated on payment done ${paymentIntent?.id}`);
+        logger.info(`CheckoutSession ${checkoutSession.id} updated on setup done ${setupIntent.id}`);
       }
     }
 

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

@@ -25,17 +25,17 @@ export default {
     const { invoiceId } = extraParams;
     const { invoice, paymentIntent, paymentCurrency, paymentMethod } = await ensureInvoiceForCollect(invoiceId);
 
-    const tokens = [{ address: paymentCurrency.contract as string, value: invoice.amount_due }];
-    // @ts-ignore
-    const itx: TransferV3Tx = {
-      outputs: [{ owner: wallet.address, tokens, assets: [] }],
-      data: getTxMetadata({
-        paymentIntentId: paymentIntent.id,
-        invoiceId,
-      }),
-    };
-
     if (paymentMethod.type === 'arcblock') {
+      const tokens = [{ address: paymentCurrency.contract as string, value: invoice.amount_due }];
+      // @ts-ignore
+      const itx: TransferV3Tx = {
+        outputs: [{ owner: wallet.address, tokens, assets: [] }],
+        data: getTxMetadata({
+          paymentIntentId: paymentIntent.id,
+          invoiceId,
+        }),
+      };
+
       return {
         prepareTx: {
           type: 'TransferV3Tx',
@@ -93,11 +93,11 @@ export default {
       // cleanup the queue
       let exist = await paymentQueue.get(paymentIntent.id);
       if (exist) {
-        await paymentQueue.cancel(paymentIntent.id);
+        await paymentQueue.delete(paymentIntent.id);
       }
       exist = await invoiceQueue.get(invoice.id);
       if (exist) {
-        await invoiceQueue.cancel(invoice.id);
+        await invoiceQueue.delete(invoice.id);
       }
 
       if (invoice.subscription_id) {

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

@@ -32,21 +32,18 @@ export default {
     }
 
     if (paymentMethod.type === 'arcblock') {
+      const items = checkoutSession.line_items as TLineItemExpanded[];
       const address = toDelegateAddress(userDid, wallet.address);
-      const amount = getFastCheckoutAmount(
-        checkoutSession.line_items as TLineItemExpanded[],
-        checkoutSession.mode,
-        paymentCurrency.id
-      );
+      const amount = getFastCheckoutAmount(items, checkoutSession.mode, paymentCurrency.id);
 
-      const tokenLimits = await getTokenLimitsForDelegation(
-        checkoutSession,
+      const tokenLimits = await getTokenLimitsForDelegation(items, paymentMethod, paymentCurrency, address, amount);
+      const tokenRequirements = await getTokenRequirements({
+        items,
+        mode: checkoutSession.mode,
+        includeFreeTrial: !!checkoutSession.subscription_data?.trial_period_days,
         paymentMethod,
         paymentCurrency,
-        address,
-        amount
-      );
-      const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
+      });
 
       return {
         signature: {

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

@@ -4,7 +4,12 @@ import { estimateMaxGasForTx, hasStakedForGas } from '../../integrations/blockch
 import { blocklet } from '../../libs/auth';
 import dayjs from '../../libs/dayjs';
 import logger from '../../libs/logger';
-import { getFastCheckoutAmount, getPriceUintAmountByCurrency, getStatementDescriptor } from '../../libs/session';
+import {
+  expandLineItems,
+  getFastCheckoutAmount,
+  getPriceUintAmountByCurrency,
+  getStatementDescriptor,
+} from '../../libs/session';
 import type { TLineItemExpanded } from '../../store/models';
 import { CheckoutSession } from '../../store/models/checkout-session';
 import { Customer } from '../../store/models/customer';
@@ -14,6 +19,7 @@ import { PaymentCurrency } from '../../store/models/payment-currency';
 import { PaymentIntent } from '../../store/models/payment-intent';
 import { PaymentMethod } from '../../store/models/payment-method';
 import { Price } from '../../store/models/price';
+import { Product } from '../../store/models/product';
 import { SetupIntent } from '../../store/models/setup-intent';
 import { Subscription } from '../../store/models/subscription';
 import { SubscriptionItem } from '../../store/models/subscription-item';
@@ -25,6 +31,7 @@ type Result = {
   subscription?: Subscription;
   paymentCurrency: PaymentCurrency;
   paymentMethod: PaymentMethod;
+  invoice?: Invoice;
 };
 
 export async function ensureCheckoutSession(checkoutSessionId: string) {
@@ -440,30 +447,30 @@ export async function ensureInvoiceAndItems({
 export async function ensureInvoiceForCollect(invoiceId: string) {
   const invoice = await Invoice.findByPk(invoiceId);
   if (!invoice) {
-    throw new Error('Invoice not found');
+    throw new Error(`Invoice ${invoiceId} not found`);
   }
   if (invoice.status === 'paid') {
-    throw new Error('Invoice already paid');
+    throw new Error(`Invoice ${invoiceId} already paid`);
   }
   if (invoice.status === 'void') {
-    throw new Error('Invoice already void');
+    throw new Error(`Invoice ${invoiceId} already void`);
   }
   if (invoice.status === 'draft') {
-    throw new Error('Invoice is draft');
+    throw new Error(`Invoice ${invoiceId} is draft`);
   }
 
   const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
   if (!paymentIntent) {
-    throw new Error('Payment intent not found for invoice');
+    throw new Error(`Payment intent not found for invoice ${invoiceId}`);
   }
   if (paymentIntent.status === 'canceled') {
-    throw new Error('Payment intent already canceled');
+    throw new Error(`Payment intent already canceled for invoice ${invoiceId}`);
   }
   if (paymentIntent.status === 'succeeded') {
-    throw new Error('Payment intent already succeeded');
+    throw new Error(`Payment intent already succeeded for invoice ${invoiceId}`);
   }
   if (paymentIntent.status === 'processing') {
-    throw new Error('Payment intent processing');
+    throw new Error(`Payment intent processing for invoice ${invoiceId}`);
   }
 
   const paymentCurrency = await PaymentCurrency.findByPk(paymentIntent.currency_id);
@@ -501,18 +508,23 @@ export function getAuthPrincipalClaim(method: PaymentMethod, action: string) {
   };
 }
 
-export async function getTokenRequirements(
-  checkoutSession: CheckoutSession,
-  paymentMethod: PaymentMethod,
-  paymentCurrency: PaymentCurrency
-) {
+export type TokenRequirementArgs = {
+  items: TLineItemExpanded[];
+  mode: string;
+  includeFreeTrial: boolean;
+  paymentMethod: PaymentMethod;
+  paymentCurrency: PaymentCurrency;
+};
+
+export async function getTokenRequirements({
+  items,
+  mode,
+  includeFreeTrial,
+  paymentMethod,
+  paymentCurrency,
+}: TokenRequirementArgs) {
   const tokenRequirements = [];
-  let amount = getFastCheckoutAmount(
-    checkoutSession.line_items as TLineItemExpanded[],
-    checkoutSession.mode,
-    paymentCurrency.id,
-    !!checkoutSession.subscription_data?.trial_period_days
-  );
+  let amount = getFastCheckoutAmount(items, mode, paymentCurrency.id, !!includeFreeTrial);
 
   // If the app has not staked, we need to add the gas fee to the amount
   if ((await hasStakedForGas(paymentMethod)) === false) {
@@ -538,3 +550,52 @@ export async function getTokenRequirements(
 
   return tokenRequirements;
 }
+
+export async function ensureSubscription(subscriptionId: string): Promise<Result> {
+  const subscription = await Subscription.findByPk(subscriptionId);
+  if (!subscription) {
+    throw new Error(`Subscription not found: ${subscriptionId}`);
+  }
+  if (subscription.status !== 'past_due') {
+    throw new Error(`Subscription ${subscriptionId} is not in past_due status`);
+  }
+
+  const paymentCurrencyId = subscription.currency_id;
+  const paymentMethodId = subscription.default_payment_method_id;
+
+  const [paymentMethod, paymentCurrency, invoice] = await Promise.all([
+    PaymentMethod.findByPk(paymentMethodId),
+    PaymentCurrency.findByPk(paymentCurrencyId),
+    Invoice.findByPk(subscription.latest_invoice_id),
+  ]);
+  if (!paymentMethod) {
+    throw new Error(`Payment method not found for subscription ${subscriptionId}`);
+  }
+  if (!paymentCurrency) {
+    throw new Error(`Payment currency not found for subscription ${subscriptionId}`);
+  }
+
+  if (['arcblock', 'ethereum'].includes(paymentMethod.type) === false) {
+    throw new Error(`Payment method ${paymentMethod.type} should not be here`);
+  }
+
+  const items = (await SubscriptionItem.findAll({ where: { subscription_id: subscription.id } })).map((x) =>
+    x.toJSON()
+  );
+  const products = (await Product.findAll()).map((x) => x.toJSON());
+  const prices = (await Price.findAll()).map((x) => x.toJSON());
+  // @ts-ignore
+  expandLineItems(items, products, prices);
+  // @ts-ignore
+  subscription.items = await Price.expand(items);
+
+  return {
+    // @ts-ignore
+    checkoutSession: null,
+    subscription,
+    paymentMethod,
+    paymentCurrency,
+    // @ts-ignore
+    invoice,
+  };
+}

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

@@ -34,20 +34,17 @@ export default {
     }
 
     if (paymentMethod.type === 'arcblock') {
+      const items = checkoutSession.line_items as TLineItemExpanded[];
       const address = toDelegateAddress(userDid, wallet.address);
-      const amount = getFastCheckoutAmount(
-        checkoutSession.line_items as TLineItemExpanded[],
-        checkoutSession.mode,
-        paymentCurrency.id
-      );
-      const tokenLimits = await getTokenLimitsForDelegation(
-        checkoutSession,
+      const amount = getFastCheckoutAmount(items, checkoutSession.mode, paymentCurrency.id);
+      const tokenLimits = await getTokenLimitsForDelegation(items, paymentMethod, paymentCurrency, address, amount);
+      const tokenRequirements = await getTokenRequirements({
+        items,
+        mode: checkoutSession.mode,
+        includeFreeTrial: !!checkoutSession.subscription_data?.trial_period_days,
         paymentMethod,
         paymentCurrency,
-        address,
-        amount
-      );
-      const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
+      });
 
       return {
         signature: {