@kimafinance/kima-transaction-api 1.0.0

package/README.md

@@ -0,0 +1,43 @@
+# Kima Transaction API
+
+A wrapper around Kima's API, enabling sending and monitoring transactions
+
+## Install
+
+```bash
+npm install --save @kimafinance/kima-transaction-api
+yarn add @kimafinance/kima-transaction-api
+```
+
+
+## Usage
+
+```ts
+import { submitKimaTransaction } from '@kimafinance/kima-transaction-backend'
+
+const txResult = await submitKimaTransaction({
+    originAddress: "0x1234123412341234123412341234123412341234",
+    originChain: "Ethereum",
+    targetAddress: "0x1234123412341234123412341234123412341234",
+    targetChain: "Polygon",
+    amount: 100,
+    fee: 0.3
+})
+
+```
+
+
+## Available Functions
+
+`submitKimaTransaction` : Submit a transaction to transfer liquidity from one change to another.
+
+    - `originAddress (string)`: sending address
+    - `originChain (string)`: sending chain
+    - `targetAddress (string)`: receiving address
+    - `targetChain (string)`: receiving chain
+    - `amount (number)`: amount of token to transfer
+    - `fee (number)`: amount of token that kima consumes to pay gas fee for pulling & releasing token transactions
+
+## 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

@@ -0,0 +1,10 @@
+interface Props {
+    originChain: string;
+    originAddress: string;
+    targetChain: string;
+    targetAddress: string;
+    amount: number;
+    fee: number;
+}
+export declare function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, amount, fee, }: Props): Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+export {};

package/build/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.submitKimaTransaction = void 0;
+const proto_signing_1 = require("@cosmjs/proto-signing");
+const common_1 = require("./kima/common");
+async function submitKimaTransaction({ originChain, originAddress, targetChain, targetAddress, amount, fee, }) {
+    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,
+        originChain,
+        originAddress,
+        targetChain,
+        targetAddress,
+        amount: amount.toString(),
+        fee: fee.toString(),
+    };
+    const msg = await client.msgRequestTransaction(params);
+    return await client.signAndBroadcast([msg]);
+}
+exports.submitKimaTransaction = submitKimaTransaction;

package/build/kima/common.d.ts

@@ -0,0 +1,15 @@
+import { StdFee } from '@cosmjs/stargate';
+import { Registry, OfflineSigner, EncodeObject } from '@cosmjs/proto-signing';
+import { MsgRequestTransaction, MsgApproveTransaction, MsgFetchBalance } from './tx';
+interface SignAndBroadcastOptions {
+    fee: StdFee;
+    memo?: string;
+}
+export declare const registry: Registry;
+export declare const TxClient: (wallet: OfflineSigner) => Promise<{
+    signAndBroadcast: (msgs: EncodeObject[], { fee, memo }?: SignAndBroadcastOptions) => Promise<import("@cosmjs/stargate").DeliverTxResponse>;
+    msgRequestTransaction: (data: MsgRequestTransaction) => EncodeObject;
+    msgApproveTransaction: (data: MsgApproveTransaction) => EncodeObject;
+    msgFetchBalance: (data: MsgFetchBalance) => EncodeObject;
+}>;
+export {};

package/build/kima/common.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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");
+dotenv_1.default.config();
+const defaultFee = {
+    amount: [],
+    gas: '200000'
+};
+const types = [
+    [
+        '/DiversifiTechnologies.diversifi.diversifi.MsgRequestTransaction',
+        tx_1.MsgRequestTransaction
+    ],
+    [
+        '/DiversifiTechnologies.diversifi.diversifi.MsgApproveTransaction',
+        tx_1.MsgApproveTransaction
+    ],
+    [
+        '/DiversifiTechnologies.diversifi.diversifi.MsgFetchBalance',
+        tx_1.MsgFetchBalance
+    ]
+];
+exports.registry = new proto_signing_1.Registry(types);
+const TxClient = async (wallet) => {
+    const client = await stargate_1.SigningStargateClient.connectWithSigner('https://' + process.env.KIMA_BACKEND_DIVERSIFI_NODE_PROVIDER1, wallet, { registry: exports.registry });
+    const { address } = (await wallet.getAccounts())[0];
+    return {
+        signAndBroadcast: (msgs, { fee, memo } = { fee: defaultFee, memo: '' }) => client.signAndBroadcast(address, msgs, fee, memo),
+        msgRequestTransaction: (data) => ({
+            typeUrl: '/DiversifiTechnologies.diversifi.diversifi.MsgRequestTransaction',
+            value: tx_1.MsgRequestTransaction.fromPartial(data)
+        }),
+        msgApproveTransaction: (data) => ({
+            typeUrl: '/DiversifiTechnologies.diversifi.diversifi.MsgApproveTransaction',
+            value: tx_1.MsgApproveTransaction.fromPartial(data)
+        }),
+        msgFetchBalance: (data) => ({
+            typeUrl: '/DiversifiTechnologies.diversifi.diversifi.MsgFetchBalance',
+            value: tx_1.MsgFetchBalance.fromPartial(data)
+        })
+    };
+};
+exports.TxClient = TxClient;

