Getting started

There are a few setup steps needed to start using the Kiln Connect SDK. Contact [e-mail] 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.

JavaScript

# using npm
npm install @kilnfi/sdk​

# using yarn
yarn add @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.

Create an application on your Kiln dashboard

Copy your Kiln API Key

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'.

With the Kiln Connect SDK, you remain entirely in control of what is sent for signing to your Fireblocks workspace. You can verify the content of the transactions crafted with this SDK before signing it. Note that the entire signing workflow is done on the SDK end, not on Kiln APIs. Kiln will never have access to your Fireblocks API key or secret key.

4. Configure the SDK

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

JavaScript

import { Kiln } from '@kilnfi/sdk';
const fs = require('fs');

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

const k = new Kiln({
  testnet: true, // true when using on testnet networks and Kiln's testnet API
  apiToken: 'kiln_xxx', // Kiln API token
});