Skip to main content

iota_sdk.client._high_level_api

HighLevelAPI Objects​

class HighLevelAPI()

get_outputs​

def get_outputs(output_ids: List[OutputId])

Fetch OutputResponse from provided OutputIds (requests are sent in parallel).

get_outputs_ignore_errors​

def get_outputs_ignore_errors(output_ids: List[OutputId])

Try to get OutputResponse from provided OutputIds. Requests are sent in parallel and errors are ignored, can be useful for spent outputs.

find_blocks​

def find_blocks(block_ids: List[HexStr])

Find all blocks by provided block IDs.

retry​

def retry(block_id: HexStr)

Retries (promotes or reattaches) a block for provided block id. Block should only be retried only if they are valid and haven't been confirmed for a while.

retry_until_included​

def retry_until_included(block_id: HexStr,
                         interval: Optional[int] = None,
                         max_attempts: Optional[int] = None)

Retries (promotes or reattaches) a block for provided block id until it's included (referenced by a milestone). Default interval is 5 seconds and max attempts is 40. Returns the included block at first position and additional reattached blocks.

consolidate_funds​

def consolidate_funds(secret_manager, generate_addresses_options)

Function to consolidate all funds from a range of addresses to the address with the lowest index in that range Returns the address to which the funds got consolidated, if any were available.

find_inputs​

def find_inputs(addresses: List[str], amount: int)

Function to find inputs from addresses for a provided amount (useful for offline signing)

find_outputs​

def find_outputs(output_ids: List[OutputId], addresses: List[str])

Find all outputs based on the requests criteria. This method will try to query multiple nodes if the request amount exceeds individual node limit.

reattach​

def reattach(block_id: HexStr)

Reattaches blocks for provided block id. Blocks can be reattached only if they are valid and haven't been confirmed for a while.

reattach_unchecked​

def reattach_unchecked(block_id: HexStr)

Reattach a block without checking if it should be reattached.

promote​

def promote(block_id: HexStr)

Promotes a block. The method should validate if a promotion is necessary through get_block. If not, the method should error out and should not allow unnecessary promotions.

promote_unchecked​

def promote_unchecked(block_id: HexStr)

Promote a block without checking if it should be promoted.