multiversx_sdk.abi package

Submodules

multiversx_sdk.abi.abi module

class multiversx_sdk.abi.abi.Abi(definition: AbiDefinition)

Bases: object

decode_endpoint_output_parameters(endpoint_name: str, encoded_values: list[bytes]) → list[Any]

decode_event(event_name: str, topics: list[bytes], additional_data: list[bytes]) → SimpleNamespace

encode_constructor_input_parameters(values: list[Any]) → list[bytes]

encode_endpoint_input_parameters(endpoint_name: str, values: list[Any]) → list[bytes]

encode_upgrade_constructor_input_parameters(values: list[Any]) → list[bytes]

classmethod load(path: Path) → Abi

class multiversx_sdk.abi.abi.EndpointPrototype(input_parameters: list[Any], output_parameters: list[Any])

Bases: object

class multiversx_sdk.abi.abi.EventField(name: str, value: Any)

Bases: object

class multiversx_sdk.abi.abi.EventPrototype(fields: list[EventField])

Bases: object

multiversx_sdk.abi.abi_definition module

class multiversx_sdk.abi.abi_definition.AbiDefinition(constructor: EndpointDefinition, upgrade_constructor: EndpointDefinition, endpoints: list[EndpointDefinition], types: TypesDefinitions, events: list[EventDefinition])

Bases: object

classmethod from_dict(data: dict[str, Any]) → AbiDefinition

get_event_definition(name: str) → EventDefinition

classmethod load(path: Path) → AbiDefinition

class multiversx_sdk.abi.abi_definition.EndpointDefinition(name: str, docs: str, mutability: str, inputs: list[ParameterDefinition], outputs: list[ParameterDefinition], payable_in_tokens: list[str], only_owner: bool, title: str = '')

Bases: object

classmethod from_dict(data: dict[str, Any]) → EndpointDefinition

class multiversx_sdk.abi.abi_definition.EnumDefinition(name: str, variants: list[EnumVariantDefinition])

Bases: object

classmethod from_dict(name: str, data: dict[str, Any]) → EnumDefinition

class multiversx_sdk.abi.abi_definition.EnumVariantDefinition(name: str, discriminant: int, fields: list[FieldDefinition])

Bases: object

classmethod from_dict(data: dict[str, Any]) → EnumVariantDefinition

class multiversx_sdk.abi.abi_definition.EventDefinition(identifier: str, inputs: list[EventTopicDefinition])

Bases: object

classmethod from_dict(data: dict[str, Any]) → EventDefinition

class multiversx_sdk.abi.abi_definition.EventTopicDefinition(name: str, type: str, indexed: bool)

Bases: object

classmethod from_dict(data: dict[str, Any]) → EventTopicDefinition

class multiversx_sdk.abi.abi_definition.ExplicitEnumDefinition(name: str, variants: list[ExplicitEnumVariantDefinition])

Bases: object

classmethod from_dict(name: str, data: dict[str, Any]) → ExplicitEnumDefinition

class multiversx_sdk.abi.abi_definition.ExplicitEnumVariantDefinition(name: str)

Bases: object

classmethod from_dict(data: dict[str, Any]) → ExplicitEnumVariantDefinition

class multiversx_sdk.abi.abi_definition.FieldDefinition(name: str, description: str, type: str)

Bases: object

classmethod from_dict(data: dict[str, Any]) → FieldDefinition

class multiversx_sdk.abi.abi_definition.NullEndpointDefinition

Bases: EndpointDefinition

class multiversx_sdk.abi.abi_definition.ParameterDefinition(name: str, type: str)

Bases: object

classmethod from_dict(data: dict[str, Any]) → ParameterDefinition

class multiversx_sdk.abi.abi_definition.StructDefinition(name: str, fields: list[FieldDefinition])

Bases: object

classmethod from_dict(name: str, data: dict[str, Any]) → StructDefinition

class multiversx_sdk.abi.abi_definition.TypesDefinitions(enums: list[EnumDefinition], explicit_enums: list[ExplicitEnumDefinition], structs: list[StructDefinition])

Bases: object

classmethod from_dict(data: dict[str, Any]) → TypesDefinitions

