View Source FireblocksSdk.Api.Vault (FireblocksSdk v0.1.2)

Link to this section Summary

Functions

Initiates activation for a wallet in a vault account.

Creates a new vault account with the requested name.

Creates a wallet for a specific asset in a vault account.

Lists all addresses for specific asset of vault account.

Gets the public key information based on derivation path and signing algorithm.

Get the maximum amount of a particular asset that can be spent in a single transaction from a specified vault account (UTXO assets only, with a limitation on number of inputs embedded).

Get UTXO unspent input information.

Get the asset balance for a vault account.

Gets a single vault account

Gets a list of vault accounts per page matching the given filter or path

Gets the assets amount summary for all accounts or filtered accounts.

Hides the requested vault account from the web console view.

Updates the balance of a specific asset in a vault account.

Renames the requested vault account.

Converts an existing segwit address to the legacy format.

Sets the autofueling property of the vault account to enabled or disabled.

Assigns an AML/KYT customer reference ID for the vault account.

Makes a hidden vault account visible in web console view.

Updates the description of an existing address of an asset in a vault account.

Link to this section Functions

Link to this function

active(vault_id, asset_id, idempotentKey \\ "")

View Source

Initiates activation for a wallet in a vault account.

Link to this function

create(vault, idempotentKey \\ "")

View Source

Creates a new vault account with the requested name.

FireblocksSdk.Api.Vault.create([
  name: "MyVault",
  hiddenOnUI: false,
  customerRefId: "MyCustomerRefId",
  autoFuel: false
])

Options:

Link to this function

create_wallet(wallet, idempotentKey \\ "")

View Source

Creates a wallet for a specific asset in a vault account.

FireblocksSdk.Api.Vault.create_wallet([
  vaultId: "1",
  assetId: "XLM"
])

Options:

Link to this function

get_deposit_addresses(vault_id, asset_id)

View Source

Lists all addresses for specific asset of vault account.

Link to this function

get_public_key_info(filter)

View Source

Gets the public key information based on derivation path and signing algorithm.

Options:

Link to this function

get_utxo_max_spendable_amount(vault_id, asset_id, manual_signing \\ false)

View Source

Get the maximum amount of a particular asset that can be spent in a single transaction from a specified vault account (UTXO assets only, with a limitation on number of inputs embedded).

Send several transactions if you want to spend more than the maximum spendable amount.

Link to this function

get_utxo_unspent_inputs(vault_id, asset_id)

View Source

Get UTXO unspent input information.

Link to this function

get_vault_account_asset(vault_id, asset_id)

View Source

Get the asset balance for a vault account.

FireblocksSdk.Api.Vault.get_vault_account_asset("1", "XLM")
Link to this function

get_vault_account_by_id(vault_id)

View Source

Gets a single vault account

  • vault_id: Fireblock vault id
Link to this function

get_vault_accounts_with_page_info(options)

View Source

Gets a list of vault accounts per page matching the given filter or path

FireblocksSdk.Api.Vault.get_vault_accounts_with_page_info([
  namePrefix: "Operations",
  assetId: "ETH",
  limit: 30
])

Supported options:

Link to this function

get_vault_assets_balance(options)

View Source

Gets the assets amount summary for all accounts or filtered accounts.

Supported options:

Link to this function

hide(vault_id, idempotentKey \\ "")

View Source

Hides the requested vault account from the web console view.

Link to this function

refresh_balance(vault_id, asset_id, idempotentKey \\ "")

View Source

Updates the balance of a specific asset in a vault account.

Link to this function

rename(vault_id, name, idempotentKey \\ "")

View Source

Renames the requested vault account.

Link to this function

segwit_to_legacy(vault_id, asset_id, address_id, idempotentKey \\ "")

View Source

Converts an existing segwit address to the legacy format.

Link to this function

set_auto_fuel(fuel, idempotentKey \\ "")

View Source

Sets the autofueling property of the vault account to enabled or disabled.

Options:

Link to this function

set_customer_ref_id(reference, idempotentKey \\ "")

View Source

Assigns an AML/KYT customer reference ID for the vault account.

# set customer reference on vault
FireblocksSdk.Api.Vault.set_customer_ref_id([
  vaultId: "1",
  customerRefId: "Customer#1"
])

# set customer reference on vault asset
FireblocksSdk.Api.Vault.set_customer_ref_id([
  vaultId: "1",
  assetId: "ETH",
  customerRefId: "Customer#1"
])

Options:

Link to this function

unhide(vault_id, idempotentKey \\ "")

View Source

Makes a hidden vault account visible in web console view.

Link to this function

update_address_description(change, idempotentKey \\ "")

View Source

Updates the description of an existing address of an asset in a vault account.

Options: