genlayer package

Common import for all contracts

It exposes most of the types to the top scope and encapsulates other utility under gl namespace which is a proxy to genlayer.std

genlayer.gl

Blockchain specific functionality, that won’t work without GenVM

Proxy to genlayer.std

class genlayer.Address

Bases: object

Represents GenLayer Address

SIZE: Final[int] = 20

Constant that represents size of a Genlayer address

__init__(val: str | Buffer)

Parameters:

val (str | Buffer) – either a hex encoded address (that starts with ‘0x’), or base64 encoded address, or buffer of 20 bytes

Warning

checksum validation is not performed

property as_b64: str

>>> Address('0x5b38da6a701c568545dcfcb03fcb875f56beddc4').as_b64
'WzjaanAcVoVF3PywP8uHX1a+3cQ='

Returns:

base64 representation of an address (most compact string)

property as_bytes: bytes

>>> Address('0x5b38da6a701c568545dcfcb03fcb875f56beddc4').as_bytes
b'[8\xdajp\x1cV\x85E\xdc\xfc\xb0?\xcb\x87_V\xbe\xdd\xc4'

Returns:

raw bytes of an address (most compact representation)

property as_hex: str

>>> Address('0x5b38da6a701c568545dcfcb03fcb875f56beddc4').as_hex
'0x5B38Da6a701c568545dCfcB03FcB875f56beddC4'

Returns:

checksum string representation

property as_int: u160

>>> Address('0x5b38da6a701c568545dcfcb03fcb875f56beddc4').as_int
1123907236495940146162314350759402901750813440091
>>> hex(Address('0x5b38da6a701c568545dcfcb03fcb875f56beddc4').as_int)
'0xc4ddbe565f87cb3fb0fcdc4585561c706ada385b'

Returns:

int representation of an address (unsigned little endian)

class genlayer.Array

Bases: Sequence, SizedArray, Generic

Constantly sized array that can be persisted on the blockchain

__init__()

This class can’t be created with Array()

Raises:

TypeError – always

class genlayer.DynArray

Bases: MutableSequence, Generic

Represents exponentially growing array (list in python terms) that can be persisted on the blockchain

__init__()

This class can’t be created with DynArray()

Raises:

TypeError – always

append(value: T) → None

S.append(value) – append value to the end of the sequence

append_new_get() → T

Return type:

T

insert(index: int, value: T) → None

S.insert(index, value) – insert value before index

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

genlayer.Keccak256(initial_input: Buffer | None = None)

exception genlayer.Rollback

Bases: Exception

Exception that will be treated as a “Rollback”

__init__(msg: str)

class genlayer.TreeMap

Bases: MutableMapping, Generic

Represents a mapping from keys to values that can be persisted on the blockchain

K must implement genlayer.py.storage.tree_map.Comparable protocol (“<” and “=” are needed)

__init__()

This class can’t be created with TreeMap()

Raises:

TypeError – always

clear() → None.  Remove all items from D.

compute_if_absent(k: K, supplier: Callable[[], V]) → V

Returns:

Value associated with k if it is present, otherwise get’s new value from the supplier, stores it at k and returns

Return type:

V

get(k: K, default: G = None) → V | G

Returns:

Value associated with k or default if there is no such value

Return type:

V | G

get_or_insert_default(k: K) → V

Return type:

V

items() → a set-like object providing a view on D's items

Return type:

ItemsView

class genlayer.VecDB

Bases: Generic

Data structure that supports storing and querying vector data

There are two entities that can act as a key:

1. vector (can have duplicates)

2. id (int alias, can’t have duplicates)

Warning

import numpy before from genlayer import * if you wish to use VecDB!

Element = Element

Id = Id

get_by_id(id: Id) → VecDBElement[T, S, V, None]

Return type:

VecDBElement[T, S, V, None]

get_by_id_or_none(id: Id) → VecDBElement[T, S, V, None] | None

Return type:

VecDBElement[T, S, V, None] | None

insert(key: np.ndarray[tuple[S], np.dtype[T]], val: V) → Id

Return type:

Id

knn(v: np.ndarray[tuple[S], np.dtype[T]], k: int) → Iterator[VecDBElement[T, S, V, T]]

Return type:

Iterator[VecDBElement[T, S, V, T]]

genlayer.allow_storage(cls: T) → T

Return type:

T

Integer aliases

It also have aliases for signed and unsigned integer types (such as u256) and bigint alias that can be used in storage unlike regular int