refactor(vechain): remove thor-devkit dependency, inline transaction types, update validation schema (add comment/abi, maxFeePerGas, make gasPriceCoef optional) (#486)

Author: Justkant

.changeset/hip-rats-divide.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/wallet-api-core": minor
+---
+
+refactor(vechain): remove thor-devkit dependency, inline transaction types, update validation schema (add comment/abi, maxFeePerGas, make gasPriceCoef optional)

packages/core/package.json

@@ -35,7 +35,6 @@
     "@stacks/transactions": "^6.13.0",
     "@ton/core": "^0.62.0",
     "bignumber.js": "^9.1.2",
-    "thor-devkit": "^2.0.9",
     "uuid": "^9.0.1",
     "zod": "^3.22.4"
   }

packages/core/src/families/vechain/types.ts

@@ -1,12 +1,141 @@
-import type { Transaction as ThorTransaction } from "thor-devkit";
 import type { z } from "zod";
 import type { TransactionCommon } from "../index";
 import type { schemaRawVechainTransaction } from "./validation";
 
 export type VechainTransaction = TransactionCommon & {
   readonly family: RawVechainTransaction["family"];
   estimatedFees: string;
-  body: ThorTransaction.Body;
+  body: TransactionBody;
 };
 
 export type RawVechainTransaction = z.infer<typeof schemaRawVechainTransaction>;
+
+// Copied vechain-sdk-js
+// https://github.com/vechain/vechain-sdk-js/blob/main/packages/core/src/transaction/TransactionClause.d.ts
+type TransactionClause = {
+  /**
+   * Destination address where:
+   * * transfer token to or
+   * * invoke contract method on.
+   *
+   * @note Set null destination to deploy a contract.
+   */
+  to: string | null;
+
+  /**
+   * Amount of token to transfer to the destination
+   */
+  value: string | number;
+
+  /**
+   * Input data for contract method invocation or deployment
+   */
+  data: string;
+
+  /**
+   * Optional comment for the clause, helpful for displaying what the clause is doing.
+   */
+  comment?: string;
+
+  /**
+   * Optional ABI for the contract method invocation.
+   */
+  abi?: string;
+};
+
+// Copied vechain-sdk-js
+// https://github.com/vechain/vechain-sdk-js/blob/main/packages/core/src/transaction/TransactionBody.d.ts
+type TransactionBody = {
+  /**
+   * Last byte of genesis block ID
+   */
+  chainTag: number;
+
+  /**
+   * 8 bytes prefix of some block's ID
+   */
+  blockRef: string;
+
+  /**
+   * Constraint of time bucket
+   */
+  expiration: number;
+
+  /**
+   * Array of clauses
+   */
+  clauses: TransactionClause[];
+
+  /**
+   * Coefficient applied to base gas price [0,255]
+   */
+  gasPriceCoef?: number;
+
+  /**
+   * Max gas provided for execution
+   */
+  gas: string | number;
+
+  /**
+   * ID of another tx that is depended
+   */
+  dependsOn: string | null;
+
+  /**
+   * Nonce value for various purposes.
+   * Basic is to prevent replay attack by make transaction unique.
+   * Every transaction with same chainTag, blockRef, ... must have different nonce.
+   */
+  nonce: string | number;
+
+  /**
+   * The maximum fee per gas for the transaction.
+   */
+  maxFeePerGas?: string | number;
+
+  /**
+   * The maximum priority fee per gas for the transaction.
+   */
+  maxPriorityFeePerGas?: string | number;
+
+  /**
+   * A reserved field intended for features use.
+   *
+   * In standard EVM transactions, this reserved field typically is not present.
+   * However, it's been designed to cater to VIP-191, which deals with fee delegation.
+   *
+   * If the `features` within the `reserved` field is set as `1111...111`, it indicates that the transaction has been delegated.
+   * The method to check if the transaction is delegated is:
+   *
+   * ```typescript
+   * reserved.features & 1 === 1
+   * ```
+   *
+   * @example
+   *
+   * 1.
+   * ```typescript
+   * feature = 111101;
+   * isDelegated = (111101 & 111111) === 111101; // false (not delegated)
+   * ```
+   *
+   * 2.
+   * ```typescript
+   * feature = 111111;
+   * isDelegated = (111111 & 111111) === 111111; // true (delegated)
+   * ```
+   *
+   * @remarks
+   * For more information on the subject, refer to {@link https://github.com/vechain/VIPs/blob/master/vips/VIP-191.md | VIP-191}.
+   */
+  reserved?: {
+    /**
+     * Tx feature bits
+     */
+    features?: number;
+    /**
+     * Unused
+     */
+    unused?: Uint8Array[];
+  };
+};

packages/core/src/families/vechain/validation.ts

@@ -6,6 +6,8 @@ export const schemaThorTransactionClause = z.object({
   to: z.string().nullable(),
   value: z.union([z.string(), z.number()]),
   data: z.string(),
+  comment: z.string().optional(),
+  abi: z.string().optional(),
 });
 
 // Generated from VeChain Thor Transaction types
@@ -15,10 +17,12 @@ export const schemaThorTransactionBody = z.object({
   blockRef: z.string(),
   expiration: z.number(),
   clauses: z.array(schemaThorTransactionClause),
-  gasPriceCoef: z.number(),
+  gasPriceCoef: z.number().optional(),
   gas: z.union([z.string(), z.number()]),
   dependsOn: z.string().nullable(),
   nonce: z.union([z.string(), z.number()]),
+  maxFeePerGas: z.union([z.string(), z.number()]).optional(),
+  maxPriorityFeePerGas: z.union([z.string(), z.number()]).optional(),
   reserved: z
     .object({
       features: z.number().optional(),