@kilnfi/sdk NPM

Description

Kiln JS SDK makes it easy to interact with the Kiln staking platform.

It provides a simple way of crafting staking transactions as well getting real time and historical data about your stakes.

Check out the full documentation.

Supported protocols

ADA
ATOM
DOT
DYDX
ETH
FET
INJ
MATIC
NEAR
NOBLE
OSMO
SOL
TIA
XTZ
More protocol to come, don't hesitate to contact us (support@kiln.fi)

⚠️️WARNING:

The transaction crafting and reporting are done on mainnet networks on OSMO / TIA / DYDX even in testnet mode.

Installation

You can install the JS SDK with npm:

npm install --save @kilnfi/sdk

Setup

In order to use this sdk, you will need a kiln api token. Please contact support@kiln.fi to get one.

import { Kiln } from "../src/kiln";

const k = new Kiln({
  testnet: true,
  apiToken: "kiln_xxx",
});

Craft 32 ETH staking transaction, sign it with fireblocks and broadcast it

import { Kiln } from "@kilnfi/sdk";
import { Integration } from "@kilnfi/sdk/lib/types/integrations";
const fs = require("fs");

const apiSecret = fs.readFileSync(__dirname + "/path_to_fireblocks_secret", "utf8");

const k = new Kiln({
  testnet: true,
  apiToken: "kiln_xxx",
});

const vault: Integration = {
  provider: "fireblocks",
  fireblocksApiKey: "YOUR_API_USER_KEY", // your fireblocks API user key
  fireblocksSecretKey: apiSecret, // your fireblocks private key (generated with your CSR file and your API user)
  vaultId: 7, // your fireblocks vault id
};

try {
  // Craft 32 ETH staking transaction
  const tx = await k.eth.craftStakeTx("kiln_account_id", "withdrawal_address", 32);

  // Sign it with your fireblock vault
  const txSigned = await k.eth.sign(vault, tx);

  // Broadcast it
  const hash = await k.eth.broadcast(txSigned);
} catch (err) {
  // handle errors
}

Fetch ETH stakes and network stats

try {
  // Get stakes by accounts
  const stakes = await k.eth.getAccountsRewards(["kiln-account-id"]);

  // Get stakes by wallets
  const stakesByWallet = await k.eth.getWalletRewards(["wallet-address"]);

  // Get stakes by validators
  const stakesByValidator = await k.eth.getStakesRewards(["validator-address"]);

  // Get network stats
  const stats = await k.eth.getNetworkStats();
} catch (err) {
  // handle errors
}