feat: add crypto payment method error (#6720)

## Explanation

<!--
Thanks for your contribution! Take a moment to answer these questions so
that reviewers have the information they need to properly understand
your changes:

* What is the current state of things and why does it need to change?
* What is the solution your changes offer and how does it work?
* Are there any changes whose purpose might not obvious to those
unfamiliar with the domain?
* If your primary goal was to update one package but you found you had
to update another one along the way, why did you do so?
* If you had to upgrade a dependency, why did you do so?
-->

- Add `CryptoPaymentMethodError` error response to
`SubscriptionCryptoPaymentMethod`
- Make `rawTransaction` in `UpdatePaymentMethodCryptoRequest` optional
for top up case

## References

<!--
Are there any issues that this pull request is tied to?
Are there other links that reviewers should consult to understand these
changes better?
Are there client or consumer pull requests to adopt any breaking
changes?

For example:

* Fixes #12345
* Related to #67890
-->

## Checklist

- [x] I've updated the test suite for new or updated code as appropriate
- [x] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [x] I've communicated my changes to consumers by [updating changelogs
for packages I've
changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs),
highlighting breaking changes as necessary
- [x] I've prepared draft pull requests for clients and consumer
packages to resolve any breaking changes

Author: tuna1207

packages/subscription-controller/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add `CryptoPaymentMethodError` error response to `SubscriptionCryptoPaymentMethod` ([#6720](https://github.com/MetaMask/core/pull/6720))
+
+### Changed
+
+- Make `rawTransaction` in `UpdatePaymentMethodCryptoRequest` optional for top up case ([#6720](https://github.com/MetaMask/core/pull/6720))
+
 ## [0.2.0]
 
 ### Changed

packages/subscription-controller/src/types.ts

@@ -41,6 +41,18 @@ export const SUBSCRIPTION_STATUSES = {
 export type SubscriptionStatus =
   (typeof SUBSCRIPTION_STATUSES)[keyof typeof SUBSCRIPTION_STATUSES];
 
+export const CRYPTO_PAYMENT_METHOD_ERRORS = {
+  APPROVAL_TRANSACTION_TOO_OLD: 'approval_transaction_too_old',
+  APPROVAL_TRANSACTION_REVERTED: 'approval_transaction_reverted',
+  APPROVAL_TRANSACTION_MAX_VERIFICATION_ATTEMPTS_REACHED:
+    'approval_transaction_max_verification_attempts_reached',
+  INSUFFICIENT_BALANCE: 'insufficient_balance',
+  INSUFFICIENT_ALLOWANCE: 'insufficient_allowance',
+} as const;
+
+export type CryptoPaymentMethodError =
+  (typeof CRYPTO_PAYMENT_METHOD_ERRORS)[keyof typeof CRYPTO_PAYMENT_METHOD_ERRORS];
+
 /** only usd for now */
 export type Currency = 'usd';
 
@@ -86,6 +98,7 @@ export type SubscriptionCryptoPaymentMethod = {
     payerAddress: Hex;
     chainId: Hex;
     tokenSymbol: string;
+    error?: CryptoPaymentMethodError;
   };
 };
 
@@ -258,7 +271,11 @@ export type UpdatePaymentMethodCryptoRequest = {
   chainId: Hex;
   payerAddress: Hex;
   tokenSymbol: string;
-  rawTransaction: Hex;
+  /**
+   * The raw transaction to pay for the subscription
+   * Can be empty if retry after topping up balance
+   */
+  rawTransaction?: Hex;
   recurringInterval: RecurringInterval;
   billingCycles: number;
 };