feat: add vechain family [LIVE-9715] (#332)

* feat: add vechain family

* test: add serializers test for vechain

.changeset/polite-melons-look.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/wallet-api-core": minor
+---
+
+feat: add vechain family

packages/core/package.json

@@ -26,6 +26,7 @@
     "eslint": "^8.56.0",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
+    "thor-devkit": "^2.0.9",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.3.3"

packages/core/src/families/common.ts

@@ -26,6 +26,7 @@ export const FAMILIES = [
   "elrond",
   "cardano",
   "solana",
+  "vechain",
 ] as const;
 
 export const schemaFamilies = z.enum(FAMILIES);

packages/core/src/families/index.ts

@@ -16,6 +16,7 @@ export * from "./tron/types";
 export * from "./elrond/types";
 export * from "./cardano/types";
 export * from "./solana/types";
+export * from "./vechain/types";
 
 export * from "./common";
 export * from "./serializer";

packages/core/src/families/serializer.ts

@@ -64,6 +64,10 @@ import {
   deserializeSolanaTransaction,
   serializeSolanaTransaction,
 } from "./solana/serializer";
+import {
+  deserializeVechainTransaction,
+  serializeVechainTransaction,
+} from "./vechain/serializer";
 import type { RawTransaction, Transaction } from "./types";
 
 /**
@@ -111,6 +115,8 @@ export function serializeTransaction(transaction: Transaction): RawTransaction {
       return serializeCardanoTransaction(transaction);
     case "solana":
       return serializeSolanaTransaction(transaction);
+    case "vechain":
+      return serializeVechainTransaction(transaction);
     default: {
       const exhaustiveCheck: never = transaction; // https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
       return exhaustiveCheck;
@@ -166,6 +172,8 @@ export function deserializeTransaction(
       return deserializeCardanoTransaction(rawTransaction);
     case "solana":
       return deserializeSolanaTransaction(rawTransaction);
+    case "vechain":
+      return deserializeVechainTransaction(rawTransaction);
     default: {
       const exhaustiveCheck: never = rawTransaction; // https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
       return exhaustiveCheck;

packages/core/src/families/types.ts

@@ -19,6 +19,7 @@ import type { SolanaTransaction } from "./solana/types";
 import type { StellarTransaction } from "./stellar/types";
 import type { TezosTransaction } from "./tezos/types";
 import type { TronTransaction } from "./tron/types";
+import type { VechainTransaction } from "./vechain/types";
 import type { schemaRawTransaction } from "./validation";
 
 /**
@@ -79,4 +80,5 @@ export type Transaction =
   | NeoTransaction
   | ElrondTransaction
   | CardanoTransaction
-  | SolanaTransaction;
+  | SolanaTransaction
+  | VechainTransaction;

packages/core/src/families/validation.ts

@@ -17,6 +17,7 @@ import { schemaRawHederaTransaction } from "./hedera/validation";
 import { schemaRawFilecoinTransaction } from "./filecoin/validation";
 import { schemaRawElrondTransaction } from "./elrond/validation";
 import { schemaRawCardanoTransaction } from "./cardano/validation";
+import { schemaRawVechainTransaction } from "./vechain/validation";
 
 export const schemaRawTransaction = z.discriminatedUnion("family", [
   schemaRawAlgorandTransaction,
@@ -37,4 +38,5 @@ export const schemaRawTransaction = z.discriminatedUnion("family", [
   schemaRawElrondTransaction,
   schemaRawCardanoTransaction,
   schemaRawSolanaTransaction,
+  schemaRawVechainTransaction,
 ]);

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

@@ -0,0 +1,30 @@
+import BigNumber from "bignumber.js";
+import type { RawVechainTransaction, VechainTransaction } from "./types";
+
+export const serializeVechainTransaction = ({
+  amount,
+  recipient,
+  family,
+  estimatedFees,
+  body,
+}: VechainTransaction): RawVechainTransaction => ({
+  amount: amount.toString(),
+  recipient,
+  family,
+  estimatedFees,
+  body,
+});
+
+export const deserializeVechainTransaction = ({
+  amount,
+  recipient,
+  family,
+  estimatedFees,
+  body,
+}: RawVechainTransaction): VechainTransaction => ({
+  amount: new BigNumber(amount),
+  recipient,
+  family,
+  estimatedFees,
+  body,
+});

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

@@ -0,0 +1,12 @@
+import { 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;
+};
+
+export type RawVechainTransaction = z.infer<typeof schemaRawVechainTransaction>;

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

@@ -0,0 +1,34 @@
+import { z } from "zod";
+import { schemaFamilies, schemaTransactionCommon } from "../common";
+
+// Generated from VeChain Thor Transaction types
+export const schemaThorTransactionClause = z.object({
+  to: z.string().nullable(),
+  value: z.union([z.string(), z.number()]),
+  data: z.string(),
+});
+
+// Generated from VeChain Thor Transaction types
+// with Buffer type removed for `reserved.unused`
+export const schemaThorTransactionBody = z.object({
+  chainTag: z.number(),
+  blockRef: z.string(),
+  expiration: z.number(),
+  clauses: z.array(schemaThorTransactionClause),
+  gasPriceCoef: z.number(),
+  gas: z.union([z.string(), z.number()]),
+  dependsOn: z.string().nullable(),
+  nonce: z.union([z.string(), z.number()]),
+  reserved: z
+    .object({
+      features: z.number().optional(),
+      unused: z.array(z.any()).optional(),
+    })
+    .optional(),
+});
+
+export const schemaRawVechainTransaction = schemaTransactionCommon.extend({
+  family: z.literal(schemaFamilies.enum.vechain),
+  estimatedFees: z.string(),
+  body: schemaThorTransactionBody,
+});

packages/core/tests/serializers.spec.ts

@@ -39,6 +39,8 @@ import {
   RawCardanoTransaction,
   RawSolanaTransaction,
   SolanaTransaction,
+  VechainTransaction,
+  RawVechainTransaction,
 } from "../src";
 
 const date = new Date();
@@ -773,6 +775,47 @@ describe("serializers.ts", () => {
         });
       });
     });
+
+    describe("vechain", () => {
+      const family = schemaFamilies.enum.vechain;
+
+      it("should serialize a Vechain transaction", () => {
+        const transaction: VechainTransaction = {
+          family,
+          amount: new BigNumber(100),
+          recipient: "recipient",
+          estimatedFees: "0",
+          body: {
+            chainTag: 0,
+            blockRef: "",
+            expiration: 0,
+            clauses: [],
+            gasPriceCoef: 0,
+            gas: 0,
+            dependsOn: null,
+            nonce: 0,
+          },
+        };
+        const serializedTransaction = serializeTransaction(transaction);
+
+        expect(serializedTransaction).toEqual({
+          family,
+          amount: "100",
+          recipient: "recipient",
+          estimatedFees: "0",
+          body: {
+            chainTag: 0,
+            blockRef: "",
+            expiration: 0,
+            clauses: [],
+            gasPriceCoef: 0,
+            gas: 0,
+            dependsOn: null,
+            nonce: 0,
+          },
+        });
+      });
+    });
   });
 
   describe("deserializeTransaction", () => {
@@ -1444,6 +1487,48 @@ describe("serializers.ts", () => {
         });
       });
     });
+
+    describe("vechain", () => {
+      const family = schemaFamilies.enum.vechain;
+
+      it("should deserialize a Solana transaction", () => {
+        const serializedTransaction: RawVechainTransaction = {
+          family,
+          amount: "100",
+          recipient: "recipient",
+          estimatedFees: "0",
+          body: {
+            chainTag: 0,
+            blockRef: "",
+            expiration: 0,
+            clauses: [],
+            gasPriceCoef: 0,
+            gas: 0,
+            dependsOn: null,
+            nonce: 0,
+          },
+        };
+
+        const transaction = deserializeTransaction(serializedTransaction);
+
+        expect(transaction).toEqual({
+          family,
+          amount: new BigNumber(100),
+          recipient: "recipient",
+          estimatedFees: "0",
+          body: {
+            chainTag: 0,
+            blockRef: "",
+            expiration: 0,
+            clauses: [],
+            gasPriceCoef: 0,
+            gas: 0,
+            dependsOn: null,
+            nonce: 0,
+          },
+        });
+      });
+    });
   });
 
   describe("Serialize -> Deserialize flow", () => {