@kimafinance/kima-transaction-api 1.0.24-beta.1 → 1.0.26-beta.1

package/build/index.d.ts

@@ -23,6 +23,11 @@ interface Props {
     symbol: CurrencyOptions;
     amount: number;
     fee: number;
+    htlcCreationHash: string;
+    htlcCreationVout: number;
+    htlcExpirationTimestamp: string;
+    htlcVersion: string;
+    senderPubKey: Uint8Array;
 }
-export declare function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, symbol, amount, fee, }: Props): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+export declare function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, symbol, amount, fee, htlcCreationHash, htlcCreationVout, htlcExpirationTimestamp, htlcVersion, senderPubKey, }: Props): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
 export {};

package/build/index.js

@@ -25,7 +25,7 @@ var CurrencyOptions;
 function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
-async function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, symbol, amount, fee, }) {
+async function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, symbol, amount, fee, htlcCreationHash, htlcCreationVout, htlcExpirationTimestamp, htlcVersion, senderPubKey, }) {
     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();
@@ -38,6 +38,11 @@ async function submitKimaTransaction({ originChain, originAddress, targetChain,
         symbol,
         amount: amount.toString(),
         fee: fee.toString(),
+        htlcCreationHash,
+        htlcCreationVout,
+        htlcExpirationTimestamp,
+        htlcVersion,
+        senderPubKey,
     };
     let msg = await client.msgRequestTransaction(params);
     const result = await client.signAndBroadcast([msg]);
@@ -55,7 +60,7 @@ async function submitKimaTransaction({ originChain, originAddress, targetChain,
         creator: firstAccount.address,
         txId,
         txHash: result.transactionHash,
-        txType: "request_transaction"
+        txType: "request_transaction",
     });
     console.log(msg);
     let hashResult;

package/build/kima/tx.d.ts

@@ -9,6 +9,16 @@ export interface MsgRequestTransaction {
     symbol: string;
     amount: string;
     fee: string;
+    /** the timestamp when the HTLC contract expires and the user can reclaim the funds locked there */
+    htlcExpirationTimestamp: string;
+    /** the txhash locking the funds in the HTLC */
+    htlcCreationHash: string;
+    /** the output index of the locked funds  in the HTLC creation transaction */
+    htlcCreationVout: number;
+    /** a version denoting which HTLC script version is being using for the HTLC transaction */
+    htlcVersion: string;
+    /** for bitcoin transaction this is the public key of the sender */
+    senderPubKey: Uint8Array;
 }
 export interface MsgRequestTransactionResponse {
     code: string;
@@ -44,6 +54,16 @@ export interface MsgRequestProvisionTransaction {
     symbol: string;
     amount: string;
     options: string;
+    /** BTC transaction */
+    htlcExpirationTimestamp: string;
+    /** the txhash locking the funds in the HTLC */
+    htlcCreationHash: string;
+    /** the output index of the locked funds  in the HTLC creation transaction */
+    htlcCreationVout: number;
+    /** a version denoting which HTLC script version is being using for the HTLC transaction */
+    htlcVersion: string;
+    /** the (compressed) public key of the sender */
+    senderPubKey: Uint8Array;
 }
 export interface MsgRequestProvisionTransactionResponse {
     code: string;
@@ -117,6 +137,11 @@ export declare const MsgRequestTransaction: {
         symbol?: string | undefined;
         amount?: string | undefined;
         fee?: string | undefined;
+        htlcExpirationTimestamp?: string | undefined;
+        htlcCreationHash?: string | undefined;
+        htlcCreationVout?: number | undefined;
+        htlcVersion?: string | undefined;
+        senderPubKey?: Uint8Array | undefined;
     } & {
         creator?: string | undefined;
         originChain?: string | undefined;
@@ -126,6 +151,11 @@ export declare const MsgRequestTransaction: {
         symbol?: string | undefined;
         amount?: string | undefined;
         fee?: string | undefined;
+        htlcExpirationTimestamp?: string | undefined;
+        htlcCreationHash?: string | undefined;
+        htlcCreationVout?: number | undefined;
+        htlcVersion?: string | undefined;
+        senderPubKey?: Uint8Array | undefined;
     } & { [K in Exclude<keyof I, keyof MsgRequestTransaction>]: never; }>(object: I): MsgRequestTransaction;
 };
 export declare const MsgRequestTransactionResponse: {
@@ -219,6 +249,11 @@ export declare const MsgRequestProvisionTransaction: {
         symbol?: string | undefined;
         amount?: string | undefined;
         options?: string | undefined;
+        htlcExpirationTimestamp?: string | undefined;
+        htlcCreationHash?: string | undefined;
+        htlcCreationVout?: number | undefined;
+        htlcVersion?: string | undefined;
+        senderPubKey?: Uint8Array | undefined;
     } & {
         creator?: string | undefined;
         chain?: string | undefined;
@@ -226,6 +261,11 @@ export declare const MsgRequestProvisionTransaction: {
         symbol?: string | undefined;
         amount?: string | undefined;
         options?: string | undefined;
+        htlcExpirationTimestamp?: string | undefined;
+        htlcCreationHash?: string | undefined;
+        htlcCreationVout?: number | undefined;
+        htlcVersion?: string | undefined;
+        senderPubKey?: Uint8Array | undefined;
     } & { [K in Exclude<keyof I, keyof MsgRequestProvisionTransaction>]: never; }>(object: I): MsgRequestProvisionTransaction;
 };
 export declare const MsgRequestProvisionTransactionResponse: {

package/build/kima/tx.js

@@ -18,6 +18,11 @@ function createBaseMsgRequestTransaction() {
         symbol: "",
         amount: "",
         fee: "",
+        htlcExpirationTimestamp: "",
+        htlcCreationHash: "",
+        htlcCreationVout: 0,
+        htlcVersion: "",
+        senderPubKey: new Uint8Array(),
     };
 }
 exports.MsgRequestTransaction = {
@@ -46,6 +51,21 @@ exports.MsgRequestTransaction = {
         if (message.fee !== "") {
             writer.uint32(66).string(message.fee);
         }
+        if (message.htlcExpirationTimestamp !== "") {
+            writer.uint32(74).string(message.htlcExpirationTimestamp);
+        }
+        if (message.htlcCreationHash !== "") {
+            writer.uint32(82).string(message.htlcCreationHash);
+        }
+        if (message.htlcCreationVout !== 0) {
+            writer.uint32(88).uint32(message.htlcCreationVout);
+        }
+        if (message.htlcVersion !== "") {
+            writer.uint32(98).string(message.htlcVersion);
+        }
+        if (message.senderPubKey.length !== 0) {
+            writer.uint32(106).bytes(message.senderPubKey);
+        }
         return writer;
     },
     decode(input, length) {
@@ -79,6 +99,21 @@ exports.MsgRequestTransaction = {
                 case 8:
                     message.fee = reader.string();
                     break;
+                case 9:
+                    message.htlcExpirationTimestamp = reader.string();
+                    break;
+                case 10:
+                    message.htlcCreationHash = reader.string();
+                    break;
+                case 11:
+                    message.htlcCreationVout = reader.uint32();
+                    break;
+                case 12:
+                    message.htlcVersion = reader.string();
+                    break;
+                case 13:
+                    message.senderPubKey = reader.bytes();
+                    break;
                 default:
                     reader.skipType(tag & 7);
                     break;
@@ -90,24 +125,57 @@ exports.MsgRequestTransaction = {
         return {
             creator: isSet(object.creator) ? String(object.creator) : "",
             originChain: isSet(object.originChain) ? String(object.originChain) : "",
-            originAddress: isSet(object.originAddress) ? String(object.originAddress) : "",
+            originAddress: isSet(object.originAddress)
+                ? String(object.originAddress)
+                : "",
             targetChain: isSet(object.targetChain) ? String(object.targetChain) : "",
-            targetAddress: isSet(object.targetAddress) ? String(object.targetAddress) : "",
+            targetAddress: isSet(object.targetAddress)
+                ? String(object.targetAddress)
+                : "",
             symbol: isSet(object.symbol) ? String(object.symbol) : "",
             amount: isSet(object.amount) ? String(object.amount) : "",
             fee: isSet(object.fee) ? String(object.fee) : "",
+            htlcExpirationTimestamp: isSet(object.htlcExpirationTimestamp)
+                ? String(object.htlcExpirationTimestamp)
+                : "",
+            htlcCreationHash: isSet(object.htlcCreationHash)
+                ? String(object.htlcCreationHash)
+                : "",
+            htlcCreationVout: isSet(object.htlcCreationVout)
+                ? Number(object.htlcCreationVout)
+                : 0,
+            htlcVersion: isSet(object.htlcVersion) ? String(object.htlcVersion) : "",
+            senderPubKey: isSet(object.senderPubKey)
+                ? bytesFromBase64(object.senderPubKey)
+                : new Uint8Array(),
         };
     },
     toJSON(message) {
         const obj = {};
         message.creator !== undefined && (obj.creator = message.creator);
-        message.originChain !== undefined && (obj.originChain = message.originChain);
-        message.originAddress !== undefined && (obj.originAddress = message.originAddress);
-        message.targetChain !== undefined && (obj.targetChain = message.targetChain);
-        message.targetAddress !== undefined && (obj.targetAddress = message.targetAddress);
+        message.originChain !== undefined &&
+            (obj.originChain = message.originChain);
+        message.originAddress !== undefined &&
+            (obj.originAddress = message.originAddress);
+        message.targetChain !== undefined &&
+            (obj.targetChain = message.targetChain);
+        message.targetAddress !== undefined &&
+            (obj.targetAddress = message.targetAddress);
         message.symbol !== undefined && (obj.symbol = message.symbol);
         message.amount !== undefined && (obj.amount = message.amount);
         message.fee !== undefined && (obj.fee = message.fee);
+        message.htlcExpirationTimestamp !== undefined &&
+            (obj.htlcExpirationTimestamp = message.htlcExpirationTimestamp);
+        message.htlcCreationHash !== undefined &&
+            (obj.htlcCreationHash = message.htlcCreationHash);
+        message.htlcCreationVout !== undefined &&
+            (obj.htlcCreationVout = Math.round(message.htlcCreationVout));
+        message.htlcVersion !== undefined &&
+            (obj.htlcVersion = message.htlcVersion);
+        message.senderPubKey !== undefined &&
+            (obj.senderPubKey = base64FromBytes(message.senderPubKey !== undefined
+                ? message.senderPubKey
+                : new Uint8Array()));
         return obj;
     },
     fromPartial(object) {
@@ -120,6 +188,11 @@ exports.MsgRequestTransaction = {
         message.symbol = object.symbol ?? "";
         message.amount = object.amount ?? "";
         message.fee = object.fee ?? "";
+        message.htlcExpirationTimestamp = object.htlcExpirationTimestamp ?? "";
+        message.htlcCreationHash = object.htlcCreationHash ?? "";
+        message.htlcCreationVout = object.htlcCreationVout ?? 0;
+        message.htlcVersion = object.htlcVersion ?? "";
+        message.senderPubKey = object.senderPubKey ?? new Uint8Array();
         return message;
     },
 };
@@ -297,7 +370,10 @@ exports.MsgFinalizeTransactionResponse = {
         return message;
     },
     fromJSON(object) {
-        return { code: isSet(object.code) ? String(object.code) : "", msg: isSet(object.msg) ? String(object.msg) : "" };
+        return {
+            code: isSet(object.code) ? String(object.code) : "",
+            msg: isSet(object.msg) ? String(object.msg) : "",
+        };
     },
     toJSON(message) {
         const obj = {};
@@ -425,7 +501,10 @@ exports.MsgFinalizeProvisionTransactionResponse = {
         return message;
     },
     fromJSON(object) {
-        return { code: isSet(object.code) ? String(object.code) : "", msg: isSet(object.msg) ? String(object.msg) : "" };
+        return {
+            code: isSet(object.code) ? String(object.code) : "",
+            msg: isSet(object.msg) ? String(object.msg) : "",
+        };
     },
     toJSON(message) {
         const obj = {};
@@ -441,7 +520,19 @@ exports.MsgFinalizeProvisionTransactionResponse = {
     },
 };
 function createBaseMsgRequestProvisionTransaction() {
-    return { creator: "", chain: "", fromAddress: "", symbol: "", amount: "", options: "" };
+    return {
+        creator: "",
+        chain: "",
+        fromAddress: "",
+        symbol: "",
+        amount: "",
+        options: "",
+        htlcExpirationTimestamp: "",
+        htlcCreationHash: "",
+        htlcCreationVout: 0,
+        htlcVersion: "",
+        senderPubKey: new Uint8Array(),
+    };
 }
 exports.MsgRequestProvisionTransaction = {
     encode(message, writer = minimal_1.default.Writer.create()) {
@@ -463,6 +554,21 @@ exports.MsgRequestProvisionTransaction = {
         if (message.options !== "") {
             writer.uint32(50).string(message.options);
         }
+        if (message.htlcExpirationTimestamp !== "") {
+            writer.uint32(58).string(message.htlcExpirationTimestamp);
+        }
+        if (message.htlcCreationHash !== "") {
+            writer.uint32(66).string(message.htlcCreationHash);
+        }
+        if (message.htlcCreationVout !== 0) {
+            writer.uint32(72).uint32(message.htlcCreationVout);
+        }
+        if (message.htlcVersion !== "") {
+            writer.uint32(82).string(message.htlcVersion);
+        }
+        if (message.senderPubKey.length !== 0) {
+            writer.uint32(90).bytes(message.senderPubKey);
+        }
         return writer;
     },
     decode(input, length) {
@@ -490,6 +596,21 @@ exports.MsgRequestProvisionTransaction = {
                 case 6:
                     message.options = reader.string();
                     break;
+                case 7:
+                    message.htlcExpirationTimestamp = reader.string();
+                    break;
+                case 8:
+                    message.htlcCreationHash = reader.string();
+                    break;
+                case 9:
+                    message.htlcCreationVout = reader.uint32();
+                    break;
+                case 10:
+                    message.htlcVersion = reader.string();
+                    break;
+                case 11:
+                    message.senderPubKey = reader.bytes();
+                    break;
                 default:
                     reader.skipType(tag & 7);
                     break;
@@ -505,16 +626,42 @@ exports.MsgRequestProvisionTransaction = {
             symbol: isSet(object.symbol) ? String(object.symbol) : "",
             amount: isSet(object.amount) ? String(object.amount) : "",
             options: isSet(object.options) ? String(object.options) : "",
+            htlcExpirationTimestamp: isSet(object.htlcExpirationTimestamp)
+                ? String(object.htlcExpirationTimestamp)
+                : "",
+            htlcCreationHash: isSet(object.htlcCreationHash)
+                ? String(object.htlcCreationHash)
+                : "",
+            htlcCreationVout: isSet(object.htlcCreationVout)
+                ? Number(object.htlcCreationVout)
+                : 0,
+            htlcVersion: isSet(object.htlcVersion) ? String(object.htlcVersion) : "",
+            senderPubKey: isSet(object.senderPubKey)
+                ? bytesFromBase64(object.senderPubKey)
+                : new Uint8Array(),
         };
     },
     toJSON(message) {
         const obj = {};
         message.creator !== undefined && (obj.creator = message.creator);
         message.chain !== undefined && (obj.chain = message.chain);
-        message.fromAddress !== undefined && (obj.fromAddress = message.fromAddress);
+        message.fromAddress !== undefined &&
+            (obj.fromAddress = message.fromAddress);
         message.symbol !== undefined && (obj.symbol = message.symbol);
         message.amount !== undefined && (obj.amount = message.amount);
         message.options !== undefined && (obj.options = message.options);
+        message.htlcExpirationTimestamp !== undefined &&
+            (obj.htlcExpirationTimestamp = message.htlcExpirationTimestamp);
+        message.htlcCreationHash !== undefined &&
+            (obj.htlcCreationHash = message.htlcCreationHash);
+        message.htlcCreationVout !== undefined &&
+            (obj.htlcCreationVout = Math.round(message.htlcCreationVout));
+        message.htlcVersion !== undefined &&
+            (obj.htlcVersion = message.htlcVersion);
+        message.senderPubKey !== undefined &&
+            (obj.senderPubKey = base64FromBytes(message.senderPubKey !== undefined
+                ? message.senderPubKey
+                : new Uint8Array()));
         return obj;
     },
     fromPartial(object) {
@@ -525,6 +672,11 @@ exports.MsgRequestProvisionTransaction = {
         message.symbol = object.symbol ?? "";
         message.amount = object.amount ?? "";
         message.options = object.options ?? "";
+        message.htlcExpirationTimestamp = object.htlcExpirationTimestamp ?? "";
+        message.htlcCreationHash = object.htlcCreationHash ?? "";
+        message.htlcCreationVout = object.htlcCreationVout ?? 0;
+        message.htlcVersion = object.htlcVersion ?? "";
+        message.senderPubKey = object.senderPubKey ?? new Uint8Array();
         return message;
     },
 };
@@ -625,13 +777,16 @@ exports.MsgCancelTransaction = {
     fromJSON(object) {
         return {
             creator: isSet(object.creator) ? String(object.creator) : "",
-            transactionId: isSet(object.transactionId) ? String(object.transactionId) : "",
+            transactionId: isSet(object.transactionId)
+                ? String(object.transactionId)
+                : "",
         };
     },
     toJSON(message) {
         const obj = {};
         message.creator !== undefined && (obj.creator = message.creator);
-        message.transactionId !== undefined && (obj.transactionId = message.transactionId);
+        message.transactionId !== undefined &&
+            (obj.transactionId = message.transactionId);
         return obj;
     },
     fromPartial(object) {
@@ -675,7 +830,10 @@ exports.MsgCancelTransactionResponse = {
         return message;
     },
     fromJSON(object) {
-        return { code: isSet(object.code) ? String(object.code) : "", msg: isSet(object.msg) ? String(object.msg) : "" };
+        return {
+            code: isSet(object.code) ? String(object.code) : "",
+            msg: isSet(object.msg) ? String(object.msg) : "",
+        };
     },
     toJSON(message) {
         const obj = {};
@@ -794,7 +952,10 @@ exports.MsgSetTxHashResponse = {
         return message;
     },
     fromJSON(object) {
-        return { code: isSet(object.code) ? String(object.code) : "", msg: isSet(object.msg) ? String(object.msg) : "" };
+        return {
+            code: isSet(object.code) ? String(object.code) : "",
+            msg: isSet(object.msg) ? String(object.msg) : "",
+        };
     },
     toJSON(message) {
         const obj = {};
@@ -873,7 +1034,8 @@ exports.MsgSetTxProcess = {
         const obj = {};
         message.creator !== undefined && (obj.creator = message.creator);
         message.txId !== undefined && (obj.txId = Math.round(message.txId));
-        message.timestamp !== undefined && (obj.timestamp = Math.round(message.timestamp));
+        message.timestamp !== undefined &&
+            (obj.timestamp = Math.round(message.timestamp));
         message.msgId !== undefined && (obj.msgId = message.msgId);
         message.txType !== undefined && (obj.txType = message.txType);
         return obj;
@@ -922,7 +1084,14 @@ exports.MsgSetTxProcessResponse = {
     },
 };
 function createBaseMsgRequestDrainTransaction() {
-    return { creator: "", toChain: "", toAddress: "", symbol: "", amount: "", options: "" };
+    return {
+        creator: "",
+        toChain: "",
+        toAddress: "",
+        symbol: "",
+        amount: "",
+        options: "",
+    };
 }
 exports.MsgRequestDrainTransaction = {
     encode(message, writer = minimal_1.default.Writer.create()) {
@@ -1183,7 +1352,10 @@ exports.MsgFinalizeDrainTransactionResponse = {
         return message;
     },
     fromJSON(object) {
-        return { code: isSet(object.code) ? String(object.code) : "", msg: isSet(object.msg) ? String(object.msg) : "" };
+        return {
+            code: isSet(object.code) ? String(object.code) : "",
+            msg: isSet(object.msg) ? String(object.msg) : "",
+        };
     },
     toJSON(message) {
         const obj = {};
@@ -1204,11 +1376,13 @@ class MsgClientImpl {
         this.rpc = rpc;
         this.RequestTransaction = this.RequestTransaction.bind(this);
         this.FinalizeTransaction = this.FinalizeTransaction.bind(this);
-        this.RequestProvisionTransaction = this.RequestProvisionTransaction.bind(this);
+        this.RequestProvisionTransaction =
+            this.RequestProvisionTransaction.bind(this);
         this.CancelTransaction = this.CancelTransaction.bind(this);
         this.SetTxHash = this.SetTxHash.bind(this);
         this.SetTxProcess = this.SetTxProcess.bind(this);
-        this.FinalizeProvisionTransaction = this.FinalizeProvisionTransaction.bind(this);
+        this.FinalizeProvisionTransaction =
+            this.FinalizeProvisionTransaction.bind(this);
         this.RequestDrainTransaction = this.RequestDrainTransaction.bind(this);
         this.FinalizeDrainTransaction = this.FinalizeDrainTransaction.bind(this);
     }
@@ -1274,6 +1448,31 @@ var globalThis = (() => {
     }
     throw "Unable to locate global object";
 })();
+function bytesFromBase64(b64) {
+    if (globalThis.Buffer) {
+        return Uint8Array.from(globalThis.Buffer.from(b64, "base64"));
+    }
+    else {
+        const bin = globalThis.atob(b64);
+        const arr = new Uint8Array(bin.length);
+        for (let i = 0; i < bin.length; ++i) {
+            arr[i] = bin.charCodeAt(i);
+        }
+        return arr;
+    }
+}
+function base64FromBytes(arr) {
+    if (globalThis.Buffer) {
+        return globalThis.Buffer.from(arr).toString("base64");
+    }
+    else {
+        const bin = [];
+        arr.forEach((byte) => {
+            bin.push(String.fromCharCode(byte));
+        });
+        return globalThis.btoa(bin.join(""));
+    }
+}
 function longToNumber(long) {
     if (long.gt(Number.MAX_SAFE_INTEGER)) {
         throw new globalThis.Error("Value is larger than Number.MAX_SAFE_INTEGER");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kimafinance/kima-transaction-api",
-  "version": "1.0.24-beta.1",
+  "version": "1.0.26-beta.1",
   "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

@@ -29,6 +29,11 @@ interface Props {
   symbol: CurrencyOptions;
   amount: number;
   fee: number;
+  htlcCreationHash: string;
+  htlcCreationVout: number;
+  htlcExpirationTimestamp: string;
+  htlcVersion: string;
+  senderPubKey: Uint8Array;
 }
 
 function sleep(ms: number) {
@@ -43,6 +48,11 @@ export async function submitKimaTransaction({
   symbol,
   amount,
   fee,
+  htlcCreationHash,
+  htlcCreationVout,
+  htlcExpirationTimestamp,
+  htlcVersion,
+  senderPubKey,
 }: Props) {
   const wallet = await DirectSecp256k1HdWallet.fromMnemonic(
     process.env.KIMA_BACKEND_MNEMONIC as string,
@@ -59,6 +69,11 @@ export async function submitKimaTransaction({
     symbol,
     amount: amount.toString(),
     fee: fee.toString(),
+    htlcCreationHash,
+    htlcCreationVout,
+    htlcExpirationTimestamp,
+    htlcVersion,
+    senderPubKey,
   };
 
   let msg = await client.msgRequestTransaction(params);
@@ -80,7 +95,7 @@ export async function submitKimaTransaction({
     creator: firstAccount.address,
     txId,
     txHash: result.transactionHash,
-    txType: "request_transaction"
+    txType: "request_transaction",
   });
 
   console.log(msg);