fireblocks_sdk::apis::fireblocks_network_api

Trait FireblocksNetworkApi

Source 
pub trait FireblocksNetworkApi: Send + Sync {

Show 15 methods    // Required methods
    fn check_third_party_routing<'life0, 'async_trait>(
        &'life0 self,
        params: CheckThirdPartyRoutingParams,
    ) -> Pin<Box<dyn Future<Output = Result<ThirdPartyRouting, Error<CheckThirdPartyRoutingError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_network_connection<'life0, 'async_trait>(
        &'life0 self,
        params: CreateNetworkConnectionParams,
    ) -> Pin<Box<dyn Future<Output = Result<NetworkConnectionResponse, Error<CreateNetworkConnectionError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn create_network_id<'life0, 'async_trait>(
        &'life0 self,
        params: CreateNetworkIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<NetworkIdResponse, Error<CreateNetworkIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn delete_network_connection<'life0, 'async_trait>(
        &'life0 self,
        params: DeleteNetworkConnectionParams,
    ) -> Pin<Box<dyn Future<Output = Result<DeleteNetworkConnectionResponse, Error<DeleteNetworkConnectionError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn delete_network_id<'life0, 'async_trait>(
        &'life0 self,
        params: DeleteNetworkIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<DeleteNetworkIdResponse, Error<DeleteNetworkIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_network<'life0, 'async_trait>(
        &'life0 self,
        params: GetNetworkParams,
    ) -> Pin<Box<dyn Future<Output = Result<NetworkConnectionResponse, Error<GetNetworkError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_network_connections<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkConnectionResponse>, Error<GetNetworkConnectionsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_network_id<'life0, 'async_trait>(
        &'life0 self,
        params: GetNetworkIdParams,
    ) -> Pin<Box<dyn Future<Output = Result<NetworkIdResponse, Error<GetNetworkIdError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_network_ids<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkIdResponse>, Error<GetNetworkIdsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn get_routing_policy_asset_groups<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Error<GetRoutingPolicyAssetGroupsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn search_network_ids<'life0, 'async_trait>(
        &'life0 self,
        params: SearchNetworkIdsParams,
    ) -> Pin<Box<dyn Future<Output = Result<SearchNetworkIdsResponse, Error<SearchNetworkIdsError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_network_id_discoverability<'life0, 'async_trait>(
        &'life0 self,
        params: SetNetworkIdDiscoverabilityParams,
    ) -> Pin<Box<dyn Future<Output = Result<SetNetworkIdResponse, Error<SetNetworkIdDiscoverabilityError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_network_id_name<'life0, 'async_trait>(
        &'life0 self,
        params: SetNetworkIdNameParams,
    ) -> Pin<Box<dyn Future<Output = Result<SetNetworkIdResponse, Error<SetNetworkIdNameError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_network_id_routing_policy<'life0, 'async_trait>(
        &'life0 self,
        params: SetNetworkIdRoutingPolicyParams,
    ) -> Pin<Box<dyn Future<Output = Result<SetNetworkIdResponse, Error<SetNetworkIdRoutingPolicyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn set_routing_policy<'life0, 'async_trait>(
        &'life0 self,
        params: SetRoutingPolicyParams,
    ) -> Pin<Box<dyn Future<Output = Result<SetRoutingPolicyResponse, Error<SetRoutingPolicyError>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;

}

Required Methods§

Source

fn check_third_party_routing<'life0, 'async_trait>( &'life0 self, params: CheckThirdPartyRoutingParams, ) -> Pin<Box<dyn Future<Output = Result<ThirdPartyRouting, Error<CheckThirdPartyRoutingError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_connections/{connectionId}/is_third_party_routing/ {assetType}

The Fireblocks Network allows for flexibility around incoming deposits. A receiver can receive network deposits to locations other than Fireblocks. This endpoint validates whether future transactions are routed to the displayed recipient or to a 3rd party.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn create_network_connection<'life0, 'async_trait>( &'life0 self, params: CreateNetworkConnectionParams, ) -> Pin<Box<dyn Future<Output = Result<NetworkConnectionResponse, Error<CreateNetworkConnectionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /network_connections

Initiates a new network connection. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Supported asset groups for routing policy can be found at /network_ids/routing_policy_asset_groups Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT). Learn more about Fireblocks Network in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn create_network_id<'life0, 'async_trait>( &'life0 self, params: CreateNetworkIdParams, ) -> Pin<Box<dyn Future<Output = Result<NetworkIdResponse, Error<CreateNetworkIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

POST /network_ids

Creates a new Network ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Supported asset groups for routing policy can be found at /network_ids/routing_policy_asset_groups Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn delete_network_connection<'life0, 'async_trait>( &'life0 self, params: DeleteNetworkConnectionParams, ) -> Pin<Box<dyn Future<Output = Result<DeleteNetworkConnectionResponse, Error<DeleteNetworkConnectionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

DELETE /network_connections/{connectionId}

Deletes an existing network connection specified by its connection ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail.

  • Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
  • Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
    Endpoint Permission: Admin, Non-Signing Admin.
Source

fn delete_network_id<'life0, 'async_trait>( &'life0 self, params: DeleteNetworkIdParams, ) -> Pin<Box<dyn Future<Output = Result<DeleteNetworkIdResponse, Error<DeleteNetworkIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

DELETE /network_ids/{networkId}

Deletes a network by its ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_network<'life0, 'async_trait>( &'life0 self, params: GetNetworkParams, ) -> Pin<Box<dyn Future<Output = Result<NetworkConnectionResponse, Error<GetNetworkError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_connections/{connectionId}

Gets a network connection by ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_network_connections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkConnectionResponse>, Error<GetNetworkConnectionsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_connections

Returns all network connections. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default - Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_network_id<'life0, 'async_trait>( &'life0 self, params: GetNetworkIdParams, ) -> Pin<Box<dyn Future<Output = Result<NetworkIdResponse, Error<GetNetworkIdError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_ids/{networkId}

Retrieves a network by its ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn get_network_ids<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<NetworkIdResponse>, Error<GetNetworkIdsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_ids

Retrieves a list of all local and discoverable remote network IDs. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail.

  • Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
  • Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
    Endpoint Permission: Admin, Non-Signing Admin.
Source

fn get_routing_policy_asset_groups<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, Error<GetRoutingPolicyAssetGroupsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_ids/routing_policy_asset_groups

Retrieves a list of all enabled routing policy asset groups. Your routing policy defines how your transactions are routed. You can use one or more enabled routing policy asset groups to describe connection or network id routing policy.
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn search_network_ids<'life0, 'async_trait>( &'life0 self, params: SearchNetworkIdsParams, ) -> Pin<Box<dyn Future<Output = Result<SearchNetworkIdsResponse, Error<SearchNetworkIdsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

GET /network_ids/search

Retrieves a list of all local and discoverable remote network IDs. Can be filtered. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None

  • Network Connection Crypto → Default - Network Connection FIAT → Default - Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Source

fn set_network_id_discoverability<'life0, 'async_trait>( &'life0 self, params: SetNetworkIdDiscoverabilityParams, ) -> Pin<Box<dyn Future<Output = Result<SetNetworkIdResponse, Error<SetNetworkIdDiscoverabilityError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /network_ids/{networkId}/set_discoverability

Update whether or not the network ID is discoverable by others. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail.

  • Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.
  • Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
    Endpoint Permission: Admin, Non-Signing Admin.
Source

fn set_network_id_name<'life0, 'async_trait>( &'life0 self, params: SetNetworkIdNameParams, ) -> Pin<Box<dyn Future<Output = Result<SetNetworkIdResponse, Error<SetNetworkIdNameError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /network_ids/{networkId}/set_name

Updates name of a specified network ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one. - Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
Endpoint Permission: Admin, Non-Signing Admin.

Source

fn set_network_id_routing_policy<'life0, 'async_trait>( &'life0 self, params: SetNetworkIdRoutingPolicyParams, ) -> Pin<Box<dyn Future<Output = Result<SetNetworkIdResponse, Error<SetNetworkIdRoutingPolicyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /network_ids/{networkId}/set_routing_policy

Updates the routing policy of a specified network ID. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.

  • Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Supported asset groups for routing policy can be found at /network_ids/routing_policy_asset_groups Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
    Endpoint Permission: Admin, Non-Signing Admin.
Source

fn set_routing_policy<'life0, 'async_trait>( &'life0 self, params: SetRoutingPolicyParams, ) -> Pin<Box<dyn Future<Output = Result<SetRoutingPolicyResponse, Error<SetRoutingPolicyError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

PATCH /network_connections/{connectionId}/set_routing_policy

Updates an existing network connection’s routing policy. Note: This API call is subject to Flexible Routing Schemes. Your routing policy defines how your transactions are routed. You can choose 1 of the 3 different schemes mentioned below for each asset type: - None; Defines the profile routing to no destination for that asset type. Incoming transactions to asset types routed to None will fail. - Custom; Route to an account that you choose. If you remove the account, incoming transactions will fail until you choose another one.

  • Default; Use the routing specified by the network profile the connection is connected to. This scheme is also referred to as "Profile Routing" Default Workspace Presets: - Network Profile Crypto → Custom - Network Profile FIAT → None - Network Connection Crypto → Default - Network Connection FIAT → Default Supported asset groups for routing policy can be found at /network_ids/routing_policy_asset_groups Note: By default, Custom routing scheme uses (dstId = 0, dstType = VAULT).
    Endpoint Permission: Admin, Non-Signing Admin.

Implementors§