Kiln's JS SDK allow you to:

• Craft, sign and broadcast staking transactions using Fireblocks as a custody solution

• Get staking data about your stakes and their rewards

• Get network wide data

• Manage your Kiln accounts

Supported languages and protocols:

JS SDK:

https://github.com/kilnfi/sdk-js

https://www.npmjs.com/package/@kilnfi/sdk

All Kiln Connect protocols are supported in the SDK.

Find Kiln Connect documentation here:

https://docs.api.kiln.fi/docs/quickstart

When staking on different protocols, you will need to find Kiln's validator addresses if you choose to stake with Kiln.

Addresses on all protocols can be found in this section

v3 changelog

Here is the high level changelog of the v3:

• The Kiln class now exposes a type safe HTTP client that exposes all Kiln Connect endpoints available. The client is generated from our OpenAPI specs. The OpenAPI typescript schema is also exposed so you can benefit from all type definitions. The schema and SDK will be updated frequently with newly added endpoints.

• The fireblocks raw signing feature is now under the fireblocks service exposed by the Kiln class. A sign method is available for all protocols we support.

Upgrade from 2.X to 3.X

Update your dependencies:

Update calls to use the http client instead of specific protocol object.

2.X:

3.X:

1. Install the SDK

The Kiln Connect SDK is only available in TS/JS for now, if you have other programming language requirements, please contact the support.

# using bun
bun install @kilnfi/sdk​

2. Retrieve your Kiln API key

Create an application on your Kiln Dashboard, and retrieve the given API key.

The API key is used to authenticate with the Kiln REST API which can manage Kiln accounts, craft transactions, and provide reporting data.

3. Set up Fireblocks (required to sign transactions)

In the case that you would like to craft and sign transactions with your Fireblocks vault, you will need to setup the following in Fireblocks:

1. The raw signing feature is required on all protocols except on EVM compatible protocols (ETH, MATIC). Make sure that it is enabled in your workspace in case you wish to stake on other protocols. You can ask the Fireblocks support for information.

2. Create an API user using the Fireblocks tutorial here with the Editor role (minimum privilege to initiate transactions on the workspace). This might require that you contact your Fireblocks support.

3. Generate the CSR certificate and make sure you store it somewhere safe.

4. Get the API key of the user by clicking on "Copy API key" of the user in the workspace members list

5. Get the vault account id you want to stake with by clicking on it in your Fireblocks workspace and check the URL. For example the vault id of https://console.fireblocks.io/v2/accounts/vault/4 is '4'.

4. Configure the SDK

You can now configure the SDK with you Kiln API token.​

import { Kiln } from '@kilnfi/sdk';
import fs from "node:fs";

// Fireblocks secret key
const apiSecret = fs.readFileSync(__dirname + '/fireblocks_secret.key', 'utf8');

const k = new Kiln({
    baseUrl: 'https://api.kiln.fi',
    apiToken: 'KILN_API_KEY',
});


const tx = await k.client.POST(
  '/v1/near/transaction/stake',
  {
    body: {
      account_id: 'd3f1b917-72b1-4982-a4dd-93fce579a708',
      wallet: 'c36b1a5da2e60d1fd5d3a6b46f7399eb26571457f3272f3c978bc9527ad2335f',
      pool_id: 'kiln.pool.f863973.m0',
      amount_yocto: '1000000000000000000000000',
    }
  }
);

const signResponse = await k.fireblocks.signNearTx(vault, tx.data.data, "NEAR_TEST");

const broadcastedTx = await k.client.POST("/v1/near/transaction/broadcast", {
  body: {
    signed_tx_serialized: signResponse.signed_tx.data.signed_tx_serialized,
  }
});