@fireblocks/fireblocks-web3-provider

Fireblocks Web3 Provider

Fireblocks EIP-1193 Compatible Ethereum JavaScript Provider

Installation

npm install @fireblocks/fireblocks-web3-provider

Setup

import { FireblocksWeb3Provider, ChainId } from "@fireblocks/fireblocks-web3-provider";

const eip1193Provider = new FireblocksWeb3Provider({
    privateKey: process.env.FIREBLOCKS_API_PRIVATE_KEY_PATH,
    apiKey: process.env.FIREBLOCKS_API_KEY,
    vaultAccountIds: process.env.FIREBLOCKS_VAULT_ACCOUNT_IDS,
    chainId: ChainId.GOERLI,
})

Usage with ethers.js

import * as ethers from "ethers"

const provider = new ethers.providers.Web3Provider(eip1193Provider);

Usage with web3.js

import Web3 from "web3";

const web3 = new Web3(eip1193Provider);

API Documentation

new FireblocksWeb3Provider(config)

• config FireblocksProviderConfig

This class is an EIP-1193 Compatible Ethereum JavaScript Provider powered by the Fireblocks API

FireblocksProviderConfig

export type FireblocksProviderConfig = {
  // # Mandatory fields

  // Learn more about creating API users here: 
  // https://support.fireblocks.io/hc/en-us/articles/4407823826194-Adding-new-API-users
  apiKey: string,
  privateKey: string,
  
  // Either chainId or rpcUrl must be provided
  chainId?: ChainId, // If not provided, it is inferred from the rpcUrl
  rpcUrl?: string, // If not provided, it is inferred from the chainId
  
  // # Optional fields

  // By default, the first 20 vault accounts are dynamically loaded from the Fireblocks API
  // It is recommended to provide the vault account ids explicitly because it helps avoid unnecessary API calls
  vaultAccountIds?: number | number[] | string | string[],
  // By default, the fallback fee level is set to FeeLevel.MEDIUM
  fallbackFeeLevel?: FeeLevel,
  // By default, the note is set to "Created by Fireblocks Web3 Provider"
  note?: string,
  // By default, the polling interval is set to 1000ms (1 second)
  // It is the interval in which the Fireblocks API is queried to check the status of transactions
  pollingInterval?: number,
  // By default, it is assumed that one time addresses are enabled in your workspace
  // If they're not, set this to false
  oneTimeAddressesEnabled?: boolean,
  // By default, no externalTxId is associated with transactions
  // If you want to set one, you can either provide a function that returns a string, or provide a string directly
  externalTxId?: (() => string) | string,
}

Changelog

v1.0.0

29 December 2022

• Publish v1 release #2
• Document the configuration options 6338712
• release 0.0.9 a76188e
• remove "Beta" warning message f697939
• Generate full changelogs 293c187