Getting started
There are a few setup steps needed to start using the Kiln Connect SDK. Contact [email protected] should you have any feedbacks / questions.
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:
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.
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.
Generate the CSR certificate and make sure you store it somewhere safe.
Get the API key of the user by clicking on "Copy API key" of the user in the workspace members list
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,
}
});
Last updated
Was this helpful?