payment-kit 1.17.4 → 1.17.5

package/api/src/crons/currency.ts

@@ -19,7 +19,7 @@ export async function syncCurrencyLogo() {
 
   const updateLogo = (item: PaymentMethod | PaymentCurrency) => {
     const { logo } = item;
-    if (/\/methods\/(stripe|arcblock|ethereum)\.png$/.test(logo)) {
+    if (/\/methods\/(stripe|arcblock|ethereum|base)\.png$/.test(logo)) {
       const newLogo = getUrl(logo.replace(/^.*?(\/methods\/.*)$/, '$1'));
       promises.push((item as any).update({ logo: newLogo }));
     }

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

@@ -13,6 +13,7 @@ import { events } from '../../libs/event';
 import logger from '../../libs/logger';
 import { Customer, GroupedBN, PaymentCurrency, PaymentMethod, Subscription } from '../../store/models';
 import { fetchErc20Balance, fetchEtherBalance } from '../ethereum/token';
+import { EVM_CHAIN_TYPES } from '../../libs/constants';
 
 export async function ensureStakedForGas() {
   const currencies = await PaymentCurrency.findAll({ where: { active: true, is_base_currency: true } });
@@ -225,7 +226,7 @@ export async function getStakeSummaryByDid(did: string, livemode: boolean = true
 export async function getTokenSummaryByDid(
   did: string,
   livemode: boolean,
-  type: string = 'arcblock'
+  type: string | string[] = 'arcblock'
 ): Promise<GroupedBN> {
   const methods = await PaymentMethod.findAll({
     where: { type, livemode },
@@ -249,7 +250,7 @@ export async function getTokenSummaryByDid(
           }
         });
       }
-      if (method.type === 'ethereum' && isEthereumDid(did)) {
+      if (EVM_CHAIN_TYPES.includes(method.type) && isEthereumDid(did)) {
         const client = method.getEvmClient();
         await Promise.all(
           // @ts-ignore
@@ -278,7 +279,7 @@ export async function getTokenByAddress(
     const { tokens } = await client.getAccountTokens({ address });
     return tokens.find((t: any) => t.address === paymentCurrency.contract)?.balance;
   }
-  if (paymentMethod.type === 'ethereum') {
+  if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
     const client = paymentMethod.getEvmClient();
     if (paymentCurrency.contract) {
       const token = await fetchErc20Balance(client, paymentCurrency.contract, address);

package/api/src/libs/constants.ts

@@ -0,0 +1,3 @@
+export const EVM_CHAIN_TYPES = ['ethereum', 'base'];
+
+export const CHARGE_SUPPORTED_CHAIN_TYPES = ['arcblock', 'ethereum', 'base'];

package/api/src/libs/invoice.ts

@@ -36,6 +36,7 @@ import {
 } from './subscription';
 import logger from './logger';
 import { ensureOverdraftProtectionPrice } from './overdraft-protection';
+import { CHARGE_SUPPORTED_CHAIN_TYPES } from './constants';
 
 export function getCustomerInvoicePageUrl({
   invoiceId,
@@ -124,7 +125,7 @@ export async function getInvoiceShouldPayTotal(invoice: Invoice) {
     const setup = getSubscriptionCycleSetup(subscription.pending_invoice_item_interval, invoice.period_start);
     let offset = 0;
     let filterFunc = (item: any) => item;
-    if (['arcblock', 'ethereum'].includes(paymentMethod.type)) {
+    if (CHARGE_SUPPORTED_CHAIN_TYPES.includes(paymentMethod.type)) {
       switch (invoice.billing_reason) {
         case 'subscription_cancel':
           filterFunc = (item: any) => item.price?.recurring?.usage_type === 'metered';
@@ -231,7 +232,7 @@ export async function getSetupInvoice(
   if (!stakingProps?.tx_hash) {
     return null;
   }
-  if (paymentMethod.type !== 'arcblock') {
+  if (paymentMethod?.type !== 'arcblock') {
     return null;
   }
   const firstInvoice = await Invoice.findOne({
@@ -715,7 +716,7 @@ export async function ensureOverdraftProtectionInvoiceAndItems({
   props: Partial<TInvoice> & { period_start: number; period_end: number };
 }): Promise<{ invoice: Invoice; items: InvoiceItem[] }> {
   const { price, product } = await ensureOverdraftProtectionPrice(subscription.livemode);
-  const invoicePrice = price.currency_options.find((x: any) => x.currency_id === paymentIntent?.currency_id);
+  const invoicePrice = price?.currency_options?.find((x: any) => x.currency_id === paymentIntent?.currency_id);
 
   if (!subscription.overdraft_protection?.enabled) {
     throw new Error('create overdraft protection invoice skipped due to overdraft protection not enabled');
@@ -757,7 +758,7 @@ export async function ensureOverdraftProtectionInvoiceAndItems({
     total: invoicePrice.unit_amount || '0',
     items: [
       {
-        price_id: price.id,
+        price_id: price?.id || '',
         amount: invoicePrice.unit_amount || '0',
         quantity: 1,
         description: product?.name || '',
@@ -773,7 +774,7 @@ export async function ensureOverdraftProtectionInvoiceAndItems({
     },
   });
 
-  await Price.increment({ quantity_sold: 1 }, { where: { id: price.id } });
+  await Price.increment({ quantity_sold: 1 }, { where: { id: price?.id } });
   return result;
 }
 

package/api/src/libs/notification/template/subscription-renew-failed.ts

@@ -9,6 +9,7 @@ import { translate } from '../../../locales';
 import {
   CheckoutSession,
   Customer,
+  NFTMintChainType,
   Invoice,
   NftMintItem,
   PaymentIntent,
@@ -109,7 +110,7 @@ export class SubscriptionRenewFailedEmailTemplate
 
     const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
     const nftMintItem: NftMintItem | undefined = hasNft
-      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
+      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
       : undefined;
     const paymentInfo: string = `${fromUnitToToken(invoice.amount_remaining, paymentCurrency.decimal)} ${
       paymentCurrency.symbol
@@ -126,7 +127,7 @@ export class SubscriptionRenewFailedEmailTemplate
 
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
     const chainHost: string | undefined =
-      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.api_host;
+      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.api_host;
     const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
       subscriptionId: subscription.id,
       locale,
@@ -139,7 +140,7 @@ export class SubscriptionRenewFailedEmailTemplate
       action: 'pay',
     });
     const txHash: string | undefined =
-      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
+      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.tx_hash;
     const viewTxHashLink: string | undefined =
       hasNft && txHash
         ? getExplorerLink({

package/api/src/libs/notification/template/subscription-renewed.ts

@@ -8,6 +8,7 @@ import { translate } from '../../../locales';
 import {
   CheckoutSession,
   Customer,
+  NFTMintChainType,
   Invoice,
   NftMintItem,
   PaymentIntent,
@@ -98,7 +99,7 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
 
     const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
     const nftMintItem: NftMintItem | undefined = hasNft
-      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
+      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
       : undefined;
     const amountPaid = +fromUnitToToken(invoice.total, paymentCurrency.decimal);
     const paymentInfo: string = `${fromUnitToToken(invoice.total, paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
@@ -113,7 +114,7 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
 
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
     const chainHost: string | undefined =
-      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.api_host;
+      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.api_host;
     const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
       subscriptionId: subscription.id,
       locale,
@@ -125,7 +126,7 @@ export class SubscriptionRenewedEmailTemplate implements BaseEmailTemplate<Subsc
       locale,
     });
     const txHash: string | undefined =
-      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
+      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.tx_hash;
     const viewTxHashLink: string | undefined =
       hasNft && txHash
         ? getExplorerLink({

package/api/src/libs/notification/template/subscription-succeeded.ts

@@ -16,6 +16,7 @@ import {
   Subscription,
   PaymentCurrency,
   Invoice,
+  NFTMintChainType,
 } from '../../../store/models';
 import { getCustomerInvoicePageUrl, getOneTimeProductInfo } from '../../invoice';
 import { getMainProductName } from '../../product';
@@ -122,7 +123,7 @@ export class SubscriptionSucceededEmailTemplate
     const paymentInfo: string = `${paymentAmount} ${paymentCurrency.symbol}`;
     const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
     const nftMintItem: NftMintItem | undefined = hasNft
-      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
+      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
       : undefined;
     const currentPeriodStart: string = formatTime((subscription.current_period_start || invoice.period_start) * 1000);
     const currentPeriodEnd: string = formatTime((subscription.current_period_end || invoice.period_end) * 1000);
@@ -136,7 +137,7 @@ export class SubscriptionSucceededEmailTemplate
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
     // @FIXME: 获取 chainHost 困难的一批?
     const chainHost: string | undefined =
-      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.api_host;
+      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.api_host;
     const viewSubscriptionLink = getCustomerSubscriptionPageUrl({
       subscriptionId: subscription.id,
       locale,
@@ -150,7 +151,7 @@ export class SubscriptionSucceededEmailTemplate
 
     const paymentIntent = await PaymentIntent.findByPk(invoice.payment_intent_id);
     const txHash: string | undefined =
-      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.tx_hash;
+      paymentIntent?.payment_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.tx_hash;
     const viewTxHashLink: string | undefined =
       txHash &&
       getExplorerLink({

package/api/src/libs/notification/template/subscription-trial-start.ts

@@ -7,7 +7,15 @@ import prettyMsI18n from 'pretty-ms-i18n';
 import isEmpty from 'lodash/isEmpty';
 import { getUserLocale } from '../../../integrations/blocklet/notification';
 import { translate } from '../../../locales';
-import { CheckoutSession, Customer, Invoice, NftMintItem, PaymentMethod, Subscription } from '../../../store/models';
+import {
+  CheckoutSession,
+  Customer,
+  NFTMintChainType,
+  Invoice,
+  NftMintItem,
+  PaymentMethod,
+  Subscription,
+} from '../../../store/models';
 import { PaymentCurrency } from '../../../store/models/payment-currency';
 import { getCustomerInvoicePageUrl, getOneTimeProductInfo } from '../../invoice';
 import { getMainProductName } from '../../product';
@@ -106,11 +114,11 @@ export class SubscriptionTrialStartEmailTemplate
 
     const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
     const nftMintItem: NftMintItem | undefined = hasNft
-      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
+      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
       : undefined;
     const paymentMethod: PaymentMethod | null = await PaymentMethod.findByPk(invoice.default_payment_method_id);
     const chainHost: string | undefined =
-      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']?.api_host;
+      paymentMethod?.settings?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]?.api_host;
     const paymentInfo: string = `${fromUnitToToken('0', paymentCurrency.decimal)} ${paymentCurrency.symbol}`;
     const currentPeriodStart: string = formatTime((subscription.trial_start as number) * 1000);
     const currentPeriodEnd: string = formatTime((subscription.trial_end as number) * 1000);

package/api/src/libs/notification/template/subscription-upgraded.ts

@@ -8,6 +8,7 @@ import { translate } from '../../../locales';
 import {
   CheckoutSession,
   Customer,
+  NFTMintChainType,
   NftMintItem,
   PaymentIntent,
   PaymentMethod,
@@ -93,7 +94,7 @@ export class SubscriptionUpgradedEmailTemplate implements BaseEmailTemplate<Subs
     )} ${paymentCurrency.symbol}`;
     const hasNft: boolean = checkoutSession?.nft_mint_status === 'minted';
     const nftMintItem: NftMintItem | undefined = hasNft
-      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as 'arcblock' | 'ethereum']
+      ? checkoutSession?.nft_mint_details?.[checkoutSession?.nft_mint_details?.type as NFTMintChainType]
       : undefined;
     const currentPeriodStart: string = formatTime(
       skipInvoice ? subscription.current_period_start * 1000 : invoice.period_start * 1000

package/api/src/libs/payment.ts

@@ -15,6 +15,7 @@ import type { TPaymentCurrency } from '../store/models/payment-currency';
 import { blocklet, ethWallet, wallet } from './auth';
 import logger from './logger';
 import { OCAP_PAYMENT_TX_TYPE } from './util';
+import { CHARGE_SUPPORTED_CHAIN_TYPES, EVM_CHAIN_TYPES } from './constants';
 
 export interface SufficientForPaymentResult {
   sufficient: boolean;
@@ -108,7 +109,7 @@ export async function isDelegationSufficientForPayment(args: {
     return { sufficient: false, reason: 'NOT_SUPPORTED' };
   }
 
-  if (paymentMethod.type === 'ethereum') {
+  if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
     if (!paymentCurrency.contract) {
       return { sufficient: false, reason: 'NOT_SUPPORTED' };
     }
@@ -204,7 +205,7 @@ export async function getPaymentDetail(
     return defaultResult;
   }
   const paymentSettings = invoice?.payment_settings;
-  if (['arcblock', 'ethereum'].includes(paymentMethod.type)) {
+  if (CHARGE_SUPPORTED_CHAIN_TYPES.includes(paymentMethod.type)) {
     // balance enough token for payment?
     const payer = paymentSettings?.payment_method_options.arcblock?.payer as string;
     const result = await isDelegationSufficientForPayment({
@@ -295,7 +296,7 @@ export async function getTokenLimitsForDelegation(
     return [entry];
   }
 
-  if (paymentMethod.type === 'ethereum') {
+  if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
     // FIXME: @wangshijun better control from customer.token_limits
     entry.totalAllowance = new BN(amount).mul(new BN(12)).toString();
     return [entry];
@@ -326,7 +327,7 @@ export async function isBalanceSufficientForRefund(args: {
     return { sufficient: true, token };
   }
 
-  if (paymentMethod.type === 'ethereum') {
+  if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
     const provider = paymentMethod.getEvmClient();
     const balance = paymentCurrency.contract
       ? await fetchErc20Balance(provider, paymentCurrency.contract, ethWallet.address)

package/api/src/libs/product.ts

@@ -1,6 +1,8 @@
 import isEmpty from 'lodash/isEmpty';
 
-import { CheckoutSession, Price, Product, Subscription } from '../store/models';
+import { Op } from 'sequelize';
+import { CheckoutSession, PaymentCurrency, PaymentMethod, Price, Product, Subscription } from '../store/models';
+import { EVM_CHAIN_TYPES } from './constants';
 
 export async function getMainProductName(subscriptionId: string): Promise<string> {
   const subscription = await Subscription.findByPk(subscriptionId);
@@ -62,3 +64,24 @@ export async function getMainProductNameByCheckoutSession(checkoutSession: Check
 
   return product.name;
 }
+
+export async function checkCurrencySupportRecurring(currencyIds: string[] | string, isRecurring: boolean) {
+  if (!isRecurring) {
+    return {
+      notSupportCurrencies: [],
+      validate: true,
+    };
+  }
+  const currencyIdsArray = Array.isArray(currencyIds) ? currencyIds : [currencyIds];
+  const currencies = (await PaymentCurrency.findAll({
+    where: { id: { [Op.in]: currencyIdsArray } },
+    include: [{ model: PaymentMethod, as: 'payment_method' }],
+  })) as (PaymentCurrency & { payment_method: PaymentMethod })[];
+  const notSupportCurrencies = currencies.filter(
+    (c) => EVM_CHAIN_TYPES.includes(c.payment_method?.type) && c.symbol === 'ETH'
+  );
+  return {
+    notSupportCurrencies,
+    validate: notSupportCurrencies?.length === 0,
+  };
+}

package/api/src/queues/payment.ts

@@ -33,12 +33,13 @@ import { Payout } from '../store/models/payout';
 import { Price } from '../store/models/price';
 import { Subscription } from '../store/models/subscription';
 import { SubscriptionItem } from '../store/models/subscription-item';
-import type { PaymentError, PaymentSettings } from '../store/models/types';
+import type { EVMChainType, PaymentError, PaymentSettings } from '../store/models/types';
 import { notificationQueue } from './notification';
 import { ensureOverdraftProtectionInvoiceAndItems } from '../libs/invoice';
 import { Lock } from '../store/models';
 import { ensureOverdraftProtectionPrice } from '../libs/overdraft-protection';
 import createQueue from '../libs/queue';
+import { EVM_CHAIN_TYPES } from '../libs/constants';
 
 type PaymentJob = {
   paymentIntentId: string;
@@ -391,7 +392,7 @@ export const handlePaymentFailed = async (
   const { enabled: enableOverdraftProtection, unused: unusedAmount } =
     await isSubscriptionOverdraftProtectionEnabled(subscription);
   const { price } = await ensureOverdraftProtectionPrice(subscription.livemode);
-  const invoicePrice = (price.currency_options || []).find((x: any) => x.currency_id === paymentIntent?.currency_id);
+  const invoicePrice = (price?.currency_options || []).find((x: any) => x.currency_id === paymentIntent?.currency_id);
 
   if (subscription.overdraft_protection?.enabled && !enableOverdraftProtection) {
     // overdraft protection is enabled but not enough
@@ -776,13 +777,14 @@ export const handlePayment = async (job: PaymentJob) => {
       await handlePaymentSucceed(paymentIntent);
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       if (!paymentCurrency.contract) {
         throw new Error('Payment capture not supported for ethereum payment currencies without contract');
       }
 
       const client = paymentMethod.getEvmClient();
-      const payer = paymentSettings?.payment_method_options.ethereum?.payer as string;
+      const paymentType = paymentMethod.type;
+      const payer = paymentSettings?.payment_method_options[paymentType as EVMChainType]?.payer as string;
 
       // check balance before capture with transaction
       result = await isDelegationSufficientForPayment({
@@ -805,7 +807,7 @@ export const handlePayment = async (job: PaymentJob) => {
         last_payment_error: null,
         amount_received: paymentIntent.amount,
         payment_details: {
-          ethereum: {
+          [paymentType]: {
             tx_hash: receipt.hash,
             payer: payer as string,
             block_height: receipt.blockNumber.toString(),

package/api/src/queues/refund.ts

@@ -14,7 +14,8 @@ import { PaymentIntent } from '../store/models/payment-intent';
 import { PaymentMethod } from '../store/models/payment-method';
 import { Refund } from '../store/models/refund';
 import { Subscription } from '../store/models/subscription';
-import type { PaymentError } from '../store/models/types';
+import type { EVMChainType, PaymentError } from '../store/models/types';
+import { EVM_CHAIN_TYPES } from '../libs/constants';
 
 type RefundJob = {
   refundId: string;
@@ -117,7 +118,7 @@ const handleRefundJob = async (
   paymentMethod: PaymentMethod,
   customer: Customer
 ) => {
-  const refundSupport = ['arcblock', 'ethereum', 'stripe'].includes(paymentMethod.type);
+  const refundSupport = ['arcblock', 'ethereum', 'stripe', 'base'].includes(paymentMethod.type);
   if (refundSupport === false) {
     logger.warn(`PaymentMethod does not support auto charge: ${paymentCurrency.payment_method_id}`);
     return;
@@ -183,9 +184,10 @@ const handleRefundJob = async (
       logger.info('Refund status updated to succeeded', { id: refund.id, txHash });
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
+      const paymentType = paymentMethod.type;
       if (!paymentCurrency.contract) {
-        throw new Error('Refund not supported for ethereum payment currencies without contract');
+        throw new Error(`Refund not supported for ${paymentType} payment currencies without contract`);
       }
 
       // check balance before transfer with transaction
@@ -197,7 +199,7 @@ const handleRefundJob = async (
 
       // do the capture
       const client = paymentMethod.getEvmClient();
-      const payer = paymentIntent!.payment_details?.ethereum?.payer as string;
+      const payer = paymentIntent!.payment_details?.[paymentType as EVMChainType]?.payer as string;
       const receipt = await sendErc20ToUser(client, paymentCurrency.contract, payer, refund.amount);
       logger.info('refund transfer done', { id: refund.id, txHash: receipt.hash });
 
@@ -205,7 +207,7 @@ const handleRefundJob = async (
         status: 'succeeded',
         last_attempt_error: null,
         payment_details: {
-          ethereum: {
+          [paymentType]: {
             tx_hash: receipt.hash,
             payer: wallet.address,
             block_height: receipt.blockNumber.toString(),

package/api/src/routes/connect/change-payment.ts

@@ -11,6 +11,7 @@ import {
   updateStripeSubscriptionAfterChangePayment,
 } from './shared';
 import { ensureStakeInvoice } from '../../libs/invoice';
+import { EVM_CHAIN_TYPES } from '../../libs/constants';
 
 export default {
   action: 'change-payment',
@@ -65,7 +66,7 @@ export default {
       return claims;
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       if (!paymentCurrency.contract) {
         throw new Error(`Payment currency ${paymentMethod.type}:${paymentCurrency.id} does not support subscription`);
       }
@@ -169,7 +170,7 @@ export default {
       return { hash: paymentDetails.tx_hash };
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       await prepareTxExecution();
       const paymentDetails = await executeEvmTransaction('approve', userDid, claims, paymentMethod);
       waitForEvmTxConfirm(paymentMethod.getEvmClient(), +paymentDetails.block_height, paymentMethod.confirmation.block)

package/api/src/routes/connect/change-plan.ts

@@ -15,6 +15,7 @@ import {
   getStakeTxClaim,
 } from './shared';
 import { ensureStakeInvoice } from '../../libs/invoice';
+import { EVM_CHAIN_TYPES } from '../../libs/constants';
 
 export default {
   action: 'change-plan',
@@ -79,7 +80,7 @@ export default {
       return claims;
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       if (!paymentCurrency.contract) {
         throw new Error(`Payment currency ${paymentMethod.type}:${paymentCurrency.id} does not support subscription`);
       }
@@ -177,7 +178,7 @@ export default {
       return { hash: paymentDetails.tx_hash };
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       await prepareTxExecution();
 
       const paymentDetails = await executeEvmTransaction('approve', userDid, claims, paymentMethod);

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

@@ -11,8 +11,9 @@ import { getGasPayerExtra } from '../../libs/payment';
 import { getTxMetadata } from '../../libs/util';
 import { invoiceQueue } from '../../queues/invoice';
 import { handlePaymentSucceed, paymentQueue } from '../../queues/payment';
-import { PaymentIntent } from '../../store/models';
+import { EVMChainType, PaymentIntent } from '../../store/models';
 import { ensureSubscriptionForCollectBatch, getAuthPrincipalClaim } from './shared';
+import { EVM_CHAIN_TYPES } from '../../libs/constants';
 
 // Used to collect uncollectible invoices for a subscription and currency
 export default {
@@ -62,14 +63,14 @@ export default {
       return claims;
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       return {
         signature: {
           type: 'eth:transaction',
           data: toBase58(
             Buffer.from(
               JSON.stringify({
-                network: paymentMethod.settings?.ethereum?.chain_id,
+                network: paymentMethod.settings[paymentMethod.type as EVMChainType]?.chain_id,
                 tx: encodeTransferItx(ethWallet.address, amount!, paymentCurrency.contract),
               }),
               'utf-8'
@@ -139,7 +140,7 @@ export default {
 
       return { hash: txHash };
     }
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       const client = paymentMethod.getEvmClient();
       const claim = claims.find((x) => x.type === 'signature');
 

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

@@ -12,8 +12,9 @@ import { onSubscriptionUpdateConnected } from '../../libs/subscription';
 import { getTxMetadata } from '../../libs/util';
 import { invoiceQueue } from '../../queues/invoice';
 import { handlePaymentSucceed, paymentQueue } from '../../queues/payment';
-import { Price, Subscription, SubscriptionItem } from '../../store/models';
+import { EVMChainType, Price, Subscription, SubscriptionItem } from '../../store/models';
 import { ensureInvoiceForCollect, getAuthPrincipalClaim, getDelegationTxClaim } from './shared';
+import { EVM_CHAIN_TYPES } from '../../libs/constants';
 
 // Used to collect an open invoice failed to collect automatically
 export default {
@@ -73,10 +74,10 @@ export default {
       return claims;
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       // FIXME: @wangshijun can we support this
       if (action === 'renew' && invoice.subscription_id) {
-        throw new Error('Renew subscription on collect payment not supported for ethereum');
+        throw new Error(`Renew subscription on collect payment not supported for ${paymentMethod.type}`);
       }
 
       return {
@@ -85,7 +86,7 @@ export default {
           data: toBase58(
             Buffer.from(
               JSON.stringify({
-                network: paymentMethod.settings?.ethereum?.chain_id,
+                network: paymentMethod.settings[paymentMethod.type as EVMChainType]?.chain_id,
                 tx: encodeTransferItx(ethWallet.address, paymentIntent.amount, paymentCurrency.contract),
               }),
               'utf-8'
@@ -170,7 +171,7 @@ export default {
       }
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       await paymentIntent.update({ status: 'processing' });
       const client = paymentMethod.getEvmClient();
       const claim = claims.find((x) => x.type === 'signature');

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

@@ -11,6 +11,8 @@ import { createPaymentOutput } from '../../libs/session';
 import { getTxMetadata } from '../../libs/util';
 import { handlePaymentSucceed } from '../../queues/payment';
 import { ensureInvoiceForCheckout, ensurePaymentIntent, getAuthPrincipalClaim } from './shared';
+import { EVMChainType } from '../../store/models';
+import { EVM_CHAIN_TYPES } from '../../libs/constants';
 
 export default {
   action: 'payment',
@@ -63,14 +65,14 @@ export default {
       };
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       return {
         signature: {
           type: 'eth:transaction',
           data: toBase58(
             Buffer.from(
               JSON.stringify({
-                network: paymentMethod.settings?.ethereum?.chain_id,
+                network: paymentMethod.settings[paymentMethod.type as EVMChainType]?.chain_id,
                 tx: encodeTransferItx(ethWallet.address, paymentIntent.amount, paymentCurrency.contract),
               }),
               'utf-8'
@@ -140,7 +142,7 @@ export default {
       }
     }
 
-    if (paymentMethod.type === 'ethereum') {
+    if (EVM_CHAIN_TYPES.includes(paymentMethod.type)) {
       try {
         await paymentIntent.update({ status: 'processing' });
 
@@ -164,7 +166,10 @@ export default {
         return { hash: paymentDetails.tx_hash };
       } catch (err) {
         console.error(err);
-        logger.error('Failed to finalize paymentIntent on ethereum', { paymentIntent: paymentIntent.id, error: err });
+        logger.error(`Failed to finalize paymentIntent on ${paymentMethod.type}`, {
+          paymentIntent: paymentIntent.id,
+          error: err,
+        });
         await paymentIntent.update({ status: 'requires_capture' });
         throw err;
       }