multiversx_sdk.abi.address_value module

class multiversx_sdk.abi.address_value.AddressValue(value: bytes = b'')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

classmethod new_from_address(address: IAddress) → AddressValue

set_payload(value: Any)

class multiversx_sdk.abi.address_value.IAddress(*args, **kwargs)

Bases: Protocol

For internal use only.

get_public_key() → bytes

multiversx_sdk.abi.array_value module

class multiversx_sdk.abi.array_value.ArrayValue(length: int, items: list[ISingleValue] | None = None, item_creator: Callable[[], ISingleValue] | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

guard_length(items: list[ISingleValue])

set_payload(value: Any)

multiversx_sdk.abi.bigint_value module

class multiversx_sdk.abi.bigint_value.BigIntValue(value: int = 0)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.biguint_value module

class multiversx_sdk.abi.biguint_value.BigUIntValue(value: int = 0)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.bool_value module

class multiversx_sdk.abi.bool_value.BoolValue(value: bool = False)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.bytes_value module

class multiversx_sdk.abi.bytes_value.BytesValue(value: bytes = b'')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.code_metadata_value module

class multiversx_sdk.abi.code_metadata_value.CodeMetadataValue(value: bytes = b'')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

classmethod new_from_code_metadata(code_metadata: CodeMetadata) → CodeMetadataValue

set_payload(value: Any)

multiversx_sdk.abi.codec module

class multiversx_sdk.abi.codec.Codec

Bases: object

decode_nested(data: bytes, value: ISingleValue) → None

decode_top_level(data: bytes, value: ISingleValue) → None

encode_nested(value: ISingleValue) → bytes

encode_top_level(value: ISingleValue) → bytes

multiversx_sdk.abi.counted_variadic_values module

class multiversx_sdk.abi.counted_variadic_values.CountedVariadicValues(items: list[ISingleValue | MultiValue] | None = None, item_creator: Callable[[], ISingleValue | MultiValue] | None = None)

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.enum_value module

class multiversx_sdk.abi.enum_value.EnumValue(discriminant: int = 0, fields: list[Field] | None = None, fields_provider: Callable[[int], list[Field]] | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.explicit_enum_value module

class multiversx_sdk.abi.explicit_enum_value.ExplicitEnumValue(value: str = '')

Bases: StringValue

multiversx_sdk.abi.fields module

class multiversx_sdk.abi.fields.Field(name: str, value: ISingleValue)

Bases: object

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.fields.decode_fields_nested(fields: list[Field], reader: BytesIO)

multiversx_sdk.abi.fields.encode_fields_nested(fields: list[Field], writer: BytesIO)

multiversx_sdk.abi.fields.set_fields_from_dictionary(fields: list[Field], dictionary: dict[str, Any])

multiversx_sdk.abi.fields.set_fields_from_list(fields: list[Field], items: list[Any])

multiversx_sdk.abi.interface module

class multiversx_sdk.abi.interface.IPayloadHolder(*args, **kwargs)

Bases: Protocol

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.interface.ISingleValue(*args, **kwargs)

Bases: IPayloadHolder, Protocol

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

multiversx_sdk.abi.list_value module

class multiversx_sdk.abi.list_value.ListValue(items: list[ISingleValue] | None = None, item_creator: Callable[[], ISingleValue] | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.multi_value module

class multiversx_sdk.abi.multi_value.MultiValue(items: list[ISingleValue | MultiValue])

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.option_value module

class multiversx_sdk.abi.option_value.OptionValue(value: ISingleValue | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.optional_value module

class multiversx_sdk.abi.optional_value.OptionalValue(value: ISingleValue | MultiValue | None = None)

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.parts module

class multiversx_sdk.abi.parts.PartsHolder(parts: Sequence[bytes])

Bases: object

PartsHolder holds data parts (e.g. raw contract call arguments, raw contract return values). It allows one to easily construct parts (thus functioning as a builder of parts). It also allows one to focus on a specific part to read from (thus functioning as a reader of parts: think of a pick-up head). Both functionalities (building and reading) are kept within this single abstraction, for convenience.

Creates a new PartsHolder, which has the given parts. Focus is on the first part, if any, or “beyond the last part” otherwise.

append_empty_part()

append_to_last_part(data: bytes)

focus_on_next_part()

Focuses on the next part, if any. Otherwise, it returns an error.

get_num_parts() → int

get_part(index: int) → bytes

get_parts() → list[bytes]

has_any_part() → bool

is_focused_beyond_last_part()

Returns true if the focus is already beyond the last part.

read_whole_focused_part()

Reads the whole focused part, if any. Otherwise, it returns an error.

multiversx_sdk.abi.serializer module

class multiversx_sdk.abi.serializer.Serializer(parts_separator: str = '@')

Bases: object

The serializer follows the rules of the MultiversX Serialization format: https://docs.multiversx.com/developers/data/serialization-overview

deserialize(data: str, output_values: Sequence[Any])

deserialize_parts(parts: Sequence[bytes], output_values: Sequence[Any])

serialize(input_values: Sequence[Any]) → str

serialize_to_parts(input_values: Sequence[Any]) → list[bytes]

multiversx_sdk.abi.shared module

multiversx_sdk.abi.shared.convert_native_value_to_dictionary(obj: Any, raise_on_failure: bool = True) → Tuple[dict[str, Any], bool]

multiversx_sdk.abi.shared.convert_native_value_to_list(obj: Any, raise_on_failure: bool = True) → Tuple[list[Any], bool]

multiversx_sdk.abi.shared.decode_length(reader: BytesIO) → int

multiversx_sdk.abi.shared.encode_length(writer: BytesIO, length: int)

multiversx_sdk.abi.shared.read_bytes_exactly(reader: BytesIO, num_bytes: int)

multiversx_sdk.abi.small_int_values module

class multiversx_sdk.abi.small_int_values.I16Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.small_int_values.I32Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.small_int_values.I64Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.small_int_values.I8Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.small_int_values.SmallIntValue(num_bytes: int, value: int = 0)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.small_int_values.SmallUIntValue(num_bytes: int, value: int = 0)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.small_int_values.U16Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.small_int_values.U32Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.small_int_values.U64Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.small_int_values.U8Value(value: int = 0)

Bases: SmallUIntValue

multiversx_sdk.abi.string_value module

class multiversx_sdk.abi.string_value.StringValue(value: str = '')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.struct_value module

class multiversx_sdk.abi.struct_value.StructValue(fields: list[Field])

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.token_identifier_value module

class multiversx_sdk.abi.token_identifier_value.TokenIdentifierValue(value: str = '')

Bases: StringValue

multiversx_sdk.abi.tuple_value module

class multiversx_sdk.abi.tuple_value.TupleValue(fields: list[ISingleValue])

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

multiversx_sdk.abi.type_formula module

class multiversx_sdk.abi.type_formula.TypeFormula(name: str, type_parameters: list[TypeFormula])

Bases: object

multiversx_sdk.abi.type_formula_parser module

class multiversx_sdk.abi.type_formula_parser.TypeFormulaParser

Bases: object

BEGIN_TYPE_PARAMETERS = '<'

COMMA = ','

END_TYPE_PARAMETERS = '>'

PUNCTUATION = [',', '<', '>']

acquire_type_parameters(stack: list[Any]) → list[TypeFormula]

acquire_type_with_parameters(stack: list[Any]) → TypeFormula

is_beginning_of_type_parameters(token: str) → bool

is_end_of_type_parameters(token: str) → bool

is_punctuation(token: str) → bool

parse_expression(expression: str) → TypeFormula

tokenize_expression(expression: str) → list[str]

multiversx_sdk.abi.typesystem module

multiversx_sdk.abi.typesystem.is_bytes(value: Any) → bool

multiversx_sdk.abi.typesystem.is_list_of_bytes(values: Sequence[Any]) → bool

multiversx_sdk.abi.typesystem.is_list_of_typed_values(values: Sequence[Any]) → bool

multiversx_sdk.abi.typesystem.is_multi_value(value: Any) → bool

multiversx_sdk.abi.typesystem.is_single_value(value: Any) → bool

multiversx_sdk.abi.typesystem.is_typed_value(value: Any) → bool

multiversx_sdk.abi.variadic_values module

class multiversx_sdk.abi.variadic_values.VariadicValues(items: list[ISingleValue | MultiValue] | None = None, item_creator: Callable[[], ISingleValue | MultiValue] | None = None)

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)

Module contents

class multiversx_sdk.abi.Abi(definition: AbiDefinition)

Bases: object

decode_endpoint_output_parameters(endpoint_name: str, encoded_values: list[bytes]) → list[Any]

decode_event(event_name: str, topics: list[bytes], additional_data: list[bytes]) → SimpleNamespace

encode_constructor_input_parameters(values: list[Any]) → list[bytes]

encode_endpoint_input_parameters(endpoint_name: str, values: list[Any]) → list[bytes]

encode_upgrade_constructor_input_parameters(values: list[Any]) → list[bytes]

classmethod load(path: Path) → Abi

class multiversx_sdk.abi.AbiDefinition(constructor: EndpointDefinition, upgrade_constructor: EndpointDefinition, endpoints: list[EndpointDefinition], types: TypesDefinitions, events: list[EventDefinition])

Bases: object

classmethod from_dict(data: dict[str, Any]) → AbiDefinition

get_event_definition(name: str) → EventDefinition

classmethod load(path: Path) → AbiDefinition

class multiversx_sdk.abi.AddressValue(value: bytes = b'')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

classmethod new_from_address(address: IAddress) → AddressValue

set_payload(value: Any)

class multiversx_sdk.abi.ArrayValue(length: int, items: list[ISingleValue] | None = None, item_creator: Callable[[], ISingleValue] | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

guard_length(items: list[ISingleValue])

set_payload(value: Any)

class multiversx_sdk.abi.BigIntValue(value: int = 0)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.BigUIntValue(value: int = 0)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.BoolValue(value: bool = False)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.BytesValue(value: bytes = b'')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.CodeMetadataValue(value: bytes = b'')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

classmethod new_from_code_metadata(code_metadata: CodeMetadata) → CodeMetadataValue

set_payload(value: Any)

class multiversx_sdk.abi.EnumValue(discriminant: int = 0, fields: list[Field] | None = None, fields_provider: Callable[[int], list[Field]] | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.ExplicitEnumValue(value: str = '')

Bases: StringValue

class multiversx_sdk.abi.Field(name: str, value: ISingleValue)

Bases: object

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.I16Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.I32Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.I64Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.I8Value(value: int = 0)

Bases: SmallIntValue

class multiversx_sdk.abi.ListValue(items: list[ISingleValue] | None = None, item_creator: Callable[[], ISingleValue] | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.MultiValue(items: list[ISingleValue | MultiValue])

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.OptionValue(value: ISingleValue | None = None)

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.OptionalValue(value: ISingleValue | MultiValue | None = None)

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.Serializer(parts_separator: str = '@')

Bases: object

The serializer follows the rules of the MultiversX Serialization format: https://docs.multiversx.com/developers/data/serialization-overview

deserialize(data: str, output_values: Sequence[Any])

deserialize_parts(parts: Sequence[bytes], output_values: Sequence[Any])

serialize(input_values: Sequence[Any]) → str

serialize_to_parts(input_values: Sequence[Any]) → list[bytes]

class multiversx_sdk.abi.StringValue(value: str = '')

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.StructValue(fields: list[Field])

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.TokenIdentifierValue(value: str = '')

Bases: StringValue

class multiversx_sdk.abi.TupleValue(fields: list[ISingleValue])

Bases: object

decode_nested(reader: BytesIO)

decode_top_level(data: bytes)

encode_nested(writer: BytesIO)

encode_top_level(writer: BytesIO)

get_payload() → Any

set_payload(value: Any)

class multiversx_sdk.abi.U16Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.U32Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.U64Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.U8Value(value: int = 0)

Bases: SmallUIntValue

class multiversx_sdk.abi.VariadicValues(items: list[ISingleValue | MultiValue] | None = None, item_creator: Callable[[], ISingleValue | MultiValue] | None = None)

Bases: IPayloadHolder

get_payload() → Any

set_payload(value: Any)