SDK API Documentation

Note

Single text file docs for AI

Parts:

• Public API
  • Package genlayer
    • gl
    • Address
      • Address.SIZE
      • Address.__eq__()
      • Address.__format__()
      • Address.__ge__()
      • Address.__gt__()
      • Address.__hash__()
      • Address.__init__()
      • Address.__le__()
      • Address.__lt__()
      • Address.__repr__()
      • Address.__str__()
      • Address.as_b64
      • Address.as_bytes
      • Address.as_hex
      • Address.as_int
    • Array
      • Array.__getitem__()
      • Array.__init__()
      • Array.__iter__()
      • Array.__len__()
      • Array.__setitem__()
    • DynArray
      • DynArray.__delitem__()
      • DynArray.__getitem__()
      • DynArray.__init__()
      • DynArray.__iter__()
      • DynArray.__len__()
      • DynArray.__repr__()
      • DynArray.__setitem__()
      • DynArray.append()
      • DynArray.append_new_get()
      • DynArray.insert()
      • DynArray.pop()
    • Keccak256()
    • Rollback
      • Rollback.__init__()
    • TreeMap
      • TreeMap.__contains__()
      • TreeMap.__delitem__()
      • TreeMap.__getitem__()
      • TreeMap.__gl_allow_storage__
      • TreeMap.__iter__()
      • TreeMap.__len__()
      • TreeMap.__repr__()
      • TreeMap.__setitem__()
      • TreeMap.clear()
      • TreeMap.compute_if_absent()
      • TreeMap.get()
      • TreeMap.get_or_insert_default()
      • TreeMap.items()
    • allow_storage()
    • Integer aliases
  • Package genlayer.std
    • gl
      • Contract
        • Contract.__get_schema__()
        • Contract.__handle_undefined_method__()
        • Contract.__on_errored_message__()
        • Contract.__receive__()
        • Contract.address
        • Contract.balance
      • ContractAt
        • ContractAt.__init__()
        • ContractAt.address
        • ContractAt.balance
        • ContractAt.emit()
        • ContractAt.emit_transfer()
        • ContractAt.view()
      • Event
        • Event.__init__()
        • Event.emit()
        • Event.indexed
        • Event.name
        • Event.signature
      • Lazy
        • Lazy.__init__()
        • Lazy.get()
      • MessageRawType
        • MessageRawType.__optional_keys__
        • MessageRawType.__required_keys__
        • MessageRawType.__total__
        • MessageRawType.chain_id
        • MessageRawType.contract_address
        • MessageRawType.datetime
        • MessageRawType.entry_data
        • MessageRawType.entry_kind
        • MessageRawType.entry_stage_data
        • MessageRawType.is_init
        • MessageRawType.origin_address
        • MessageRawType.sender_address
        • MessageRawType.stack
        • MessageRawType.value
      • MessageType
        • MessageType.__getnewargs__()
        • MessageType.__new__()
        • MessageType.__repr__()
        • MessageType.chain_id
        • MessageType.contract_address
        • MessageType.origin_address
        • MessageType.sender_address
        • MessageType.value
      • contract_interface()
      • deploy_contract()
      • eq_principle_prompt_comparative()
      • eq_principle_prompt_non_comparative()
      • eq_principle_strict_eq()
      • eth_contract()
      • exec_prompt()
      • get_webpage()
      • message
      • message_raw
      • private()
      • public
        • public.view()
        • public.write
    • gl.calldata
      • CalldataEncodable
        • CalldataEncodable.__to_calldata__()
      • DecodingError
      • decode()
      • encode()
      • to_str()
    • gl.advanced
      • ContractError
        • ContractError.__eq__()
        • ContractError.__hash__
        • ContractError.__init__()
        • ContractError.__repr__()
        • ContractError.data
      • ContractReturn
        • ContractReturn.__eq__()
        • ContractReturn.__hash__
        • ContractReturn.__init__()
        • ContractReturn.__repr__()
        • ContractReturn.data
      • emit_raw_event()
      • run_nondet()
      • sandbox()
      • validator_handle_rollbacks_and_errors_default()
    • gl.eth
      • ContractDeclaration
        • ContractDeclaration.View
        • ContractDeclaration.Write
        • ContractDeclaration.__init__()
      • ContractProxy
        • ContractProxy.__init__()
        • ContractProxy.address
        • ContractProxy.balance
        • ContractProxy.emit()
        • ContractProxy.emit_transfer()
        • ContractProxy.view()
      • InplaceTuple
      • MethodEncoder
        • MethodEncoder.__init__()
        • MethodEncoder.decode_ret()
        • MethodEncoder.encode_call()
      • decode()
      • encode()
      • selector_of()
      • signature_of()
      • type_name_of()
    • gl.wasi
      • get_balance()
      • get_self_balance()
      • gl_call()
      • storage_read()
      • storage_write()
  • Package genlayer_embeddings
    • Model
      • Model.__call__()
      • Model.__init__()
    • SentenceTransformer()
    • VecDB
      • VecDB.Element
      • VecDB.Id
      • VecDB.__gl_allow_storage__
      • VecDB.__iter__()
      • VecDB.__len__()
      • VecDB.get_by_id()
      • VecDB.get_by_id_or_none()
      • VecDB.insert()
      • VecDB.knn()
