erc_4626.vault_protocol.rysk.api

Documentation for eth_defi.erc_4626.vault_protocol.rysk.api Python module.

Rysk Premium public pool catalogue client.

The scheduled vault pipeline discovers and prices Rysk pools from onchain events. The application catalogue remains useful for operator tools that need the current user-facing product set without scanning a chain first.

Functions

fetch_rysk_premium_pools(*[, session])	Fetch the current Rysk Premium application catalogue.
is_rysk_premium_test_pool(pool)	Identify catalogue products labelled as internal or test-only.

Classes

RyskPremiumPool

Describe one product returned by the Rysk Premium application.

Exceptions

RyskPremiumAPIError

Raised when the Rysk Premium catalogue response is unavailable or invalid.

exception RyskPremiumAPIError

Bases: RuntimeError

Raised when the Rysk Premium catalogue response is unavailable or invalid.

__init__(*args, **kwargs)

__new__(**kwargs)

add_note(note, /)

Add a note to the exception

with_traceback(tb, /)

Set self.__traceback__ to tb and return self.

class RyskPremiumPool

Bases: object

Describe one product returned by the Rysk Premium application.

The catalogue is an operator-tool convenience rather than a source of scanner classification or share-price history.

chain_id: int

EVM chain containing the pool.

address: eth_typing.evm.HexAddress

Pool and ERC-20 LP share-token address.

name: str

Curator-facing product name.

description: Optional[str]

Curator-facing product description, when supplied.

option_type: str

Advertised option-writing direction.

__init__(chain_id, address, name, description, option_type)

Parameters

• chain_id (int) –

• address (eth_typing.evm.HexAddress) –

• name (str) –

• description (Optional[str]) –

• option_type (str) –

Return type

None

is_rysk_premium_test_pool(pool)

Identify catalogue products labelled as internal or test-only.

The public endpoint includes operational test products. Operator tools use the issuer’s labels to keep those products out of user-facing reports.

Parameters

pool (eth_defi.erc_4626.vault_protocol.rysk.api.RyskPremiumPool) – Catalogue product to inspect.

Returns

True for an issuer-labelled internal or test product.

Return type

bool

fetch_rysk_premium_pools(*, session=None)

Fetch the current Rysk Premium application catalogue.

This unauthenticated endpoint is an application API, not a versioned developer API. The scheduled scanner and fixed-scope migration do not depend on it; examination tools use it only to enumerate current public products. See the official Premium application.

Parameters

session (Optional[requests.sessions.Session]) – Optional persistent HTTP session.

Returns

Validated catalogue products across all published EVM chains.

Raises

RyskPremiumAPIError – If transport, JSON decoding or response validation fails.

Return type

tuple[eth_defi.erc_4626.vault_protocol.rysk.api.RyskPremiumPool, …]