feat: support Near family

LedgerHQ · Mar 14, 2023 · 30b492e · 30b492e
1 parent 10f0321
commit 30b492e
Show file tree

Hide file tree

Showing 25 changed files with 224 additions and 54 deletions.
diff --git a/.changeset/wet-buttons-warn.md b/.changeset/wet-buttons-warn.md
@@ -0,0 +1,5 @@
+---
+"@ledgerhq/wallet-api-core": minor
+---
+
+Support Near family
diff --git a/packages/core/src/families/common.ts b/packages/core/src/families/common.ts
@@ -18,6 +18,7 @@ export const FAMILIES = [
   "polkadot",
   "stellar",
   "tron",
+  "near",
 ] as const;
 
 export const schemaFamilies = z.enum(FAMILIES);
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 "./near/types";
 export * from "./polkadot/types";
 export * from "./ripple/types";
 export * from "./stellar/types";

diff --git a/packages/core/src/families/near/serializer.ts b/packages/core/src/families/near/serializer.ts
@@ -0,0 +1,34 @@
+import BigNumber from "bignumber.js";
+import type { RawNearTransaction, NearTransaction } from "./types";
+
+export const serializeNearTransaction = ({
+  amount,
+  recipient,
+  family,
+  mode,
+  fees,
+}: NearTransaction): RawNearTransaction => {
+  return {
+    amount: amount.toString(),
+    recipient,
+    family,
+    mode,
+    fees: fees?.toString(),
+  };
+};
+
+export const deserializeNearTransaction = ({
+  amount,
+  recipient,
+  family,
+  mode,
+  fees,
+}: RawNearTransaction): NearTransaction => {
+  return {
+    amount: new BigNumber(amount),
+    recipient,
+    family,
+    mode,
+    fees: fees ? new BigNumber(fees) : undefined,
+  };
+};
diff --git a/packages/core/src/families/near/types.ts b/packages/core/src/families/near/types.ts
@@ -0,0 +1,12 @@
+import type BigNumber from "bignumber.js";
+import type { z } from "zod";
+import type { TransactionCommon } from "../index";
+import type { schemaRawNearTransaction } from "./validation";
+
+export interface NearTransaction extends TransactionCommon {
+  readonly family: RawNearTransaction["family"];
+  mode: string;
+  fees?: BigNumber;
+}
+
+export type RawNearTransaction = z.infer<typeof schemaRawNearTransaction>;
diff --git a/packages/core/src/families/near/validation.ts b/packages/core/src/families/near/validation.ts
@@ -0,0 +1,8 @@
+import { z } from "zod";
+import { schemaFamilies, schemaTransactionCommon } from "../common";
+
+export const schemaRawNearTransaction = schemaTransactionCommon.extend({
+  family: z.literal(schemaFamilies.enum.near),
+  mode: z.string(),
+  fees: z.string().optional(),
+});
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 {
+  deserializeNearTransaction,
+  serializeNearTransaction,
+} from "./near/serializer";
 import {
   deserializePolkadotTransaction,
   serializePolkadotTransaction,
@@ -70,6 +74,8 @@ export function serializeTransaction(transaction: Transaction): RawTransaction {
       return serializeStellarTransaction(transaction);
     case "tron":
       return serializeTronTransaction(transaction);
+    case "near":
+      return serializeNearTransaction(transaction);
     default: {
       const exhaustiveCheck: never = transaction; // https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
       return exhaustiveCheck;
@@ -109,6 +115,8 @@ export function deserializeTransaction(
       return deserializeStellarTransaction(rawTransaction);
     case "tron":
       return deserializeTronTransaction(rawTransaction);
+    case "near":
+      return deserializeNearTransaction(rawTransaction);
     default: {
       const exhaustiveCheck: never = rawTransaction; // https://www.typescriptlang.org/docs/handbook/2/narrowing.html#exhaustiveness-checking
       return exhaustiveCheck;

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 { NearTransaction } from "./near/types";
 import type { PolkadotTransaction } from "./polkadot/types";
 import type { RippleTransaction } from "./ripple/types";
 import type { StellarTransaction } from "./stellar/types";
@@ -63,4 +64,5 @@ export type Transaction =
   | TezosTransaction
   | PolkadotTransaction
   | StellarTransaction
-  | TronTransaction;
+  | TronTransaction
+  | NearTransaction;
diff --git a/packages/core/src/families/validation.ts b/packages/core/src/families/validation.ts
@@ -4,6 +4,7 @@ import { schemaRawBitcoinTransaction } from "./bitcoin/validation";
 import { schemaRawCosmosTransaction } from "./cosmos/validation";
 import { schemaRawCryptoOrgTransaction } from "./crypto_org/validation";
 import { schemaRawEthereumTransaction } from "./ethereum/validation";
+import { schemaRawNearTransaction } from "./near/validation";
 import { schemaRawPolkadotTransaction } from "./polkadot/validation";
 import { schemaRawRippleTransaction } from "./ripple/validation";
 import { schemaRawStellarTransaction } from "./stellar/validation";
@@ -16,6 +17,7 @@ export const schemaRawTransaction = z.discriminatedUnion("family", [
   schemaRawCosmosTransaction,
   schemaRawCryptoOrgTransaction,
   schemaRawEthereumTransaction,
+  schemaRawNearTransaction,
   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
 
 ___
 
@@ -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/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/NearTransaction.md b/website/docs/reference/api/client/interfaces/NearTransaction.md
@@ -0,0 +1,84 @@
+---
+id: "NearTransaction"
+title: "Interface: NearTransaction"
+sidebar_label: "NearTransaction"
+sidebar_position: 0
+custom_edit_url: null
+---
+
+Common fields for all cryptocurrency transactions
+
+## Hierarchy
+
+- [`TransactionCommon`](TransactionCommon.md)
+
+  ↳ **`NearTransaction`**
+
+## 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**: ``"near"``
+
+The family of the transaction
+
+#### Overrides
+
+[TransactionCommon](TransactionCommon.md).[family](TransactionCommon.md#family)
+
+#### Defined in
+
+packages/core/lib/families/near/types.d.ts:6
+
+___
+
+### fees
+
+• `Optional` **fees**: `BigNumber`
+
+#### Defined in
+
+packages/core/lib/families/near/types.d.ts:8
+
+___
+
+### mode
+
+• **mode**: `string`
+
+#### Defined in
+
+packages/core/lib/families/near/types.d.ts:7
+
+___
+
+### 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)
 
+  ↳ [`NearTransaction`](NearTransaction.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"`` \| ``"tezos"`` \| ``"polkadot"`` \| ``"stellar"`` \| ``"tron"`` \| ``"near"``
 
 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