@kimafinance/kima-transaction-api 1.4.2 → 1.4.3

package/README.md

@@ -17,12 +17,13 @@ yarn add @kimafinance/kima-transaction-api
 
 ```ts
 import {
-  submitKimaTransaction,
+  submitKimaTransferTransaction,
+  submitKimaSwapTransaction,
   SupportNetworks,
   CurrencyOptions,
 } from "@kimafinance/kima-transaction-api";
 
-const txResult = await submitKimaTransaction({
+const txResult = await submitKimaTransferTransaction({
   originAddress: "0x1234123412341234123412341234123412341234",
   originChain: "ETH",
   originSymbol: "USDK",
@@ -44,11 +45,30 @@ const txResult = await submitKimaTransaction({
     transactionIdSignature: "", // optional: used to validate transaction idempotency
   }
 });
+
+
+const txResult = await submitKimaSwapTransaction({
+  originAddress: "0x1234123412341234123412341234123412341234",
+  originChain: "ETH",
+  originSymbol: "USDK",
+  targetAddress: "0x1234123412341234123412341234123412341234",
+  targetChain: "POL",
+  targetSymbol: "USDK",
+  amountIn: "100",
+  amountOut: "100",
+  fee: "0.3",
+  dex: "uniswap", // required to send empty strings for now
+  slippage: "0.05",
+  options: {
+    signature: "", // required: generated signature from the approval message
+    feeId: "", // required: id returned from calculated fee in fcs
+  }
+});
 ```
 
 ## Available Functions
 
-`submitKimaTransaction` : Submit a transaction to transfer liquidity from one change to another.
+`submitKimaTransferTransaction` : Submit a transaction to transfer liquidity from one change to another.
 
     - `originAddress`: sending address
     - `originChain`: sending chain
