feat(ton): add named payload types and raw schemas for pool & vesting operations (#484)

Author: Justkant

.changeset/empty-beers-taste.md

@@ -0,0 +1,5 @@
+---
+"@ledgerhq/wallet-api-core": minor
+---
+
+feat(ton): add named payload types and raw schemas for pool & vesting operations

packages/core/package.json

@@ -33,7 +33,7 @@
   "dependencies": {
     "@ledgerhq/errors": "^6.16.2",
     "@stacks/transactions": "^6.13.0",
-    "@ton/core": "^0.60.1",
+    "@ton/core": "^0.62.0",
     "bignumber.js": "^9.1.2",
     "thor-devkit": "^2.0.9",
     "uuid": "^9.0.1",

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

@@ -153,6 +153,28 @@ const fromTransactionPayloadRaw = (
         queryId: payload.queryId ? BigInt(payload.queryId) : null,
         swapId: Buffer.from(payload.swapId, "hex"),
       };
+    case "tonwhales-pool-deposit":
+      return {
+        type: payload.type,
+        queryId: BigInt(payload.queryId),
+        gasLimit: BigInt(payload.gasLimit),
+      };
+    case "tonwhales-pool-withdraw":
+      return {
+        type: payload.type,
+        queryId: BigInt(payload.queryId),
+        gasLimit: BigInt(payload.gasLimit),
+        amount: BigInt(payload.amount),
+      };
+    case "vesting-send-msg-comment":
+      return {
+        type: payload.type,
+        queryId: payload.queryId ? BigInt(payload.queryId) : null,
+        sendMode: payload.sendMode,
+        value: BigInt(payload.value),
+        destination: Address.parse(payload.destination),
+        text: payload.text,
+      };
     case "comment":
       return payload;
     default: {
@@ -299,6 +321,31 @@ const toTransactionPayloadRaw = (
             : null,
         swapId: payload.swapId.toString("hex"),
       };
+    case "tonwhales-pool-deposit":
+      return {
+        type: payload.type,
+        queryId: payload.queryId.toString(),
+        gasLimit: payload.gasLimit.toString(),
+      };
+    case "tonwhales-pool-withdraw":
+      return {
+        type: payload.type,
+        queryId: payload.queryId.toString(),
+        gasLimit: payload.gasLimit.toString(),
+        amount: payload.amount.toString(),
+      };
+    case "vesting-send-msg-comment":
+      return {
+        type: payload.type,
+        queryId:
+          typeof payload.queryId === "bigint"
+            ? payload.queryId.toString()
+            : null,
+        sendMode: payload.sendMode,
+        value: payload.value.toString(),
+        destination: payload.destination.toRawString(),
+        text: payload.text,
+      };
     case "comment":
       return payload;
     default: {

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

@@ -16,7 +16,10 @@ import type {
   schemaTonPayloadSingleNominatorWithdrawRaw,
   schemaTonPayloadTokenBridgePaySwapRaw,
   schemaTonPayloadTonStakersDepositRaw,
+  schemaTonPayloadTonWhalesPoolDepositRaw,
+  schemaTonPayloadTonWhalesPoolWithdrawRaw,
   schemaTonPayloadUnsafeRaw,
+  schemaTonPayloadVestingSendMsgCommentRaw,
   schemaTonPayloadVoteForProposalRaw,
 } from "./validation";
 
@@ -177,6 +180,40 @@ export type TonPayloadTokenBridgePaySwapRaw = z.infer<
   typeof schemaTonPayloadTokenBridgePaySwapRaw
 >;
 
+export type TonPayloadTonWhalesPoolDeposit = {
+  type: "tonwhales-pool-deposit";
+  queryId: bigint;
+  gasLimit: bigint;
+};
+
+export type TonPayloadTonWhalesPoolDepositRaw = z.infer<
+  typeof schemaTonPayloadTonWhalesPoolDepositRaw
+>;
+
+export type TonPayloadTonWhalesPoolWithdraw = {
+  type: "tonwhales-pool-withdraw";
+  queryId: bigint;
+  gasLimit: bigint;
+  amount: bigint;
+};
+
+export type TonPayloadTonWhalesPoolWithdrawRaw = z.infer<
+  typeof schemaTonPayloadTonWhalesPoolWithdrawRaw
+>;
+
+export type TonPayloadVestingSendMsgComment = {
+  type: "vesting-send-msg-comment";
+  queryId: bigint | null;
+  sendMode: number;
+  value: bigint;
+  destination: Address;
+  text: string;
+};
+
+export type TonPayloadVestingSendMsgCommentRaw = z.infer<
+  typeof schemaTonPayloadVestingSendMsgCommentRaw
+>;
+
 export type TonPayloadFormat =
   | TonPayloadComment
   | TonPayloadJettonTransfer
@@ -189,6 +226,9 @@ export type TonPayloadFormat =
   | TonPayloadTonStakersDeposit
   | TonPayloadVoteForProposal
   | TonPayloadChangeDnsRecord
-  | TonPayloadTokenBridgePaySwap;
+  | TonPayloadTokenBridgePaySwap
+  | TonPayloadTonWhalesPoolDeposit
+  | TonPayloadTonWhalesPoolWithdraw
+  | TonPayloadVestingSendMsgComment;
 
 export type TonPayloadFormatRaw = z.infer<typeof schemaTonPayloadFormatRaw>;

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

@@ -118,6 +118,28 @@ export const schemaTonPayloadTokenBridgePaySwapRaw = z.object({
   swapId: z.string(),
 });
 
+export const schemaTonPayloadTonWhalesPoolDepositRaw = z.object({
+  type: z.literal("tonwhales-pool-deposit"),
+  queryId: z.string(),
+  gasLimit: z.string(),
+});
+
+export const schemaTonPayloadTonWhalesPoolWithdrawRaw = z.object({
+  type: z.literal("tonwhales-pool-withdraw"),
+  queryId: z.string(),
+  gasLimit: z.string(),
+  amount: z.string(),
+});
+
+export const schemaTonPayloadVestingSendMsgCommentRaw = z.object({
+  type: z.literal("vesting-send-msg-comment"),
+  queryId: z.union([z.string(), z.null()]),
+  sendMode: z.number(),
+  value: z.string(),
+  destination: z.string(),
+  text: z.string(),
+});
+
 export const schemaTonPayloadFormatRaw = z.union([
   schemaTonPayloadCommentRaw,
   schemaTonPayloadJettonTransferRaw,
@@ -131,6 +153,9 @@ export const schemaTonPayloadFormatRaw = z.union([
   schemaTonPayloadVoteForProposalRaw,
   schemaTonPayloadChangeDnsRecordRaw,
   schemaTonPayloadTokenBridgePaySwapRaw,
+  schemaTonPayloadTonWhalesPoolDepositRaw,
+  schemaTonPayloadTonWhalesPoolWithdrawRaw,
+  schemaTonPayloadVestingSendMsgCommentRaw,
 ]);
 
 export const schemaRawTonTransaction = schemaTransactionCommon.extend({

packages/core/tests/ton-serializers.spec.ts

@@ -406,6 +406,71 @@ const cases: {
       },
     },
   },
+  {
+    name: "tx with payload for tonwhales-pool-deposit",
+    tx: {
+      ...baseTx,
+      payload: {
+        type: "tonwhales-pool-deposit",
+        queryId: BigInt(1),
+        gasLimit: BigInt(1000000),
+      },
+    },
+    rawTx: {
+      ...baseRawTx,
+      payload: {
+        type: "tonwhales-pool-deposit",
+        queryId: "1",
+        gasLimit: "1000000",
+      },
+    },
+  },
+  {
+    name: "tx with payload for tonwhales-pool-withdraw",
+    tx: {
+      ...baseTx,
+      payload: {
+        type: "tonwhales-pool-withdraw",
+        queryId: BigInt(2),
+        gasLimit: BigInt(2000000),
+        amount: BigInt(5000000000),
+      },
+    },
+    rawTx: {
+      ...baseRawTx,
+      payload: {
+        type: "tonwhales-pool-withdraw",
+        queryId: "2",
+        gasLimit: "2000000",
+        amount: "5000000000",
+      },
+    },
+  },
+  {
+    name: "tx with payload for vesting-send-msg-comment",
+    tx: {
+      ...baseTx,
+      payload: {
+        type: "vesting-send-msg-comment",
+        queryId: BigInt(3),
+        sendMode: 3,
+        value: BigInt(42),
+        destination: randomAddress,
+        text: "vesting comment",
+      },
+    },
+    rawTx: {
+      ...baseRawTx,
+      payload: {
+        type: "vesting-send-msg-comment",
+        queryId: "3",
+        sendMode: 3,
+        value: "42",
+        destination: rawRandomAddress,
+        text: "vesting comment",
+      },
+    },
+  },
   {
     name: "tx with payload we don't support",
     tx: {