@kimafinance/kima-transaction-api 1.5.12 → 1.5.13

package/README.md

@@ -19,10 +19,25 @@ yarn add @kimafinance/kima-transaction-api
 import {
   submitKimaTransferTransaction,
   submitKimaSwapTransaction,
-  SupportNetworks,
+  SupportedNetworks,
   CurrencyOptions,
+  SubmitOptionsPayload,
 } from "@kimafinance/kima-transaction-api";
 
+const transferOptions: SubmitOptionsPayload = {
+  signature: "", // approval message signature
+  feeId: "", // fee id from fee quote
+  chargeFeeAtTarget: false,
+  transactionIdSeed: "",
+  transactionIdSignature: "",
+  permit2: {
+    r: "0x...",
+    s: "0x...",
+    v: 27,
+    deadline: 1735689600,
+  },
+};
+
 const txResult = await submitKimaTransferTransaction({
   originAddress: "0x1234123412341234123412341234123412341234",
   originChain: "ETH",
@@ -37,13 +52,8 @@ const txResult = await submitKimaTransferTransaction({
   htlcExpirationTimestamp: "",
   htlcVersion: "",
   senderPubKey: "",
-  options: {
-    signature: "", // required: generated signature from the approval message
-    feeId: "", // required: id returned from calculated fee in fcs
-    chargeFeeAtTarget: false // required: wether to deduct fees from origin or target
-    transactionIdSeed: "", // optional: used in fiat on ramp payments
-    transactionIdSignature: "", // optional: used to validate transaction idempotency
-  }
+  // Runtime wire format stays a serialized JSON string
+  options: JSON.stringify(transferOptions),
 });
 
 
@@ -59,10 +69,16 @@ const txResult = await submitKimaSwapTransaction({
   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
-  }
+  options: JSON.stringify({
+    signature: "",
+    feeId: "",
+    permit2: {
+      r: "0x...",
+      s: "0x...",
+      v: 28,
+      deadline: 1735689600,
+    },
+  } satisfies SubmitOptionsPayload),
 });
 ```
 

package/build/index.d.ts

@@ -1,4 +1,5 @@
 import { RequestHtlcReclaimProps, RequestHtlcLockProps, HtlcLockingTransactionResponse, QueryHtlcLockingTransactionParams, RequestTransferTxProps, RequestSwapTxProps, RequestExternalTxProps } from "./types";
+export * from "./types";
 export declare function getHtlcLockingTransactions({ baseUrl, limit, offset, paginationKey, }: QueryHtlcLockingTransactionParams): Promise<HtlcLockingTransactionResponse>;
 export declare function HtlcReclaim({ senderAddress, txHash, }: RequestHtlcReclaimProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
 export declare function submitHtlcLock({ fromAddress, senderPubkey, amount, htlcTimeout, txHash, htlcAddress, }: RequestHtlcLockProps): Promise<import("@cosmjs/stargate").DeliverTxResponse>;

package/build/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -9,6 +23,7 @@ const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
 const url_1 = require("url");
 const common_1 = require("./kima/common");
+__exportStar(require("./types"), exports);
 const requestJson = async (url) => {
     return new Promise((resolve, reject) => {
         const parsed = new url_1.URL(url);

package/build/types.d.ts

@@ -25,6 +25,21 @@ export declare enum CurrencyOptions {
     EUR = "EUR",
     USD = "USD"
 }
+export interface Permit2SubmitOptions {
+    r: string;
+    s: string;
+    v: number;
+    deadline: number;
+}
+export interface SubmitOptionsPayload {
+    signature?: string;
+    feeId?: string;
+    chargeFeeAtTarget?: boolean;
+    transactionIdSeed?: string;
+    transactionIdSignature?: string;
+    permit2?: Permit2SubmitOptions;
+    [key: string]: unknown;
+}
 export interface RequestHtlcReclaimProps {
     senderAddress: string;
     txHash: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kimafinance/kima-transaction-api",
-  "version": "1.5.12",
+  "version": "1.5.13",
   "description": "A wrapper around Kima's API, enabling sending and monitoring transactions (Beta version)",
   "repository": "https://github.com/kima-finance/kima-transaction-api",
   "author": "",

package/src/index.ts

@@ -24,6 +24,8 @@ import {
   RequestExternalTxProps,
 } from "./types";
 
+export * from "./types";
+
 const requestJson = async <T>(url: string): Promise<T> => {
   return new Promise((resolve, reject) => {
     const parsed = new URL(url);

package/src/types.ts

@@ -28,6 +28,23 @@ export enum CurrencyOptions {
     USD = "USD",
 }
 
+export interface Permit2SubmitOptions {
+    r: string;
+    s: string;
+    v: number; // 27 | 28
+    deadline: number; // unix timestamp (seconds)
+}
+
+export interface SubmitOptionsPayload {
+    signature?: string;
+    feeId?: string;
+    chargeFeeAtTarget?: boolean;
+    transactionIdSeed?: string;
+    transactionIdSignature?: string;
+    permit2?: Permit2SubmitOptions;
+    [key: string]: unknown;
+}
+
 export interface RequestHtlcReclaimProps {
     senderAddress: string;
     txHash: string;
@@ -56,6 +73,7 @@ export interface RequestTransferTxProps {
     htlcExpirationTimestamp?: string;
     htlcVersion?: string;
     senderPubKey?: Uint8Array;
+    // JSON-serialized SubmitOptionsPayload
     options: string;
 }
 
@@ -76,6 +94,7 @@ export interface RequestSwapTxProps {
     htlcCreationVout?: number;
     htlcVersion?: string;
     senderPubKey?: Uint8Array;
+    // JSON-serialized SubmitOptionsPayload
     options: string;
 }
 
@@ -88,6 +107,7 @@ export interface RequestExternalTxProps {
     targetSymbol: CurrencyOptions;
     amount: string;
     fee: string;
+    // JSON-serialized SubmitOptionsPayload
     options: string;
 }