feat: add stacks family (#335)

.changeset/big-waves-press.md

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

packages/core/package.json

@@ -20,6 +20,7 @@
   },
   "devDependencies": {
     "@ledgerhq/jest-shared-config": "workspace:*",
+    "@stacks/transactions": "^6.13.0",
     "@types/jest": "^29.5.12",
     "@types/node": "^20.11.19",
     "@types/uuid": "^9.0.8",

packages/core/src/families/common.ts

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

packages/core/src/families/index.ts

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

packages/core/src/families/serializer.ts

@@ -68,6 +68,10 @@ import {
   deserializeVechainTransaction,
   serializeVechainTransaction,
 } from "./vechain/serializer";
+import {
+  deserializeStacksTransaction,
+  serializeStacksTransaction,
+} from "./stacks/serializer";
 import type { RawTransaction, Transaction } from "./types";
 
 /**
@@ -117,6 +121,8 @@ export function serializeTransaction(transaction: Transaction): RawTransaction {
       return serializeSolanaTransaction(transaction);
     case "vechain":
       return serializeVechainTransaction(transaction);
+    case "stacks":
+      return serializeStacksTransaction(transaction);
     default: {
       const exhaustiveCheck: never = transaction; // https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
       return exhaustiveCheck;
@@ -174,6 +180,8 @@ export function deserializeTransaction(
       return deserializeSolanaTransaction(rawTransaction);
     case "vechain":
       return deserializeVechainTransaction(rawTransaction);
+    case "stacks":
+      return deserializeStacksTransaction(rawTransaction);
     default: {
       const exhaustiveCheck: never = rawTransaction; // https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
       return exhaustiveCheck;

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

@@ -0,0 +1,42 @@
+import BigNumber from "bignumber.js";
+import type { RawStacksTransaction, StacksTransaction } from "./types";
+
+export const serializeStacksTransaction = ({
+  amount,
+  recipient,
+  family,
+  fee,
+  nonce,
+  memo,
+  network,
+  anchorMode,
+}: StacksTransaction): RawStacksTransaction => ({
+  amount: amount.toString(),
+  recipient,
+  family,
+  fee: fee?.toString(),
+  nonce: nonce?.toString(),
+  memo,
+  network,
+  anchorMode,
+});
+
+export const deserializeStacksTransaction = ({
+  amount,
+  recipient,
+  family,
+  fee,
+  nonce,
+  memo,
+  network,
+  anchorMode,
+}: RawStacksTransaction): StacksTransaction => ({
+  amount: new BigNumber(amount),
+  recipient,
+  family,
+  fee: fee ? new BigNumber(fee) : undefined,
+  nonce: nonce ? new BigNumber(nonce) : undefined,
+  memo,
+  network: network === "mainnet" ? network : "testnet",
+  anchorMode,
+});

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

@@ -0,0 +1,18 @@
+import type { z } from "zod";
+import type { TransactionCommon } from "../index";
+import type { schemaRawStacksTransaction } from "./validation";
+import type BigNumber from "bignumber.js";
+import type { AnchorMode } from "@stacks/transactions";
+
+export type StacksNetworks = "mainnet" | "testnet";
+
+export type StacksTransaction = TransactionCommon & {
+  readonly family: RawStacksTransaction["family"];
+  fee?: BigNumber;
+  nonce?: BigNumber;
+  memo?: string;
+  network: StacksNetworks;
+  anchorMode: AnchorMode;
+};
+
+export type RawStacksTransaction = z.infer<typeof schemaRawStacksTransaction>;

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

@@ -0,0 +1,11 @@
+import { z } from "zod";
+import { schemaFamilies, schemaTransactionCommon } from "../common";
+
+export const schemaRawStacksTransaction = schemaTransactionCommon.extend({
+  family: z.literal(schemaFamilies.enum.stacks),
+  fee: z.string().optional(),
+  nonce: z.string().optional(),
+  memo: z.string().optional(),
+  network: z.string(),
+  anchorMode: z.number(),
+});

packages/core/src/families/types.ts

@@ -21,6 +21,7 @@ import type { TezosTransaction } from "./tezos/types";
 import type { TronTransaction } from "./tron/types";
 import type { VechainTransaction } from "./vechain/types";
 import type { schemaRawTransaction } from "./validation";
+import type { StacksTransaction } from "./stacks/types";
 
 /**
  * Supported coin families
@@ -81,4 +82,5 @@ export type Transaction =
   | ElrondTransaction
   | CardanoTransaction
   | SolanaTransaction
-  | VechainTransaction;
+  | VechainTransaction
+  | StacksTransaction;

packages/core/src/families/validation.ts

@@ -18,6 +18,7 @@ import { schemaRawFilecoinTransaction } from "./filecoin/validation";
 import { schemaRawElrondTransaction } from "./elrond/validation";
 import { schemaRawCardanoTransaction } from "./cardano/validation";
 import { schemaRawVechainTransaction } from "./vechain/validation";
+import { schemaRawStacksTransaction } from "./stacks/validation";
 
 export const schemaRawTransaction = z.discriminatedUnion("family", [
   schemaRawAlgorandTransaction,
@@ -39,4 +40,5 @@ export const schemaRawTransaction = z.discriminatedUnion("family", [
   schemaRawCardanoTransaction,
   schemaRawSolanaTransaction,
   schemaRawVechainTransaction,
+  schemaRawStacksTransaction,
 ]);