erc_4626.vault_protocol.arcus.offchain_data

Documentation for eth_defi.erc_4626.vault_protocol.arcus.offchain_data Python module.

Reviewed Arcus pToken display data.

Arcus documents pToken mechanics in its product announcement and exposes live values through its public vault API. The scanner keeps reviewed address-scoped copy locally so metadata reads stay deterministic and do not depend on an offchain service.

Arcus is the protocol-level curator and manager display name for these address-scoped products. This attribution does not identify the operator behind the unlabelled address returned by the onchain manager() accessor.

Module Attributes

ARCUS_PTOKEN_DEPOSIT_FEE	Entry fee reported by the reviewed production pToken API records.
ARCUS_PTOKEN_PERFORMANCE_FEE	Profit share reported by the reviewed production pToken API records.
ARCUS_VAULT_DATA	Address-scoped product copy for reviewed production pTokens.

Functions

get_arcus_vault_offchain_data(vault_address)

Return reviewed static data for a production Arcus pToken.

Classes

ArcusVaultOffchainData

Reviewed display data for one production Arcus pToken.

ARCUS_PTOKEN_DEPOSIT_FEE: Final[float] = 0.0025

Entry fee reported by the reviewed production pToken API records.

ARCUS_PTOKEN_PERFORMANCE_FEE: Final[float] = 0.0

Profit share reported by the reviewed production pToken API records.

class ArcusVaultOffchainData

Bases: TypedDict

Reviewed display data for one production Arcus pToken.

short_description: str

Listing-friendly pToken summary.

description: str

Longer pToken strategy summary.

notes: str

Explanation of pToken return and collateral mechanics.

deposit_fee: float

Entry fee as a fraction of the deposited amount.

performance_fee: float

Manager profit share as a fraction of profit.

__init__(*args, **kwargs)

__new__(**kwargs)

clear()

Remove all items from the dict.

copy()

Return a shallow copy of the dict.

fromkeys(value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()

Return a set-like object providing a view on the dict’s items.

keys()

Return a set-like object providing a view on the dict’s keys.

pop(k[, d]) → v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault(key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.

If E is present and has a .keys() method, then does: for k in E.keys(): D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

Return an object providing a view on the dict’s values.

ARCUS_VAULT_DATA: Final[dict[eth_typing.evm.HexAddress, eth_defi.erc_4626.vault_protocol.arcus.offchain_data.ArcusVaultOffchainData]] = {'0x4472c69d299382f8847ebce4fc6ed8e295510e3e': {'deposit_fee': 0.0025, 'description': "Arcus pBTC3x targets 3x long BTC exposure through perpetual futures. Each token represents a pro-rata claim on the vault's USDG collateral and open BTC perpetual position.", 'notes': "A pToken holder's return follows the token's NAV per share, representing a proportionate claim on the vault's USDG collateral and BTC perpetual position after funding, fees and slippage. It is not simply 3 times the asset's total return, as automatic threshold-based rebalancing makes performance path-dependent. The pooled account, rather than individual holders, maintains the collateral required for the position. Read the [announcement](https://arcus.xyz/blog/ptokens-a-new-primitive-on-arcus) for more details.", 'performance_fee': 0.0, 'short_description': 'Arcus pToken targeting 3x long BTC perpetual exposure.'}, '0xe24cabdf76dd1c2576049167eb1755c84b985c36': {'deposit_fee': 0.0025, 'description': "Arcus pHOOD3x targets 3x long HOOD exposure through perpetual futures. Each token represents a pro-rata claim on the vault's USDG collateral and open HOOD perpetual position.", 'notes': "A pToken holder's return follows the token's NAV per share, representing a proportionate claim on the vault's USDG collateral and HOOD perpetual position after funding, fees and slippage. It is not simply 3 times the asset's total return, as automatic threshold-based rebalancing makes performance path-dependent. The pooled account, rather than individual holders, maintains the collateral required for the position. Read the [announcement](https://arcus.xyz/blog/ptokens-a-new-primitive-on-arcus) for more details.", 'performance_fee': 0.0, 'short_description': 'Arcus pToken targeting 3x long HOOD perpetual exposure.'}}

Address-scoped product copy for reviewed production pTokens.

The implementation deliberately does not extrapolate this data to every contract that shares the Arcus detection signal.

get_arcus_vault_offchain_data(vault_address)

Return reviewed static data for a production Arcus pToken.

This lookup performs no network I/O. The caller is already an ArcusVault, so its classifier has established the Robinhood Chain contract family.

Parameters

vault_address (eth_typing.evm.HexAddress) – Arcus pToken contract address.

Returns

Reviewed product copy, or None when the pToken has not been individually reviewed.

Return type

Optional[eth_defi.erc_4626.vault_protocol.arcus.offchain_data.ArcusVaultOffchainData]