@ledgerhq/coin-canton 0.5.0-nightly.4 → 0.5.0-nightly.5

package/src/network/gateway.integ.test.ts

@@ -13,6 +13,11 @@ import {
   preparePreApprovalTransaction,
   submitPreApprovalTransaction,
 } from "./gateway";
+import type { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
+
+const mockCurrency = {
+  id: "canton_network",
+} as unknown as CryptoCurrency;
 
 describe("gateway (devnet)", () => {
   let onboardedAccount: {
@@ -50,7 +55,7 @@ describe("gateway (devnet)", () => {
       };
 
       // WHEN
-      const response = await prepareOnboarding(keyPair.publicKeyHex, "ed25519");
+      const response = await prepareOnboarding(mockCurrency, keyPair.publicKeyHex, "ed25519");
 
       // THEN
       expect(response).toHaveProperty("party_id");
@@ -70,11 +75,20 @@ describe("gateway (devnet)", () => {
       // GIVEN
       const { keyPair } = getOnboardedAccount();
       const prepareRequest = { public_key: keyPair.publicKeyHex, public_key_type: "ed25519" };
-      const prepareResponse = await prepareOnboarding(keyPair.publicKeyHex, "ed25519");
+      const prepareResponse = await prepareOnboarding(
+        mockCurrency,
+        keyPair.publicKeyHex,
+        "ed25519",
+      );
       const signature = keyPair.sign(prepareResponse.transactions.combined_hash);
 
       // WHEN
-      const response = await submitOnboarding(prepareRequest, prepareResponse, signature);
+      const response = await submitOnboarding(
+        mockCurrency,
+        prepareRequest,
+        prepareResponse,
+        signature,
+      );
 
       // Save onboarded account for all tests that need a valid party ID
       onboardedAccount = {
@@ -92,7 +106,7 @@ describe("gateway (devnet)", () => {
 
   describe("getLedgerEnd", () => {
     it("should return ledger end", async () => {
-      const end = await getLedgerEnd();
+      const end = await getLedgerEnd(mockCurrency);
       expect(end).toBeGreaterThanOrEqual(0);
     });
   });
@@ -100,7 +114,7 @@ describe("gateway (devnet)", () => {
   describe("getBalance", () => {
     it("should return user balance", async () => {
       const { partyId } = getOnboardedAccount();
-      const balance = await getBalance(partyId);
+      const balance = await getBalance(mockCurrency, partyId);
       expect(balance.length).toBeGreaterThanOrEqual(0);
       if (balance.length > 0) {
         expect(balance[0].amount).toBeGreaterThanOrEqual(0);
@@ -111,7 +125,7 @@ describe("gateway (devnet)", () => {
 
   describe("getPartyById", () => {
     it.skip("should return party info", async () => {
-      const party = await getPartyById("4f2e1485107adf5f");
+      const party = await getPartyById(mockCurrency, "4f2e1485107adf5f");
       expect(party).toBeDefined();
     });
   });
@@ -119,6 +133,7 @@ describe("gateway (devnet)", () => {
   describe("getPartyByPubKey", () => {
     it.skip("should return party info", async () => {
       const party = await getPartyByPubKey(
+        mockCurrency,
         "122027c6dbbbdbffe0fa3122ae05175f3b9328e879e9ce96b670354deb64a45683c1",
       );
       expect(party).toBeDefined();
@@ -128,7 +143,9 @@ describe("gateway (devnet)", () => {
   describe("getOperations", () => {
     it("should return user transactions", async () => {
       const { operations } = await getOperations(
+        mockCurrency,
         "party-5f29bb32e9939939::12202becd8062a1d170209956cfd977fca76fcb4d2a892d08c77a7483f35a11d6440",
+        {},
       );
       expect(operations.length).toBeGreaterThanOrEqual(0);
     });
@@ -141,7 +158,7 @@ describe("gateway (devnet)", () => {
       const amount = 1000;
 
       // WHEN
-      const response = await prepareTapRequest({ partyId, amount });
+      const response = await prepareTapRequest(mockCurrency, { partyId, amount });
 
       // THEN
       expect(response).toHaveProperty("serialized");
@@ -155,14 +172,14 @@ describe("gateway (devnet)", () => {
     it("should submit tap request with proper signature", async () => {
       // GIVEN
       const { keyPair, partyId } = getOnboardedAccount();
-      const tapPrepareResponse = await prepareTapRequest({
+      const tapPrepareResponse = await prepareTapRequest(mockCurrency, {
         partyId,
         amount: 1000,
       });
       const tapSignature = keyPair.sign(tapPrepareResponse.hash);
 
       // WHEN
-      const response = await submitTapRequest({
+      const response = await submitTapRequest(mockCurrency, {
         partyId,
         serialized: tapPrepareResponse.serialized,
         signature: tapSignature,
@@ -182,7 +199,7 @@ describe("gateway (devnet)", () => {
       const { partyId } = getOnboardedAccount();
 
       // WHEN
-      const response = await preparePreApprovalTransaction(partyId);
+      const response = await preparePreApprovalTransaction(mockCurrency, partyId);
 
       // THEN
       expect(response).toHaveProperty("serialized");
@@ -196,11 +213,12 @@ describe("gateway (devnet)", () => {
     it("should submit pre-approval transaction with proper signature", async () => {
       // GIVEN
       const { keyPair, partyId } = getOnboardedAccount();
-      const preparedTransaction = await preparePreApprovalTransaction(partyId);
+      const preparedTransaction = await preparePreApprovalTransaction(mockCurrency, partyId);
       const preApprovalSignature = keyPair.sign(preparedTransaction.hash);
 
       // WHEN
       const response = await submitPreApprovalTransaction(
+        mockCurrency,
         partyId,
         preparedTransaction,
         preApprovalSignature,

package/src/network/gateway.ts

@@ -9,6 +9,7 @@ import {
   SubmitTransactionResponse,
   PreApprovalResult,
 } from "../types/onboard";
+import type { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 
 type OnboardingPrepareResponse = {
   party_id: string;
@@ -47,7 +48,7 @@ export type PrepareTransferResponse = {
 
 export type PrepareTransferRequest = {
   type: "token-transfer-request";
-  amount: number;
+  amount: string;
   recipient: string;
   execute_before_secs: number;
   instrument_id: string;
@@ -151,6 +152,9 @@ export type OperationInfo =
           asset: string;
           details: {
             type: "pre-approval";
+            metadata: {
+              reason?: string;
+            };
           };
         },
       ];
@@ -193,6 +197,9 @@ export type OperationInfo =
           asset: string;
           details: {
             type: "tap";
+            metadata: {
+              reason?: string;
+            };
           };
         },
       ];
@@ -235,6 +242,9 @@ export type OperationInfo =
           asset: string;
           details: {
             type: "transfer";
+            metadata: {
+              reason?: string;
+            };
           };
         },
       ];
@@ -262,9 +272,10 @@ export type OperationInfo =
       };
     };
 
-const getGatewayUrl = () => coinConfig.getCoinConfig().gatewayUrl;
-const getNodeId = () => coinConfig.getCoinConfig().nodeId || "ledger-devnet-stg";
-const getNetworkType = () => coinConfig.getCoinConfig().networkType;
+const getGatewayUrl = (currency: CryptoCurrency) => coinConfig.getCoinConfig(currency).gatewayUrl;
+const getNodeId = (currency: CryptoCurrency) =>
+  coinConfig.getCoinConfig(currency).nodeId || "ledger-devnet-stg";
+const getNetworkType = (currency: CryptoCurrency) => coinConfig.getCoinConfig(currency).networkType;
 
 const gatewayNetwork = <T, U = unknown>(req: LiveNetworkRequest<U>) => {
   const API_KEY = getEnv("CANTON_API_KEY");
@@ -278,11 +289,12 @@ const gatewayNetwork = <T, U = unknown>(req: LiveNetworkRequest<U>) => {
 };
 
 export async function prepareOnboarding(
+  currency: CryptoCurrency,
   pubKey: string,
   pubKeyType: string,
 ): Promise<OnboardingPrepareResponse> {
-  const gatewayUrl = getGatewayUrl();
-  const nodeId = getNodeId();
+  const gatewayUrl = getGatewayUrl(currency);
+  const nodeId = getNodeId(currency);
   const fullUrl = `${gatewayUrl}/v1/node/${nodeId}/onboarding/prepare`;
 
   const { data } = await gatewayNetwork<OnboardingPrepareResponse, OnboardingPrepareRequest>({
@@ -298,13 +310,14 @@ export async function prepareOnboarding(
 }
 
 export async function submitOnboarding(
+  currency: CryptoCurrency,
   prepareRequest: OnboardingPrepareRequest,
   prepareResponse: OnboardingPrepareResponse,
   signature: string,
 ) {
   const { data } = await gatewayNetwork<OnboardingSubmitResponse, OnboardingSubmitRequest>({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/onboarding/submit`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/onboarding/submit`,
     data: {
       prepare_request: prepareRequest,
       prepare_response: prepareResponse,
@@ -314,10 +327,15 @@ export async function submitOnboarding(
   return data;
 }
 
-export async function submit(partyId: string, serialized: string, signature: string) {
+export async function submit(
+  currency: CryptoCurrency,
+  partyId: string,
+  serialized: string,
+  signature: string,
+) {
   const { data } = await gatewayNetwork<TransactionSubmitResponse, TransactionSubmitRequest>({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/transaction/submit`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/transaction/submit`,
     data: {
       serialized,
       signature,
@@ -326,31 +344,42 @@ export async function submit(partyId: string, serialized: string, signature: str
   return data;
 }
 
-export async function getBalance(partyId: string): Promise<InstrumentBalance[]> {
+export async function getBalance(
+  currency: CryptoCurrency,
+  partyId: string,
+): Promise<InstrumentBalance[]> {
   const { data } = await gatewayNetwork<InstrumentBalance[]>({
     method: "GET",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/balance`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/balance`,
   });
   return data;
 }
 
-export async function getPartyById(partyId: string): Promise<PartyInfo> {
-  return await getParty(partyId, "party-id");
+export async function getPartyById(currency: CryptoCurrency, partyId: string): Promise<PartyInfo> {
+  return await getParty(currency, partyId, "party-id");
 }
 
-export async function getPartyByPubKey(pubKey: string): Promise<PartyInfo> {
-  return await getParty(pubKey, "public-key");
+export async function getPartyByPubKey(
+  currency: CryptoCurrency,
+  pubKey: string,
+): Promise<PartyInfo> {
+  return await getParty(currency, pubKey, "public-key");
 }
 
-async function getParty(identifier: string, by: "party-id" | "public-key"): Promise<PartyInfo> {
+async function getParty(
+  currency: CryptoCurrency,
+  identifier: string,
+  by: "party-id" | "public-key",
+): Promise<PartyInfo> {
   const { data } = await gatewayNetwork<PartyInfo>({
     method: "GET",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${identifier}?by=${by}`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${identifier}?by=${by}`,
   });
   return data;
 }
 
 export async function getOperations(
+  currency: CryptoCurrency,
   partyId: string,
   options?: {
     cursor?: number | undefined;
@@ -367,7 +396,7 @@ export async function getOperations(
     operations: OperationInfo[];
   }>({
     method: "GET",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/operations`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/operations`,
     params: options,
   });
   return data;
@@ -389,11 +418,11 @@ enum TransactionType {
   TRANSFER_PRE_APPROVAL_PROPOSAL = "transfer-pre-approval-proposal",
 }
 
-export async function prepareTapRequest({
-  partyId,
-  amount = 1000000,
-}: PrepareTapRequest): Promise<PrepareTapResponse> {
-  if (getNetworkType() === "mainnet") {
+export async function prepareTapRequest(
+  currency: CryptoCurrency,
+  { partyId, amount = 1000000 }: PrepareTapRequest,
+): Promise<PrepareTapResponse> {
+  if (getNetworkType(currency) === "mainnet") {
     return {
       serialized: "",
       json: null,
@@ -402,7 +431,7 @@ export async function prepareTapRequest({
   }
   const { data } = await gatewayNetwork<PrepareTapResponse, { amount: number; type: string }>({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/transaction/prepare`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/transaction/prepare`,
     data: {
       amount: parseInt(amount.toString(), 10), // Convert to integer to avoid scientific notation
       type: TransactionType.TAP_REQUEST,
@@ -422,17 +451,16 @@ type SubmitTapRequestResponse = {
   update_id: string;
 };
 
-export async function submitTapRequest({
-  partyId,
-  serialized,
-  signature,
-}: SubmitTapRequestRequest): Promise<SubmitTapRequestResponse> {
+export async function submitTapRequest(
+  currency: CryptoCurrency,
+  { partyId, serialized, signature }: SubmitTapRequestRequest,
+): Promise<SubmitTapRequestResponse> {
   const { data } = await gatewayNetwork<
     SubmitTapRequestResponse,
     Omit<SubmitTapRequestRequest, "partyId">
   >({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/transaction/submit`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/transaction/submit`,
     data: {
       serialized,
       signature,
@@ -442,31 +470,33 @@ export async function submitTapRequest({
 }
 
 export async function prepareTransferRequest(
+  currency: CryptoCurrency,
   partyId: string,
   params: PrepareTransferRequest,
 ): Promise<PrepareTransferResponse> {
   const { data } = await gatewayNetwork<PrepareTransferResponse, PrepareTransferRequest>({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/transaction/prepare`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/transaction/prepare`,
     data: params,
   });
   return data;
 }
 
-export async function getLedgerEnd(): Promise<number> {
+export async function getLedgerEnd(currency: CryptoCurrency): Promise<number> {
   const { data } = await gatewayNetwork<number>({
     method: "GET",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/ledger-end`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/ledger-end`,
   });
   return data;
 }
 
 export async function preparePreApprovalTransaction(
+  currency: CryptoCurrency,
   partyId: string,
 ): Promise<PrepareTransactionResponse> {
   const { data } = await gatewayNetwork<PrepareTransactionResponse, PrepareTransactionRequest>({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/transaction/prepare`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/transaction/prepare`,
     data: {
       type: TransactionType.TRANSFER_PRE_APPROVAL_PROPOSAL,
       receiver: partyId,
@@ -476,13 +506,14 @@ export async function preparePreApprovalTransaction(
 }
 
 export async function submitPreApprovalTransaction(
+  currency: CryptoCurrency,
   partyId: string,
   { serialized }: PrepareTransactionResponse,
   signature: string,
 ): Promise<PreApprovalResult> {
   const { data } = await gatewayNetwork<SubmitTransactionResponse, SubmitTransactionRequest>({
     method: "POST",
-    url: `${getGatewayUrl()}/v1/node/${getNodeId()}/party/${partyId}/transaction/submit`,
+    url: `${getGatewayUrl(currency)}/v1/node/${getNodeId(currency)}/party/${partyId}/transaction/submit`,
     data: {
       serialized,
       signature,

package/src/types/bridge.ts

@@ -15,13 +15,16 @@ import type {
   CantonPreApprovalProgress,
   CantonPreApprovalResult,
 } from "./onboard";
+import type { CryptoCurrency } from "@ledgerhq/types-cryptoassets";
 
 export interface CantonCurrencyBridge extends CurrencyBridge {
   onboardAccount: (
+    currency: CryptoCurrency,
     deviceId: string,
     derivationPath: string,
   ) => Observable<CantonOnboardProgress | CantonOnboardResult>;
   authorizePreapproval: (
+    currency: CryptoCurrency,
     deviceId: string,
     derivationPath: string,
     partyId: string,
@@ -43,11 +46,13 @@ export type NetworkInfoRaw = {
 export type Transaction = TransactionCommon & {
   family: "canton";
   fee: BigNumber | null | undefined;
+  memo?: string;
 };
 
 export type TransactionRaw = TransactionCommonRaw & {
   family: "canton";
   fee: string | null | undefined;
+  memo?: string;
 };
 
 export type TransactionStatus = TransactionStatusCommon;