• Internal packages
  • Package genlayer.py
  • Package genlayer.py._internal
  • Package genlayer.py._internal.event
    • Event
      • Event.__init__()
      • Event.emit()
      • Event.indexed
      • Event.name
      • Event.signature
  • Package genlayer.py._internal.reflect
  • Package genlayer.py.eth._internal.builder
  • Package genlayer.py.eth._internal.codecs
    • AddressCodec
    • ArrayCodec
      • ArrayCodec.__init__()
    • BoolCodec
    • BytesNCodec
      • BytesNCodec.__init__()
    • BytesStrCodec
      • BytesStrCodec.__init__()
    • Codec
      • Codec.__repr__()
    • DecoderState
      • DecoderState.__eq__()
      • DecoderState.__hash__
      • DecoderState.__init__()
      • DecoderState.__repr__()
    • DynArrayCodec
      • DynArrayCodec.__init__()
    • EncodeState
      • EncodeState.__eq__()
      • EncodeState.__hash__
      • EncodeState.__init__()
      • EncodeState.__repr__()
    • IntCodec
      • IntCodec.__init__()
    • TupleCodec
      • TupleCodec.__init__()
  • Package genlayer.py.eth._internal.type_dicts
  • Package genlayer.py.eth.calldata
    • signature_of()
  • Package genlayer.py.eth.generate
    • ContractDeclaration
      • ContractDeclaration.__init__()
    • ContractProxy
      • ContractProxy.__init__()
  • Package genlayer.py.eth.support
    • InplaceTuple
  • Package genlayer.py.get_schema
    • get_schema()
  • Package genlayer.py.keccak
    • Keccak256()
    • KeccakHash
      • KeccakHash.__init__()
      • KeccakHash.__repr__()
      • KeccakHash.preset()
  • Package genlayer.py.storage
    • Array
      • Array.__init__()
      • Array.count()
      • Array.index()
    • DynArray
      • DynArray.__init__()
      • DynArray.__repr__()
      • DynArray.append()
      • DynArray.clear()
      • DynArray.count()
      • DynArray.extend()
      • DynArray.index()
      • DynArray.insert()
      • DynArray.pop()
      • DynArray.remove()
      • DynArray.reverse()
    • Indirection
      • Indirection.__init__()
      • Indirection.slot()
    • Manager
      • Manager.__init__()
    • Root
      • Root.__init__()
      • Root.code
      • Root.locked_slots
    • TreeMap
      • TreeMap.__repr__()
      • TreeMap.clear()
      • TreeMap.compute_if_absent()
      • TreeMap.get()
      • TreeMap.items()
      • TreeMap.keys()
      • TreeMap.pop()
      • TreeMap.popitem()
      • TreeMap.setdefault()
      • TreeMap.update()
      • TreeMap.values()
    • VLA
  • Package genlayer.py.storage._internal
  • Package genlayer.py.storage._internal.core
    • ComplexCopyAction
      • ComplexCopyAction.__init__()
    • Indirection
      • Indirection.__init__()
      • Indirection.slot()
    • IndirectionTypeDesc
      • IndirectionTypeDesc.__init__()
      • IndirectionTypeDesc.set()
    • InmemManager
      • InmemManager.__init__()
    • InmemSlot
      • InmemSlot.__init__()
    • Manager
      • Manager.__init__()
    • PseudoSequence
      • PseudoSequence.__init__()
    • SpecialTypeDesc
      • SpecialTypeDesc.__eq__()
      • SpecialTypeDesc.__hash__()
      • SpecialTypeDesc.__init__()
      • SpecialTypeDesc.get()
    • TypeDesc
      • TypeDesc.__init__()
      • TypeDesc.__repr__()
      • TypeDesc.copy_actions
      • TypeDesc.get()
      • TypeDesc.set()
      • TypeDesc.size
    • VLA
    • VLATypeDesc
      • VLATypeDesc.__init__()
      • VLATypeDesc.set()
  • Package genlayer.py.storage._internal.desc_base_types
    • AddrDesc
      • AddrDesc.__init__()
      • AddrDesc.__repr__()
      • AddrDesc.get()
      • AddrDesc.set()
    • BoolDesc
      • BoolDesc.__init__()
      • BoolDesc.__repr__()
      • BoolDesc.get()
      • BoolDesc.set()
    • BytesDesc
      • BytesDesc.__init__()
      • BytesDesc.__repr__()
    • IntDesc
      • IntDesc.__eq__()
      • IntDesc.__hash__()
      • IntDesc.__init__()
      • IntDesc.__repr__()
      • IntDesc.get()
      • IntDesc.set()
    • NoneDesc
      • NoneDesc.__eq__()
      • NoneDesc.__hash__()
      • NoneDesc.__init__()
      • NoneDesc.__repr__()
      • NoneDesc.get()
      • NoneDesc.set()
    • StrDesc
      • StrDesc.__init__()
      • StrDesc.__repr__()
  • Package genlayer.py.storage._internal.desc_record
    • RecordExtraFields
  • Package genlayer.py.storage._internal.generate
  • Package genlayer.py.storage._internal.numpy
  • Package genlayer.py.storage.annotations
  • Package genlayer.py.storage.root
    • Root
      • Root.__init__()
      • Root.code
      • Root.locked_slots
  • Package genlayer.py.storage.tree_map
    • Comparable
      • Comparable.__init__()
      • Comparable.__lt__()
    • TreeMap
      • TreeMap.__repr__()
      • TreeMap.clear()
      • TreeMap.compute_if_absent()
      • TreeMap.get()
      • TreeMap.items()
  • Package genlayer.py.storage.vec
    • Array
      • Array.__init__()
    • DynArray
      • DynArray.__init__()
      • DynArray.__repr__()
      • DynArray.append()
      • DynArray.insert()
      • DynArray.pop()
  • Package genlayer.py.types
    • Address
      • Address.SIZE
      • Address.__eq__()
      • Address.__format__()
      • Address.__ge__()
      • Address.__gt__()
      • Address.__hash__()
      • Address.__init__()
      • Address.__le__()
      • Address.__lt__()
      • Address.__repr__()
      • Address.__str__()
      • Address.as_b64
      • Address.as_bytes
      • Address.as_hex
      • Address.as_int
    • Lazy
      • Lazy.__init__()
      • Lazy.get()
    • Rollback
      • Rollback.__init__()
    • SizedArray
      • SizedArray.__init__()
    • bigint
      • bigint.__supertype__
    • u256
      • u256.__supertype__
  • Package genlayer.std._internal
    • LazyApi
      • LazyApi.__call__()
      • LazyApi.__init__()
      • LazyApi.lazy()
  • Package genlayer.std._internal.gl_call
  • Package genlayer.std._internal.result_codes
    • EntryKind
      • EntryKind.__format__()
      • EntryKind.__new__()
      • EntryKind.as_integer_ratio()
      • EntryKind.bit_count()
      • EntryKind.bit_length()
      • EntryKind.conjugate()
      • EntryKind.denominator
      • EntryKind.from_bytes()
      • EntryKind.imag
      • EntryKind.is_integer()
      • EntryKind.numerator
      • EntryKind.real
      • EntryKind.to_bytes()
    • ResultCode
      • ResultCode.__format__()
      • ResultCode.__new__()
      • ResultCode.as_integer_ratio()
      • ResultCode.bit_count()
      • ResultCode.bit_length()
      • ResultCode.conjugate()
      • ResultCode.denominator
      • ResultCode.from_bytes()
      • ResultCode.imag
      • ResultCode.is_integer()
      • ResultCode.numerator
      • ResultCode.real
      • ResultCode.to_bytes()
    • StorageType
      • StorageType.__format__()
      • StorageType.__new__()
      • StorageType.as_integer_ratio()
      • StorageType.bit_count()
      • StorageType.bit_length()
      • StorageType.conjugate()
      • StorageType.denominator
      • StorageType.from_bytes()
      • StorageType.imag
      • StorageType.is_integer()
      • StorageType.numerator
      • StorageType.real
      • StorageType.to_bytes()
  • Package genlayer.std._internal.runner
  • Package genlayer.std._internal.storage
    • STORAGE_MAN
  • Package genlayer.std._wasi
  • Package genlayer.std.annotations
    • private()
  • Package genlayer.std.eq_principles
    • eq_principle_prompt_comparative()
    • eq_principle_prompt_non_comparative()
    • eq_principle_strict_eq()
  • Package genlayer.std.eth
    • eth_contract()
  • Package genlayer.std.events
    • Event
      • Event.__init__()
      • Event.indexed
      • Event.name
      • Event.signature
  • Package genlayer.std.genvm_contracts
    • Contract
      • Contract.__handle_undefined_method__()
      • Contract.__on_errored_message__()
      • Contract.__receive__()
      • Contract.address
      • Contract.balance
    • ContractAt
      • ContractAt.__init__()
      • ContractAt.address
      • ContractAt.emit()
      • ContractAt.emit_transfer()
      • ContractAt.view()
    • DeploymentTransactionDataKwArgs
      • DeploymentTransactionDataKwArgs.clear()
      • DeploymentTransactionDataKwArgs.copy()
      • DeploymentTransactionDataKwArgs.fromkeys()
      • DeploymentTransactionDataKwArgs.get()
      • DeploymentTransactionDataKwArgs.items()
      • DeploymentTransactionDataKwArgs.keys()
      • DeploymentTransactionDataKwArgs.pop()
      • DeploymentTransactionDataKwArgs.popitem()
      • DeploymentTransactionDataKwArgs.salt_nonce
      • DeploymentTransactionDataKwArgs.setdefault()
      • DeploymentTransactionDataKwArgs.update()
      • DeploymentTransactionDataKwArgs.values()
    • TransactionDataKwArgs
      • TransactionDataKwArgs.clear()
      • TransactionDataKwArgs.copy()
      • TransactionDataKwArgs.fromkeys()
      • TransactionDataKwArgs.get()
      • TransactionDataKwArgs.items()
      • TransactionDataKwArgs.keys()
      • TransactionDataKwArgs.pop()
      • TransactionDataKwArgs.popitem()
      • TransactionDataKwArgs.setdefault()
      • TransactionDataKwArgs.update()
      • TransactionDataKwArgs.values()
    • contract_interface()
    • deploy_contract()
  • Package genlayer.std.msg
    • MessageRawType
      • MessageRawType.chain_id
      • MessageRawType.contract_address
      • MessageRawType.datetime
      • MessageRawType.is_init
      • MessageRawType.origin_address
      • MessageRawType.sender_address
      • MessageRawType.stack
  • Package genlayer.std.nondet_fns
    • ExecPromptKwArgs
      • ExecPromptKwArgs.clear()
      • ExecPromptKwArgs.copy()
      • ExecPromptKwArgs.fromkeys()
      • ExecPromptKwArgs.get()
      • ExecPromptKwArgs.items()
      • ExecPromptKwArgs.keys()
      • ExecPromptKwArgs.pop()
      • ExecPromptKwArgs.popitem()
      • ExecPromptKwArgs.response_format
      • ExecPromptKwArgs.setdefault()
      • ExecPromptKwArgs.update()
      • ExecPromptKwArgs.values()
    • GetWebpageKwArgs
      • GetWebpageKwArgs.clear()
      • GetWebpageKwArgs.copy()
      • GetWebpageKwArgs.fromkeys()
      • GetWebpageKwArgs.get()
      • GetWebpageKwArgs.items()
      • GetWebpageKwArgs.keys()
      • GetWebpageKwArgs.mode
      • GetWebpageKwArgs.pop()
      • GetWebpageKwArgs.popitem()
      • GetWebpageKwArgs.setdefault()
      • GetWebpageKwArgs.update()
      • GetWebpageKwArgs.values()
      • GetWebpageKwArgs.wait_after_loaded
    • exec_prompt()
    • get_webpage()