payment-kit 1.13.59 → 1.13.61

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

@@ -33,7 +33,7 @@ export async function ensureStakedForGas() {
 
         const result = await client.getForgeState({});
         const { token, txConfig } = result.state;
-        const holding = account.tokens.find((x: any) => x.address === token.address);
+        const holding = (account?.tokens || []).find((x: any) => x.address === token.address);
         if (toBN(holding?.value || '0').lte(toBN(txConfig.txGas.minStake))) {
           logger.info(`not enough balance to stake for gas on chain ${host}`);
           continue;
@@ -53,3 +53,24 @@ export async function ensureStakedForGas() {
     }
   }
 }
+
+export async function hasStakedForGas(method: PaymentMethod, sender = wallet.address) {
+  if (method.type === 'arcblock') {
+    const client = method.getOcapClient();
+    const address = toStakeAddress(sender, sender);
+    const { state } = await client.getStakeState({ address });
+    return !!state;
+  }
+
+  return true;
+}
+
+export async function estimateMaxGasForTx(method: PaymentMethod, typeUrl = 'fg:t:delegate') {
+  if (method.type === 'arcblock') {
+    const client = method.getOcapClient();
+    const { estimate } = await client.estimateGas({ typeUrl });
+    return estimate.max;
+  }
+
+  return '0';
+}

package/api/src/jobs/payment.ts

@@ -1,6 +1,8 @@
+import { ensureStakedForGas } from '../integrations/blockchain/stake';
 import { wallet } from '../libs/auth';
 import dayjs from '../libs/dayjs';
 import CustomError from '../libs/error';
+import { events } from '../libs/event';
 import logger from '../libs/logger';
 import { getGasPayerExtra, isDelegationSufficientForPayment } from '../libs/payment';
 import createQueue from '../libs/queue';
