Updated Fireblocks Use Cases page

Improvements to notifications and data objects

Added "Structuring Your Vault" section

Updates to API Co-Signer Callback

New article: Transaction sources & destinations

A new article titled Transaction Sources & Destinations has been added to the developer portal detailing which locations can be identified as a source or destination when creating new transactions or retrieving existing transactions.

Updates and improvements to documentation

  1. The Supported Assets section has been renamed Blockchains & Assets. The following endpoints have been moved to Blockchains & Assets in the documentation with no change to their behavior:
    1. GET https://api.fireblocks.io/v1/estimate_network_fee
    2. POST https://api.fireblocks.io/v1/transactions/validate_address/{assetId}/{address}
  2. Additional documentation has been added to the following endpoints:
    1. List transaction history
    2. Find a specific transaction
    3. Find a specific transaction by external transaction ID
  3. Removed options that have never been officially supported by Fireblocks with the exception of a small group of beta workspaces:
    1. Filter transactions by OEC_PARTNER
    2. The fields maxBip44AddressIndexUsed and maxBip44ChangeAddressIndexUsed have been removed from vault endpoints. Fireblocks has never returned these options and they were documented incorrectly.
  4. If a confirmation threshold is set by transaction ID or set by transaction hash and the value is below the required number of confirmations for a specific blockchain, an error with code 400 1451 is returned. This error response has been active since March 14, 2023.
  5. The code samples for the following endpoints have been corrected:
    1. GET /v1/transactions
    2. GET /v1/transactions/validate_address/{assetId}/{address}
    3. GET /v1/vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info

Update to Webhooks & API Co-Signer Notifications Sections

The Webhooks & Notifications, and API Co-Signer Callback sections of the API Reference guide have been updated to a clearer order, with new sections for each notification type. There have been no changes to webhooks or co-signer callback behavior.

Updates to transaction API endpoints

  • Affected endpoints and objects
  • The TransactionOperation data object now includes all options with a detailed description of each one.
  • The feePayerInfo field has been removed from the documentation. It was included in the Developer Documentation but has never been returned in any response.
  • Known limitations
    The following limitations are known for the following cases:
    • When creating a transaction, if the forceSweep parameter is set to true for a transfer when the source account is 1 DOT, the transaction will fail. Any amount more or less than 1 DOT succeeds. This is a Polkadot blockchain limitation.
    • When retrieving transactions, if a transaction uses the destinations object with more than one value in the array, the blockInfo data object is returned as null.
  • Compound
    The SUPPLY_FROM_COMPOUND and REDEEM_FROM_COMPOUND transaction operation have been removed from the documentation.
    These options are deprecated and no longer available when creating a transaction. They are still returned when retrieving relevant past transactions.
  • Recommended numeric string fields
    Several numeric fields have been deprecated. Although they are still supported, they are now replaced by numeric string fields that are highly recommended and allow greater accuracy. The deprecated fields and the recommended amountInfo object that replaces them are described below.
  • The amountInfo object is now recommended
    The amount, requestedAmount, netAmount, and amountUSD numeric fields have been deprecated for all Transaction Response objects. The deprecated fields are still returned in all relevant responses but are not recommended. The amountInfo object that was introduced in September 2020, includes all these fields as strings and is recommended in place. These string fields ensure support for accurate decimal precision.
    • The amountInfo object comprises the following fields:
      • amount - string
        If the transfer is a withdrawal from an exchange, the actual amount that was requested to be transferred. Otherwise, it is the requested amount. This value will always be equal to the amount (number) parameter of TransactionDetails.
      • requestedAmount - string
        The amount requested by the user.
      • netAmount - string
        The net amount of the transaction, after fee deduction.
      • amountUSD - string
        The USD value of the requested amount.

Updates to fiat accounts

All documentation relating to fiat providers no longer includes options for Silvergate or Signature banks. These connections were deprecated in March 2023, and April 2023, respectively.

Updates to raw signing API objects

  • The MPC_ECDSA_SECP256R1 option has been removed from the documentation. It was included in the SigningAlgorithm Vault object. It has never been supported by Fireblocks and should not have been documented previously.
  • For customers who use the Fireblocks EU cloud environment, the rawTx parameter is not included in the CallbackResponse object.