Skip to content

Upstreams

erpc.upstreams

Upstream configuration dataclasses for eRPC.

UpstreamConfig dataclass

Configuration for a single eRPC upstream.

Attributes:

Name Type Description
id str

Unique upstream identifier.
endpoint str

RPC endpoint URL.
type str

Upstream type (e.g. evm, evm+alchemy).
vendor_name str

Provider vendor name for provider-specific optimisations.
allowed_methods list[str]

Allowlist of JSON-RPC methods. Empty means all allowed.
ignored_methods list[str]

Denylist of JSON-RPC methods.
failsafe dict[str, Any]

Failsafe policy overrides for this upstream.
json_rpc dict[str, Any]

JSON-RPC-level configuration overrides.
Source code in erpc/upstreams.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@dataclass
class UpstreamConfig:
    """Configuration for a single eRPC upstream.

    Attributes:
        id: Unique upstream identifier.
        endpoint: RPC endpoint URL.
        type: Upstream type (e.g. ``evm``, ``evm+alchemy``).
        vendor_name: Provider vendor name for provider-specific optimisations.
        allowed_methods: Allowlist of JSON-RPC methods. Empty means all allowed.
        ignored_methods: Denylist of JSON-RPC methods.
        failsafe: Failsafe policy overrides for this upstream.
        json_rpc: JSON-RPC-level configuration overrides.

    """

    id: str = ""
    endpoint: str = ""
    type: str = "evm"
    vendor_name: str = ""
    allowed_methods: list[str] = field(default_factory=list)
    ignored_methods: list[str] = field(default_factory=list)
    failsafe: dict[str, Any] = field(default_factory=dict)
    json_rpc: dict[str, Any] = field(default_factory=dict)

    def to_dict(self) -> dict[str, Any]:
        """Serialise this upstream config to an eRPC-compatible dictionary."""
        d: dict[str, Any] = {}
        if self.id:
            d["id"] = self.id
        if self.endpoint:
            d["endpoint"] = self.endpoint
        if self.type != "evm":
            d["type"] = self.type
        if self.vendor_name:
            d["vendorName"] = self.vendor_name
        if self.allowed_methods:
            d["allowMethods"] = self.allowed_methods
        if self.ignored_methods:
            d["ignoreMethods"] = self.ignored_methods
        if self.failsafe:
            d["failsafe"] = self.failsafe
        if self.json_rpc:
            d["jsonRpc"] = self.json_rpc
        return d

to_dict 

to_dict() -> dict[str, Any]

Serialise this upstream config to an eRPC-compatible dictionary.

Source code in erpc/upstreams.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
def to_dict(self) -> dict[str, Any]:
    """Serialise this upstream config to an eRPC-compatible dictionary."""
    d: dict[str, Any] = {}
    if self.id:
        d["id"] = self.id
    if self.endpoint:
        d["endpoint"] = self.endpoint
    if self.type != "evm":
        d["type"] = self.type
    if self.vendor_name:
        d["vendorName"] = self.vendor_name
    if self.allowed_methods:
        d["allowMethods"] = self.allowed_methods
    if self.ignored_methods:
        d["ignoreMethods"] = self.ignored_methods
    if self.failsafe:
        d["failsafe"] = self.failsafe
    if self.json_rpc:
        d["jsonRpc"] = self.json_rpc
    return d