erc_4626.vault_protocol.lagoon.offchain_metadata

Documentation for eth_defi.erc_4626.vault_protocol.lagoon.offchain_metadata Python module.

Lagoon vault offchain metadata.

  • Lagoon stores vault descriptions in their web app, not on-chain or in a public data repository

  • We reverse-engineered the Lagoon Next.js app and discovered internal API endpoints at app.lagoon.finance that serve vault metadata including descriptions

  • The listing endpoint /api/vaults returns paginated vault data without descriptions

  • The detail endpoint /api/vault returns full vault data including description and shortDescription

  • We fetch and cache this data locally to avoid repeated API calls

  • Two-level caching: disk (2-day TTL) + in-process dictionary

Functions

fetch_lagoon_vault_metadata(web3, vault_address)

Fetch vault metadata from Lagoon's offchain web app API.

fetch_lagoon_vaults_for_chain(chain_id[, ...])

Fetch and cache Lagoon offchain vault metadata for a given chain.

Classes

LagoonCuratorMetadata

Metadata about a Lagoon vault curator.

LagoonVaultMetadata

Metadata about a Lagoon vault from offchain source.
class LagoonCuratorMetadata

Bases: TypedDict

Metadata about a Lagoon vault curator.

Extracted from the Lagoon web app API /api/vault endpoint.

__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.

class LagoonVaultMetadata

Bases: TypedDict

Metadata about a Lagoon vault from offchain source.

Fetched from the Lagoon web app API at app.lagoon.finance. Discovered by reverse-engineering the Lagoon Next.js JavaScript bundles.

  • Listing endpoint: GET /api/vaults?chainId={chainId}&pageIndex=0&pageSize=100

  • Detail endpoint: GET /api/vault?chainId={chainId}&address={address}

The detail endpoint returns description and shortDescription fields that are not available in the listing endpoint.

__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.

fetch_lagoon_vault_metadata(web3, vault_address)

Fetch vault metadata from Lagoon’s offchain web app API.

  • Do both in-process and disk cache to avoid repeated fetches

Parameters

  • web3 (web3.main.Web3) – Web3 instance (used to get chain_id and checksum address)

  • vault_address (eth_typing.evm.HexAddress) – Vault contract address

Returns

Metadata dict or None if the vault is not in Lagoon’s app database

Return type

Optional[eth_defi.erc_4626.vault_protocol.lagoon.offchain_metadata.LagoonVaultMetadata]

fetch_lagoon_vaults_for_chain(chain_id, cache_path=PosixPath('/home/runner/.tradingstrategy/cache/lagoon'), api_base_url='https://app.lagoon.finance/api', now_=None, max_cache_duration=datetime.timedelta(days=2))

Fetch and cache Lagoon offchain vault metadata for a given chain.

  • Enumerates vaults using the listing endpoint, then fetches each vault’s detail (including description) from the detail endpoint

  • One JSON cache file per chain

  • Multiprocess safe via file lock

Parameters

  • chain_id (int) – EVM chain id

  • cache_path (pathlib.Path) – Directory for cache files (default ~/.tradingstrategy/cache/lagoon/)

  • api_base_url (str) – Lagoon API base URL

  • now – Override current time (for testing)

  • max_cache_duration (datetime.timedelta) – How long before refreshing cache (default 2 days)

  • now_ (Optional[datetime.datetime]) –

Returns

Dict mapping checksummed vault address to LagoonVaultMetadata

Return type

dict[str, eth_defi.erc_4626.vault_protocol.lagoon.offchain_metadata.LagoonVaultMetadata]