@@ -246,6 +248,15 @@ export const paymentQueue = createQueue<PaymentJob>({
 });
 
 export const startPaymentQueue = async () => {
+  // Do gas stake as soon as possible after payment succeed
+  events.on('payment_intent.succeeded', async (paymentIntent: PaymentIntent) => {
+    const paymentMethod = await PaymentMethod.findByPk(paymentIntent.payment_method_id);
+    if (paymentMethod && paymentMethod.type === 'arcblock') {
+      ensureStakedForGas();
+    }
+  });
+
+  // Restore previous payments
   const payments = await PaymentIntent.findAll({
     where: {
       status: ['requires_capture', 'processing'],

package/api/src/libs/logger.ts

@@ -20,7 +20,7 @@ const init = (label: string): Logger => {
   return instance;
 };
 
-const logger = process.env.NODE_ENV === 'production' ? consoleLogger : init('app');
+const logger = process.env.BLOCKLET_ENV === 'production' ? consoleLogger : init('app');
 
 export default logger;
 

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

@@ -721,6 +721,7 @@ router.put('/:id/submit', user, ensureCheckoutSessionOpen, async (req, res) => {
           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 },

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

@@ -7,10 +7,8 @@ import { subscriptionQueue } from '../../jobs/subscription';
 import type { CallbackArgs } from '../../libs/auth';
 import { wallet } from '../../libs/auth';
 import { getGasPayerExtra } from '../../libs/payment';
-import { getFastCheckoutAmount } from '../../libs/session';
 import { getTxMetadata } from '../../libs/util';
-import type { TLineItemExpanded } from '../../store/models';
-import { ensureSetupIntent, getAuthPrincipalClaim } from './shared';
+import { ensureSetupIntent, getAuthPrincipalClaim, getTokenRequirements } from './shared';
 
 export default {
   action: 'setup',
@@ -32,12 +30,7 @@ export default {
     }
 
     if (paymentMethod.type === 'arcblock') {
-      const amount = getFastCheckoutAmount(
-        checkoutSession.line_items as TLineItemExpanded[],
-        checkoutSession.mode,
-        paymentCurrency,
-        !!checkoutSession.subscription_data?.trial_period_days
-      );
+      const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
 
       return {
         signature: {
@@ -57,7 +50,7 @@ export default {
           },
           nonce: checkoutSessionId,
           requirement: {
-            tokens: amount === '0' ? [] : [{ address: paymentCurrency.contract as string, value: amount }],
+            tokens: tokenRequirements,
           },
           chainInfo: {
             host: paymentMethod.settings?.arcblock?.api_host as string,

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

@@ -1,9 +1,10 @@
 import { BN } from '@ocap/util';
 
+import { estimateMaxGasForTx, hasStakedForGas } from '../../integrations/blockchain/stake';
 import { blocklet } from '../../libs/auth';
 import dayjs from '../../libs/dayjs';
 import logger from '../../libs/logger';
-import { getStatementDescriptor } from '../../libs/session';
+import { getFastCheckoutAmount, getStatementDescriptor } from '../../libs/session';
 import type { TLineItemExpanded } from '../../store/models';
 import { CheckoutSession } from '../../store/models/checkout-session';
 import { Customer } from '../../store/models/customer';
@@ -450,3 +451,41 @@ export function getAuthPrincipalClaim(method: PaymentMethod, action: string) {
     chainInfo,
   };
 }
+
+export async function getTokenRequirements(
+  checkoutSession: CheckoutSession,
+  paymentMethod: PaymentMethod,
+  paymentCurrency: PaymentCurrency
+) {
+  const tokenRequirements = [];
+  let amount = getFastCheckoutAmount(
+    checkoutSession.line_items as TLineItemExpanded[],
+    checkoutSession.mode,
+    paymentCurrency,
+    !!checkoutSession.subscription_data?.trial_period_days
+  );
+
+  // If the app has not staked, we need to add the gas fee to the amount
+  if ((await hasStakedForGas(paymentMethod)) === false) {
+    const maxGas = await estimateMaxGasForTx(paymentMethod);
+    // pay with the base currency? just add gas to it
+    if (paymentCurrency.is_base_currency) {
+      amount = new BN(amount).add(new BN(maxGas)).toString();
+      tokenRequirements.push({ address: paymentCurrency.contract as string, value: amount });
+    } else {
+      tokenRequirements.push({ address: paymentCurrency.contract as string, value: amount });
+      const baseCurrency = await PaymentCurrency.findOne({
+        where: { active: true, is_base_currency: true, payment_method_id: paymentMethod.id },
+      });
+      if (baseCurrency) {
+        tokenRequirements.push({ address: baseCurrency.contract as string, value: maxGas });
+      } else {
+        throw new Error('Base currency not found since app has not staked for gas');
+      }
+    }
+  } else {
+    tokenRequirements.push({ address: paymentCurrency.contract as string, value: amount });
+  }
+
+  return tokenRequirements;
+}

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

@@ -9,10 +9,8 @@ import { subscriptionQueue } from '../../jobs/subscription';
 import type { CallbackArgs } from '../../libs/auth';
 import { wallet } from '../../libs/auth';
 import { getGasPayerExtra } from '../../libs/payment';
-import { getFastCheckoutAmount } from '../../libs/session';
 import { getTxMetadata } from '../../libs/util';
-import type { TLineItemExpanded } from '../../store/models';
-import { ensureInvoiceForCheckout, ensurePaymentIntent, getAuthPrincipalClaim } from './shared';
+import { ensureInvoiceForCheckout, ensurePaymentIntent, getAuthPrincipalClaim, getTokenRequirements } from './shared';
 
 export default {
   action: 'subscription',
@@ -34,12 +32,7 @@ export default {
     }
 
     if (paymentMethod.type === 'arcblock') {
-      const amount = getFastCheckoutAmount(
-        checkoutSession.line_items as TLineItemExpanded[],
-        checkoutSession.mode,
-        paymentCurrency,
-        !!checkoutSession.subscription_data?.trial_period_days
-      );
+      const tokenRequirements = await getTokenRequirements(checkoutSession, paymentMethod, paymentCurrency);
 
       return {
         signature: {
@@ -59,7 +52,7 @@ export default {
           },
           nonce: checkoutSessionId,
           requirement: {
-            tokens: amount === '0' ? [] : [{ address: paymentCurrency.contract as string, value: amount }],
+            tokens: tokenRequirements,
           },
           chainInfo: {
             host: paymentMethod.settings?.arcblock?.api_host as string,

package/api/src/store/migrate.ts

@@ -1,14 +1,16 @@
+/* eslint-disable no-console */
 /* eslint-disable no-await-in-loop */
 import type { QueryInterface } from 'sequelize';
 import { SequelizeStorage, Umzug } from 'umzug';
 
+import logger from '../libs/logger';
 import { sequelize } from './sequelize';
 
 const umzug = new Umzug({
   migrations: { glob: ['migrations/*.{ts,js}', { cwd: __dirname }] },
   context: sequelize.getQueryInterface(),
   storage: new SequelizeStorage({ sequelize }),
-  logger: console,
+  logger,
 });
 
 export default function migrate() {
@@ -17,14 +19,18 @@ export default function migrate() {
 
 type ColumnChanges = Record<string, { name: string; field: any }[]>;
 export async function safeApplyColumnChanges(context: QueryInterface, changes: ColumnChanges) {
+  console.info('safeApplyColumnChanges', changes);
   for (const [table, columns] of Object.entries(changes)) {
     const schema = await context.describeTable(table);
     for (const { name, field } of columns) {
       if (!schema[name]) {
         await context.addColumn(table, name, field);
+        console.info('safeApplyColumnChanges.addColumn', { table, name, field });
         if (field.defaultValue) {
           await context.bulkUpdate(table, { [name]: field.defaultValue }, {});
         }
+      } else {
+        console.info('safeApplyColumnChanges.skip', { table, name, field });
       }
     }
   }

package/api/src/store/migrations/20230905-genesis.ts

@@ -1,52 +1,52 @@
 import type { Migration } from '../migrate';
 import models from '../models';
 
-export const up: Migration = async ({ context: queryInterface }) => {
-  await queryInterface.createTable('checkout_sessions', models.CheckoutSession.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('coupons', models.Coupon.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('customers', models.Customer.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('discounts', models.Discount.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('events', models.Event.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('invoices', models.Invoice.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('invoice_items', models.InvoiceItem.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('jobs', models.Job.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('payment_currencies', models.PaymentCurrency.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('payment_intents', models.PaymentIntent.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('payment_links', models.PaymentLink.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('payment_methods', models.PaymentMethod.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('prices', models.Price.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('products', models.Product.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('promotion_codes', models.PromotionCode.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('setup_intents', models.SetupIntent.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('subscription_items', models.SubscriptionItem.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('subscription_schedules', models.SubscriptionSchedule.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('subscriptions', models.Subscription.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('usage_records', models.UsageRecord.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('webhook_attempts', models.WebhookAttempt.GENESIS_ATTRIBUTES);
-  await queryInterface.createTable('webhook_endpoints', models.WebhookEndpoint.GENESIS_ATTRIBUTES);
+export const up: Migration = async ({ context }) => {
+  await context.createTable('checkout_sessions', models.CheckoutSession.GENESIS_ATTRIBUTES);
+  await context.createTable('coupons', models.Coupon.GENESIS_ATTRIBUTES);
+  await context.createTable('customers', models.Customer.GENESIS_ATTRIBUTES);
+  await context.createTable('discounts', models.Discount.GENESIS_ATTRIBUTES);
+  await context.createTable('events', models.Event.GENESIS_ATTRIBUTES);
+  await context.createTable('invoices', models.Invoice.GENESIS_ATTRIBUTES);
+  await context.createTable('invoice_items', models.InvoiceItem.GENESIS_ATTRIBUTES);
+  await context.createTable('jobs', models.Job.GENESIS_ATTRIBUTES);
+  await context.createTable('payment_currencies', models.PaymentCurrency.GENESIS_ATTRIBUTES);
+  await context.createTable('payment_intents', models.PaymentIntent.GENESIS_ATTRIBUTES);
+  await context.createTable('payment_links', models.PaymentLink.GENESIS_ATTRIBUTES);
+  await context.createTable('payment_methods', models.PaymentMethod.GENESIS_ATTRIBUTES);
+  await context.createTable('prices', models.Price.GENESIS_ATTRIBUTES);
+  await context.createTable('products', models.Product.GENESIS_ATTRIBUTES);
+  await context.createTable('promotion_codes', models.PromotionCode.GENESIS_ATTRIBUTES);
+  await context.createTable('setup_intents', models.SetupIntent.GENESIS_ATTRIBUTES);
+  await context.createTable('subscription_items', models.SubscriptionItem.GENESIS_ATTRIBUTES);
+  await context.createTable('subscription_schedules', models.SubscriptionSchedule.GENESIS_ATTRIBUTES);
+  await context.createTable('subscriptions', models.Subscription.GENESIS_ATTRIBUTES);
+  await context.createTable('usage_records', models.UsageRecord.GENESIS_ATTRIBUTES);
+  await context.createTable('webhook_attempts', models.WebhookAttempt.GENESIS_ATTRIBUTES);
+  await context.createTable('webhook_endpoints', models.WebhookEndpoint.GENESIS_ATTRIBUTES);
 };
 
-export const down: Migration = async ({ context: queryInterface }) => {
-  await queryInterface.dropTable('checkout_sessions');
-  await queryInterface.dropTable('coupons');
-  await queryInterface.dropTable('customers');
-  await queryInterface.dropTable('discounts');
-  await queryInterface.dropTable('events');
-  await queryInterface.dropTable('invoices');
-  await queryInterface.dropTable('invoice_items');
-  await queryInterface.dropTable('jobs');
-  await queryInterface.dropTable('payment_currencies');
-  await queryInterface.dropTable('payment_intents');
-  await queryInterface.dropTable('payment_links');
-  await queryInterface.dropTable('payment_methods');
-  await queryInterface.dropTable('prices');
-  await queryInterface.dropTable('products');
-  await queryInterface.dropTable('promotion_codes');
-  await queryInterface.dropTable('setup_intents');
-  await queryInterface.dropTable('subscription_items');
-  await queryInterface.dropTable('subscription_schedules');
-  await queryInterface.dropTable('subscriptions');
-  await queryInterface.dropTable('usage_records');
-  await queryInterface.dropTable('webhook_endpoints');
-  await queryInterface.dropTable('webhook_attempts');
+export const down: Migration = async ({ context }) => {
+  await context.dropTable('checkout_sessions');
+  await context.dropTable('coupons');
+  await context.dropTable('customers');
+  await context.dropTable('discounts');
+  await context.dropTable('events');
+  await context.dropTable('invoices');
+  await context.dropTable('invoice_items');
+  await context.dropTable('jobs');
+  await context.dropTable('payment_currencies');
+  await context.dropTable('payment_intents');
+  await context.dropTable('payment_links');
+  await context.dropTable('payment_methods');
+  await context.dropTable('prices');
+  await context.dropTable('products');
+  await context.dropTable('promotion_codes');
+  await context.dropTable('setup_intents');
+  await context.dropTable('subscription_items');
+  await context.dropTable('subscription_schedules');
+  await context.dropTable('subscriptions');
+  await context.dropTable('usage_records');
+  await context.dropTable('webhook_endpoints');
+  await context.dropTable('webhook_attempts');
 };

package/api/src/store/migrations/20230911-seeding.ts

@@ -158,8 +158,8 @@ const paymentMethods = [
   },
 ];
 
-export const up: Migration = async ({ context: queryInterface }) => {
-  await queryInterface.bulkInsert(
+export const up: Migration = async ({ context }) => {
+  await context.bulkInsert(
     'payment_methods',
     paymentMethods,
     {},
@@ -170,7 +170,7 @@ export const up: Migration = async ({ context: queryInterface }) => {
       metadata: { type: new Sequelize.JSON() },
     }
   );
-  await queryInterface.bulkInsert(
+  await context.bulkInsert(
     'payment_currencies',
     paymentCurrencies,
     {},
@@ -180,7 +180,7 @@ export const up: Migration = async ({ context: queryInterface }) => {
   );
 };
 
-export const down: Migration = async ({ context: queryInterface }) => {
-  await queryInterface.bulkDelete('payment_methods', {});
-  await queryInterface.bulkDelete('payment_currencies', {});
+export const down: Migration = async ({ context }) => {
+  await context.bulkDelete('payment_methods', {});
+  await context.bulkDelete('payment_currencies', {});
 };

package/api/src/store/migrations/20231017-pricing-table.ts

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

package/api/src/store/migrations/20231021-nft.ts

@@ -9,7 +9,6 @@ export const up: Migration = async ({ context }) => {
     checkout_sessions: [
       { name: 'nft_mint_settings', field: { type: DataTypes.JSON, allowNull: true } },
       { name: 'payment_intent_data', field: { type: DataTypes.JSON, allowNull: true } },
-      { name: 'nft_mint_settings', field: { type: DataTypes.JSON, allowNull: true } },
       { name: 'nft_mint_details', field: { type: DataTypes.JSON, allowNull: true } },
       {
         name: 'nft_mint_status',

package/api/src/store/sequelize.ts

@@ -10,6 +10,6 @@ import env from '../libs/env';
 // eslint-disable-next-line import/prefer-default-export
 export const sequelize = new Sequelize({
   dialect: 'sqlite',
-  logging: false,
+  logging: process.env.SQL_LOG === '1',
   storage: join(env.dataDir, 'payment-kit.db'),
 });

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.59
+version: 1.13.61
 logo: logo.png
 files:
   - dist
@@ -57,7 +57,6 @@ screenshots:
   - 5-admin-4.png
 components:
   - name: image-bin
-    required: true
     source:
       store: https://test.store.blocklet.dev
       name: image-bin

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "payment-kit",
-  "version": "1.13.59",
+  "version": "1.13.61",
   "scripts": {
     "dev": "blocklet dev",
     "eject": "vite eject",
@@ -104,7 +104,7 @@
     "@abtnode/types": "1.16.18",
     "@arcblock/eslint-config": "^0.2.4",
     "@arcblock/eslint-config-ts": "^0.2.4",
-    "@did-pay/types": "1.13.59",
+    "@did-pay/types": "1.13.61",
     "@types/cookie-parser": "^1.4.6",
     "@types/cors": "^2.8.17",
     "@types/dotenv-flow": "^3.3.3",
@@ -141,5 +141,5 @@
       "parser": "typescript"
     }
   },
-  "gitHead": "b07b1b9616fd429159569c18d9971cc654037da7"
+  "gitHead": "d765c5289d482e4265d25b82db551c695eada1e0"
 }