@kimafinance/kima-transaction-api v1.0.30-beta.1

Kima Transaction API

A wrapper around Kima's API, enabling sending and monitoring transactions. This is for beta version

Install

npm install --save @kimafinance/kima-transaction-api
yarn add @kimafinance/kima-transaction-api

Usage

import {
  submitKimaTransaction,
  SupportNetworks,
  CurrencyOptions,
} from "@kimafinance/kima-transaction-backend";

const txResult = await submitKimaTransaction({
  originAddress: "0x1234123412341234123412341234123412341234",
  originChain: "ETH",
  targetAddress: "0x1234123412341234123412341234123412341234",
  targetChain: "POL",
  symbol: "USDK",
  amount: 100,
  fee: 0.3,
});

Available Functions

submitKimaTransaction : Submit a transaction to transfer liquidity from one change to another.

- `originAddress`: sending address
- `originChain`: sending chain
- `targetAddress`: receiving address
- `targetChain`: receiving chain
- `symbol`: token symbol
- `amount`: amount of token to transfer
- `fee`: 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. KIMA_BACKEND_NODE_PROVIDER : Node provider for kima chain