zeth.core.contracts.InstanceDescription Class Reference

Public Member Functions
def	__init__ (self, str address, Dict[str, Any] abi)
Dict[str, Any]	to_json_dict (self)
Any	instantiate (self, Any web3)

Static Public Member Functions
InstanceDescription	from_json_dict (Dict[str, Any] desc_json)
InstanceDescription	deploy (Any web3, str source_file, str contract_name, str deployer_eth_address, Optional[bytes] deployer_eth_private_key, Optional[int] deployment_gas, Dict[str, Any] compiler_flags=None, Iterable[Any] args=None)
InstanceDescription	deploy_from_compiled (Any web3, str deployer_eth_address, Optional[bytes] deployer_eth_private_key, Optional[int] deployment_gas, Any compiled, *Any args)
Any	compile (str source_file, str contract_name, Dict[str, Any] compiler_flags=None)

Public Attributes
	address
	abi

Detailed Description

Minimal data required to instantiate the in-memory interface to a contract.

Definition at line 21 of file contracts.py.

Constructor & Destructor Documentation

__init__()

def zeth.core.contracts.InstanceDescription.__init__	(		self,
		str	address,
		Dict[str, Any]	abi
	)

Definition at line 25 of file contracts.py.

    def __init__(self, address: str, abi: Dict[str, Any]):
        self.address = address
        self.abi = abi
 

Member Function Documentation

compile()

Any zeth.core.contracts.InstanceDescription.compile ( str  source_file, str  contract_name, Dict[str, Any]   compiler_flags = None  )

static

Definition at line 96 of file contracts.py.

    def compile(
            source_file: str,
            contract_name: str,
            compiler_flags: Dict[str, Any] = None) \
            -> Any:
        compiled_all = compile_files([source_file], **(compiler_flags or {}))
        assert compiled_all
        compiled = compiled_all[f"{source_file}:{contract_name}"]
        assert compiled
        return compiled
 

Here is the call graph for this function:

deploy()

InstanceDescription zeth.core.contracts.InstanceDescription.deploy ( Any  web3, str  source_file, str  contract_name, str  deployer_eth_address, Optional[bytes]  deployer_eth_private_key, Optional[int]  deployment_gas, Dict[str, Any]   compiler_flags = None, Iterable[Any]   args = None  )

static

Compile and deploy a contract, returning the live instance and an instance
description (which the caller should save in order to access the
instance in the future).

Definition at line 40 of file contracts.py.

    def deploy(
            web3: Any,
            source_file: str,
            contract_name: str,
            deployer_eth_address: str,
            deployer_eth_private_key: Optional[bytes],
            deployment_gas: Optional[int],
            compiler_flags: Dict[str, Any] = None,
            args: Iterable[Any] = None) -> InstanceDescription:
        """
        Compile and deploy a contract, returning the live instance and an instance
        description (which the caller should save in order to access the
        instance in the future).
        """
        compiled = InstanceDescription.compile(
            source_file, contract_name, compiler_flags)
        assert compiled
        instance_desc = InstanceDescription.deploy_from_compiled(
            web3,
            deployer_eth_address,
            deployer_eth_private_key,
            deployment_gas,
            compiled,
            *(args or []))
        print(
            f"deploy: contract: {contract_name} "
            f"to address: {instance_desc.address}")
        return instance_desc
 

deploy_from_compiled()

InstanceDescription zeth.core.contracts.InstanceDescription.deploy_from_compiled ( Any  web3, str  deployer_eth_address, Optional[bytes]  deployer_eth_private_key, Optional[int]  deployment_gas, Any  compiled, *Any  args  )

static

Definition at line 70 of file contracts.py.

    def deploy_from_compiled(
            web3: Any,
            deployer_eth_address: str,
            deployer_eth_private_key: Optional[bytes],
            deployment_gas: Optional[int],
            compiled: Any,
            *args: Any) -> InstanceDescription:
        contract = web3.eth.contract(
            abi=compiled['abi'], bytecode=compiled['bin'])
        construct_call = contract.constructor(*args)
        tx_hash = send_contract_call(
            web3,
            construct_call,
            deployer_eth_address,
            deployer_eth_private_key,
            None,
            deployment_gas)
 
        tx_receipt = web3.eth.waitForTransactionReceipt(tx_hash, 10000)
        contract_address = tx_receipt['contractAddress']
        print(
            f"deploy:   tx_hash={tx_hash[0:8].hex()}, " +
            f"  gasUsed={tx_receipt.gasUsed}, status={tx_receipt.status}")
        return InstanceDescription(contract_address, compiled['abi'])
 

Here is the call graph for this function:

from_json_dict()

InstanceDescription zeth.core.contracts.InstanceDescription.from_json_dict ( Dict[str, Any]  desc_json )

static

Definition at line 36 of file contracts.py.

    def from_json_dict(desc_json: Dict[str, Any]) -> InstanceDescription:
        return InstanceDescription(desc_json["address"], desc_json["abi"])
 

instantiate()

Any zeth.core.contracts.InstanceDescription.instantiate	(		self,
		Any	web3
	)

Return the instantiated contract

Definition at line 107 of file contracts.py.

    def instantiate(self, web3: Any) -> Any:
        """
        Return the instantiated contract
        """
        return web3.eth.contract(address=self.address, abi=self.abi)
 
 

to_json_dict()

Dict[str, Any] zeth.core.contracts.InstanceDescription.to_json_dict

(

self

)

Definition at line 29 of file contracts.py.

    def to_json_dict(self) -> Dict[str, Any]:
        return {
            "address": self.address,
            "abi": self.abi
        }
 

Here is the caller graph for this function:

Member Data Documentation

abi

zeth.core.contracts.InstanceDescription.abi

Definition at line 27 of file contracts.py.

address

zeth.core.contracts.InstanceDescription.address

Definition at line 26 of file contracts.py.

---

The documentation for this class was generated from the following file:

• /home/runner/work/zeth/zeth/client/zeth/core/contracts.py