Michelson REPL

Builtin interpreter

class pytezos.repl.interpreter.Interpreter(debug=True)

Michelson interpreter reimplemented in Python. Based on the following reference: https://michelson.nomadic-labs.com/

execute(code)

Execute Michelson instructions (note that stack is not cleared after execution).

Parameters

code – Michelson source (any valid Michelson expression or special helpers)

Returns

{“success”: True|False, “stdout”: “”, “stderr”: {}, “result”: {“value”: “”, …}}

Extendable parser

exception pytezos.repl.parser.MichelsonRuntimeError(message, trace, data)

classmethod init(message, prim, data=None)

classmethod wrap(error: pytezos.repl.parser.MichelsonRuntimeError, prim)

exception pytezos.repl.parser.MichelsonTypeCheckError(message, trace, data)

class pytezos.repl.parser.Unit

pytezos.repl.parser.assert_big_map_val(type_expr)

pytezos.repl.parser.assert_comparable(type_expr)

pytezos.repl.parser.assert_expr_equal(expected, actual)

pytezos.repl.parser.assert_no_field_annots(annots)

pytezos.repl.parser.assert_pushable(type_expr)

pytezos.repl.parser.assert_single_type_annot(annots)

pytezos.repl.parser.assert_single_var_annot(annots)

pytezos.repl.parser.assert_type(value, exp_type)

pytezos.repl.parser.dispatch_core_map(val_expr, mapping: dict)

pytezos.repl.parser.dispatch_prim_map(val_expr, mapping: dict)

pytezos.repl.parser.expr_equal(a, b)

pytezos.repl.parser.get_bool(val_expr)

pytezos.repl.parser.get_bytes(val_expr)

pytezos.repl.parser.get_core_val(val_expr, core_type)

pytezos.repl.parser.get_entry_expr(type_expr, field_annot)

pytezos.repl.parser.get_int(val_expr)

pytezos.repl.parser.get_prim_args(val_expr, prim, args_len: int)

pytezos.repl.parser.get_string(val_expr)

pytezos.repl.parser.get_type_annots(type_expr: dict) → list

pytezos.repl.parser.is_big_map_val(type_expr)

pytezos.repl.parser.is_comparable(type_expr)

pytezos.repl.parser.is_pushable(type_expr)

