GenLayer Python API naming

[kp2pml30]

Ideas for better names (and other "syntactic" changes) for entities provided for Python contracts

Currently exposed methods: https://sdk.genlayer.com/api/public/index.html

[kp2pml30]

Contract names

Current state

Main contract

class C(gl.Contract):
  ...

Untyped internal contract

ContractAt(Address("0xaddr"))

Typed internal contract

@gl.contract_interface
class MyContract:
  class View:
    def view_meth(self, i: int) -> int: ...

  class Write:
    def write_meth(self, i: int) -> None: ...

External contracts

@gl.eth_contract
class Ghost:
  class View:
    pass

  class Write:
    def test(self, x: u256, /) -> None: ...

Issues

1. Minor inconsistency in deriving/annotating
2. Confusing naming

Changes

Names

For external (eth) contracts:

1. prefix:
   • eth
   • evm
   • external
2. suffix:
   • contract
   • contract interface

Main contract:

• contract (keep)
• main contract

Untyped internal contract:

• ContractAt (keep)
• Contract (conflicts with current "main contract")
• get_contract_at()

Typed internal contract:

• contract interface (keep)
• internal contract
• contract (unify with untyped, conflicts with current "main contract")

Implementation limitations

It seems that it is impossible to keep syntax with nested classes with deriving instead of decorators

[kp2pml30]

Example of unification for typed&untyped contracts:

@contract_interface
class C:
	class View:
		def foo(self) -> str: ...
	class Write:
		pass

a = C(Address("0x")) # InternalContract[C.View, C.Write]
b = InternalContract(Address("0x")) # InternalContract[Unknown, Unknown]

a.view().foo() # hints in editor + typing
b.view().foo() # no hints but works

implementation skeleton for @kp2pml30

code:

class GenVMContractDeclaration[TView, TWrite](typing.Protocol):
	View: type[TView]
	Write: type[TWrite]

class InternalContract[TView, TWrite]:
	def __init__(self, addr: Address): ...

	def view(self) -> TView: ...
	def write(self) -> TWrite: ...

def contract_interface[TView, TWrite](
	_contr: GenVMContractDeclaration[TView, TWrite],
) -> typing.Type[InternalContract[TView, TWrite]]: # typing.Callable[[Address], InternalContract[TView, TWrite]]:
	...

[kp2pml30]

Web module rework

see #137

Proposed syntax:

gl.web.get('http://example.org', headers=dict[str, str])
gl.web.post('http://example.org', body=bytes|dict)
...
gl.web.render('http://example.org', mode='html|text|screenshot')

[kp2pml30]

future: add validtor sig header

[kp2pml30]

• OriginAddress
• InitiatorAddress

[kp2pml30]

Separate "namespace" for eq_principle

gl.eq_principle.strict_eq
gl.eq_principle.comparative
gl.eq_principle.non_comparative