package

neo3.api.helpers

module

neo3.api.helpers.signing

Signing functions for use with ChainFacade.invoke.

Classes

• SigningDetails — SigningDetails(network: int)

Functions

• sign_insecure_with_account(acc, password) (Callable) — Sign and add a witness using the account and the provided account password.
• sign_insecure_with_multisig_account(acc, password) (Callable) — Sign and add a multi-signature witness.
• sign_secure_with_account(acc, env_password_name) (Callable) — Sign and add a witness using the account. The account password is read from the environment variables.

module

neo3.api.helpers.stdlib

This module holds helper functions for data that has been serialized using the StdLib native contract

Classes

• PlaceHolder — PlaceHolder(type, count)

Functions

• binary_deserialize(data) — Deserialize data that has been serialized using StdLib.serialize()

module

neo3.api.helpers.txbuilder

Builder for creating a Transaction. Calculate fees, add signers and sign.

Classes

• TxBuilder — Transaction builder.

module

neo3.api.helpers.unwrap

Helper functions to easily fetch native values from the ResultStack returned as response by various RPC methodssuch as invoke_function(), invoke_script(), get_application_log_transaction() and get_application_log_block().

Includes sanity checking.

Functions

• as_address(res, idx) (str) — Convert the stack item at idx to a NEO3 address.
• as_bool(res, idx) (bool) — Convert the stack item at idx to a bool.
• as_bytes(res, idx) (bytes) — Convert the stack item at idx to bytes.
• as_dict(res, idx) (dict) — Convert the stack item at idx to a dictionary.
• as_int(res, idx) (int) — Convert the stack item at idx to an int.
• as_list(res, idx) (list) — Convert the stack item at idx to a list.
• as_none(res, idx) — Convert the stack item at idx to None.
• as_public_key(res, idx) (ECPoint) — Convert the stack item at idx to a public key.
• as_str(res, idx) (str) — Convert the stack item at idx to a str.
• as_uint160(res, idx) (UInt160) — Convert the stack item at idx to an UInt160.
• as_uint256(res, idx) (UInt256) — Convert the stack item at idx to an UInt256.
• check_state_ok(res) — Check if the execution of the transaction finished in a success state.
• item(res, idx) (StackItem) — Fetch the stack item at idx from the result stack. Performs basic validation and bounds checking.