payment-kit 1.13.99 → 1.13.100

package/api/src/queues/invoice.ts

@@ -42,15 +42,12 @@ export const handleInvoice = async (job: InvoiceJob) => {
   }
 
   // no payment required
-  if (invoice.total === '0') {
+  if (invoice.amount_remaining === '0') {
     logger.warn(`invoice does not require payment: ${job.invoiceId}`);
 
     await invoice.update({
       paid: true,
       status: 'paid',
-      amount_due: '0',
-      amount_paid: '0',
-      amount_remaining: '0',
       attempt_count: invoice.attempt_count + 1,
       attempted: true,
       status_transitions: { ...invoice.status_transitions, paid_at: dayjs().unix() },
@@ -101,9 +98,9 @@ export const handleInvoice = async (job: InvoiceJob) => {
     // TODO: support partial payment from user balance
     paymentIntent = await PaymentIntent.create({
       livemode: !!invoice.livemode,
-      amount: invoice.total,
+      amount: invoice.amount_remaining,
       amount_received: '0',
-      amount_capturable: invoice.total,
+      amount_capturable: '0',
       customer_id: invoice.customer_id,
       description: descriptionMap[invoice.billing_reason] || '',
       currency_id: invoice.currency_id,
@@ -160,7 +157,7 @@ export const startInvoiceQueue = async () => {
     where: {
       status: 'open',
       collection_method: 'charge_automatically',
-      amount_due: { [Op.gt]: '0' },
+      amount_remaining: { [Op.gt]: '0' },
     },
   });
 

package/api/src/queues/payment.ts

@@ -5,7 +5,7 @@ import dayjs from '../libs/dayjs';
 import CustomError from '../libs/error';
 import { events } from '../libs/event';
 import logger from '../libs/logger';
-import { getGasPayerExtra, isBalanceSufficientForPayment, isDelegationSufficientForPayment } from '../libs/payment';
+import { getGasPayerExtra, isDelegationSufficientForPayment } from '../libs/payment';
 import createQueue from '../libs/queue';
 import { getDaysUntilDue, getDueUnit } from '../libs/subscription';
 import { MAX_RETRY_COUNT, MIN_RETRY_MAIL, getNextRetry } from '../libs/util';
@@ -24,7 +24,7 @@ type PaymentJob = {
   retryOnError?: boolean;
 };
 
-export const handlePaymentSucceed = async (paymentIntent: PaymentIntent, invoiceUpdates: any = {}) => {
+export const handlePaymentSucceed = async (paymentIntent: PaymentIntent) => {
   let invoice;
   if (paymentIntent.invoice_id) {
     invoice = await Invoice.findByPk(paymentIntent.invoice_id);
@@ -46,15 +46,13 @@ export const handlePaymentSucceed = async (paymentIntent: PaymentIntent, invoice
     await invoice.update({
       paid: true,
       status: 'paid',
-      amount_due: '0',
       amount_paid: paymentIntent.amount,
       amount_remaining: '0',
       attempt_count: invoice.attempt_count + 1,
       attempted: true,
       status_transitions: { ...invoice.status_transitions, paid_at: dayjs().unix() },
-      ...invoiceUpdates,
     });
-    logger.info(`Invoice ${invoice.id} updated on payment done: ${paymentIntent.id}`, invoiceUpdates);
+    logger.info(`Invoice ${invoice.id} updated on payment done: ${paymentIntent.id}`);
   }
 
   if (invoice.subscription_id) {
@@ -297,37 +295,6 @@ export const handlePayment = async (job: PaymentJob) => {
     const client = paymentMethod.getOcapClient();
     const payer = paymentSettings?.payment_method_options.arcblock?.payer;
 
-    // if we can complete purchase with customer balance
-    const balance = isBalanceSufficientForPayment({
-      paymentMethod,
-      paymentCurrency,
-      customer,
-      amount: paymentIntent.amount,
-    });
-    if (balance.sufficient) {
-      const tmp = await customer.decreaseTokenBalance(paymentCurrency.id, paymentIntent.amount);
-      logger.info(`PaymentIntent capture done: ${paymentIntent.id} with customer balance`, tmp);
-      await paymentIntent.update({
-        status: 'succeeded',
-        amount: '0', // update payment intent amount to 0
-        amount_received: '0',
-        payment_details: {
-          arcblock: {
-            tx_hash: '',
-            payer: payer as string,
-          },
-        },
-      });
-
-      await handlePaymentSucceed(paymentIntent, {
-        starting_token_balance: tmp.starting,
-        ending_token_balance: tmp.ending,
-      });
-      return;
-    }
-
-    // FIXME: support partial payment from balance
-
     // check balance before capture with transaction
     result = await isDelegationSufficientForPayment({
       paymentMethod,

package/api/src/queues/subscription.ts

@@ -113,6 +113,7 @@ const handleSubscriptionInvoice = async (
 
   const { invoice } = await ensureInvoiceAndItems({
     customer,
+    currency,
     subscription,
     trailing: false,
     metered: true,

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

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/indent */
+/* eslint-disable prettier/prettier */
 import { BN } from '@ocap/util';
 
 import { estimateMaxGasForTx, hasStakedForGas } from '../../integrations/blockchain/stake';
@@ -252,8 +254,10 @@ export async function ensureInvoiceForCheckout({
     };
   }
 
+  const currency = await PaymentCurrency.findByPk(checkoutSession.currency_id);
   const { invoice, items } = await ensureInvoiceAndItems({
     customer,
+    currency: currency as PaymentCurrency,
     subscription,
     lineItems: await Price.expand(checkoutSession.line_items, { product: true }),
     trailing: !!checkoutSession.subscription_data?.trial_period_days,
@@ -301,19 +305,37 @@ export async function ensureInvoiceForCheckout({
 
 export async function ensureInvoiceAndItems({
   customer,
+  currency,
   subscription,
   props,
   lineItems,
   trailing,
   metered,
+  applyCredit = true,
 }: {
   customer: Customer;
+    currency: PaymentCurrency;
   subscription?: Subscription;
   props: TInvoice;
   lineItems: TLineItemExpanded[];
   trailing: boolean; // do we have trailing
   metered: boolean; // is the quantity metered
+    applyCredit?: boolean; // should we apply customer credit?
 }): Promise<{ invoice: Invoice; items: InvoiceItem[] }> {
+  if (props.total === '0') {
+    throw new Error('Invoice total should not be 0');
+  }
+
+  // apply possible balance to invoice
+  let remaining = props.total;
+  let result = { starting: {}, ending: {} };
+  if (applyCredit) {
+    const balance = customer.getBalanceToApply(currency.id, props.total);
+    result = await customer.decreaseTokenBalance(currency.id, balance);
+    remaining = new BN(props.total).sub(new BN(balance)).toString();
+    logger.info(`Invoice will use customer credit: ${props.total}:${remaining}`, result);
+  }
+
   const invoice = await Invoice.create({
     livemode: props.livemode,
     number: await customer.getInvoiceNumber(),
@@ -336,19 +358,20 @@ export async function ensureInvoiceAndItems({
     subscription_id: subscription?.id,
     checkout_session_id: props.checkout_session_id || '',
 
+    total: props.total || '0',
     subtotal: props.total || '0',
-    subtotal_excluding_tax: props.total || '0',
     tax: '0',
-    total: props.total || '0',
-    amount_due: props.total || '0',
+    subtotal_excluding_tax: props.total || '0',
+
+    amount_due: remaining,
     amount_paid: '0',
-    amount_remaining: props.total || '0',
+    amount_remaining: remaining,
     amount_shipping: '0',
 
     starting_balance: '0',
     ending_balance: '0',
-    starting_token_balance: {},
-    ending_token_balance: {},
+    starting_token_balance: result.starting,
+    ending_token_balance: result.ending,
 
     attempt_count: 0,
     attempted: false,

package/api/src/routes/subscriptions.ts

@@ -508,6 +508,11 @@ const createProration = async (subscription: TSubscription, setup: ReturnType<ty
     throw new Error('Subscription should have latest invoice when create proration');
   }
 
+  const customer = await Customer.findByPk(subscription.customer_id);
+  if (!customer) {
+    throw new Error('Subscription should have customer when create proration');
+  }
+
   // 1. get last invoice, and invoice items, filter invoice items that are in licensed recurring mode
   const invoiceItems = await InvoiceItem.findAll({ where: { invoice_id: lastInvoice.id, proration: false } });
   const invoiceItemsExpanded = await Price.expand(invoiceItems.map((x) => x.toJSON()));
@@ -520,11 +525,11 @@ const createProration = async (subscription: TSubscription, setup: ReturnType<ty
   const prorationStart = lastInvoice.period_start;
   const prorationEnd = lastInvoice.period_end;
   const prorationRate = Math.ceil(((prorationEnd - now) / (prorationEnd - prorationStart)) * 1000000);
-  let totalProrationAmount = new BN(0);
+  let proration = new BN(0);
   const prorations = await Promise.all(
     prorationItems.map((x: TLineItemExpanded & { [key: string]: any }) => {
       const unitAmount = getPriceUintAmountByCurrency(x.price, subscription.currency_id);
-      const prorationAmount = new BN(unitAmount)
+      const amount = new BN(unitAmount)
         .mul(new BN(x.quantity))
         .mul(new BN(prorationRate))
         .div(new BN(1000000))
@@ -533,13 +538,13 @@ const createProration = async (subscription: TSubscription, setup: ReturnType<ty
         subscription: subscription.id,
         invoice: x.invoice_id,
         invoiceItem: x.id,
-        prorationAmount,
+        amount,
       });
-      totalProrationAmount = totalProrationAmount.add(new BN(prorationAmount));
+      proration = proration.add(new BN(amount));
 
       return {
         price_id: x.price_id,
-        amount: `-${prorationAmount}`,
+        amount: `-${amount}`,
         quantity: x.quantity,
         // @ts-ignore
         description: `Unused time on ${x.price.product.name} after ${dayjs().format('lll')}`,
@@ -564,14 +569,20 @@ const createProration = async (subscription: TSubscription, setup: ReturnType<ty
   });
 
   // 5. adjust invoice total && update customer token balance
-  let total = new BN(setup.amount.setup);
-  let credit = new BN(setup.amount.setup);
-  if (total.gte(totalProrationAmount)) {
-    total = total.sub(totalProrationAmount).toString();
-    credit = '0';
+  const total = setup.amount.setup;
+  let remaining = setup.amount.setup;
+  let newCredit = '0';
+  let appliedCredit = '0';
+  if (new BN(total).gte(proration)) {
+    // Proration amount is less than total, all proration are used,
+    remaining = new BN(total).sub(proration).toString();
+    // Besides, we need to try to apply customer credit
+    appliedCredit = customer.getBalanceToApply(subscription.currency_id, remaining);
+    remaining = new BN(remaining).sub(new BN(appliedCredit)).toString();
   } else {
-    credit = totalProrationAmount.sub(total).toString();
-    total = '0';
+    // Proration amount is greater than total, we need to increase customer credit
+    newCredit = proration.sub(new BN(total)).toString();
+    remaining = '0';
   }
 
   logger.info('subscription proration result', {
@@ -579,16 +590,20 @@ const createProration = async (subscription: TSubscription, setup: ReturnType<ty
     prorationStart,
     prorationEnd,
     prorationRate,
-    totalProrationAmount,
+    proration,
     total,
-    credit,
+    remaining,
+    newCredit,
+    appliedCredit,
   });
 
   return {
     lastInvoice,
     total,
-    credit,
+    remaining,
     prorations,
+    newCredit,
+    appliedCredit,
   };
 };
 
@@ -738,16 +753,21 @@ router.put('/:id', authPortal, async (req, res) => {
         const prorationBehavior = updates.proration_behavior || subscription.proration_behavior || 'none';
         if (prorationBehavior === 'create_prorations') {
           // 1. create proration
-          const { lastInvoice, total, credit, prorations } = await createProration(subscription, setup);
+          const { lastInvoice, remaining, newCredit, appliedCredit, prorations } = await createProration(
+            subscription,
+            setup
+          );
 
           // 2. create new invoice: amount according to new subscription items
           // 3. create new invoice items: amount according to new subscription items
           const result = await ensureInvoiceAndItems({
             customer,
+            currency: paymentCurrency,
             subscription,
             trailing: false,
             metered: false,
             lineItems: newItems,
+            applyCredit: false,
             props: {
               status: 'draft',
               livemode: subscription.livemode,
@@ -755,7 +775,7 @@ router.put('/:id', authPortal, async (req, res) => {
               statement_descriptor: lastInvoice.statement_descriptor,
               period_start: setup.period.start,
               period_end: setup.period.end,
-              auto_advance: true, // FIXME: this should be calculated dynamically
+              auto_advance: true,
               billing_reason: 'subscription_update',
               total: setup.amount.setup,
               currency_id: paymentCurrency.id,
@@ -793,32 +813,33 @@ router.put('/:id', authPortal, async (req, res) => {
           });
 
           // 5. adjust invoice total or update customer credit balance
-          if (total !== '0') {
-            await invoice.update({
-              status: 'open',
-              subtotal: total,
-              subtotal_excluding_tax: total,
-              total,
-              amount_due: total,
-              amount_remaining: total,
+          const invoiceUpdates: Partial<Invoice> = {
+            status: 'open',
+            amount_due: remaining,
+            amount_remaining: remaining,
+          };
+          if (appliedCredit !== '0') {
+            const creditResult = await customer.decreaseTokenBalance(paymentCurrency.id, appliedCredit);
+            invoiceUpdates.starting_token_balance = creditResult.starting;
+            invoiceUpdates.ending_token_balance = creditResult.ending;
+            logger.info('customer credit applied to invoice after proration', {
+              subscription: req.params.id,
+              appliedCredit,
+              creditResult,
             });
-            logger.info('subscription proration used on invoice', { subscription: req.params.id, total });
           }
-          if (credit !== '0') {
-            const balance = await customer.increaseTokenBalance(paymentCurrency.id, credit);
-            await invoice.update({
-              status: 'open',
-              subtotal: '0',
-              subtotal_excluding_tax: '0',
-              total: '0',
-              amount_due: '0',
-              amount_remaining: '0',
-              starting_token_balance: balance.starting,
-              ending_token_balance: balance.ending,
+          if (newCredit !== '0') {
+            const creditResult = await customer.increaseTokenBalance(paymentCurrency.id, newCredit);
+            invoiceUpdates.starting_token_balance = creditResult.starting;
+            invoiceUpdates.ending_token_balance = creditResult.ending;
+            logger.info('subscription proration credit applied to customer', {
+              subscription: req.params.id,
+              newCredit,
+              creditResult,
             });
-            logger.info('subscription proration credit to customer', { subscription: req.params.id, credit });
           }
 
+          await invoice.update(invoiceUpdates);
           await subscription.update(updates);
 
           // 6. process the invoice as usual: push into queue
@@ -989,10 +1010,7 @@ router.post('/:id/update', authPortal, async (req, res) => {
     }
 
     // validate the request
-    const { newItems, addedItems, deletedItems, updatedItems } = await validateSubscriptionUpdateRequest(
-      subscription,
-      req.body.items
-    );
+    const { newItems } = await validateSubscriptionUpdateRequest(subscription, req.body.items);
 
     // do the simulation
     const setup = getSubscriptionCreateSetup(newItems, subscription.currency_id, 0);
@@ -1001,12 +1019,11 @@ router.post('/:id/update', authPortal, async (req, res) => {
     return res.json({
       setup,
       total: result.total,
-      credit: result.credit,
+      newCredit: result.newCredit,
+      appliedCredit: result.appliedCredit,
+      remaining: result.remaining,
       prorations: result.prorations,
       items: newItems,
-      addedItems,
-      deletedItems,
-      updatedItems,
     });
   } catch (err) {
     console.error(err);

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

@@ -154,7 +154,17 @@ export class Customer extends Model<InferAttributes<Customer>, InferCreationAttr
     return `${this.invoice_prefix}-${padStart(sequence.toString(), 4, '0')}`;
   }
 
-  public async decreaseTokenBalance(currencyId: string, amount: string) {
+  public getBalanceToApply(currencyId: string, amount: string) {
+    const tokens = this.token_balance || {};
+    const balance = tokens[currencyId] || '0';
+    return new BN(balance).lt(new BN(amount)) ? balance : amount;
+  }
+
+  public async decreaseTokenBalance(currencyId: string, amount: string, dryRun: boolean = false) {
+    if (amount === '0') {
+      return { starting: {}, ending: {} };
+    }
+
     const tokens = this.token_balance || {};
     const balance = tokens[currencyId] || '0';
     if (new BN(balance).lt(new BN(amount))) {
@@ -164,17 +174,21 @@ export class Customer extends Model<InferAttributes<Customer>, InferCreationAttr
     const starting = cloneDeep(tokens);
     // NOTE: new object is required to trick sequelize to update the field
     const ending = { ...starting, [currencyId]: new BN(balance).sub(new BN(amount)).toString() };
-    await this.update({ token_balance: ending });
+    if (!dryRun) {
+      await this.update({ token_balance: ending });
+    }
     return { starting, ending };
   }
 
-  public async increaseTokenBalance(currencyId: string, amount: string) {
+  public async increaseTokenBalance(currencyId: string, amount: string, dryRun: boolean = false) {
     const tokens = this.token_balance || {};
     const balance = tokens[currencyId] || '0';
     const starting = cloneDeep(tokens);
     // NOTE: new object is required to trick sequelize to update the field
     const ending = { ...starting, [currencyId]: new BN(balance).add(new BN(amount)).toString() };
-    await this.update({ token_balance: ending });
+    if (!dryRun) {
+      await this.update({ token_balance: ending });
+    }
     return { starting, ending };
   }
 

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

@@ -64,13 +64,14 @@ export class Invoice extends Model<InferAttributes<Invoice>, InferCreationAttrib
   declare subtotal_excluding_tax: string;
   declare tax: string;
   declare total: string;
-  declare amount_due: string;
+
+  declare amount_due: string; // total - amount_paid
   declare amount_paid: string;
-  declare amount_remaining: string;
+  declare amount_remaining: string; // amount_due - amount_paid
   declare amount_shipping: string;
 
-  declare starting_balance: string;
-  declare ending_balance: string;
+  declare starting_balance: string; // usd credit
+  declare ending_balance: string; // usd credit
   declare starting_token_balance?: Record<string, string>; // token balances
   declare ending_token_balance?: Record<string, string>; // token balances
 

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.99",
+  "version": "1.13.100",
   "scripts": {
     "dev": "COMPONENT_STORE_URL=https://test.store.blocklet.dev blocklet dev",
     "eject": "vite eject",
@@ -110,7 +110,7 @@
     "@abtnode/types": "1.16.21",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.99",
+    "@did-pay/types": "1.13.100",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -149,5 +149,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "abb8f6d451350b07f5755fe4d599e8a438b3cfe1"
+  "gitHead": "d2334fda5fe27f35f3a7d89a1de0251972f20613"
 }

package/src/pages/customer/subscription/update.tsx

@@ -54,7 +54,7 @@ export default function CustomerSubscriptionUpdate() {
     loading: false,
     priceId: '',
     total: '',
-    credit: '',
+    remaining: '',
     setup: null,
     prorations: [],
     items: [],
@@ -86,7 +86,7 @@ export default function CustomerSubscriptionUpdate() {
 
       const deleted = data.subscription.items.find((si) => data.table.items.some((ti) => ti.price_id === si.price_id));
       if (deleted!.price_id === priceId) {
-        setState({ priceId: '', total: '', credit: '', setup: null, prorations: [], items: [] });
+        setState({ priceId: '', total: '', remaining: '', setup: null, prorations: [], items: [] });
         return;
       }
 
@@ -108,7 +108,7 @@ export default function CustomerSubscriptionUpdate() {
       setState({ priceId, ...result });
     } catch (err) {
       Toast.error(formatError(err));
-      setState({ priceId: '', total: '', credit: '', setup: null, prorations: [], items: [] });
+      setState({ priceId: '', total: '', remaining: '', setup: null, prorations: [], items: [] });
     }
   };
 
@@ -249,7 +249,7 @@ export default function CustomerSubscriptionUpdate() {
               {t('customer.upgrade.due')}
             </Typography>
             <Typography component="p" style={{ fontWeight: 'bold' }}>
-              {fromUnitToToken(state.total, data.subscription.paymentCurrency.decimal)}{' '}
+              {fromUnitToToken(state.remaining, data.subscription.paymentCurrency.decimal)}{' '}
               {data.subscription.paymentCurrency.symbol}
             </Typography>
           </Stack>