Skip to main content

iota_client.client

IotaClient Objects​

class IotaClient(NodeCoreAPI, NodeIndexerAPI, HighLevelAPI, Utils)

__init__​

def __init__(client_config=None)

Initialize the IOTA Client.

build_alias_output​

def build_alias_output(alias_id,
                       unlock_conditions,
                       amount=None,
                       native_tokens=None,
                       state_index=None,
                       state_metadata=None,
                       foundry_counter=None,
                       features=None,
                       immutable_features=None)

Build an AliasOutput.

build_basic_output​

def build_basic_output(unlock_conditions,
                       amount=None,
                       native_tokens=None,
                       features=None)

Build a BasicOutput.

build_foundry_output​

def build_foundry_output(serial_number,
                         token_scheme,
                         unlock_conditions,
                         amount=None,
                         native_tokens=None,
                         features=None,
                         immutable_features=None)

Build a FoundryOutput.

build_nft_output​

def build_nft_output(nft_id,
                     unlock_conditions,
                     amount=None,
                     native_tokens=None,
                     features=None,
                     immutable_features=None)

Build an NftOutput.

generate_addresses​

def generate_addresses(secret_manager, options)

Generate addresses.

build_and_post_block​

def build_and_post_block(secret_manager=None, options=None)

Build and post a block.

get_node​

def get_node()

Get a node candidate from the healthy node pool.

get_network_info​

def get_network_info()

Gets the network related information such as network_id and min_pow_score.

get_network_id​

def get_network_id()

Gets the network id of the node we're connecting to.

get_bech32_hrp​

def get_bech32_hrp()

Returns the bech32_hrp.

get_min_pow_score​

def get_min_pow_score()

Returns the min pow score.

get_tips_interval​

def get_tips_interval()

Returns the tips interval.

get_local_pow​

def get_local_pow()

Returns if local pow should be used or not.

get_fall_back_to_local_pow​

def get_fall_back_to_local_pow()

Get fallback to local proof of work timeout.

unhealthy_nodes​

def unhealthy_nodes()

Returns the unhealthy nodes.

get_ledger_nano_status​

def get_ledger_nano_status(is_simulator)

Returns the Ledger Status.

prepare_transaction​

def prepare_transaction(secret_manager=None, options=None)

Prepare a transaction for signing.

sign_transaction​

def sign_transaction(secret_manager, prepared_transaction_data)

Sign a transaction.

store_mnemonic​

def store_mnemonic(secret_manager, mnemonic)

Store a mnemonic in the Stronghold vault.

submit_payload​

def submit_payload(payload_dto)

Submit a payload in a block.