Class FireblocksService

Index

Constructors

Methods

ensureBtcWalletExists getBtcSegwitAddressForVaultID getFireblocksSDK getPublicKeyByVaultID signTransaction

Constructors

constructor

new FireblocksService(fireblocksConfig?: FireblocksConfig): FireblocksService
Parameters
- OptionalfireblocksConfig: FireblocksConfig
Returns FireblocksService
- Defined in src/services/fireblocks.service.ts:29

Methods

ensureBtcWalletExists

ensureBtcWalletExists(vaultID: string | number): Promise<void>
Ensures a BTC (or BTC_TEST) wallet exists in the given Fireblocks vault ID.
Parameters
- vaultID: string | number
  The Fireblocks vault ID as a string or number. Must be a valid non-negative integer.
Returns Promise<void>
Throws
If the vault ID is invalid or if any error occurs during the process.
- Defined in src/services/fireblocks.service.ts:100

getBtcSegwitAddressForVaultID

getBtcSegwitAddressForVaultID(vaultID: string | number): Promise<string>
Retrieves the public key associated with a given Fireblocks vault ID.

This method converts the provided vaultID to a non-negative integer, validates it, and then retrieves the corresponding public key using the Fireblocks SDK.
Parameters
- vaultID: string | number
  The Fireblocks vault ID as a string or number. Must be a valid non-negative integer.
Returns Promise<string>
A promise that resolves to the public key as a string.

Throws
If the vault ID is invalid or if any error occurs during the process.
- Defined in src/services/fireblocks.service.ts:135

getFireblocksSDK

getFireblocksSDK(): Fireblocks
Returns Fireblocks
The initialized Fireblocks SDK instance of this Service class.
- Defined in src/services/fireblocks.service.ts:58

getPublicKeyByVaultID

getPublicKeyByVaultID(vaultID: string | number): Promise<string>
Retrieves the public key associated with a given Fireblocks vault ID.

This method converts the provided vaultID to a non-negative integer, validates it, and then retrieves the corresponding public key using the Fireblocks SDK.
Parameters
- vaultID: string | number
  The Fireblocks vault ID as a string or number. Must be a valid non-negative integer.
Returns Promise<string>
A promise that resolves to the public key as a string.

Throws
If the vault ID is invalid or if any error occurs during the process.
- Defined in src/services/fireblocks.service.ts:72

signTransaction

signTransaction(
    content: string,
    vaultAccountId: string,
    txNote?: string,
): Promise<any>
Signs a transaction with the given vault account ID using the Fireblocks SDK and Fireblocks-signer.

This method prepares and sends a transaction from the specified sender to the recipient // descripe parameters
Parameters
- content: string
  The content of the transaction to sign.
- vaultAccountId: string
  The Fireblocks vault account ID as a string or number.
- OptionaltxNote: string
  An optional note for the transaction.
Returns Promise<any>
A promise that resolves to the signature when the transaction is successfully signed.

Throws
If any parameter is invalid or if the transaction fails.
- Defined in src/services/fireblocks.service.ts:193