View Source FireblocksSdk.Api.Vault (FireblocksSdk v0.1.1)
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
Initiates activation for a wallet in a vault account.
Creates a new vault account with the requested name.
FireblocksSdk.Api.Vault.create([
name: "MyVault",
hiddenOnUI: false,
customerRefId: "MyCustomerRefId",
autoFuel: false
])
Options:
:name
(String.t/0
) - Required.:hiddenOnUI
(boolean/0
) - The default value isfalse
.:customerRefId
(String.t/0
):autoFuel
(boolean/0
) - The default value istrue
.
Creates a wallet for a specific asset in a vault account.
FireblocksSdk.Api.Vault.create_wallet([
vaultId: "1",
assetId: "XLM"
])
Options:
:vaultId
(String.t/0
) - Required.:assetId
(String.t/0
) - Required.:eosAccountName
(String.t/0
)
Lists all addresses for specific asset of vault account.
Gets the public key information based on derivation path and signing algorithm.
Options:
:vaultId
(String.t/0
):assetId
(String.t/0
):addressId
(String.t/0
):change
(String.t/0
):derivationPath
(String.t/0
) - Required.:algorithm
(String.t/0
) - Required.:compressed
(boolean/0
)
get_utxo_max_spendable_amount(vault_id, asset_id, manual_signing \\ false)
View SourceGet 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.
Get UTXO unspent input information.
Get the asset balance for a vault account.
FireblocksSdk.Api.Vault.get_vault_account_asset("1", "XLM")
Gets a single vault account
vault_id
: Fireblock vault id
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:
:namePrefix
(String.t/0
):nameSuffix
(String.t/0
):minAmountThreshold
(non_neg_integer/0
):assetId
(String.t/0
):orderBy
:limit
(non_neg_integer/0
):before
(String.t/0
):after
(String.t/0
)
Gets the assets amount summary for all accounts or filtered accounts.
Supported options:
:accountNamePrefix
(String.t/0
):accountNameSuffic
(String.t/0
)
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.
segwit_to_legacy(vault_id, asset_id, address_id, idempotentKey \\ "")
View SourceConverts an existing segwit address to the legacy format.
Sets the autofueling property of the vault account to enabled or disabled.
Options:
:vaultId
(String.t/0
) - Required.:autoFuel
(boolean/0
) - Required. The default value istrue
.
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:
:vaultId
(String.t/0
) - Required.:assetId
(String.t/0
):addressId
(String.t/0
):customerRefId
(String.t/0
) - Required.
Makes a hidden vault account visible in web console view.
Updates the description of an existing address of an asset in a vault account.
Options:
:vaultId
(String.t/0
) - Required.:assetId
(String.t/0
) - Required.:addressId
(String.t/0
) - Required.:description
(String.t/0
) - The default value is""
.