README.md

The Official Javascript & Typescript SDK for Fireblocks API

About

This repository contains the official Javascript & Typescript SDK for Fireblocks API. For the complete API reference, go to API reference.

V4 Migration

Please read the following guide for migration

Usage

Before You Begin

Make sure you have the credentials for Fireblocks API Services. Otherwise, please contact Fireblocks support for further instructions on how to obtain your API credentials.

Requirements

• node.js v12 or newer

Installation

npm install fireblocks-sdk --save

or

yarn add fireblocks-sdk

Importing Fireblocks SDK

JavaScript:

const FireblocksSDK = require("fireblocks-sdk").FireblocksSDK;
const fireblocks = new FireblocksSDK(privateKey, apiKey);

TypeScript:

import { FireblocksSDK } from "fireblocks-sdk";
const fireblocks = new FireblocksSDK(privateKey, apiKey);

You can also pass additional options:

const baseUrl = "https://api.fireblocks.io";
const authProvider: IAuthProvider = { /* Custom implementation */ };
const fireblocks = new FireblocksSDK(privateKey, apiKey, baseUrl, authProvider, options);

The options argument has the following structure:

interface SDKOptions {
    /** HTTP request timeout */
    timeoutInMs?: number;

    /** Proxy configurations */
    proxy?: AxiosProxyConfig | false;

    /** Whether to remove platform from User-Agent header */
    anonymousPlatform?: boolean;
    
    /** Additional product identifier to be prepended to the User-Agent header */
    userAgent?: string;
}

Axios Interceptor

You can provide the sdk options with an axios response interceptor:

new FireblocksSDK(privateKey, userId, serverAddress, undefined, {
    customAxiosOptions: {
        interceptors: {
            response: {
                onFulfilled: (response) => {
                    console.log(`Request ID: ${response.headers["x-request-id"]}`);
                    return response;
                },
                onRejected: (error) => {
                    console.log(`Request ID: ${error.response.headers["x-request-id"]}`);
                    throw error;
                }
            }
        }
    }
});

Error Handling

The SDK throws AxiosError upon http errors for API requests.

You can read more about axios error handling here.

You can get more data on the Fireblocks error using the following fields:

• error.response.data.code: The Fireblocks error code, should be provided on support tickets
• error.response.data.message: Explanation of the Fireblocks error
• error.response.headers['x-request-id']: The request ID correlated to the API request, should be provided on support tickets / Github issues