feat: integrate hedera family

LedgerHQ · Mar 17, 2023 · c083a8c · c083a8c
1 parent da89c62
commit c083a8c
Show file tree

Hide file tree

Showing 26 changed files with 211 additions and 54 deletions.
diff --git a/.changeset/itchy-gorillas-punch.md b/.changeset/itchy-gorillas-punch.md
@@ -0,0 +1,6 @@
+---
+"@ledgerhq/wallet-api-core": minor
+"wallet-api-website": minor
+---
+
+Integrate hedera family
diff --git a/.gitignore b/.gitignore
@@ -39,4 +39,7 @@ lib/
 lib-es/
 
 # eslint cache
-.eslintcache
+.eslintcache
+
+# ide
+.idea
diff --git a/packages/core/src/families/common.ts b/packages/core/src/families/common.ts
@@ -14,6 +14,7 @@ export const FAMILIES = [
   "cosmos",
   "ripple",
   "cosmos",
+  "hedera",
   "tezos",
   "polkadot",
   "stellar",

diff --git a/packages/core/src/families/hedera/serializer.ts b/packages/core/src/families/hedera/serializer.ts
@@ -0,0 +1,30 @@
+import BigNumber from "bignumber.js";
+import type { HederaTransaction, RawHederaTransaction } from "./types";
+
+export function serializeHederaTransaction({
+  amount,
+  family,
+  memo = undefined,
+  recipient,
+}: HederaTransaction): RawHederaTransaction {
+  return {
+    amount: amount.toString(),
+    family,
+    memo,
+    recipient,
+  };
+}
+
+export function deserializeHederaTransaction({
+  amount,
+  family,
+  memo = undefined,
+  recipient,
+}: RawHederaTransaction): HederaTransaction {
+  return {
+    amount: new BigNumber(amount),
+    family,
+    memo,
+    recipient,
+  };
+}
diff --git a/packages/core/src/families/hedera/types.ts b/packages/core/src/families/hedera/types.ts
@@ -0,0 +1,10 @@
+import type { z } from "zod";
+import type { TransactionCommon } from "../index";
+import type { schemaRawHederaTransaction } from "./validation";
+
+export interface HederaTransaction extends TransactionCommon {
+  readonly family: RawHederaTransaction["family"];
+  memo?: string;
+}
+
+export type RawHederaTransaction = z.infer<typeof schemaRawHederaTransaction>;
diff --git a/packages/core/src/families/hedera/validation.ts b/packages/core/src/families/hedera/validation.ts
@@ -0,0 +1,7 @@
+import { z } from "zod";
+import { schemaFamilies, schemaTransactionCommon } from "../common";
+
+export const schemaRawHederaTransaction = schemaTransactionCommon.extend({
+  family: z.literal(schemaFamilies.enum.hedera),
+  memo: z.string().optional(),
+});
diff --git a/packages/core/src/families/index.ts b/packages/core/src/families/index.ts
@@ -3,6 +3,7 @@ export * from "./bitcoin/types";
 export * from "./cosmos/types";
 export * from "./crypto_org/types";
 export * from "./ethereum/types";
+export * from "./hedera/types";
 export * from "./polkadot/types";
 export * from "./ripple/types";
 export * from "./stellar/types";

diff --git a/packages/core/src/families/serializer.ts b/packages/core/src/families/serializer.ts
@@ -18,6 +18,10 @@ import {
   deserializeEthereumTransaction,
   serializeEthereumTransaction,
 } from "./ethereum/serializer";
+import {
+  deserializeHederaTransaction,
+  serializeHederaTransaction,
+} from "./hedera/serializer";
 import {
   deserializePolkadotTransaction,
   serializePolkadotTransaction,
@@ -62,6 +66,8 @@ export function serializeTransaction(transaction: Transaction): RawTransaction {
       return serializeRippleTransaction(transaction);
     case "cosmos":
       return serializeCosmosTransaction(transaction);
+    case "hedera":
+      return serializeHederaTransaction(transaction);
     case "tezos":
       return serializeTezosTransaction(transaction);
     case "polkadot":
@@ -101,6 +107,8 @@ export function deserializeTransaction(
       return deserializeRippleTransaction(rawTransaction);
     case "cosmos":
       return deserializeCosmosTransaction(rawTransaction);
+    case "hedera":
+      return deserializeHederaTransaction(rawTransaction);
     case "tezos":
       return deserializeTezosTransaction(rawTransaction);
     case "polkadot":

diff --git a/packages/core/src/families/types.ts b/packages/core/src/families/types.ts
@@ -6,6 +6,7 @@ import type { schemaFamilies } from "./common";
 import type { CosmosTransaction } from "./cosmos/types";
 import type { CryptoOrgTransaction } from "./crypto_org/types";
 import type { EthereumTransaction } from "./ethereum/types";
+import type { HederaTransaction } from "./hedera/types";
 import type { PolkadotTransaction } from "./polkadot/types";
 import type { RippleTransaction } from "./ripple/types";
 import type { StellarTransaction } from "./stellar/types";
@@ -58,6 +59,7 @@ export type Transaction =
   | BitcoinTransaction
   | AlgorandTransaction
   | CryptoOrgTransaction
+  | HederaTransaction
   | RippleTransaction
   | CosmosTransaction
   | TezosTransaction

diff --git a/packages/core/src/families/validation.ts b/packages/core/src/families/validation.ts
@@ -9,13 +9,15 @@ import { schemaRawRippleTransaction } from "./ripple/validation";
 import { schemaRawStellarTransaction } from "./stellar/validation";
 import { schemaRawTezosTransaction } from "./tezos/validation";
 import { schemaRawTronTransaction } from "./tron/validation";
+import { schemaRawHederaTransaction } from "./hedera/validation";
 
 export const schemaRawTransaction = z.discriminatedUnion("family", [
   schemaRawAlgorandTransaction,
   schemaRawBitcoinTransaction,
   schemaRawCosmosTransaction,
   schemaRawCryptoOrgTransaction,
   schemaRawEthereumTransaction,
+  schemaRawHederaTransaction,
   schemaRawPolkadotTransaction,
   schemaRawRippleTransaction,
   schemaRawStellarTransaction,

diff --git a/website/docs/reference/api/client/index.md b/website/docs/reference/api/client/index.md
diff --git a/website/docs/reference/api/client/interfaces/AlgorandTransaction.md b/website/docs/reference/api/client/interfaces/AlgorandTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -101,4 +101,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/BitcoinTransaction.md b/website/docs/reference/api/client/interfaces/BitcoinTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -71,4 +71,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/CosmosTransaction.md b/website/docs/reference/api/client/interfaces/CosmosTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -101,4 +101,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/CryptoOrgTransaction.md b/website/docs/reference/api/client/interfaces/CryptoOrgTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -81,4 +81,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/EthereumTransaction.md b/website/docs/reference/api/client/interfaces/EthereumTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -101,4 +101,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/HederaTransaction.md b/website/docs/reference/api/client/interfaces/HederaTransaction.md
@@ -0,0 +1,74 @@
+---
+id: "HederaTransaction"
+title: "Interface: HederaTransaction"
+sidebar_label: "HederaTransaction"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Common fields for all cryptocurrency transactions
+
+## Hierarchy
+
+- [`TransactionCommon`](TransactionCommon.md)
+
+  ↳ **`HederaTransaction`**
+
+## Properties
+
+### amount
+
+• **amount**: `BigNumber`
+
+The amount of token to send in the transaction, denoted in the smallest cryptocurrency's magnitude
+For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx corresponding to 0.00000001 BTC
+
+#### Inherited from
+
+[TransactionCommon](TransactionCommon.md).[amount](TransactionCommon.md#amount)
+
+#### Defined in
+
+packages/core/lib/families/types.d.ts:38
+
+___
+
+### family
+
+• `Readonly` **family**: ``"hedera"``
+
+The family of the transaction
+
+#### Overrides
+
+[TransactionCommon](TransactionCommon.md).[family](TransactionCommon.md#family)
+
+#### Defined in
+
+packages/core/lib/families/hedera/types.d.ts:5
+
+___
+
+### memo
+
+• `Optional` **memo**: `string`
+
+#### Defined in
+
+packages/core/lib/families/hedera/types.d.ts:6
+
+___
+
+### recipient
+
+• **recipient**: `string`
+
+The address of the transaction's recipient
+
+#### Inherited from
+
+[TransactionCommon](TransactionCommon.md).[recipient](TransactionCommon.md#recipient)
+
+#### Defined in
+
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/PolkadotTransaction.md b/website/docs/reference/api/client/interfaces/PolkadotTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -91,4 +91,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/RippleTransaction.md b/website/docs/reference/api/client/interfaces/RippleTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -71,7 +71,7 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
 
 ___
 

diff --git a/website/docs/reference/api/client/interfaces/StellarTransaction.md b/website/docs/reference/api/client/interfaces/StellarTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -91,4 +91,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/TezosTransaction.md b/website/docs/reference/api/client/interfaces/TezosTransaction.md
@@ -29,7 +29,7 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
@@ -91,4 +91,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42
diff --git a/website/docs/reference/api/client/interfaces/TransactionCommon.md b/website/docs/reference/api/client/interfaces/TransactionCommon.md
@@ -22,6 +22,8 @@ Common fields for all cryptocurrency transactions
 
   ↳ [`EthereumTransaction`](EthereumTransaction.md)
 
+  ↳ [`HederaTransaction`](HederaTransaction.md)
+
   ↳ [`PolkadotTransaction`](PolkadotTransaction.md)
 
   ↳ [`RippleTransaction`](RippleTransaction.md)
@@ -43,19 +45,19 @@ For example in BTC, a tx with an 'amount' field of 1 will correspond to a tx cor
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:37
+packages/core/lib/families/types.d.ts:38
 
 ___
 
 ### family
 
-• **family**: ``"bitcoin"`` \| ``"ethereum"`` \| ``"algorand"`` \| ``"crypto_org"`` \| ``"ripple"`` \| ``"cosmos"`` \| ``"tezos"`` \| ``"polkadot"`` \| ``"stellar"`` \| ``"tron"``
+• **family**: ``"bitcoin"`` \| ``"ethereum"`` \| ``"algorand"`` \| ``"crypto_org"`` \| ``"ripple"`` \| ``"cosmos"`` \| ``"hedera"`` \| ``"tezos"`` \| ``"polkadot"`` \| ``"stellar"`` \| ``"tron"``
 
 The family of the transaction
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:32
+packages/core/lib/families/types.d.ts:33
 
 ___
 
@@ -67,4 +69,4 @@ The address of the transaction's recipient
 
 #### Defined in
 
-packages/core/lib/families/types.d.ts:41
+packages/core/lib/families/types.d.ts:42