package/build/kima/tx.d.ts

@@ -0,0 +1,274 @@
+import { Reader, Writer } from 'protobufjs/minimal';
+export declare const protobufPackage = "DiversifiTechnologies.diversifi.diversifi";
+export interface MsgRequestTransaction {
+    creator: string;
+    originChain: string;
+    originAddress: string;
+    targetChain: string;
+    targetAddress: string;
+    amount: string;
+    fee: string;
+}
+export interface MsgRequestTransactionResponse {
+    code: string;
+    msg: string;
+}
+export interface MsgApproveTransaction {
+    creator: string;
+    txHash: string;
+    success: string;
+    signedKey: string;
+}
+export interface MsgApproveTransactionResponse {
+    code: string;
+    msg: string;
+}
+export interface MsgFetchBalance {
+    creator: string;
+}
+export interface MsgFetchBalanceResponse {
+    code: string;
+    result: string;
+}
+export interface MsgObservationVote {
+    creator: string;
+    txHash: string;
+    chainId: string;
+    from: string;
+    to: string;
+    amount: string;
+}
+export interface MsgObservationVoteResponse {
+    code: string;
+    msg: string;
+}
+export interface MsgUpdateBalance {
+    creator: string;
+    chainId: string;
+    balance: string;
+    decimal: string;
+}
+export interface MsgUpdateBalanceResponse {
+    code: string;
+    msg: string;
+}
+export interface MsgKeysignVote {
+    creator: string;
+    txHash: string;
+    pubKey: string;
+}
+export interface MsgKeysignVoteResponse {
+    code: string;
+    msg: string;
+}
+export interface MsgUpdateGasFee {
+    creator: string;
+    chainId: string;
+    fee: string;
+}
+export interface MsgUpdateGasFeeResponse {
+}
+export interface MsgProvisionTransaction {
+    creator: string;
+    fromChain: string;
+    fromAddress: string;
+    symbol: string;
+    tokenAddr: string;
+    amount: string;
+    options: string;
+}
+export interface MsgProvisionTransactionResponse {
+}
+export interface MsgDrainTransaction {
+    creator: string;
+    fromChain: string;
+    toChain: string;
+    toAddress: string;
+    nftAddr: string;
+    amount: string;
+    options: string;
+}
+export interface MsgDrainTransactionResponse {
+}
+export interface MsgCancelTransaction {
+    creator: string;
+    transactionId: string;
+}
+export interface MsgCancelTransactionResponse {
+}
+export declare const MsgRequestTransaction: {
+    encode(message: MsgRequestTransaction, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgRequestTransaction;
+    fromJSON(object: any): MsgRequestTransaction;
+    toJSON(message: MsgRequestTransaction): unknown;
+    fromPartial(object: DeepPartial<MsgRequestTransaction>): MsgRequestTransaction;
+};
+export declare const MsgRequestTransactionResponse: {
+    encode(message: MsgRequestTransactionResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgRequestTransactionResponse;
+    fromJSON(object: any): MsgRequestTransactionResponse;
+    toJSON(message: MsgRequestTransactionResponse): unknown;
+    fromPartial(object: DeepPartial<MsgRequestTransactionResponse>): MsgRequestTransactionResponse;
+};
+export declare const MsgApproveTransaction: {
+    encode(message: MsgApproveTransaction, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgApproveTransaction;
+    fromJSON(object: any): MsgApproveTransaction;
+    toJSON(message: MsgApproveTransaction): unknown;
+    fromPartial(object: DeepPartial<MsgApproveTransaction>): MsgApproveTransaction;
+};
+export declare const MsgApproveTransactionResponse: {
+    encode(message: MsgApproveTransactionResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgApproveTransactionResponse;
+    fromJSON(object: any): MsgApproveTransactionResponse;
+    toJSON(message: MsgApproveTransactionResponse): unknown;
+    fromPartial(object: DeepPartial<MsgApproveTransactionResponse>): MsgApproveTransactionResponse;
+};
+export declare const MsgFetchBalance: {
+    encode(message: MsgFetchBalance, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgFetchBalance;
+    fromJSON(object: any): MsgFetchBalance;
+    toJSON(message: MsgFetchBalance): unknown;
+    fromPartial(object: DeepPartial<MsgFetchBalance>): MsgFetchBalance;
+};
+export declare const MsgFetchBalanceResponse: {
+    encode(message: MsgFetchBalanceResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgFetchBalanceResponse;
+    fromJSON(object: any): MsgFetchBalanceResponse;
+    toJSON(message: MsgFetchBalanceResponse): unknown;
+    fromPartial(object: DeepPartial<MsgFetchBalanceResponse>): MsgFetchBalanceResponse;
+};
+export declare const MsgObservationVote: {
+    encode(message: MsgObservationVote, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgObservationVote;
+    fromJSON(object: any): MsgObservationVote;
+    toJSON(message: MsgObservationVote): unknown;
+    fromPartial(object: DeepPartial<MsgObservationVote>): MsgObservationVote;
+};
+export declare const MsgObservationVoteResponse: {
+    encode(message: MsgObservationVoteResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgObservationVoteResponse;
+    fromJSON(object: any): MsgObservationVoteResponse;
+    toJSON(message: MsgObservationVoteResponse): unknown;
+    fromPartial(object: DeepPartial<MsgObservationVoteResponse>): MsgObservationVoteResponse;
+};
+export declare const MsgUpdateBalance: {
+    encode(message: MsgUpdateBalance, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgUpdateBalance;
+    fromJSON(object: any): MsgUpdateBalance;
+    toJSON(message: MsgUpdateBalance): unknown;
+    fromPartial(object: DeepPartial<MsgUpdateBalance>): MsgUpdateBalance;
+};
+export declare const MsgUpdateBalanceResponse: {
+    encode(message: MsgUpdateBalanceResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgUpdateBalanceResponse;
+    fromJSON(object: any): MsgUpdateBalanceResponse;
+    toJSON(message: MsgUpdateBalanceResponse): unknown;
+    fromPartial(object: DeepPartial<MsgUpdateBalanceResponse>): MsgUpdateBalanceResponse;
+};
+export declare const MsgKeysignVote: {
+    encode(message: MsgKeysignVote, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgKeysignVote;
+    fromJSON(object: any): MsgKeysignVote;
+    toJSON(message: MsgKeysignVote): unknown;
+    fromPartial(object: DeepPartial<MsgKeysignVote>): MsgKeysignVote;
+};
+export declare const MsgKeysignVoteResponse: {
+    encode(message: MsgKeysignVoteResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgKeysignVoteResponse;
+    fromJSON(object: any): MsgKeysignVoteResponse;
+    toJSON(message: MsgKeysignVoteResponse): unknown;
+    fromPartial(object: DeepPartial<MsgKeysignVoteResponse>): MsgKeysignVoteResponse;
+};
+export declare const MsgUpdateGasFee: {
+    encode(message: MsgUpdateGasFee, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgUpdateGasFee;
+    fromJSON(object: any): MsgUpdateGasFee;
+    toJSON(message: MsgUpdateGasFee): unknown;
+    fromPartial(object: DeepPartial<MsgUpdateGasFee>): MsgUpdateGasFee;
+};
+export declare const MsgUpdateGasFeeResponse: {
+    encode(_: MsgUpdateGasFeeResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgUpdateGasFeeResponse;
+    fromJSON(_: any): MsgUpdateGasFeeResponse;
+    toJSON(_: MsgUpdateGasFeeResponse): unknown;
+    fromPartial(_: DeepPartial<MsgUpdateGasFeeResponse>): MsgUpdateGasFeeResponse;
+};
+export declare const MsgProvisionTransaction: {
+    encode(message: MsgProvisionTransaction, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgProvisionTransaction;
+    fromJSON(object: any): MsgProvisionTransaction;
+    toJSON(message: MsgProvisionTransaction): unknown;
+    fromPartial(object: DeepPartial<MsgProvisionTransaction>): MsgProvisionTransaction;
+};
+export declare const MsgProvisionTransactionResponse: {
+    encode(_: MsgProvisionTransactionResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgProvisionTransactionResponse;
+    fromJSON(_: any): MsgProvisionTransactionResponse;
+    toJSON(_: MsgProvisionTransactionResponse): unknown;
+    fromPartial(_: DeepPartial<MsgProvisionTransactionResponse>): MsgProvisionTransactionResponse;
+};
+export declare const MsgDrainTransaction: {
+    encode(message: MsgDrainTransaction, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgDrainTransaction;
+    fromJSON(object: any): MsgDrainTransaction;
+    toJSON(message: MsgDrainTransaction): unknown;
+    fromPartial(object: DeepPartial<MsgDrainTransaction>): MsgDrainTransaction;
+};
+export declare const MsgDrainTransactionResponse: {
+    encode(_: MsgDrainTransactionResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgDrainTransactionResponse;
+    fromJSON(_: any): MsgDrainTransactionResponse;
+    toJSON(_: MsgDrainTransactionResponse): unknown;
+    fromPartial(_: DeepPartial<MsgDrainTransactionResponse>): MsgDrainTransactionResponse;
+};
+export declare const MsgCancelTransaction: {
+    encode(message: MsgCancelTransaction, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgCancelTransaction;
+    fromJSON(object: any): MsgCancelTransaction;
+    toJSON(message: MsgCancelTransaction): unknown;
+    fromPartial(object: DeepPartial<MsgCancelTransaction>): MsgCancelTransaction;
+};
+export declare const MsgCancelTransactionResponse: {
+    encode(_: MsgCancelTransactionResponse, writer?: Writer): Writer;
+    decode(input: Reader | Uint8Array, length?: number): MsgCancelTransactionResponse;
+    fromJSON(_: any): MsgCancelTransactionResponse;
+    toJSON(_: MsgCancelTransactionResponse): unknown;
+    fromPartial(_: DeepPartial<MsgCancelTransactionResponse>): MsgCancelTransactionResponse;
+};
+/** Msg defines the Msg service. */
+export interface Msg {
+    RequestTransaction(request: MsgRequestTransaction): Promise<MsgRequestTransactionResponse>;
+    ApproveTransaction(request: MsgApproveTransaction): Promise<MsgApproveTransactionResponse>;
+    FetchBalance(request: MsgFetchBalance): Promise<MsgFetchBalanceResponse>;
+    ObservationVote(request: MsgObservationVote): Promise<MsgObservationVoteResponse>;
+    UpdateBalance(request: MsgUpdateBalance): Promise<MsgUpdateBalanceResponse>;
+    KeysignVote(request: MsgKeysignVote): Promise<MsgKeysignVoteResponse>;
+    UpdateGasFee(request: MsgUpdateGasFee): Promise<MsgUpdateGasFeeResponse>;
+    ProvisionTransaction(request: MsgProvisionTransaction): Promise<MsgProvisionTransactionResponse>;
+    DrainTransaction(request: MsgDrainTransaction): Promise<MsgDrainTransactionResponse>;
+    /** this line is used by starport scaffolding # proto/tx/rpc */
+    CancelTransaction(request: MsgCancelTransaction): Promise<MsgCancelTransactionResponse>;
+}
+export declare class MsgClientImpl implements Msg {
+    private readonly rpc;
+    constructor(rpc: Rpc);
+    RequestTransaction(request: MsgRequestTransaction): Promise<MsgRequestTransactionResponse>;
+    ApproveTransaction(request: MsgApproveTransaction): Promise<MsgApproveTransactionResponse>;
+    FetchBalance(request: MsgFetchBalance): Promise<MsgFetchBalanceResponse>;
+    ObservationVote(request: MsgObservationVote): Promise<MsgObservationVoteResponse>;
+    UpdateBalance(request: MsgUpdateBalance): Promise<MsgUpdateBalanceResponse>;
+    KeysignVote(request: MsgKeysignVote): Promise<MsgKeysignVoteResponse>;
+    UpdateGasFee(request: MsgUpdateGasFee): Promise<MsgUpdateGasFeeResponse>;
+    ProvisionTransaction(request: MsgProvisionTransaction): Promise<MsgProvisionTransactionResponse>;
+    DrainTransaction(request: MsgDrainTransaction): Promise<MsgDrainTransactionResponse>;
+    CancelTransaction(request: MsgCancelTransaction): Promise<MsgCancelTransactionResponse>;
+}
+interface Rpc {
+    request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>;
+}
+type Builtin = Date | Function | Uint8Array | string | number | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export {};