@@ -59,6 +79,20 @@ const txResult = await submitKimaTransaction({
     - `amount`: amount of token to transfer
     - `fee`: amount of token that kima consumes to pay gas fee for pulling & releasing token transactions
 
+`submitKimaSwapTransaction` : Submit a transaction to swap token from one chain to another.
+
+    - `originAddress`: sending address
+    - `originChain`: sending chain
+    - `originSymbol`: sending token symbol
+    - `targetAddress`: receiving address
+    - `targetChain`: receiving chain
+    - `targetSymbol`: receiving token symbol
+    - `amountIn`: amount of token to swap
+    - `amountOut`: expected amount of token to receive
+    - `fee`: amount of token that kima consumes to pay gas fee for pulling & swapping token transactions
+    - `dex`: the name of the dex that user wants to interact with (optional)
+    - `slippage`: maximum acceptable slippage parameter
+
 ## Environment Variables
 
 `KIMA_BACKEND_MNEMONIC` : Seed phrase of developer wallet. This wallet must have KIMA token to submit a transaction to kima chain.

package/build/index.d.ts

@@ -1,50 +1,6 @@
-export declare enum SupportedNetworks {
-    ETHEREUM = "ETH",
-    POLYGON = "POL",
-    AVALANCHE = "AVX",
-    SOLANA = "SOL",
-    FUSE = "FUS",
-    CELO = "CEL",
-    BSC = "BSC",
-    ARBITRIUM = "ARB",
-    OPTIMISM = "OPT",
-    POLYGON_ZKEVM = "ZKE"
-}
-export declare enum CurrencyOptions {
-    USDT = "USDT",
-    USDC = "USDC",
-    USDK = "USDK"
-}
-interface RequestHtlcReclaimProps {
-    senderAddress: string;
-    txHash: string;
-}
+import { RequestHtlcReclaimProps, RequestHtlcLockProps, RequestTransferTxProps, RequestSwapTxProps } from "./types";
 export declare function HtlcReclaim({ senderAddress, txHash, }: RequestHtlcReclaimProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
-interface RequestHtlcLockProps {
-    fromAddress: string;
-    senderPubkey: string;
-    amount: string;
-    htlcTimeout: string;
-    txHash: string;
-    htlcAddress: string;
-}
 export declare function submitHtlcLock({ fromAddress, senderPubkey, amount, htlcTimeout, txHash, htlcAddress, }: RequestHtlcLockProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
-interface RequestTxProps {
-    originChain: SupportedNetworks;
-    originAddress: string;
-    targetChain: SupportedNetworks;
-    targetAddress: string;
-    originSymbol: CurrencyOptions;
-    targetSymbol: CurrencyOptions;
-    amount: string;
-    fee: string;
-    htlcCreationHash: string;
-    htlcCreationVout: number;
-    htlcExpirationTimestamp: string;
-    htlcVersion: string;
-    senderPubKey: Uint8Array;
-    options: string;
-}
 export declare function getCreatorAddress(): Promise<import("@cosmjs/proto-signing").AccountData>;
-export declare function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, originSymbol, targetSymbol, amount, fee, htlcCreationHash, htlcCreationVout, htlcExpirationTimestamp, htlcVersion, senderPubKey, options, }: RequestTxProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
-export {};
+export declare function submitKimaTransferTransaction({ originChain, originAddress, targetChain, targetAddress, originSymbol, targetSymbol, amount, fee, htlcCreationHash, htlcCreationVout, htlcExpirationTimestamp, htlcVersion, senderPubKey, options, }: RequestTransferTxProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+export declare function submitKimaSwapTransaction({ originChain, originAddress, targetChain, targetAddress, originSymbol, targetSymbol, amountIn, amountOut, fee, dex, slippage, options, }: RequestSwapTxProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;

package/build/index.js

@@ -1,27 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.submitKimaTransaction = exports.getCreatorAddress = exports.submitHtlcLock = exports.HtlcReclaim = exports.CurrencyOptions = exports.SupportedNetworks = void 0;
+exports.submitKimaSwapTransaction = exports.submitKimaTransferTransaction = exports.getCreatorAddress = exports.submitHtlcLock = exports.HtlcReclaim = void 0;
 const proto_signing_1 = require("@cosmjs/proto-signing");
 const common_1 = require("./kima/common");
-var SupportedNetworks;
-(function (SupportedNetworks) {
-    SupportedNetworks["ETHEREUM"] = "ETH";
-    SupportedNetworks["POLYGON"] = "POL";
-    SupportedNetworks["AVALANCHE"] = "AVX";
-    SupportedNetworks["SOLANA"] = "SOL";
-    SupportedNetworks["FUSE"] = "FUS";
-    SupportedNetworks["CELO"] = "CEL";
-    SupportedNetworks["BSC"] = "BSC";
-    SupportedNetworks["ARBITRIUM"] = "ARB";
-    SupportedNetworks["OPTIMISM"] = "OPT";
-    SupportedNetworks["POLYGON_ZKEVM"] = "ZKE";
-})(SupportedNetworks = exports.SupportedNetworks || (exports.SupportedNetworks = {}));
-var CurrencyOptions;
-(function (CurrencyOptions) {
-    CurrencyOptions["USDT"] = "USDT";
-    CurrencyOptions["USDC"] = "USDC";
-    CurrencyOptions["USDK"] = "USDK";
-})(CurrencyOptions = exports.CurrencyOptions || (exports.CurrencyOptions = {}));
 async function HtlcReclaim({ senderAddress, txHash, }) {
     const wallet = await proto_signing_1.DirectSecp256k1HdWallet.fromMnemonic(process.env.KIMA_BACKEND_MNEMONIC, { prefix: "kima" });
     const client = await (0, common_1.TxClient)(wallet);
@@ -54,16 +35,13 @@ async function submitHtlcLock({ fromAddress, senderPubkey, amount, htlcTimeout,
     return result;
 }
 exports.submitHtlcLock = submitHtlcLock;
-function sleep(ms) {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-}
 async function getCreatorAddress() {
     const wallet = await proto_signing_1.DirectSecp256k1HdWallet.fromMnemonic(process.env.KIMA_BACKEND_MNEMONIC, { prefix: "kima" });
     const [firstAccount] = await wallet.getAccounts();
     return firstAccount;
 }
 exports.getCreatorAddress = getCreatorAddress;
-async function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, originSymbol, targetSymbol, amount, fee, htlcCreationHash, htlcCreationVout, htlcExpirationTimestamp, htlcVersion, senderPubKey, options, }) {
+async function submitKimaTransferTransaction({ originChain, originAddress, targetChain, targetAddress, originSymbol, targetSymbol, amount, fee, htlcCreationHash, htlcCreationVout = 0, htlcExpirationTimestamp, htlcVersion = "", senderPubKey, options, }) {
     const wallet = await proto_signing_1.DirectSecp256k1HdWallet.fromMnemonic(process.env.KIMA_BACKEND_MNEMONIC, { prefix: "kima" });
     const client = await (0, common_1.TxClient)(wallet);
     const [firstAccount] = await wallet.getAccounts();
@@ -77,47 +55,39 @@ async function submitKimaTransaction({ originChain, originAddress, targetChain,
         targetSymbol,
         amount: amount,
         fee: fee,
-        htlcCreationHash,
-        htlcCreationVout,
-        htlcExpirationTimestamp,
+        htlcCreationHash: htlcCreationHash || "",
+        htlcCreationVout: htlcCreationVout || 0,
+        htlcExpirationTimestamp: htlcExpirationTimestamp || "",
         htlcVersion,
-        senderPubKey,
+        senderPubKey: senderPubKey || new Uint8Array(),
         options,
     };
     const msgTx = await client.msgRequestTransaction(params);
     const result = await client.signAndBroadcast([msgTx]);
-    if (result.code !== 0) {
-        return result;
-    }
-    let txId = 1;
-    for (const event of result.events) {
-        if (event.type === "transaction_requested") {
-            for (const attr of event.attributes) {
-                if (attr.key === "txId") {
-                    txId = +attr.value;
-                }
-            }
-        }
-    }
-    await sleep(5000);
-    const msgSetHash = await client.msgSetTxHash({
+    return result;
+}
+exports.submitKimaTransferTransaction = submitKimaTransferTransaction;
+async function submitKimaSwapTransaction({ originChain, originAddress, targetChain, targetAddress, originSymbol, targetSymbol, amountIn, amountOut, fee, dex, slippage, options, }) {
+    const wallet = await proto_signing_1.DirectSecp256k1HdWallet.fromMnemonic(process.env.KIMA_BACKEND_MNEMONIC, { prefix: "kima" });
+    const client = await (0, common_1.TxClient)(wallet);
+    const [firstAccount] = await wallet.getAccounts();
+    const params = {
         creator: firstAccount.address,
-        txId,
-        txHash: result.transactionHash,
-        txType: "request_transaction",
-    });
-    console.log(msgSetHash);
-    let hashResult;
-    do {
-        try {
-            hashResult = await client.signAndBroadcast([msgSetHash]);
-        }
-        catch (error) {
-            console.log(error);
-            await sleep(5000);
-            continue;
-        }
-    } while (hashResult?.code !== 0);
+        originChain,
+        originAddress,
+        targetChain,
+        targetAddress,
+        originSymbol,
+        targetSymbol,
+        amountIn: amountIn,
+        amountOut: amountOut,
+        fee: fee,
+        dex: dex,
+        slippage: slippage,
+        options: options,
+    };
+    const msgTx = await client.msgRequestSwapTransaction(params);
+    const result = await client.signAndBroadcast([msgTx]);
     return result;
 }
-exports.submitKimaTransaction = submitKimaTransaction;
+exports.submitKimaSwapTransaction = submitKimaSwapTransaction;

package/build/kima/common.d.ts

@@ -1,5 +1,6 @@
 import { Registry, OfflineSigner, EncodeObject } from "@cosmjs/proto-signing";
-import { MsgRequestHtlcLock, MsgRequestTransaction, MsgSetTxHash, MsgHtlcReclaim } from "./tx";
+import { MsgRequestHtlcLock, MsgRequestTransaction, MsgSetTxHash, MsgHtlcReclaim } from "./transfer_tx";
+import { MsgRequestSwapTransaction } from "./swap_tx";
 export declare const registry: Registry;
 export declare const TxClient: (wallet: OfflineSigner) => Promise<{
     signAndBroadcast: (msgs: EncodeObject[]) => Promise<import("@cosmjs/stargate").DeliverTxResponse>;
@@ -7,4 +8,5 @@ export declare const TxClient: (wallet: OfflineSigner) => Promise<{
     msgRequestHtlcLock: (data: MsgRequestHtlcLock) => EncodeObject;
     msgSetTxHash: (data: MsgSetTxHash) => EncodeObject;
     msgHtlcReclaim: (data: MsgHtlcReclaim) => EncodeObject;
+    msgRequestSwapTransaction: (data: MsgRequestSwapTransaction) => EncodeObject;
 }>;

package/build/kima/common.js

@@ -7,17 +7,19 @@ exports.TxClient = exports.registry = void 0;
 const stargate_1 = require("@cosmjs/stargate");
 const dotenv_1 = __importDefault(require("dotenv"));
 const proto_signing_1 = require("@cosmjs/proto-signing");
-const tx_1 = require("./tx");
+const transfer_tx_1 = require("./transfer_tx");
+const swap_tx_1 = require("./swap_tx");
 dotenv_1.default.config();
 const defaultFee = {
     amount: [(0, proto_signing_1.coin)(200, "uKIMA")],
     gas: "200000", // Gas limit
 };
 const types = [
-    ["/kimablockchain.transaction.MsgRequestTransaction", tx_1.MsgRequestTransaction],
-    ["/kimablockchain.transaction.MsgRequestHtlcLock", tx_1.MsgRequestHtlcLock],
-    ["/kimablockchain.transaction.MsgSetTxHash", tx_1.MsgSetTxHash],
-    ["/kimablockchain.transaction.MsgHtlcReclaim", tx_1.MsgHtlcReclaim],
+    ["/kimablockchain.transaction.MsgRequestTransaction", transfer_tx_1.MsgRequestTransaction],
+    ["/kimablockchain.transaction.MsgRequestHtlcLock", transfer_tx_1.MsgRequestHtlcLock],
+    ["/kimablockchain.transaction.MsgSetTxHash", transfer_tx_1.MsgSetTxHash],
+    ["/kimablockchain.transaction.MsgHtlcReclaim", transfer_tx_1.MsgHtlcReclaim],
+    ["/kimablockchain.swap.MsgRequestSwapTransaction", swap_tx_1.MsgRequestSwapTransaction],
 ];
 exports.registry = new proto_signing_1.Registry(types);
 const TxClient = async (wallet) => {
@@ -30,19 +32,23 @@ const TxClient = async (wallet) => {
         },
         msgRequestTransaction: (data) => ({
             typeUrl: "/kimablockchain.transaction.MsgRequestTransaction",
-            value: tx_1.MsgRequestTransaction.fromPartial(data),
+            value: transfer_tx_1.MsgRequestTransaction.fromPartial(data),
         }),
         msgRequestHtlcLock: (data) => ({
             typeUrl: "/kimablockchain.transaction.MsgRequestHtlcLock",
-            value: tx_1.MsgRequestHtlcLock.fromPartial(data),
+            value: transfer_tx_1.MsgRequestHtlcLock.fromPartial(data),
         }),
         msgSetTxHash: (data) => ({
             typeUrl: "/kimablockchain.transaction.MsgSetTxHash",
-            value: tx_1.MsgSetTxHash.fromPartial(data),
+            value: transfer_tx_1.MsgSetTxHash.fromPartial(data),
         }),
         msgHtlcReclaim: (data) => ({
             typeUrl: "/kimablockchain.transaction.MsgHtlcReclaim",
-            value: tx_1.MsgHtlcReclaim.fromPartial(data),
+            value: transfer_tx_1.MsgHtlcReclaim.fromPartial(data),
+        }),
+        msgRequestSwapTransaction: (data) => ({
+            typeUrl: "/kimablockchain.swap.MsgRequestSwapTransaction",
+            value: swap_tx_1.MsgRequestSwapTransaction.fromPartial(data),
         }),
     };
 };