Skip to content

elements_blockchain

Francisco Dias edited this page Aug 20, 2026 · 1 revision

Blockchain

The Blockchain endpoints.

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.



Back To Top

elements_create_smart_contract

Patches a Smart Contract entry, associated with the specified deployed script hash.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_smart_contract(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateSmartContractRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsSmartContract or Undefined
_request ElementsRequest


Back To Top

elements_create_vault

Creates a new Vault, associated with the given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_vault(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateVaultRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsVault or Undefined
_request ElementsRequest


Back To Top

elements_create_wallet

Creates a new Wallet, associated with the given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_create_wallet(_vault_id, _body=undefined, _callback=undefined)
Argument Type Description
_vault_id String
_body ElementsCreateWalletRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsWallet or Undefined
_request ElementsRequest


Back To Top

elements_delete_contract

Deletes a Smart Contract with the specified contractId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_contract(_contract_id, _callback=undefined)
Argument Type Description
_contract_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_delete_vault

Deletes a Vault with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_vault(_vault_id, _callback=undefined)
Argument Type Description
_vault_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_delete_wallet

Deletes a Wallet with the specified id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_delete_wallet(_vault_id, _wallet_id, _callback=undefined)
Argument Type Description
_vault_id String
_wallet_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest


Back To Top

elements_get_smart_contract

Gets a specific Smart Contract by contractId.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_smart_contract(_contract_id, _callback=undefined)
Argument Type Description
_contract_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsSmartContract or Undefined
_request ElementsRequest


Back To Top

elements_get_smart_contracts

Gets a pagination of SmartContracts.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_smart_contracts(_offset=undefined, _count=undefined, _api=undefined, _network=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_api String
_network Array of String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationSmartContract or Undefined
_request ElementsRequest


Back To Top

elements_get_vault

Gets a specific Vault by Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_vault(_vault_id, _callback=undefined)
Argument Type Description
_vault_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsVault or Undefined
_request ElementsRequest


Back To Top

elements_get_vaults

Gets a pagination of Wallets. Optionally a user Id can be specified to filter for a given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_vaults(_offset=undefined, _count=undefined, _user_id=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_user_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationVault or Undefined
_request ElementsRequest


Back To Top

elements_get_wallet

Gets a specific Wallet by Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_wallet(_wallet_id, _callback=undefined)
Argument Type Description
_wallet_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsWallet or Undefined
_request ElementsRequest


Back To Top

elements_get_wallet_for_vault

Gets a specific Wallet by Id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_wallet_for_vault(_vault_id, _wallet_id, _callback=undefined)
Argument Type Description
_vault_id String
_wallet_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsWallet or Undefined
_request ElementsRequest


Back To Top

elements_get_wallets

Gets a pagination of Wallets. Optionally a user Id can be specified to filter for a given user.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_get_wallets(_vault_id, _offset=undefined, _count=undefined, _user_id=undefined, _api=undefined, _network=undefined, _callback=undefined)
Argument Type Description
_vault_id String
_offset Real
_count Real
_user_id String
_api String
_network Array of String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationWallet or Undefined
_request ElementsRequest


Back To Top

elements_update_smart_contract

Patches a Smart Contract entry, associated with the specified deployed script hash.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_smart_contract(_contract_id, _body=undefined, _callback=undefined)
Argument Type Description
_contract_id String
_body ElementsUpdateSmartContractRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsSmartContract or Undefined
_request ElementsRequest


Back To Top

elements_update_vault

Updates a Vault with the specified name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_vault(_vault_id, _body=undefined, _callback=undefined)
Argument Type Description
_vault_id String
_body ElementsUpdateVaultRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsVault or Undefined
_request ElementsRequest


Back To Top

elements_update_wallet

Updates a Wallet with the specified name or id.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback.


Syntax:

elements_update_wallet(_vault_id, _wallet_id, _body=undefined, _callback=undefined)
Argument Type Description
_vault_id String
_wallet_id String
_body ElementsUpdateWalletRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsWallet or Undefined
_request ElementsRequest


Clone this wiki locally