PerformanceSeries

Documentation for eth_defi.vault_report.charts.PerformanceSeries Python class.

class PerformanceSeries

Bases: object

One vault in a performance comparison chart.

Built by eth_defi.vault_report.report.render_report_charts() from the vaults chosen for a best-performing section or for the new vaults chart.

Attributes summary

vault_id

Vault id, a column of the daily prices

name

Vault name, or its address when it has none

properties

Curator, protocol and chain shown under the name in the legend, with trimmed logos

benchmarks

Benchmark names the vault is compared with, see eth_defi.vault_report.benchmarks.select_benchmarks()

rank

Rank shown in the legend and the line end badge.

Methods summary

__init__(vault_id, name, properties, benchmarks)

vault_id: str

Vault id, a column of the daily prices

name: str

Vault name, or its address when it has none

properties: tuple[eth_defi.vault_report.charts.VaultProperty, ...]

Curator, protocol and chain shown under the name in the legend, with trimmed logos

benchmarks: tuple[str, ...]

Benchmark names the vault is compared with, see eth_defi.vault_report.benchmarks.select_benchmarks()

rank: Optional[int]

Rank shown in the legend and the line end badge. Defaults to the position in the chart.

__init__(vault_id, name, properties, benchmarks, rank=None)
Parameters
Return type

None