Add optional attributes to PolkadotTransaction (#271)

* chore: add missing attributes for polkadot transactions * chore: add changeset * fix: remove bondExtra - case handled separately
LedgerHQ · Dec 7, 2023 · 6a5771c · 6a5771c · vercel · Dec 7, 2023
1 parent a466649
commit 6a5771c
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/.changeset/metal-dolls-punch.md b/.changeset/metal-dolls-punch.md
@@ -0,0 +1,5 @@
+---
+"@ledgerhq/wallet-api-core": minor
+---
+
+add optional attributes for PolkadotTransaction
diff --git a/packages/core/src/families/polkadot/serializer.ts b/packages/core/src/families/polkadot/serializer.ts
@@ -8,13 +8,19 @@ export const serializePolkadotTransaction = ({
   mode,
   fee,
   era,
+  validators,
+  numOfSlashingSpans,
+  rewardDestination,
 }: PolkadotTransaction): RawPolkadotTransaction => ({
   amount: amount.toString(),
   recipient,
   family,
   mode,
   fee: fee ? fee.toString() : undefined,
   era,
+  validators,
+  numOfSlashingSpans,
+  rewardDestination,
 });
 
 export const deserializePolkadotTransaction = ({
@@ -24,11 +30,17 @@ export const deserializePolkadotTransaction = ({
   mode,
   fee,
   era,
+  validators,
+  numOfSlashingSpans,
+  rewardDestination,
 }: RawPolkadotTransaction): PolkadotTransaction => ({
   amount: new BigNumber(amount),
   recipient,
   family,
   mode,
   fee: fee ? new BigNumber(fee) : undefined,
   era,
+  validators,
+  numOfSlashingSpans,
+  rewardDestination,
 });
diff --git a/packages/core/src/families/polkadot/types.ts b/packages/core/src/families/polkadot/types.ts
@@ -1,18 +1,25 @@
-import type BigNumber from "bignumber.js";
+import BigNumber from "bignumber.js";
 import type { z } from "zod";
-import type { TransactionCommon } from "../index";
+import { TransactionCommon } from "../types";
 import type {
   schemaPolkadotOperationMode,
+  schemaPolkadotRewardDestination,
   schemaRawPolkadotTransaction,
 } from "./validation";
 
 export type PolkadotOperationMode = z.infer<typeof schemaPolkadotOperationMode>;
+export type PolkadotRewardDestination = z.infer<
+  typeof schemaPolkadotRewardDestination
+>;
 
 export type PolkadotTransaction = TransactionCommon & {
   readonly family: RawPolkadotTransaction["family"];
   mode: PolkadotOperationMode;
   fee?: BigNumber;
   era?: number;
+  validators?: string[];
+  numOfSlashingSpans?: number;
+  rewardDestination?: PolkadotRewardDestination;
 };
 
 export type RawPolkadotTransaction = z.infer<

diff --git a/packages/core/src/families/polkadot/validation.ts b/packages/core/src/families/polkadot/validation.ts
@@ -13,9 +13,20 @@ export const schemaPolkadotOperationMode = z.enum([
   "claimReward",
 ]);
 
+export const schemaPolkadotRewardDestination = z.enum([
+  "Staked",
+  "Stash",
+  "Controller",
+  "Account",
+  "None",
+]);
+
 export const schemaRawPolkadotTransaction = schemaTransactionCommon.extend({
   family: z.literal(schemaFamilies.enum.polkadot),
   mode: schemaPolkadotOperationMode,
   fee: z.string().optional(),
   era: z.number().optional(),
+  validators: z.array(z.string()).optional(),
+  rewardDestination: schemaPolkadotRewardDestination.optional(),
+  numOfSlashingSpans: z.number().optional(),
 });