pytezos.repl.parser.parse_address(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_big_map(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_bool(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_bytes(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_chain_id(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_contract(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_core_expr(expr) → tuple

pytezos.repl.parser.parse_elt(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_expression(val_expr, type_expr, selector=<function val_selector>, type_path='0')

Run an extensible parser for Micheline expressions. This function will just do the type checking for you, if you want to build a response you’d need to define a selector.

Parameters

• val_expr – value expression (Micheline)

• type_expr – corresponding type expression (Micheline)

• selector – function selector(val_expr, type_expr, val, type_path). Default selector (val_selector) converts Micheline to Python objects

• type_path – starting binary path (default is ‘0’)

pytezos.repl.parser.parse_int(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_key(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_key_hash(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_lambda(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_list(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_map(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_mutez(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_nat(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_operation(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_option(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_or(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_pair(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_prim_expr(expr) → tuple

pytezos.repl.parser.parse_set(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_signature(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_string(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_timestamp(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.parse_type(type_expr) → Tuple[str, list, Callable]

pytezos.repl.parser.parse_unit(val_expr, type_expr, selector, type_path)

pytezos.repl.parser.primitive(prim, args_len=0)

pytezos.repl.parser.remove_field_annots(type_expr)

pytezos.repl.parser.restore_entry_expr(val_expr, type_expr, field_annot)

pytezos.repl.parser.val_selector(val_expr, type_expr, val, type_path)

Interpreter context

class pytezos.repl.context.Context

begin(prim=None)

drop_all()

dump(count: int)

end()

get(key, default=None)

peek()

pop(count: int) → List[pytezos.repl.types.StackItem]

pop1()

pop2()

pop3()

print(message)

printf(template: str)

protect(count: int)

push(item: pytezos.repl.types.StackItem, annots=None, move=False)

reset()

restore(count: int)

set(key, value)

spawn(stack)

unset(key)

class pytezos.repl.context.DummyGen

get_fresh_address()

Michelson type system

class pytezos.repl.types.Address(val='', val_expr=None, type_expr=None, **kwargs)

classmethod new(address)

prim = 'address'

class pytezos.repl.types.BigMap(val, val_expr, type_expr, **kwargs)

assert_key_type(item: pytezos.repl.types.StackItem)

assert_val_type(item: pytezos.repl.types.StackItem)

find(key: pytezos.repl.types.StackItem) → pytezos.repl.types.StackItem

prim = 'big_map'

remove(key: pytezos.repl.types.StackItem) → pytezos.repl.types.BigMap

update(key: pytezos.repl.types.StackItem, value: pytezos.repl.types.StackItem) → pytezos.repl.types.BigMap

val_type_expr()

class pytezos.repl.types.Bool(val=False, val_expr=None, type_expr=None, **kwargs)

prim = 'bool'

class pytezos.repl.types.Bytes(val=b'', type_expr=None, val_expr=None, **kwargs)

prim = 'bytes'

class pytezos.repl.types.ChainID(val, val_expr=None, type_expr=None, **kwargs)

prim = 'chain_id'

class pytezos.repl.types.Contract(val, val_expr, type_expr, **kwargs)

assert_param_type(item: pytezos.repl.types.StackItem)

get_address()

get_entrypoint()

classmethod new(contract, type_expr)

prim = 'contract'

class pytezos.repl.types.Int(val=0, val_expr=None, type_expr=None, **kwargs)

prim = 'int'

class pytezos.repl.types.Key(val, val_expr, type_expr, **kwargs)

prim = 'key'

class pytezos.repl.types.KeyHash(val='', val_expr=None, type_expr=None, **kwargs)

classmethod new(key_hash)

prim = 'key_hash'

class pytezos.repl.types.Lambda(val, val_expr, type_expr, **kwargs)

assert_param_type(item: pytezos.repl.types.StackItem)

assert_ret_type(item: pytezos.repl.types.StackItem)

property code

classmethod new(p_type_expr, r_type_expr, code)

partial_apply(item: pytezos.repl.types.StackItem)

prim = 'lambda'

class pytezos.repl.types.List(val, val_expr, type_expr, **kwargs)

assert_val_type(item: pytezos.repl.types.StackItem)

cut_head()

classmethod empty(v_type_expr)

classmethod new(items: list)

prepend(item: pytezos.repl.types.StackItem) → pytezos.repl.types.List

prim = 'list'

val_type()

class pytezos.repl.types.Map(val, val_expr, type_expr, **kwargs)

assert_key_type(item: pytezos.repl.types.StackItem)

assert_val_type(item: pytezos.repl.types.StackItem)

classmethod empty(k_type_expr, v_type_expr)

find(key: pytezos.repl.types.StackItem) → pytezos.repl.types.StackItem

make_key(k_val_expr)

make_val(v_val_expr)

classmethod new(items: list)

prim = 'map'

remove(key: pytezos.repl.types.StackItem) → pytezos.repl.types.Map

update(key: pytezos.repl.types.StackItem, val: pytezos.repl.types.StackItem) → pytezos.repl.types.Map

val_type_expr()

class pytezos.repl.types.Mutez(val=0, val_expr=None, type_expr=None, **kwargs)

prim = 'mutez'

class pytezos.repl.types.Nat(val=0, val_expr=None, type_expr=None, **kwargs)

prim = 'nat'

class pytezos.repl.types.Operation(val, val_expr, type_expr, **kwargs)

property content

static format_content(content)

classmethod new(content)

prim = 'operation'

class pytezos.repl.types.Option(val, val_expr, type_expr, **kwargs)

get_some()

is_none()

classmethod none(type_expr)

prim = 'option'

classmethod some(item: pytezos.repl.types.StackItem)

class pytezos.repl.types.Or(val, val_expr, type_expr, **kwargs)

get_some()

is_left()

classmethod left(r_type_expr, item: pytezos.repl.types.StackItem)

prim = 'or'

classmethod right(l_type_expr, item: pytezos.repl.types.StackItem)

class pytezos.repl.types.Pair(val, val_expr, type_expr, **kwargs)

get_element(idx: int)

classmethod new(left: pytezos.repl.types.StackItem, right: pytezos.repl.types.StackItem)

prim = 'pair'

class pytezos.repl.types.Set(val, val_expr, type_expr, **kwargs)

add(item: pytezos.repl.types.StackItem) → pytezos.repl.types.Set

assert_key_type(item: pytezos.repl.types.StackItem)

classmethod empty(k_type_expr)

classmethod new(items: list)

prim = 'set'

remove(item: pytezos.repl.types.StackItem) → pytezos.repl.types.Set

class pytezos.repl.types.Signature(val, val_expr, type_expr, **kwargs)

prim = 'signature'

class pytezos.repl.types.StackItem(val, val_expr, type_expr, **kwargs)

classmethod init(val_expr, type_expr, **kwargs)

static parse(val_expr, type_expr, **kwargs)

prim = ''

rename(annots: list)

class pytezos.repl.types.String(val='', val_expr=None, type_expr=None, **kwargs)

prim = 'string'

class pytezos.repl.types.Timestamp(val=0, val_expr=None, type_expr=None, **kwargs)

prim = 'timestamp'

class pytezos.repl.types.Unit(val=Unit, val_expr=None, type_expr=None, **kwargs)

prim = 'unit'

pytezos.repl.types.assert_equal_types(a, b)

pytezos.repl.types.assert_stack_item(item: pytezos.repl.types.StackItem)

pytezos.repl.types.assert_stack_type(item: pytezos.repl.types.StackItem, item_type)

pytezos.repl.types.dispatch_type_map(a, b, mapping)

pytezos.repl.types.get_name(annots: list, prefix, default=None)

Big_map abstraction

class pytezos.repl.big_map.BigMapPool

commit(big_map_diff: list)

contains(big_map: pytezos.repl.types.BigMap, key: pytezos.repl.types.StackItem) → bool

diff(storage: pytezos.repl.types.StackItem)

empty(k_type_expr, v_type_expr) → pytezos.repl.types.BigMap

find(big_map: pytezos.repl.types.BigMap, key: pytezos.repl.types.StackItem) → pytezos.repl.types.StackItem

pre_alloc(val_expr, type_expr, copy=False, network=None)

reset()

pytezos.repl.big_map.elt_to_update(elt, type_expr, big_map_id)

pytezos.repl.big_map.make_elt(args)

PyTezos helpers

pytezos.repl.helpers.do_begin(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_big_map_diff(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_commit(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_debug(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_drop_all(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_dump(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_dump_all(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_expand(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_include(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_patch(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_print(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_reset(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_reset_none(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_run(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.do_unset(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.helpers.is_prim(val_expr, prim)

Arithmetic operations

pytezos.repl.arithmetic.do_abs(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_add(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_and(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_blake2b(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_check_sig(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_compare(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_ediv(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_eq(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_hash_key(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_int(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_is_nat(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_lsl(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_mul(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_neg(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_not(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_or_xor(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_sha(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.arithmetic.do_sub(ctx: pytezos.repl.context.Context, prim, args, annots)

Blockchain-specific operations

pytezos.repl.blockchain.check_contract(ctx: pytezos.repl.context.Context, address, entry_annot, type_expr)

pytezos.repl.blockchain.decrease_balance(ctx: pytezos.repl.context.Context, amount: pytezos.repl.types.Mutez)

pytezos.repl.blockchain.do_address(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_amount(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_balance(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_chain_id(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_contract(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_create_contract(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_implicit_account(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_now(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_parameter(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_self(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_sender(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_set_delegate(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_source(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_transfer_tokens(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.get_balance(ctx: pytezos.repl.context.Context)

Control flow operators

pytezos.repl.blockchain.check_contract(ctx: pytezos.repl.context.Context, address, entry_annot, type_expr)

pytezos.repl.blockchain.decrease_balance(ctx: pytezos.repl.context.Context, amount: pytezos.repl.types.Mutez)

pytezos.repl.blockchain.do_address(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_amount(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_balance(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_chain_id(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_contract(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_create_contract(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_implicit_account(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_now(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_parameter(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_self(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_sender(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_set_delegate(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_source(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.do_transfer_tokens(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.blockchain.get_balance(ctx: pytezos.repl.context.Context)

Operations with structures

pytezos.repl.structures.do_car(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_concat(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_cons(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_empty_big_map(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_empty_map(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_empty_set(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_get(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_left(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_mem(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_nil(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_none(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_pack(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_pair(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_size(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_slice(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_some(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_unit(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_unpack(ctx: pytezos.repl.context.Context, prim, args, annots)

pytezos.repl.structures.do_update(ctx: pytezos.repl.context.Context, prim, args, annots)