feat: osmosis swap messages

Author: mateuszjasiuk

apps/namadillo/src/App/AppRoutes.tsx

@@ -20,6 +20,7 @@ import { ProposalAndVote } from "./Governance/ProposalAndVote";
 import { SubmitVote } from "./Governance/SubmitVote";
 import { ViewJson } from "./Governance/ViewJson";
 import { IbcShieldAll } from "./Ibc/IbcShieldAll";
+import { OsmosisSwap } from "./Ibc/OsmosisSwap";
 import { MoveAssets } from "./Layout/MoveAssets";
 import { routes } from "./routes";
 import { Advanced } from "./Settings/Advanced";
@@ -110,6 +111,13 @@ export const MainRoutes = (): JSX.Element => {
             </>
           )}
 
+          {/* Swapping */}
+          {true && (
+            <>
+              <Route path={routes.swap} element={<OsmosisSwap />} />
+            </>
+          )}
+
           {/* Transaction History */}
           {(features.namTransfersEnabled || features.ibcTransfersEnabled) && (
             <Route>

apps/namadillo/src/App/Ibc/OsmosisSwap.tsx

@@ -0,0 +1,80 @@
+import { defaultAccountAtom } from "atoms/accounts";
+import { createOsmosisSwapTxAtom } from "atoms/transfer/atoms";
+import BigNumber from "bignumber.js";
+import invariant from "invariant";
+import { useAtomValue } from "jotai";
+import { useEffect } from "react";
+
+export const OsmosisSwap: React.FC = () => {
+  const { mutateAsync: performOsmosisSwap } = useAtomValue(
+    createOsmosisSwapTxAtom
+  );
+
+  const account = useAtomValue(defaultAccountAtom);
+
+  useEffect(() => {
+    const handleOsmosisSwap = async (): Promise<void> => {
+      invariant(account.data, "No transparent account is found");
+
+      const transfer = {
+        amountInBaseDenom: BigNumber(10),
+        // osmosis channel
+        channelId: "channel-7",
+        portId: "transfer",
+        token: "tnam1p4zuqqd94csj6zv8n0jxylz9kex4vdsgvg3uglw9",
+        source:
+          "03d5935721000000803fe3d7a9c42c483e5c3840c13eb7dadec2e420f850a769342a2786b58c86215d1fd1ca29f99d94bf033533a30b3461a2dacc4d0f968a080a2a335a085525d18b29f5e59e281a297c35d62299ff82a1525ae327862aca92d01faceebe375af12530bf9eff49e6f90c2eb554db591b1fc30694c716635f0bd2050682d6eeb6a2c5438dd7725495fb866d76db12de4e44ad9be424af57d12c8c19a6dc8664825d8701000000000000000000000000000000000000000000000000000000000000000001f3d7b291d734e35aefd38601bc947778d3adefc9ee2defd8d745fe124e850d0b",
+        receiver:
+          "osmo1ewll8h7up3g0ca2z9ur9e6dv6an64snxg5k8tmzylg6uprkyhgzszjgdzr",
+        gasSpendingKey:
+          "03d5935721000000803fe3d7a9c42c483e5c3840c13eb7dadec2e420f850a769342a2786b58c86215d1fd1ca29f99d94bf033533a30b3461a2dacc4d0f968a080a2a335a085525d18b29f5e59e281a297c35d62299ff82a1525ae327862aca92d01faceebe375af12530bf9eff49e6f90c2eb554db591b1fc30694c716635f0bd2050682d6eeb6a2c5438dd7725495fb866d76db12de4e44ad9be424af57d12c8c19a6dc8664825d8701000000000000000000000000000000000000000000000000000000000000000001f3d7b291d734e35aefd38601bc947778d3adefc9ee2defd8d745fe124e850d0b",
+        refundTarget: "tnam1qz24lx0mz3y9uahfkxvnurnynqe898actvzyy22y",
+      };
+      const params = {
+        transfer,
+        // We want to receive TIA
+        outputDenom: "transfer/channel-10/utia",
+        recipient: "tnam1qqshvryx9pngpk7mmzpzkjkm6klelgusuvmkc0uz",
+        overflow: "tnam1qqshvryx9pngpk7mmzpzkjkm6klelgusuvmkc0uz",
+        slippage: { 0: "1" },
+        localRecoveryAddr: "osmo1sy99khct7t7wth2wus5xpwkcf6n8p0lvrnwelh",
+        route: [
+          {
+            poolId: "1464",
+            tokenOutDenom:
+              "ibc/498A0751C798A0D9A389AA3691123DADA57DAA4FE165D5C75894505B876BA6E4",
+          },
+          {
+            poolId: "1247",
+            tokenOutDenom:
+              "ibc/D79E7D83AB399BFFF93433E54FAA480C191248FC556924A2A8351AE2638B3877",
+          },
+        ],
+        osmosisRestRpc: "https://osmosis-rest.publicnode.com",
+      };
+
+      try {
+        await performOsmosisSwap({
+          signer: {
+            publicKey: account.data.publicKey!,
+            address: account.data.address!,
+          },
+          account: account.data,
+          params: [params],
+          gasConfig: {
+            gasLimit: BigNumber(75000),
+            gasPriceInMinDenom: BigNumber(0.000001),
+            gasToken: "tnam1p4zuqqd94csj6zv8n0jxylz9kex4vdsgvg3uglw9",
+          },
+        });
+      } catch (error) {
+        console.error("Error performing Osmosis swap:", error);
+      }
+    };
+
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (window as any).osmosisSwap = handleOsmosisSwap;
+  }, [account.data]);
+
+  return <></>;
+};

apps/namadillo/src/App/routes.ts

@@ -32,6 +32,9 @@ export const routes = {
   transaction: "/transaction/:hash",
   receive: "/receive",
 
+  // Swap
+  swap: "/swap",
+
   // Settings
   settings: "/settings",
   settingsAdvanced: "/settings/advanced",

apps/namadillo/src/atoms/transfer/atoms.ts

@@ -1,6 +1,7 @@
 import {
   DatedViewingKey,
   IbcTransferMsgValue,
+  OsmosisSwapMsgValue,
   ShieldedTransferMsgValue,
   ShieldingTransferMsgValue,
   TransparentTransferMsgValue,
@@ -21,6 +22,7 @@ import { atomWithMutation } from "jotai-tanstack-query";
 import { BuildTxAtomParams } from "types";
 import {
   createIbcTx,
+  createOsmosisSwapTx,
   createShieldedTransferTx,
   createShieldingTransferTx,
   createTransparentTransferTx,
@@ -236,3 +238,38 @@ export const createIbcTxAtom = atomWithMutation((get) => {
     },
   };
 });
+
+export const createOsmosisSwapTxAtom = atomWithMutation((get) => {
+  const account = get(defaultAccountAtom);
+  const chain = get(chainAtom);
+  const rpcUrl = get(rpcUrlAtom);
+
+  return {
+    enabled: account.isSuccess && chain.isSuccess,
+    mutationKey: ["create-ibc-tx"],
+    mutationFn: async ({
+      params,
+      gasConfig,
+      account,
+      signer,
+      memo,
+    }: BuildTxAtomParams<OsmosisSwapMsgValue>) => {
+      invariant(
+        signer,
+        "We always expect signer to be passed explicitly, because we might also need to unshield"
+      );
+      invariant(account, "No account");
+      invariant(params.length !== 0, "No params");
+
+      return await createOsmosisSwapTx(
+        chain.data!,
+        account,
+        params,
+        gasConfig,
+        rpcUrl,
+        signer?.publicKey,
+        memo
+      );
+    },
+  };
+});

apps/namadillo/src/atoms/transfer/services.ts

@@ -5,6 +5,8 @@ import {
   GenDisposableSignerResponse,
   IbcTransferMsgValue,
   IbcTransferProps,
+  OsmosisSwapMsgValue,
+  OsmosisSwapProps,
   ShieldedTransferMsgValue,
   ShieldedTransferProps,
   ShieldingTransferMsgValue,
@@ -22,6 +24,7 @@ import { Address, ChainSettings, GasConfig } from "types";
 import { getSdkInstance } from "utils/sdk";
 import {
   IbcTransfer,
+  OsmosisSwap,
   Shield,
   ShieldedTransfer,
   Unshield,
@@ -309,3 +312,52 @@ export const createIbcTx = async (
     },
   });
 };
+
+export const createOsmosisSwapTx = async (
+  chain: ChainSettings,
+  account: Account,
+  props: OsmosisSwapProps[],
+  gasConfig: GasConfig,
+  rpcUrl: string,
+  signerPublicKey: string,
+  memo?: string
+): Promise<EncodedTxData<OsmosisSwapProps>> => {
+  let bparams: BparamsMsgValue[] | undefined;
+  if (account.type === AccountType.Ledger) {
+    const sdk = await getSdkInstance();
+    const ledger = await sdk.initLedger();
+    bparams = await ledger.getBparams();
+    ledger.closeTransport();
+  }
+  const { transfer } = props[0];
+
+  return await workerBuildTxPair({
+    rpcUrl,
+    token: transfer.token,
+    buildTxFn: async (workerLink) => {
+      const msgValue = new OsmosisSwapMsgValue({
+        ...props[0],
+        transfer: {
+          ...transfer,
+          gasSpendingKey: transfer.gasSpendingKey,
+          bparams,
+        },
+      });
+      const msg: OsmosisSwap = {
+        type: "osmosis-swap",
+        payload: {
+          account: {
+            ...account,
+            publicKey: signerPublicKey,
+          },
+          gasConfig,
+          props: [msgValue],
+          chain,
+          memo,
+        },
+      };
+
+      return (await workerLink.osmosisSwap(msg)).payload;
+    },
+  });
+};

apps/namadillo/src/workers/MaspTxMessages.ts

@@ -1,6 +1,7 @@
 import {
   Account,
   IbcTransferMsgValue,
+  OsmosisSwapMsgValue,
   ShieldedTransferMsgValue,
   ShieldingTransferMsgValue,
   TxResponseMsgValue,
@@ -76,6 +77,19 @@ export type IbcTransferDone = WebWorkerMessage<
   EncodedTxData<IbcTransferMsgValue>
 >;
 
+type OsmosisSwapPayload = {
+  account: Account;
+  gasConfig: GasConfig;
+  props: OsmosisSwapMsgValue[];
+  chain: ChainSettings;
+  memo?: string;
+};
+export type OsmosisSwap = WebWorkerMessage<"osmosis-swap", OsmosisSwapPayload>;
+export type OsmosisSwapDone = WebWorkerMessage<
+  "osmosis-swap-done",
+  EncodedTxData<OsmosisSwapMsgValue>
+>;
+
 type GenerateIbcShieldingMemoPayload = {
   target: string;
   token: string;

apps/namadillo/src/workers/MaspTxWorker.ts

@@ -2,6 +2,7 @@ import { initMulticore } from "@namada/sdk/inline-init";
 import { getSdk, Sdk } from "@namada/sdk/web";
 import {
   IbcTransferMsgValue,
+  OsmosisSwapMsgValue,
   ShieldedTransferMsgValue,
   ShieldingTransferMsgValue,
   TxResponseMsgValue,
@@ -18,6 +19,8 @@ import {
   IbcTransferDone,
   Init,
   InitDone,
+  OsmosisSwap,
+  OsmosisSwapDone,
   Shield,
   ShieldDone,
   ShieldedTransfer,
@@ -89,6 +92,17 @@ export class Worker {
     };
   }
 
+  async osmosisSwap(m: OsmosisSwap): Promise<OsmosisSwapDone> {
+    if (!this.sdk) {
+      throw new Error("SDK is not initialized");
+    }
+
+    return {
+      type: "osmosis-swap-done",
+      payload: await osmosisSwap(this.sdk, m.payload),
+    };
+  }
+
   async broadcast(m: Broadcast): Promise<BroadcastDone> {
     if (!this.sdk) {
       throw new Error("SDK is not initialized");
@@ -189,6 +203,27 @@ async function ibcTransfer(
   return encodedTxData;
 }
 
+async function osmosisSwap(
+  sdk: Sdk,
+  payload: OsmosisSwap["payload"]
+): Promise<EncodedTxData<OsmosisSwapMsgValue>> {
+  const { account, gasConfig, chain, props } = payload;
+
+  await sdk.masp.loadMaspParams("", chain.chainId);
+  const encodedTxData = await buildTx<OsmosisSwapMsgValue>(
+    sdk,
+    account,
+    gasConfig,
+    chain,
+    props,
+    sdk.tx.buildOsmosisSwap,
+    undefined,
+    false
+  );
+
+  return encodedTxData;
+}
+
 async function generateIbcShieldingMemo(
   sdk: Sdk,
   payload: GenerateIbcShieldingMemo["payload"]
@@ -240,6 +275,8 @@ export const registerTransferHandlers = (): void => {
   registerBNTransferHandler<UnshieldDone>("unshield-done");
   registerBNTransferHandler<IbcTransfer>("ibc-transfer");
   registerBNTransferHandler<IbcTransferDone>("ibc-transfer-done");
+  registerBNTransferHandler<OsmosisSwap>("osmosis-swap");
+  registerBNTransferHandler<OsmosisSwapDone>("osmosis-swap-done");
   registerBNTransferHandler<Unshield>("unshield");
   registerBNTransferHandler<GenerateIbcShieldingMemo>(
     "generate-ibc-shielding-memo"

packages/sdk/src/tx/tx.ts

@@ -15,6 +15,8 @@ import {
   IbcTransferMsgValue,
   IbcTransferProps,
   Message,
+  OsmosisSwapMsgValue,
+  OsmosisSwapProps,
   RedelegateMsgValue,
   RedelegateProps,
   RevealPkMsgValue,
@@ -280,6 +282,31 @@ export class Tx {
     return deserialize(Buffer.from(serializedTx), TxMsgValue);
   }
 
+  /**
+   * Build Osmosis Swap Tx
+   * `osmosisSwapProps.transfer.amountInBaseDenom` is the amount in the **base** denom
+   * e.g. the value of 1 NAM should be BigNumber(1_000_000), not BigNumber(1).
+   * @async
+   * @param wrapperTxProps - properties of the transaction
+   * @param osmosisSwapProps - properties of the osmosis swap tx
+   * @returns promise that resolves to an TxMsgValue
+   */
+  async buildOsmosisSwap(
+    wrapperTxProps: WrapperTxProps,
+    osmosisSwapProps: OsmosisSwapProps
+  ): Promise<TxMsgValue> {
+    const ibcTransferMsg = new Message<OsmosisSwapProps>();
+    const encodedWrapperArgs = this.encodeTxArgs(wrapperTxProps);
+    const encodedIbcTransfer = ibcTransferMsg.encode(
+      new OsmosisSwapMsgValue(osmosisSwapProps)
+    );
+    const serializedTx = await this.sdk.build_osmosis_swap(
+      encodedIbcTransfer,
+      encodedWrapperArgs
+    );
+    return deserialize(Buffer.from(serializedTx), TxMsgValue);
+  }
+
   /**
    * Build Ethereum Bridge Transfer Tx
    * @async